@openapi-typescript-infra/service 4.23.0 → 4.23.2

package/build/types.d.ts

@@ -1,7 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="cookie-parser" />
-/// <reference types="node" />
 import type { Server } from 'http';
 import type { REPLServer } from 'repl';
 import type pino from 'pino';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "4.23.0",
+  "version": "4.23.2",
   "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,12 +60,12 @@
   "dependencies": {
     "@godaddy/terminus": "^4.12.1",
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/exporter-prometheus": "^0.52.0",
+    "@opentelemetry/exporter-prometheus": "^0.52.1",
     "@opentelemetry/instrumentation-dns": "^0.37.0",
     "@opentelemetry/instrumentation-express": "^0.40.1",
     "@opentelemetry/instrumentation-generic-pool": "^0.37.0",
     "@opentelemetry/instrumentation-graphql": "^0.41.0",
-    "@opentelemetry/instrumentation-http": "^0.52.0",
+    "@opentelemetry/instrumentation-http": "^0.52.1",
     "@opentelemetry/instrumentation-ioredis": "^0.41.0",
     "@opentelemetry/instrumentation-net": "^0.37.0",
     "@opentelemetry/instrumentation-pg": "^0.42.0",
@@ -73,8 +73,8 @@
     "@opentelemetry/instrumentation-undici": "^0.3.0",
     "@opentelemetry/resource-detector-container": "^0.3.11",
     "@opentelemetry/resource-detector-gcp": "^0.29.10",
-    "@opentelemetry/sdk-node": "^0.52.0",
-    "@opentelemetry/semantic-conventions": "^1.25.0",
+    "@opentelemetry/sdk-node": "^0.52.1",
+    "@opentelemetry/semantic-conventions": "^1.25.1",
     "@sesamecare-oss/confit": "^2.2.1",
     "@sesamecare-oss/opentelemetry-node-metrics": "^1.0.1",
     "ajv": "^8.16.0",
@@ -85,7 +85,7 @@
     "glob": "^8.1.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.8",
-    "pino": "^9.1.0",
+    "pino": "^9.3.2",
     "read-pkg-up": "^7.0.1",
     "request-ip": "^3.3.0"
   },
@@ -95,14 +95,14 @@
     "@openapi-typescript-infra/coconfig": "^4.4.0",
     "@semantic-release/commit-analyzer": "^13.0.0",
     "@semantic-release/exec": "^6.0.3",
-    "@semantic-release/github": "^10.0.6",
-    "@semantic-release/release-notes-generator": "^14.0.0",
+    "@semantic-release/github": "^10.1.3",
+    "@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.5",
+    "@types/lodash": "^4.17.7",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^20.14.2",
+    "@types/node": "^20.14.14",
     "@types/request-ip": "^0.0.41",
     "@types/supertest": "^6.0.2",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
@@ -111,12 +111,12 @@
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
-    "pino-pretty": "^11.2.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.4.5",
+    "typescript": "^5.5.4",
     "vitest": "^1.6.0"
   },
   "resolutions": {

package/src/openapi.ts

@@ -74,65 +74,62 @@ export async function openApi<
     delete (global as { window: unknown }).window;
   }
 
