@openapi-typescript-infra/service 6.1.2 → 6.2.0

package/src/config/index.ts

@@ -2,13 +2,8 @@ import fs from 'fs';
 import path from 'path';
 import { fileURLToPath } from 'url';
 
-import {
-  BaseConfitSchema,
-  Confit,
-  Factory,
-  ShortstopHandler,
-  confit,
-} from '@sesamecare-oss/confit';
+import type { BaseConfitSchema, Confit, Factory, ShortstopHandler } from '@sesamecare-oss/confit';
+import { confit } from '@sesamecare-oss/confit';
 
 import { getAvailablePort } from '../development/port-finder.js';
 

package/src/config/schema.ts

@@ -1,7 +1,7 @@
 import type { BaseConfitSchema } from '@sesamecare-oss/confit';
 import type { middleware } from 'express-openapi-validator';
 import type { Level } from 'pino';
-import bodyParser from 'body-parser';
+import type bodyParser from 'body-parser';
 
 export interface ConfigurationItemEnabled {
   enabled?: boolean;

package/src/config/shortstops.ts

@@ -144,12 +144,12 @@ export function shortstops(service: { name: string }, sourcedir: string) {
     servicetype: serviceTypeFactory(service.name),
     servicename: (v: string) => v.replace(/\$\{name\}/g, service.name),
 
-    os(p: keyof typeof osMethods) {
-      return osMethods[p]();
+    os(p: string) {
+      return osMethods[p as keyof typeof osMethods]();
     },
     // No-op in case you have values that start with a shortstop handler name (and colon)
     literal(v: string) {
       return v;
     },
-  } as Record<string, ShortstopHandler<string, unknown>>;
+  } satisfies Record<string, ShortstopHandler<string, unknown>>;
 }

package/src/config/validation.ts

@@ -1,4 +1,4 @@
-import { ConfigurationSchema } from './schema.js';
+import type { ConfigurationSchema } from './schema.js';
 
 export interface ConfigValidationError {
   path: string;

package/src/development/port-finder.ts

@@ -33,7 +33,6 @@ async function isAvailable(port: number) {
 
 async function findPort(start: number) {
   for (let p = start; p < start + 1000; p += 1) {
-    // eslint-disable-next-line no-await-in-loop
     if (await isAvailable(p)) {
       return p;
     }

package/src/development/repl.ts

@@ -1,12 +1,13 @@
-import repl, { REPLServer } from 'repl';
-import fs from 'fs';
-import path from 'path';
+import type { REPLServer } from 'node:repl';
+import repl from 'node:repl';
+import fs from 'node:fs';
+import path from 'node:path';
 
 import { glob } from 'glob';
 import { set } from 'moderndash';
 
-import { AnyServiceLocals, ServiceExpress, ServiceLocals } from '../types.js';
-import { ConfigurationSchema } from '../config/schema.js';
+import type { AnyServiceLocals, ServiceExpress, ServiceLocals } from '../types.js';
+import type { ConfigurationSchema } from '../config/schema.js';
 
 const REPL_PROP = '$$repl$$';
 
@@ -37,7 +38,6 @@ export function serviceRepl<SLocals extends AnyServiceLocals = ServiceLocals<Con
     app,
     req: new FakeReq('/'),
     dump(o: unknown) {
-      // eslint-disable-next-line no-console
       console.log(JSON.stringify(o, null, '\t'));
     },
     // Use iTerm2's escape code to copy to clipboard
@@ -54,7 +54,10 @@ export function serviceRepl<SLocals extends AnyServiceLocals = ServiceLocals<Con
   });
   app.locals.service.attachRepl?.(app, rl);
 
-  loadReplFunctions(app, codepath, rl);
+  loadReplFunctions(app, codepath, rl).catch((error) => {
+    // eslint-disable-next-line no-console
+    console.error('Failed to load REPL functions', error);
+  });
 
   rl.on('exit', onExit);
 }
@@ -78,9 +81,9 @@ async function loadReplFunctions<
         const module = await import(path.resolve(file));
 
         // Look for functions with the REPL_PROP marker
-        Object.values(module).forEach((exported) => {
+        for (const exported of Object.values(module as Record<string, unknown>)) {
           if (!exported) {
-            return;
+            continue;
           }
           if (typeof exported === 'function') {
             const replName = (exported as WithReplProp)[REPL_PROP];
@@ -88,9 +91,10 @@ async function loadReplFunctions<
               set(rl.context, replName, exported.bind(null, app));
             }
           }
-        });
+        }
       }
     } catch (err) {
+      // eslint-disable-next-line no-console
       console.error(`Failed to load REPL functions from ${file}:`, err);
     }
   }

