@powersync/service-module-mongodb-storage 0.11.0 → 0.12.0

package/src/storage/implementation/MongoCompactor.ts

@@ -1,10 +1,11 @@
 import { mongo } from '@powersync/lib-service-mongodb';
-import { logger, ReplicationAssertionError } from '@powersync/lib-services-framework';
-import { InternalOpId, storage, utils } from '@powersync/service-core';
+import { logger, ReplicationAssertionError, ServiceAssertionError } from '@powersync/lib-services-framework';
+import { addChecksums, InternalOpId, storage, utils } from '@powersync/service-core';
 
 import { PowerSyncMongo } from './db.js';
-import { BucketDataDocument, BucketDataKey } from './models.js';
+import { BucketDataDocument, BucketDataKey, BucketStateDocument } from './models.js';
 import { cacheKey } from './OperationBatch.js';
+import { readSingleBatch } from './util.js';
 
 interface CurrentBucketState {
   /** Bucket name */
@@ -27,6 +28,21 @@ interface CurrentBucketState {
    * Number of REMOVE/MOVE operations seen since lastNotPut.
    */
   opsSincePut: number;
+
+  /**
+   * Incrementally-updated checksum, up to maxOpId
+   */
+  checksum: number;
+
+  /**
+   * op count for the checksum
+   */
+  opCount: number;
+
+  /**
+   * Byte size of ops covered by the checksum.
+   */
+  opBytes: number;
 }
 
 /**
@@ -43,13 +59,15 @@ const DEFAULT_MEMORY_LIMIT_MB = 64;
 
 export class MongoCompactor {
   private updates: mongo.AnyBulkWriteOperation<BucketDataDocument>[] = [];
+  private bucketStateUpdates: mongo.AnyBulkWriteOperation<BucketStateDocument>[] = [];
 
   private idLimitBytes: number;
   private moveBatchLimit: number;
   private moveBatchQueryLimit: number;
   private clearBatchLimit: number;
-  private maxOpId: bigint | undefined;
+  private maxOpId: bigint;
   private buckets: string[] | undefined;
+  private signal?: AbortSignal;
 
   constructor(
     private db: PowerSyncMongo,
@@ -60,8 +78,9 @@ export class MongoCompactor {
     this.moveBatchLimit = options?.moveBatchLimit ?? DEFAULT_MOVE_BATCH_LIMIT;
     this.moveBatchQueryLimit = options?.moveBatchQueryLimit ?? DEFAULT_MOVE_BATCH_QUERY_LIMIT;
     this.clearBatchLimit = options?.clearBatchLimit ?? DEFAULT_CLEAR_BATCH_LIMIT;
-    this.maxOpId = options?.maxOpId;
+    this.maxOpId = options?.maxOpId ?? 0n;
     this.buckets = options?.compactBuckets;
+    this.signal = options?.signal;
   }
 
   /**
@@ -117,31 +136,33 @@ export class MongoCompactor {
       o: new mongo.MaxKey() as any
     };
 
-    while (true) {
+    while (!this.signal?.aborted) {
       // Query one batch at a time, to avoid cursor timeouts
-      const batch = await this.db.bucket_data
-        .find(
-          {
+      const cursor = this.db.bucket_data.aggregate<BucketDataDocument & { size: number | bigint }>([
+        {
+          $match: {
             _id: {
               $gte: lowerBound,
               $lt: upperBound
             }
-          },
-          {
-            projection: {
-              _id: 1,
-              op: 1,
-              table: 1,
-              row_id: 1,
-              source_table: 1,
-              source_key: 1
-            },
-            limit: this.moveBatchQueryLimit,
-            sort: { _id: -1 },
-            singleBatch: true
           }
-        )
-        .toArray();
+        },
+        { $sort: { _id: -1 } },
+        { $limit: this.moveBatchQueryLimit },
+        {
+          $project: {
+            _id: 1,
+            op: 1,
+            table: 1,
+            row_id: 1,
+            source_table: 1,
+            source_key: 1,
+            checksum: 1,
+            size: { $bsonSize: '$$ROOT' }
+          }
+        }
+      ]);
+      const { data: batch } = await readSingleBatch(cursor);
 
       if (batch.length == 0) {
         // We've reached the end
@@ -153,34 +174,47 @@ export class MongoCompactor {
 
       for (let doc of batch) {
         if (currentState == null || doc._id.b != currentState.bucket) {
-          if (currentState != null && currentState.lastNotPut != null && currentState.opsSincePut >= 1) {
-            // Important to flush before clearBucket()
-            await this.flush();
-            logger.info(
-              `Inserting CLEAR at ${this.group_id}:${currentState.bucket}:${currentState.lastNotPut} to remove ${currentState.opsSincePut} operations`
-            );
+          if (currentState != null) {
+            if (currentState.lastNotPut != null && currentState.opsSincePut >= 1) {
+              // Important to flush before clearBucket()
+              // Does not have to happen before flushBucketChecksums()
+              await this.flush();
+              logger.info(
+                `Inserting CLEAR at ${this.group_id}:${currentState.bucket}:${currentState.lastNotPut} to remove ${currentState.opsSincePut} operations`
+              );
+
+              // Free memory before clearing bucket
+              currentState!.seen.clear();
+
+              await this.clearBucket(currentState);
+            }
 
-            const bucket = currentState.bucket;
-            const clearOp = currentState.lastNotPut;
-            // Free memory before clearing bucket
-            currentState = null;
-            await this.clearBucket(bucket, clearOp);
+            // Should happen after clearBucket() for accurate stats
+            this.updateBucketChecksums(currentState);
           }
           currentState = {
             bucket: doc._id.b,
             seen: new Map(),
             trackingSize: 0,
             lastNotPut: null,
-            opsSincePut: 0
+            opsSincePut: 0,
+
+            checksum: 0,
+            opCount: 0,
+            opBytes: 0
           };
         }
 
-        if (this.maxOpId != null && doc._id.o > this.maxOpId) {
+        if (doc._id.o > this.maxOpId) {
           continue;
         }
 
+        currentState.checksum = addChecksums(currentState.checksum, Number(doc.checksum));
+        currentState.opCount += 1;
+
         let isPersistentPut = doc.op == 'PUT';
 
+        currentState.opBytes += Number(doc.size);
         if (doc.op == 'REMOVE' || doc.op == 'PUT') {
           const key = `${doc.table}/${doc.row_id}/${cacheKey(doc.source_table!, doc.source_key!)}`;
           const targetOp = currentState.seen.get(key);
@@ -208,6 +242,8 @@ export class MongoCompactor {
                 }
               }
             });
+
+            currentState.opBytes += 200 - Number(doc.size); // TODO: better estimate for this
           } else {
             if (currentState.trackingSize >= idLimitBytes) {
               // Reached memory limit.
@@ -234,24 +270,72 @@ export class MongoCompactor {
           currentState.opsSincePut += 1;
         }
 
-        if (this.updates.length >= this.moveBatchLimit) {
+        if (this.updates.length + this.bucketStateUpdates.length >= this.moveBatchLimit) {
           await this.flush();
         }
       }
     }
 
-    await this.flush();
     currentState?.seen.clear();
     if (currentState?.lastNotPut != null && currentState?.opsSincePut > 1) {
       logger.info(
         `Inserting CLEAR at ${this.group_id}:${currentState.bucket}:${currentState.lastNotPut} to remove ${currentState.opsSincePut} operations`
       );
-      const bucket = currentState.bucket;
-      const clearOp = currentState.lastNotPut;
-      // Free memory before clearing bucket
-      currentState = null;
-      await this.clearBucket(bucket, clearOp);
+      // Need flush() before clear()
+      await this.flush();
+      await this.clearBucket(currentState);
     }
+    if (currentState != null) {
+      // Do this _after_ clearBucket so that we have accurate counts.
+      this.updateBucketChecksums(currentState);
+    }
+    // Need another flush after updateBucketChecksums()
+    await this.flush();
+  }
+
+  /**
+   * Call when done with a bucket.
+   */
+  private updateBucketChecksums(state: CurrentBucketState) {
+    if (state.opCount < 0) {
+      throw new ServiceAssertionError(
+        `Invalid opCount: ${state.opCount} checksum ${state.checksum} opsSincePut: ${state.opsSincePut} maxOpId: ${this.maxOpId}`
+      );
+    }
+    this.bucketStateUpdates.push({
+      updateOne: {
+        filter: {
+          _id: {
+            g: this.group_id,
+            b: state.bucket
+          }
+        },
+        update: {
+          $set: {
+            compacted_state: {
+              op_id: this.maxOpId,
+              count: state.opCount,
+              checksum: BigInt(state.checksum),
+              bytes: state.opBytes
+            },
+            estimate_since_compact: {
+              // Note: There could have been a whole bunch of new operations added to the bucket _while_ compacting,
+              // which we don't currently cater for.
+              // We could potentially query for that, but that could add overhead.
+              count: 0,
+              bytes: 0
+            }
+          },
+          $setOnInsert: {
+            // Only set this if we're creating the document.
+            // In all other cases, the replication process will have a set a more accurate id.
+            last_op: this.maxOpId
+          }
+        },
+        // We generally expect this to have been created before, but do handle cases of old unchanged buckets
+        upsert: true
+      }
+    });
   }
 
   private async flush() {
@@ -266,15 +350,26 @@ export class MongoCompactor {
       });
       this.updates = [];
     }
