fix(tests): print out openapi validation errors rather than just throwing

Author: djMax

config/test.json

@@ -3,11 +3,6 @@
   "logging": {
     "level": "warn"
   },
-  "routing": {
-    "openapi": {
-      "validateResponses": true
-    }
-  },
   "server": {
     "port": 0
   }

package.json

@@ -54,7 +54,7 @@
         }
       ],
       "@semantic-release/npm",
-      "@semantic-release/git"
+      "@semantic-release/github"
     ]
   },
   "homepage": "https://github.com/openapi-typescript-infra/service#readme",
@@ -99,10 +99,9 @@
     "@commitlint/cli": "^18.4.3",
     "@commitlint/config-conventional": "^18.4.3",
     "@openapi-typescript-infra/coconfig": "^4.2.2",
-    "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^11.1.0",
     "@semantic-release/exec": "^6.0.3",
-    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^9.2.3",
     "@semantic-release/release-notes-generator": "^12.1.0",
     "@types/cookie-parser": "^1.4.6",
     "@types/express": "^4.17.21",

src/openapi.ts

@@ -3,9 +3,10 @@ import path from 'path';
 import _ from 'lodash';
 import * as OpenApiValidator from 'express-openapi-validator';
 import { OpenAPIFramework } from 'express-openapi-validator/dist/framework/index';
-import type { Handler } from 'express';
+import type { Handler, Request } from 'express';
 
 import type { AnyServiceLocals, ServiceExpress, ServiceLocals } from './types';
+import { getNodeEnv } from './env';
 import { getFilesInDir, loadModule } from './express-app/modules';
 import { ConfigurationSchema } from './config/schema';
 
@@ -116,6 +117,19 @@ export async function openApi<
 
   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);
+              console.log('Emitted from:', req.originalUrl);
+              console.debug(body);
+            },
+          },
+        }
+      : {}),
     ...(typeof routing.openapi === 'object' ? routing.openapi : {}),
     ...openApiOptions,
   };