@openapi-typescript-infra/service 1.2.1 → 2.0.0

package/package.json

@@ -1,18 +1,16 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "1.2.1",
-  "description": "An opinionated framework for building configuration driven services - web, api, or job. Uses OpenAPI, pino logging, express, confit, Typescript and Jest.",
+  "version": "2.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": {
-    "test": "jest",
+    "test": "vitest",
     "lint": "eslint .",
     "build": "tsc -p tsconfig.build.json && yarn dlx glob-chmod 755 build/bin/*",
     "watch": "tsc -p tsconfig.json -w --preserveWatchOutput",
     "clean": "npx rimraf ./build",
     "prepublishOnly": "yarn build",
-    "prepack": "pinst --disable",
-    "postpack": "pinst --enable",
-    "_postinstall": "husky install && coconfig"
+    "_postinstall": "coconfig"
   },
   "repository": {
     "type": "git",
@@ -27,9 +25,6 @@
   "engines": {
     "node": ">=18"
   },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx}": "yarn eslint --cache --fix"
-  },
   "keywords": [
     "service",
     "openapi",
@@ -37,7 +32,7 @@
     "confit",
     "babel",
     "typescript",
-    "jest"
+    "vitest"
   ],
   "author": "developers@pyralis.com>",
   "license": "MIT",
@@ -47,6 +42,19 @@
   "release": {
     "branches": [
       "main"
+    ],
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      [
+        "@semantic-release/exec",
+        {
+          "publishCmd": "yarn dlx pinst --disable"
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/git"
     ]
   },
   "homepage": "https://github.com/openapi-typescript-infra/service#readme",
@@ -55,22 +63,22 @@
     "@godaddy/terminus": "^4.12.1",
     "@opentelemetry/api": "^1.4.1",
     "@opentelemetry/api-metrics": "^0.33.0",
-    "@opentelemetry/exporter-prometheus": "^0.41.0",
-    "@opentelemetry/exporter-trace-otlp-proto": "^0.41.0",
-    "@opentelemetry/instrumentation": "^0.41.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.35.0",
-    "@opentelemetry/instrumentation-dns": "^0.32.0",
-    "@opentelemetry/instrumentation-express": "^0.33.0",
-    "@opentelemetry/instrumentation-generic-pool": "^0.32.0",
-    "@opentelemetry/instrumentation-graphql": "^0.35.0",
-    "@opentelemetry/instrumentation-http": "^0.41.0",
-    "@opentelemetry/instrumentation-ioredis": "^0.35.0",
-    "@opentelemetry/instrumentation-net": "^0.32.0",
-    "@opentelemetry/instrumentation-pg": "^0.36.0",
-    "@opentelemetry/instrumentation-pino": "^0.34.0",
-    "@opentelemetry/sdk-metrics": "^1.15.0",
-    "@opentelemetry/sdk-node": "^0.41.0",
-    "@opentelemetry/semantic-conventions": "^1.15.0",
+    "@opentelemetry/exporter-prometheus": "^0.41.2",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.41.2",
+    "@opentelemetry/instrumentation": "^0.41.2",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.36.0",
+    "@opentelemetry/instrumentation-dns": "^0.32.1",
+    "@opentelemetry/instrumentation-express": "^0.33.1",
+    "@opentelemetry/instrumentation-generic-pool": "^0.32.2",
+    "@opentelemetry/instrumentation-graphql": "^0.35.1",
+    "@opentelemetry/instrumentation-http": "^0.41.2",
+    "@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/sdk-metrics": "^1.15.2",
+    "@opentelemetry/sdk-node": "^0.41.2",
+    "@opentelemetry/semantic-conventions": "^1.15.2",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.3.1",
     "eventsource": "^1.1.2",
@@ -79,7 +87,7 @@
     "glob": "^8.1.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.8",
-    "pino": "^8.14.1",
+    "pino": "^8.15.0",
     "read-pkg-up": "^7.0.1",
     "rest-api-support": "^1.16.3",
     "shortstop-dns": "^1.1.0",
@@ -87,32 +95,32 @@
     "shortstop-yaml": "^1.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.6",
-    "@commitlint/config-conventional": "^17.6.6",
-    "@openapi-typescript-infra/coconfig": "^3.2.0",
+    "@commitlint/cli": "^17.7.1",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@openapi-typescript-infra/coconfig": "^4.0.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^10.0.1",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/release-notes-generator": "^11.0.4",
     "@types/cookie-parser": "^1.4.3",
     "@types/eventsource": "1.1.11",
     "@types/express": "^4.17.17",
     "@types/glob": "^8.1.0",
-    "@types/jest": "^29.5.3",
-    "@types/lodash": "^4.14.195",
+    "@types/lodash": "^4.14.197",
     "@types/minimist": "^1.2.2",
-    "@types/node": "^18.16.19",
+    "@types/node": "^18.17.5",
     "@types/supertest": "^2.0.12",
-    "coconfig": "^0.12.2",
-    "eslint": "^8.45.0",
+    "coconfig": "^0.13.3",
+    "eslint": "^8.47.0",
     "eslint-config-gasbuddy": "^7.2.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-jest": "^27.2.3",
-    "husky": "^8.0.3",
-    "jest": "^29.6.1",
-    "lint-staged": "^13.2.3",
-    "pino-pretty": "^10.0.1",
+    "eslint-config-prettier": "^9.0.0",
+    "pino-pretty": "^10.2.0",
     "pinst": "^3.0.0",
     "supertest": "^6.3.3",
-    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "typescript": "^5.1.6",
+    "vitest": "^0.34.2"
   },
   "packageManager": "yarn@3.2.3"
 }

