cleanup router code and naming

stevensJourney · stevensJourney · commit 0dcae0d7b8e6 · 2025-05-07T10:23:35.000+02:00
diff --git a/modules/module-core/src/CoreModule.ts b/modules/module-core/src/CoreModule.ts
@@ -14,7 +14,7 @@ export class CoreModule extends core.modules.AbstractModule {
   public async initialize(context: core.ServiceContextContainer): Promise<void> {
     this.configureTags(context);
 
-    if ([core.system.ServiceContextMode.API, core.system.ServiceContextMode.UNIFIED].includes(context.mode)) {
+    if ([core.system.ServiceContextMode.API, core.system.ServiceContextMode.UNIFIED].includes(context.serviceMode)) {
       // Service should include API routes
       this.registerAPIRoutes(context);
     }
@@ -115,7 +115,7 @@ export class CoreModule extends core.modules.AbstractModule {
     } = context;
 
     const exposesAPI = [core.system.ServiceContextMode.API, core.system.ServiceContextMode.UNIFIED].includes(
-      context.mode
+      context.serviceMode
     );
 
     /**
@@ -124,13 +124,13 @@ export class CoreModule extends core.modules.AbstractModule {
      *  - Always enabling filesystem probes always exposing HTTP probes
      * Probe types must explicitly be selected if not using LEGACY_DEFAULT
      */
-    if (probes.http || (exposesAPI && probes.legacy)) {
+    if (probes.use_http || (exposesAPI && probes.use_legacy)) {
       context.routerEngine.registerRoutes({
         api_routes: core.routes.endpoints.PROBES_ROUTES
       });
     }
 
-    if (probes.legacy || probes.filesystem) {
+    if (probes.use_legacy || probes.use_filesystem) {
       context.register(framework.ContainerImplementation.PROBES, framework.createFSProbe());
     }
   }
@@ -146,7 +146,7 @@ export class CoreModule extends core.modules.AbstractModule {
 
     await core.metrics.registerMetrics({
       service_context: context,
-      modes: metricsModeMap[context.mode] ?? []
+      modes: metricsModeMap[context.serviceMode] ?? []
     });
   }
 
diff --git a/modules/module-core/test/src/index.ts b/modules/module-core/test/src/index.ts
diff --git a/modules/module-core/test/src/probes.test.ts b/modules/module-core/test/src/probes.test.ts
@@ -24,7 +24,7 @@ const createTestContainer = async (options: TestContainerOptions) => {
 
   const serviceContext = new system.ServiceContextContainer({
     configuration: collectedConfig,
-    mode: options.mode
+    serviceMode: options.mode
   });
 
   await moduleManager.initialize(serviceContext);
@@ -89,7 +89,7 @@ describe('Probes', () => {
           type: memory
         healthcheck:
           probes:
-            http: true
+            use_http: true
       `,
       mode: system.ServiceContextMode.SYNC
     });
@@ -148,7 +148,7 @@ describe('Probes', () => {
           type: memory
         healthcheck:
           probes:
-            http: true
+            use_http: true
       `,
       mode: system.ServiceContextMode.API
     });
diff --git a/packages/service-core/src/entry/commands/compact-action.ts b/packages/service-core/src/entry/commands/compact-action.ts
@@ -38,7 +38,7 @@ export function registerCompactAction(program: Command) {
     }
     const config = await utils.loadConfig(extractRunnerOptions(options));
     const serviceContext = new system.ServiceContextContainer({
-      mode: system.ServiceContextMode.COMPACT,
+      serviceMode: system.ServiceContextMode.COMPACT,
       configuration: config
     });
 
diff --git a/packages/service-core/src/entry/commands/migrate-action.ts b/packages/service-core/src/entry/commands/migrate-action.ts
@@ -19,7 +19,7 @@ export function registerMigrationAction(program: Command) {
     .action(async (direction: migrations.Direction, options) => {
       const config = await utils.loadConfig(extractRunnerOptions(options));
       const serviceContext = new system.ServiceContextContainer({
-        mode: system.ServiceContextMode.MIGRATION,
+        serviceMode: system.ServiceContextMode.MIGRATION,
         configuration: config
       });
 
diff --git a/packages/service-core/src/entry/commands/test-connection-action.ts b/packages/service-core/src/entry/commands/test-connection-action.ts
@@ -18,7 +18,7 @@ export function registerTestConnectionAction(program: Command) {
     try {
       const config = await utils.loadConfig(extractRunnerOptions(options));
       const serviceContext = new system.ServiceContextContainer({
-        mode: system.ServiceContextMode.TEST_CONNECTION,
+        serviceMode: system.ServiceContextMode.TEST_CONNECTION,
         configuration: config
       });
 
diff --git a/packages/service-core/src/routes/configure-fastify.ts b/packages/service-core/src/routes/configure-fastify.ts
@@ -9,7 +9,7 @@ import { PROBES_ROUTES } from './endpoints/probes.js';
 import { SYNC_RULES_ROUTES } from './endpoints/sync-rules.js';
 import { SYNC_STREAM_ROUTES } from './endpoints/sync-stream.js';
 import { createRequestQueueHook, CreateRequestQueueParams } from './hooks.js';
-import { RouteDefinition, RouterServiceContext } from './router.js';
+import { RouteDefinition } from './router.js';
 
 /**
  * A list of route definitions to be registered as endpoints.
@@ -59,14 +59,9 @@ export function configureFastifyServer(server: fastify.FastifyInstance, options:
   const { service_context, routes = DEFAULT_ROUTE_OPTIONS } = options;
 
   const generateContext = async () => {
-    const { routerEngine } = service_context;
-    if (!routerEngine) {
-      throw new Error(`RouterEngine has not been registered`);
-    }
-
     return {
       user_id: undefined,
-      service_context: service_context as RouterServiceContext
+      service_context: service_context
     };
   };
 
diff --git a/packages/service-core/src/routes/configure-rsocket.ts b/packages/service-core/src/routes/configure-rsocket.ts
@@ -37,10 +37,6 @@ export function configureRSocket(router: ReactiveSocketRouter<Context>, options:
             throw new errors.AuthorizationError(token_errors ?? 'Authentication required');
           }
 
-          if (!service_context.routerEngine) {
-            throw new Error(`RouterEngine has not been registered`);
-          }
-
           return {
             token,
             user_agent,
diff --git a/packages/service-core/src/routes/endpoints/admin.ts b/packages/service-core/src/routes/endpoints/admin.ts
@@ -19,7 +19,7 @@ export const executeSql = routeDefinition({
       }
     } = payload;
 
-    const apiHandler = payload.context.service_context.routerEngine!.getAPI();
+    const apiHandler = payload.context.service_context.routerEngine.getAPI();
 
     const sourceConfig = await apiHandler.getSourceConfig();
     if (!sourceConfig.debug_api) {
@@ -47,7 +47,7 @@ export const diagnostics = routeDefinition({
     const { service_context } = context;
     const include_content = payload.params.sync_rules_content ?? false;
 
-    const apiHandler = service_context.routerEngine!.getAPI();
+    const apiHandler = service_context.routerEngine.getAPI();
 
     const status = await apiHandler.getConnectionStatus();
     if (!status) {
@@ -94,7 +94,7 @@ export const getSchema = routeDefinition({
   authorize: authApi,
   validator: schema.createTsCodecValidator(internal_routes.GetSchemaRequest, { allowAdditional: true }),
   handler: async (payload) => {
-    const apiHandler = payload.context.service_context.routerEngine!.getAPI();
+    const apiHandler = payload.context.service_context.routerEngine.getAPI();
 
     return internal_routes.GetSchemaResponse.encode(await api.getConnectionsSchema(apiHandler));
   }
@@ -112,7 +112,7 @@ export const reprocess = routeDefinition({
     const {
       storageEngine: { activeBucketStorage }
     } = service_context;
-    const apiHandler = service_context.routerEngine!.getAPI();
+    const apiHandler = service_context.routerEngine.getAPI();
     const next = await activeBucketStorage.getNextSyncRules(apiHandler.getParseSyncRulesOptions());
     if (next != null) {
       throw new Error(`Busy processing sync rules - cannot reprocess`);
@@ -159,7 +159,7 @@ export const validate = routeDefinition({
       context: { service_context }
     } = payload;
     const content = payload.params.sync_rules;
-    const apiHandler = service_context.routerEngine!.getAPI();
+    const apiHandler = service_context.routerEngine.getAPI();
 
     const schemaData = await api.getConnectionsSchema(apiHandler);
     const schema = new StaticSchema(schemaData.connections);
diff --git a/packages/service-core/src/routes/endpoints/checkpointing.ts b/packages/service-core/src/routes/endpoints/checkpointing.ts
@@ -18,7 +18,7 @@ export const writeCheckpoint = routeDefinition({
     const {
       context: { service_context }
     } = payload;
-    const apiHandler = service_context.routerEngine!.getAPI();
+    const apiHandler = service_context.routerEngine.getAPI();
 
     // This old API needs a persisted checkpoint id.
     // Since we don't use LSNs anymore, the only way to get that is to wait.
@@ -54,7 +54,7 @@ export const writeCheckpoint2 = routeDefinition({
   handler: async (payload) => {
     const { user_id, service_context } = payload.context;
 
-    const apiHandler = service_context.routerEngine!.getAPI();
+    const apiHandler = service_context.routerEngine.getAPI();
 
     const { replicationHead, writeCheckpoint } = await util.createWriteCheckpoint({
       userId: user_id,
diff --git a/packages/service-core/src/routes/endpoints/socket-route.ts b/packages/service-core/src/routes/endpoints/socket-route.ts
@@ -33,7 +33,7 @@ export const syncStreamReactive: SocketRouteGenerator = (router) =>
         }
       });
 
-      if (routerEngine!.closed) {
+      if (routerEngine.closed) {
         responder.onError(
           new errors.ServiceError({
             status: 503,
@@ -64,9 +64,9 @@ export const syncStreamReactive: SocketRouteGenerator = (router) =>
         return;
       }
 
-      const syncRules = bucketStorage.getParsedSyncRules(routerEngine!.getAPI().getParseSyncRulesOptions());
+      const syncRules = bucketStorage.getParsedSyncRules(routerEngine.getAPI().getParseSyncRulesOptions());
 
-      const removeStopHandler = routerEngine!.addStopHandler(() => {
+      const removeStopHandler = routerEngine.addStopHandler(() => {
         controller.abort();
       });
 
diff --git a/packages/service-core/src/routes/endpoints/sync-rules.ts b/packages/service-core/src/routes/endpoints/sync-rules.ts
@@ -53,7 +53,7 @@ export const deploySyncRules = routeDefinition({
     const content = payload.params.content;
 
     try {
-      const apiHandler = service_context.routerEngine!.getAPI();
+      const apiHandler = service_context.routerEngine.getAPI();
       SqlSyncRules.fromYaml(payload.params.content, {
         ...apiHandler.getParseSyncRulesOptions(),
         // We don't do any schema-level validation at this point
@@ -94,7 +94,7 @@ export const validateSyncRules = routeDefinition({
   handler: async (payload) => {
     const content = payload.params.content;
     const { service_context } = payload.context;
-    const apiHandler = service_context.routerEngine!.getAPI();
+    const apiHandler = service_context.routerEngine.getAPI();
 
     const info = await debugSyncRules(apiHandler, content);
 
@@ -121,7 +121,7 @@ export const currentSyncRules = routeDefinition({
       });
     }
 
-    const apiHandler = service_context.routerEngine!.getAPI();
+    const apiHandler = service_context.routerEngine.getAPI();
     const info = await debugSyncRules(apiHandler, sync_rules.sync_rules_content);
     const next = await activeBucketStorage.getNextSyncRulesContent();
 
@@ -158,7 +158,7 @@ export const reprocessSyncRules = routeDefinition({
     const {
       storageEngine: { activeBucketStorage }
     } = payload.context.service_context;
-    const apiHandler = payload.context.service_context.routerEngine!.getAPI();
+    const apiHandler = payload.context.service_context.routerEngine.getAPI();
     const sync_rules = await activeBucketStorage.getActiveSyncRules(apiHandler.getParseSyncRulesOptions());
     if (sync_rules == null) {
       throw new errors.ServiceError({
diff --git a/packages/service-core/src/routes/endpoints/sync-stream.ts b/packages/service-core/src/routes/endpoints/sync-stream.ts
@@ -26,7 +26,7 @@ export const syncStreamed = routeDefinition({
     const userAgent = headers['x-user-agent'] ?? headers['user-agent'];
     const clientId = payload.params.client_id;
 
-    if (routerEngine!.closed) {
+    if (routerEngine.closed) {
       throw new errors.ServiceError({
         status: 503,
         code: ErrorCode.PSYNC_S2003,
@@ -47,7 +47,7 @@ export const syncStreamed = routeDefinition({
       });
     }
 
-    const syncRules = bucketStorage.getParsedSyncRules(routerEngine!.getAPI().getParseSyncRulesOptions());
+    const syncRules = bucketStorage.getParsedSyncRules(routerEngine.getAPI().getParseSyncRulesOptions());
 
     const controller = new AbortController();
     const tracker = new sync.RequestTracker(metricsEngine);
@@ -72,7 +72,7 @@ export const syncStreamed = routeDefinition({
         { objectMode: false, highWaterMark: 16 * 1024 }
       );
 
-      const deregister = routerEngine!.addStopHandler(() => {
+      const deregister = routerEngine.addStopHandler(() => {
         // This error is not currently propagated to the client
         controller.abort();
         stream.destroy(new Error('Shutting down system'));
diff --git a/packages/service-core/src/routes/router.ts b/packages/service-core/src/routes/router.ts
@@ -6,7 +6,8 @@ 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
  */
diff --git a/packages/service-core/src/runner/teardown.ts b/packages/service-core/src/runner/teardown.ts
@@ -15,7 +15,7 @@ export async function teardown(runnerConfig: utils.RunnerConfig) {
     logger.info(`Tearing down PowerSync instance...`);
     const config = await utils.loadConfig(runnerConfig);
     const serviceContext = new system.ServiceContextContainer({
-      mode: system.ServiceContextMode.TEARDOWN,
+      serviceMode: system.ServiceContextMode.TEARDOWN,
       configuration: config
     });
 
diff --git a/packages/service-core/src/system/ServiceContext.ts b/packages/service-core/src/system/ServiceContext.ts
@@ -14,10 +14,11 @@ export interface ServiceContext {
   lifeCycleEngine: LifeCycledSystem;
   metricsEngine: metrics.MetricsEngine;
   replicationEngine: replication.ReplicationEngine | null;
-  routerEngine: routes.RouterEngine | null;
+  routerEngine: routes.RouterEngine;
   storageEngine: storage.StorageEngine;
   migrations: PowerSyncMigrationManager;
   syncContext: SyncContext;
+  serviceMode: ServiceContextMode;
 }
 
 export enum ServiceContextMode {
@@ -31,7 +32,7 @@ export enum ServiceContextMode {
 }
 
 export interface ServiceContextOptions {
-  mode: ServiceContextMode;
+  serviceMode: ServiceContextMode;
   configuration: utils.ResolvedPowerSyncConfig;
 }
 
@@ -46,10 +47,10 @@ export class ServiceContextContainer implements ServiceContext {
   storageEngine: storage.StorageEngine;
   syncContext: SyncContext;
   routerEngine: routes.RouterEngine;
-  mode: ServiceContextMode;
+  serviceMode: ServiceContextMode;
 
   constructor(options: ServiceContextOptions) {
-    this.mode = options.mode;
+    this.serviceMode = options.serviceMode;
     const { configuration } = options;
     this.configuration = configuration;
 
diff --git a/packages/service-core/src/util/config/compound-config-collector.ts b/packages/service-core/src/util/config/compound-config-collector.ts
@@ -166,14 +166,14 @@ export class CompoundConfigCollector {
          */
         probes: baseConfig.healthcheck?.probes
           ? {
-              filesystem: baseConfig.healthcheck.probes.filesystem ?? false,
-              http: baseConfig.healthcheck.probes.http ?? false,
-              legacy: baseConfig.healthcheck.probes.legacy ?? false
+              use_filesystem: baseConfig.healthcheck.probes.use_filesystem ?? false,
+              use_http: baseConfig.healthcheck.probes.use_http ?? false,
+              use_legacy: baseConfig.healthcheck.probes.use_legacy ?? false
             }
           : {
-              filesystem: false,
-              http: false,
-              legacy: true
+              use_filesystem: false,
+              use_http: false,
+              use_legacy: true
             }
       },
       api_parameters: {
diff --git a/packages/service-core/src/util/config/types.ts b/packages/service-core/src/util/config/types.ts
@@ -72,13 +72,13 @@ export type ResolvedPowerSyncConfig = {
 
   healthcheck: {
     probes: {
-      filesystem: boolean;
-      http: boolean;
+      use_filesystem: boolean;
+      use_http: boolean;
       /**
        * @deprecated This maintains backwards compatibility with the legacy default.
        * Explicit probe configuration should be used instead.
        */
-      legacy: boolean;
+      use_legacy: boolean;
     };
   };
 
diff --git a/packages/service-core/test/src/config.test.ts b/packages/service-core/test/src/config.test.ts
@@ -44,7 +44,7 @@ describe('Config', () => {
       config_base64: Buffer.from(yamlConfig, 'utf-8').toString('base64')
     });
 
-    expect(config.healthcheck.probes.http).toBe(true);
+    expect(config.healthcheck.probes.use_http).toBe(true);
   });
 
   it('should substitute number env variables in YAML config', {}, async () => {
diff --git a/packages/types/src/config/PowerSyncConfig.ts b/packages/types/src/config/PowerSyncConfig.ts
diff --git a/service/src/runners/server.ts b/service/src/runners/server.ts
diff --git a/service/src/runners/stream-worker.ts b/service/src/runners/stream-worker.ts
diff --git a/service/src/runners/unified-runner.ts b/service/src/runners/unified-runner.ts

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ export function registerCompactAction(program: Command) {`
`38`	`38`	`}`
`39`	`39`	`const config = await utils.loadConfig(extractRunnerOptions(options));`
`40`	`40`	`const serviceContext = new system.ServiceContextContainer({`
`41`		`- mode: system.ServiceContextMode.COMPACT,`
	`41`	`+ serviceMode: system.ServiceContextMode.COMPACT,`
`42`	`42`	`configuration: config`
`43`	`43`	`});`
`44`	`44`