Code cleanup

Author: stevensJourney

packages/service-core/src/routes/endpoints/socket-route.ts

@@ -6,7 +6,7 @@ import { SocketRouteGenerator } from '../router-socket.js';
 import { SyncRoutes } from './sync-stream.js';
 
 import { APIMetric, event_types } from '@powersync/service-types';
-import { formatParamsForLogging } from '../../util/param-logging.js';
+import { limitParamsForLogging } from '../../util/param-logging.js';
 
 export const syncStreamReactive: SocketRouteGenerator = (router) =>
   router.reactiveStream<util.StreamingSyncRequest, any>(SyncRoutes.STREAM, {
@@ -99,10 +99,10 @@ export const syncStreamReactive: SocketRouteGenerator = (router) =>
         tracker.setCompressed(connection.tracker.encoding);
       }
 
-      const formattedAppMetadata = params.app_metadata ? formatParamsForLogging(params.app_metadata) : undefined;
+      const formattedAppMetadata = params.app_metadata ? limitParamsForLogging(params.app_metadata) : undefined;
       logger.info('Sync stream started', {
         app_metadata: formattedAppMetadata,
-        client_params: params.parameters ? formatParamsForLogging(params.parameters) : undefined
+        client_params: params.parameters ? limitParamsForLogging(params.parameters) : undefined
       });
 
       try {

packages/service-core/src/routes/endpoints/sync-stream.ts

@@ -9,7 +9,7 @@ import { APIMetric, event_types } from '@powersync/service-types';
 import { authUser } from '../auth.js';
 import { routeDefinition } from '../router.js';
 
-import { formatParamsForLogging } from '../../util/param-logging.js';
+import { limitParamsForLogging } from '../../util/param-logging.js';
 import { maybeCompressResponseStream } from '../compression.js';
 
 export enum SyncRoutes {
@@ -78,12 +78,12 @@ export const syncStreamed = routeDefinition({
     const tracker = new sync.RequestTracker(metricsEngine);
 
     const formattedAppMetadata = payload.params.app_metadata
-      ? formatParamsForLogging(payload.params.app_metadata)
+      ? limitParamsForLogging(payload.params.app_metadata)
       : undefined;
 
     logger.info('Sync stream started', {
       app_metadata: formattedAppMetadata,
-      client_params: payload.params.parameters ? formatParamsForLogging(payload.params.parameters) : undefined
+      client_params: payload.params.parameters ? limitParamsForLogging(payload.params.parameters) : undefined
     });
 
     try {

packages/service-core/src/util/param-logging.ts

@@ -1,14 +1,34 @@
+/**
+ * Options for {@link limitParamsForLogging}.
+ */
 export type ParamLoggingFormatOptions = {
   maxKeyCount: number;
   maxStringLength: number;
 };
 
+/**
+ * Default options for {@link limitParamsForLogging}.
+ */
 export const DEFAULT_PARAM_LOGGING_FORMAT_OPTIONS: ParamLoggingFormatOptions = {
   maxKeyCount: 10,
   maxStringLength: 50
 };
 
-export function formatParamsForLogging(params: Record<string, any>, options: Partial<ParamLoggingFormatOptions> = {}) {
+/**
+ * Formats potentially arbitrary parameters for logging.
+ * This limits the number of keys and strings to a maximum length.
+ * A warning key-value is added if the number of keys exceeds the maximum.
+ * String values exceeding the maximum length are truncated.
+ * Non-String values are stringified, the maximum length is then applied.
+ * @param params - The parameters to format.
+ * @param options - The options to use.
+ * @default DEFAULT_PARAM_LOGGING_FORMAT_OPTIONS
+ * @returns The formatted parameters.
+ */
+export function limitParamsForLogging(
+  params: Record<string, any>,
+  options: Partial<ParamLoggingFormatOptions> = DEFAULT_PARAM_LOGGING_FORMAT_OPTIONS
+) {
   const {
     maxStringLength = DEFAULT_PARAM_LOGGING_FORMAT_OPTIONS.maxStringLength,
     maxKeyCount = DEFAULT_PARAM_LOGGING_FORMAT_OPTIONS.maxKeyCount
@@ -31,7 +51,7 @@ export function formatParamsForLogging(params: Record<string, any>, options: Par
         return [];
       }
 
-      if (typeof value === 'string') {
+      if (typeof value == 'string') {
         return [key, trimString(value)];
       }
       return [key, trimString(JSON.stringify(value))];

packages/service-core/test/src/routes/stream.test.ts

@@ -6,7 +6,7 @@ import { pipeline } from 'stream/promises';
 import { describe, expect, it } from 'vitest';
 import winston from 'winston';
 import { syncStreamed } from '../../../src/routes/endpoints/sync-stream.js';
-import { DEFAULT_PARAM_LOGGING_FORMAT_OPTIONS, formatParamsForLogging } from '../../../src/util/param-logging.js';
+import { DEFAULT_PARAM_LOGGING_FORMAT_OPTIONS, limitParamsForLogging } from '../../../src/util/param-logging.js';
 import { mockServiceContext } from './mocks.js';
 
 describe('Stream Route', () => {
@@ -149,7 +149,7 @@ describe('Stream Route', () => {
 
       // Verify that app_metadata from defaultMeta is present in the log
       expect(syncStartedLog?.app_metadata).toBeDefined();
-      expect(syncStartedLog?.app_metadata).toEqual(formatParamsForLogging(inputMeta));
+      expect(syncStartedLog?.app_metadata).toEqual(limitParamsForLogging(inputMeta));
       // Should trim long metadata
       expect(syncStartedLog?.app_metadata.long_meta.length).toEqual(
         DEFAULT_PARAM_LOGGING_FORMAT_OPTIONS.maxStringLength