@powersync/service-module-postgres 0.0.0-dev-20260203155513 → 0.0.0-dev-20260223080959

package/CHANGELOG.md

@@ -1,6 +1,51 @@
 # @powersync/service-module-postgres
 
-## 0.0.0-dev-20260203155513
+## 0.0.0-dev-20260223080959
+
+### Minor Changes
+
+- 8bd83e8: Introduce storage versions.
+
+### Patch Changes
+
+- Updated dependencies [0998251]
+- Updated dependencies [1c45667]
+- Updated dependencies [8a4c34e]
+- Updated dependencies [8bd83e8]
+  - @powersync/service-core@0.0.0-dev-20260223080959
+  - @powersync/service-types@0.0.0-dev-20260223080959
+  - @powersync/service-sync-rules@0.0.0-dev-20260223080959
+  - @powersync/lib-service-postgres@0.0.0-dev-20260223080959
+  - @powersync/lib-services-framework@0.0.0-dev-20260223080959
+  - @powersync/service-jpgwire@0.0.0-dev-20260223080959
+
+## 0.17.2
+
+### Patch Changes
+
+- Updated dependencies [a04252d]
+  - @powersync/service-sync-rules@0.31.1
+  - @powersync/lib-services-framework@0.8.2
+  - @powersync/service-jpgwire@0.21.12
+  - @powersync/service-core@1.19.2
+  - @powersync/lib-service-postgres@0.4.21
+
+## 0.17.1
+
+### Patch Changes
+
+- 479997b: Introduce `BaseSyncConfig` to represent SQL-based sync rules and precompiled sync plans.
+- Updated dependencies [0e99ce0]
+- Updated dependencies [479997b]
+- Updated dependencies [d1c2228]
+- Updated dependencies [1a1a4cc]
+  - @powersync/service-sync-rules@0.31.0
+  - @powersync/service-core@1.19.1
+  - @powersync/lib-services-framework@0.8.1
+  - @powersync/service-jpgwire@0.21.11
+  - @powersync/lib-service-postgres@0.4.20
+
+## 0.17.0
 
 ### Minor Changes
 
@@ -14,16 +59,15 @@
 - Updated dependencies [781d0e3]
 - Updated dependencies [e578245]
 - Updated dependencies [3040079]
-- Updated dependencies [0255483]
-- Updated dependencies [3207fd2]
+- Updated dependencies [3b2c512]
 - Updated dependencies [a02cc58]
 - Updated dependencies [e108ffd]
-  - @powersync/service-core@0.0.0-dev-20260203155513
-  - @powersync/service-sync-rules@0.0.0-dev-20260203155513
-  - @powersync/service-types@0.0.0-dev-20260203155513
-  - @powersync/lib-services-framework@0.0.0-dev-20260203155513
-  - @powersync/service-jpgwire@0.0.0-dev-20260203155513
-  - @powersync/lib-service-postgres@0.0.0-dev-20260203155513
+  - @powersync/service-core@1.19.0
+  - @powersync/service-sync-rules@0.30.0
+  - @powersync/lib-services-framework@0.8.0
+  - @powersync/service-types@0.14.0
+  - @powersync/service-jpgwire@0.21.10
+  - @powersync/lib-service-postgres@0.4.19
 
 ## 0.16.16
 

package/dist/replication/replication-utils.d.ts

