@powersync/service-module-mongodb-storage 0.16.0 → 0.17.0

package/src/storage/implementation/v1/MongoSyncBucketStorageV1.ts

@@ -1,11 +1,13 @@
 import * as lib_mongo from '@powersync/lib-service-mongodb';
 import { mongo } from '@powersync/lib-service-mongodb';
+import { ServiceAssertionError } from '@powersync/lib-services-framework';
 import {
   CheckpointChanges,
   deserializeParameterLookup,
   GetCheckpointChangesOptions,
   InternalOpId,
   internalToExternalOpId,
+  maxLsn,
   ParameterSetLimitExceededError,
   ProtocolOpId,
   storage,
@@ -20,14 +22,20 @@ import {
   MongoSyncBucketStorageCheckpoint,
   MongoSyncBucketStorageContext
 } from '../common/MongoSyncBucketStorageContext.js';
-import { CommonSourceTableDocument, SourceKey } from '../models.js';
+import { SourceKey } from '../models.js';
 import { MongoBucketBatchOptions } from '../MongoBucketBatch.js';
 import { MongoChecksums } from '../MongoChecksums.js';
 import { MongoCompactOptions, MongoCompactor } from '../MongoCompactor.js';
 import { MongoParameterCompactor } from '../MongoParameterCompactor.js';
-import { MongoPersistedSyncRulesContent } from '../MongoPersistedSyncRulesContent.js';
+import { MongoPersistedSyncRulesContentV1 } from '../MongoPersistedSyncRulesContent.js';
 import { MongoSyncBucketStorage, MongoSyncBucketStorageOptions } from '../MongoSyncBucketStorage.js';
-import { BucketDataDocumentV1, BucketDataKeyV1, BucketStateDocument, loadBucketDataDocumentV1 } from './models.js';
+import {
+  BucketDataDocumentV1,
+  BucketDataKeyV1,
+  BucketStateDocument,
+  loadBucketDataDocumentV1,
+  SyncRuleDocumentV1
+} from './models.js';
 import { MongoBucketBatchV1 } from './MongoBucketBatchV1.js';
 import { MongoChecksumsV1 } from './MongoChecksumsV1.js';
 import { MongoCompactorV1 } from './MongoCompactorV1.js';
@@ -42,7 +50,7 @@ export class MongoSyncBucketStorageV1 extends MongoSyncBucketStorage {
   constructor(
     factory: MongoBucketStorage,
     group_id: number,
-    sync_rules: MongoPersistedSyncRulesContent,
+    sync_rules: MongoPersistedSyncRulesContentV1,
     slot_name: string,
     writeCheckpointMode: storage.WriteCheckpointMode | undefined,
     options: MongoSyncBucketStorageOptions
@@ -56,6 +64,105 @@ export class MongoSyncBucketStorageV1 extends MongoSyncBucketStorage {
     return new MongoBucketBatchV1(batchOptions);
   }
 
+  protected async fetchCheckpointState(
+    session: mongo.ClientSession
+  ): Promise<{ checkpoint: bigint; lsn: string | null } | null> {
+    const doc = (await this.db.sync_rules.findOne(
+      { _id: this.group_id },
+      {
+        session,
+        projection: { _id: 1, state: 1, last_checkpoint: 1, last_checkpoint_lsn: 1, snapshot_done: 1 }
+      }
+    )) as SyncRuleDocumentV1;
+    if (!doc?.snapshot_done || ![storage.SyncRuleState.ACTIVE, storage.SyncRuleState.ERRORED].includes(doc.state)) {
+      return null;
+    }
+    return {
+      checkpoint: doc.last_checkpoint ?? 0n,
+      lsn: doc.last_checkpoint_lsn ?? null
+    };
+  }
+
+  protected async getWriterSyncState() {
+    const doc = (await this.db.sync_rules.findOne(
+      {
+        _id: this.group_id
+      },
+      { projection: { last_checkpoint_lsn: 1, keepalive_op: 1, snapshot_lsn: 1 } }
+    )) as SyncRuleDocumentV1;
+    const checkpointLsn = doc?.last_checkpoint_lsn ?? null;
+    return {
+      lastCheckpointLsn: checkpointLsn,
+      resumeFromLsn: maxLsn(checkpointLsn, doc?.snapshot_lsn),
+      keepaliveOp: doc?.keepalive_op ? BigInt(doc.keepalive_op) : null,
+      syncConfigId: null
+    };
+  }
+
+  protected async terminateSyncRuleState(): Promise<void> {
+    await this.db.sync_rules.updateOne(
+      {
+        _id: this.group_id
+      },
+      {
+        $set: {
+          state: storage.SyncRuleState.TERMINATED,
+          persisted_lsn: null,
+          snapshot_done: false
+        }
+      }
+    );
+  }
+
+  protected async getStatusImpl(): Promise<storage.SyncRuleStatus> {
+    const doc = (await this.db.sync_rules.findOne(
+      {
+        _id: this.group_id
+      },
+      {
+        projection: {
+          snapshot_done: 1,
+          last_checkpoint_lsn: 1,
+          state: 1,
+          snapshot_lsn: 1,
+          keepalive_op: 1
+        }
+      }
+    )) as SyncRuleDocumentV1;
+    if (doc == null) {
+      throw new ServiceAssertionError('Cannot find replication stream status');
+    }
+
+    return {
+      snapshot_done: doc.snapshot_done,
+      snapshot_lsn: doc.snapshot_lsn ?? null,
+      active: doc.state == storage.SyncRuleState.ACTIVE,
+      checkpoint_lsn: doc.last_checkpoint_lsn,
+      keepalive_op: doc.keepalive_op == null ? null : BigInt(doc.keepalive_op)
+    };
+  }
+
+  protected async clearSyncRuleState(): Promise<void> {
+    await this.db.sync_rules.updateOne(
+      {
+        _id: this.group_id
+      },
+      {
+        $set: {
+          snapshot_done: false,
+          persisted_lsn: null,
+          last_checkpoint_lsn: null,
+          last_checkpoint: null,
+          no_checkpoint_before: null
+        },
+        $unset: {
+          snapshot_lsn: 1
+        }
+      },
+      { maxTimeMS: lib_mongo.db.MONGO_CLEAR_OPERATION_TIMEOUT_MS }
+    );
+  }
+
   protected createMongoChecksums(options: MongoSyncBucketStorageOptions): MongoChecksums {
     return new MongoChecksumsV1(this.db, this.group_id, {
       ...options.checksumOptions,
@@ -75,18 +182,6 @@ export class MongoSyncBucketStorageV1 extends MongoSyncBucketStorage {
     return new MongoParameterCompactorV1(this.db, this.group_id, checkpoint, options);
   }
 
-  protected sourceTableBaseId(): Partial<CommonSourceTableDocument> {
-    return { group_id: this.group_id };
-  }
-
-  protected augmentCreatedSourceTableDocument(
-    _createDoc: CommonSourceTableDocument,
-    _options: storage.ResolveTableOptions,
-    _candidateSourceTable: storage.SourceTable
-  ): void {}
-
-  protected async initializeResolvedSourceRecords(_sourceTableId: bson.ObjectId): Promise<void> {}
-
   protected override get versionContext(): MongoSyncBucketStorageContext<VersionedPowerSyncMongoV1> {
     return {
       db: this.db,

package/src/storage/implementation/v1/PersistedBatchV1.ts

@@ -3,9 +3,8 @@ import { ReplicationAssertionError } from '@powersync/lib-services-framework';
 import { storage } from '@powersync/service-core';
 import * as bson from 'bson';
 
-import { BucketDataSource } from '@powersync/service-sync-rules';
+import { BucketDataSource, BucketDefinitionId } from '@powersync/service-sync-rules';
 import { mongoTableId } from '../../../utils/util.js';
-import { BucketDefinitionId } from '../BucketDefinitionMapping.js';
 import { EMPTY_DATA } from '../MongoBucketBatchShared.js';
 import {
   BucketStateUpdate,

package/src/storage/implementation/v1/models.ts

@@ -1,3 +1,4 @@
+import { SerializedSyncPlan } from '@powersync/service-core';
 import * as bson from 'bson';
 import { BucketDataDoc } from '../common/BucketDataDoc.js';
 import {
@@ -8,6 +9,8 @@ import {
   LEGACY_BUCKET_DATA_DEFINITION_ID,
   SourceKey,
   SourceTableDocument,
+  SyncRuleCheckpointFields,
+  SyncRuleDocumentBase,
   TaggedBucketParameterDocument
 } from '../models.js';
 
@@ -75,6 +78,18 @@ export interface SourceTableDocumentV1 extends SourceTableDocument {
   group_id: number;
 }
 
+export interface SyncRuleDocumentV1 extends SyncRuleDocumentBase, SyncRuleCheckpointFields<string | null> {
+  content: string;
+  serialized_plan?: SerializedSyncPlan | null;
+
+  /**
+   * True if initial snapshot has been replicated.
+   *
+   * Can only be false if state == PROCESSING.
+   */
+  snapshot_done: boolean;
+}
+
 export interface BucketStateDocumentV1 extends BucketStateDocumentBase {
   _id: BucketStateDocumentBase['_id'] & {
     g: number;