@powersync/service-module-mysql 0.0.0-dev-20250304151813 → 0.0.0-dev-20250307115534

package/test/src/BinLogStream.test.ts

@@ -1,10 +1,11 @@
-import { Metrics, storage } from '@powersync/service-core';
-import { putOp, removeOp } from '@powersync/service-core-tests';
+import { storage } from '@powersync/service-core';
+import { METRICS_HELPER, putOp, removeOp } from '@powersync/service-core-tests';
 import { v4 as uuid } from 'uuid';
 import { describe, expect, test } from 'vitest';
 import { BinlogStreamTestContext } from './BinlogStreamUtils.js';
 import { env } from './env.js';
 import { INITIALIZED_MONGO_STORAGE_FACTORY, INITIALIZED_POSTGRES_STORAGE_FACTORY } from './util.js';
+import { ReplicationMetric } from '@powersync/service-types';
 
 const BASIC_SYNC_RULES = `
 bucket_definitions:
@@ -35,9 +36,9 @@ function defineBinlogStreamTests(factory: storage.TestStorageFactory) {
 
     await context.replicateSnapshot();
 
-    const startRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const startRowCount = (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.ROWS_REPLICATED_TOTAL)) ?? 0;
     const startTxCount =
-      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+      (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.TRANSACTIONS_REPLICATED_TOTAL)) ?? 0;
 
     context.startStreaming();
     const testId = uuid();
@@ -47,9 +48,9 @@ function defineBinlogStreamTests(factory: storage.TestStorageFactory) {
     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 endRowCount = (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.ROWS_REPLICATED_TOTAL)) ?? 0;
     const endTxCount =
-      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+      (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.TRANSACTIONS_REPLICATED_TOTAL)) ?? 0;
     expect(endRowCount - startRowCount).toEqual(1);
     expect(endTxCount - startTxCount).toEqual(1);
   });
@@ -68,9 +69,9 @@ function defineBinlogStreamTests(factory: storage.TestStorageFactory) {
 
     await context.replicateSnapshot();
 
-    const startRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const startRowCount = (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.ROWS_REPLICATED_TOTAL)) ?? 0;
     const startTxCount =
-      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+      (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.TRANSACTIONS_REPLICATED_TOTAL)) ?? 0;
 
     context.startStreaming();
 
@@ -80,9 +81,9 @@ function defineBinlogStreamTests(factory: storage.TestStorageFactory) {
     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 endRowCount = (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.ROWS_REPLICATED_TOTAL)) ?? 0;
     const endTxCount =
-      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+      (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.TRANSACTIONS_REPLICATED_TOTAL)) ?? 0;
     expect(endRowCount - startRowCount).toEqual(1);
     expect(endTxCount - startTxCount).toEqual(1);
   });
@@ -172,10 +173,15 @@ function defineBinlogStreamTests(factory: storage.TestStorageFactory) {
     const testId = uuid();
     await connectionManager.query(`INSERT INTO test_data(id, description) VALUES('${testId}','test1')`);
 
+    const startRowCount = (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.ROWS_REPLICATED_TOTAL)) ?? 0;
+
     await context.replicateSnapshot();
+    context.startStreaming();
 
+    const endRowCount = (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.ROWS_REPLICATED_TOTAL)) ?? 0;
     const data = await context.getBucketData('global[]');
     expect(data).toMatchObject([putOp('test_data', { id: testId, description: 'test1' })]);
+    expect(endRowCount - startRowCount).toEqual(1);
   });
 
   test('snapshot with date values', async () => {
@@ -198,6 +204,7 @@ function defineBinlogStreamTests(factory: storage.TestStorageFactory) {
       `);
 
     await context.replicateSnapshot();
+    context.startStreaming();
 
     const data = await context.getBucketData('global[]');
     expect(data).toMatchObject([
@@ -227,9 +234,9 @@ function defineBinlogStreamTests(factory: storage.TestStorageFactory) {
 
     await context.replicateSnapshot();
 
-    const startRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const startRowCount = (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.ROWS_REPLICATED_TOTAL)) ?? 0;
     const startTxCount =
-      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+      (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.TRANSACTIONS_REPLICATED_TOTAL)) ?? 0;
 
     context.startStreaming();
 
@@ -256,9 +263,9 @@ function defineBinlogStreamTests(factory: storage.TestStorageFactory) {
         timestamp: '2023-03-06T15:47:00.000Z'
       })
     ]);
-    const endRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const endRowCount = (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.ROWS_REPLICATED_TOTAL)) ?? 0;
     const endTxCount =
-      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+      (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.TRANSACTIONS_REPLICATED_TOTAL)) ?? 0;
     expect(endRowCount - startRowCount).toEqual(2);
     expect(endTxCount - startTxCount).toEqual(2);
   });
@@ -272,9 +279,9 @@ function defineBinlogStreamTests(factory: storage.TestStorageFactory) {
 
     await context.replicateSnapshot();
 
-    const startRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const startRowCount = (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.ROWS_REPLICATED_TOTAL)) ?? 0;
     const startTxCount =
-      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+      (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.TRANSACTIONS_REPLICATED_TOTAL)) ?? 0;
 
     context.startStreaming();
 
@@ -282,9 +289,9 @@ function defineBinlogStreamTests(factory: storage.TestStorageFactory) {
     const data = await context.getBucketData('global[]');
 
     expect(data).toMatchObject([]);
-    const endRowCount = (await Metrics.getInstance().getMetricValueForTests('powersync_rows_replicated_total')) ?? 0;
+    const endRowCount = (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.ROWS_REPLICATED_TOTAL)) ?? 0;
     const endTxCount =
