@openapi-typescript-infra/service 4.19.1 → 4.20.1

package/config/test.json

@@ -4,6 +4,7 @@
     "level": "warn"
   },
   "server": {
-    "port": 0
+    "port": 0,
+    "internalPort": 0
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "4.19.1",
+  "version": "4.20.1",
   "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": {
@@ -85,7 +85,7 @@
     "glob": "^8.1.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.8",
-    "pino": "^8.21.0",
+    "pino": "^9.0.0",
     "read-pkg-up": "^7.0.1",
     "request-ip": "^3.3.0"
   },

package/src/config/index.ts

@@ -1,5 +1,4 @@
 import fs from 'fs';
-import net from 'net';
 import path from 'path';
 
 import {
@@ -10,8 +9,7 @@ import {
   confit,
 } from '@sesamecare-oss/confit';
 
-import { findPort } from '../development/port-finder';
-import { isTest } from '../env';
+import { getAvailablePort } from '../development/port-finder';
 
 import type { ConfigurationSchema } from './schema';
 
@@ -57,28 +55,6 @@ async function addDefaultConfiguration<Config extends ConfigurationSchema = Conf
   }
 }
 
-async function getEphemeralPort(): Promise<number> {
-  return new Promise((resolve, reject) => {
-    const server = net.createServer();
-
-    server.listen(0, () => {
-      const address = server.address();
-      if (typeof address === 'string' || !address) {
-        reject(new Error('Invalid address'));
-        return;
-      }
-      const port = address.port; // Retrieve the ephemeral port
-      server.close((err) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve(port);
-        }
-      });
-    });
-  });
-}
-
 export interface ServiceConfigurationSpec {
   // The LAST configuration is the most "specific" - if a configuration value
   // exists in all directories, the last one wins
@@ -117,8 +93,7 @@ export async function loadConfiguration<Config extends ConfigurationSchema>({
   // configured to auto-select
   const serverConfig = loaded.get().server;
   if (serverConfig.port === 0) {
-    const portPromise: Promise<number> = (isTest() || process.env.TEST_RUNNER) ? getEphemeralPort() : findPort(8001);
-    const port = await portPromise;
+    const port = await getAvailablePort(8001);
     const store = loaded.get();
     store.server = store.server || {};
     store.server.port = port;

package/src/development/port-finder.ts

@@ -1,5 +1,7 @@
 import net from 'net';
 
+import { isTest } from '../env';
+
 // Inspired by https://github.com/kessler/find-port/blob/master/lib/findPort.js
 async function isAvailable(port: number) {
   return new Promise((accept, reject) => {
@@ -29,7 +31,7 @@ async function isAvailable(port: number) {
   });
 }
 
-export async function findPort(start: 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)) {
@@ -38,3 +40,29 @@ export async function findPort(start: number) {
   }
   return 0;
 }
+
+async function getEphemeralPort(): Promise<number> {
+  return new Promise((resolve, reject) => {
+    const server = net.createServer();
+
+    server.listen(0, () => {
+      const address = server.address();
+      if (typeof address === 'string' || !address) {
+        reject(new Error('Invalid address'));
+        return;
+      }
+      const port = address.port; // Retrieve the ephemeral port
+      server.close((err) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(port);
+        }
+      });
+    });
+  });
+}
+
+export async function getAvailablePort(basePort: number): Promise<number> {
+  return (isTest() || process.env.TEST_RUNNER) ? getEphemeralPort() : findPort(basePort);
+}

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

@@ -2,7 +2,7 @@ import express from 'express';
 import type { Application } from 'express-serve-static-core';
 
 import { AnyServiceLocals, InternalLocals, ServiceExpress, ServiceLocals } from '../types';
-import { findPort } from '../development/port-finder';
+import { getAvailablePort } from '../development/port-finder';
 import { ConfigurationSchema } from '../config/schema';
 
 export async function startInternalApp<
@@ -11,7 +11,7 @@ export async function startInternalApp<
   const app = express() as unknown as Application<InternalLocals<SLocals>>;
   app.locals.mainApp = mainApp;
 
-  const finalPort = port === 0 ? await findPort(3001) : port;
+  const finalPort = port === 0 ? await getAvailablePort(3001) : port;
 
   app.get('/health', async (req, res) => {
     if (mainApp.locals.service?.healthy) {

package/src/telemetry/requestLogger.ts

@@ -29,6 +29,7 @@ interface WithIdentifiedSession {
 
 interface ErrorWithStatus extends Error {
   status?: number;
+  expected_error?: boolean;
 }
 
 function getBasicInfo(req: Request): [string, Record<string, string | number>] {
@@ -84,11 +85,15 @@ function finishLog<SLocals extends AnyServiceLocals = ServiceLocals<Configuratio
     endLog.u = res.locals.user.id;
   }
 
+  let unexpectedError = false;
   if (error) {
     endLog.e = error.message;
     if (!(error instanceof ServiceError) || error.log_stack) {
       endLog.st = error.stack;
     }
+    if (!(error as ErrorWithStatus).expected_error) {
+      unexpectedError = true;
+    }
   }
 
   if (prefs.logRequests) {
@@ -110,7 +115,11 @@ function finishLog<SLocals extends AnyServiceLocals = ServiceLocals<Configuratio
   }
 
   const msg = service.getLogFields?.(req as RequestWithApp<SLocals>, endLog) || url;
-  logger.info(endLog, msg);
+  if (unexpectedError) {
+    logger.error(endLog, msg);
+  } else {
+    logger.info(endLog, msg);
+  }
 }
 
 export function loggerMiddleware<
@@ -122,7 +131,7 @@ export function loggerMiddleware<
 ): RequestHandler {
   const nonProd = getNodeEnv() !== 'production';
   const { logger, service } = app.locals;
-  return function gblogger(req, res, next) {
+  return function serviceLogger(req, res, next) {
     const logResponse =
       config?.logResponseBody || (nonProd && req.headers['x-log']?.includes('res'));
     const logRequest = config?.logRequestBody || (nonProd && req.headers['x-log']?.includes('req'));
@@ -176,7 +185,7 @@ export function loggerMiddleware<
 export function errorHandlerMiddleware<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,
 >(app: ServiceExpress<SLocals>, histogram: Histogram, unnest?: boolean, returnError?: boolean) {
-  const gbErrorHandler: ErrorRequestHandler = (error, req, res, next) => {
+  const svcErrorHandler: ErrorRequestHandler = (error, req, res, next) => {
     let loggable: Partial<ServiceError> = error;
     const body = error.response?.body || error.body;
     if (unnest && body?.domain && body?.code && body?.message) {
@@ -204,11 +213,11 @@ export function errorHandlerMiddleware<
       next(error);
     }
   };
-  return gbErrorHandler;
+  return svcErrorHandler;
 }
 
 export function notFoundMiddleware() {
-  const gbNotFoundHandler: ServiceHandler = (req, res, next) => {
+  const serviceNotFoundHandler: ServiceHandler = (req, res, next) => {
     const error = new ServiceError(req.app, `Cannot ${req.method} ${req.path}`, {
       status: 404,
       code: 'NotFound',
@@ -216,5 +225,5 @@ export function notFoundMiddleware() {
     });
     next(error);
   };
-  return gbNotFoundHandler as RequestHandler;
+  return serviceNotFoundHandler as RequestHandler;
 }