@openapi-typescript-infra/service 2.0.2 → 2.2.0

package/config/development.json

@@ -1,11 +1,15 @@
 {
+  "$schema": "tsschema://../src/config/schema#ConfigurationSchema",
   "logging": {
     "level": "debug"
   },
-  "port": 0,
+  "server": {
+    "port": 0,
+    "internalPort": 0
+  },
   "connections": {
     "default": {
       "proxy": "http://localhost:9990"
     }
   }
-}
+}

package/config/test.json

@@ -1,5 +1,6 @@
 {
+  "$schema": "tsschema://../src/config/schema#ConfigurationSchema",
   "logging": {
     "level": "warn"
   }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "2.0.2",
+  "version": "2.2.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": {
@@ -67,7 +67,7 @@
     "@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-dns": "^0.32.2",
     "@opentelemetry/instrumentation-express": "^0.33.1",
     "@opentelemetry/instrumentation-generic-pool": "^0.32.2",
     "@opentelemetry/instrumentation-graphql": "^0.35.1",
@@ -83,7 +83,7 @@
     "dotenv": "^16.3.1",
     "eventsource": "^1.1.2",
     "express": "next",
-    "express-openapi-validator": "^5.0.4",
+    "express-openapi-validator": "^5.0.6",
     "glob": "^8.1.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.8",
@@ -97,31 +97,33 @@
   "devDependencies": {
     "@commitlint/cli": "^17.7.1",
     "@commitlint/config-conventional": "^17.7.0",
-    "@openapi-typescript-infra/coconfig": "^4.0.0",
+    "@openapi-typescript-infra/coconfig": "^4.1.0",
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/commit-analyzer": "^10.0.1",
+    "@semantic-release/commit-analyzer": "^10.0.4",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/release-notes-generator": "^11.0.4",
+    "@semantic-release/release-notes-generator": "^11.0.7",
     "@types/cookie-parser": "^1.4.3",
     "@types/eventsource": "1.1.11",
     "@types/express": "^4.17.17",
     "@types/glob": "^8.1.0",
     "@types/lodash": "^4.14.197",
     "@types/minimist": "^1.2.2",
-    "@types/node": "^18.17.5",
+    "@types/node": "^18.17.12",
     "@types/supertest": "^2.0.12",
+    "@typescript-eslint/eslint-plugin": "^6.5.0",
+    "@typescript-eslint/parser": "^6.5.0",
     "coconfig": "^0.13.3",
-    "eslint": "^8.47.0",
-    "eslint-config-gasbuddy": "^7.2.0",
+    "eslint": "^8.48.0",
     "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
     "pino-pretty": "^10.2.0",
     "pinst": "^3.0.0",
     "supertest": "^6.3.3",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.1.6",
-    "vitest": "^0.34.2"
+    "typescript": "^5.2.2",
+    "vitest": "^0.34.3"
   },
   "packageManager": "yarn@3.2.3"
 }

package/src/config/schema.ts

@@ -19,7 +19,7 @@ export interface ConfigurationSchema extends Record<string, unknown> {
     logHttpRequests?: boolean;
     logRequestBody?: boolean;
     logResponseBody?: boolean;
-  },
+  };
   routing?: {
     openapi?: boolean;
     // Relative to the *root directory* of the app
@@ -34,14 +34,14 @@ export interface ConfigurationSchema extends Record<string, unknown> {
     bodyParsers?: {
       json?: boolean;
       form?: boolean;
-    },
+    };
     // Set static.enabled to true to enable static assets to be served
     static?: ConfigurationItemEnabled & {
       // The path relative to the root directory of the app
       path?: string;
       // The path on which to mount the static assets (defaults to /)
       mountPath?: string;
-    },
+    };
     finalHandlers: {
       // Whether to create and return errors for unhandled routes
       notFound?: boolean;
@@ -55,12 +55,18 @@ export interface ConfigurationSchema extends Record<string, unknown> {
         // information.
         unnest: boolean;
       };
-    },
-  },
-  server?: {
-    internalPort?: number,
-    port?: number,
-    metrics: ConfigurationItemEnabled,
-  },
+    };
+  };
+  server: {
+    internalPort?: number;
+    port?: number;
+    metrics: ConfigurationItemEnabled;
+    // To enable HTTPS on the main service, set the key and cert to the
+    // actual key material (not the path). Use shortstop file: handler.
+    // Note that generally it's better to offload tls termination,
+    // but this is useful for dev.
+    key?: string;
+    certificate?: string;
+  };
   connections: Record<string, ServiceConfiguration>;
 }

package/src/config/shortstops.ts

@@ -29,6 +29,38 @@ function betterRequire(basepath: string) {
   };
 }
 
