@powersync/service-module-postgres-storage 0.0.0-dev-20260313100403 → 0.0.0-dev-20260511080634

package/src/storage/checkpoints/PostgresWriteCheckpointAPI.ts

@@ -64,7 +64,9 @@ export class PostgresWriteCheckpointAPI implements storage.WriteCheckpointAPI {
     switch (this.writeCheckpointMode) {
       case storage.WriteCheckpointMode.CUSTOM:
         if (false == 'sync_rules_id' in filters) {
-          throw new framework.errors.ValidationError(`Sync rules ID is required for custom Write Checkpoint filtering`);
+          throw new framework.errors.ValidationError(
+            `Replication stream ID is required for custom Write Checkpoint filtering`
+          );
         }
         return this.lastCustomWriteCheckpoint(filters as storage.CustomWriteCheckpointFilters);
       case storage.WriteCheckpointMode.MANAGED:

package/src/storage/current-data-store.ts

@@ -1,8 +1,8 @@
 import * as lib_postgres from '@powersync/lib-service-postgres';
 import { storage } from '@powersync/service-core';
 import * as t from 'ts-codec';
-import { pick } from '../utils/ts-codec.js';
 import * as models from '../types/models/CurrentData.js';
+import { pick } from '../utils/ts-codec.js';
 
 type Queryable = Pick<lib_postgres.DatabaseClient, 'sql' | 'streamRows'>;
 

package/src/storage/sync-rules/PostgresPersistedSyncRulesContent.ts

@@ -1,5 +1,5 @@
 import * as lib_postgres from '@powersync/lib-service-postgres';
-import { ErrorCode, logger, ServiceError } from '@powersync/lib-services-framework';
+import { ErrorCode, ServiceError } from '@powersync/lib-services-framework';
 import { storage } from '@powersync/service-core';
 import { models } from '../../types/types.js';
 
@@ -31,17 +31,14 @@ export class PostgresPersistedSyncRulesContent extends storage.PersistedSyncRule
     });
     const lockHandle = await manager.acquire();
     if (!lockHandle) {
-      throw new ServiceError(
-        ErrorCode.PSYNC_S1003,
-        `Sync rules: ${this.id} have been locked by another process for replication.`
-      );
+      throw new ServiceError(ErrorCode.PSYNC_S1003, `Replication stream is locked by another process, standing by.`);
     }
 
     const interval = setInterval(async () => {
       try {
         await lockHandle.refresh();
       } catch (e) {
-        logger.error('Failed to refresh lock', e);
+        this.logger.error('Failed to refresh lock', e);
         clearInterval(interval);
       }
     }, 30_130);

package/src/types/models/SyncRules.ts

@@ -1,4 +1,5 @@
 import { framework, storage } from '@powersync/service-core';
+import { ReplicationError } from '@powersync/service-types';
 import * as t from 'ts-codec';
 import { bigint, pgwire_number } from '../codecs.js';
 import { jsonContainerObject } from './json.js';
@@ -59,7 +60,8 @@ export const SyncRules = t.object({
           overrides: t.record(t.boolean),
           maxTimeValuePrecision: t.number.optional()
         }),
-        eventDescriptors: t.record(t.array(t.string))
+        eventDescriptors: t.record(t.array(t.string)),
+        errors: t.array(ReplicationError).optional()
       })
     )
   )

package/src/types/models/models-index.ts

@@ -5,7 +5,7 @@ export * from './BucketParameters.js';
 export * from './CurrentData.js';
 export * from './Instance.js';
 export * from './Migration.js';
+export * from './SdkReporting.js';
 export * from './SourceTable.js';
 export * from './SyncRules.js';
 export * from './WriteCheckpoint.js';
-export * from './SdkReporting.js';

package/src/utils/test-utils.ts

@@ -1,9 +1,9 @@
+import { createLogger, logger as defaultLogger, transports } from '@powersync/lib-services-framework';
 import { framework, PowerSyncMigrationManager, ServiceContext, TestStorageOptions } from '@powersync/service-core';
 import { PostgresMigrationAgent } from '../migrations/PostgresMigrationAgent.js';
