@openapi-typescript-infra/service 5.10.0 → 5.11.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "5.10.0",
+  "version": "5.11.1",
   "description": "An opinionated framework for building configuration driven services - web, api, or  ob. Uses OpenAPI, pino logging, express, confit, Typescript and vitest.",
   "exports": {
     ".": {
@@ -70,66 +70,67 @@
   "dependencies": {
     "@godaddy/terminus": "^4.12.1",
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/auto-instrumentations-node": "^0.56.1",
-    "@opentelemetry/exporter-prometheus": "^0.57.2",
-    "@opentelemetry/instrumentation-dns": "^0.43.1",
-    "@opentelemetry/instrumentation-express": "^0.47.1",
-    "@opentelemetry/instrumentation-generic-pool": "^0.43.1",
-    "@opentelemetry/instrumentation-graphql": "^0.47.1",
-    "@opentelemetry/instrumentation-http": "^0.57.2",
-    "@opentelemetry/instrumentation-ioredis": "^0.47.1",
-    "@opentelemetry/instrumentation-net": "^0.43.1",
-    "@opentelemetry/instrumentation-pg": "^0.51.1",
-    "@opentelemetry/instrumentation-pino": "^0.46.1",
-    "@opentelemetry/instrumentation-undici": "^0.10.1",
-    "@opentelemetry/resource-detector-container": "^0.6.1",
-    "@opentelemetry/resource-detector-gcp": "^0.33.1",
-    "@opentelemetry/sdk-node": "^0.57.2",
-    "@opentelemetry/semantic-conventions": "^1.30.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.59.0",
+    "@opentelemetry/exporter-prometheus": "^0.201.1",
+    "@opentelemetry/instrumentation-dns": "^0.45.0",
+    "@opentelemetry/instrumentation-express": "^0.50.0",
+    "@opentelemetry/instrumentation-generic-pool": "^0.45.0",
+    "@opentelemetry/instrumentation-graphql": "^0.49.0",
+    "@opentelemetry/instrumentation-http": "^0.201.1",
+    "@opentelemetry/instrumentation-ioredis": "^0.49.0",
+    "@opentelemetry/instrumentation-net": "^0.45.0",
+    "@opentelemetry/instrumentation-pg": "^0.53.0",
+    "@opentelemetry/instrumentation-pino": "^0.48.0",
+    "@opentelemetry/instrumentation-undici": "^0.12.0",
+    "@opentelemetry/resource-detector-container": "^0.7.1",
+    "@opentelemetry/resource-detector-gcp": "^0.35.0",
+    "@opentelemetry/sdk-node": "^0.201.1",
+    "@opentelemetry/semantic-conventions": "^1.33.0",
     "@sesamecare-oss/confit": "^2.2.1",
     "@sesamecare-oss/opentelemetry-node-metrics": "^1.1.0",
     "ajv": "^8.17.1",
     "clean-stack": "^5.2.0",
     "cookie-parser": "^1.4.7",
-    "dotenv": "^16.4.7",
+    "dotenv": "^16.5.0",
     "express": "^5.1.0",
-    "express-openapi-validator": "^5.4.7",
-    "glob": "^11.0.1",
-    "import-in-the-middle": "^1.13.1",
+    "express-openapi-validator": "^5.5.2",
+    "glob": "^11.0.2",
+    "import-in-the-middle": "^1.13.2",
     "minimist": "^1.2.8",
     "moderndash": "^4.0.0",
-    "pino": "^9.6.0",
+    "opentelemetry-resource-detector-sync-api": "^0.30.0",
+    "pino": "^9.7.0",
     "read-package-up": "^11.0.0",
     "request-ip": "^3.3.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.8.0",
-    "@commitlint/config-conventional": "^19.8.0",
-    "@openapi-typescript-infra/coconfig": "^4.6.0",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@openapi-typescript-infra/coconfig": "^4.7.1",
     "@semantic-release/commit-analyzer": "^13.0.1",
-    "@semantic-release/exec": "^7.0.3",
-    "@semantic-release/github": "^11.0.1",
+    "@semantic-release/exec": "^7.1.0",
+    "@semantic-release/github": "^11.0.2",
     "@semantic-release/release-notes-generator": "^14.0.3",
     "@types/cookie-parser": "^1.4.8",
-    "@types/express": "^5.0.1",
+    "@types/express": "^5.0.2",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^22.13.17",
+    "@types/node": "^22.15.20",
     "@types/request-ip": "^0.0.41",
     "@types/supertest": "^6.0.3",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "@typescript-eslint/parser": "^7.18.0",
-    "coconfig": "^1.6.1",
+    "coconfig": "^1.6.2",
     "eslint": "^8.57.1",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-import-resolver-typescript": "^4.3.1",
+    "eslint-import-resolver-typescript": "^4.3.5",
     "eslint-plugin-import": "^2.31.0",
     "pino-pretty": "^13.0.0",
     "pinst": "^3.0.0",
-    "supertest": "^7.1.0",
+    "supertest": "^7.1.1",
     "tsconfig-paths": "^4.2.0",
-    "tsx": "^4.19.3",
-    "typescript": "^5.8.2",
-    "vitest": "^3.1.1"
+    "tsx": "^4.19.4",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.4"
   },
   "resolutions": {
     "qs": "^6.11.0"

package/src/express-app/app.ts

@@ -232,7 +232,7 @@ export async function startApp<
   }
 
   if (routing?.freezeQuery) {
-    app.use((req, res, next) => {
+    app.use(function freezeQuery(req, res, next) {
       // Express 5 re-parses the query string every time. This causes problems with
       // various libraries, namely the express OpenAPI parser. So we "freeze it" in place
       // here, which runs right before the routing validation logic does. Note that this
@@ -259,7 +259,8 @@ export async function startApp<
     );
   }
   if (routing?.openapi) {
-    app.use(await openApi(app, rootDirectory, codepath, codePattern, options.openApiOptions));
+    const openApiMiddleware = await openApi(app, rootDirectory, codepath, codePattern, options.openApiOptions);
+    app.use(openApiMiddleware);
   }
 
   // Putting this here allows more flexible middleware insertion

package/src/telemetry/index.ts

@@ -1,14 +1,11 @@
 import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-proto';
 import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto';
 import {
-  Detector,
-  DetectorSync,
-  envDetectorSync,
-  hostDetectorSync,
-  IResource,
-  osDetectorSync,
-  processDetectorSync,
-  ResourceDetectionConfig,
+  detectResources,
+  envDetector,
+  hostDetector,
+  osDetector,
+  processDetector,
 } from '@opentelemetry/resources';
 import { containerDetector } from '@opentelemetry/resource-detector-container';
 import { gcpDetector } from '@opentelemetry/resource-detector-gcp';
@@ -67,17 +64,6 @@ function getLogExporter() {
 let prometheusExporter: PrometheusExporter | undefined;
 let telemetrySdk: opentelemetry.NodeSDK | undefined;
 
-function awaitAttributes(detector: DetectorSync): Detector {
-  return {
-    async detect(config?: ResourceDetectionConfig): Promise<IResource> {
-      const resource = detector.detect(config)
-      await resource.waitForAsyncAttributes?.()
-
-      return resource
-    },
-  }
-}
-
 /**
  * OpenTelemetry is not friendly to the idea of stopping
  * and starting itself, it seems. So we can only keep a global
@@ -90,33 +76,40 @@ export async function startGlobalTelemetry(serviceName: string) {
   if (!prometheusExporter) {
     const { metrics, logs, NodeSDK } = opentelemetry;
 
+    const resource = await detectResources({
+      detectors: [
+        envDetector,
+        hostDetector,
+        osDetector,
+        processDetector,
+        containerDetector,
+        gcpDetector,
+      ],
+    });
+
     prometheusExporter = new PrometheusExporter({ preventServerStart: true });
     const instrumentations = getAutoInstrumentations();
     const logExporter = getLogExporter();
     telemetrySdk = new NodeSDK({
       serviceName,
       autoDetectResources: false,
-      resourceDetectors: [
-        awaitAttributes(envDetectorSync),
-        awaitAttributes(hostDetectorSync),
-        awaitAttributes(osDetectorSync),
-        awaitAttributes(processDetectorSync),
-        awaitAttributes(containerDetector),
-        awaitAttributes(gcpDetector),
-      ],
+      resource,
       traceExporter: getSpanExporter(),
       metricReader: prometheusExporter,
       instrumentations,
       logRecordProcessors: logExporter ? [new logs.BatchLogRecordProcessor(logExporter)] : [],
       views: [
-        new metrics.View({
+        {
           instrumentName: 'http_request_duration_seconds',
           instrumentType: metrics.InstrumentType.HISTOGRAM,
-          aggregation: new metrics.ExplicitBucketHistogramAggregation(
-            [0.003, 0.03, 0.1, 0.3, 1.5, 10],
-            true,
-          ),
-        }),
+          aggregation: {
+            type: metrics.AggregationType.EXPLICIT_BUCKET_HISTOGRAM,
+            options: {
+              boundaries: [0.003, 0.03, 0.1, 0.3, 1.5, 10],
+              recordMinMax: true,
+            },
+          },
+        },
       ],
     });
     telemetrySdk.start();
@@ -160,3 +153,5 @@ export async function startWithTelemetry<
   });
   return { app, codepath: options.codepath, server };
 }
+
+export { setTelemetryHooks } from './instrumentations.js';

package/src/telemetry/instrumentations.ts

@@ -1,11 +1,12 @@
 import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { DnsInstrumentation } from '@opentelemetry/instrumentation-dns';
-import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
+import { ExpressInstrumentation, SpanNameHook } from '@opentelemetry/instrumentation-express';
 import { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici';
 import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
-import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
+import { HttpInstrumentation, IgnoreIncomingRequestFunction } from '@opentelemetry/instrumentation-http';
 import { IORedisInstrumentation } from '@opentelemetry/instrumentation-ioredis';
 import { NetInstrumentation } from '@opentelemetry/instrumentation-net';
+import { GraphQLInstrumentation } from '@opentelemetry/instrumentation-graphql';
 import { PgInstrumentation } from '@opentelemetry/instrumentation-pg';
 import { PinoInstrumentation } from '@opentelemetry/instrumentation-pino';
 
@@ -13,6 +14,7 @@ const InstrumentationMap = {
   '@opentelemetry/instrumentation-http': HttpInstrumentation,
   '@opentelemetry/instrumentation-dns': DnsInstrumentation,
   '@opentelemetry/instrumentation-express': ExpressInstrumentation,
+  '@opentelemetry/instrumentation-graphql': GraphQLInstrumentation,
   '@opentelemetry/instrumentation-undici': UndiciInstrumentation,
   '@opentelemetry/instrumentation-generic-pool': GenericPoolInstrumentation,
   '@opentelemetry/instrumentation-ioredis': IORedisInstrumentation,
@@ -27,8 +29,45 @@ export type InstrumentationConfigMap = {
   [Name in keyof typeof InstrumentationMap]?: ConfigArg<(typeof InstrumentationMap)[Name]>;
 };
 
+let ignoreIncomingRequestHook: IgnoreIncomingRequestFunction | undefined = (req) => {
+  return req.url === '/health' || req.url === '/metrics';
+};
+
+let spanNameHook: SpanNameHook | undefined;
+
+export function setTelemetryHooks(hooks: {
+  ignoreIncomingRequestHook?: IgnoreIncomingRequestFunction;
+  spanNameHook?: SpanNameHook;
+}) {
+  if ('ignoreIncomingRequestHook' in hooks) {
+    ignoreIncomingRequestHook = hooks.ignoreIncomingRequestHook;
+  }
+  if ('spanNameHook' in hooks) {
+    spanNameHook = hooks.spanNameHook;
+  }
+}
+
+const defaultConfigs: InstrumentationConfigMap = {
+  '@opentelemetry/instrumentation-http': {
+    ignoreIncomingRequestHook(req) {
+      if (ignoreIncomingRequestHook) {
+        return ignoreIncomingRequestHook(req);
+      }
+      return false;
+    },
+  },
+  '@opentelemetry/instrumentation-express': {
+    spanNameHook(info, defaultName) {
+      if (spanNameHook) {
+        return spanNameHook(info, defaultName);
+      }
+      return defaultName;
+    },
+  },
+};
+
 export function getAutoInstrumentations(
-  inputConfigs: InstrumentationConfigMap = {},
+  inputConfigs: InstrumentationConfigMap = defaultConfigs,
 ): Instrumentation[] {
   const keys = Object.keys(InstrumentationMap) as Array<keyof typeof InstrumentationMap>;
   return keys

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