@powersync/service-module-mongodb-storage 0.0.0-dev-20260602073133 → 0.0.0-dev-20260909133214

package/dist/storage/implementation/v3/MongoSyncBucketStorageV3.d.ts

@@ -1,63 +1,88 @@
-import * as lib_mongo from '@powersync/lib-service-mongodb';
 import { mongo } from '@powersync/lib-service-mongodb';
-import { CheckpointChanges, GetCheckpointChangesOptions, InternalOpId, storage, utils } from '@powersync/service-core';
+import { CheckpointChanges, CompactInitialReplicationOptions, CompactInitialReplicationResults, GetCheckpointChangesOptions, InternalOpId, SingleSyncConfigBucketDefinitionMapping, storage } from '@powersync/service-core';
 import { ParameterLookupRows, ScopedParameterLookup } from '@powersync/service-sync-rules';
 import { MongoBucketStorage } from '../../MongoBucketStorage.js';
-import { MongoSyncBucketStorageCheckpoint, MongoSyncBucketStorageContext } from '../common/MongoSyncBucketStorageContext.js';
-import { MongoBucketBatchOptions } from '../MongoBucketBatch.js';
+import { MongoGetCheckpointChangesOptions, MongoSyncBucketStorageCheckpoint } from '../common/MongoSyncBucketStorageCheckpoint.js';
 import { MongoChecksums } from '../MongoChecksums.js';
 import { MongoCompactOptions, MongoCompactor } from '../MongoCompactor.js';
 import { MongoParameterCompactor } from '../MongoParameterCompactor.js';
-import { MongoPersistedSyncRulesContentV1 } from '../MongoPersistedSyncRulesContent.js';
-import { MongoSyncBucketStorage, MongoSyncBucketStorageOptions } from '../MongoSyncBucketStorage.js';
+import { MongoPersistedReplicationStream } from '../MongoPersistedReplicationStream.js';
+import { MongoCheckpointState, MongoSyncBucketStorage, MongoSyncBucketStorageOptions } from '../MongoSyncBucketStorage.js';
+import { MongoCheckpointAPIOptions } from '../MongoWriteCheckpointAPI.js';
 import { MongoChecksumsV3 } from './MongoChecksumsV3.js';
+import { MongoWriteCheckpointAPIV3 } from './MongoWriteCheckpointAPIV3.js';
+import { ObjectStorage } from './object-storage/ObjectStorage.js';
 import { VersionedPowerSyncMongoV3 } from './VersionedPowerSyncMongoV3.js';
