Additional log metadata on sync requests (#261)

* Setup a logger per request/connection.

* Pass logger through to sync streams.

* Add closeReason for websockets.

* Fix some tests.

* Log more granular stats on synced operations.

* Add stream_ms, close_reason.

* Add changeset.

* Add some comments on closeReason.

Author: rkistner

.changeset/clever-months-travel.md

@@ -0,0 +1,15 @@
+---
+'@powersync/service-rsocket-router': minor
+'@powersync/service-core': minor
+'@powersync/lib-services-framework': minor
+'@powersync/service-image': minor
+'@powersync/service-module-postgres-storage': patch
+'@powersync/service-module-mongodb-storage': patch
+'@powersync/service-module-postgres': patch
+'@powersync/service-module-mongodb': patch
+'@powersync/service-module-mysql': patch
+'@powersync/service-sync-rules': patch
+'@powersync/lib-service-postgres': patch
+---
+
+Add additional log metadata to sync requests.

libs/lib-postgres/package.json

@@ -34,9 +34,7 @@
     "p-defer": "^4.0.1",
     "ts-codec": "^1.3.0",
     "uri-js": "^4.4.1",
-    "uuid": "^9.0.1"
+    "uuid": "^11.1.0"
   },
-  "devDependencies": {
-    "@types/uuid": "^9.0.4"
-  }
+  "devDependencies": {}
 }

libs/lib-services/package.json

@@ -28,13 +28,12 @@
     "ipaddr.js": "^2.1.0",
     "lodash": "^4.17.21",
     "ts-codec": "^1.3.0",
-    "uuid": "^9.0.1",
+    "uuid": "^11.1.0",
     "winston": "^3.13.0",
     "zod": "^3.23.8"
   },
   "devDependencies": {
     "@types/lodash": "^4.17.5",
-    "@types/uuid": "^9.0.4",
     "vitest": "^3.0.5"
   }
 }

libs/lib-services/src/index.ts

@@ -9,7 +9,7 @@ export * from './container.js';
 export * from './errors/errors-index.js';
 export * as errors from './errors/errors-index.js';
 
-export * from './logger/Logger.js';
+export * from './logger/logger-index.js';
 
 export * from './locks/locks-index.js';
 export * as locks from './locks/locks-index.js';

libs/lib-services/src/logger/Logger.ts

@@ -1,17 +1,14 @@
 import winston from 'winston';
 
-export namespace Logger {
-  export const development_format = winston.format.combine(
-    winston.format.colorize({ level: true }),
-    winston.format.simple()
-  );
-  export const production_format = winston.format.combine(winston.format.timestamp(), winston.format.json());
+export namespace LogFormat {
+  export const development = winston.format.combine(winston.format.colorize({ level: true }), winston.format.simple());
+  export const production = winston.format.combine(winston.format.timestamp(), winston.format.json());
 }
 
 export const logger = winston.createLogger();
 
 // Configure logging to console as the default
 logger.configure({
-  format: process.env.NODE_ENV == 'production' ? Logger.production_format : Logger.development_format,
+  format: process.env.NODE_ENV == 'production' ? LogFormat.production : LogFormat.development,
   transports: [new winston.transports.Console()]
 });

libs/lib-services/src/logger/logger-index.ts

@@ -1 +1,2 @@
 export * from './Logger.js';
+export { Logger } from 'winston';

libs/lib-services/src/router/router-response.ts

@@ -9,7 +9,7 @@ export type RouterResponseParams<T> = {
   /**
    * Hook to be called after the response has been sent
    */
-  afterSend?: () => Promise<void>;
+  afterSend?: (details: { clientClosed: boolean }) => Promise<void>;
 };
 
 /**
@@ -21,7 +21,7 @@ export class RouterResponse<T = unknown> {
   status: number;
   data: T;
   headers: Record<string, string>;
-  afterSend: () => Promise<void>;
+  afterSend: (details: { clientClosed: boolean }) => Promise<void>;
 
   __micro_router_response = true;
 

modules/module-mongodb-storage/package.json

@@ -28,20 +28,19 @@
     }
   },
   "dependencies": {
+    "@powersync/lib-service-mongodb": "workspace:*",
     "@powersync/lib-services-framework": "workspace:*",
     "@powersync/service-core": "workspace:*",
     "@powersync/service-jsonbig": "workspace:*",
     "@powersync/service-sync-rules": "workspace:*",
     "@powersync/service-types": "workspace:*",
-    "@powersync/lib-service-mongodb": "workspace:*",
     "bson": "^6.10.3",
-    "ts-codec": "^1.3.0",
     "ix": "^5.0.0",
     "lru-cache": "^10.2.2",
-    "uuid": "^9.0.1"
+    "ts-codec": "^1.3.0",
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
-    "@types/uuid": "^9.0.4",
     "@powersync/service-core-tests": "workspace:*"
   }
 }

modules/module-mongodb/package.json

@@ -28,18 +28,17 @@
     }
   },
   "dependencies": {
+    "@powersync/lib-service-mongodb": "workspace:*",
     "@powersync/lib-services-framework": "workspace:*",
     "@powersync/service-core": "workspace:*",
     "@powersync/service-jsonbig": "workspace:*",
     "@powersync/service-sync-rules": "workspace:*",
     "@powersync/service-types": "workspace:*",
-    "@powersync/lib-service-mongodb": "workspace:*",
     "bson": "^6.10.3",
     "ts-codec": "^1.3.0",
-    "uuid": "^9.0.1"
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
-    "@types/uuid": "^9.0.4",
     "@powersync/service-core-tests": "workspace:*",
     "@powersync/service-module-mongodb-storage": "workspace:*",
     "@powersync/service-module-postgres-storage": "workspace:*"

modules/module-mysql/package.json

@@ -29,24 +29,23 @@
   },
   "dependencies": {
     "@powersync/lib-services-framework": "workspace:*",
+    "@powersync/mysql-zongji": "^0.1.0",
     "@powersync/service-core": "workspace:*",
+    "@powersync/service-jsonbig": "workspace:*",
     "@powersync/service-sync-rules": "workspace:*",
     "@powersync/service-types": "workspace:*",
-    "@powersync/service-jsonbig": "workspace:*",
-    "@powersync/mysql-zongji": "^0.1.0",
-    "semver": "^7.5.4",
     "async": "^3.2.4",
     "mysql2": "^3.11.0",
+    "semver": "^7.5.4",
     "ts-codec": "^1.3.0",
     "uri-js": "^4.4.1",
-    "uuid": "^9.0.1"
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
-    "@types/semver": "^7.5.4",
-    "@types/async": "^3.2.24",
-    "@types/uuid": "^9.0.4",
     "@powersync/service-core-tests": "workspace:*",
     "@powersync/service-module-mongodb-storage": "workspace:*",
-    "@powersync/service-module-postgres-storage": "workspace:*"
+    "@powersync/service-module-postgres-storage": "workspace:*",
+    "@types/async": "^3.2.24",
+    "@types/semver": "^7.5.4"
   }
 }