-import { normalizePostgresStorageConfig, PostgresStorageConfigDecoded } from '../types/types.js';
-import { PostgresReportStorage } from '../storage/PostgresReportStorage.js';
 import { PostgresBucketStorageFactory } from '../storage/PostgresBucketStorageFactory.js';
-import { logger as defaultLogger, createLogger, transports } from '@powersync/lib-services-framework';
+import { PostgresReportStorage } from '../storage/PostgresReportStorage.js';
+import { normalizePostgresStorageConfig, PostgresStorageConfigDecoded } from '../types/types.js';
 import { truncateTables } from './db.js';
 
 export type PostgresTestStorageOptions = {

package/src/utils/utils-index.ts

@@ -1,5 +1,5 @@
 export * from './bson.js';
 export * from './bucket-data.js';
 export * from './db.js';
-export * from './ts-codec.js';
 export * as test_utils from './test-utils.js';
+export * from './ts-codec.js';

package/test/src/__snapshots__/{client-connections-storage.test.ts.snap → connection-report-storage.test.ts.snap}

@@ -19,7 +19,7 @@ exports[`Connection report storage > Should create a connection event if its aft
 
 exports[`Connection report storage > Should delete rows older than specified range 1`] = `
 {
-  "sdk_breakdown": [
+  "sdks": [
     {
       "clients": 1,
       "sdk": "powersync-dart/1.6.4",
@@ -51,7 +51,7 @@ exports[`Connection report storage > Should delete rows older than specified ran
       "users": 1,
     },
   ],
-  "total_users": 5,
+  "users": 5,
 }
 `;
 
@@ -77,9 +77,9 @@ exports[`Connection report storage > Should update a connection event if its wit
 ]
 `;
 
-exports[`Report storage tests > getClientConnectionsSummary returns the past day summary 1`] = `
+exports[`Report storage tests > Should show connection report data for user over the past day 1`] = `
 {
-  "sdk_breakdown": [
+  "sdks": [
     {
       "clients": 1,
       "sdk": "powersync-dart/1.6.4",
@@ -101,13 +101,13 @@ exports[`Report storage tests > getClientConnectionsSummary returns the past day
       "users": 1,
     },
   ],
-  "total_users": 3,
+  "users": 3,
 }
 `;
 
-exports[`Report storage tests > getClientConnectionsSummary returns the past month summary 1`] = `
+exports[`Report storage tests > Should show connection report data for user over the past month 1`] = `
 {
-  "sdk_breakdown": [
+  "sdks": [
     {
       "clients": 1,
       "sdk": "powersync-dart/1.6.4",
@@ -149,13 +149,13 @@ exports[`Report storage tests > getClientConnectionsSummary returns the past mon
       "users": 1,
     },
   ],
-  "total_users": 7,
+  "users": 7,
 }
 `;
 
-exports[`Report storage tests > getClientConnectionsSummary returns the past week summary 1`] = `
+exports[`Report storage tests > Should show connection report data for user over the past week 1`] = `
 {
-  "sdk_breakdown": [
+  "sdks": [
     {
       "clients": 1,
       "sdk": "powersync-dart/1.6.4",
@@ -187,13 +187,13 @@ exports[`Report storage tests > getClientConnectionsSummary returns the past wee
       "users": 1,
     },
   ],
-  "total_users": 5,
+  "users": 5,
 }
 `;
 
-exports[`Report storage tests > getCurrentConnections returns current connections 1`] = `
+exports[`Report storage tests > Should show currently connected users 1`] = `
 {
-  "sdk_breakdown": [
+  "sdks": [
     {
       "clients": 1,
       "sdk": "powersync-dart/1.6.4",
@@ -210,11 +210,11 @@ exports[`Report storage tests > getCurrentConnections returns current connection
       "users": 1,
     },
   ],
-  "total_users": 2,
+  "users": 2,
 }
 `;
 
-exports[`Report storage tests > getClientSessions returns sessions for a client_id 1`] = `
+exports[`Report storage tests > Should show paginated response of all connections of specified client_id 1`] = `
 {
   "count": 1,
   "cursor": undefined,
@@ -231,7 +231,7 @@ exports[`Report storage tests > getClientSessions returns sessions for a client_
 }
 `;
 
-exports[`Report storage tests > getClientSessions returns paginated sessions with a limit 1`] = `
+exports[`Report storage tests > Should show paginated response of all connections with a limit 1`] = `
 {
   "count": 4,
   "cursor": "<removed-for-snapshot>",
@@ -269,7 +269,7 @@ exports[`Report storage tests > getClientSessions returns paginated sessions wit
 }
 `;
 
-exports[`Report storage tests > getClientSessions returns paginated sessions with a limit 2`] = `
+exports[`Report storage tests > Should show paginated response of all connections with a limit 2`] = `
 {
   "count": 4,
   "cursor": undefined,
@@ -307,7 +307,7 @@ exports[`Report storage tests > getClientSessions returns paginated sessions wit
 }
 `;
 
-exports[`Report storage tests > getClientSessions returns paginated sessions with a limit and date range 1`] = `
+exports[`Report storage tests > Should show paginated response of all connections with a limit with date range 1`] = `
 {
   "count": 4,
   "cursor": "<removed-for-snapshot>",
@@ -345,7 +345,7 @@ exports[`Report storage tests > getClientSessions returns paginated sessions wit
 }
 `;
 
-exports[`Report storage tests > getClientSessions returns paginated sessions with a limit and date range 2`] = `
+exports[`Report storage tests > Should show paginated response of all connections with a limit with date range 2`] = `
 {
   "count": 2,
   "cursor": undefined,
@@ -383,7 +383,7 @@ exports[`Report storage tests > getClientSessions returns paginated sessions wit
 }
 `;
 
-exports[`Report storage tests > getClientSessions returns sessions for a user_id 1`] = `
+exports[`Report storage tests > Should show paginated response of connections of specified user_id 1`] = `
 {
   "count": 2,
   "cursor": undefined,
@@ -407,7 +407,7 @@ exports[`Report storage tests > getClientSessions returns sessions for a user_id
 }
 `;
 
-exports[`Report storage tests > getClientSessions returns sessions for a date range 1`] = `
+exports[`Report storage tests > Should show paginated response of connections over a date range 1`] = `
 {
   "count": 6,
   "cursor": undefined,
@@ -459,7 +459,7 @@ exports[`Report storage tests > getClientSessions returns sessions for a date ra
 }
 `;
 
-exports[`Report storage tests > getClientSessions returns sessions for client_id and user_id within a date range 1`] = `
+exports[`Report storage tests > Should show paginated response of connections over a date range of specified client_id and user_id 1`] = `
 {
   "count": 1,
   "cursor": undefined,

package/test/src/__snapshots__/storage_sync.test.ts.snap

@@ -1,5 +1,99 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`sync - postgres > storage v1 > can override priority when subscribing to stream 1`] = `
+[
+  {
+    "checkpoint": {
+      "buckets": [
+        {
+          "bucket": "1#todos|0["a"]",
+          "checksum": -1712802421,
+          "count": 1,
+          "priority": 0,
+          "subscriptions": [
+            {
+              "sub": 0,
+            },
+            {
+              "sub": 1,
+            },
+          ],
+        },
+        {
+          "bucket": "1#todos|0["b"]",
+          "checksum": -1291414318,
+          "count": 1,
+          "priority": 3,
+          "subscriptions": [
+            {
+              "sub": 1,
+            },
+          ],
+        },
+      ],
+      "last_op_id": "2",
+      "streams": [
+        {
+          "errors": [],
+          "is_default": false,
+          "name": "todos",
+        },
+      ],
+      "write_checkpoint": undefined,
+    },
+  },
+  {
+    "data": {
+      "after": "0",
+      "bucket": "1#todos|0["a"]",
+      "data": [
+        {
+          "checksum": 2582164875,
+          "data": "{"id":"a","description":"Test 1"}",
+          "object_id": "a",
+          "object_type": "test",
+          "op": "PUT",
+          "op_id": "1",
+          "subkey": "02d285ac-4f96-5124-8fba-c6d1df992dd1",
+        },
+      ],
+      "has_more": false,
+      "next_after": "1",
+    },
+  },
+  {
+    "partial_checkpoint_complete": {
+      "last_op_id": "2",
+      "priority": 0,
+    },
+  },
+  {
+    "data": {
+      "after": "0",
+      "bucket": "1#todos|0["b"]",
+      "data": [
+        {
+          "checksum": 3003552978,
+          "data": "{"id":"b","description":"Test 2"}",
+          "object_id": "b",
+          "object_type": "test",
+          "op": "PUT",
+          "op_id": "2",
+          "subkey": "243b0e26-87b2-578a-993c-5ac5b6f7fd64",
+        },
+      ],
+      "has_more": false,
+      "next_after": "2",
+    },
+  },
+  {
+    "checkpoint_complete": {
+      "last_op_id": "2",
+    },
+  },
+]
+`;
+
 exports[`sync - postgres > storage v1 > compacting data - invalidate checkpoint 1`] = `
 [
   {
@@ -1095,6 +1189,100 @@ exports[`sync - postgres > storage v1 > sync updates to parameter query only 2`]
 ]
 `;
 
+exports[`sync - postgres > storage v2 > can override priority when subscribing to stream 1`] = `
+[
+  {
+    "checkpoint": {
+      "buckets": [
+        {
+          "bucket": "1#todos|0["a"]",
+          "checksum": -1712802421,
+          "count": 1,
+          "priority": 0,
+          "subscriptions": [
+            {
+              "sub": 0,
+            },
+            {
+              "sub": 1,
+            },
+          ],
+        },
+        {
+          "bucket": "1#todos|0["b"]",
+          "checksum": -1291414318,
+          "count": 1,
+          "priority": 3,
+          "subscriptions": [
+            {
+              "sub": 1,
+            },
+          ],
+        },
+      ],
+      "last_op_id": "2",
+      "streams": [
+        {
+          "errors": [],
+          "is_default": false,
+          "name": "todos",
+        },
+      ],
+      "write_checkpoint": undefined,
+    },
+  },
+  {
+    "data": {
+      "after": "0",
+      "bucket": "1#todos|0["a"]",
+      "data": [
+        {
+          "checksum": 2582164875,
+          "data": "{"id":"a","description":"Test 1"}",
+          "object_id": "a",
+          "object_type": "test",
+          "op": "PUT",
+          "op_id": "1",
+          "subkey": "02d285ac-4f96-5124-8fba-c6d1df992dd1",
+        },
+      ],
+      "has_more": false,
+      "next_after": "1",
+    },
+  },
+  {
+    "partial_checkpoint_complete": {
+      "last_op_id": "2",
+      "priority": 0,
+    },
+  },
+  {
+    "data": {
+      "after": "0",
+      "bucket": "1#todos|0["b"]",
+      "data": [
+        {
+          "checksum": 3003552978,
+          "data": "{"id":"b","description":"Test 2"}",
+          "object_id": "b",
+          "object_type": "test",
+          "op": "PUT",
+          "op_id": "2",
+          "subkey": "243b0e26-87b2-578a-993c-5ac5b6f7fd64",
+        },
+      ],
+      "has_more": false,
+      "next_after": "2",
+    },
+  },
+  {
+    "checkpoint_complete": {
+      "last_op_id": "2",
+    },
+  },
+]
+`;
+
 exports[`sync - postgres > storage v2 > compacting data - invalidate checkpoint 1`] = `
 [
   {
@@ -2190,6 +2378,100 @@ exports[`sync - postgres > storage v2 > sync updates to parameter query only 2`]
 ]
 `;
 
+exports[`sync - postgres > storage v3 > can override priority when subscribing to stream 1`] = `
+[
+  {
+    "checkpoint": {
+      "buckets": [
+        {
+          "bucket": "1#todos|0["a"]",
+          "checksum": -1712802421,
+          "count": 1,
+          "priority": 0,
+          "subscriptions": [
+            {
+              "sub": 0,
+            },
+            {
+              "sub": 1,
+            },
+          ],
+        },
+        {
+          "bucket": "1#todos|0["b"]",
+          "checksum": -1291414318,
+          "count": 1,
+          "priority": 3,
+          "subscriptions": [
+            {
+              "sub": 1,
+            },
+          ],
+        },
+      ],
+      "last_op_id": "2",
+      "streams": [
+        {
+          "errors": [],
+          "is_default": false,
+          "name": "todos",
+        },
+      ],
+      "write_checkpoint": undefined,
+    },
+  },
+  {
+    "data": {
+      "after": "0",
+      "bucket": "1#todos|0["a"]",
+      "data": [
+        {
+          "checksum": 2582164875,
+          "data": "{"id":"a","description":"Test 1"}",
+          "object_id": "a",
+          "object_type": "test",
+          "op": "PUT",
+          "op_id": "1",
+          "subkey": "02d285ac-4f96-5124-8fba-c6d1df992dd1",
+        },
+      ],
+      "has_more": false,
+      "next_after": "1",
+    },
+  },
+  {
+    "partial_checkpoint_complete": {
+      "last_op_id": "2",
+      "priority": 0,
+    },
+  },
+  {
+    "data": {
+      "after": "0",
+      "bucket": "1#todos|0["b"]",
+      "data": [
+        {
+          "checksum": 3003552978,
+          "data": "{"id":"b","description":"Test 2"}",
+          "object_id": "b",
+          "object_type": "test",
+          "op": "PUT",
+          "op_id": "2",
+          "subkey": "243b0e26-87b2-578a-993c-5ac5b6f7fd64",
+        },
+      ],
+      "has_more": false,
+      "next_after": "2",
+    },
+  },
+  {
+    "checkpoint_complete": {
+      "last_op_id": "2",
+    },
+  },
+]
+`;
+
 exports[`sync - postgres > storage v3 > compacting data - invalidate checkpoint 1`] = `
 [
   {

package/test/src/{client-connections-storage.test.ts → connection-report-storage.test.ts}

@@ -1,9 +1,9 @@
-import { afterAll, beforeAll, describe, expect, it } from 'vitest';
-import { POSTGRES_REPORT_STORAGE_FACTORY } from './util.js';
-import { event_types } from '@powersync/service-types';
 import { register, ReportUserData } from '@powersync/service-core-tests';
-import { PostgresReportStorage } from '../../src/storage/PostgresReportStorage.js';
 import { DateTimeValue } from '@powersync/service-sync-rules';
+import { event_types } from '@powersync/service-types';
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import { PostgresReportStorage } from '../../src/storage/PostgresReportStorage.js';
+import { POSTGRES_REPORT_STORAGE_FACTORY } from './util.js';
 
 const factory = await POSTGRES_REPORT_STORAGE_FACTORY();
 const userData = register.REPORT_TEST_USERS;
@@ -223,7 +223,7 @@ describe('Connection report storage', async () => {
     await factory.deleteOldConnectionData({
       date: dates.weekAgo
     });
-    const sdk = await factory.getClientConnectionsSummary({
+    const sdk = await factory.getClientConnectionReports({
       start: dates.monthAgo,
       end: dates.now
     });

package/test/src/setup.ts

@@ -1,6 +1,6 @@
 import { container } from '@powersync/lib-services-framework';
-import { beforeAll } from 'vitest';
 import { METRICS_HELPER } from '@powersync/service-core-tests';
+import { beforeAll } from 'vitest';
 
 beforeAll(async () => {
   // Executes for every test file

package/test/tsconfig.json

@@ -1,7 +1,6 @@
 {
   "extends": "../../../tsconfig.tests.json",
   "compilerOptions": {
-    "baseUrl": "./",
     "declarationDir": "dist/@types",
     "tsBuildInfoFile": "dist/.tsbuildinfo",
     "lib": ["ES2022", "esnext.disposable"],

package/dist/@types/storage/current-data-table.d.ts

@@ -1,9 +0,0 @@
-import { storage } from '@powersync/service-core';
-export declare const V1_CURRENT_DATA_TABLE = "current_data";
-export declare const V3_CURRENT_DATA_TABLE = "v3_current_data";
-/**
- * The table used by a specific storage version for general current_data access.
- */
-export declare function getCommonCurrentDataTable(storageConfig: storage.StorageVersionConfig): "current_data" | "v3_current_data";
-export declare function getV1CurrentDataTable(storageConfig: storage.StorageVersionConfig): string;
-export declare function getV3CurrentDataTable(storageConfig: storage.StorageVersionConfig): string;

package/dist/storage/current-data-table.js

@@ -1,22 +0,0 @@
-import { ServiceAssertionError } from '@powersync/lib-services-framework';
-export const V1_CURRENT_DATA_TABLE = 'current_data';
-export const V3_CURRENT_DATA_TABLE = 'v3_current_data';
-/**
- * The table used by a specific storage version for general current_data access.
- */
-export function getCommonCurrentDataTable(storageConfig) {
-    return storageConfig.softDeleteCurrentData ? V3_CURRENT_DATA_TABLE : V1_CURRENT_DATA_TABLE;
-}
-export function getV1CurrentDataTable(storageConfig) {
-    if (storageConfig.softDeleteCurrentData) {
-        throw new ServiceAssertionError('current_data table cannot be used when softDeleteCurrentData is enabled');
-    }
-    return V1_CURRENT_DATA_TABLE;
-}
-export function getV3CurrentDataTable(storageConfig) {
-    if (!storageConfig.softDeleteCurrentData) {
-        throw new ServiceAssertionError('v3_current_data table cannot be used when softDeleteCurrentData is disabled');
-    }
-    return V3_CURRENT_DATA_TABLE;
-}
-//# sourceMappingURL=current-data-table.js.map

package/dist/storage/current-data-table.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"current-data-table.js","sourceRoot":"","sources":["../../src/storage/current-data-table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAG1E,MAAM,CAAC,MAAM,qBAAqB,GAAG,cAAc,CAAC;AACpD,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;AAEvD;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,aAA2C;IACnF,OAAO,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,qBAAqB,CAAC;AAC7F,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,aAA2C;IAC/E,IAAI,aAAa,CAAC,qBAAqB,EAAE,CAAC;QACxC,MAAM,IAAI,qBAAqB,CAAC,yEAAyE,CAAC,CAAC;IAC7G,CAAC;IACD,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,aAA2C;IAC/E,IAAI,CAAC,aAAa,CAAC,qBAAqB,EAAE,CAAC;QACzC,MAAM,IAAI,qBAAqB,CAAC,6EAA6E,CAAC,CAAC;IACjH,CAAC;IACD,OAAO,qBAAqB,CAAC;AAC/B,CAAC"}

package/src/storage/current-data-table.ts

@@ -1,26 +0,0 @@
-import { ServiceAssertionError } from '@powersync/lib-services-framework';
-import { storage } from '@powersync/service-core';
-
-export const V1_CURRENT_DATA_TABLE = 'current_data';
-export const V3_CURRENT_DATA_TABLE = 'v3_current_data';
-
-/**
- * The table used by a specific storage version for general current_data access.
- */
-export function getCommonCurrentDataTable(storageConfig: storage.StorageVersionConfig) {
-  return storageConfig.softDeleteCurrentData ? V3_CURRENT_DATA_TABLE : V1_CURRENT_DATA_TABLE;
-}
-
-export function getV1CurrentDataTable(storageConfig: storage.StorageVersionConfig) {
-  if (storageConfig.softDeleteCurrentData) {
-    throw new ServiceAssertionError('current_data table cannot be used when softDeleteCurrentData is enabled');
-  }
-  return V1_CURRENT_DATA_TABLE;
-}
-
-export function getV3CurrentDataTable(storageConfig: storage.StorageVersionConfig) {
-  if (!storageConfig.softDeleteCurrentData) {
-    throw new ServiceAssertionError('v3_current_data table cannot be used when softDeleteCurrentData is disabled');
-  }
-  return V3_CURRENT_DATA_TABLE;
-}