+    if (this.bucketStateUpdates.length > 0) {
+      logger.info(`Updating ${this.bucketStateUpdates.length} bucket states`);
+      await this.db.bucket_state.bulkWrite(this.bucketStateUpdates, {
+        ordered: false
+      });
+      this.bucketStateUpdates = [];
+    }
   }
 
   /**
    * Perform a CLEAR compact for a bucket.
    *
+   *
    * @param bucket bucket name
    * @param op op_id of the last non-PUT operation, which will be converted to CLEAR.
    */
-  private async clearBucket(bucket: string, op: InternalOpId) {
+  private async clearBucket(currentState: CurrentBucketState) {
+    const bucket = currentState.bucket;
+    const clearOp = currentState.lastNotPut!;
+
     const opFilter = {
       _id: {
         $gte: {
@@ -285,7 +380,7 @@ export class MongoCompactor {
         $lte: {
           g: this.group_id,
           b: bucket,
-          o: op
+          o: clearOp
         }
       }
     };
@@ -293,7 +388,8 @@ export class MongoCompactor {
     const session = this.db.client.startSession();
     try {
       let done = false;
-      while (!done) {
+      while (!done && !this.signal?.aborted) {
+        let opCountDiff = 0;
         // Do the CLEAR operation in batches, with each batch a separate transaction.
         // The state after each batch is fully consistent.
         // We need a transaction per batch to make sure checksums stay consistent.
@@ -364,12 +460,16 @@ export class MongoCompactor {
               },
               { session }
             );
+
+            opCountDiff = -numberOfOpsToClear + 1;
           },
           {
             writeConcern: { w: 'majority' },
             readConcern: { level: 'snapshot' }
           }
         );
+        // Update _outside_ the transaction, since the transaction can be retried multiple times.
+        currentState.opCount += opCountDiff;
       }
     } finally {
       await session.endSession();

package/src/storage/implementation/MongoSyncBucketStorage.ts

@@ -7,14 +7,18 @@ import {
   ServiceAssertionError
 } from '@powersync/lib-services-framework';
 import {
+  addPartialChecksums,
   BroadcastIterable,
+  BucketChecksum,
   CHECKPOINT_INVALIDATE_ALL,
   CheckpointChanges,
+  CompactOptions,
   deserializeParameterLookup,
   GetCheckpointChangesOptions,
   InternalOpId,
   internalToExternalOpId,
   maxLsn,
+  PartialChecksum,
   ProtocolOpId,
   ReplicationCheckpoint,
   storage,
@@ -31,9 +35,9 @@ import { PowerSyncMongo } from './db.js';
 import { BucketDataDocument, BucketDataKey, BucketStateDocument, SourceKey, SourceTableDocument } from './models.js';
 import { MongoBucketBatch } from './MongoBucketBatch.js';
 import { MongoCompactor } from './MongoCompactor.js';
+import { MongoParameterCompactor } from './MongoParameterCompactor.js';
 import { MongoWriteCheckpointAPI } from './MongoWriteCheckpointAPI.js';
 import { idPrefixFilter, mapOpEntry, readSingleBatch, setSessionSnapshotTime } from './util.js';
-import { MongoParameterCompactor } from './MongoParameterCompactor.js';
 
 export class MongoSyncBucketStorage
   extends BaseObserver<storage.SyncRulesBucketStorageListener>
@@ -490,24 +494,71 @@ export class MongoSyncBucketStorage
     return this.checksumCache.getChecksumMap(checkpoint, buckets);
   }
 
+  clearChecksumCache() {
+    this.checksumCache.clear();
+  }
+
   private async getChecksumsInternal(batch: storage.FetchPartialBucketChecksum[]): Promise<storage.PartialChecksumMap> {
     if (batch.length == 0) {
       return new Map();
     }
 
+    const preFilters: any[] = [];
+    for (let request of batch) {
+      if (request.start == null) {
+        preFilters.push({
+          _id: {
+            g: this.group_id,
+            b: request.bucket
+          },
+          'compacted_state.op_id': { $exists: true, $lte: request.end }
+        });
+      }
+    }
+
+    const preStates = new Map<string, { opId: InternalOpId; checksum: BucketChecksum }>();
+
+    if (preFilters.length > 0) {
+      // For un-cached bucket checksums, attempt to use the compacted state first.
+      const states = await this.db.bucket_state
+        .find({
+          $or: preFilters
+        })
+        .toArray();
+      for (let state of states) {
+        const compactedState = state.compacted_state!;
+        preStates.set(state._id.b, {
+          opId: compactedState.op_id,
+          checksum: {
+            bucket: state._id.b,
+            checksum: Number(compactedState.checksum),
+            count: compactedState.count
+          }
+        });
+      }
+    }
+
     const filters: any[] = [];
     for (let request of batch) {
+      let start = request.start;
+      if (start == null) {
+        const preState = preStates.get(request.bucket);
+        if (preState != null) {
+          start = preState.opId;
+        }
+      }
+
       filters.push({
         _id: {
           $gt: {
             g: this.group_id,
             b: request.bucket,
-            o: request.start ? BigInt(request.start) : new bson.MinKey()
+            o: start ?? new bson.MinKey()
           },
           $lte: {
             g: this.group_id,
             b: request.bucket,
-            o: BigInt(request.end)
+            o: request.end
           }
         }
       });
@@ -537,26 +588,48 @@ export class MongoSyncBucketStorage
             }
           }
         ],
-        { session: undefined, readConcern: 'snapshot', maxTimeMS: lib_mongo.db.MONGO_OPERATION_TIMEOUT_MS }
+        { session: undefined, readConcern: 'snapshot', maxTimeMS: lib_mongo.db.MONGO_CHECKSUM_TIMEOUT_MS }
       )
       .toArray()
       .catch((e) => {
         throw lib_mongo.mapQueryError(e, 'while reading checksums');
       });
 
-    return new Map<string, storage.PartialChecksum>(
+    const partialChecksums = new Map<string, storage.PartialOrFullChecksum>(
       aggregate.map((doc) => {
+        const partialChecksum = Number(BigInt(doc.checksum_total) & 0xffffffffn) & 0xffffffff;
+        const bucket = doc._id;
         return [
-          doc._id,
-          {
-            bucket: doc._id,
-            partialCount: doc.count,
-            partialChecksum: Number(BigInt(doc.checksum_total) & 0xffffffffn) & 0xffffffff,
-            isFullChecksum: doc.has_clear_op == 1
-          } satisfies storage.PartialChecksum
+          bucket,
+          doc.has_clear_op == 1
+            ? ({
+                // full checksum - replaces any previous one
+                bucket,
+                checksum: partialChecksum,
+                count: doc.count
+              } satisfies BucketChecksum)
+            : ({
+                // partial checksum - is added to a previous one
+                bucket,
+                partialCount: doc.count,
+                partialChecksum
+              } satisfies PartialChecksum)
         ];
       })
     );
+
+    return new Map<string, storage.PartialOrFullChecksum>(
+      batch.map((request) => {
+        const bucket = request.bucket;
+        // Could be null if this is either (1) a partial request, or (2) no compacted checksum was available
+        const preState = preStates.get(bucket);
+        // Could be null if we got no data
+        const partialChecksum = partialChecksums.get(bucket);
+        const merged = addPartialChecksums(bucket, preState?.checksum ?? null, partialChecksum ?? null);
+
+        return [bucket, merged];
+      })
+    );
   }
 
   async terminate(options?: storage.TerminateOptions) {
@@ -701,13 +774,31 @@ export class MongoSyncBucketStorage
   }
 
   async compact(options?: storage.CompactOptions) {
-    const checkpoint = await this.getCheckpointInternal();
-    await new MongoCompactor(this.db, this.group_id, options).compact();
-    if (checkpoint != null && options?.compactParameterData) {
-      await new MongoParameterCompactor(this.db, this.group_id, checkpoint.checkpoint, options).compact();
+    let maxOpId = options?.maxOpId;
+    if (maxOpId == null) {
+      const checkpoint = await this.getCheckpointInternal();
+      maxOpId = checkpoint?.checkpoint ?? undefined;
+    }
+    await new MongoCompactor(this.db, this.group_id, { ...options, maxOpId }).compact();
+    if (maxOpId != null && options?.compactParameterData) {
+      await new MongoParameterCompactor(this.db, this.group_id, maxOpId, options).compact();
     }
   }
 
+  async populatePersistentChecksumCache(options: Pick<CompactOptions, 'signal' | 'maxOpId'>): Promise<void> {
+    const start = Date.now();
+    // We do a minimal compact, primarily to populate the checksum cache
+    await this.compact({
+      ...options,
+      // Skip parameter data
+      compactParameterData: false,
+      // Don't track updates for MOVE compacting
+      memoryLimitMB: 0
+    });
+    const duration = Date.now() - start;
+    logger.info(`Populated persistent checksum cache in ${(duration / 1000).toFixed(1)}s`);
+  }
+
   /**
    * Instance-wide watch on the latest available checkpoint (op_id + lsn).
    */

package/src/storage/implementation/PersistedBatch.ts

@@ -71,15 +71,17 @@ export class PersistedBatch {
     this.logger = options?.logger ?? defaultLogger;
   }
 
-  private incrementBucket(bucket: string, op_id: InternalOpId) {
+  private incrementBucket(bucket: string, op_id: InternalOpId, bytes: number) {
     let existingState = this.bucketStates.get(bucket);
     if (existingState) {
       existingState.lastOp = op_id;
       existingState.incrementCount += 1;
+      existingState.incrementBytes += bytes;
     } else {
       this.bucketStates.set(bucket, {
         lastOp: op_id,
-        incrementCount: 1
+        incrementCount: 1,
+        incrementBytes: bytes
       });
     }
   }
@@ -115,7 +117,8 @@ export class PersistedBatch {
       }
 
       remaining_buckets.delete(key);
-      this.currentSize += recordData.length + 200;
+      const byteEstimate = recordData.length + 200;
+      this.currentSize += byteEstimate;
 
       const op_id = options.op_seq.next();
       this.debugLastOpId = op_id;
@@ -138,7 +141,7 @@ export class PersistedBatch {
           }
         }
       });
-      this.incrementBucket(k.bucket, op_id);
+      this.incrementBucket(k.bucket, op_id, byteEstimate);
     }
 
     for (let bd of remaining_buckets.values()) {
@@ -166,7 +169,7 @@ export class PersistedBatch {
         }
       });
       this.currentSize += 200;
