@powersync/service-core-tests 0.14.0 → 0.15.1

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

@@ -12,15 +12,24 @@ import * as test_utils from '../test-utils/test-utils-index.js';
  *
  * ```
  */
-export function registerDataStorageCheckpointTests(generateStorageFactory: storage.TestStorageFactory) {
+export function registerDataStorageCheckpointTests(config: storage.TestStorageConfig) {
+  const generateStorageFactory = config.factory;
+  const storageVersion = config.storageVersion;
+
   test('managed write checkpoints - checkpoint after write', async (context) => {
     await using factory = await generateStorageFactory();
     const r = await factory.configureSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     data: []
-    `)
+    `,
+        {
+          validate: false,
+          storageVersion
+        }
+      )
     );
     const bucketStorage = factory.getInstance(r.persisted_sync_rules!);
 
@@ -30,14 +39,15 @@ bucket_definitions:
       .watchCheckpointChanges({ user_id: 'user1', signal: abortController.signal })
       [Symbol.asyncIterator]();
 
+    await using writer = await bucketStorage.createWriter(test_utils.BATCH_OPTIONS);
+    await writer.markAllSnapshotDone('1/1');
+
     const writeCheckpoint = await bucketStorage.createManagedWriteCheckpoint({
       heads: { '1': '5/0' },
       user_id: 'user1'
     });
 
-    await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
-      await batch.keepalive('5/0');
-    });
+    await writer.keepalive('5/0');
 
     const result = await iter.next();
     expect(result).toMatchObject({
@@ -55,23 +65,30 @@ bucket_definitions:
   test('managed write checkpoints - write after checkpoint', async (context) => {
     await using factory = await generateStorageFactory();
     const r = await factory.configureSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     data: []
-    `)
+    `,
+        {
+          validate: false,
+          storageVersion
+        }
+      )
     );
     const bucketStorage = factory.getInstance(r.persisted_sync_rules!);
 
+    await using writer = await bucketStorage.createWriter(test_utils.BATCH_OPTIONS);
+    await writer.markAllSnapshotDone('1/1');
+
     const abortController = new AbortController();
     context.onTestFinished(() => abortController.abort());
     const iter = bucketStorage
       .watchCheckpointChanges({ user_id: 'user1', signal: abortController.signal })
       [Symbol.asyncIterator]();
 
-    await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
-      await batch.keepalive('5/0');
-    });
+    await writer.keepalive('5/0');
 
     const result = await iter.next();
     expect(result).toMatchObject({
@@ -92,9 +109,7 @@ bucket_definitions:
     // We have to trigger a new keepalive after the checkpoint, at least to cover postgres storage.
     // This is what is effetively triggered with RouteAPI.createReplicationHead().
     // MongoDB storage doesn't explicitly need this anymore.
-    await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
-      await batch.keepalive('6/0');
-    });
+    await writer.keepalive('6/0');
 
     let result2 = await iter.next();
     if (result2.value?.base?.lsn == '5/0') {
@@ -116,29 +131,36 @@ bucket_definitions:
   test('custom write checkpoints - checkpoint after write', async (context) => {
     await using factory = await generateStorageFactory();
     const r = await factory.configureSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     data: []
-    `)
+    `,
+        {
+          validate: false,
+          storageVersion
+        }
+      )
     );
     const bucketStorage = factory.getInstance(r.persisted_sync_rules!);
     bucketStorage.setWriteCheckpointMode(storage.WriteCheckpointMode.CUSTOM);
 
+    await using writer = await bucketStorage.createWriter(test_utils.BATCH_OPTIONS);
+    await writer.markAllSnapshotDone('1/1');
+
     const abortController = new AbortController();
     context.onTestFinished(() => abortController.abort());
     const iter = bucketStorage
       .watchCheckpointChanges({ user_id: 'user1', signal: abortController.signal })
       [Symbol.asyncIterator]();
 
-    await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
-      await batch.addCustomWriteCheckpoint({
-        checkpoint: 5n,
-        user_id: 'user1'
-      });
-      await batch.flush();
-      await batch.keepalive('5/0');
+    writer.addCustomWriteCheckpoint({
+      checkpoint: 5n,
+      user_id: 'user1'
     });
+    await writer.flush();
+    await writer.keepalive('5/0');
 
     const result = await iter.next();
     expect(result).toMatchObject({
@@ -155,32 +177,39 @@ bucket_definitions:
   test('custom write checkpoints - standalone checkpoint', async (context) => {
     await using factory = await generateStorageFactory();
     const r = await factory.configureSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     data: []
-    `)
+    `,
+        {
+          validate: false,
+          storageVersion
+        }
+      )
     );
     const bucketStorage = factory.getInstance(r.persisted_sync_rules!);
     bucketStorage.setWriteCheckpointMode(storage.WriteCheckpointMode.CUSTOM);
 
+    await using writer = await bucketStorage.createWriter(test_utils.BATCH_OPTIONS);
+    await writer.markAllSnapshotDone('1/1');
+
     const abortController = new AbortController();
     context.onTestFinished(() => abortController.abort());
     const iter = bucketStorage
       .watchCheckpointChanges({ user_id: 'user1', signal: abortController.signal })
       [Symbol.asyncIterator]();
 
-    await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
-      // Flush to clear state
-      await batch.flush();
+    // Flush to clear state
+    await writer.flush();
 
-      await batch.addCustomWriteCheckpoint({
-        checkpoint: 5n,
-        user_id: 'user1'
-      });
-      await batch.flush();
-      await batch.keepalive('5/0');
+    writer.addCustomWriteCheckpoint({
+      checkpoint: 5n,
+      user_id: 'user1'
     });
+    await writer.flush();
+    await writer.keepalive('5/0');
 
     const result = await iter.next();
     expect(result).toMatchObject({
@@ -197,24 +226,31 @@ bucket_definitions:
   test('custom write checkpoints - write after checkpoint', async (context) => {
     await using factory = await generateStorageFactory();
     const r = await factory.configureSyncRules(
-      updateSyncRulesFromYaml(`
+      updateSyncRulesFromYaml(
+        `
 bucket_definitions:
   mybucket:
     data: []
-    `)
+    `,
+        {
+          validate: false,
+          storageVersion
+        }
+      )
     );
     const bucketStorage = factory.getInstance(r.persisted_sync_rules!);
     bucketStorage.setWriteCheckpointMode(storage.WriteCheckpointMode.CUSTOM);
 
+    await using writer = await bucketStorage.createWriter(test_utils.BATCH_OPTIONS);
+    await writer.markAllSnapshotDone('1/1');
+
     const abortController = new AbortController();
     context.onTestFinished(() => abortController.abort());
     const iter = bucketStorage
       .watchCheckpointChanges({ user_id: 'user1', signal: abortController.signal })
       [Symbol.asyncIterator]();
 
-    await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
-      await batch.keepalive('5/0');
-    });
+    await writer.keepalive('5/0');
 
     const result = await iter.next();
     expect(result).toMatchObject({
@@ -227,14 +263,12 @@ bucket_definitions:
       }
     });
 
-    await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
-      batch.addCustomWriteCheckpoint({
-        checkpoint: 6n,
-        user_id: 'user1'
-      });
-      await batch.flush();
-      await batch.keepalive('6/0');
+    writer.addCustomWriteCheckpoint({
+      checkpoint: 6n,
+      user_id: 'user1'
     });
+    await writer.flush();
+    await writer.keepalive('6/0');
 
     let result2 = await iter.next();
     expect(result2).toMatchObject({
@@ -248,14 +282,12 @@ bucket_definitions:
       }
     });
 
-    await bucketStorage.startBatch(test_utils.BATCH_OPTIONS, async (batch) => {
-      batch.addCustomWriteCheckpoint({
-        checkpoint: 7n,
-        user_id: 'user1'
-      });
-      await batch.flush();
-      await batch.keepalive('7/0');
+    writer.addCustomWriteCheckpoint({
+      checkpoint: 7n,
+      user_id: 'user1'
     });
+    await writer.flush();
+    await writer.keepalive('7/0');
 
     let result3 = await iter.next();
     expect(result3).toMatchObject({