package/src/env.ts

@@ -6,6 +6,7 @@ export function getNodeEnv(): ValidEnv {
     case 'staging':
     case 'test':
       return (process.env.APP_ENV || process.env.NODE_ENV) as ValidEnv;
+    case undefined:
     default:
       return 'development';
   }

package/src/error.ts

@@ -1,4 +1,4 @@
-import { ConfigurationSchema } from './config/schema.js';
+import type { ConfigurationSchema } from './config/schema.js';
 import type { AnyServiceLocals, ServiceLike, ServiceLocals } from './types.js';
 
 export interface ServiceErrorSpec {

package/src/express-app/app.ts

@@ -26,7 +26,7 @@ import type {
   ServiceOptions,
   ServiceStartOptions,
 } from '../types.js';
-import { ConfigurationSchema } from '../config/schema.js';
+import type { ConfigurationSchema } from '../config/schema.js';
 import { shortstops } from '../config/shortstops.js';
 import { getNodeEnv, isDev } from '../env.js';
 import { getGlobalPrometheusExporter } from '../telemetry/index.js';
@@ -156,20 +156,19 @@ export async function startApp<
   // so that the req can decide whether to save the raw request body or not.
   const attachServiceLocals: RequestHandler = (req, res, next) => {
     res.locals.logger = logger;
-    let maybePromise: Promise<void> | void | undefined;
     try {
-      maybePromise = serviceImpl.onRequest?.(
+      const result = serviceImpl.onRequest?.(
         req as RequestWithApp<SLocals>,
         res as Response<unknown, RLocals>,
       );
+      if (result !== undefined && result !== null && typeof result.then === 'function') {
+        void result.catch(next).then(next);
+      } else {
+        next();
+      }
     } catch (error) {
       next(error);
     }
-    if (maybePromise) {
-      maybePromise.catch(next).then(next);
-    } else {
-      next();
-    }
   };
   app.use(attachServiceLocals);
 
@@ -322,7 +321,7 @@ function httpServer<
   );
 }
 
-function url(config: ConfigurationSchema['server'], port: number) {
+function url(config: ConfigurationSchema['server'], port?: number) {
   if (config.certificate) {
     return `https://${config.hostname}${port === 443 ? '' : `:${port}`}`;
   }
@@ -333,7 +332,7 @@ export async function listen<SLocals extends AnyServiceLocals = ServiceLocals<Co
   app: ServiceExpress<SLocals>,
   shutdownHandler?: () => Promise<void>,
 ) {
-  const config = app.locals.config.server || {};
+  const config: ConfigurationSchema['server'] = app.locals.config.server || {};
   const { port } = config;
 
   const { service, logger } = app.locals;
@@ -384,7 +383,7 @@ export async function listen<SLocals extends AnyServiceLocals = ServiceLocals<Co
           app.locals.internalApp.locals.server?.close();
         }
       }
-      shutdownApp(app);
+      void shutdownApp(app);
     }
   });
 
