feat(config): allow additional shortstop handlers to be inserted before configuration is loaded

Author: djMax

__tests__/config.test.ts

@@ -4,6 +4,7 @@ import path from 'path';
 import { describe, expect, test } from 'vitest';
 
 import { ConfigurationSchema, insertConfigurationBefore, loadConfiguration } from '../src/config';
+import { shortstops } from '../src/config/shortstops';
 
 interface CustomConfig extends ConfigurationSchema {
   google: string;
@@ -18,10 +19,10 @@ interface CustomConfig extends ConfigurationSchema {
 describe('configuration loader', () => {
   test('overrides and shortstops', async () => {
     const rootDirectory = path.resolve(__dirname, './fake-serv');
+    const shortstopHandlers = shortstops({ name: 'fake-serv' }, path.join(rootDirectory, 'src'));
     const config = await loadConfiguration<CustomConfig>({
-      name: 'fake-serv',
-      sourceDirectory: path.join(rootDirectory, 'src'),
       configurationDirectories: [path.resolve(rootDirectory, './config')],
+      shortstopHandlers,
     });
 
     expect(config.logging?.level).toEqual('debug');

src/config/index.ts

@@ -1,11 +1,16 @@
 import fs from 'fs';
 import path from 'path';
 
-import { BaseConfitSchema, Confit, Factory, confit } from '@sesamecare-oss/confit';
+import {
+  BaseConfitSchema,
+  Confit,
+  Factory,
+  ShortstopHandler,
+  confit,
+} from '@sesamecare-oss/confit';
 
 import { findPort } from '../development/port-finder';
 
-import { shortstops } from './shortstops';
 import type { ConfigurationSchema } from './schema';
 
 // Order matters here.
@@ -51,27 +56,23 @@ async function addDefaultConfiguration<Config extends ConfigurationSchema = Conf
 }
 
 export interface ServiceConfigurationSpec {
-  // Used for "sourcerequire" and other source-relative paths and for the package name
-  sourceDirectory: string;
   // The LAST configuration is the most "specific" - if a configuration value
   // exists in all directories, the last one wins
   configurationDirectories: string[];
-  name: string;
+  shortstopHandlers: Record<string, ShortstopHandler<string, unknown>>;
 }
 
 export async function loadConfiguration<Config extends ConfigurationSchema>({
-  name,
   configurationDirectories: dirs,
-  sourceDirectory,
+  shortstopHandlers,
 }: ServiceConfigurationSpec): Promise<Config> {
-  const defaultProtocols = shortstops({ name }, sourceDirectory);
   const specificConfig = dirs[dirs.length - 1];
 
   // This confit version just gets us environment info
   const envConfit = await confit({ basedir: specificConfig }).create();
   const configFactory = confit<Config>({
     basedir: specificConfig,
-    protocols: defaultProtocols,
+    protocols: shortstopHandlers,
   });
 
   /**

src/express-app/app.ts

@@ -28,6 +28,7 @@ import type {
   ServiceStartOptions,
 } from '../types';
 import { ConfigurationSchema } from '../config/schema';
+import { shortstops } from '../config/shortstops';
 import { getNodeEnv, isDev } from '../env';
 import { getGlobalPrometheusExporter } from '../telemetry/index';
 
@@ -76,15 +77,16 @@ export async function startApp<
   const serviceImpl = service();
   assert(serviceImpl?.start, 'Service function did not return a conforming object');
 
+  const sourceDirectory = path.join(rootDirectory, codepath);
   const baseOptions: ServiceOptions = {
     configurationDirectories: [path.resolve(rootDirectory, './config')],
+    shortstopHandlers: shortstops({ name }, sourceDirectory),
   };
   const options = serviceImpl.configure?.(startOptions, baseOptions) || baseOptions;
 
   const config = await loadConfiguration({
-    name,
     configurationDirectories: options.configurationDirectories,
-    sourceDirectory: path.join(rootDirectory, codepath),
+    shortstopHandlers: options.shortstopHandlers,
   });
 
   const logging = config.logging;

src/types.ts

@@ -6,6 +6,7 @@ import type { Request, Response } from 'express';
 import type { Application } from 'express-serve-static-core';
 import type { middleware } from 'express-openapi-validator';
 import type { Meter } from '@opentelemetry/api';
+import { ShortstopHandler } from '@sesamecare-oss/confit';
 
 import { ConfigurationSchema } from './config/schema';
 
@@ -143,6 +144,8 @@ export interface ServiceOptions {
 
   // Add or control OpenAPI options such as security handlers
   openApiOptions?: Parameters<typeof middleware>[0];
+
+  shortstopHandlers: Record<string, ShortstopHandler<string, unknown>>;
 }
 
 export interface ServiceLike<