@defra/lis-infra-ui-services 0.37.0 → 0.38.0

package/README.md

@@ -180,7 +180,7 @@ The main entry point (`@defra/lis-infra-ui-services`) exports `buildMicrositePat
 | 503           | `service-unavailable`  |
 | anything else | `problem-with-service` |
 
-5xx responses are logged at `error`, and 4xx responses other than 401, 403 and 404 at `warn`, each with the error object, request method, path and status code. Boom messages are logged, so application code must not put user-supplied text in them.
+5xx responses are logged at `error`, and 4xx responses other than 401, 403 and 404 at `warn`, each with the error object and the ECS fields `http.request.method`, `url.path` and `http.response.status_code`. Boom messages are logged, so application code must not put user-supplied text in them.
 
 ```js
 import { catchAll } from '@defra/lis-infra-ui-services/errors'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/lis-infra-ui-services",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "description": "UI-Services shared definitions for the livestock taxonomy topology.",
   "main": "src/index.js",
   "repository": {

package/src/errors/index.js

@@ -64,11 +64,16 @@ function logFailure(request, statusCode) {
     return
   }
 
-  // Keys mirror hapi-pino's shape because the CDP pipeline maps them to ECS fields and drops the rest; request.path deliberately omits the query string
+  // Native ECS keys: hubs register hapi-pino on the shared logger, whose
+  // req/res serialisers expect real HTTP objects (and null the status of a
+  // plain one). request.path deliberately omits the query string.
   const context = {
     err: getError(response, statusCode),
-    req: { method: request.method, url: request.path },
-    res: { statusCode }
+    http: {
+      request: { method: request.method },
+      response: { status_code: statusCode }
+    },
+    url: { path: request.path }
   }
 
   if (isServerError) {

package/src/errors/index.test.js

@@ -107,8 +107,11 @@ test('catchAll logs server errors and renders the problem with the service page'
   assert.deepEqual(logger.error.mock.calls[0], [
     {
       err: request.response,
-      req: { method: 'get', url: '/mock-path' },
-      res: { statusCode: statusCodes.internalServerError }
+      http: {
+        request: { method: 'get' },
+        response: { status_code: statusCodes.internalServerError }
+      },
+      url: { path: '/mock-path' }
     },
     'Request failed'
   ])
@@ -129,8 +132,11 @@ test.each([statusCodes.badRequest, statusCodes.unprocessableEntity])(
     assert.deepEqual(logger.warn.mock.calls[0], [
       {
         err: request.response,
-        req: { method: 'get', url: '/mock-path' },
-        res: { statusCode }
+        http: {
+          request: { method: 'get' },
+          response: { status_code: statusCode }
+        },
+        url: { path: '/mock-path' }
       },
       'Request rejected'
     ])
@@ -214,8 +220,11 @@ test('catchAll logs the error behind plain 500 responses before continuing', ()
   assert.deepEqual(logger.error.mock.calls[0], [
     {
       err: sourceError,
-      req: { method: 'post', url: '/plain' },
-      res: { statusCode: statusCodes.internalServerError }
+      http: {
+        request: { method: 'post' },
+        response: { status_code: statusCodes.internalServerError }
+      },
+      url: { path: '/plain' }
     },
     'Request failed'
   ])