package/src/express-app/app.ts

@@ -40,7 +40,9 @@ interface InternalMetricsInfo {
   exporter?: PrometheusExporter;
 }
 
-interface AppWithMetrics { [METRICS_KEY]?: InternalMetricsInfo; }
+interface AppWithMetrics {
+  [METRICS_KEY]?: InternalMetricsInfo;
+}
 
 async function enableMetrics<SLocals extends ServiceLocals = ServiceLocals>(
   app: ServiceExpress<SLocals>,
@@ -89,9 +91,7 @@ export async function startApp<
   SLocals extends ServiceLocals = ServiceLocals,
   RLocals extends RequestLocals = RequestLocals,
 >(startOptions: ServiceStartOptions<SLocals, RLocals>): Promise<ServiceExpress<SLocals>> {
-  const {
-    service, rootDirectory, codepath = 'build', name,
-  } = startOptions;
+  const { service, rootDirectory, codepath = 'build', name } = startOptions;
   const shouldPrettyPrint = isDev() && !process.env.NO_PRETTY_LOGS;
   const destination = pino.destination({
     dest: process.env.LOG_TO_FILE || process.stdout.fd,
@@ -99,24 +99,24 @@ export async function startApp<
   });
   const logger = shouldPrettyPrint
     ? pino({
-      transport: {
-        destination,
-        target: 'pino-pretty',
-        options: {
-          colorize: true,
+        transport: {
+          destination,
+          target: 'pino-pretty',
+          options: {
+            colorize: true,
+          },
         },
-      },
-    })
+      })
     : pino(
-      {
-        formatters: {
-          level(label) {
-            return { level: label };
+        {
+          formatters: {
+            level(label) {
+              return { level: label };
+            },
           },
         },
-      },
-      destination,
-    );
+        destination,
+      );
 
   const serviceImpl = service();
   assert(serviceImpl?.start, 'Service function did not return a conforming object');
@@ -260,15 +260,16 @@ export async function startApp<
     });
   }
 
+  const codePattern = codepath === 'src' ? '**/*.ts' : '**/*.js';
   if (routing?.routes) {
     await loadRoutes(
       app,
       path.resolve(rootDirectory, codepath, config.get<string>('routing:routes') || 'routes'),
-      codepath === 'src' ? '**/*.ts' : '**/*.js',
+      codePattern,
     );
   }
   if (routing?.openapi) {
-    app.use(openApi(app, rootDirectory, codepath, options.openApiOptions));
+    app.use(await openApi(app, rootDirectory, codepath, codePattern, options.openApiOptions));
   }
 
   // Putting this here allows more flexible middleware insertion

package/src/express-app/modules.ts

@@ -0,0 +1,27 @@
+import { glob } from 'glob';
+
+export async function loadModule(path: string): Promise<Record<string, unknown>> {
+  try {
+    return require(path);
+  } catch (error) {
+    if ((error as Error).message.includes('Cannot use import statement outside a module')) {
+      return import(path);
+    }
+    throw error;
+  }
+}
+
+export async function getFilesInDir(pattern: string, dir: string) {
+  const files: string[] = await new Promise((accept, reject) => {
+    glob(
+      pattern,
+      {
+        nodir: true,
+        strict: true,
+        cwd: dir,
+      },
+      (error, matches) => (error ? reject(error) : accept(matches)),
+    );
+  });
+  return files;
+}

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

