@openapi-typescript-infra/service 2.9.2 → 3.0.0

package/build/types.d.ts

@@ -8,17 +8,18 @@ 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 type { ConfigStore } from './config/types';
+import { Confit } from '@sesamecare-oss/confit';
+import { ConfigurationSchema } from './config/schema';
 export interface InternalLocals extends Record<string, unknown> {
     server?: Server;
     mainApp: ServiceExpress;
 }
 export type ServiceLogger = pino.BaseLogger & Pick<pino.Logger, 'isLevelEnabled'>;
-export interface ServiceLocals {
+export interface ServiceLocals<Config extends ConfigurationSchema = ConfigurationSchema> {
     service: Service;
     name: string;
     logger: ServiceLogger;
-    config: ConfigStore;
+    config: Confit<Config>;
     meter: Meter;
     internalApp: Application<InternalLocals>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "2.9.2",
+  "version": "3.0.0",
   "description": "An opinionated framework for building configuration driven services - web, api, or  ob. Uses OpenAPI, pino logging, express, confit, Typescript and vitest.",
   "main": "build/index.js",
   "scripts": {
@@ -59,29 +59,29 @@
   },
   "homepage": "https://github.com/openapi-typescript-infra/service#readme",
   "dependencies": {
-    "@gasbuddy/confit": "^3.0.0",
     "@godaddy/terminus": "^4.12.1",
     "@opentelemetry/api": "^1.6.0",
     "@opentelemetry/exporter-prometheus": "^0.43.0",
     "@opentelemetry/exporter-trace-otlp-proto": "^0.43.0",
     "@opentelemetry/instrumentation": "^0.43.0",
-    "@opentelemetry/instrumentation-dns": "^0.32.2",
-    "@opentelemetry/instrumentation-express": "^0.33.1",
-    "@opentelemetry/instrumentation-fetch": "^0.43.0",
-    "@opentelemetry/instrumentation-generic-pool": "^0.32.2",
-    "@opentelemetry/instrumentation-graphql": "^0.35.1",
+    "@opentelemetry/instrumentation-dns": "^0.32.3",
+    "@opentelemetry/instrumentation-express": "^0.33.2",
+    "@opentelemetry/instrumentation-generic-pool": "^0.32.3",
+    "@opentelemetry/instrumentation-graphql": "^0.35.2",
     "@opentelemetry/instrumentation-http": "^0.43.0",
-    "@opentelemetry/instrumentation-ioredis": "^0.35.1",
-    "@opentelemetry/instrumentation-net": "^0.32.1",
-    "@opentelemetry/instrumentation-pg": "^0.36.1",
-    "@opentelemetry/instrumentation-pino": "^0.34.1",
-    "@opentelemetry/resource-detector-container": "^0.3.1",
-    "@opentelemetry/resource-detector-gcp": "^0.29.1",
-    "@opentelemetry/resources": "^1.17.0",
-    "@opentelemetry/sdk-metrics": "^1.17.0",
+    "@opentelemetry/instrumentation-ioredis": "^0.35.2",
+    "@opentelemetry/instrumentation-net": "^0.32.2",
+    "@opentelemetry/instrumentation-pg": "^0.36.2",
+    "@opentelemetry/instrumentation-pino": "^0.34.2",
+    "@opentelemetry/resource-detector-container": "^0.3.2",
+    "@opentelemetry/resource-detector-gcp": "^0.29.2",
+    "@opentelemetry/resources": "^1.17.1",
+    "@opentelemetry/sdk-metrics": "^1.17.1",
     "@opentelemetry/sdk-node": "^0.43.0",
-    "@opentelemetry/sdk-trace-base": "^1.17.0",
-    "@opentelemetry/semantic-conventions": "^1.17.0",
+    "@opentelemetry/sdk-trace-base": "^1.17.1",
+    "@opentelemetry/semantic-conventions": "^1.17.1",
+    "@sesamecare-oss/confit": "^1.0.6",
+    "@sesamecare-oss/opentelemetry-node-metrics": "^1.0.1",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.3.1",
     "eventsource": "^1.1.2",
@@ -90,16 +90,14 @@
     "glob": "^8.1.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.8",
-    "pino": "^8.15.1",
+    "opentelemetry-instrumentation-fetch-node": "^1.1.0",
+    "pino": "^8.16.0",
     "read-pkg-up": "^7.0.1",
-    "rest-api-support": "^1.16.3",
-    "shortstop-dns": "^1.1.0",
-    "shortstop-handlers": "^1.1.1",
-    "shortstop-yaml": "^1.0.0"
+    "rest-api-support": "^1.16.3"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.7.1",
-    "@commitlint/config-conventional": "^17.7.0",
+    "@commitlint/cli": "^17.8.0",
+    "@commitlint/config-conventional": "^17.8.0",
     "@openapi-typescript-infra/coconfig": "^4.2.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^11.0.0",
@@ -108,25 +106,25 @@
     "@semantic-release/release-notes-generator": "^12.0.0",
     "@types/cookie-parser": "^1.4.4",
     "@types/eventsource": "1.1.12",
-    "@types/express": "^4.17.18",
+    "@types/express": "^4.17.19",
     "@types/glob": "^8.1.0",
     "@types/lodash": "^4.14.199",
     "@types/minimist": "^1.2.3",
-    "@types/node": "^20.7.0",
-    "@types/supertest": "^2.0.13",
-    "@typescript-eslint/eslint-plugin": "^6.7.3",
-    "@typescript-eslint/parser": "^6.7.3",
-    "coconfig": "^0.13.3",
-    "eslint": "^8.50.0",
+    "@types/node": "^20.8.6",
+    "@types/supertest": "^2.0.14",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@typescript-eslint/parser": "^6.8.0",
+    "coconfig": "^1.0.0",
+    "eslint": "^8.51.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.28.1",
-    "pino-pretty": "^10.2.0",
+    "pino-pretty": "^10.2.3",
     "pinst": "^3.0.0",
     "supertest": "^6.3.3",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
     "typescript": "^5.2.2",
-    "vitest": "^0.34.5"
+    "vitest": "^0.34.6"
   },
   "resolutions": {
     "qs": "^6.11.0"

package/src/config/index.ts

@@ -1,16 +1,15 @@
 import fs from 'fs';
 import path from 'path';
 
-import confit from '@gasbuddy/confit';
+import { BaseConfitType, Confit, Factory, confit } from '@sesamecare-oss/confit';
 
 import { findPort } from '../development/port-finder';
 
 import { shortstops } from './shortstops';
-import type { ConfigStore } from './types';
 import type { ConfigurationSchema } from './schema';
 
 // Order matters here.
-const ENVIRONMENTS = ['production', 'staging', 'test', 'development'];
+const ENVIRONMENTS = ['production', 'staging', 'test', 'development'] as const;
 
 async function pathExists(f: string) {
   return new Promise((accept, reject) => {
@@ -26,12 +25,12 @@ async function pathExists(f: string) {
   });
 }
 
-async function addDefaultConfiguration(
-  configFactory: ReturnType<typeof confit>,
+async function addDefaultConfiguration<Config extends ConfigurationSchema = ConfigurationSchema>(
+  configFactory: Factory<Config>,
   directory: string,
-  envConfit: ConfigStore,
+  envConfit: Confit<BaseConfitType>,
 ) {
-  const addIfEnv = async (e: string) => {
+  const addIfEnv = async (e: (typeof ENVIRONMENTS)[number]) => {
     const c = path.join(directory, `${e}.json`);
     if (envConfit.get(`env:${e}`) && (await pathExists(c))) {
       configFactory.addDefault(c);
@@ -60,19 +59,17 @@ export interface ServiceConfigurationSpec {
   name: string;
 }
 
-export async function loadConfiguration({
+export async function loadConfiguration<Config extends ConfigurationSchema>({
   name,
   configurationDirectories: dirs,
   sourceDirectory,
-}: ServiceConfigurationSpec): Promise<ConfigStore> {
+}: ServiceConfigurationSpec): Promise<Confit<Config>> {
   const defaultProtocols = shortstops({ name }, sourceDirectory);
   const specificConfig = dirs[dirs.length - 1];
 
   // This confit version just gets us environment info
-  const envConfit: ConfigStore = await new Promise((accept, reject) => {
-    confit(specificConfig).create((err, config) => (err ? reject(err) : accept(config)));
-  });
-  const configFactory = confit({
+  const envConfit = await confit({ basedir: specificConfig }).create();
+  const configFactory = confit<ConfigurationSchema>({
     basedir: specificConfig,
     protocols: defaultProtocols,
   });
@@ -89,13 +86,11 @@ export async function loadConfiguration({
     Promise.resolve(),
   );
 
-  const loaded: ConfigStore = await new Promise((accept, reject) => {
-    configFactory.create((err, config) => (err ? reject(err) : accept(config)));
-  });
+  const loaded = await configFactory.create();
 
   // Because other things need to know the port we choose, we pick it here if it's
   // configured to auto-select
-  const serverConfig = loaded.get('server') as Required<ConfigurationSchema['server']>;
+  const serverConfig = loaded.get('server');
   if (serverConfig.port === 0) {
     const port = (await findPort(8001)) as number;
     loaded.set('server:port', port);
@@ -104,7 +99,8 @@ export async function loadConfiguration({
   // TODO init other stuff based on config here, such as key management or
   // other cloud-aware shortstop handlers
 
-  return loaded;
+  // Not sure why this is necessary, but it is
+  return loaded as unknown as Confit<Config>;
 }
 
 export function insertConfigurationBefore(
@@ -123,4 +119,3 @@ export function insertConfigurationBefore(
 }
 
 export * from './schema';
-export * from './types';

package/src/config/schema.ts

@@ -12,7 +12,7 @@ export interface ConfigurationItemEnabled {
   enabled?: boolean;
 }
 
-export interface ConfigurationSchema extends Record<string, unknown> {
+export interface ConfigurationSchema {
   trustProxy?: string[];
   logging?: {
     level?: Level;

package/src/config/shortstops.ts

@@ -1,10 +1,15 @@
 import os from 'os';
 import path from 'path';
 
-import shortstop from 'shortstop-handlers';
-import shortstopYaml from 'shortstop-yaml';
-import shortstopDns from 'shortstop-dns';
-import { ProtocolFn } from '@gasbuddy/confit';
+import {
+  base64Handler,
+  envHandler,
+  fileHandler,
+  pathHandler,
+  requireHandler,
+  yamlHandler,
+  type ShortstopHandler,
+} from '@sesamecare-oss/confit';
 
 /**
  * Default shortstop handlers for GasBuddy service configuration
@@ -15,7 +20,7 @@ import { ProtocolFn } from '@gasbuddy/confit';
  * with a url-like hash pattern
  */
 function betterRequire(basepath: string) {
-  const baseRequire = shortstop.require(basepath);
+  const baseRequire = requireHandler(basepath);
   return function hashRequire(v: string) {
     const [moduleName, func] = v.split('#');
     const module = baseRequire(moduleName);
@@ -33,7 +38,7 @@ function betterRequire(basepath: string) {
  * Just like path, but resolve ~/ to the home directory
  */
 function betterPath(basepath: string) {
-  const basePath = shortstop.path(basepath);
+  const basePath = pathHandler(basepath);
   return function pathWithHomeDir(v: string) {
     if (v.startsWith('~/')) {
       return basePath(path.join(os.homedir(), v.slice(2)));
@@ -46,18 +51,12 @@ function betterPath(basepath: string) {
  * Just like file, but resolve ~/ to the home directory
  */
 function betterFile(basepath: string) {
-  const baseFile = shortstop.file(basepath);
-  return function fileWithHomeDir(
-    v: string,
-    callback: ((error: Error | null, result?: Buffer | string | undefined) => void) | undefined,
-  ) {
-    if (!callback) {
-      return undefined;
-    }
+  const baseFile = fileHandler(basepath);
+  return function fileWithHomeDir(v: string) {
     if (v.startsWith('~/')) {
-      return baseFile(path.join(os.homedir(), v.slice(2)), callback);
+      return baseFile(path.join(os.homedir(), v.slice(2)));
     }
-    return baseFile(v, callback);
+    return baseFile(v);
   };
 }
 
@@ -109,7 +108,7 @@ export function shortstops(service: { name: string }, sourcedir: string) {
    */
   const basedir = path.join(sourcedir, '..');
 
-  const env = shortstop.env();
+  const env = envHandler();
 
   return {
     env,
@@ -121,7 +120,7 @@ export function shortstops(service: { name: string }, sourcedir: string) {
       }
       return !!env(v);
     },
-    base64: shortstop.base64(),
+    base64: base64Handler(),
     regex(v: string) {
       const [, pattern, flags] = v.match(/^\/(.*)\/([a-z]*)/) || [];
       return new RegExp(pattern, flags);
@@ -129,14 +128,14 @@ export function shortstops(service: { name: string }, sourcedir: string) {
 
     // handle source and base directory intelligently
     path: betterPath(basedir),
-    sourcepath: shortstop.path(sourcedir),
+    sourcepath: pathHandler(sourcedir),
     file: betterFile(basedir),
-    sourcefile: shortstop.file(sourcedir) as ProtocolFn<Buffer | string | undefined>,
+    sourcefile: fileHandler(sourcedir),
     require: betterRequire(basedir),
     sourcerequire: betterRequire(sourcedir),
 
     // Sometimes yaml is more pleasant for configuration
-    yaml: shortstopYaml(basedir) as ProtocolFn<ReturnType<typeof JSON.parse>>,
+    yaml: yamlHandler(basedir),
 
     // Switch on service type
     servicetype: serviceTypeFactory(service.name),
@@ -145,10 +144,9 @@ export function shortstops(service: { name: string }, sourcedir: string) {
     os(p: keyof typeof osMethods) {
       return osMethods[p]();
     },
-    dns: shortstopDns() as ProtocolFn<string>,
     // 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>>;
 }

package/src/express-app/app.ts

@@ -7,6 +7,7 @@ import express from 'express';
 import { pino } from 'pino';
 import cookieParser from 'cookie-parser';
 import { metrics } from '@opentelemetry/api';
+import { setupNodeMetrics } from '@sesamecare-oss/opentelemetry-node-metrics';
 import { createTerminus } from '@godaddy/terminus';
 import type { RequestHandler, Response } from 'express';
 
@@ -109,6 +110,8 @@ export async function startApp<
   }
 
   app.locals.meter = metrics.getMeterProvider().getMeter(name);
+  setupNodeMetrics(app.locals.meter, {});
+
   if (config.get('trustProxy')) {
     app.set('trust proxy', config.get('trustProxy'));
   }

package/src/telemetry/DummyExporter.ts

@@ -10,7 +10,7 @@ const noop: SpanExporter['export'] = (spans, resultCallback) => {
 };
 
 export class DummySpanExporter implements SpanExporter {
-  export = noop;
+  export: typeof noop = noop;
 
   async shutdown() {
     // Nothing to do

package/src/telemetry/instrumentations.ts

@@ -1,6 +1,7 @@
 import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { DnsInstrumentation } from '@opentelemetry/instrumentation-dns';
 import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
+import { FetchInstrumentation } from 'opentelemetry-instrumentation-fetch-node';
 import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
 import { IORedisInstrumentation } from '@opentelemetry/instrumentation-ioredis';
@@ -18,13 +19,11 @@ import {
   processDetectorSync,
 } from '@opentelemetry/resources';
 
-import { FetchInstrumentation } from './fetchInstrumentation';
-
 const InstrumentationMap = {
   '@opentelemetry/instrumentation-http': HttpInstrumentation,
-  'opentelemetry-instrumentation-node-18-fetch': FetchInstrumentation,
   '@opentelemetry/instrumentation-dns': DnsInstrumentation,
   '@opentelemetry/instrumentation-express': ExpressInstrumentation,
+  'opentelemetry-instrumentation-fetch-node': FetchInstrumentation,
   '@opentelemetry/instrumentation-generic-pool': GenericPoolInstrumentation,
   '@opentelemetry/instrumentation-ioredis': IORedisInstrumentation,
   '@opentelemetry/instrumentation-net': NetInstrumentation,

package/src/types.ts

@@ -6,8 +6,9 @@ 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 { Confit } from '@sesamecare-oss/confit';
 
-import type { ConfigStore } from './config/types';
+import { ConfigurationSchema } from './config/schema';
 
 export interface InternalLocals extends Record<string, unknown> {
   server?: Server;
@@ -19,11 +20,11 @@ export type ServiceLogger = pino.BaseLogger & Pick<pino.Logger, 'isLevelEnabled'
 // Vanilla express wants this to extend Record<string, any> but this is a mistake
 // because you lose type checking on it, even though I get that underneath it truly
 // is Record<string, any>
-export interface ServiceLocals {
+export interface ServiceLocals<Config extends ConfigurationSchema = ConfigurationSchema> {
   service: Service;
   name: string;
   logger: ServiceLogger;
-  config: ConfigStore;
+  config: Confit<Config>;
   meter: Meter;
   internalApp: Application<InternalLocals>;
 }

package/vitest.config.ts

@@ -3,7 +3,7 @@
  * 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@0.13.3
+ * @version coconfig@1.0.0
  */
 import cjs from '@openapi-typescript-infra/coconfig';
 import * as esmToCjs from '@openapi-typescript-infra/coconfig';

package/@types/config.d.ts

@@ -1,64 +0,0 @@
-/* eslint-disable import/no-default-export */
-declare module 'shortstop-handlers' {
-  export function require(module: string): ReturnType<NodeRequire>;
-  export function env(): (envVarName: string) => string | undefined;
-  export function base64(): (blob: string) => Buffer;
-  export function path(baseDir?: string): (relativePath: string) => string;
-  export function file(
-    baseDir?: string,
-  ): (
-    relativePath: string,
-    cb: (err: Error | null, result?: Buffer | string | undefined) => void,
-  ) => void;
-}
-
-declare module 'shortstop-yaml' {
-  export default function yaml<T>(
-    basepath: string,
-  ): (path: string, callback: (error?: Error, result?: T) => void) => void;
-}
-
-declare module 'shortstop-dns' {
-  export default function dns(opts?: {
-    family?: number;
-    all?: boolean;
-  }): (address: string, callback: (error?: Error, result?: string[]) => void) => void;
-}
-
-declare module '@gasbuddy/confit' {
-  type Json = ReturnType<typeof JSON.parse>;
-
-  export type ProtocolFn<CallbackType> = (
-    value: Json,
-    callback?: (error: Error | null, result?: CallbackType) => void,
-  ) => void;
-
-  interface ProtocolsSetPrivate<C> {
-    [protocol: string]: ProtocolFn<C> | ProtocolFn<C>[];
-  }
-
-  interface ConfigStore {
-    get<T>(name: string): T | undefined;
-    set<T>(name: string, newValue: T): T;
-    use(newSettings: unknown): void;
-  }
-
-  type Options<C> = {
-    basedir: string;
-    protocols: ProtocolsSetPrivate<C>;
-  };
-
-  interface ConfigFactory {
-    create(callback: (err: Error, config: ConfigStore) => unknown): void;
-    addOverride(filepathOrSettingsObj: string | object): this;
-    addDefault(filepathOrSettingsObj: string | object): this;
-  }
-
-  function confit<C>(optionsOrBaseDir: Options<C> | string): ConfigFactory;
-
-  namespace confit {
-    export type ProtocolsSet<C> = ProtocolsSetPrivate<C>;
-  }
-
-  export default confit;
-}

package/build/config/types.d.ts

@@ -1,4 +0,0 @@
-export interface ConfigStore {
-    get<T>(name: string): T | undefined;
-    set<T>(name: string, value: T): void;
-}

package/build/config/types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/build/config/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":""}

package/build/telemetry/fetchInstrumentation.d.ts

@@ -1,49 +0,0 @@
-/// <reference types="node" />
-import { Instrumentation, InstrumentationConfig } from '@opentelemetry/instrumentation';
-import { MeterProvider, Span, TracerProvider } from '@opentelemetry/api';
-interface FetchRequestArguments {
-    request: {
-        path: string;
-        method: string;
-        origin: string;
-        headers: string;
-    };
-    span: Span;
-    additionalHeaders: Record<string, unknown>;
-    error?: Error;
-}
-type ErrorFetchRequestArguments = FetchRequestArguments & {
-    error: Error;
-};
-type ResponseFetchRequestArguments = FetchRequestArguments & {
-    response: {
-        statusCode: number;
-        headers: Buffer[];
-    };
-};
-interface FetchInstrumentationConfig extends InstrumentationConfig {
-    onRequest?: (args: FetchRequestArguments) => void;
-}
-export declare class FetchInstrumentation implements Instrumentation {
-    private channelSubs;
-    private spanFromReq;
-    private tracer;
-    private config;
-    private meter;
-    readonly instrumentationName = "opentelemetry-instrumentation-node-18-fetch";
-    readonly instrumentationVersion = "1.0.0";
-    readonly instrumentationDescription = "Instrumentation for Node 18 fetch via diagnostics_channel";
-    private subscribeToChannel;
-    constructor(config: FetchInstrumentationConfig);
-    disable(): void;
-    enable(): void;
-    setTracerProvider(tracerProvider: TracerProvider): void;
-    setMeterProvider(meterProvider: MeterProvider): void;
-    setConfig(config: InstrumentationConfig): void;
-    getConfig(): InstrumentationConfig;
-    onRequest({ request }: FetchRequestArguments): void;
-    onHeaders({ request, response }: ResponseFetchRequestArguments): void;
-    onDone({ request }: FetchRequestArguments): void;
-    onError({ request, error }: ErrorFetchRequestArguments): void;
-}
-export {};