@@ -401,7 +400,7 @@ export async function listen<SLocals extends AnyServiceLocals = ServiceLocals<Co
       const serverConfig = app.locals.config.server;
       // Ok now start the internal port if we have one.
       if (serverConfig?.internalPort || serverConfig?.internalPort === 0) {
-        startInternalApp(app, serverConfig.internalPort)
+        startInternalApp(app, serverConfig.internalPort as number)
           .then((internalApp) => {
             locals.internalApp = internalApp;
             const prometheusExporter = getGlobalPrometheusExporter();

package/src/express-app/internal-server.ts

@@ -1,9 +1,9 @@
 import express from 'express';
 import type { Application } from 'express-serve-static-core';
 
-import { AnyServiceLocals, InternalLocals, ServiceExpress, ServiceLocals } from '../types.js';
+import type { AnyServiceLocals, InternalLocals, ServiceExpress, ServiceLocals } from '../types.js';
 import { getAvailablePort } from '../development/port-finder.js';
-import { ConfigurationSchema } from '../config/schema.js';
+import type { ConfigurationSchema } from '../config/schema.js';
 
 export async function startInternalApp<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,

package/src/express-app/route-loader.ts

@@ -3,7 +3,7 @@ import path from 'path';
 import { Router } from 'express';
 
 import type { AnyServiceLocals, ServiceExpress, ServiceLocals } from '../types.js';
-import { ConfigurationSchema } from '../config/schema.js';
+import type { ConfigurationSchema } from '../config/schema.js';
 
 import { getFilesInDir } from './modules.js';
 

package/src/express-app/types.ts

@@ -1,7 +1,7 @@
 import type { NextFunction, Response } from 'express';
 
 import type { AnyServiceLocals, RequestLocals, RequestWithApp, ServiceLocals } from '../types.js';
-import { ConfigurationSchema } from '../config/schema.js';
+import type { ConfigurationSchema } from '../config/schema.js';
 
 export type ServiceHandler<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,

package/src/hook.ts

@@ -1,4 +1,4 @@
-import { ConfigurationSchema } from './config/schema.js';
+import type { ConfigurationSchema } from './config/schema.js';
 import type { AnyServiceLocals, RequestLocals, Service, ServiceLocals } from './types.js';
 
 /**

package/src/openapi.ts

@@ -8,7 +8,7 @@ import type { Handler, Request, RequestHandler } from 'express';
 import type { AnyServiceLocals, ServiceExpress, ServiceLocals } from './types.js';
 import { getNodeEnv } from './env.js';
 import { getFilesInDir } from './express-app/modules.js';
-import { ConfigurationSchema } from './config/schema.js';
+import type { ConfigurationSchema } from './config/schema.js';
 
 const notImplementedHandler: Handler = (req, res) => {
   res.status(501).json({
@@ -55,7 +55,7 @@ export async function openApi<
       });
     }),
   );
-  const modulesByPath = moduleFiles.reduce(
+  const modulesByPath = moduleFiles.reduce<Record<string, Record<string, unknown>>>(
     (acc, file, index) => {
       const m = preloadedModules[index];
       if (m) {
@@ -63,7 +63,7 @@ export async function openApi<
       }
       return acc;
     },
-    {} as Record<string, Record<string, unknown>>,
+    {},
   );
 
   // This is nuts, but there are testing frameworks or some other things
@@ -134,6 +134,7 @@ export async function openApi<
               onError(error: Error, body: unknown, req: Request) {
                 console.log('Response body fails validation: ', error);
                 console.log('Emitted from:', req.originalUrl);
+                // eslint-disable-next-line no-console
                 console.debug(body);
                 throw error;
               },

package/src/telemetry/DummyExporter.ts

@@ -1,4 +1,5 @@
-import { ExportResult, ExportResultCode } from '@opentelemetry/core';
+import type { ExportResult } from '@opentelemetry/core';
+import { ExportResultCode } from '@opentelemetry/core';
 import type { ReadableSpan, SpanExporter } from '@opentelemetry/sdk-trace-base';
 
 export class DummySpanExporter implements SpanExporter {

package/src/telemetry/index.ts

@@ -83,7 +83,7 @@ export async function startGlobalTelemetry(
   if (!prometheusExporter) {
     const { metrics, logs, NodeSDK } = opentelemetry;
 
-    const resource = await detectResources({
+    const resource = detectResources({
       detectors: [
         envDetector,
         hostDetector,
@@ -144,7 +144,6 @@ export async function startWithTelemetry<
 >(options: DelayLoadServiceStartOptions) {
   await startGlobalTelemetry(options.name, options.customizer);
 
-  // eslint-disable-next-line import/no-unresolved, @typescript-eslint/no-var-requires
   const { startApp, listen } = (await import('../express-app/app.js')) as {
     startApp: StartAppFn<SLocals, RLocals>;
     listen: ListenFn<SLocals>;
@@ -154,7 +153,7 @@ export async function startWithTelemetry<
   const startOptions: ServiceStartOptions<SLocals> = {
     ...options,
     service,
-    locals: { ...options.locals } as Partial<SLocals>,
+    locals: { ...options.locals } as unknown as Partial<SLocals>,
   };
   const app = await startApp(startOptions);
   app.locals.logger.info('OpenTelemetry enabled');

package/src/telemetry/instrumentations.ts

@@ -1,12 +1,11 @@
 import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { DnsInstrumentation } from '@opentelemetry/instrumentation-dns';
-import { ExpressInstrumentation, SpanNameHook } from '@opentelemetry/instrumentation-express';
+import type { SpanNameHook } from '@opentelemetry/instrumentation-express';
+import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
 import { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici';
 import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
-import {
-  HttpInstrumentation,
-  IgnoreIncomingRequestFunction,
-} from '@opentelemetry/instrumentation-http';
+import type { IgnoreIncomingRequestFunction } from '@opentelemetry/instrumentation-http';
+import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
 import { RedisInstrumentation } from '@opentelemetry/instrumentation-redis';
 import { NetInstrumentation } from '@opentelemetry/instrumentation-net';
 import { GraphQLInstrumentation } from '@opentelemetry/instrumentation-graphql';
@@ -85,7 +84,7 @@ const defaultConfigs: InstrumentationConfigMap = {
 export function getAutoInstrumentations(
   inputConfigs: InstrumentationConfigMap = defaultConfigs,
 ): Instrumentation[] {
-  const keys = Object.keys(InstrumentationMap) as Array<keyof typeof InstrumentationMap>;
+  const keys = Object.keys(InstrumentationMap) as (keyof typeof InstrumentationMap)[];
   return keys
     .map((name) => {
       const Instance = InstrumentationMap[name];

package/src/telemetry/requestLogger.ts

@@ -1,12 +1,12 @@
 import type { RequestHandler, Request, Response, ErrorRequestHandler } from 'express';
 import { getClientIp } from 'request-ip';
-import { Histogram } from '@opentelemetry/api';
+import type { Histogram } from '@opentelemetry/api';
 import cleanStack from 'clean-stack';
 
 import { ServiceError } from '../error.js';
 import type { AnyServiceLocals, RequestWithApp, ServiceExpress, ServiceLocals } from '../types.js';
 import type { ServiceHandler } from '../express-app/types.js';
-import { ConfigurationSchema } from '../config/schema.js';
+import type { ConfigurationSchema } from '../config/schema.js';
 import { getNodeEnv } from '../env.js';
 
 const LOG_PREFS = Symbol('Logging information');
@@ -15,7 +15,7 @@ const LOGGED_SEMAPHORE = Symbol('Logged semaphore');
 interface LogPrefs {
   start: [number, number];
   logRequests?: boolean;
-  chunks?: Array<Buffer>;
+  chunks?: Buffer[];
   logged: boolean;
 }
 
@@ -80,7 +80,7 @@ function finishLog<SLocals extends AnyServiceLocals = ServiceLocals<Configuratio
   }
   const [url, preInfo] = getBasicInfo(req);
 
-  let responseType: string = 'finished';
+  let responseType = 'finished';
 
   // ts warning is known and incorrect—`aborted` is a subset of `destroyed`
   if (req.aborted) {
@@ -178,13 +178,13 @@ export function loggerMiddleware<
       const oldEnd = res.end;
       res.write = ((...args: Parameters<(typeof res)['write']>) => {
         if (prefs.chunks) {
-          prefs.chunks.push(Buffer.isBuffer(args[0]) ? args[0] : Buffer.from(args[0]));
+          prefs.chunks.push(Buffer.isBuffer(args[0]) ? args[0] : Buffer.from(args[0] as string));
         }
         return (oldWrite as (typeof res)['write']).apply(res, args);
       }) as (typeof res)['write'];
       res.end = ((...args: Parameters<(typeof res)['end']>) => {
         if (args[0] && prefs.chunks) {
-          prefs.chunks.push(Buffer.isBuffer(args[0]) ? args[0] : Buffer.from(args[0]));
+          prefs.chunks.push(Buffer.isBuffer(args[0]) ? args[0] : Buffer.from(args[0] as string));
         }
         return oldEnd.apply(res, args);
       }) as (typeof res)['end'];
@@ -230,7 +230,7 @@ export function errorHandlerMiddleware<
     // Set the status to error, even if we aren't going to render the error.
     res.status(loggable.status || 500);
     if (returnError) {
-      finishLog(app, error, req, res, histogram);
+      finishLog(app, error as Error, req, res, histogram);
       const prefs = (res.locals as WithLogPrefs)[LOG_PREFS];
       prefs.logged = true;
       res.json({

package/src/types.ts

@@ -1,5 +1,5 @@
-import type { Server } from 'http';
-import type { REPLServer } from 'repl';
+import type { Server } from 'node:http';
+import type { REPLServer } from 'node:repl';
 
 import type { BaseLogger, Logger } from 'pino';
 import type { Request, Response } from 'express';
@@ -7,9 +7,9 @@ import type { Application } from 'express-serve-static-core';
 import type { middleware } from 'express-openapi-validator';
 import type { Meter } from '@opentelemetry/api';
 import type { NodeSDKConfiguration } from '@opentelemetry/sdk-node';
-import { ShortstopHandler } from '@sesamecare-oss/confit';
+import type { ShortstopHandler } from '@sesamecare-oss/confit';
 
-import { ConfigurationSchema } from './config/schema.js';
+import type { ConfigurationSchema } from './config/schema.js';
 
 export interface InternalLocals<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,
@@ -82,7 +82,7 @@ export interface Service<
   // Called after the server is listening
   onListening?: (
     app: ServiceExpress<SLocals>,
-    info: { port: number; protocol: 'http' | 'https' },
+    info: { port?: number; protocol: 'http' | 'https' },
   ) => void | Promise<void>;
 
   start(app: ServiceExpress<SLocals>): void | Promise<void>;
@@ -110,7 +110,7 @@ export interface Service<
   getLogFields?(
     req: RequestWithApp<SLocals>,
     values: Record<string, string | string[] | number | undefined>,
-  ): string | undefined | void;
+  ): string | undefined;
 
   // The repl is a useful tool for diagnosing issues in non-dev environments.
   // The attachRepl method provides a way to add custom functionality

package/.commitlintrc.json

@@ -1,5 +0,0 @@
-{
-  "extends": [
-    "@commitlint/config-conventional"
-  ]
-}

package/.eslintignore

@@ -1,11 +0,0 @@
-build/
-coverage
-jest.config.js
-vitest.config.?s
-.eslintrc.js
-coconfig.?s
-src/generated
-node_modules
-migrations/
-.yarn/
-**/*.k6.js

package/.eslintrc.cjs

@@ -1,14 +0,0 @@
-/**
- * This file is generated by coconfig. Do not edit it directly.
- * Instead, edit the coconfig.js or coconfig.ts file in your project root.
- *
- * See https://github.com/gas-buddy/coconfig for more information.
- * @version coconfig@1.6.2
- */
-const configModule = require('@openapi-typescript-infra/coconfig');
-
-const configItem = configModule.default || configModule.config || configModule;
-const { configuration } = configItem && configItem['.eslintrc.cjs'];
-const resolved = typeof configuration === 'function' ? configuration() : configuration;
-
-module.exports = resolved;

package/.prettierrc.cjs

@@ -1,14 +0,0 @@
-/**
- * This file is generated by coconfig. Do not edit it directly.
- * Instead, edit the coconfig.js or coconfig.ts file in your project root.
- *
- * See https://github.com/gas-buddy/coconfig for more information.
- * @version coconfig@1.6.2
- */
-const configModule = require('@openapi-typescript-infra/coconfig');
-
-const configItem = configModule.default || configModule.config || configModule;
-const { configuration } = configItem && configItem['.prettierrc.cjs'];
-const resolved = typeof configuration === 'function' ? configuration() : configuration;
-
-module.exports = resolved;