-      (await Metrics.getInstance().getMetricValueForTests('powersync_transactions_replicated_total')) ?? 0;
+      (await METRICS_HELPER.getMetricValueForTests(ReplicationMetric.TRANSACTIONS_REPLICATED_TOTAL)) ?? 0;
 
     // There was a transaction, but we should not replicate any actual data
     expect(endRowCount - startRowCount).toEqual(0);

package/test/src/BinlogStreamUtils.ts

@@ -4,13 +4,16 @@ import { MySQLConnectionManager } from '@module/replication/MySQLConnectionManag
 import { logger } from '@powersync/lib-services-framework';
 import {
   BucketStorageFactory,
-  OpId,
+  createCoreReplicationMetrics,
+  initializeCoreReplicationMetrics,
+  InternalOpId,
   OplogEntry,
+  ProtocolOpId,
   ReplicationCheckpoint,
   storage,
   SyncRulesBucketStorage
 } from '@powersync/service-core';
-import { test_utils } from '@powersync/service-core-tests';
+import { METRICS_HELPER, test_utils } from '@powersync/service-core-tests';
 import mysqlPromise from 'mysql2/promise';
 import { clearTestDb, TEST_CONNECTION_OPTIONS } from './util.js';
 
@@ -43,7 +46,10 @@ export class BinlogStreamTestContext {
   constructor(
     public factory: BucketStorageFactory,
     public connectionManager: MySQLConnectionManager
-  ) {}
+  ) {
+    createCoreReplicationMetrics(METRICS_HELPER.metricsEngine);
+    initializeCoreReplicationMetrics(METRICS_HELPER.metricsEngine);
+  }
 
   async dispose() {
     this.abortController.abort();
@@ -96,6 +102,7 @@ export class BinlogStreamTestContext {
     }
     const options: BinLogStreamOptions = {
       storage: this.storage,
+      metrics: METRICS_HELPER.metricsEngine,
       connections: this.connectionManager,
       abortSignal: this.abortController.signal
     };
@@ -116,30 +123,38 @@ export class BinlogStreamTestContext {
     this.streamPromise = this.binlogStream.streamChanges();
   }
 
-  async getCheckpoint(options?: { timeout?: number }): Promise<string> {
+  async getCheckpoint(options?: { timeout?: number }): Promise<InternalOpId> {
     const connection = await this.connectionManager.getConnection();
     let checkpoint = await Promise.race([
       getClientCheckpoint(connection, this.factory, { timeout: options?.timeout ?? 60_000 }),
       this.streamPromise
     ]);
     connection.release();
-    if (typeof checkpoint == undefined) {
+    if (checkpoint == null) {
       // This indicates an issue with the test setup - streamingPromise completed instead
       // of getClientCheckpoint()
-      throw new Error('Test failure - streamingPromise completed');
+      throw new Error('Test failure - streamingPromise completed. Was startStreaming() called?');
     }
-    return checkpoint as string;
+    return checkpoint;
   }
 
-  async getBucketsDataBatch(buckets: Record<string, string>, options?: { timeout?: number }) {
+  async getBucketsDataBatch(buckets: Record<string, InternalOpId>, options?: { timeout?: number }) {
     const checkpoint = await this.getCheckpoint(options);
-    const map = new Map<string, string>(Object.entries(buckets));
+    const map = new Map<string, InternalOpId>(Object.entries(buckets));
     return test_utils.fromAsync(this.storage!.getBucketDataBatch(checkpoint, map));
   }
 
-  async getBucketData(bucket: string, start = '0', options?: { timeout?: number }): Promise<OplogEntry[]> {
+  async getBucketData(
+    bucket: string,
+    start?: ProtocolOpId | InternalOpId | undefined,
+    options?: { timeout?: number }
+  ): Promise<OplogEntry[]> {
+    start = start ?? 0n;
+    if (typeof start == 'string') {
+      start = BigInt(start);
+    }
     const checkpoint = await this.getCheckpoint(options);
-    const map = new Map<string, string>([[bucket, start]]);
+    const map = new Map<string, InternalOpId>([[bucket, start]]);
     const batch = this.storage!.getBucketDataBatch(checkpoint, map);
     const batches = await test_utils.fromAsync(batch);
     return batches[0]?.batch.data ?? [];
@@ -150,7 +165,7 @@ export async function getClientCheckpoint(
   connection: mysqlPromise.Connection,
   storageFactory: BucketStorageFactory,
   options?: { timeout?: number }
-): Promise<OpId> {
+): Promise<InternalOpId> {
   const start = Date.now();
   const gtid = await readExecutedGtid(connection);
   // This old API needs a persisted checkpoint id.

package/test/src/setup.ts

@@ -1,13 +1,12 @@
 import { container } from '@powersync/lib-services-framework';
-import { test_utils } from '@powersync/service-core-tests';
+import { METRICS_HELPER } from '@powersync/service-core-tests';
 import { beforeAll, beforeEach } from 'vitest';
 
 beforeAll(async () => {
   // Executes for every test file
   container.registerDefaults();
-  await test_utils.initMetrics();
 });
 
 beforeEach(async () => {
-  await test_utils.resetMetrics();
+  METRICS_HELPER.resetMetrics();
 });