-  app.locals.openApiSpecification = await new OpenAPIFramework({ apiDoc: apiSpec })
-    .initialize({ visitApi() {} })
-    .then((docs) => docs.apiDoc)
-    .catch((error) => {
-      app.locals.logger.error(error, 'Failed to parse and load OpenAPI spec');
-    });
-
-  if (_window) {
-    (global as { window: unknown }).window = _window;
-  };
+  try {
+    app.locals.openApiSpecification = await new OpenAPIFramework({ apiDoc: apiSpec })
+      .initialize({ visitApi() { } })
+      .then((docs) => docs.apiDoc)
+      .catch((error) => {
+        app.locals.logger.error(error, 'Failed to parse and load OpenAPI spec');
+      });
 
-  const defaultOptions: OAPIOpts = {
-    apiSpec: app.locals.openApiSpecification,
-    ignoreUndocumented: true,
-    validateRequests: {
-      allowUnknownQueryParameters: true,
-      coerceTypes: 'array',
-    },
-    operationHandlers: {
-      basePath,
-      resolver(
-        basePath: string,
-        route: Parameters<typeof OpenApiValidator.resolvers.defaultResolver>[1],
-      ) {
-        const pathKey = route.openApiRoute.substring(route.basePath.length);
-        const modulePath = path.join(basePath, pathKey);
+    const defaultOptions: OAPIOpts = {
+      apiSpec: app.locals.openApiSpecification,
+      ignoreUndocumented: true,
+      validateRequests: {
+        allowUnknownQueryParameters: true,
+        coerceTypes: 'array',
+      },
+      operationHandlers: {
+        basePath,
+        resolver(
+          basePath: string,
+          route: Parameters<typeof OpenApiValidator.resolvers.defaultResolver>[1],
+        ) {
+          const pathKey = route.openApiRoute.substring(route.basePath.length);
+          const modulePath = path.join(basePath, pathKey);
 
-        try {
-          const module = modulesByPath[pathKey];
-          const method = module
-            ? Object.keys(module).find((m) => m.toUpperCase() === route.method)
-            : undefined;
-          if (!module || !method) {
-            throw new Error(
-              `Could not find a [${route.method}] function in ${modulePath} when trying to route [${route.method} ${route.expressRoute}].`,
+          try {
+            const module = modulesByPath[pathKey];
+            const method = module
+              ? Object.keys(module).find((m) => m.toUpperCase() === route.method)
+              : undefined;
+            if (!module || !method) {
+              throw new Error(
+                `Could not find a [${route.method}] function in ${modulePath} when trying to route [${route.method} ${route.expressRoute}].`,
+              );
+            }
+            return module[method] as RequestHandler;
+          } catch (error) {
+            app.locals.logger.error(
+              {
+                error: (error as Error).message,
+                pathKey,
+                modulePath: path.relative(rootDirectory, modulePath),
+              },
+              'Failed to load API method handler',
             );
+            return notImplementedHandler;
           }
-          return module[method] as RequestHandler;
-        } catch (error) {
-          app.locals.logger.error(
-            {
-              error: (error as Error).message,
-              pathKey,
-              modulePath: path.relative(rootDirectory, modulePath),
-            },
-            'Failed to load API method handler',
-          );
-          return notImplementedHandler;
-        }
+        },
       },
-    },
-  };
+    };
 
-  const { routing } = app.locals.config;
-  const combinedOptions = {
-    // In test mode, validate returned swagger responses. This can easily be disabled
-    // by setting validateResponses to false in the config.
-    ...(getNodeEnv() === 'test'
-      ? {
+    const { routing } = app.locals.config;
+    const combinedOptions = {
+      // In test mode, validate returned swagger responses. This can easily be disabled
+      // by setting validateResponses to false in the config.
+      ...(getNodeEnv() === 'test'
+        ? {
           validateResponses: {
             onError(error: Error, body: unknown, req: Request) {
               console.log('Response body fails validation: ', error);
@@ -142,10 +139,15 @@ export async function openApi<
             },
           },
         }
-      : {}),
-    ...(typeof routing.openapi === 'object' ? routing.openapi : {}),
-    ...openApiOptions,
-  };
+        : {}),
+      ...(typeof routing.openapi === 'object' ? routing.openapi : {}),
+      ...openApiOptions,
+    };
 
-  return OpenApiValidator.middleware(_.defaultsDeep(defaultOptions, combinedOptions));
+    return OpenApiValidator.middleware(_.defaultsDeep(defaultOptions, combinedOptions));
+  } finally {
+    if (_window) {
+      (global as { window: unknown }).window = _window;
+    };
+  }
 }

package/src/telemetry/DummyExporter.ts

@@ -1,16 +1,14 @@
-import { ExportResultCode } from '@opentelemetry/core';
-import type { SpanExporter } from '@opentelemetry/sdk-trace-base';
-
-const noop: SpanExporter['export'] = (spans, resultCallback) => {
-  setImmediate(() =>
-    resultCallback({
-      code: ExportResultCode.SUCCESS,
-    }),
-  );
-};
+import { ExportResult, ExportResultCode } from '@opentelemetry/core';
+import type { ReadableSpan, SpanExporter } from '@opentelemetry/sdk-trace-base';
 
 export class DummySpanExporter implements SpanExporter {
-  export: typeof noop = noop;
+  export(spans: ReadableSpan[], resultCallback: (r: ExportResult) => void) {
+    setImmediate(() =>
+      resultCallback({
+        code: ExportResultCode.SUCCESS,
+      }),
+    );
+  }
 
   async shutdown() {
     // Nothing to do