+/**
+ * Just like path, but resolve ~/ to the home directory
+ */
+function betterPath(basepath: string) {
+  const basePath = shortstop.path(basepath);
+  return function pathWithHomeDir(v: string) {
+    if (v.startsWith('~/')) {
+      return basePath(path.join(os.homedir(), v.slice(2)));
+    }
+    return basePath(v);
+  };
+}
+
+/**
+ * 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;
+    }
+    if (v.startsWith('~/')) {
+      return baseFile(path.join(os.homedir(), v.slice(2)), callback);
+    }
+    return baseFile(v, callback);
+  };
+}
+
 function canonicalizeServiceSuffix(suffix?: string) {
   if (!suffix) {
     return 'internal';
@@ -70,10 +102,7 @@ const osMethods = {
   version: os.version,
 };
 
-export function shortstops(
-  service: { name: string; },
-  sourcedir: string,
-) {
+export function shortstops(service: { name: string }, sourcedir: string) {
   /**
    * Since we use transpiled sources a lot,
    * basedir and sourcedir are meaningfully different reference points.
@@ -99,10 +128,10 @@ export function shortstops(
     },
 
     // handle source and base directory intelligently
-    path: shortstop.path(basedir),
+    path: betterPath(basedir),
     sourcepath: shortstop.path(sourcedir),
-    file: shortstop.file(basedir),
-    sourcefile: shortstop.file(sourcedir),
+    file: betterFile(basedir),
+    sourcefile: shortstop.file(sourcedir) as ProtocolFn<Buffer | string | undefined>,
     require: betterRequire(basedir),
     sourcerequire: betterRequire(sourcedir),
 

package/src/express-app/app.ts

@@ -1,5 +1,6 @@
 import assert from 'assert';
 import http from 'http';
+import https from 'https';
 import path from 'path';
 
 import express from 'express';
@@ -303,18 +304,32 @@ export async function shutdownApp(app: ServiceExpress) {
   (logger as pino.Logger).flush?.();
 }
 
+function tlsServer<SLocals extends ServiceLocals = ServiceLocals>(
+  app: ServiceExpress<SLocals>,
+  config: ConfigurationSchema['server'],
+) {
+  return https.createServer(
+    {
+      key: config.key,
+      cert: config.certificate,
+    },
+    app,
+  );
+}
+
 export async function listen<SLocals extends ServiceLocals = ServiceLocals>(
   app: ServiceExpress<SLocals>,
   shutdownHandler?: () => Promise<void>,
 ) {
-  let port = app.locals.config.get('server:port');
+  const config = app.locals.config.get('server') as Required<ConfigurationSchema['server']>;
+  let { port } = config;
 
   if (port === 0) {
-    port = await findPort(8001);
+    port = (await findPort(8001)) as number;
   }
 
   const { service, logger } = app.locals;
-  const server = http.createServer(app);
+  const server = config.certificate ? tlsServer(app, config) : http.createServer(app);
   let shutdownInProgress = false;
   createTerminus(server, {
     timeout: 15000,
@@ -358,6 +373,10 @@ export async function listen<SLocals extends ServiceLocals = ServiceLocals>(
     }
   });
 
+  server.on('error', (error) => {
+    logger.error(error, 'Main service listener error');
+  });
+
   const metricInfo = (app.locals as AppWithMetrics)[METRICS_KEY] as InternalMetricsInfo;
   delete (app.locals as AppWithMetrics)[METRICS_KEY];
 

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

@@ -2,11 +2,14 @@ import express from 'express';
 import type { Application } from 'express-serve-static-core';
 
 import { InternalLocals, ServiceExpress } from '../types';
+import { findPort } from '../development/port-finder';
 
 export async function startInternalApp(mainApp: ServiceExpress, port: number) {
   const app = express() as unknown as Application<InternalLocals>;
   app.locals.mainApp = mainApp;
 
+  const finalPort = port === 0 ? await findPort(3001) : port;
+
   app.get('/health', async (req, res) => {
     if (mainApp.locals.service?.healthy) {
       try {
@@ -21,9 +24,12 @@ export async function startInternalApp(mainApp: ServiceExpress, port: number) {
   });
 
   const listenPromise = new Promise<void>((accept) => {
-    app.locals.server = app.listen(port, () => {
+    app.locals.server = app.listen(finalPort, () => {
       accept();
     });
+    app.locals.server.on('error', (error) => {
+      mainApp.locals.logger.error(error, 'Internal app server error');
+    });
   });
 
   await listenPromise;

package/tsconfig.json

@@ -20,7 +20,7 @@
       "ES2022",
       "DOM"
     ],
-    "module": "CommonJS",
+    "module": "NodeNext",
     "moduleResolution": "NodeNext",
     "target": "ES2022",
     "declaration": true,