@powersync/service-module-mongodb 0.5.1 → 0.6.1

package/src/replication/ChangeStream.ts

@@ -14,7 +14,7 @@ import { MongoLSN } from '../common/MongoLSN.js';
 import { PostImagesOption } from '../types/types.js';
 import { escapeRegExp } from '../utils.js';
 import { MongoManager } from './MongoManager.js';
-import { constructAfterRecord, createCheckpoint, getMongoRelation } from './MongoRelation.js';
+import { constructAfterRecord, createCheckpoint, getCacheIdentifier, getMongoRelation } from './MongoRelation.js';
 import { CHECKPOINTS_COLLECTION } from './replication-utils.js';
 
 export interface ChangeStreamOptions {
@@ -89,6 +89,10 @@ export class ChangeStream {
     return this.connections.options.postImages == PostImagesOption.AUTO_CONFIGURE;
   }
 
+  private get logPrefix() {
+    return `[powersync_${this.group_id}]`;
+  }
+
   /**
    * This resolves a pattern, persists the related metadata, and returns
    * the resulting SourceTables.
@@ -124,18 +128,13 @@ export class ChangeStream {
       .toArray();
 
     if (!tablePattern.isWildcard && collections.length == 0) {
-      logger.warn(`Collection ${schema}.${tablePattern.name} not found`);
+      logger.warn(`${this.logPrefix} Collection ${schema}.${tablePattern.name} not found`);
     }
 
     for (let collection of collections) {
       const table = await this.handleRelation(
         batch,
-        {
-          name: collection.name,
-          schema,
-          objectId: collection.name,
-          replicationColumns: [{ name: '_id' }]
-        } as SourceEntityDescriptor,
+        getMongoRelation({ db: schema, coll: collection.name }),
         // This is done as part of the initial setup - snapshot is handled elsewhere
         { snapshot: false, collectionInfo: collection }
       );
@@ -149,7 +148,7 @@ export class ChangeStream {
   async initSlot(): Promise<InitResult> {
     const status = await this.storage.getStatus();
     if (status.snapshot_done && status.checkpoint_lsn) {
-      logger.info(`Initial replication already done`);
+      logger.info(`${this.logPrefix} Initial replication already done`);
       return { needsInitialSync: false };
     }
 
@@ -220,7 +219,7 @@ export class ChangeStream {
           }
 
           const { comparable: lsn } = new MongoLSN({ timestamp: snapshotTime });
-          logger.info(`Snapshot commit at ${snapshotTime.inspect()} / ${lsn}`);
+          logger.info(`${this.logPrefix} Snapshot commit at ${snapshotTime.inspect()} / ${lsn}`);
           await batch.commit(lsn);
         }
       );
@@ -289,7 +288,7 @@ export class ChangeStream {
     table: storage.SourceTable,
     session?: mongo.ClientSession
   ) {
-    logger.info(`Replicating ${table.qualifiedName}`);
+    logger.info(`${this.logPrefix} Replicating ${table.qualifiedName}`);
     const estimatedCount = await this.estimatedCount(table);
     let at = 0;
     let lastLogIndex = 0;
@@ -319,7 +318,7 @@ export class ChangeStream {
 
       at += 1;
       if (at - lastLogIndex >= 5000) {
-        logger.info(`[${this.group_id}] Replicating ${table.qualifiedName} ${at}/${estimatedCount}`);
+        logger.info(`${this.logPrefix}  Replicating ${table.qualifiedName} ${at}/${estimatedCount}`);
         lastLogIndex = at;
       }
       Metrics.getInstance().rows_replicated_total.add(1);
@@ -328,14 +327,16 @@ export class ChangeStream {
     }
 
     await batch.flush();
-    logger.info(`Replicated ${at} documents for ${table.qualifiedName}`);
+    logger.info(`${this.logPrefix} Replicated ${at} documents for ${table.qualifiedName}`);
   }
 
   private async getRelation(
     batch: storage.BucketStorageBatch,
-    descriptor: SourceEntityDescriptor
+    descriptor: SourceEntityDescriptor,
+    options: { snapshot: boolean }
   ): Promise<SourceTable> {
-    const existing = this.relation_cache.get(descriptor.objectId);
+    const cacheId = getCacheIdentifier(descriptor);
+    const existing = this.relation_cache.get(cacheId);
     if (existing != null) {
       return existing;
     }
@@ -344,7 +345,7 @@ export class ChangeStream {
     // missing values.
     const collection = await this.getCollectionInfo(descriptor.schema, descriptor.name);
 
-    return this.handleRelation(batch, descriptor, { snapshot: false, collectionInfo: collection });
+    return this.handleRelation(batch, descriptor, { snapshot: options.snapshot, collectionInfo: collection });
   }
 
   private async getCollectionInfo(db: string, name: string): Promise<mongo.CollectionInfo | undefined> {
@@ -375,7 +376,7 @@ export class ChangeStream {
         collMod: collectionInfo.name,
         changeStreamPreAndPostImages: { enabled: true }
       });
-      logger.info(`Enabled postImages on ${db}.${collectionInfo.name}`);
+      logger.info(`${this.logPrefix} Enabled postImages on ${db}.${collectionInfo.name}`);
     } else if (!enabled) {
       throw new ServiceError(ErrorCode.PSYNC_S1343, `postImages not enabled on ${db}.${collectionInfo.name}`);
     }
@@ -394,9 +395,6 @@ export class ChangeStream {
     }
 
     const snapshot = options.snapshot;
-    if (!descriptor.objectId && typeof descriptor.objectId != 'string') {
-      throw new ReplicationAssertionError('MongoDB replication - objectId expected');
-    }
     const result = await this.storage.resolveTable({
       group_id: this.group_id,
       connection_id: this.connection_id,
@@ -404,10 +402,16 @@ export class ChangeStream {
       entity_descriptor: descriptor,
       sync_rules: this.sync_rules
     });
-    this.relation_cache.set(descriptor.objectId, result.table);
+    this.relation_cache.set(getCacheIdentifier(descriptor), result.table);
 
-    // Drop conflicting tables. This includes for example renamed tables.
-    await batch.drop(result.dropTables);
+    // Drop conflicting collections.
+    // This is generally not expected for MongoDB source dbs, so we log an error.
+    if (result.dropTables.length > 0) {
+      logger.error(
+        `Conflicting collections found for ${JSON.stringify(descriptor)}. Dropping: ${result.dropTables.map((t) => t.id).join(', ')}`
+      );
+      await batch.drop(result.dropTables);
+    }
 
     // Snapshot if:
     // 1. Snapshot is requested (false for initial snapshot, since that process handles it elsewhere)
@@ -415,6 +419,7 @@ export class ChangeStream {
     // 3. The table is used in sync rules.
     const shouldSnapshot = snapshot && !result.table.snapshotComplete && result.table.syncAny;
     if (shouldSnapshot) {
+      logger.info(`${this.logPrefix} New collection: ${descriptor.schema}.${descriptor.name}`);
       // Truncate this table, in case a previous snapshot was interrupted.
       await batch.truncate([result.table]);
 
@@ -434,7 +439,7 @@ export class ChangeStream {
     change: mongo.ChangeStreamDocument
   ): Promise<storage.FlushedResult | null> {
     if (!table.syncAny) {
-      logger.debug(`Collection ${table.qualifiedName} not used in sync rules - skipping`);
+      logger.debug(`${this.logPrefix} Collection ${table.qualifiedName} not used in sync rules - skipping`);
       return null;
     }
 
@@ -528,7 +533,7 @@ export class ChangeStream {
         const startAfter = lastLsn?.timestamp;
         const resumeAfter = lastLsn?.resumeToken;
 
-        logger.info(`Resume streaming at ${startAfter?.inspect()} / ${lastLsn}`);
+        logger.info(`${this.logPrefix} Resume streaming at ${startAfter?.inspect()} / ${lastLsn}`);
 
         const filters = this.getSourceNamespaceFilters();
 
@@ -552,7 +557,6 @@ export class ChangeStream {
 
         const streamOptions: mongo.ChangeStreamOptions = {
           showExpandedEvents: true,
-          useBigInt64: true,
           maxAwaitTimeMS: 200,
           fullDocument: fullDocument
         };
@@ -591,13 +595,14 @@ export class ChangeStream {
 
         let splitDocument: mongo.ChangeStreamDocument | null = null;
 
+        let flexDbNameWorkaroundLogged = false;
+
         while (true) {
           if (this.abort_signal.aborted) {
             break;
           }
 
           const originalChangeDocument = await stream.tryNext();
-
           // The stream was closed, we will only ever receive `null` from it
           if (!originalChangeDocument && stream.closed) {
             break;
@@ -637,6 +642,29 @@ export class ChangeStream {
             throw new ReplicationAssertionError(`Incomplete splitEvent: ${JSON.stringify(splitDocument.splitEvent)}`);
           }
 
+          if (
+            !filters.multipleDatabases &&
+            'ns' in changeDocument &&
+            changeDocument.ns.db != this.defaultDb.databaseName &&
+            changeDocument.ns.db.endsWith(`_${this.defaultDb.databaseName}`)
+          ) {
+            // When all of the following conditions are met:
+            // 1. We're replicating from an Atlas Flex instance.
+            // 2. There were changestream events recorded while the PowerSync service is paused.
+            // 3. We're only replicating from a single database.
+            // Then we've observed an ns with for example {db: '67b83e86cd20730f1e766dde_ps'},
+            // instead of the expected {db: 'ps'}.
+            // We correct this.
+            changeDocument.ns.db = this.defaultDb.databaseName;
+
+            if (!flexDbNameWorkaroundLogged) {
+              flexDbNameWorkaroundLogged = true;
+              logger.warn(
+                `${this.logPrefix} Incorrect DB name in change stream: ${changeDocument.ns.db}. Changed to ${this.defaultDb.databaseName}.`
+              );
+            }
+          }
+
           if (
             (changeDocument.operationType == 'insert' ||
               changeDocument.operationType == 'update' ||
@@ -683,28 +711,44 @@ export class ChangeStream {
               waitForCheckpointLsn = await createCheckpoint(this.client, this.defaultDb);
             }
             const rel = getMongoRelation(changeDocument.ns);
-            const table = await this.getRelation(batch, rel);
+            const table = await this.getRelation(batch, rel, {
+              // In most cases, we should not need to snapshot this. But if this is the first time we see the collection
+              // for whatever reason, then we do need to snapshot it.
+              // This may result in some duplicate operations when a collection is created for the first time after
+              // sync rules was deployed.
+              snapshot: true
+            });
             if (table.syncAny) {
               await this.writeChange(batch, table, changeDocument);
             }
           } else if (changeDocument.operationType == 'drop') {
             const rel = getMongoRelation(changeDocument.ns);
-            const table = await this.getRelation(batch, rel);
+            const table = await this.getRelation(batch, rel, {
+              // We're "dropping" this collection, so never snapshot it.
+              snapshot: false
+            });
             if (table.syncAny) {
               await batch.drop([table]);
-              this.relation_cache.delete(table.objectId);
+              this.relation_cache.delete(getCacheIdentifier(rel));
             }
           } else if (changeDocument.operationType == 'rename') {
             const relFrom = getMongoRelation(changeDocument.ns);
             const relTo = getMongoRelation(changeDocument.to);
-            const tableFrom = await this.getRelation(batch, relFrom);
+            const tableFrom = await this.getRelation(batch, relFrom, {
+              // We're "dropping" this collection, so never snapshot it.
+              snapshot: false
+            });
             if (tableFrom.syncAny) {
               await batch.drop([tableFrom]);
-              this.relation_cache.delete(tableFrom.objectId);
+              this.relation_cache.delete(getCacheIdentifier(relFrom));
             }
             // Here we do need to snapshot the new table
             const collection = await this.getCollectionInfo(relTo.schema, relTo.name);
-            await this.handleRelation(batch, relTo, { snapshot: true, collectionInfo: collection });
+            await this.handleRelation(batch, relTo, {
+              // This is a new (renamed) collection, so always snapshot it.
+              snapshot: true,
+              collectionInfo: collection
+            });
           }
         }
       }

package/src/replication/ChangeStreamReplicationJob.ts

@@ -40,8 +40,8 @@ export class ChangeStreamReplicationJob extends replication.AbstractReplicationJ
       this.logger.error(`Replication failed`, e);
 
       if (e instanceof ChangeStreamInvalidatedError) {
-        // This stops replication on this slot, and creates a new slot
-        await this.options.storage.factory.slotRemoved(this.slotName);
+        // This stops replication and restarts with a new instance
+        await this.options.storage.factory.restartReplication(this.storage.group_id);
       }
     } finally {
       this.abortController.abort();

package/src/replication/MongoManager.ts

@@ -1,11 +1,9 @@
 import { mongo } from '@powersync/lib-service-mongodb';
 
 import { NormalizedMongoConnectionConfig } from '../types/types.js';
+import { BSON_DESERIALIZE_DATA_OPTIONS } from '@powersync/service-core';
 
 export class MongoManager {
-  /**
-   * Do not use this for any transactions.
-   */
   public readonly client: mongo.MongoClient;
   public readonly db: mongo.Db;
 
@@ -35,6 +33,9 @@ export class MongoManager {
 
       maxConnecting: 3,
       maxIdleTimeMS: 60_000,
+
+      ...BSON_DESERIALIZE_DATA_OPTIONS,
+
       ...overrides
     });
     this.db = this.client.db(options.database, {});