@@ -1,30 +1,19 @@
 import path from 'path';
 
-import { glob } from 'glob';
 import express from 'express';
 
 import type { ServiceExpress } from '../types';
 
+import { getFilesInDir, loadModule } from './modules';
+
 export async function loadRoutes(app: ServiceExpress, routingDir: string, pattern: string) {
-  const files: string[] = await new Promise((accept, reject) => {
-    glob(
-      pattern,
-      {
-        nodir: true,
-        strict: true,
-        cwd: routingDir,
-      },
-      (error, matches) => (error ? reject(error) : accept(matches)),
-    );
-  });
+  const files = await getFilesInDir(pattern, routingDir);
 
   await Promise.all(
     files.map(async (filename) => {
       const routeBase = path.dirname(filename);
       const modulePath = path.resolve(routingDir, filename);
-      // Need to use require for loading .ts files
-      // eslint-disable-next-line import/no-dynamic-require, global-require, @typescript-eslint/no-var-requires
-      const module = require(modulePath);
+      const module = await loadModule(modulePath);
       const mounter = module.default || module.route;
       if (typeof mounter === 'function') {
         const childRouter = express.Router();
@@ -38,7 +27,7 @@ export async function loadRoutes(app: ServiceExpress, routingDir: string, patter
           pathParts.push(fn);
         }
         const finalPath = pathParts.join('/') || '/';
-        app.locals.logger.debug({ path: finalPath, source: filename }, 'Registering route');
+        app.locals.logger.debug({ path: finalPath, source: filename }, 'Registering routes');
         app.use(finalPath, childRouter);
       } else {
         app.locals.logger.warn({ filename }, 'Route file had no default export');

package/src/openapi.ts

@@ -5,6 +5,7 @@ import * as OpenApiValidator from 'express-openapi-validator';
 import type { Handler } from 'express';
 
 import type { ServiceExpress } from './types';
+import { getFilesInDir, loadModule } from './express-app/modules';
 
 const notImplementedHandler: Handler = (req, res) => {
   res.status(501).json({
@@ -16,15 +17,46 @@ const notImplementedHandler: Handler = (req, res) => {
 
 type OAPIOpts = Parameters<typeof OpenApiValidator.middleware>[0];
 
-export function openApi(
+export async function openApi(
   app: ServiceExpress,
   rootDirectory: string,
   codepath: string,
+  pattern: string,
   openApiOptions?: Partial<OAPIOpts>,
 ) {
   const apiSpec = path.resolve(rootDirectory, `./api/${app.locals.name}.yaml`);
   app.locals.logger.debug({ apiSpec, codepath }, 'Serving OpenAPI');
 
+  const basePath = path.resolve(rootDirectory, `${codepath}/handlers`);
+  // Because of the weirdness of ESM/CJS interop, and the synchronous nature of
+  // the OpenAPI resolver, we need to preload all the modules we might need
+  const moduleFiles = await getFilesInDir(
+    pattern,
+    path.resolve(rootDirectory, `${codepath}/handlers`),
+  );
+  const preloadedModules = await Promise.all(
+    moduleFiles.map((file) => {
+      const fullPath = path.join(basePath, file);
+      return loadModule(fullPath).catch((error) => {
+        app.locals.logger.warn(
+          { file: fullPath, message: error.message },
+          'Could not load potential API handler',
+        );
+        return undefined;
+      });
+    }),
+  );
+  const modulesByPath = moduleFiles.reduce(
+    (acc, file, index) => {
+      const m = preloadedModules[index];
+      if (m) {
+        acc[`/${path.basename(file, path.extname(file))}`] = m;
+      }
+      return acc;
+    },
+    {} as Record<string, Record<string, unknown>>,
+  );
+
   const defaultOptions: OAPIOpts = {
     apiSpec,
     ignoreUndocumented: true,
@@ -33,16 +65,20 @@ export function openApi(
       coerceTypes: 'array',
     },
     operationHandlers: {
-      basePath: path.resolve(rootDirectory, `${codepath}/handlers`),
-      resolver(basePath: string, route: Parameters<typeof OpenApiValidator.resolvers.defaultResolver>[1]) {
+      basePath,
+      resolver(
+        basePath: string,
+        route: Parameters<typeof OpenApiValidator.resolvers.defaultResolver>[1],
+      ) {
         const pathKey = route.openApiRoute.substring(route.basePath.length);
         const modulePath = path.join(basePath, pathKey);
 
         try {
-          // eslint-disable-next-line import/no-dynamic-require, global-require, @typescript-eslint/no-var-requires
-          const module = require(modulePath);
-          const method = Object.keys(module).find((m) => m.toUpperCase() === route.method);
-          if (!method) {
+          const module = modulesByPath[pathKey];
+          const method = module
+            ? Object.keys(module).find((m) => m.toUpperCase() === route.method)
+            : undefined;
+          if (!module || !method) {
             throw new Error(
               `Could not find a [${route.method}] function in ${modulePath} when trying to route [${route.method} ${route.expressRoute}].`,
             );

package/src/telemetry/index.ts

@@ -24,7 +24,9 @@ function getExporter() {
       url: process.env.OTLP_EXPORTER || 'http://otlp-exporter:4318/v1/traces',
     });
   }
-  return new opentelemetry.tracing.ConsoleSpanExporter();
+  if (process.env.ENABLE_CONSOLE_OLTP_EXPORTER) {
+    return new opentelemetry.tracing.ConsoleSpanExporter();
+  }
 }
 
 export async function startWithTelemetry<

package/tsconfig.build.json

@@ -5,6 +5,7 @@
     "src/**/*.test.ts",
     "__tests__/**/*.ts",
     "__mocks__/**/*.ts",
-    "coconfig.ts"
+    "coconfig.ts",
+    "vitest.config.ts"
   ]
 }

package/tsconfig.json

@@ -4,7 +4,8 @@
     "src/**/*",
     "__tests__/**/*",
     "__mocks__/**/*",
-    "coconfig.ts"
+    "coconfig.ts",
+    "vitest.config.ts"
   ],
   "exclude": [
     "node_modules",

package/vitest.config.ts

@@ -0,0 +1,19 @@
+/**
+ * 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@0.13.3
+ */
+import cjs from '@openapi-typescript-infra/coconfig';
+import * as esmToCjs from '@openapi-typescript-infra/coconfig';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const configModule: any = cjs || esmToCjs;
+
+const configItem = configModule.default || configModule.config || configModule;
+const { configuration } = configItem && configItem['vitest.config.ts'];
+const resolved = typeof configuration === 'function' ? configuration() : configuration;
+
+// eslint-disable-next-line import/no-default-export
+export default resolved;

package/.husky/commit-msg

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx --no -- commitlint --edit ${1}

package/.husky/pre-commit

@@ -1,6 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-yarn lint-staged
-yarn build
-yarn test

package/__tests__/config.test.ts

@@ -1,32 +0,0 @@
-import path from 'path';
-
-import { insertConfigurationBefore, loadConfiguration } from '../src/config';
-
-describe('configuration loader', () => {
-  test('overrides and shortstops', async () => {
-    const rootDirectory = path.resolve(__dirname, './fake-serv');
-    const config = await loadConfiguration({
-      name: 'fake-serv',
-      rootDirectory,
-      configurationDirectories: [path.resolve(rootDirectory, './config')],
-    });
-    expect(config.get('logging:level')).toEqual('debug');
-    expect(config.get('google')).toBeTruthy();
-    expect(config.get('google')).not.toEqual('google.com');
-
-    expect(config.get('envswitchoff')).toBeFalsy();
-    expect(config.get('envswitchon')).toBeTruthy();
-
-    expect(config.get('servicetype')).toBeTruthy();
-    expect(config.get('oservicetype')).toBeTruthy();
-    expect(config.get('notservicetype')).toBeFalsy();
-
-    const orig = ['a', 'b', 'd'];
-    const withC = insertConfigurationBefore(orig, 'c', 'd');
-    expect(withC).toEqual(['a', 'b', 'c', 'd']);
-    const withE = insertConfigurationBefore(orig, 'e', 'q');
-    expect(withE).toEqual(['a', 'b', 'd', 'e', 'q']);
-    expect(insertConfigurationBefore(undefined, 'a', 'b')).toEqual(['a', 'b']);
-    expect(insertConfigurationBefore([], 'a', 'b')).toEqual(['a', 'b']);
-  });
-});

package/__tests__/fake-serv/api/fake-serv.yaml

@@ -1,48 +0,0 @@
-openapi: 3.0.0
-info:
-  title: Fake Service
-  version: 1.0.0
-paths:
-  /hello:
-    get:
-      description: Get a greeting
-      parameters:
-        - name: greeting
-          in: query
-          required: false
-          schema:
-            type: string
-        - name: number
-          in: query
-          required: false
-          schema:
-            type: number
-        - name: break_things
-          in: query
-          required: false
-          schema:
-            type: boolean
-      responses:
-        200:
-          description: We responded
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  greeting:
-                    type: string
-    post:
-      description: Test body conversion
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                number:
-                  type: number
-        required: true
-      responses:
-        204:
-          description: I heard you

package/__tests__/fake-serv/config/config.json

@@ -1,16 +0,0 @@
-{
-  "logging": {
-    "level": "debug"
-  },
-  "google": "dns:google.com",
-  "envswitchoff": "env_switch:ENV_VAR_DOESNT_EXIST",
-  "envswitchon": "env_switch:!ENV_VAR_DOESNT_EXIST",
-  "servicetype": "servicetype:serv",
-  "oservicetype": "servicetype:internal",
-  "notservicetype": "servicetype:api",
-  "server": {
-    "metrics": {
-      "enabled": true
-    }
-  }
-}

package/__tests__/fake-serv/src/handlers/hello.ts

@@ -1,10 +0,0 @@
-import { ServiceHandler } from '../../../../src/index';
-import { FakeServLocals } from '../index';
-
-export const get: ServiceHandler<FakeServLocals> = async (req, res) => {
-  res.json({ greeting: req.query.greeting || 'Hello World' });
-};
-
-export const post: ServiceHandler<FakeServLocals> = async (req, res) => {
-  res.sendStatus(204);
-};

package/__tests__/fake-serv/src/index.ts

@@ -1,35 +0,0 @@
-import { RestApiErrorResponse, RestApiSuccessResponse } from 'rest-api-support';
-
-import type { Service, ServiceLocals } from '../../../src/types';
-import { useService } from '../../../src';
-
-export interface FakeServLocals extends ServiceLocals {
-  services: {
-    fakeServ: {
-      get_something(): RestApiSuccessResponse<{ things: string[] }> | RestApiErrorResponse;
-    }
-  }
-}
-
-export function service(): Service<FakeServLocals> {
-  const base = useService<FakeServLocals>();
-  return {
-    ...base,
-    async start(app) {
-      await base.start(app);
-      app.locals.services.fakeServ = {
-        get_something() { throw new Error('Should not be called.'); },
-      };
-    },
-    async onRequest(req, res) {
-      await base.onRequest?.(req, res);
-      res.locals.rawBody = true;
-    },
-    async healthy(app) {
-      await base.healthy?.(app);
-      return new Promise((accept) => {
-        setTimeout(accept, 1000);
-      });
-    },
-  };
-}

package/__tests__/fake-serv/src/routes/error.ts

@@ -1,13 +0,0 @@
-import { ServiceRouter } from '../../../../src/index';
-import { ServiceError } from '../../../../src/error';
-
-export function route(router: ServiceRouter) {
-  router.get('/sync', (req) => {
-    throw new ServiceError(req.app, 'Synchronous error', { code: 'SyncError' });
-  });
-
-  router.get('/async', async (req) => {
-    await new Promise((accept) => { setTimeout(accept, 100); })
-      .then(() => { throw new ServiceError(req.app, 'Async error', { code: 'AsyncError' }); });
-  });
-}

package/__tests__/fake-serv/src/routes/index.ts

@@ -1,22 +0,0 @@
-import type { ServiceExpress, ServiceRouter } from '../../../../src';
-import { FakeServLocals } from '../index';
-
-export function route(
-  router: ServiceRouter<FakeServLocals>,
-  app: ServiceExpress<FakeServLocals>,
-) {
-  const worldRequests = app.locals.meter.createCounter('world_requests', {
-    description: 'Metrics about requests to world',
-  });
-
-  router.get('/world', (req, res) => {
-    worldRequests.add(1, { method: 'get' });
-    res.json({ hello: 'world' });
-  });
-
-  router.post('/world', async (req, res) => {
-    await app.locals.services.fakeServ.get_something();
-    worldRequests.add(1);
-    res.sendStatus(204);
-  });
-}

package/__tests__/fake-serv/src/routes/other/world.ts

@@ -1,7 +0,0 @@
-import type { Router } from 'express';
-
-export function route(router: Router) {
-  router.get('/', (req, res) => {
-    res.json({ hello: 'jupiter' });
-  });
-}