@powersync/service-core-tests 0.14.0 → 0.15.0

package/src/tests/register-data-storage-parameter-tests.ts

@@ -1,9 +1,9 @@
-import { JwtPayload, storage, updateSyncRulesFromYaml } from '@powersync/service-core';
+import { CURRENT_STORAGE_VERSION, JwtPayload, storage, updateSyncRulesFromYaml } from '@powersync/service-core';
 import { RequestParameters, ScopedParameterLookup, SqliteJsonRow } from '@powersync/service-sync-rules';
 import { expect, test } from 'vitest';
 import * as test_utils from '../test-utils/test-utils-index.js';
-import { bucketRequest, TEST_TABLE } from './util.js';
-import { ParameterLookupScope } from '@powersync/service-sync-rules';
+import { bucketRequest } from '../test-utils/test-utils-index.js';
+import { parameterLookupScope } from './util.js';
 
 /**
  * @example
@@ -15,23 +15,33 @@ import { ParameterLookupScope } from '@powersync/service-sync-rules';
  *
  * ```
  */
-export function registerDataStorageParameterTests(generateStorageFactory: storage.TestStorageFactory) {
-  const MYBUCKET_1: ParameterLookupScope = { lookupName: 'mybucket', queryId: '1' };
+export function registerDataStorageParameterTests(config: storage.TestStorageConfig) {
+  const generateStorageFactory = config.factory;
+  const storageVersion = config.storageVersion ?? CURRENT_STORAGE_VERSION;
+  const TEST_TABLE = test_utils.makeTestTable('test', ['id'], config);
+  const MYBUCKET_1 = parameterLookupScope('mybucket', '1');
 
   test('save and load parameters', async () => {
     await using factory = await generateStorageFactory();
     const syncRules = await factory.updateSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     parameters:
       - SELECT group_id FROM test WHERE id1 = token_parameters.user_id OR id2 = token_parameters.user_id
     data: []
-    `)
+    `,
+        {
+          storageVersion
+        }
+      )
     );
     const bucketStorage = factory.getInstance(syncRules);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
+
       await batch.save({
         sourceTable: TEST_TABLE,
         tag: storage.SaveOperationTag.INSERT,
@@ -71,17 +81,23 @@ bucket_definitions:
   test('it should use the latest version', async () => {
     await using factory = await generateStorageFactory();
     const syncRules = await factory.updateSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     parameters:
       - SELECT group_id FROM test WHERE id = token_parameters.user_id
     data: []
-    `)
+    `,
+        {
+          storageVersion
+        }
+      )
     );
     const bucketStorage = factory.getInstance(syncRules);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
       await batch.save({
         sourceTable: TEST_TABLE,
         tag: storage.SaveOperationTag.INSERT,
@@ -127,7 +143,8 @@ bucket_definitions:
   test('it should use the latest version after updates', async () => {
     await using factory = await generateStorageFactory();
     const syncRules = await factory.updateSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     parameters:
@@ -135,13 +152,16 @@ bucket_definitions:
         FROM todos
         WHERE list_id IN token_parameters.list_id
     data: []
-    `)
+    `,
+        { storageVersion }
+      )
     );
     const bucketStorage = factory.getInstance(syncRules);
 
-    const table = test_utils.makeTestTable('todos', ['id', 'list_id']);
+    const table = test_utils.makeTestTable('todos', ['id', 'list_id'], config);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
       // Create two todos which initially belong to different lists
       await batch.save({
         sourceTable: table,
@@ -202,17 +222,23 @@ bucket_definitions:
   test('save and load parameters with different number types', async () => {
     await using factory = await generateStorageFactory();
     const syncRules = await factory.updateSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     parameters:
       - SELECT group_id FROM test WHERE n1 = token_parameters.n1 and f2 = token_parameters.f2 and f3 = token_parameters.f3
     data: []
-    `)
+    `,
+        {
+          storageVersion
+        }
+      )
     );
     const bucketStorage = factory.getInstance(syncRules);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
       await batch.save({
         sourceTable: TEST_TABLE,
         tag: storage.SaveOperationTag.INSERT,
@@ -252,17 +278,23 @@ bucket_definitions:
 
     await using factory = await generateStorageFactory();
     const syncRules = await factory.updateSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     parameters:
       - SELECT group_id FROM test WHERE n1 = token_parameters.n1
     data: []
-    `)
+    `,
+        {
+          storageVersion
+        }
+      )
     );
     const bucketStorage = factory.getInstance(syncRules);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
       await batch.save({
         sourceTable: TEST_TABLE,
         tag: storage.SaveOperationTag.INSERT,
@@ -301,23 +333,29 @@ bucket_definitions:
   });
 
   test('save and load parameters with workspaceId', async () => {
-    const WORKSPACE_TABLE = test_utils.makeTestTable('workspace', ['id']);
+    const WORKSPACE_TABLE = test_utils.makeTestTable('workspace', ['id'], config);
 
     await using factory = await generateStorageFactory();
     const syncRules = await factory.updateSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
     by_workspace:
       parameters:
         - SELECT id as workspace_id FROM workspace WHERE
           workspace."userId" = token_parameters.user_id
       data: []
-    `)
+    `,
+        {
+          storageVersion
+        }
+      )
     );
     const sync_rules = syncRules.parsed(test_utils.PARSE_OPTIONS).hydratedSyncRules();
     const bucketStorage = factory.getInstance(syncRules);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
       await batch.save({
         sourceTable: WORKSPACE_TABLE,
         tag: storage.SaveOperationTag.INSERT,
@@ -337,7 +375,7 @@ bucket_definitions:
 
     const buckets = await querier.queryDynamicBucketDescriptions({
       async getParameterSets(lookups) {
-        expect(lookups).toEqual([ScopedParameterLookup.direct({ lookupName: 'by_workspace', queryId: '1' }, ['u1'])]);
+        expect(lookups).toEqual([ScopedParameterLookup.direct(parameterLookupScope('by_workspace', '1'), ['u1'])]);
 
         const parameter_sets = await checkpoint.getParameterSets(lookups);
         expect(parameter_sets).toEqual([{ workspace_id: 'workspace1' }]);
@@ -346,7 +384,7 @@ bucket_definitions:
     });
     expect(buckets).toEqual([
       {
-        bucket: bucketRequest(syncRules, 'by_workspace["workspace1"]'),
+        bucket: bucketRequest(syncRules, 'by_workspace["workspace1"]').bucket,
         priority: 3,
         definition: 'by_workspace',
         inclusion_reasons: ['default']
@@ -355,23 +393,29 @@ bucket_definitions:
   });
 
   test('save and load parameters with dynamic global buckets', async () => {
-    const WORKSPACE_TABLE = test_utils.makeTestTable('workspace');
+    const WORKSPACE_TABLE = test_utils.makeTestTable('workspace', undefined, config);
 
     await using factory = await generateStorageFactory();
     const syncRules = await factory.updateSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
     by_public_workspace:
       parameters:
         - SELECT id as workspace_id FROM workspace WHERE
           workspace.visibility = 'public'
       data: []
-    `)
+    `,
+        {
+          storageVersion
+        }
+      )
     );
     const sync_rules = syncRules.parsed(test_utils.PARSE_OPTIONS).hydratedSyncRules();
     const bucketStorage = factory.getInstance(syncRules);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
       await batch.save({
         sourceTable: WORKSPACE_TABLE,
         tag: storage.SaveOperationTag.INSERT,
@@ -413,9 +457,7 @@ bucket_definitions:
 
     const buckets = await querier.queryDynamicBucketDescriptions({
       async getParameterSets(lookups) {
-        expect(lookups).toEqual([
-          ScopedParameterLookup.direct({ lookupName: 'by_public_workspace', queryId: '1' }, [])
-        ]);
+        expect(lookups).toEqual([ScopedParameterLookup.direct(parameterLookupScope('by_public_workspace', '1'), [])]);
 
         const parameter_sets = await checkpoint.getParameterSets(lookups);
         parameter_sets.sort((a, b) => JSON.stringify(a).localeCompare(JSON.stringify(b)));
@@ -426,13 +468,13 @@ bucket_definitions:
     buckets.sort((a, b) => a.bucket.localeCompare(b.bucket));
     expect(buckets).toEqual([
       {
-        bucket: bucketRequest(syncRules, 'by_public_workspace["workspace1"]'),
+        bucket: bucketRequest(syncRules, 'by_public_workspace["workspace1"]').bucket,
         priority: 3,
         definition: 'by_public_workspace',
         inclusion_reasons: ['default']
       },
       {
-        bucket: bucketRequest(syncRules, 'by_public_workspace["workspace3"]'),
+        bucket: bucketRequest(syncRules, 'by_public_workspace["workspace3"]').bucket,
         priority: 3,
         definition: 'by_public_workspace',
         inclusion_reasons: ['default']
@@ -441,11 +483,12 @@ bucket_definitions:
   });
 
   test('multiple parameter queries', async () => {
-    const WORKSPACE_TABLE = test_utils.makeTestTable('workspace');
+    const WORKSPACE_TABLE = test_utils.makeTestTable('workspace', undefined, config);
 
     await using factory = await generateStorageFactory();
     const syncRules = await factory.updateSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
     by_workspace:
       parameters:
@@ -454,12 +497,17 @@ bucket_definitions:
         - SELECT id as workspace_id FROM workspace WHERE
             workspace.user_id = token_parameters.user_id
       data: []
-    `)
+    `,
+        {
+          storageVersion
+        }
+      )
     );
     const sync_rules = syncRules.parsed(test_utils.PARSE_OPTIONS).hydratedSyncRules();
     const bucketStorage = factory.getInstance(syncRules);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
       await batch.save({
         sourceTable: WORKSPACE_TABLE,
         tag: storage.SaveOperationTag.INSERT,
@@ -526,33 +574,39 @@ bucket_definitions:
       })
     ).map((e) => e.bucket);
     expect(foundLookups).toEqual([
-      ScopedParameterLookup.direct({ lookupName: 'by_workspace', queryId: '1' }, []),
-      ScopedParameterLookup.direct({ lookupName: 'by_workspace', queryId: '2' }, ['u1'])
+      ScopedParameterLookup.direct(parameterLookupScope('by_workspace', '1'), []),
+      ScopedParameterLookup.direct(parameterLookupScope('by_workspace', '2'), ['u1'])
     ]);
     parameter_sets.sort((a, b) => JSON.stringify(a).localeCompare(JSON.stringify(b)));
     expect(parameter_sets).toEqual([{ workspace_id: 'workspace1' }, { workspace_id: 'workspace3' }]);
 
     buckets.sort();
     expect(buckets).toEqual([
-      bucketRequest(syncRules, 'by_workspace["workspace1"]'),
-      bucketRequest(syncRules, 'by_workspace["workspace3"]')
+      bucketRequest(syncRules, 'by_workspace["workspace1"]').bucket,
+      bucketRequest(syncRules, 'by_workspace["workspace3"]').bucket
     ]);
   });
 
   test('truncate parameters', async () => {
     await using factory = await generateStorageFactory();
     const syncRules = await factory.updateSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     parameters:
       - SELECT group_id FROM test WHERE id1 = token_parameters.user_id OR id2 = token_parameters.user_id
     data: []
-    `)
+    `,
+        {
+          storageVersion
+        }
+      )
     );
     const bucketStorage = factory.getInstance(syncRules);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
       await batch.save({
         sourceTable: TEST_TABLE,
         tag: storage.SaveOperationTag.INSERT,
@@ -577,14 +631,19 @@ bucket_definitions:
   test('invalidate cached parsed sync rules', async () => {
     await using bucketStorageFactory = await generateStorageFactory();
     const syncRules = await bucketStorageFactory.updateSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
     by_workspace:
       parameters:
         - SELECT id as workspace_id FROM workspace WHERE
           workspace."userId" = token_parameters.user_id
       data: []
-    `)
+    `,
+        {
+          storageVersion
+        }
+      )
     );
     const syncBucketStorage = bucketStorageFactory.getInstance(syncRules);
 
@@ -626,6 +685,7 @@ streams:
     const bucketStorage = factory.getInstance(syncRules);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
       await batch.save({
         sourceTable: TEST_TABLE,
         tag: storage.SaveOperationTag.INSERT,
@@ -641,13 +701,7 @@ streams:
 
     const checkpoint = await bucketStorage.getCheckpoint();
     const parameters = await checkpoint.getParameterSets([
-      ScopedParameterLookup.direct(
-        {
-          lookupName: 'lookup',
-          queryId: '0'
-        },
-        ['baz']
-      )
+      ScopedParameterLookup.direct(parameterLookupScope('lookup', '0'), ['baz'])
     ]);
     expect(parameters).toEqual([
       {

package/src/tests/register-parameter-compacting-tests.ts

@@ -2,10 +2,13 @@ import { storage, updateSyncRulesFromYaml } from '@powersync/service-core';
 import { ScopedParameterLookup } from '@powersync/service-sync-rules';
 import { expect, test } from 'vitest';
 import * as test_utils from '../test-utils/test-utils-index.js';
+import { parameterLookupScope } from './util.js';
 
-const TEST_TABLE = test_utils.makeTestTable('test', ['id']);
+export function registerParameterCompactTests(config: storage.TestStorageConfig) {
+  const generateStorageFactory = config.factory;
+
+  const TEST_TABLE = test_utils.makeTestTable('test', ['id'], config);
 
-export function registerParameterCompactTests(generateStorageFactory: storage.TestStorageFactory) {
   test('compacting parameters', async () => {
     await using factory = await generateStorageFactory();
     const syncRules = await factory.updateSyncRules(
@@ -19,6 +22,7 @@ bucket_definitions:
     const bucketStorage = factory.getInstance(syncRules);
 
     await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+      await batch.markAllSnapshotDone('1/1');
       await batch.save({
         sourceTable: TEST_TABLE,
         tag: storage.SaveOperationTag.INSERT,
@@ -40,7 +44,7 @@ bucket_definitions:
       await batch.commit('1/1');
     });
 
-    const lookup = ScopedParameterLookup.direct({ lookupName: 'test', queryId: '1' }, ['t1']);
+    const lookup = ScopedParameterLookup.direct(parameterLookupScope('test', '1'), ['t1']);
 
     const checkpoint1 = await bucketStorage.getCheckpoint();
     const parameters1 = await checkpoint1.getParameterSets([lookup]);
@@ -102,6 +106,7 @@ bucket_definitions:
       const bucketStorage = factory.getInstance(syncRules);
 
       await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
+        await batch.markAllSnapshotDone('1/1');
         await batch.save({
           sourceTable: TEST_TABLE,
           tag: storage.SaveOperationTag.INSERT,
@@ -151,7 +156,7 @@ bucket_definitions:
         await batch.commit('3/1');
       });
 
-      const lookup = ScopedParameterLookup.direct({ lookupName: 'test', queryId: '1' }, ['u1']);
+      const lookup = ScopedParameterLookup.direct(parameterLookupScope('test', '1'), ['u1']);
 
       const checkpoint1 = await bucketStorage.getCheckpoint();
       const parameters1 = await checkpoint1.getParameterSets([lookup]);