-      this.incrementBucket(bd.bucket, op_id);
+      this.incrementBucket(bd.bucket, op_id, 200);
     }
   }
 
@@ -369,6 +372,10 @@ export class PersistedBatch {
           update: {
             $set: {
               last_op: state.lastOp
+            },
+            $inc: {
+              'estimate_since_compact.count': state.incrementCount,
+              'estimate_since_compact.bytes': state.incrementBytes
             }
           },
           upsert: true
@@ -381,4 +388,5 @@ export class PersistedBatch {
 interface BucketStateUpdate {
   lastOp: InternalOpId;
   incrementCount: number;
+  incrementBytes: number;
 }

package/src/storage/implementation/models.ts

@@ -98,6 +98,21 @@ export interface BucketStateDocument {
     b: string;
   };
   last_op: bigint;
+  /**
+   * If set, this can be treated as "cache" of a checksum at a specific point.
+   * Can be updated periodically, for example by the compact job.
+   */
+  compacted_state?: {
+    op_id: InternalOpId;
+    count: number;
+    checksum: bigint;
+    bytes: number;
+  };
+
+  estimate_since_compact?: {
+    count: number;
+    bytes: number;
+  };
 }
 
 export interface IdSequenceDocument {

package/src/storage/implementation/util.ts

@@ -43,7 +43,7 @@ export function generateSlotName(prefix: string, sync_rules_id: number) {
  *
  * For this to be effective, set batchSize = limit in the find command.
  */
-export async function readSingleBatch<T>(cursor: mongo.FindCursor<T>): Promise<{ data: T[]; hasMore: boolean }> {
+export async function readSingleBatch<T>(cursor: mongo.AbstractCursor<T>): Promise<{ data: T[]; hasMore: boolean }> {
   try {
     let data: T[];
     let hasMore = true;