feat(net): choose metrics port in test mode, upgrade pino

Author: djMax

config/test.json

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

package.json

@@ -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"
   },

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;

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);
+}

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) {

yarn.lock

@@ -796,7 +796,7 @@ __metadata:
     glob: ^8.1.0
     lodash: ^4.17.21
     minimist: ^1.2.8
-    pino: ^8.21.0
+    pino: ^9.0.0
     pino-pretty: ^11.0.0
     pinst: ^3.0.0
     read-pkg-up: ^7.0.1
@@ -6290,9 +6290,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"pino@npm:^8.21.0":
-  version: 8.21.0
-  resolution: "pino@npm:8.21.0"
+"pino@npm:^9.0.0":
+  version: 9.0.0
+  resolution: "pino@npm:9.0.0"
   dependencies:
     atomic-sleep: ^1.0.0
     fast-redact: ^3.1.1
@@ -6307,7 +6307,7 @@ __metadata:
     thread-stream: ^2.6.0
   bin:
     pino: bin.js
-  checksum: d895c37cfcb7ade33ad7ac4ca54c0497ab719ec726e42b7c7b9697e07572a09a7c7de18d751440769c3ea5ecbac2075fdac720cf182720a4764defe3de8a1411
+  checksum: d4d22aa5ab7d1c116c40b694bcc14a38cc9335ff195186933bb9f622784f9dd95d755c454cde420bf971bcda07d3a6013b3a2a4dcb9be43745f9c1a7f86c352c
   languageName: node
   linkType: hard