feat: GZIP (#109)

* Pus * gzip * Push * Buffer.from * Format * Add changeset * Push * Remove deps * Rvert back to original lib.rs * Push * Refactor decompress function * Autogenerate * Format * deferred * Fix tests * Remove blob coments * Message queue. Untested * Fix test * Chunked decompress
clockworklabs · Oct 23, 2024 · cf7b7d8 · cf7b7d8
1 parent 221ac62
commit cf7b7d8
Show file tree

Hide file tree

Showing 33 changed files with 953 additions and 903 deletions.
diff --git a/.changeset/dull-mangos-appear.md b/.changeset/dull-mangos-appear.md
@@ -0,0 +1,5 @@
+---
+'@clockworklabs/spacetimedb-sdk': patch
+---
+
+fix: websocket message handling, Buffer, onConnect
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -43,9 +43,6 @@
   },
   "devDependencies": {
     "@clockworklabs/test-app": "file:../test-app",
-    "@types/brotli": "1.3.3",
-    "brotli": "1.3.3",
-    "buffer": "^6.0.3",
     "tsup": "^8.1.0",
     "undici": "^6.19.2"
   }

diff --git a/packages/sdk/src/client_api/bsatn_row_list_type.ts b/packages/sdk/src/client_api/bsatn_row_list_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { RowSizeHint as __RowSizeHint } from './row_size_hint_type';
 

