@powersync/service-module-mysql 0.1.5 → 0.1.7

package/test/src/BinLogStream.test.ts

@@ -1,11 +1,9 @@
 import { putOp, removeOp } from '@core-tests/stream_utils.js';
-import { MONGO_STORAGE_FACTORY } from '@core-tests/util.js';
-import { BucketStorageFactory, Metrics } from '@powersync/service-core';
-import { describe, expect, test } from 'vitest';
-import { binlogStreamTest } from './BinlogStreamUtils.js';
+import { MONGO_STORAGE_FACTORY, StorageFactory } from '@core-tests/util.js';
+import { Metrics } from '@powersync/service-core';
 import { v4 as uuid } from 'uuid';
-
-type StorageFactory = () => Promise<BucketStorageFactory>;
+import { describe, expect, test } from 'vitest';
+import { BinlogStreamTestContext } from './BinlogStreamUtils.js';
 
 const BASIC_SYNC_RULES = `
 bucket_definitions:
@@ -14,92 +12,81 @@ bucket_definitions:
       - SELECT id, description FROM "test_data"
 `;
 
-describe(
-  ' Binlog stream - mongodb',
-  function () {
-    defineBinlogStreamTests(MONGO_STORAGE_FACTORY);
-  },
-  { timeout: 20_000 }
-);
+describe('Binlog stream - mongodb', { timeout: 20_000 }, function () {
+  defineBinlogStreamTests(MONGO_STORAGE_FACTORY);
+});
 
 function defineBinlogStreamTests(factory: StorageFactory) {
-  test(
-    'Replicate basic values',
-    binlogStreamTest(factory, async (context) => {
-      const { connectionManager } = context;
-      await context.updateSyncRules(`
+  test('Replicate basic values', async () => {
+    await using context = await BinlogStreamTestContext.open(factory);
+    const { connectionManager } = context;
+    await context.updateSyncRules(`
   bucket_definitions:
     global:
       data:
         - SELECT id, description, num FROM "test_data"`);
 
-      await connectionManager.query(`CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description TEXT, num BIGINT)`);
-
-      await context.replicateSnapshot();
-
-      const startRowCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
-      const startTxCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
-
-      context.startStreaming();
-      const testId = uuid();
-      await connectionManager.query(
-        `INSERT INTO test_data(id, description, num) VALUES('${testId}', 'test1', 1152921504606846976)`
-      );
-      const data = await context.getBucketData('global[]');
-
-      expect(data).toMatchObject([putOp('test_data', { id: testId, description: 'test1', num: 1152921504606846976n })]);
-      const endRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
-      const endTxCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
-      expect(endRowCount - startRowCount).toEqual(1);
-      expect(endTxCount - startTxCount).toEqual(1);
-    })
-  );
-
-  test(
-    'replicating case sensitive table',
-    binlogStreamTest(factory, async (context) => {
-      const { connectionManager } = context;
-      await context.updateSyncRules(`
+    await connectionManager.query(`CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description TEXT, num BIGINT)`);
+
+    await context.replicateSnapshot();
+
+    const startRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const startTxCount =
+      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+
+    context.startStreaming();
+    const testId = uuid();
+    await connectionManager.query(
+      `INSERT INTO test_data(id, description, num) VALUES('${testId}', 'test1', 1152921504606846976)`
+    );
+    const data = await context.getBucketData('global[]');
+
+    expect(data).toMatchObject([putOp('test_data', { id: testId, description: 'test1', num: 1152921504606846976n })]);
+    const endRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const endTxCount =
+      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+    expect(endRowCount - startRowCount).toEqual(1);
+    expect(endTxCount - startTxCount).toEqual(1);
+  });
+
+  test('replicating case sensitive table', async () => {
+    await using context = await BinlogStreamTestContext.open(factory);
+    const { connectionManager } = context;
+    await context.updateSyncRules(`
       bucket_definitions:
         global:
           data:
             - SELECT id, description FROM "test_DATA"
       `);
 
-      await connectionManager.query(`CREATE TABLE test_DATA (id CHAR(36) PRIMARY KEY, description text)`);
+    await connectionManager.query(`CREATE TABLE test_DATA (id CHAR(36) PRIMARY KEY, description text)`);
 
-      await context.replicateSnapshot();
+    await context.replicateSnapshot();
 
-      const startRowCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
-      const startTxCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+    const startRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const startTxCount =
+      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
 
-      context.startStreaming();
+    context.startStreaming();
 
-      const testId = uuid();
-      await connectionManager.query(`INSERT INTO test_DATA(id, description) VALUES('${testId}','test1')`);
+    const testId = uuid();
+    await connectionManager.query(`INSERT INTO test_DATA(id, description) VALUES('${testId}','test1')`);
 
-      const data = await context.getBucketData('global[]');
+    const data = await context.getBucketData('global[]');
+
+    expect(data).toMatchObject([putOp('test_DATA', { id: testId, description: 'test1' })]);
+    const endRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const endTxCount =
+      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+    expect(endRowCount - startRowCount).toEqual(1);
+    expect(endTxCount - startTxCount).toEqual(1);
+  });
 
-      expect(data).toMatchObject([putOp('test_DATA', { id: testId, description: 'test1' })]);
-      const endRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
-      const endTxCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
-      expect(endRowCount - startRowCount).toEqual(1);
-      expect(endTxCount - startTxCount).toEqual(1);
-    })
-  );
-
-  //   TODO: Not supported yet
-  //   test(
-  //     'replicating TRUNCATE',
-  //     binlogStreamTest(factory, async (context) => {
-  //       const { connectionManager } = context;
-  //       const syncRuleContent = `
+  // TODO: Not supported yet
+  // test('replicating TRUNCATE', async () => {
+  //   await using context = await BinlogStreamTestContext.create(factory);
+  //   const { connectionManager } = context;
+  //   const syncRuleContent = `
   // bucket_definitions:
   //   global:
   //     data:
