@defra/lis-infra-ui-services 0.1.0 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/lis-infra-ui-services",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "UI-Services shared definitions for the livestock taxonomy topology.",
   "main": "src/index.js",
   "repository": {
@@ -54,7 +54,6 @@
   "author": "Defra DDTS",
   "license": "OGL-UK-3.0",
   "dependencies": {
-    "@defra/hapi-tracing": "1.30.0",
     "@elastic/ecs-pino-format": "1.5.0",
     "@hapi/catbox-memory": "6.0.2",
     "@hapi/catbox-redis": "7.0.2",
@@ -73,9 +72,11 @@
     "undici": "7.24.8"
   },
   "peerDependencies": {
-    "eslint": "^9.0.0"
+    "eslint": "^9.0.0",
+    "@defra/lis-hubs-infra-core": "^0.2.0"
   },
   "devDependencies": {
+    "@defra/lis-hubs-infra-core": "^0.2.0",
     "@defra/lis-infra-eslint-config": "^0.6.0",
     "@vitest/coverage-istanbul": "^4.1.10",
     "audit-ci": "^7.1.0",

package/src/logging/logger-options.js

@@ -1,11 +1,32 @@
 import { createRequire } from 'node:module'
 
 import { ecsFormat } from '@elastic/ecs-pino-format'
-import { getTraceId } from '@defra/hapi-tracing'
+import { requestContext } from '@defra/lis-hubs-infra-core'
 
 const require = createRequire(import.meta.url)
 const pinoPretty = require('pino-pretty')
 
+/**
+ * Wraps ecs-pino-format's log formatter to also surface error.cause.
+ * ECS's error.* fields (type, message, stack_trace) predate Error.cause
+ * (ES2022) and have no field for it, so ecs-pino-format silently drops it -
+ * this puts it back as error.cause when present.
+ * @param {object} ecs - The object returned by ecsFormat().
+ * @returns {Function}
+ */
+function createEcsLogFormatter(ecs) {
+  return function log(obj) {
+    const formatted = ecs.formatters.log(obj)
+    const cause = obj.err?.cause
+
+    if (cause !== undefined && formatted.error) {
+      formatted.error.cause = cause?.message ?? cause?.code ?? cause
+    }
+
+    return formatted
+  }
+}
+
 /**
  * @param {{ logConfig: object, serviceName: string, serviceVersion: string }} options
  * @returns {object}
@@ -15,12 +36,15 @@ export function createLoggerOptions({
   serviceName,
   serviceVersion
 }) {
+  const ecs = ecsFormat({ serviceVersion, serviceName })
+
   const formatters = {
     ecs: {
-      ...ecsFormat({
-        serviceVersion,
-        serviceName
-      })
+      ...ecs,
+      formatters: {
+        ...ecs.formatters,
+        log: createEcsLogFormatter(ecs)
+      }
     },
     json: {},
     'pino-pretty': {
@@ -42,10 +66,10 @@ export function createLoggerOptions({
     nesting: true,
     mixin() {
       const mixinValues = {}
-      const traceId = getTraceId()
+      const correlationId = requestContext.get('correlation_id')
 
-      if (traceId) {
-        mixinValues.trace = { id: traceId }
+      if (correlationId) {
+        mixinValues.trace = { id: correlationId }
       }
 
       return mixinValues

package/src/logging/logger-options.test.js

@@ -0,0 +1,108 @@
+import { beforeEach, describe, expect, test, vi } from 'vitest'
+
+import { requestContext } from '@defra/lis-hubs-infra-core'
+import { createLoggerOptions } from './logger-options.js'
+
+vi.mock('@defra/lis-hubs-infra-core')
+
+const mocks = {
+  requestContextGet: vi.mocked(requestContext.get)
+}
+
+function createOptions(format = 'ecs') {
+  return createLoggerOptions({
+    logConfig: { enabled: true, level: 'info', format, redact: [] },
+    serviceName: 'test-service',
+    serviceVersion: '1.2.3'
+  })
+}
+
+describe('createLoggerOptions()', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  test('mixin adds trace.id from the request context correlation id', () => {
+    // Arrange
+    mocks.requestContextGet.mockReturnValue('correlation-123')
+
+    // Act
+    const mixinValues = createOptions().mixin()
+
+    // Assert
+    expect(mixinValues).toEqual({ trace: { id: 'correlation-123' } })
+    expect(mocks.requestContextGet).toHaveBeenCalledWith('correlation_id')
+  })
+
+  test('mixin omits trace when no correlation id is available', () => {
+    // Arrange
+    mocks.requestContextGet.mockReturnValue(null)
+
+    // Act
+    const mixinValues = createOptions().mixin()
+
+    // Assert
+    expect(mixinValues).toEqual({})
+  })
+
+  test('ecs log formatter preserves error.cause alongside the standard ECS fields', () => {
+    // Arrange
+    const cause = new Error('getaddrinfo ENOTFOUND identity.example')
+    const err = new Error('fetch failed')
+    err.cause = cause
+
+    // Act
+    const formatted = createOptions().formatters.log({ err, msg: 'failed' })
+
+    // Assert
+    expect(formatted.error.message).toBe('fetch failed')
+    expect(formatted.error.type).toBe('Error')
+    expect(formatted.error.cause).toBe(cause.message)
+  })
+
+  test('ecs log formatter falls back to cause.code when cause has no message', () => {
+    // Arrange
+    const cause = { code: 'ENOTFOUND' }
+    const err = new Error('fetch failed')
+    err.cause = cause
+
+    // Act
+    const formatted = createOptions().formatters.log({ err })
+
+    // Assert
+    expect(formatted.error.cause).toBe('ENOTFOUND')
+  })
+
+  test('ecs log formatter falls back to the raw cause value when it has neither message nor code', () => {
+    // Arrange
+    const err = new Error('fetch failed')
+    err.cause = 'ECONNREFUSED'
+
+    // Act
+    const formatted = createOptions().formatters.log({ err })
+
+    // Assert
+    expect(formatted.error.cause).toBe('ECONNREFUSED')
+  })
+
+  test('ecs log formatter is unaffected when the error has no cause', () => {
+    // Arrange
+    const err = new Error('plain failure')
+
+    // Act
+    const formatted = createOptions().formatters.log({ err })
+
+    // Assert
+    expect(formatted.error.message).toBe('plain failure')
+    expect('cause' in formatted.error).toBe(false)
+  })
+
+  test('non-ecs log formats are unaffected by the cause-preserving wrapper', () => {
+    // Arrange
+    // Act
+    const options = createOptions('json')
+
+    // Assert
+    expect('formatters' in options).toBe(false)
+  })
+})