@powersync/service-core 0.0.0-dev-20241021151922 → 0.0.0-dev-20241021184609

package/src/storage/mongo/MongoBucketBatch.ts

@@ -12,7 +12,7 @@ import {
   SaveOptions
 } from '../BucketStorage.js';
 import { SourceTable } from '../SourceTable.js';
-import { BatchedCustomWriteCheckpointOptions, CustomWriteCheckpointOptions } from '../WriteCheckpointAPI.js';
+import { CustomWriteCheckpointOptions } from '../write-checkpoint.js';
 import { PowerSyncMongo } from './db.js';
 import { CurrentBucket, CurrentDataDocument, SourceKey, SyncRuleDocument } from './models.js';
 import { MongoIdSequence } from './MongoIdSequence.js';
@@ -83,7 +83,7 @@ export class MongoBucketBatch extends DisposableObserver<BucketBatchStorageListe
     this.sync_rules = sync_rules;
   }
 
-  addCustomWriteCheckpoint(checkpoint: BatchedCustomWriteCheckpointOptions): void {
+  addCustomWriteCheckpoint(checkpoint: CustomWriteCheckpointOptions): void {
     this.write_checkpoint_batch.push({
       ...checkpoint,
       sync_rules_id: this.group_id

package/src/storage/mongo/MongoStorageProvider.ts

@@ -19,7 +19,8 @@ export class MongoStorageProvider implements BucketStorageProvider {
     return {
       storage: new MongoBucketStorage(database, {
         // TODO currently need the entire resolved config due to this
-        slot_name_prefix: resolvedConfig.slot_name_prefix
+        slot_name_prefix: resolvedConfig.slot_name_prefix,
+        write_checkpoint_mode: options.writeCheckpointMode
       }),
       shutDown: () => client.close(),
       tearDown: () => {

package/src/storage/mongo/MongoSyncBucketStorage.ts

@@ -2,8 +2,7 @@ import { SqliteJsonRow, SqliteJsonValue, SqlSyncRules } from '@powersync/service
 import * as bson from 'bson';
 import * as mongo from 'mongodb';
 
-import { DisposableObserver, logger } from '@powersync/lib-services-framework';
-import * as timers from 'timers/promises';
+import { DisposableObserver } from '@powersync/lib-services-framework';
 import * as db from '../../db/db-index.js';
 import * as util from '../../util/util-index.js';
 import {
@@ -27,19 +26,13 @@ import {
 import { ChecksumCache, FetchPartialBucketChecksum, PartialChecksum, PartialChecksumMap } from '../ChecksumCache.js';
 import { MongoBucketStorage } from '../MongoBucketStorage.js';
 import { SourceTable } from '../SourceTable.js';
-import {
-  BatchedCustomWriteCheckpointOptions,
-  ManagedWriteCheckpointOptions,
-  SyncStorageLastWriteCheckpointFilters,
-  WriteCheckpointAPI,
-  WriteCheckpointMode
-} from '../WriteCheckpointAPI.js';
 import { PowerSyncMongo } from './db.js';
 import { BucketDataDocument, BucketDataKey, SourceKey, SyncRuleState } from './models.js';
 import { MongoBucketBatch } from './MongoBucketBatch.js';
 import { MongoCompactor } from './MongoCompactor.js';
-import { MongoWriteCheckpointAPI } from './MongoWriteCheckpointAPI.js';
 import { BSON_DESERIALIZE_OPTIONS, idPrefixFilter, mapOpEntry, readSingleBatch, serializeLookup } from './util.js';
+import { logger } from '@powersync/lib-services-framework';
+import * as timers from 'timers/promises';
 
 export class MongoSyncBucketStorage
   extends DisposableObserver<SyncRulesBucketStorageListener>
@@ -53,53 +46,15 @@ export class MongoSyncBucketStorage
   });
 
   private parsedSyncRulesCache: SqlSyncRules | undefined;
-  private writeCheckpointAPI: WriteCheckpointAPI;
 
   constructor(
     public readonly factory: MongoBucketStorage,
     public readonly group_id: number,
     private readonly sync_rules: PersistedSyncRulesContent,
-    public readonly slot_name: string,
-    writeCheckpointMode: WriteCheckpointMode = WriteCheckpointMode.MANAGED
+    public readonly slot_name: string
   ) {
     super();
     this.db = factory.db;
-    this.writeCheckpointAPI = new MongoWriteCheckpointAPI({
-      db: this.db,
-      mode: writeCheckpointMode
-    });
-  }
-
-  get writeCheckpointMode() {
-    return this.writeCheckpointAPI.writeCheckpointMode;
-  }
-
-  setWriteCheckpointMode(mode: WriteCheckpointMode): void {
-    this.writeCheckpointAPI.setWriteCheckpointMode(mode);
-  }
-
-  batchCreateCustomWriteCheckpoints(checkpoints: BatchedCustomWriteCheckpointOptions[]): Promise<void> {
-    return this.writeCheckpointAPI.batchCreateCustomWriteCheckpoints(
-      checkpoints.map((checkpoint) => ({ ...checkpoint, sync_rules_id: this.group_id }))
-    );
-  }
-
-  createCustomWriteCheckpoint(checkpoint: BatchedCustomWriteCheckpointOptions): Promise<bigint> {
-    return this.writeCheckpointAPI.createCustomWriteCheckpoint({
-      ...checkpoint,
-      sync_rules_id: this.group_id
-    });
-  }
-
-  createManagedWriteCheckpoint(checkpoint: ManagedWriteCheckpointOptions): Promise<bigint> {
-    return this.writeCheckpointAPI.createManagedWriteCheckpoint(checkpoint);
-  }
-
-  lastWriteCheckpoint(filters: SyncStorageLastWriteCheckpointFilters): Promise<bigint | null> {
-    return this.writeCheckpointAPI.lastWriteCheckpoint({
-      ...filters,
-      sync_rules_id: this.group_id
-    });
   }
 
   getParsedSyncRules(options: ParseSyncRulesOptions): SqlSyncRules {

package/src/storage/mongo/MongoWriteCheckpointAPI.ts

@@ -7,7 +7,7 @@ import {
   ManagedWriteCheckpointOptions,
   WriteCheckpointAPI,
   WriteCheckpointMode
-} from '../WriteCheckpointAPI.js';
+} from '../write-checkpoint.js';
 import { PowerSyncMongo } from './db.js';
 
 export type MongoCheckpointAPIOptions = {
@@ -17,19 +17,11 @@ export type MongoCheckpointAPIOptions = {
 
 export class MongoWriteCheckpointAPI implements WriteCheckpointAPI {
   readonly db: PowerSyncMongo;
-  private _mode: WriteCheckpointMode;
+  readonly mode: WriteCheckpointMode;
 
   constructor(options: MongoCheckpointAPIOptions) {
     this.db = options.db;
-    this._mode = options.mode;
-  }
-
-  get writeCheckpointMode() {
-    return this._mode;
-  }
-
-  setWriteCheckpointMode(mode: WriteCheckpointMode): void {
-    this._mode = mode;
+    this.mode = options.mode;
   }
 
   async batchCreateCustomWriteCheckpoints(checkpoints: CustomWriteCheckpointOptions[]): Promise<void> {
@@ -37,9 +29,9 @@ export class MongoWriteCheckpointAPI implements WriteCheckpointAPI {
   }
 
   async createCustomWriteCheckpoint(options: CustomWriteCheckpointOptions): Promise<bigint> {
-    if (this.writeCheckpointMode !== WriteCheckpointMode.CUSTOM) {
+    if (this.mode !== WriteCheckpointMode.CUSTOM) {
       throw new framework.errors.ValidationError(
-        `Creating a custom Write Checkpoint when the current Write Checkpoint mode is set to "${this.writeCheckpointMode}"`
+        `Creating a custom Write Checkpoint when the current Write Checkpoint mode is set to "${this.mode}"`
       );
     }
 
@@ -60,9 +52,9 @@ export class MongoWriteCheckpointAPI implements WriteCheckpointAPI {
   }
 
   async createManagedWriteCheckpoint(checkpoint: ManagedWriteCheckpointOptions): Promise<bigint> {
-    if (this.writeCheckpointMode !== WriteCheckpointMode.MANAGED) {
+    if (this.mode !== WriteCheckpointMode.MANAGED) {
       throw new framework.errors.ValidationError(
-        `Attempting to create a managed Write Checkpoint when the current Write Checkpoint mode is set to "${this.writeCheckpointMode}"`
+        `Creating a managed Write Checkpoint when the current Write Checkpoint mode is set to "${this.mode}"`
       );
     }
 
@@ -85,7 +77,7 @@ export class MongoWriteCheckpointAPI implements WriteCheckpointAPI {
   }
 
   async lastWriteCheckpoint(filters: LastWriteCheckpointFilters): Promise<bigint | null> {
-    switch (this.writeCheckpointMode) {
+    switch (this.mode) {
       case WriteCheckpointMode.CUSTOM:
         if (false == 'sync_rules_id' in filters) {
           throw new framework.errors.ValidationError(`Sync rules ID is required for custom Write Checkpoint filtering`);

package/src/storage/storage-index.ts

@@ -5,7 +5,6 @@ export * from './SourceEntity.js';
 export * from './SourceTable.js';
 export * from './StorageEngine.js';
 
-export * from './mongo/config.js';
 export * from './mongo/db.js';
 export * from './mongo/models.js';
 export * from './mongo/MongoBucketBatch.js';
@@ -18,4 +17,5 @@ export * from './mongo/MongoSyncRulesLock.js';
 export * from './mongo/OperationBatch.js';
 export * from './mongo/PersistedBatch.js';
 export * from './mongo/util.js';
-export * from './WriteCheckpointAPI.js';
+export * from './mongo/config.js';
+export * from './write-checkpoint.js';

package/src/storage/{WriteCheckpointAPI.ts → write-checkpoint.ts}

@@ -26,19 +26,19 @@ export interface CustomWriteCheckpointFilters extends BaseWriteCheckpointIdentif
   sync_rules_id: number;
 }
 
-export interface BatchedCustomWriteCheckpointOptions extends BaseWriteCheckpointIdentifier {
+export interface CustomWriteCheckpointOptions extends CustomWriteCheckpointFilters {
   /**
    * A supplied incrementing Write Checkpoint number
    */
   checkpoint: bigint;
 }
 
-export interface CustomWriteCheckpointOptions extends BatchedCustomWriteCheckpointOptions {
-  /**
-   * Sync rules which were active when this checkpoint was created.
-   */
-  sync_rules_id: number;
-}
+/**
+ * Options for creating a custom Write Checkpoint in a batch.
+ * A {@link BucketStorageBatch} is already associated with a Sync Rules instance.
+ * The `sync_rules_id` is not required here.
+ */
+export type BatchedCustomWriteCheckpointOptions = Omit<CustomWriteCheckpointOptions, 'sync_rules_id'>;
 
 /**
  * Managed Write Checkpoints are a mapping of User ID to replication HEAD
@@ -52,33 +52,15 @@ export interface ManagedWriteCheckpointFilters extends BaseWriteCheckpointIdenti
 
 export type ManagedWriteCheckpointOptions = ManagedWriteCheckpointFilters;
 
-export type SyncStorageLastWriteCheckpointFilters = BaseWriteCheckpointIdentifier | ManagedWriteCheckpointFilters;
 export type LastWriteCheckpointFilters = CustomWriteCheckpointFilters | ManagedWriteCheckpointFilters;
 
-export interface BaseWriteCheckpointAPI {
-  readonly writeCheckpointMode: WriteCheckpointMode;
-  setWriteCheckpointMode(mode: WriteCheckpointMode): void;
-  createManagedWriteCheckpoint(checkpoint: ManagedWriteCheckpointOptions): Promise<bigint>;
-}
-
-/**
- * Write Checkpoint API to be used in conjunction with a {@link SyncRulesBucketStorage}.
- * This storage corresponds with a set of sync rules. These APIs don't require specifying a
- * sync rules id.
- */
-export interface SyncStorageWriteCheckpointAPI extends BaseWriteCheckpointAPI {
-  batchCreateCustomWriteCheckpoints(checkpoints: BatchedCustomWriteCheckpointOptions[]): Promise<void>;
-  createCustomWriteCheckpoint(checkpoint: BatchedCustomWriteCheckpointOptions): Promise<bigint>;
-  lastWriteCheckpoint(filters: SyncStorageLastWriteCheckpointFilters): Promise<bigint | null>;
-}
-
-/**
- * Write Checkpoint API which is interfaced directly with the storage layer. This requires
- * sync rules identifiers for custom write checkpoints.
- */
-export interface WriteCheckpointAPI extends BaseWriteCheckpointAPI {
+export interface WriteCheckpointAPI {
   batchCreateCustomWriteCheckpoints(checkpoints: CustomWriteCheckpointOptions[]): Promise<void>;
+
   createCustomWriteCheckpoint(checkpoint: CustomWriteCheckpointOptions): Promise<bigint>;
+
+  createManagedWriteCheckpoint(checkpoint: ManagedWriteCheckpointOptions): Promise<bigint>;
+
   lastWriteCheckpoint(filters: LastWriteCheckpointFilters): Promise<bigint | null>;
 }
 

package/src/util/config/compound-config-collector.ts

@@ -122,8 +122,7 @@ export class CompoundConfigCollector {
       },
       // TODO maybe move this out of the connection or something
       // slot_name_prefix: connections[0]?.slot_name_prefix ?? 'powersync_'
-      slot_name_prefix: 'powersync_',
-      parameters: baseConfig.parameters ?? {}
+      slot_name_prefix: 'powersync_'
     };
 
     return config;

package/src/util/config/types.ts

@@ -64,5 +64,4 @@ export type ResolvedPowerSyncConfig = {
 
   /** Prefix for postgres replication slot names. May eventually be connection-specific. */
   slot_name_prefix: string;
-  parameters: Record<string, number | string | boolean | null>;
 };