@@ -108,199 +95,235 @@ function defineBinlogStreamTests(factory: StorageFactory) {
   //     parameters: SELECT id FROM test_data WHERE id = token_parameters.user_id
   //     data: []
   // `;
-  //       await context.updateSyncRules(syncRuleContent);
-  //       await connectionManager.query(`DROP TABLE IF EXISTS test_data`);
-  //       await connectionManager.query(
-  //         `CREATE TABLE test_data(id uuid primary key default uuid_generate_v4(), description text)`
-  //       );
-  //
-  //       await context.replicateSnapshot();
-  //       context.startStreaming();
-  //
-  //       const [{ test_id }] = pgwireRows(
-  //         await connectionManager.query(`INSERT INTO test_data(description) VALUES('test1') returning id as test_id`)
-  //       );
-  //       await connectionManager.query(`TRUNCATE test_data`);
-  //
-  //       const data = await context.getBucketData('global[]');
-  //
-  //       expect(data).toMatchObject([
-  //         putOp('test_data', { id: test_id, description: 'test1' }),
-  //         removeOp('test_data', test_id)
-  //       ]);
-  //     })
+  //   await context.updateSyncRules(syncRuleContent);
+  //   await connectionManager.query(`DROP TABLE IF EXISTS test_data`);
+  //   await connectionManager.query(
+  //     `CREATE TABLE test_data(id uuid primary key default uuid_generate_v4(), description text)`
   //   );
 
-  test(
-    'replicating changing primary key',
-    binlogStreamTest(factory, async (context) => {
-      const { connectionManager } = context;
-      await context.updateSyncRules(BASIC_SYNC_RULES);
-
-      await connectionManager.query(`CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description text)`);
-
-      await context.replicateSnapshot();
-      context.startStreaming();
-
-      const testId1 = uuid();
-      await connectionManager.query(`INSERT INTO test_data(id, description) VALUES('${testId1}','test1')`);
-
-      const testId2 = uuid();
-      await connectionManager.query(
-        `UPDATE test_data SET id = '${testId2}', description = 'test2a' WHERE id = '${testId1}'`
-      );
-
-      // This update may fail replicating with:
-      // Error: Update on missing record public.test_data:074a601e-fc78-4c33-a15d-f89fdd4af31d :: {"g":1,"t":"651e9fbe9fec6155895057ec","k":"1a0b34da-fb8c-5e6f-8421-d7a3c5d4df4f"}
-      await connectionManager.query(`UPDATE test_data SET description = 'test2b' WHERE id = '${testId2}'`);
+  //   await context.replicateSnapshot();
+  //   context.startStreaming();
 
-      // Re-use old id again
-      await connectionManager.query(`INSERT INTO test_data(id, description) VALUES('${testId1}', 'test1b')`);
-      await connectionManager.query(`UPDATE test_data SET description = 'test1c' WHERE id = '${testId1}'`);
-
-      const data = await context.getBucketData('global[]');
-      expect(data).toMatchObject([
-        // Initial insert
-        putOp('test_data', { id: testId1, description: 'test1' }),
-        // Update id, then description
-        removeOp('test_data', testId1),
-        putOp('test_data', { id: testId2, description: 'test2a' }),
-        putOp('test_data', { id: testId2, description: 'test2b' }),
-        // Re-use old id
-        putOp('test_data', { id: testId1, description: 'test1b' }),
-        putOp('test_data', { id: testId1, description: 'test1c' })
-      ]);
-    })
-  );
-
-  test(
-    'initial sync',
-    binlogStreamTest(factory, async (context) => {
-      const { connectionManager } = context;
-      await context.updateSyncRules(BASIC_SYNC_RULES);
-
-      await connectionManager.query(`CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description text)`);
-
-      const testId = uuid();
-      await connectionManager.query(`INSERT INTO test_data(id, description) VALUES('${testId}','test1')`);
-
-      await context.replicateSnapshot();
-
-      const data = await context.getBucketData('global[]');
-      expect(data).toMatchObject([putOp('test_data', { id: testId, description: 'test1' })]);
-    })
-  );
-
-  test(
-    'snapshot with date values',
-    binlogStreamTest(factory, async (context) => {
-      const { connectionManager } = context;
-      await context.updateSyncRules(`
+  //   const [{ test_id }] = pgwireRows(
+  //     await connectionManager.query(`INSERT INTO test_data(description) VALUES('test1') returning id as test_id`)
+  //   );
+  //   await connectionManager.query(`TRUNCATE test_data`);
+
+  //   const data = await context.getBucketData('global[]');
+
+  //   expect(data).toMatchObject([
+  //     putOp('test_data', { id: test_id, description: 'test1' }),
+  //     removeOp('test_data', test_id)
+  //   ]);
+  // });
+
+  test('replicating changing primary key', async () => {
+    await using context = await BinlogStreamTestContext.open(factory);
+    const { connectionManager } = context;
+    await context.updateSyncRules(BASIC_SYNC_RULES);
+
+    await connectionManager.query(`CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description text)`);
+
+    await context.replicateSnapshot();
+    context.startStreaming();
+
+    const testId1 = uuid();
+    await connectionManager.query(`INSERT INTO test_data(id, description) VALUES('${testId1}','test1')`);
+
+    const testId2 = uuid();
+    await connectionManager.query(
+      `UPDATE test_data SET id = '${testId2}', description = 'test2a' WHERE id = '${testId1}'`
+    );
+
+    // This update may fail replicating with:
+    // Error: Update on missing record public.test_data:074a601e-fc78-4c33-a15d-f89fdd4af31d :: {"g":1,"t":"651e9fbe9fec6155895057ec","k":"1a0b34da-fb8c-5e6f-8421-d7a3c5d4df4f"}
+    await connectionManager.query(`UPDATE test_data SET description = 'test2b' WHERE id = '${testId2}'`);
+
+    // Re-use old id again
+    await connectionManager.query(`INSERT INTO test_data(id, description) VALUES('${testId1}', 'test1b')`);
+    await connectionManager.query(`UPDATE test_data SET description = 'test1c' WHERE id = '${testId1}'`);
+
+    const data = await context.getBucketData('global[]');
+    expect(data).toMatchObject([
+      // Initial insert
+      putOp('test_data', { id: testId1, description: 'test1' }),
+      // Update id, then description
+      removeOp('test_data', testId1),
+      putOp('test_data', { id: testId2, description: 'test2a' }),
+      putOp('test_data', { id: testId2, description: 'test2b' }),
+      // Re-use old id
+      putOp('test_data', { id: testId1, description: 'test1b' }),
+      putOp('test_data', { id: testId1, description: 'test1c' })
+    ]);
+  });
+
+  test('initial sync', async () => {
+    await using context = await BinlogStreamTestContext.open(factory);
+    const { connectionManager } = context;
+    await context.updateSyncRules(BASIC_SYNC_RULES);
+
+    await connectionManager.query(`CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description text)`);
+
+    const testId = uuid();
+    await connectionManager.query(`INSERT INTO test_data(id, description) VALUES('${testId}','test1')`);
+
+    await context.replicateSnapshot();
+
+    const data = await context.getBucketData('global[]');
+    expect(data).toMatchObject([putOp('test_data', { id: testId, description: 'test1' })]);
+  });
+
+  test('snapshot with date values', async () => {
+    await using context = await BinlogStreamTestContext.open(factory);
+    const { connectionManager } = context;
+    await context.updateSyncRules(`
       bucket_definitions:
         global:
           data:
             - SELECT * FROM "test_data"
       `);
 
-      await connectionManager.query(
-        `CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description TEXT, date DATE, datetime DATETIME, timestamp TIMESTAMP)`
-      );
+    await connectionManager.query(
+      `CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description TEXT, date DATE, datetime DATETIME, timestamp TIMESTAMP)`
+    );
 
-      const testId = uuid();
-      await connectionManager.query(`
+    const testId = uuid();
+    await connectionManager.query(`
         INSERT INTO test_data(id, description, date, datetime, timestamp) VALUES('${testId}','testDates', '2023-03-06', '2023-03-06 15:47', '2023-03-06 15:47')
       `);
 
-      await context.replicateSnapshot();
-
-      const data = await context.getBucketData('global[]');
-      expect(data).toMatchObject([
-        putOp('test_data', {
-          id: testId,
-          description: 'testDates',
-          date: `2023-03-06`,
-          datetime: '2023-03-06T15:47:00.000Z',
-          timestamp: '2023-03-06T15:47:00.000Z'
-        })
-      ]);
-    })
-  );
-
-  test(
-    'replication with date values',
-    binlogStreamTest(factory, async (context) => {
-      const { connectionManager } = context;
-      await context.updateSyncRules(`
+    await context.replicateSnapshot();
+
+    const data = await context.getBucketData('global[]');
+    expect(data).toMatchObject([
+      putOp('test_data', {
+        id: testId,
+        description: 'testDates',
+        date: `2023-03-06`,
+        datetime: '2023-03-06T15:47:00.000Z',
+        timestamp: '2023-03-06T15:47:00.000Z'
+      })
+    ]);
+  });
+
+  test('replication with date values', async () => {
+    await using context = await BinlogStreamTestContext.open(factory);
+    const { connectionManager } = context;
+    await context.updateSyncRules(`
       bucket_definitions:
         global:
           data:
             - SELECT * FROM "test_data"
       `);
 
-      await connectionManager.query(
-        `CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description TEXT, date DATE, datetime DATETIME, timestamp TIMESTAMP)`
-      );
+    await connectionManager.query(
+      `CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description TEXT, date DATE, datetime DATETIME NULL, timestamp TIMESTAMP NULL)`
+    );
 
-      await context.replicateSnapshot();
+    await context.replicateSnapshot();
 
-      const startRowCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
-      const startTxCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+    const startRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const startTxCount =
+      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
 
-      context.startStreaming();
+    context.startStreaming();
 
-      const testId = uuid();
-      await connectionManager.query(`
+    const testId = uuid();
+    await connectionManager.query(`
         INSERT INTO test_data(id, description, date, datetime, timestamp) VALUES('${testId}','testDates', '2023-03-06', '2023-03-06 15:47', '2023-03-06 15:47')
       `);
+    await connectionManager.query(`UPDATE test_data SET description = ? WHERE id = ?`, ['testUpdated', testId]);
+
+    const data = await context.getBucketData('global[]');
+    expect(data).toMatchObject([
+      putOp('test_data', {
+        id: testId,
+        description: 'testDates',
+        date: `2023-03-06`,
+        datetime: '2023-03-06T15:47:00.000Z',
+        timestamp: '2023-03-06T15:47:00.000Z'
+      }),
+      putOp('test_data', {
+        id: testId,
+        description: 'testUpdated',
+        date: `2023-03-06`,
+        datetime: '2023-03-06T15:47:00.000Z',
+        timestamp: '2023-03-06T15:47:00.000Z'
+      })
+    ]);
+    const endRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const endTxCount =
+      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+    expect(endRowCount - startRowCount).toEqual(2);
+    expect(endTxCount - startTxCount).toEqual(2);
+  });
+
+  test('table not in sync rules', async () => {
+    await using context = await BinlogStreamTestContext.open(factory);
+    const { connectionManager } = context;
+    await context.updateSyncRules(BASIC_SYNC_RULES);
+
+    await connectionManager.query(`CREATE TABLE test_donotsync (id CHAR(36) PRIMARY KEY, description text)`);
+
+    await context.replicateSnapshot();
+
+    const startRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const startTxCount =
+      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+
+    context.startStreaming();
+
+    await connectionManager.query(`INSERT INTO test_donotsync(id, description) VALUES('${uuid()}','test1')`);
+    const data = await context.getBucketData('global[]');
+
+    expect(data).toMatchObject([]);
+    const endRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const endTxCount =
+      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+
+    // There was a transaction, but we should not replicate any actual data
+    expect(endRowCount - startRowCount).toEqual(0);
+    expect(endTxCount - startTxCount).toEqual(1);
+  });
+
+  test('Resume replication', async () => {
+    const testId1 = uuid();
+    const testId2 = uuid();
+    {
+      await using context = await BinlogStreamTestContext.open(factory);
+      const { connectionManager } = context;
+      await context.updateSyncRules(`
+  bucket_definitions:
+    global:
+      data:
+        - SELECT id, description, num FROM "test_data"`);
+
+      await connectionManager.query(`CREATE TABLE test_data (id CHAR(36) PRIMARY KEY, description TEXT, num BIGINT)`);
 
+      await context.replicateSnapshot();
+      context.startStreaming();
+      await connectionManager.query(
+        `INSERT INTO test_data(id, description, num) VALUES('${testId1}', 'test1', 1152921504606846976)`
+      );
       const data = await context.getBucketData('global[]');
       expect(data).toMatchObject([
-        putOp('test_data', {
-          id: testId,
-          description: 'testDates',
-          date: `2023-03-06`,
-          datetime: '2023-03-06T15:47:00.000Z',
-          timestamp: '2023-03-06T15:47:00.000Z'
-        })
+        putOp('test_data', { id: testId1, description: 'test1', num: 1152921504606846976n })
       ]);
-      const endRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
-      const endTxCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
-      expect(endRowCount - startRowCount).toEqual(1);
-      expect(endTxCount - startTxCount).toEqual(1);
-    })
-  );
-
-  test(
-    'table not in sync rules',
-    binlogStreamTest(factory, async (context) => {
+    }
+    {
+      await using context = await BinlogStreamTestContext.open(factory, { doNotClear: true });
       const { connectionManager } = context;
-      await context.updateSyncRules(BASIC_SYNC_RULES);
-
-      await connectionManager.query(`CREATE TABLE test_donotsync (id CHAR(36) PRIMARY KEY, description text)`);
-
+      await context.loadActiveSyncRules();
+      // Does not actually do a snapshot again - just does the required intialization.
       await context.replicateSnapshot();
-
-      const startRowCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
-      const startTxCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
-
       context.startStreaming();
-
-      await connectionManager.query(`INSERT INTO test_donotsync(id, description) VALUES('${uuid()}','test1')`);
+      await connectionManager.query(`INSERT INTO test_data(id, description, num) VALUES('${testId2}', 'test2', 0)`);
       const data = await context.getBucketData('global[]');
 
-      expect(data).toMatchObject([]);
-      const endRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
-      const endTxCount =
-        (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
-
-      // There was a transaction, but we should not replicate any actual data
-      expect(endRowCount - startRowCount).toEqual(0);
-      expect(endTxCount - startTxCount).toEqual(1);
-    })
-  );
+      expect(data).toMatchObject([
+        putOp('test_data', { id: testId1, description: 'test1', num: 1152921504606846976n }),
+        putOp('test_data', { id: testId2, description: 'test2', num: 0n })
+      ]);
+    }
+  });
 }

