feature: Added support for user parameters in sync rules. (#7)

* feature: Added support for user parameters in sync rules.

* Updated a sync rule test to use both token and user parameters.

* changed StreamingSyncRequest parameter's field to take a record of `any` instead of just strings.

* Added changeset entry.

Author: Chriztiaan

.changeset/witty-ducks-work.md

@@ -0,0 +1,5 @@
+---
+'@powersync/service-core': minor
+---
+
+Added support for user parameters when making a StreamingSyncRequest.

packages/service-core/src/routes/socket-route.ts

@@ -34,7 +34,11 @@ export const sync_stream_reactive: SocketRouteGenerator = (router) =>
 
       const controller = new AbortController();
 
-      const syncParams: SyncParameters = normalizeTokenParameters(context.token_payload?.parameters ?? {});
+      const syncParams: SyncParameters = normalizeTokenParameters(
+        context.token_payload?.parameters ?? {},
+        params.parameters ?? {}
+      );
+
       const storage = system.storage;
       // Sanity check before we start the stream
       const cp = await storage.getActiveCheckpoint();

packages/service-core/src/routes/sync-stream.ts

@@ -30,7 +30,10 @@ export const syncStreamed: RouteGenerator = (router) =>
       }
 
       const params: util.StreamingSyncRequest = payload.params;
-      const syncParams: SyncParameters = normalizeTokenParameters(payload.context.token_payload!.parameters ?? {});
+      const syncParams: SyncParameters = normalizeTokenParameters(
+        payload.context.token_payload!.parameters ?? {},
+        payload.params.parameters ?? {}
+      );
 
       const storage = system.storage;
       // Sanity check before we start the stream

packages/service-core/src/util/protocol-types.ts

@@ -89,7 +89,12 @@ export const StreamingSyncRequest = t.object({
   /**
    * Data is received in a serialized BSON Buffer
    */
-  binary_data: t.boolean.optional()
+  binary_data: t.boolean.optional(),
+
+  /**
+   * Client parameters to be passed to the sync rules.
+   */
+  parameters: t.record(t.any).optional()
 });
 
 export type StreamingSyncRequest = t.Decoded<typeof StreamingSyncRequest>;

packages/service-core/test/src/sync_rules.test.ts

@@ -100,27 +100,29 @@ bucket_definitions:
     const rules = SqlSyncRules.fromYaml(`
 bucket_definitions:
   mybucket:
-    parameters: SELECT token_parameters.user_id
+    parameters: SELECT token_parameters.user_id, user_parameters.device_id
     data:
-      - SELECT id, description FROM assets WHERE assets.user_id = bucket.user_id AND NOT assets.archived
+      - SELECT id, description FROM assets WHERE assets.user_id = bucket.user_id AND assets.device_id = bucket.device_id AND NOT assets.archived
     `);
     const bucket = rules.bucket_descriptors[0];
-    expect(bucket.bucket_parameters).toEqual(['user_id']);
+    expect(bucket.bucket_parameters).toEqual(['user_id', 'device_id']);
     const param_query = bucket.global_parameter_queries[0];
-    expect(param_query.bucket_parameters).toEqual(['user_id']);
-    expect(rules.getStaticBucketIds(normalizeTokenParameters({ user_id: 'user1' }))).toEqual(['mybucket["user1"]']);
+    expect(param_query.bucket_parameters).toEqual(['user_id', 'device_id']);
+    expect(rules.getStaticBucketIds(normalizeTokenParameters({ user_id: 'user1' }, { device_id: 'device1' }))).toEqual([
+      'mybucket["user1","device1"]'
+    ]);
 
     const data_query = bucket.data_queries[0];
-    expect(data_query.bucket_parameters).toEqual(['user_id']);
+    expect(data_query.bucket_parameters).toEqual(['user_id', 'device_id']);
     expect(
       rules.evaluateRow({
         sourceTable: ASSETS,
-        record: { id: 'asset1', description: 'test', user_id: 'user1' }
+        record: { id: 'asset1', description: 'test', user_id: 'user1', device_id: 'device1' }
       })
     ).toEqual([
       {
         ruleId: '1',
-        bucket: 'mybucket["user1"]',
+        bucket: 'mybucket["user1","device1"]',
         id: 'asset1',
         data: {
           id: 'asset1',
@@ -132,7 +134,7 @@ bucket_definitions:
     expect(
       rules.evaluateRow({
         sourceTable: ASSETS,
-        record: { id: 'asset1', description: 'test', user_id: 'user1', archived: 1 }
+        record: { id: 'asset1', description: 'test', user_id: 'user1', archived: 1, device_id: 'device1' }
       })
     ).toEqual([]);
   });