+export interface MongoSyncBucketStorageContextV3 {
+    db: VersionedPowerSyncMongoV3;
+    replicationStreamId: number;
+    readPreference?: mongo.ReadPreference;
+    objectStorage: ObjectStorage | undefined;
+    /**
+     * Persisted mapping of the single sync config that read operations are served from.
+     *
+     * Implemented as a lazy getter: accessing it on a storage instance with multiple sync
+     * configs throws, but operations that don't use it remain unaffected.
+     */
+    readonly mapping: SingleSyncConfigBucketDefinitionMapping;
+}
 export declare class MongoSyncBucketStorageV3 extends MongoSyncBucketStorage {
     readonly db: VersionedPowerSyncMongoV3;
     readonly checksums: MongoChecksumsV3;
-    private readonly syncRulesV3;
-    constructor(factory: MongoBucketStorage, group_id: number, sync_rules: MongoPersistedSyncRulesContentV1, slot_name: string, writeCheckpointMode: storage.WriteCheckpointMode | undefined, options: MongoSyncBucketStorageOptions);
-    private get syncConfigId();
+    constructor(factory: MongoBucketStorage, replicationStreamId: number, replicationStream: MongoPersistedReplicationStream, replicationStreamName: string, writeCheckpointMode: storage.WriteCheckpointMode | undefined, options: MongoSyncBucketStorageOptions);
+    private get syncConfigIds();
     private get syncRulesCollection();
     private syncConfigMatch;
     private syncConfigProjection;
-    private syncConfigArrayFilters;
-    /**
-     * For now, we only support a single sync config per replication stream.
-     *
-     * In the future we'll add support for multiple.
-     */
-    private selectedSyncConfig;
+    private selectedSyncConfigs;
     protected initializeVersionStorage(): Promise<void>;
     protected createMongoChecksums(options: MongoSyncBucketStorageOptions): MongoChecksums;
+    protected createWriteCheckpointAPI(options: MongoCheckpointAPIOptions): MongoWriteCheckpointAPIV3;
     createMongoCompactor(options: MongoCompactOptions): MongoCompactor;
+    compactInitialReplication(options: CompactInitialReplicationOptions): Promise<CompactInitialReplicationResults>;
     protected createMongoParameterCompactor(checkpoint: InternalOpId, options: storage.CompactOptions): MongoParameterCompactor;
-    protected createWriterImpl(batchOptions: MongoBucketBatchOptions): storage.BucketStorageBatch;
-    protected fetchCheckpointState(session: mongo.ClientSession): Promise<{
-        checkpoint: bigint;
-        lsn: string | null;
-    } | null>;
-    protected getWriterSyncState(): Promise<{
-        lastCheckpointLsn: string | null;
-        resumeFromLsn: string | null;
-        keepaliveOp: bigint | null;
-        syncConfigId: lib_mongo.mongo.BSON.ObjectId;
-    }>;
+    protected fetchPersistedOpHead(): Promise<InternalOpId | null>;
+    protected createWriterImpl(options: storage.CreateWriterOptions): Promise<storage.BucketStorageBatch>;
+    protected fetchCheckpointState(session: mongo.ClientSession): Promise<MongoCheckpointState | null>;
     protected terminateSyncRuleState(): Promise<void>;
-    protected getStatusImpl(): Promise<storage.SyncRuleStatus>;
+    protected getStatusImpl(): Promise<storage.ReplicationStreamStatus>;
     protected clearSyncRuleState(): Promise<void>;
-    protected get versionContext(): MongoSyncBucketStorageContext<VersionedPowerSyncMongoV3>;
+    /**
+     * The persisted mapping of the single sync config that read operations are served from.
+     *
+     * Reads always operate on a single sync config: read-path storage instances are
+     * constructed for the active sync config only (see MongoBucketStorage.getActiveSyncConfig),
+     * and checkpoints are served from the single active config (see fetchCheckpointState).
+     * Within a single sync config, unique names are the persistence key of its rule mapping,
+     * so its name-keyed {@link SingleSyncConfigBucketDefinitionMapping} resolves sources from
+     * any parse of that config unambiguously - no parsed-set identity is required.
+     *
+     * Throws on storage instances with multiple sync configs (replication-side instances),
+     * which must not serve reads.
+     */
+    private singleSyncConfigMapping;
+    protected get versionContext(): MongoSyncBucketStorageContextV3;
     protected getParameterSetsImpl(checkpoint: MongoSyncBucketStorageCheckpoint, lookups: ScopedParameterLookup[], limit: number): Promise<ParameterLookupRows[]>;
-    protected getBucketDataBatchImpl(checkpoint: utils.InternalOpId, dataBuckets: storage.BucketDataRequest[], options?: storage.BucketDataBatchOptions): AsyncIterable<storage.SyncBucketDataChunk>;
-    protected clearBucketData(_signal?: AbortSignal): Promise<void>;
+    protected getBucketDataBatchImpl(checkpoint: MongoSyncBucketStorageCheckpoint, dataBuckets: storage.BucketDataRequest[], options?: storage.BucketDataBatchOptions): AsyncIterable<storage.SyncBucketDataChunk | storage.SyncBucketDataBatchEnd>;
+    protected clearBucketData(signal?: AbortSignal): Promise<void>;
     protected clearParameterIndexes(_signal?: AbortSignal): Promise<void>;
     protected clearSourceRecords(_signal?: AbortSignal): Promise<void>;
     protected clearBucketState(_signal?: AbortSignal): Promise<void>;
     protected clearSourceTables(_signal?: AbortSignal): Promise<void>;
+    protected clearCustomCheckpointRequests(signal?: AbortSignal): Promise<void>;
+    cleanupStoppedSyncConfigs(options: storage.CleanupStoppedSyncConfigsOptions): Promise<storage.CleanupStoppedSyncConfigsResult>;
     protected getDataBucketChangesImpl(options: GetCheckpointChangesOptions): Promise<Pick<CheckpointChanges, 'updatedDataBuckets' | 'invalidateDataBuckets'>>;
-    protected getParameterBucketChangesImpl(options: GetCheckpointChangesOptions): Promise<Pick<CheckpointChanges, 'updatedParameterLookups' | 'invalidateParameterBuckets'>>;
+    protected getParameterBucketChangesImpl(options: MongoGetCheckpointChangesOptions): Promise<Pick<CheckpointChanges, 'updatedParameterLookups' | 'invalidateParameterBuckets'>>;
 }