diff --git a/packages/sdk/src/client_api/call_reducer_type.ts b/packages/sdk/src/client_api/call_reducer_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 export type CallReducer = {
   reducer: string;
   args: Uint8Array;

diff --git a/packages/sdk/src/client_api/client_message_type.ts b/packages/sdk/src/client_api/client_message_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { CallReducer as __CallReducer } from './call_reducer_type';
 // @ts-ignore

diff --git a/packages/sdk/src/client_api/compressable_query_update_type.ts b/packages/sdk/src/client_api/compressable_query_update_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { QueryUpdate as __QueryUpdate } from './query_update_type';
 
@@ -45,6 +47,7 @@ export namespace CompressableQueryUpdate {
   // the tagged union.
   export type Uncompressed = { tag: 'Uncompressed'; value: __QueryUpdate };
   export type Brotli = { tag: 'Brotli'; value: Uint8Array };
+  export type Gzip = { tag: 'Gzip'; value: Uint8Array };
 
   // Helper functions for constructing each variant of the tagged union.
   // ```
@@ -59,6 +62,10 @@ export namespace CompressableQueryUpdate {
     tag: 'Brotli',
     value,
   });
+  export const Gzip = (value: Uint8Array): CompressableQueryUpdate => ({
+    tag: 'Gzip',
+    value,
+  });
 
   export function getTypeScriptAlgebraicType(): AlgebraicType {
     return AlgebraicType.createSumType([
@@ -70,6 +77,10 @@ export namespace CompressableQueryUpdate {
         'Brotli',
         AlgebraicType.createArrayType(AlgebraicType.createU8Type())
       ),
+      new SumTypeVariant(
+        'Gzip',
+        AlgebraicType.createArrayType(AlgebraicType.createU8Type())
+      ),
     ]);
   }
 
@@ -93,6 +104,7 @@ export namespace CompressableQueryUpdate {
 // The tagged union or sum type for the algebraic type `CompressableQueryUpdate`.
 export type CompressableQueryUpdate =
   | CompressableQueryUpdate.Uncompressed
-  | CompressableQueryUpdate.Brotli;
+  | CompressableQueryUpdate.Brotli
+  | CompressableQueryUpdate.Gzip;
 
 export default CompressableQueryUpdate;
diff --git a/packages/sdk/src/client_api/database_update_type.ts b/packages/sdk/src/client_api/database_update_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { TableUpdate as __TableUpdate } from './table_update_type';
 

diff --git a/packages/sdk/src/client_api/energy_quanta_type.ts b/packages/sdk/src/client_api/energy_quanta_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 export type EnergyQuanta = {
   quanta: bigint;
 };

diff --git a/packages/sdk/src/client_api/identity_token_type.ts b/packages/sdk/src/client_api/identity_token_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 export type IdentityToken = {
   identity: Identity;
   token: string;

diff --git a/packages/sdk/src/client_api/index.ts b/packages/sdk/src/client_api/index.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 
 // Import and reexport all reducer arg types
 

diff --git a/packages/sdk/src/client_api/initial_subscription_type.ts b/packages/sdk/src/client_api/initial_subscription_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { DatabaseUpdate as __DatabaseUpdate } from './database_update_type';
 

diff --git a/packages/sdk/src/client_api/one_off_query_response_type.ts b/packages/sdk/src/client_api/one_off_query_response_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { OneOffTable as __OneOffTable } from './one_off_table_type';
 

diff --git a/packages/sdk/src/client_api/one_off_query_type.ts b/packages/sdk/src/client_api/one_off_query_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 export type OneOffQuery = {
   messageId: Uint8Array;
   queryString: string;

diff --git a/packages/sdk/src/client_api/one_off_table_type.ts b/packages/sdk/src/client_api/one_off_table_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { BsatnRowList as __BsatnRowList } from './bsatn_row_list_type';
 

diff --git a/packages/sdk/src/client_api/query_update_type.ts b/packages/sdk/src/client_api/query_update_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { BsatnRowList as __BsatnRowList } from './bsatn_row_list_type';
 

diff --git a/packages/sdk/src/client_api/reducer_call_info_type.ts b/packages/sdk/src/client_api/reducer_call_info_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 export type ReducerCallInfo = {
   reducerName: string;
   reducerId: number;

diff --git a/packages/sdk/src/client_api/row_size_hint_type.ts b/packages/sdk/src/client_api/row_size_hint_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // A namespace for generated variants and helper functions.
 export namespace RowSizeHint {
   // These are the generated variant types for each variant of the tagged union.

diff --git a/packages/sdk/src/client_api/server_message_type.ts b/packages/sdk/src/client_api/server_message_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { InitialSubscription as __InitialSubscription } from './initial_subscription_type';
 // @ts-ignore

diff --git a/packages/sdk/src/client_api/subscribe_type.ts b/packages/sdk/src/client_api/subscribe_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 export type Subscribe = {
   queryStrings: string[];
   requestId: number;

diff --git a/packages/sdk/src/client_api/table_update_type.ts b/packages/sdk/src/client_api/table_update_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { CompressableQueryUpdate as __CompressableQueryUpdate } from './compressable_query_update_type';
 

diff --git a/packages/sdk/src/client_api/timestamp_type.ts b/packages/sdk/src/client_api/timestamp_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 export type Timestamp = {
   microseconds: bigint;
 };

diff --git a/packages/sdk/src/client_api/transaction_update_type.ts b/packages/sdk/src/client_api/transaction_update_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { UpdateStatus as __UpdateStatus } from './update_status_type';
 // @ts-ignore

diff --git a/packages/sdk/src/client_api/update_status_type.ts b/packages/sdk/src/client_api/update_status_type.ts
@@ -34,7 +34,9 @@ import {
   SumTypeVariant,
   // @ts-ignore
   TableCache,
-} from '../index';
+  // @ts-ignore
+  deepEqual,
+} from '..';
 // @ts-ignore
 import { DatabaseUpdate as __DatabaseUpdate } from './database_update_type';
 

diff --git a/packages/sdk/src/db_connection_builder.ts b/packages/sdk/src/db_connection_builder.ts
@@ -15,6 +15,7 @@ export class DBConnectionBuilder<DBConnection> {
   #token?: string;
   #emitter: EventEmitter = new EventEmitter();
   #createWSFn: typeof WebsocketDecompressAdapter.createWebSocketFn;
+  #compression: 'gzip' | 'none' = 'gzip';
 
   /**
    * Creates a new `SpacetimeDBClient` database client and set the initial parameters.
@@ -70,6 +71,13 @@ export class DBConnectionBuilder<DBConnection> {
     return this;
   }
 
+  withCompression(
+    compression: 'gzip' | 'none'
+  ): DBConnectionBuilder<DBConnection> {
+    this.#compression = compression;
+    return this;
+  }
+
   /**
    * Connect to The SpacetimeDB Websocket For Your Module. By default, this will use a secure websocket connection. The parameters are optional, and if not provided, will use the values provided on construction of the client.
    *
@@ -118,6 +126,7 @@ export class DBConnectionBuilder<DBConnection> {
       url,
       wsProtocol: 'v1.bsatn.spacetimedb',
       authToken: connection.token,
+      compression: this.#compression,
     })
       .then(v => {
         connection.ws = v;