@openapi-typescript-infra/service 4.24.0 → 4.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "4.24.0",
+  "version": "4.26.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": {
@@ -60,64 +60,64 @@
   "dependencies": {
     "@godaddy/terminus": "^4.12.1",
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/exporter-prometheus": "^0.52.1",
-    "@opentelemetry/instrumentation-dns": "^0.38.0",
-    "@opentelemetry/instrumentation-express": "^0.41.1",
-    "@opentelemetry/instrumentation-generic-pool": "^0.38.0",
-    "@opentelemetry/instrumentation-graphql": "^0.42.0",
-    "@opentelemetry/instrumentation-http": "^0.52.1",
-    "@opentelemetry/instrumentation-ioredis": "^0.42.0",
-    "@opentelemetry/instrumentation-net": "^0.38.0",
-    "@opentelemetry/instrumentation-pg": "^0.43.0",
-    "@opentelemetry/instrumentation-pino": "^0.41.0",
-    "@opentelemetry/instrumentation-undici": "^0.4.0",
-    "@opentelemetry/resource-detector-container": "^0.3.11",
-    "@opentelemetry/resource-detector-gcp": "^0.29.10",
-    "@opentelemetry/sdk-node": "^0.52.1",
-    "@opentelemetry/semantic-conventions": "^1.25.1",
+    "@opentelemetry/exporter-prometheus": "^0.53.0",
+    "@opentelemetry/instrumentation-dns": "^0.39.0",
+    "@opentelemetry/instrumentation-express": "^0.42.0",
+    "@opentelemetry/instrumentation-generic-pool": "^0.39.0",
+    "@opentelemetry/instrumentation-graphql": "^0.43.0",
+    "@opentelemetry/instrumentation-http": "^0.53.0",
+    "@opentelemetry/instrumentation-ioredis": "^0.43.0",
+    "@opentelemetry/instrumentation-net": "^0.39.0",
+    "@opentelemetry/instrumentation-pg": "^0.44.0",
+    "@opentelemetry/instrumentation-pino": "^0.42.0",
+    "@opentelemetry/instrumentation-undici": "^0.6.0",
+    "@opentelemetry/resource-detector-container": "^0.4.1",
+    "@opentelemetry/resource-detector-gcp": "^0.29.11",
+    "@opentelemetry/sdk-node": "^0.53.0",
+    "@opentelemetry/semantic-conventions": "^1.27.0",
     "@sesamecare-oss/confit": "^2.2.1",
-    "@sesamecare-oss/opentelemetry-node-metrics": "^1.0.1",
+    "@sesamecare-oss/opentelemetry-node-metrics": "^1.1.0",
     "ajv": "^8.17.1",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.4.5",
-    "express": "^5.0.0-beta.3",
-    "express-openapi-validator": "^5.2.0",
+    "express": "^5.0.0",
+    "express-openapi-validator": "^5.3.7",
     "glob": "^8.1.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.8",
-    "pino": "^9.3.2",
+    "pino": "^9.4.0",
     "read-pkg-up": "^7.0.1",
     "request-ip": "^3.3.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.3.0",
-    "@commitlint/config-conventional": "^19.2.2",
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
     "@openapi-typescript-infra/coconfig": "^4.4.0",
     "@semantic-release/commit-analyzer": "^13.0.0",
     "@semantic-release/exec": "^6.0.3",
-    "@semantic-release/github": "^10.1.3",
+    "@semantic-release/github": "^10.3.5",
     "@semantic-release/release-notes-generator": "^14.0.1",
     "@types/cookie-parser": "^1.4.7",
     "@types/express": "^4.17.21",
     "@types/glob": "^8.1.0",
     "@types/lodash": "^4.17.7",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^20.14.14",
+    "@types/node": "^20.16.5",
     "@types/request-ip": "^0.0.41",
     "@types/supertest": "^6.0.2",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "@typescript-eslint/parser": "^6.21.0",
     "coconfig": "^1.5.2",
-    "eslint": "^8.57.0",
+    "eslint": "^8.57.1",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-import": "^2.30.0",
     "pino-pretty": "^11.2.2",
     "pinst": "^3.0.0",
     "supertest": "^7.0.0",
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.5.4",
-    "vitest": "^2.0.5"
+    "typescript": "^5.6.2",
+    "vitest": "^2.1.1"
   },
   "resolutions": {
     "qs": "^6.11.0"

package/src/error.ts

@@ -8,6 +8,7 @@ export interface ServiceErrorSpec {
   display_message?: string;
   log_stack?: boolean;
   expected_error?: boolean;
+  client_metadata?: Record<string, unknown>;
 }
 
 /**
@@ -30,6 +31,9 @@ export class ServiceError<
 
   public log_stack?: boolean;
 
+  // Additional data TO BE RETURNED TO THE CLIENT
+  public client_metadata?: Record<string, unknown>;
+
   // If true, this shouldn't be logged as an error, but as an info log.
   // This is common when the error needs to go to the client, but should not
   // take up the valuable mental space of an error log.

package/src/telemetry/index.ts

@@ -1,4 +1,12 @@
 import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto';
+import {
+  envDetectorSync,
+  hostDetectorSync,
+  osDetectorSync,
+  processDetectorSync,
+} from '@opentelemetry/resources';
+import { containerDetector } from '@opentelemetry/resource-detector-container';
+import { gcpDetector } from '@opentelemetry/resource-detector-gcp';
 import * as opentelemetry from '@opentelemetry/sdk-node';
 import { PrometheusExporter } from '@opentelemetry/exporter-prometheus';
 
@@ -12,7 +20,7 @@ import type {
 import type { ListenFn, StartAppFn } from '../express-app/index';
 import type { ConfigurationSchema } from '../config/schema';
 
-import { getAutoInstrumentations, getResource } from './instrumentations';
+import { getAutoInstrumentations } from './instrumentations';
 import { DummySpanExporter } from './DummyExporter';
 
 // For troubleshooting, set the log level to DiagLogLevel.DEBUG
@@ -53,9 +61,17 @@ export async function startGlobalTelemetry(serviceName: string) {
       serviceName,
       autoDetectResources: false,
       traceExporter: getExporter(),
-      resource: await getResource(),
+      resourceDetectors: [
+        envDetectorSync,
+        hostDetectorSync,
+        osDetectorSync,
+        processDetectorSync,
+        containerDetector,
+        gcpDetector,
+      ],
       metricReader: prometheusExporter,
       instrumentations,
+      logRecordProcessors: [],
       views: [
         new opentelemetry.metrics.View({
           instrumentName: 'http_request_duration_seconds',

package/src/telemetry/instrumentations.ts

@@ -8,17 +8,6 @@ import { IORedisInstrumentation } from '@opentelemetry/instrumentation-ioredis';
 import { NetInstrumentation } from '@opentelemetry/instrumentation-net';
 import { PgInstrumentation } from '@opentelemetry/instrumentation-pg';
 import { PinoInstrumentation } from '@opentelemetry/instrumentation-pino';
-import { containerDetector } from '@opentelemetry/resource-detector-container';
-import { gcpDetector } from '@opentelemetry/resource-detector-gcp';
-import {
-  Resource,
-  detectResources,
-  detectResourcesSync,
-  envDetectorSync,
-  hostDetectorSync,
-  osDetectorSync,
-  processDetectorSync,
-} from '@opentelemetry/resources';
 
 const InstrumentationMap = {
   '@opentelemetry/instrumentation-http': HttpInstrumentation,
@@ -58,23 +47,3 @@ export function getAutoInstrumentations(
     })
     .filter((i) => !!i) as Instrumentation[];
 }
-
-// Async function to get combined resources
-export async function getResource(): Promise<Resource> {
-  const syncDetectors = [
-    envDetectorSync,
-    hostDetectorSync,
-    osDetectorSync,
-    processDetectorSync,
-  ];
-  const asyncDetectors = [
-    containerDetector,
-    gcpDetector,
-  ];
-
-  const asyncResources = await detectResources({ detectors: asyncDetectors });
-  const syncResources = detectResourcesSync({ detectors: syncDetectors });
-
-  // Combine async and sync resources
-  return syncResources.merge(asyncResources);
-}

package/src/telemetry/requestLogger.ts

@@ -198,6 +198,7 @@ export function errorHandlerMiddleware<
         domain: body.domain,
         code: body.code,
         display_message: body.display_message,
+        ...loggable.client_metadata,
       };
     }
     // Set the status to error, even if we aren't going to render the error.
@@ -211,6 +212,7 @@ export function errorHandlerMiddleware<
         message: loggable.message,
         domain: loggable.domain,
         display_message: loggable.display_message,
+        ...loggable.client_metadata,
       });
     } else {
       next(error);