-export declare function getParameterSetsV3(ctx: MongoSyncBucketStorageContext<VersionedPowerSyncMongoV3>, checkpoint: MongoSyncBucketStorageCheckpoint, lookups: ScopedParameterLookup[], limit: number): Promise<ParameterLookupRows[]>;
-export declare function getBucketDataBatchV3(ctx: MongoSyncBucketStorageContext<VersionedPowerSyncMongoV3>, checkpoint: utils.InternalOpId, dataBuckets: storage.BucketDataRequest[], options?: storage.BucketDataBatchOptions): AsyncIterable<storage.SyncBucketDataChunk>;
-export declare function getDataBucketChangesV3(ctx: MongoSyncBucketStorageContext<VersionedPowerSyncMongoV3>, options: GetCheckpointChangesOptions): Promise<Pick<CheckpointChanges, 'updatedDataBuckets' | 'invalidateDataBuckets'>>;
-export declare function getParameterBucketChangesV3(ctx: MongoSyncBucketStorageContext<VersionedPowerSyncMongoV3>, options: GetCheckpointChangesOptions): Promise<Pick<CheckpointChanges, 'updatedParameterLookups' | 'invalidateParameterBuckets'>>;
+export declare function getParameterSetsV3(ctx: MongoSyncBucketStorageContextV3, checkpoint: MongoSyncBucketStorageCheckpoint, lookups: ScopedParameterLookup[], limit: number): Promise<ParameterLookupRows[]>;
+export declare function getBucketDataBatchV3(ctx: MongoSyncBucketStorageContextV3, checkpoint: MongoSyncBucketStorageCheckpoint, dataBuckets: storage.BucketDataRequest[], options?: storage.BucketDataBatchOptions): AsyncIterable<storage.SyncBucketDataChunk | storage.SyncBucketDataBatchEnd>;
+export declare function getDataBucketChangesV3(ctx: MongoSyncBucketStorageContextV3, options: GetCheckpointChangesOptions): Promise<Pick<CheckpointChanges, 'updatedDataBuckets' | 'invalidateDataBuckets'>>;
+/**
+ * Query the parameter entries changed between the two checkpoints, to determine which parameter
+ * lookups need to be re-evaluated.
+ *
+ * This runs at the next checkpoint's snapshot, so it still sees entries that parameter compaction
+ * deleted after that snapshot. Compaction that deleted entries before the snapshot is covered by
+ * the invalidation fence, checked before we get here.
+ */
+export declare function getParameterBucketChangesV3(ctx: MongoSyncBucketStorageContextV3, options: MongoGetCheckpointChangesOptions): Promise<Pick<CheckpointChanges, 'updatedParameterLookups' | 'invalidateParameterBuckets'>>;