package/src/replication/MongoRelation.ts

@@ -11,11 +11,19 @@ export function getMongoRelation(source: mongo.ChangeStreamNameSpace): storage.S
   return {
     name: source.coll,
     schema: source.db,
-    objectId: source.coll,
+    // Not relevant for MongoDB - we use db + coll name as the identifier
+    objectId: undefined,
     replicationColumns: [{ name: '_id' }]
   } satisfies storage.SourceEntityDescriptor;
 }
 
+/**
+ * For in-memory cache only.
+ */
+export function getCacheIdentifier(source: storage.SourceEntityDescriptor): string {
+  return `${source.schema}.${source.name}`;
+}
+
 export function constructAfterRecord(document: mongo.Document): SqliteRow {
   let record: SqliteRow = {};
   for (let key of Object.keys(document)) {

package/test/src/change_stream.test.ts

@@ -239,6 +239,7 @@ bucket_definitions:
             - SELECT _id as id, description FROM "test_DATA"
       `);
 
+    await db.createCollection('test_DATA');
     await context.replicateSnapshot();
 
     context.startStreaming();
@@ -261,6 +262,7 @@ bucket_definitions:
           data:
             - SELECT _id as id, name, description FROM "test_data"
       `);
+    await db.createCollection('test_data');
 
     await context.replicateSnapshot();
     context.startStreaming();
@@ -371,6 +373,8 @@ bucket_definitions:
           - SELECT _id as id, name, other FROM "test_data"`);
     const { db } = context;
 
+    await db.createCollection('test_data');
+
     await context.replicateSnapshot();
 
     const collection = db.collection('test_data');
@@ -451,6 +455,8 @@ bucket_definitions:
 
     const data = await context.getBucketData('global[]');
     expect(data).toMatchObject([
+      // An extra op here, since this triggers a snapshot in addition to getting the event.
+      test_utils.putOp('test_data', { id: test_id!.toHexString(), description: 'test2' }),
       test_utils.putOp('test_data', { id: test_id!.toHexString(), description: 'test1' }),
       test_utils.putOp('test_data', { id: test_id!.toHexString(), description: 'test2' })
     ]);

package/test/src/change_stream_utils.ts

@@ -1,5 +1,5 @@
 import { mongo } from '@powersync/lib-service-mongodb';
-import { ActiveCheckpoint, BucketStorageFactory, OpId, SyncRulesBucketStorage } from '@powersync/service-core';
+import { BucketStorageFactory, OpId, ReplicationCheckpoint, SyncRulesBucketStorage } from '@powersync/service-core';
 import { test_utils } from '@powersync/service-core-tests';
 
 import { ChangeStream, ChangeStreamOptions } from '@module/replication/ChangeStream.js';
@@ -138,7 +138,7 @@ export class ChangeStreamTestContext {
 export async function getClientCheckpoint(
   client: mongo.MongoClient,
   db: mongo.Db,
-  bucketStorage: BucketStorageFactory,
+  storageFactory: BucketStorageFactory,
   options?: { timeout?: number }
 ): Promise<OpId> {
   const start = Date.now();
@@ -147,14 +147,15 @@ export async function getClientCheckpoint(
   // Since we don't use LSNs anymore, the only way to get that is to wait.
 
   const timeout = options?.timeout ?? 50_000;
-  let lastCp: ActiveCheckpoint | null = null;
+  let lastCp: ReplicationCheckpoint | null = null;
 
   while (Date.now() - start < timeout) {
-    const cp = await bucketStorage.getActiveCheckpoint();
-    lastCp = cp;
-    if (!cp.hasSyncRules()) {
+    const storage = await storageFactory.getActiveStorage();
+    const cp = await storage?.getCheckpoint();
+    if (cp == null) {
       throw new Error('No sync rules available');
     }
+    lastCp = cp;
     if (cp.lsn && cp.lsn >= lsn) {
       return cp.checkpoint;
     }

package/test/src/mongo_test.test.ts

@@ -47,6 +47,13 @@ describe('mongo data types', () => {
           'mydb',
           { foo: 'bar' }
         )
+      },
+      {
+        _id: 6 as any,
+        int4: -1,
+        int8: -9007199254740993n,
+        float: -3.14,
+        decimal: new mongo.Decimal128('-3.14')
       }
     ]);
   }
@@ -109,6 +116,13 @@ describe('mongo data types', () => {
       },
       { _id: 2 as any, nested: [{ test: 'thing' }] },
       { _id: 3 as any, date: [new Date('2023-03-06 15:47+02')] },
+      {
+        _id: 6 as any,
+        int4: [-1],
+        int8: [-9007199254740993n],
+        float: [-3.14],
+        decimal: [new mongo.Decimal128('-3.14')]
+      },
       {
         _id: 10 as any,
         timestamp: [mongo.Timestamp.fromBits(123, 456)],
@@ -164,6 +178,14 @@ describe('mongo data types', () => {
 
     // This must specifically be null, and not undefined.
     expect(transformed[4].undefined).toBeNull();
+
+    expect(transformed[5]).toMatchObject({
+      _id: 6n,
+      int4: -1n,
+      int8: -9007199254740993n,
+      float: -3.14,
+      decimal: '-3.14'
+    });
   }
 
   function checkResultsNested(transformed: Record<string, any>[]) {
@@ -193,6 +215,19 @@ describe('mongo data types', () => {
     });
 
     expect(transformed[3]).toMatchObject({
+      _id: 5n,
+      undefined: '[null]'
+    });
+
+    expect(transformed[4]).toMatchObject({
+      _id: 6n,
+      int4: '[-1]',
+      int8: '[-9007199254740993]',
+      float: '[-3.14]',
+      decimal: '["-3.14"]'
+    });
+
+    expect(transformed[5]).toMatchObject({
       _id: 10n,
       objectId: '["66e834cc91d805df11fa0ecb"]',
       timestamp: '[1958505087099]',
@@ -203,10 +238,6 @@ describe('mongo data types', () => {
       minKey: '[null]',
       maxKey: '[null]'
     });
-
-    expect(transformed[4]).toMatchObject({
-      undefined: '[null]'
-    });
   }
 
   test('test direct queries', async () => {
@@ -218,11 +249,13 @@ describe('mongo data types', () => {
       await insert(collection);
       await insertUndefined(db, 'test_data');
 
-      const rawResults = await db.collection('test_data').find().toArray();
+      const rawResults = await db
+        .collection('test_data')
+        .find({}, { sort: { _id: 1 } })
+        .toArray();
       // It is tricky to save "undefined" with mongo, so we check that it succeeded.
       expect(rawResults[4].undefined).toBeUndefined();
       const transformed = [...ChangeStream.getQueryData(rawResults)];
-
       checkResults(transformed);
     } finally {
       await client.close();
@@ -238,8 +271,11 @@ describe('mongo data types', () => {
       await insertNested(collection);
       await insertUndefined(db, 'test_data_arrays', true);
 
-      const rawResults = await db.collection('test_data_arrays').find().toArray();
-      expect(rawResults[4].undefined).toEqual([undefined]);
+      const rawResults = await db
+        .collection('test_data_arrays')
+        .find({}, { sort: { _id: 1 } })
+        .toArray();
+      expect(rawResults[3].undefined).toEqual([undefined]);
       const transformed = [...ChangeStream.getQueryData(rawResults)];
 
       checkResultsNested(transformed);
@@ -257,7 +293,6 @@ describe('mongo data types', () => {
       await setupTable(db);
 
       const stream = db.watch([], {
-        useBigInt64: true,
         maxAwaitTimeMS: 50,
         fullDocument: 'updateLookup'
       });
@@ -267,7 +302,7 @@ describe('mongo data types', () => {
       await insert(collection);
       await insertUndefined(db, 'test_data');
 
-      const transformed = await getReplicationTx(stream, 5);
+      const transformed = await getReplicationTx(stream, 6);
 
       checkResults(transformed);
     } finally {
@@ -282,7 +317,6 @@ describe('mongo data types', () => {
       await setupTable(db);
 
       const stream = db.watch([], {
-        useBigInt64: true,
         maxAwaitTimeMS: 50,
         fullDocument: 'updateLookup'
       });
@@ -292,7 +326,7 @@ describe('mongo data types', () => {
       await insertNested(collection);
       await insertUndefined(db, 'test_data_arrays', true);
 
-      const transformed = await getReplicationTx(stream, 5);
+      const transformed = await getReplicationTx(stream, 6);
 
       checkResultsNested(transformed);
     } finally {
@@ -505,5 +539,6 @@ async function getReplicationTx(replicationStream: mongo.ChangeStream, count: nu
       break;
     }
   }
+  transformed.sort((a, b) => Number(a._id) - Number(b._id));
   return transformed;
 }

package/test/src/util.ts

@@ -4,6 +4,7 @@ import * as postgres_storage from '@powersync/service-module-postgres-storage';
 
 import * as types from '@module/types/types.js';
 import { env } from './env.js';
+import { BSON_DESERIALIZE_DATA_OPTIONS } from '@powersync/service-core';
 
 export const TEST_URI = env.MONGO_TEST_DATA_URL;
 
@@ -30,7 +31,7 @@ export async function connectMongoData() {
     connectTimeoutMS: env.CI ? 15_000 : 5_000,
     socketTimeoutMS: env.CI ? 15_000 : 5_000,
     serverSelectionTimeoutMS: env.CI ? 15_000 : 2_500,
-    useBigInt64: true
+    ...BSON_DESERIALIZE_DATA_OPTIONS
   });
   const dbname = new URL(env.MONGO_TEST_DATA_URL).pathname.substring(1);
   return { client, db: client.db(dbname) };