@powersync/service-core 1.11.3 → 1.12.0

package/dist/routes/endpoints/sync-stream.js

@@ -1,4 +1,4 @@
-import { ErrorCode, errors, logger, router, schema } from '@powersync/lib-services-framework';
+import { ErrorCode, errors, router, schema } from '@powersync/lib-services-framework';
 import { RequestParameters } from '@powersync/service-sync-rules';
 import { Readable } from 'stream';
 import * as sync from '../../sync/sync-index.js';
@@ -16,11 +16,18 @@ export const syncStreamed = routeDefinition({
     authorize: authUser,
     validator: schema.createTsCodecValidator(util.StreamingSyncRequest, { allowAdditional: true }),
     handler: async (payload) => {
-        const { service_context } = payload.context;
+        const { service_context, logger } = payload.context;
         const { routerEngine, storageEngine, metricsEngine, syncContext } = service_context;
         const headers = payload.request.headers;
         const userAgent = headers['x-user-agent'] ?? headers['user-agent'];
         const clientId = payload.params.client_id;
+        const streamStart = Date.now();
+        logger.defaultMeta = {
+            ...logger.defaultMeta,
+            user_agent: userAgent,
+            client_id: clientId,
+            user_id: payload.context.user_id
+        };
         if (routerEngine.closed) {
             throw new errors.ServiceError({
                 status: 503,
@@ -51,17 +58,28 @@ export const syncStreamed = routeDefinition({
                 syncParams,
                 token: payload.context.token_payload,
                 tracker,
-                signal: controller.signal
+                signal: controller.signal,
+                logger
             })), tracker), { objectMode: false, highWaterMark: 16 * 1024 });
+            // Best effort guess on why the stream was closed.
+            // We use the `??=` operator everywhere, so that we catch the first relevant
+            // event, which is usually the most specific.
+            let closeReason = undefined;
             const deregister = routerEngine.addStopHandler(() => {
                 // This error is not currently propagated to the client
                 controller.abort();
+                closeReason ??= 'process shutdown';
                 stream.destroy(new Error('Shutting down system'));
             });
+            stream.on('end', () => {
+                // Auth failure or switch to new sync rules
+                closeReason ??= 'service closing stream';
+            });
             stream.on('close', () => {
                 deregister();
             });
             stream.on('error', (error) => {
+                closeReason ??= 'stream error';
                 controller.abort();
                 // Note: This appears as a 200 response in the logs.
                 if (error.message != 'Shutting down system') {
@@ -74,15 +92,16 @@ export const syncStreamed = routeDefinition({
                     'Content-Type': 'application/x-ndjson'
                 },
                 data: stream,
-                afterSend: async () => {
+                afterSend: async (details) => {
+                    if (details.clientClosed) {
+                        closeReason ??= 'client closing stream';
+                    }
                     controller.abort();
                     metricsEngine.getUpDownCounter(APIMetric.CONCURRENT_CONNECTIONS).add(-1);
                     logger.info(`Sync stream complete`, {
-                        user_id: syncParams.user_id,
-                        client_id: clientId,
-                        user_agent: userAgent,
-                        operations_synced: tracker.operationsSynced,
-                        data_synced_bytes: tracker.dataSyncedBytes
+                        ...tracker.getLogMeta(),
+                        stream_ms: Date.now() - streamStart,
+                        close_reason: closeReason ?? 'unknown'
                     });
                 }
             });

package/dist/routes/endpoints/sync-stream.js.map

@@ -1 +1 @@
-{"version":3,"file":"sync-stream.js","sourceRoot":"","sources":["../../../src/routes/endpoints/sync-stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAC9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,MAAM,CAAN,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,qCAAuB,CAAA;AACzB,CAAC,EAFW,UAAU,KAAV,UAAU,QAErB;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAC;IAC1C,IAAI,EAAE,UAAU,CAAC,MAAM;IACvB,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI;IAC9B,SAAS,EAAE,QAAQ;IACnB,SAAS,EAAE,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;IAC9F,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QACzB,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;QAC5C,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,eAAe,CAAC;QACpF,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;QACxC,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;QACnE,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;QAE1C,IAAI,YAAa,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC;gBAC5B,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,SAAS,CAAC,WAAW;gBAC3B,WAAW,EAAE,iCAAiC;aAC/C,CAAC,CAAC;QACL,CAAC;QAED,MAAM,MAAM,GAA8B,OAAO,CAAC,MAAM,CAAC;QACzD,MAAM,UAAU,GAAG,IAAI,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,aAAc,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;QAE1G,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC;QAEjF,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YAC1B,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC;gBAC5B,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,SAAS,CAAC,WAAW;gBAC3B,WAAW,EAAE,yBAAyB;aACvC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,SAAS,GAAG,aAAa,CAAC,kBAAkB,CAAC,YAAa,CAAC,MAAM,EAAE,CAAC,wBAAwB,EAAE,CAAC,CAAC;QAEtG,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACvD,IAAI,CAAC;YACH,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACxE,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAC1B,IAAI,CAAC,uBAAuB,CAC1B,IAAI,CAAC,MAAM,CACT,IAAI,CAAC,cAAc,CAAC;gBAClB,WAAW,EAAE,WAAW;gBACxB,aAAa;gBACb,SAAS,EAAE,SAAS;gBACpB,MAAM;gBACN,UAAU;gBACV,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,aAAc;gBACrC,OAAO;gBACP,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B,CAAC,CACH,EACD,OAAO,CACR,EACD,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE,GAAG,IAAI,EAAE,CAChD,CAAC;YAEF,MAAM,UAAU,GAAG,YAAa,CAAC,cAAc,CAAC,GAAG,EAAE;gBACnD,uDAAuD;gBACvD,UAAU,CAAC,KAAK,EAAE,CAAC;gBACnB,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBACtB,UAAU,EAAE,CAAC;YACf,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC3B,UAAU,CAAC,KAAK,EAAE,CAAC;gBACnB,oDAAoD;gBACpD,IAAI,KAAK,CAAC,OAAO,IAAI,sBAAsB,EAAE,CAAC;oBAC5C,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,OAAO,IAAI,MAAM,CAAC,cAAc,CAAC;gBAC/B,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE;oBACP,cAAc,EAAE,sBAAsB;iBACvC;gBACD,IAAI,EAAE,MAAM;gBACZ,SAAS,EAAE,KAAK,IAAI,EAAE;oBACpB,UAAU,CAAC,KAAK,EAAE,CAAC;oBACnB,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;oBACzE,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE;wBAClC,OAAO,EAAE,UAAU,CAAC,OAAO;wBAC3B,SAAS,EAAE,QAAQ;wBACnB,UAAU,EAAE,SAAS;wBACrB,iBAAiB,EAAE,OAAO,CAAC,gBAAgB;wBAC3C,iBAAiB,EAAE,OAAO,CAAC,eAAe;qBAC3C,CAAC,CAAC;gBACL,CAAC;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACZ,UAAU,CAAC,KAAK,EAAE,CAAC;YACnB,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,YAAY,CAAC,CAAC"}
+{"version":3,"file":"sync-stream.js","sourceRoot":"","sources":["../../../src/routes/endpoints/sync-stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAU,MAAM,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAC9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,MAAM,CAAN,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,qCAAuB,CAAA;AACzB,CAAC,EAFW,UAAU,KAAV,UAAU,QAErB;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAC;IAC1C,IAAI,EAAE,UAAU,CAAC,MAAM;IACvB,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI;IAC9B,SAAS,EAAE,QAAQ;IACnB,SAAS,EAAE,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;IAC9F,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QACzB,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;QACpD,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,eAAe,CAAC;QACpF,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;QACxC,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;QACnE,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE/B,MAAM,CAAC,WAAW,GAAG;YACnB,GAAG,MAAM,CAAC,WAAW;YACrB,UAAU,EAAE,SAAS;YACrB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO;SACjC,CAAC;QAEF,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;YACxB,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC;gBAC5B,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,SAAS,CAAC,WAAW;gBAC3B,WAAW,EAAE,iCAAiC;aAC/C,CAAC,CAAC;QACL,CAAC;QAED,MAAM,MAAM,GAA8B,OAAO,CAAC,MAAM,CAAC;QACzD,MAAM,UAAU,GAAG,IAAI,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,aAAc,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;QAE1G,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC;QAEjF,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YAC1B,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC;gBAC5B,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,SAAS,CAAC,WAAW;gBAC3B,WAAW,EAAE,yBAAyB;aACvC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,SAAS,GAAG,aAAa,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,wBAAwB,EAAE,CAAC,CAAC;QAErG,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACvD,IAAI,CAAC;YACH,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACxE,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAC1B,IAAI,CAAC,uBAAuB,CAC1B,IAAI,CAAC,MAAM,CACT,IAAI,CAAC,cAAc,CAAC;gBAClB,WAAW,EAAE,WAAW;gBACxB,aAAa;gBACb,SAAS,EAAE,SAAS;gBACpB,MAAM;gBACN,UAAU;gBACV,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,aAAc;gBACrC,OAAO;gBACP,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,MAAM;aACP,CAAC,CACH,EACD,OAAO,CACR,EACD,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE,GAAG,IAAI,EAAE,CAChD,CAAC;YAEF,kDAAkD;YAClD,4EAA4E;YAC5E,6CAA6C;YAC7C,IAAI,WAAW,GAAuB,SAAS,CAAC;YAEhD,MAAM,UAAU,GAAG,YAAY,CAAC,cAAc,CAAC,GAAG,EAAE;gBAClD,uDAAuD;gBACvD,UAAU,CAAC,KAAK,EAAE,CAAC;gBACnB,WAAW,KAAK,kBAAkB,CAAC;gBACnC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;YACpD,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACpB,2CAA2C;gBAC3C,WAAW,KAAK,wBAAwB,CAAC;YAC3C,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBACtB,UAAU,EAAE,CAAC;YACf,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC3B,WAAW,KAAK,cAAc,CAAC;gBAC/B,UAAU,CAAC,KAAK,EAAE,CAAC;gBACnB,oDAAoD;gBACpD,IAAI,KAAK,CAAC,OAAO,IAAI,sBAAsB,EAAE,CAAC;oBAC5C,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,OAAO,IAAI,MAAM,CAAC,cAAc,CAAC;gBAC/B,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE;oBACP,cAAc,EAAE,sBAAsB;iBACvC;gBACD,IAAI,EAAE,MAAM;gBACZ,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;oBAC3B,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;wBACzB,WAAW,KAAK,uBAAuB,CAAC;oBAC1C,CAAC;oBACD,UAAU,CAAC,KAAK,EAAE,CAAC;oBACnB,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;oBACzE,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE;wBAClC,GAAG,OAAO,CAAC,UAAU,EAAE;wBACvB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW;wBACnC,YAAY,EAAE,WAAW,IAAI,SAAS;qBACvC,CAAC,CAAC;gBACL,CAAC;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACZ,UAAU,CAAC,KAAK,EAAE,CAAC;YACnB,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,YAAY,CAAC,CAAC"}

package/dist/routes/route-register.js

@@ -1,3 +1,4 @@
+import * as uuid from 'uuid';
 import { errors, logger, router } from '@powersync/lib-services-framework';
 /**
  * Registers endpoint definitions as routes on a Fastify app instance.
@@ -12,8 +13,12 @@ export function registerFastifyRoutes(app, contextProvider, endpoints) {
                 handler: async (request, reply) => {
                     const startTime = new Date();
                     let response;
+                    const requestLogger = logger.child({
+                        route: e.path,
+                        rid: `h/${uuid.v7()}`
+                    });
                     try {
-                        const context = await contextProvider(request);
+                        const context = await contextProvider(request, { logger: requestLogger });
                         let combined = {
                             ...request.params,
                             ...request.query
@@ -48,7 +53,7 @@ export function registerFastifyRoutes(app, contextProvider, endpoints) {
                     }
                     catch (ex) {
                         const serviceError = errors.asServiceError(ex);
-                        logger.error(`Request failed`, serviceError);
+                        requestLogger.error(`Request failed`, serviceError);
                         response = new router.RouterResponse({
                             status: serviceError.errorData.status || 500,
                             headers: {
@@ -67,13 +72,12 @@ export function registerFastifyRoutes(app, contextProvider, endpoints) {
                         await reply.send(response.data);
                     }
                     finally {
-                        await response.afterSend?.();
-                        logger.info(`${e.method} ${request.url}`, {
+                        await response.afterSend?.({ clientClosed: request.socket.closed });
+                        requestLogger.info(`${e.method} ${request.url}`, {
                             duration_ms: Math.round(new Date().valueOf() - startTime.valueOf() + Number.EPSILON),
                             status: response.status,
                             method: e.method,
-                            path: request.url,
-                            route: e.path
+                            path: request.url
                         });
                     }
                 }

package/dist/routes/route-register.js.map

@@ -1 +1 @@
-{"version":3,"file":"route-register.js","sourceRoot":"","sources":["../../src/routes/route-register.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAc,MAAM,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAQvF;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,GAA4B,EAC5B,eAAgC,EAChC,SAA+C;IAE/C,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QAC1B,sCAAsC;QACtC,GAAG,CAAC,QAAQ,CAAC,KAAK,WAAW,OAAO;YAClC,OAAO,CAAC,KAAK,CAAC;gBACZ,GAAG,EAAE,CAAC,CAAC,IAAI;gBACX,MAAM,EAAE,CAAC,CAAC,MAAoB;gBAC9B,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;oBAChC,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;oBAC7B,IAAI,QAA+B,CAAC;oBACpC,IAAI,CAAC;wBACH,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC;wBAE/C,IAAI,QAAQ,GAAG;4BACb,GAAI,OAAO,CAAC,MAAc;4BAC1B,GAAI,OAAO,CAAC,KAAa;yBAC1B,CAAC;wBAEF,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;4BACvG,QAAQ,GAAG;gCACT,GAAG,QAAQ;gCACX,GAAG,OAAO,CAAC,IAAI;6BAChB,CAAC;wBACJ,CAAC;wBAED,MAAM,OAAO,GAAkC;4BAC7C,OAAO,EAAE,OAAO;4BAChB,MAAM,EAAE,QAAQ;4BAChB,OAAO;yBACR,CAAC;wBAEF,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;wBAElE,IAAI,MAAM,CAAC,cAAc,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,CAAC;4BAC7D,QAAQ,GAAG,gBAAgB,CAAC;wBAC9B,CAAC;6BAAM,IAAI,MAAM,CAAC,eAAe,CAAC,gBAAgB,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;4BACzF,QAAQ,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC;gCACnC,MAAM,EAAE,GAAG;gCACX,IAAI,EAAE,gBAAgB;6BACvB,CAAC,CAAC;wBACL,CAAC;6BAAM,CAAC;4BACN,QAAQ,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC;gCACnC,MAAM,EAAE,GAAG;gCACX,IAAI,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE;6BACjC,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;oBAAC,OAAO,EAAE,EAAE,CAAC;wBACZ,MAAM,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;wBAC/C,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;wBAE7C,QAAQ,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC;4BACnC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,MAAM,IAAI,GAAG;4BAC5C,OAAO,EAAE;gCACP,cAAc,EAAE,kBAAkB;6BACnC;4BACD,IAAI,EAAE;gCACJ,KAAK,EAAE,YAAY,CAAC,SAAS;6BAC9B;yBACF,CAAC,CAAC;oBACL,CAAC;oBAED,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;wBAC5C,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC3C,CAAC,CAAC,CAAC;oBACH,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBAC9B,IAAI,CAAC;wBACH,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBAClC,CAAC;4BAAS,CAAC;wBACT,MAAM,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC;wBAC7B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE;4BACxC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;4BACpF,MAAM,EAAE,QAAQ,CAAC,MAAM;4BACvB,MAAM,EAAE,CAAC,CAAC,MAAM;4BAChB,IAAI,EAAE,OAAO,CAAC,GAAG;4BACjB,KAAK,EAAE,CAAC,CAAC,IAAI;yBACd,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,CAAC;gBACvB,OAAO,CAAC,2BAA2B,EAAE,CAAC;YACxC,CAAC;YAED,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}
+{"version":3,"file":"route-register.js","sourceRoot":"","sources":["../../src/routes/route-register.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,EAAE,MAAM,EAAc,MAAM,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAQvF;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,GAA4B,EAC5B,eAAgC,EAChC,SAA+C;IAE/C,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QAC1B,sCAAsC;QACtC,GAAG,CAAC,QAAQ,CAAC,KAAK,WAAW,OAAO;YAClC,OAAO,CAAC,KAAK,CAAC;gBACZ,GAAG,EAAE,CAAC,CAAC,IAAI;gBACX,MAAM,EAAE,CAAC,CAAC,MAAoB;gBAC9B,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;oBAChC,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;oBAC7B,IAAI,QAA+B,CAAC;oBACpC,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC;wBACjC,KAAK,EAAE,CAAC,CAAC,IAAI;wBACb,GAAG,EAAE,KAAK,IAAI,CAAC,EAAE,EAAE,EAAE;qBACtB,CAAC,CAAC;oBACH,IAAI,CAAC;wBACH,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;wBAC1E,IAAI,QAAQ,GAAG;4BACb,GAAI,OAAO,CAAC,MAAc;4BAC1B,GAAI,OAAO,CAAC,KAAa;yBAC1B,CAAC;wBAEF,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;4BACvG,QAAQ,GAAG;gCACT,GAAG,QAAQ;gCACX,GAAG,OAAO,CAAC,IAAI;6BAChB,CAAC;wBACJ,CAAC;wBAED,MAAM,OAAO,GAAkC;4BAC7C,OAAO,EAAE,OAAO;4BAChB,MAAM,EAAE,QAAQ;4BAChB,OAAO;yBACR,CAAC;wBAEF,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;wBAElE,IAAI,MAAM,CAAC,cAAc,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,CAAC;4BAC7D,QAAQ,GAAG,gBAAgB,CAAC;wBAC9B,CAAC;6BAAM,IAAI,MAAM,CAAC,eAAe,CAAC,gBAAgB,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;4BACzF,QAAQ,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC;gCACnC,MAAM,EAAE,GAAG;gCACX,IAAI,EAAE,gBAAgB;6BACvB,CAAC,CAAC;wBACL,CAAC;6BAAM,CAAC;4BACN,QAAQ,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC;gCACnC,MAAM,EAAE,GAAG;gCACX,IAAI,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE;6BACjC,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;oBAAC,OAAO,EAAE,EAAE,CAAC;wBACZ,MAAM,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;wBAC/C,aAAa,CAAC,KAAK,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;wBAEpD,QAAQ,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC;4BACnC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,MAAM,IAAI,GAAG;4BAC5C,OAAO,EAAE;gCACP,cAAc,EAAE,kBAAkB;6BACnC;4BACD,IAAI,EAAE;gCACJ,KAAK,EAAE,YAAY,CAAC,SAAS;6BAC9B;yBACF,CAAC,CAAC;oBACL,CAAC;oBAED,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;wBAC5C,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC3C,CAAC,CAAC,CAAC;oBACH,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBAC9B,IAAI,CAAC;wBACH,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBAClC,CAAC;4BAAS,CAAC;wBACT,MAAM,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;wBACpE,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE;4BAC/C,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;4BACpF,MAAM,EAAE,QAAQ,CAAC,MAAM;4BACvB,MAAM,EAAE,CAAC,CAAC,MAAM;4BAChB,IAAI,EAAE,OAAO,CAAC,GAAG;yBAClB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,CAAC;gBACvB,OAAO,CAAC,2BAA2B,EAAE,CAAC;YACxC,CAAC;YAED,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/dist/routes/router.d.ts

@@ -1,13 +1,10 @@
-import { router } from '@powersync/lib-services-framework';
+import { router, ServiceError, Logger } from '@powersync/lib-services-framework';
 import type { JwtPayload } from '../auth/auth-index.js';
 import { ServiceContext } from '../system/ServiceContext.js';
-import { RouterEngine } from './RouterEngine.js';
 /**
  * The {@link RouterEngine} must be provided for these routes
  */
-export type RouterServiceContext = ServiceContext & {
-    routerEngine: RouterEngine;
-};
+export type RouterServiceContext = ServiceContext;
 /**
  * Common context for routes
  */
@@ -15,18 +12,22 @@ export type Context = {
     user_id?: string;
     service_context: RouterServiceContext;
     token_payload?: JwtPayload;
-    token_errors?: string[];
+    token_error?: ServiceError;
     /**
      * Only on websocket endpoints.
      */
     user_agent?: string;
+    logger: Logger;
 };
 export type BasicRouterRequest = {
     headers: Record<string, string | string[] | undefined>;
     protocol: string;
     hostname: string;
 };
-export type ContextProvider = (request: BasicRouterRequest) => Promise<Context>;
+export type ConextProviderOptions = {
+    logger: Logger;
+};
+export type ContextProvider = (request: BasicRouterRequest, options: ConextProviderOptions) => Promise<Context>;
 export type RequestEndpoint<I, O, C = Context, Payload = RequestEndpointHandlerPayload<I, C, BasicRouterRequest>> = router.Endpoint<I, O, C, Payload> & {};
 export type RequestEndpointHandlerPayload<I = any, C = Context, Request = BasicRouterRequest> = router.EndpointHandlerPayload<I, C> & {
     request: Request;

package/dist/routes/router.js.map

@@ -1 +1 @@
-{"version":3,"file":"router.js","sourceRoot":"","sources":["../../src/routes/router.ts"],"names":[],"mappings":"AAiDA;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,MAA4C;IAE5C,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"router.js","sourceRoot":"","sources":["../../src/routes/router.ts"],"names":[],"mappings":"AAwDA;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,MAA4C;IAE5C,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/runner/teardown.js

@@ -11,7 +11,10 @@ export async function teardown(runnerConfig) {
     try {
         logger.info(`Tearing down PowerSync instance...`);
         const config = await utils.loadConfig(runnerConfig);
-        const serviceContext = new system.ServiceContextContainer(config);
+        const serviceContext = new system.ServiceContextContainer({
+            serviceMode: system.ServiceContextMode.TEARDOWN,
+            configuration: config
+        });
         const moduleManager = container.getImplementation(modules.ModuleManager);
         await moduleManager.initialize(serviceContext);
         // This is mostly done to ensure that the storage is ready

package/dist/runner/teardown.js.map

@@ -1 +1 @@
-{"version":3,"file":"teardown.js","sourceRoot":"","sources":["../../src/runner/teardown.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAC1D,eAAe;AACf,mFAAmF;AACnF,wBAAwB;AAExB,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AAEvD,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,KAAK,KAAK,MAAM,uBAAuB,CAAC;AAE/C,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,YAAgC;IAC7D,IAAI,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACpD,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;QAClE,MAAM,aAAa,GAAG,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACzE,MAAM,aAAa,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QAC/C,0DAA0D;QAC1D,MAAM,cAAc,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAE7C,MAAM,kBAAkB,CAAC,cAAc,CAAC,aAAa,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;QAC1F,MAAM,cAAc,CAAC,aAAa,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;QAC5D,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAClC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;QACpC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,kBAAkB,CAAC,cAA4C,EAAE,aAAoC;IAClH,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IACzC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,MAAM,KAAK,GAA8B,EAAE,CAAC;IAC5C,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,OAAO,EAAE,CAAC;QACpC,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,MAAM,oBAAoB,GAAG,MAAM,cAAc,CAAC,uBAAuB,EAAE,CAAC;QAC5E,sCAAsC;QACtC,KAAK,MAAM,mBAAmB,IAAI,oBAAoB,EAAE,CAAC;YACvD,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,IAAI,EAAE,CAAC;YAC9C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QAED,MAAM,gBAAgB,GAAG,MAAM,cAAc,CAAC,mBAAmB,EAAE,CAAC;QACpE,MAAM,iBAAiB,GAAG,CAAC,GAAG,oBAAoB,EAAE,GAAG,gBAAgB,CAAC,CAAC;QACzE,IAAI,CAAC;YACH,gEAAgE;YAChE,MAAM,aAAa,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAE/D,oCAAoC;YACpC,KAAK,IAAI,SAAS,IAAI,iBAAiB,EAAE,CAAC;gBACxC,MAAM,gBAAgB,GAAG,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBAC/D,4FAA4F;gBAC5F,MAAM,gBAAgB,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,KAAK,GAAG,IAAI,CAAC;YACb,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM;QACR,CAAC;QACD,MAAM,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;AACH,CAAC"}
+{"version":3,"file":"teardown.js","sourceRoot":"","sources":["../../src/runner/teardown.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAC1D,eAAe;AACf,mFAAmF;AACnF,wBAAwB;AAExB,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AAEvD,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,KAAK,KAAK,MAAM,uBAAuB,CAAC;AAE/C,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,YAAgC;IAC7D,IAAI,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACpD,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,uBAAuB,CAAC;YACxD,WAAW,EAAE,MAAM,CAAC,kBAAkB,CAAC,QAAQ;YAC/C,aAAa,EAAE,MAAM;SACtB,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACzE,MAAM,aAAa,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QAC/C,0DAA0D;QAC1D,MAAM,cAAc,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAE7C,MAAM,kBAAkB,CAAC,cAAc,CAAC,aAAa,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;QAC1F,MAAM,cAAc,CAAC,aAAa,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;QAC5D,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAClC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;QACpC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,kBAAkB,CAAC,cAA4C,EAAE,aAAoC;IAClH,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IACzC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,MAAM,KAAK,GAA8B,EAAE,CAAC;IAC5C,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,OAAO,EAAE,CAAC;QACpC,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,MAAM,oBAAoB,GAAG,MAAM,cAAc,CAAC,uBAAuB,EAAE,CAAC;QAC5E,sCAAsC;QACtC,KAAK,MAAM,mBAAmB,IAAI,oBAAoB,EAAE,CAAC;YACvD,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,IAAI,EAAE,CAAC;YAC9C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QAED,MAAM,gBAAgB,GAAG,MAAM,cAAc,CAAC,mBAAmB,EAAE,CAAC;QACpE,MAAM,iBAAiB,GAAG,CAAC,GAAG,oBAAoB,EAAE,GAAG,gBAAgB,CAAC,CAAC;QACzE,IAAI,CAAC;YACH,gEAAgE;YAChE,MAAM,aAAa,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAE/D,oCAAoC;YACpC,KAAK,IAAI,SAAS,IAAI,iBAAiB,EAAE,CAAC;gBACxC,MAAM,gBAAgB,GAAG,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBAC/D,4FAA4F;gBAC5F,MAAM,gBAAgB,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,KAAK,GAAG,IAAI,CAAC;YACb,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM;QACR,CAAC;QACD,MAAM,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;AACH,CAAC"}

package/dist/sync/BucketChecksumState.d.ts

@@ -1,18 +1,22 @@
 import { BucketDescription, RequestParameters, SqlSyncRules } from '@powersync/service-sync-rules';
 import * as storage from '../storage/storage-index.js';
 import * as util from '../util/util-index.js';
-import { BucketSyncState } from './sync.js';
+import { Logger } from '@powersync/lib-services-framework';
 import { SyncContext } from './SyncContext.js';
 export interface BucketChecksumStateOptions {
     syncContext: SyncContext;
     bucketStorage: BucketChecksumStateStorage;
     syncRules: SqlSyncRules;
     syncParams: RequestParameters;
+    logger?: Logger;
     initialBucketPositions?: {
         name: string;
         after: util.InternalOpId;
     }[];
 }
+type BucketSyncState = {
+    start_op_id: util.InternalOpId;
+};
 /**
  * Represents the state of the checksums and data for a specific connection.
  *
@@ -24,8 +28,10 @@ export declare class BucketChecksumState {
     /**
      * Bucket state of bucket id -> op_id.
      * This starts with the state from the client. May contain buckets that the user do not have access to (anymore).
+     *
+     * This is always updated in-place.
      */
-    bucketDataPositions: Map<string, BucketSyncState>;
+    readonly bucketDataPositions: Map<string, BucketSyncState>;
     /**
      * Last checksums sent to the client. We keep this to calculate checkpoint diffs.
      */
@@ -37,26 +43,20 @@ export declare class BucketChecksumState {
      * partial checkpoints are sent.
      */
     private pendingBucketDownloads;
+    private readonly logger;
     constructor(options: BucketChecksumStateOptions);
-    buildNextCheckpointLine(next: storage.StorageCheckpointUpdate): Promise<CheckpointLine | null>;
     /**
-     * Get bucket positions to sync, given the list of buckets.
+     * Build a new checkpoint line for an underlying storage checkpoint update if any buckets have changed.
      *
-     * @param bucketsToFetch List of buckets to fetch, typically from buildNextCheckpointLine, or a subset of that
-     * @returns
-     */
-    getFilteredBucketPositions(bucketsToFetch: BucketDescription[]): Map<string, util.InternalOpId>;
-    /**
-     * Update the position of bucket data the client has.
+     * This call is idempotent - no internal state is updated directly when this is called.
      *
-     * @param bucket the bucket name
-     * @param nextAfter sync operations >= this value in the next batch
+     * When the checkpoint line is sent to the client, call `CheckpointLine.advance()` to update the internal state.
+     * A line may be safely discarded (not sent to the client) if `advance()` is not called.
+     *
+     * @param next The updated checkpoint
+     * @returns A {@link CheckpointLine} if any of the buckets watched by this connected was updated, or otherwise `null`.
      */
-    updateBucketPosition(options: {
-        bucket: string;
-        nextAfter: util.InternalOpId;
-        hasMore: boolean;
-    }): void;
+    buildNextCheckpointLine(next: storage.StorageCheckpointUpdate): Promise<CheckpointLine | null>;
 }
 declare const INVALIDATE_ALL_BUCKETS: unique symbol;
 export interface CheckpointUpdate {
@@ -78,10 +78,11 @@ export declare class BucketParameterState {
     readonly syncParams: RequestParameters;
     private readonly querier;
     private readonly staticBuckets;
+    private readonly logger;
     private cachedDynamicBuckets;
     private cachedDynamicBucketSet;
     private readonly lookups;
-    constructor(context: SyncContext, bucketStorage: BucketChecksumStateStorage, syncRules: SqlSyncRules, syncParams: RequestParameters);
+    constructor(context: SyncContext, bucketStorage: BucketChecksumStateStorage, syncRules: SqlSyncRules, syncParams: RequestParameters, logger: Logger);
     getCheckpointUpdate(checkpoint: storage.StorageCheckpointUpdate): Promise<CheckpointUpdate>;
     /**
      * For static buckets, we can keep track of which buckets have been updated.
@@ -95,6 +96,27 @@ export declare class BucketParameterState {
 export interface CheckpointLine {
     checkpointLine: util.StreamingSyncCheckpointDiff | util.StreamingSyncCheckpoint;
     bucketsToFetch: BucketDescription[];
+    /**
+     * Call when a checkpoint line is being sent to a client, to update the internal state.
+     */
+    advance: () => void;
+    /**
+     * Get bucket positions to sync, given the list of buckets.
+     *
+     * @param bucketsToFetch List of buckets to fetch - either this.bucketsToFetch, or a subset of it. Defaults to this.bucketsToFetch.
+     */
+    getFilteredBucketPositions(bucketsToFetch?: BucketDescription[]): Map<string, util.InternalOpId>;
+    /**
+     * Update the position of bucket data the client has, after it was sent to the client.
+     *
+     * @param bucket the bucket name
+     * @param nextAfter sync operations >= this value in the next batch
+     */
+    updateBucketPosition(options: {
+        bucket: string;
+        nextAfter: util.InternalOpId;
+        hasMore: boolean;
+    }): void;
 }
 export type BucketChecksumStateStorage = Pick<storage.SyncRulesBucketStorage, 'getChecksums' | 'getParameterSets'>;
 export {};

package/dist/sync/BucketChecksumState.js

@@ -1,5 +1,5 @@
 import * as util from '../util/util-index.js';
-import { ErrorCode, logger, ServiceAssertionError, ServiceError } from '@powersync/lib-services-framework';
+import { ErrorCode, ServiceAssertionError, ServiceError, logger as defaultLogger } from '@powersync/lib-services-framework';
 import { JSONBig } from '@powersync/service-jsonbig';
 import { getIntersection, hasIntersection } from './util.js';
 /**
@@ -13,6 +13,8 @@ export class BucketChecksumState {
     /**
      * Bucket state of bucket id -> op_id.
      * This starts with the state from the client. May contain buckets that the user do not have access to (anymore).
+     *
+     * This is always updated in-place.
      */
     bucketDataPositions = new Map();
     /**
@@ -26,34 +28,38 @@ export class BucketChecksumState {
      * partial checkpoints are sent.
      */
     pendingBucketDownloads = new Set();
+    logger;
     constructor(options) {
         this.context = options.syncContext;
         this.bucketStorage = options.bucketStorage;
-        this.parameterState = new BucketParameterState(options.syncContext, options.bucketStorage, options.syncRules, options.syncParams);
+        this.logger = options.logger ?? defaultLogger;
+        this.parameterState = new BucketParameterState(options.syncContext, options.bucketStorage, options.syncRules, options.syncParams, this.logger);
         this.bucketDataPositions = new Map();
         for (let { name, after: start } of options.initialBucketPositions ?? []) {
             this.bucketDataPositions.set(name, { start_op_id: start });
         }
     }
+    /**
+     * Build a new checkpoint line for an underlying storage checkpoint update if any buckets have changed.
+     *
+     * This call is idempotent - no internal state is updated directly when this is called.
+     *
+     * When the checkpoint line is sent to the client, call `CheckpointLine.advance()` to update the internal state.
+     * A line may be safely discarded (not sent to the client) if `advance()` is not called.
+     *
+     * @param next The updated checkpoint
+     * @returns A {@link CheckpointLine} if any of the buckets watched by this connected was updated, or otherwise `null`.
+     */
     async buildNextCheckpointLine(next) {
         const { writeCheckpoint, base } = next;
         const user_id = this.parameterState.syncParams.user_id;
         const storage = this.bucketStorage;
         const update = await this.parameterState.getCheckpointUpdate(next);
-        if (update == null && this.lastWriteCheckpoint == writeCheckpoint) {
-            return null;
-        }
         const { buckets: allBuckets, updatedBuckets } = update;
-        let dataBucketsNew = new Map();
-        for (let bucket of allBuckets) {
-            dataBucketsNew.set(bucket.bucket, {
-                description: bucket,
-                start_op_id: this.bucketDataPositions.get(bucket.bucket)?.start_op_id ?? 0n
-            });
-        }
-        this.bucketDataPositions = dataBucketsNew;
-        if (dataBucketsNew.size > this.context.maxBuckets) {
-            throw new ServiceError(ErrorCode.PSYNC_S2305, `Too many buckets: ${dataBucketsNew.size} (limit of ${this.context.maxBuckets})`);
+        /** Set of all buckets in this checkpoint. */
+        const bucketDescriptionMap = new Map(allBuckets.map((b) => [b.bucket, b]));
+        if (bucketDescriptionMap.size > this.context.maxBuckets) {
+            throw new ServiceError(ErrorCode.PSYNC_S2305, `Too many buckets: ${bucketDescriptionMap.size} (limit of ${this.context.maxBuckets})`);
         }
         let checksumMap;
         if (updatedBuckets != INVALIDATE_ALL_BUCKETS) {
@@ -63,7 +69,7 @@ export class BucketChecksumState {
             // Re-check updated buckets only
             let checksumLookups = [];
             let newChecksums = new Map();
-            for (let bucket of dataBucketsNew.keys()) {
+            for (let bucket of bucketDescriptionMap.keys()) {
                 if (!updatedBuckets.has(bucket)) {
                     const existing = this.lastChecksums.get(bucket);
                     if (existing == null) {
@@ -87,12 +93,14 @@ export class BucketChecksumState {
         }
         else {
             // Re-check all buckets
-            const bucketList = [...dataBucketsNew.keys()];
+            const bucketList = [...bucketDescriptionMap.keys()];
             checksumMap = await storage.getChecksums(base.checkpoint, bucketList);
         }
         // Subset of buckets for which there may be new data in this batch.
         let bucketsToFetch;
         let checkpointLine;
+        // Log function that is deferred until the checkpoint line is sent to the client.
+        let deferredLog;
         if (this.lastChecksums) {
             // TODO: If updatedBuckets is present, we can use that to more efficiently calculate a diff,
             // and avoid any unnecessary loops through the entire list of buckets.
@@ -116,26 +124,28 @@ export class BucketChecksumState {
             }
             const updatedBucketDescriptions = diff.updatedBuckets.map((e) => ({
                 ...e,
-                priority: this.bucketDataPositions.get(e.bucket).description.priority
+                priority: bucketDescriptionMap.get(e.bucket).priority
             }));
             bucketsToFetch = [...generateBucketsToFetch].map((b) => {
                 return {
                     bucket: b,
-                    priority: this.bucketDataPositions.get(b).description.priority
+                    priority: bucketDescriptionMap.get(b).priority
                 };
             });
-            let message = `Updated checkpoint: ${base.checkpoint} | `;
-            message += `write: ${writeCheckpoint} | `;
-            message += `buckets: ${allBuckets.length} | `;
-            message += `updated: ${limitedBuckets(diff.updatedBuckets, 20)} | `;
-            message += `removed: ${limitedBuckets(diff.removedBuckets, 20)}`;
-            logger.info(message, {
-                checkpoint: base.checkpoint,
-                user_id: user_id,
-                buckets: allBuckets.length,
-                updated: diff.updatedBuckets.length,
-                removed: diff.removedBuckets.length
-            });
+            deferredLog = () => {
+                let message = `Updated checkpoint: ${base.checkpoint} | `;
+                message += `write: ${writeCheckpoint} | `;
+                message += `buckets: ${allBuckets.length} | `;
+                message += `updated: ${limitedBuckets(diff.updatedBuckets, 20)} | `;
+                message += `removed: ${limitedBuckets(diff.removedBuckets, 20)}`;
+                this.logger.info(message, {
+                    checkpoint: base.checkpoint,
+                    user_id: user_id,
+                    buckets: allBuckets.length,
+                    updated: diff.updatedBuckets.length,
+                    removed: diff.removedBuckets.length
+                });
+            };
             checkpointLine = {
                 checkpoint_diff: {
                     last_op_id: util.internalToExternalOpId(base.checkpoint),
@@ -146,9 +156,11 @@ export class BucketChecksumState {
             };
         }
         else {
-            let message = `New checkpoint: ${base.checkpoint} | write: ${writeCheckpoint} | `;
-            message += `buckets: ${allBuckets.length} ${limitedBuckets(allBuckets, 20)}`;
-            logger.info(message, { checkpoint: base.checkpoint, user_id: user_id, buckets: allBuckets.length });
+            deferredLog = () => {
+                let message = `New checkpoint: ${base.checkpoint} | write: ${writeCheckpoint} | `;
+                message += `buckets: ${allBuckets.length} ${limitedBuckets(allBuckets, 20)}`;
+                this.logger.info(message, { checkpoint: base.checkpoint, user_id: user_id, buckets: allBuckets.length });
+            };
             bucketsToFetch = allBuckets;
             checkpointLine = {
                 checkpoint: {
@@ -156,49 +168,83 @@ export class BucketChecksumState {
                     write_checkpoint: writeCheckpoint ? String(writeCheckpoint) : undefined,
                     buckets: [...checksumMap.values()].map((e) => ({
                         ...e,
-                        priority: this.bucketDataPositions.get(e.bucket).description.priority
+                        priority: bucketDescriptionMap.get(e.bucket).priority
                     }))
                 }
             };
         }
-        this.lastChecksums = checksumMap;
-        this.lastWriteCheckpoint = writeCheckpoint;
-        this.pendingBucketDownloads = new Set(bucketsToFetch.map((b) => b.bucket));
+        const pendingBucketDownloads = new Set(bucketsToFetch.map((b) => b.bucket));
+        let hasAdvanced = false;
         return {
             checkpointLine,
-            bucketsToFetch
-        };
-    }
-    /**
-     * Get bucket positions to sync, given the list of buckets.
-     *
-     * @param bucketsToFetch List of buckets to fetch, typically from buildNextCheckpointLine, or a subset of that
-     * @returns
-     */
-    getFilteredBucketPositions(bucketsToFetch) {
-        const filtered = new Map();
-        for (let bucket of bucketsToFetch) {
-            const state = this.bucketDataPositions.get(bucket.bucket);
-            if (state) {
-                filtered.set(bucket.bucket, state.start_op_id);
+            bucketsToFetch,
+            advance: () => {
+                hasAdvanced = true;
+                // bucketDataPositions must be updated in-place - it represents the current state of
+                // the connection, not of the checkpoint line.
+                // The following could happen:
+                // 1. A = buildCheckpointLine()
+                // 2. A.advance()
+                // 3. B = buildCheckpointLine()
+                // 4. A.updateBucketPosition()
+                // 5. B.advance()
+                // In that case, it is important that the updated bucket position for A takes effect
+                // for checkpoint B.
+                let bucketsToRemove = [];
+                for (let bucket of this.bucketDataPositions.keys()) {
+                    if (!bucketDescriptionMap.has(bucket)) {
+                        bucketsToRemove.push(bucket);
+                    }
+                }
+                for (let bucket of bucketsToRemove) {
+                    this.bucketDataPositions.delete(bucket);
+                }
+                for (let bucket of allBuckets) {
+                    if (!this.bucketDataPositions.has(bucket.bucket)) {
+                        // Bucket the client hasn't seen before - initialize with 0.
+                        this.bucketDataPositions.set(bucket.bucket, { start_op_id: 0n });
+                    }
+                    // If the bucket position is already present, we keep the current position.
+                }
+                this.lastChecksums = checksumMap;
+                this.lastWriteCheckpoint = writeCheckpoint;
+                this.pendingBucketDownloads = pendingBucketDownloads;
+                deferredLog();
+            },
+            getFilteredBucketPositions: (buckets) => {
+                if (!hasAdvanced) {
+                    throw new ServiceAssertionError('Call line.advance() before getFilteredBucketPositions()');
+                }
+                buckets ??= bucketsToFetch;
+                const filtered = new Map();
+                for (let bucket of buckets) {
+                    const state = this.bucketDataPositions.get(bucket.bucket);
+                    if (state) {
+                        filtered.set(bucket.bucket, state.start_op_id);
+                    }
+                }
+                return filtered;
+            },
+            updateBucketPosition: (options) => {
+                if (!hasAdvanced) {
+                    throw new ServiceAssertionError('Call line.advance() before updateBucketPosition()');
+                }
+                const state = this.bucketDataPositions.get(options.bucket);
+                if (state) {
+                    state.start_op_id = options.nextAfter;
+                }
+                else {
+                    // If we hit this, another checkpoint has removed the bucket in the meantime, meaning
+                    // line.advance() has been called on it. In that case we don't need the bucket state anymore.
+                    // It is generally not expected to happen, but we still cover the case.
+                }
+                if (!options.hasMore) {
+                    // This specifically updates the per-checkpoint line. Completing a download for one line,
+                    // does not remove it from the next line, since it could have new updates there.
+                    pendingBucketDownloads.delete(options.bucket);
+                }
             }
-        }
-        return filtered;
-    }
-    /**
-     * Update the position of bucket data the client has.
-     *
-     * @param bucket the bucket name
-     * @param nextAfter sync operations >= this value in the next batch
-     */
-    updateBucketPosition(options) {
-        const state = this.bucketDataPositions.get(options.bucket);
-        if (state) {
-            state.start_op_id = options.nextAfter;
-        }
-        if (!options.hasMore) {
-            this.pendingBucketDownloads.delete(options.bucket);
-        }
+        };
     }
 }
 const INVALIDATE_ALL_BUCKETS = Symbol('INVALIDATE_ALL_BUCKETS');
@@ -209,14 +255,16 @@ export class BucketParameterState {
     syncParams;
     querier;
     staticBuckets;
+    logger;
     cachedDynamicBuckets = null;
     cachedDynamicBucketSet = null;
     lookups;
-    constructor(context, bucketStorage, syncRules, syncParams) {
+    constructor(context, bucketStorage, syncRules, syncParams, logger) {
         this.context = context;
         this.bucketStorage = bucketStorage;
         this.syncRules = syncRules;
         this.syncParams = syncParams;
+        this.logger = logger;
         this.querier = syncRules.getBucketParameterQuerier(this.syncParams);
         this.staticBuckets = new Map(this.querier.staticBuckets.map((b) => [b.bucket, b]));
         this.lookups = new Set(this.querier.parameterQueryLookups.map((l) => JSONBig.stringify(l.values)));
@@ -234,7 +282,7 @@ export class BucketParameterState {
             // TODO: Limit number of results even before we get to this point
             // This limit applies _before_ we get the unique set
             const error = new ServiceError(ErrorCode.PSYNC_S2305, `Too many parameter query results: ${update.buckets.length} (limit of ${this.context.maxParameterQueryResults})`);
-            logger.error(error.message, {
+            this.logger.error(error.message, {
                 checkpoint: checkpoint,
                 user_id: this.syncParams.user_id,
                 buckets: update.buckets.length