package/test/src/BinlogStreamUtils.ts

@@ -12,33 +12,15 @@ import { MySQLConnectionManager } from '@module/replication/MySQLConnectionManag
 import mysqlPromise from 'mysql2/promise';
 import { readExecutedGtid } from '@module/common/read-executed-gtid.js';
 import { logger } from '@powersync/lib-services-framework';
+import { StorageFactory } from '@core-tests/util.js';
 
 /**
  * Tests operating on the binlog stream need to configure the stream and manage asynchronous
  * replication, which gets a little tricky.
  *
- * This wraps a test in a function that configures all the context, and tears it down afterward.
+ * This wraps all the context required for testing, and tears it down afterward
+ * by using `await using`.
  */
-export function binlogStreamTest(
-  factory: () => Promise<BucketStorageFactory>,
-  test: (context: BinlogStreamTestContext) => Promise<void>
-): () => Promise<void> {
-  return async () => {
-    const f = await factory();
-    const connectionManager = new MySQLConnectionManager(TEST_CONNECTION_OPTIONS, {});
-
-    const connection = await connectionManager.getConnection();
-    await clearTestDb(connection);
-    connection.release();
-    const context = new BinlogStreamTestContext(f, connectionManager);
-    try {
-      await test(context);
-    } finally {
-      await context.dispose();
-    }
-  };
-}
-
 export class BinlogStreamTestContext {
   private _binlogStream?: BinLogStream;
   private abortController = new AbortController();
@@ -46,6 +28,18 @@ export class BinlogStreamTestContext {
   public storage?: SyncRulesBucketStorage;
   private replicationDone = false;
 
+  static async open(factory: StorageFactory, options?: { doNotClear?: boolean }) {
+    const f = await factory({ doNotClear: options?.doNotClear });
+    const connectionManager = new MySQLConnectionManager(TEST_CONNECTION_OPTIONS, {});
+
+    if (!options?.doNotClear) {
+      const connection = await connectionManager.getConnection();
+      await clearTestDb(connection);
+      connection.release();
+    }
+    return new BinlogStreamTestContext(f, connectionManager);
+  }
+
   constructor(
     public factory: BucketStorageFactory,
     public connectionManager: MySQLConnectionManager
@@ -57,6 +51,10 @@ export class BinlogStreamTestContext {
     await this.connectionManager.end();
   }
 
+  [Symbol.asyncDispose]() {
+    return this.dispose();
+  }
+
   get connectionTag() {
     return this.connectionManager.connectionTag;
   }
@@ -67,6 +65,27 @@ export class BinlogStreamTestContext {
     return this.storage!;
   }
 
+  async loadNextSyncRules() {
+    const syncRules = await this.factory.getNextSyncRulesContent();
+    if (syncRules == null) {
+      throw new Error(`Next sync rules not available`);
+    }
+
+    this.storage = this.factory.getInstance(syncRules);
+    return this.storage!;
+  }
+
+  async loadActiveSyncRules() {
+    const syncRules = await this.factory.getActiveSyncRulesContent();
+    if (syncRules == null) {
+      throw new Error(`Active sync rules not available`);
+    }
+
+    this.storage = this.factory.getInstance(syncRules);
+    this.replicationDone = true;
+    return this.storage!;
+  }
+
   get binlogStream(): BinLogStream {
     if (this.storage == null) {
       throw new Error('updateSyncRules() first');