@@ -20,7 +20,7 @@ export interface GetDebugTablesInfoOptions {
     publicationName: string;
     connectionTag: string;
     tablePatterns: sync_rules.TablePattern[];
-    syncRules: sync_rules.SqlSyncRules;
+    syncRules: sync_rules.SyncConfig;
 }
 export declare function getDebugTablesInfo(options: GetDebugTablesInfoOptions): Promise<PatternResult[]>;
 export interface GetDebugTableInfoOptions {
@@ -30,7 +30,7 @@ export interface GetDebugTableInfoOptions {
     connectionTag: string;
     tablePattern: sync_rules.TablePattern;
     relationId: number | null;
-    syncRules: sync_rules.SqlSyncRules;
+    syncRules: sync_rules.SyncConfig;
 }
 export declare function getDebugTableInfo(options: GetDebugTableInfoOptions): Promise<service_types.TableInfo>;
 export declare function cleanUpReplicationSlot(slotName: string, db: pgwire.PgClient): Promise<void>;

package/package.json

@@ -5,7 +5,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.0-dev-20260203155513",
+  "version": "0.0.0-dev-20260223080959",
   "main": "dist/index.js",
   "license": "FSL-1.1-ALv2",
   "type": "module",
@@ -25,20 +25,20 @@
     "semver": "^7.5.4",
     "ts-codec": "^1.3.0",
     "uuid": "^11.1.0",
-    "@powersync/lib-service-postgres": "0.0.0-dev-20260203155513",
-    "@powersync/lib-services-framework": "0.0.0-dev-20260203155513",
-    "@powersync/service-core": "0.0.0-dev-20260203155513",
-    "@powersync/service-jpgwire": "0.0.0-dev-20260203155513",
+    "@powersync/lib-service-postgres": "0.0.0-dev-20260223080959",
+    "@powersync/lib-services-framework": "0.0.0-dev-20260223080959",
+    "@powersync/service-core": "0.0.0-dev-20260223080959",
+    "@powersync/service-jpgwire": "0.0.0-dev-20260223080959",
     "@powersync/service-jsonbig": "0.17.12",
-    "@powersync/service-sync-rules": "0.0.0-dev-20260203155513",
-    "@powersync/service-types": "0.0.0-dev-20260203155513"
+    "@powersync/service-sync-rules": "0.0.0-dev-20260223080959",
+    "@powersync/service-types": "0.0.0-dev-20260223080959"
   },
   "devDependencies": {
     "@types/semver": "^7.5.4",
-    "@powersync/service-core-tests": "0.0.0-dev-20260203155513",
-    "@powersync/service-module-mongodb-storage": "0.0.0-dev-20260203155513",
-    "@powersync/lib-service-postgres": "0.0.0-dev-20260203155513",
-    "@powersync/service-module-postgres-storage": "0.0.0-dev-20260203155513"
+    "@powersync/service-core-tests": "0.0.0-dev-20260223080959",
+    "@powersync/service-module-mongodb-storage": "0.0.0-dev-20260223080959",
+    "@powersync/lib-service-postgres": "0.0.0-dev-20260223080959",
+    "@powersync/service-module-postgres-storage": "0.0.0-dev-20260223080959"
   },
   "scripts": {
     "build": "tsc -b",

package/src/replication/replication-utils.ts

@@ -196,7 +196,7 @@ export interface GetDebugTablesInfoOptions {
   publicationName: string;
   connectionTag: string;
   tablePatterns: sync_rules.TablePattern[];
-  syncRules: sync_rules.SqlSyncRules;
+  syncRules: sync_rules.SyncConfig;
 }
 
 export async function getDebugTablesInfo(options: GetDebugTablesInfoOptions): Promise<PatternResult[]> {
@@ -296,7 +296,7 @@ export interface GetDebugTableInfoOptions {
   connectionTag: string;
   tablePattern: sync_rules.TablePattern;
   relationId: number | null;
-  syncRules: sync_rules.SqlSyncRules;
+  syncRules: sync_rules.SyncConfig;
 }
 
 export async function getDebugTableInfo(options: GetDebugTableInfoOptions): Promise<service_types.TableInfo> {

package/test/src/checkpoints.test.ts

@@ -1,7 +1,7 @@
 import { PostgresRouteAPIAdapter } from '@module/api/PostgresRouteAPIAdapter.js';
-import { checkpointUserId, createWriteCheckpoint, TestStorageFactory } from '@powersync/service-core';
+import { checkpointUserId, createWriteCheckpoint } from '@powersync/service-core';
 import { describe, test } from 'vitest';
-import { describeWithStorage } from './util.js';
+import { describeWithStorage, StorageVersionTestContext } from './util.js';
 import { WalStreamTestContext } from './wal_stream_utils.js';
 
 import timers from 'node:timers/promises';
@@ -15,9 +15,9 @@ describe('checkpoint tests', () => {
   describeWithStorage({}, checkpointTests);
 });
 
-const checkpointTests = (factory: TestStorageFactory) => {
+const checkpointTests = ({ factory, storageVersion }: StorageVersionTestContext) => {
   test('write checkpoints', { timeout: 50_000 }, async () => {
-    await using context = await WalStreamTestContext.open(factory);
+    await using context = await WalStreamTestContext.open(factory, { storageVersion });
 
     await context.updateSyncRules(BASIC_SYNC_RULES);
     const { pool } = context;

package/test/src/chunked_snapshots.test.ts

@@ -1,17 +1,21 @@
-import { reduceBucket, TestStorageFactory } from '@powersync/service-core';
+import { reduceBucket } from '@powersync/service-core';
 import { METRICS_HELPER } from '@powersync/service-core-tests';
 import { SqliteJsonValue } from '@powersync/service-sync-rules';
 import * as crypto from 'node:crypto';
 import * as timers from 'timers/promises';
 import { describe, expect, test } from 'vitest';
-import { describeWithStorage } from './util.js';
+import { describeWithStorage, StorageVersionTestContext } from './util.js';
 import { WalStreamTestContext } from './wal_stream_utils.js';
 
 describe('chunked snapshots', () => {
   describeWithStorage({ timeout: 120_000 }, defineBatchTests);
 });
 
-function defineBatchTests(factory: TestStorageFactory) {
+function defineBatchTests({ factory, storageVersion }: StorageVersionTestContext) {
+  const openContext = (options?: Parameters<typeof WalStreamTestContext.open>[1]) => {
+    return WalStreamTestContext.open(factory, { ...options, storageVersion });
+  };
+
   // We need to test every supported type, since chunking could be quite sensitive to
   // how each specific type is handled.
   test('chunked snapshot edge case (int2)', async () => {
@@ -89,7 +93,7 @@ function defineBatchTests(factory: TestStorageFactory) {
     // 5. Logical replication picks up the UPDATE above, but it is missing the TOAST column.
     // 6. We end up with a row that has a missing TOAST column.
 
-    await using context = await WalStreamTestContext.open(factory, {
+    await using context = await openContext({
       // We need to use a smaller chunk size here, so that we can run a query in between chunks
       walStreamOptions: { snapshotChunkLength: 100 }
     });

package/test/src/large_batch.test.ts

@@ -1,14 +1,11 @@
-import { storage } from '@powersync/service-core';
 import { describe, expect, test } from 'vitest';
 import { populateData } from '../../dist/utils/populate_test_data.js';
 import { env } from './env.js';
-import { describeWithStorage, TEST_CONNECTION_OPTIONS } from './util.js';
+import { describeWithStorage, StorageVersionTestContext, TEST_CONNECTION_OPTIONS } from './util.js';
 import { WalStreamTestContext } from './wal_stream_utils.js';
 
 describe.skipIf(!(env.CI || env.SLOW_TESTS))('batch replication', function () {
-  describeWithStorage({ timeout: 240_000 }, function (factory) {
-    defineBatchTests(factory);
-  });
+  describeWithStorage({ timeout: 240_000 }, defineBatchTests);
 });
 
 const BASIC_SYNC_RULES = `bucket_definitions:
@@ -16,9 +13,13 @@ const BASIC_SYNC_RULES = `bucket_definitions:
     data:
       - SELECT id, description, other FROM "test_data"`;
 
-function defineBatchTests(factory: storage.TestStorageFactory) {
+function defineBatchTests({ factory, storageVersion }: StorageVersionTestContext) {
+  const openContext = (options?: Parameters<typeof WalStreamTestContext.open>[1]) => {
+    return WalStreamTestContext.open(factory, { ...options, storageVersion });
+  };
+
   test('update large record', async () => {
-    await using context = await WalStreamTestContext.open(factory);
+    await using context = await openContext();
     // This test generates a large transaction in MongoDB, despite the replicated data
     // not being that large.
     // If we don't limit transaction size, we could run into this error:
@@ -41,17 +42,16 @@ function defineBatchTests(factory: storage.TestStorageFactory) {
 
     context.startStreaming();
 
-    const checkpoint = await context.getCheckpoint({ timeout: 100_000 });
+    const checksum = await context.getChecksums(['global[]'], { timeout: 50_000 });
     const duration = Date.now() - start;
     const used = Math.round(process.memoryUsage().heapUsed / 1024 / 1024);
-    const checksum = await context.storage!.getChecksums(checkpoint, ['global[]']);
     expect(checksum.get('global[]')!.count).toEqual(operation_count);
     const perSecond = Math.round((operation_count / duration) * 1000);
     console.log(`${operation_count} ops in ${duration}ms ${perSecond} ops/s. ${used}MB heap`);
   });
 
   test('initial replication performance', async () => {
-    await using context = await WalStreamTestContext.open(factory);
+    await using context = await openContext();
     // Manual test to check initial replication performance and memory usage
     await context.updateSyncRules(BASIC_SYNC_RULES);
     const { pool } = context;
@@ -89,9 +89,8 @@ function defineBatchTests(factory: storage.TestStorageFactory) {
       await context.replicateSnapshot();
       context.startStreaming();
 
-      const checkpoint = await context.getCheckpoint({ timeout: 100_000 });
+      const checksum = await context.getChecksums(['global[]'], { timeout: 100_000 });
       const duration = Date.now() - start;
-      const checksum = await context.storage!.getChecksums(checkpoint, ['global[]']);
       expect(checksum.get('global[]')!.count).toEqual(operation_count);
       const perSecond = Math.round((operation_count / duration) * 1000);
       console.log(`${operation_count} ops in ${duration}ms ${perSecond} ops/s.`);
@@ -102,7 +101,7 @@ function defineBatchTests(factory: storage.TestStorageFactory) {
   });
 
   test('large number of operations', async () => {
-    await using context = await WalStreamTestContext.open(factory);
+    await using context = await openContext();
     // This just tests performance of a large number of operations inside a transaction.
     await context.updateSyncRules(BASIC_SYNC_RULES);
     const { pool } = context;
@@ -141,10 +140,9 @@ function defineBatchTests(factory: storage.TestStorageFactory) {
 
     context.startStreaming();
 
-    const checkpoint = await context.getCheckpoint({ timeout: 50_000 });
+    const checksum = await context.getChecksums(['global[]']);
     const duration = Date.now() - start;
     const used = Math.round(process.memoryUsage().heapUsed / 1024 / 1024);
-    const checksum = await context.storage!.getChecksums(checkpoint, ['global[]']);
     expect(checksum.get('global[]')!.count).toEqual(operationCount);
     const perSecond = Math.round((operationCount / duration) * 1000);
     // This number depends on the test machine, so we keep the test significantly
@@ -158,10 +156,8 @@ function defineBatchTests(factory: storage.TestStorageFactory) {
     const truncateStart = Date.now();
     await pool.query(`TRUNCATE test_data`);
 
-    const checkpoint2 = await context.getCheckpoint({ timeout: 20_000 });
+    const checksum2 = await context.getChecksums(['global[]'], { timeout: 20_000 });
     const truncateDuration = Date.now() - truncateStart;
-
-    const checksum2 = await context.storage!.getChecksums(checkpoint2, ['global[]']);
     const truncateCount = checksum2.get('global[]')!.count - checksum.get('global[]')!.count;
     expect(truncateCount).toEqual(numTransactions * perTransaction);
     const truncatePerSecond = Math.round((truncateCount / truncateDuration) * 1000);
@@ -183,7 +179,7 @@ function defineBatchTests(factory: storage.TestStorageFactory) {
     // 4. Another document to make sure the internal batching overflows
     //    to a second batch.
 
-    await using context = await WalStreamTestContext.open(factory);
+    await using context = await openContext();
     await context.updateSyncRules(`bucket_definitions:
   global:
     data:
@@ -227,9 +223,7 @@ function defineBatchTests(factory: storage.TestStorageFactory) {
     await context.replicateSnapshot();
 
     context.startStreaming();
-
-    const checkpoint = await context.getCheckpoint({ timeout: 50_000 });
-    const checksum = await context.storage!.getChecksums(checkpoint, ['global[]']);
+    const checksum = await context.getChecksums(['global[]'], { timeout: 50_000 });
     expect(checksum.get('global[]')!.count).toEqual((numDocs + 2) * 4);
   });
 

package/test/src/resuming_snapshots.test.ts

@@ -1,27 +1,30 @@
 import { describe, expect, test } from 'vitest';
 import { env } from './env.js';
-import { describeWithStorage } from './util.js';
+import { describeWithStorage, StorageVersionTestContext } from './util.js';
 import { WalStreamTestContext } from './wal_stream_utils.js';
-import { TestStorageFactory } from '@powersync/service-core';
 import { METRICS_HELPER } from '@powersync/service-core-tests';
 import { ReplicationMetric } from '@powersync/service-types';
 import * as timers from 'node:timers/promises';
 import { ReplicationAbortedError } from '@powersync/lib-services-framework';
 
 describe.skipIf(!(env.CI || env.SLOW_TESTS))('batch replication', function () {
-  describeWithStorage({ timeout: 240_000 }, function (factory) {
+  describeWithStorage({ timeout: 240_000 }, function ({ factory, storageVersion }) {
     test('resuming initial replication (1)', async () => {
       // Stop early - likely to not include deleted row in first replication attempt.
-      await testResumingReplication(factory, 2000);
+      await testResumingReplication(factory, storageVersion, 2000);
     });
     test('resuming initial replication (2)', async () => {
       // Stop late - likely to include deleted row in first replication attempt.
-      await testResumingReplication(factory, 8000);
+      await testResumingReplication(factory, storageVersion, 8000);
     });
   });
 });
 
-async function testResumingReplication(factory: TestStorageFactory, stopAfter: number) {
+async function testResumingReplication(
+  factory: StorageVersionTestContext['factory'],
+  storageVersion: number,
+  stopAfter: number
+) {
   // This tests interrupting and then resuming initial replication.
   // We interrupt replication after test_data1 has fully replicated, and
   // test_data2 has partially replicated.
@@ -33,7 +36,10 @@ async function testResumingReplication(factory: TestStorageFactory, stopAfter: n
   //    have been / have not been replicated at that point is not deterministic.
   //    We do allow for some variation in the test results to account for this.
 
-  await using context = await WalStreamTestContext.open(factory, { walStreamOptions: { snapshotChunkLength: 1000 } });
+  await using context = await WalStreamTestContext.open(factory, {
+    storageVersion,
+    walStreamOptions: { snapshotChunkLength: 1000 }
+  });
 
   await context.updateSyncRules(`bucket_definitions:
   global:
@@ -84,6 +90,7 @@ async function testResumingReplication(factory: TestStorageFactory, stopAfter: n
   // Bypass the usual "clear db on factory open" step.
   await using context2 = await WalStreamTestContext.open(factory, {
     doNotClear: true,
+    storageVersion,
     walStreamOptions: { snapshotChunkLength: 1000 }
   });
 

package/test/src/route_api_adapter.test.ts

@@ -20,7 +20,9 @@ describe('PostgresRouteAPIAdapter tests', () => {
       `);
 
       const schema = await api.getConnectionSchema();
-      expect(schema).toStrictEqual([
+      // Ignore any other potential schemas in the test database, for example the 'powersync' schema.
+      const filtered = schema.filter((s) => s.name == 'public');
+      expect(filtered).toStrictEqual([
         {
           name: 'public',
           tables: [