Merge pull request #216 from DEFRA/pino-updates

Update Pino logger packages + type fixes

.github/dependabot.yml

@@ -36,6 +36,13 @@ updates:
           - 'lint-staged'
           - 'prettier'
 
+      logging:
+        patterns:
+          - '*-pino'
+          - '*-pino-format'
+          - 'pino'
+          - 'pino-*'
+
       tools:
         patterns:
           - '@testing-library/*'

designer/package.json

@@ -60,7 +60,7 @@
     "luxon": "^3.4.4",
     "nanoid": "^3.3.4",
     "nunjucks": "^3.2.4",
-    "pino": "^8.20.0",
+    "pino": "^9.1.0",
     "prismjs": "^1.29.0",
     "react": "^16.14.0",
     "react-dom": "^16.14.0",
@@ -86,7 +86,7 @@
     "jsdom": "^24.1.0",
     "mini-css-extract-plugin": "^2.9.0",
     "outdent": "^0.8.0",
-    "pino-pretty": "^11.0.0",
+    "pino-pretty": "^11.1.0",
     "postcss": "^8.4.38",
     "postcss-loader": "^8.1.1",
     "sass-embedded": "^1.75.0",

designer/server/src/common/helpers/logging/logger-options.js

@@ -3,19 +3,21 @@ import { ecsFormat } from '@elastic/ecs-pino-format'
 import config from '~/src/config.js'
 
 /**
- * @type {import('pino').LoggerOptions}
+ * @satisfies {LoggerOptions}
  */
 export const loggerOptions = {
   redact: {
     paths: ['req.headers.authorization', 'req.headers.cookie', 'res.headers'],
     remove: true
   },
   level: config.logLevel,
-  ...(config.isProduction
-    ? ecsFormat()
-    : {
-        transport: {
-          target: 'pino-pretty'
-        }
-      })
+  ...(config.isDevelopment
+    ? /** @type {LoggerTransport} */ ({ transport: { target: 'pino-pretty' } })
+    : /** @type {LoggerFormat} */ (ecsFormat()))
 }
+
+/**
+ * @typedef {import('pino').LoggerOptions} LoggerOptions
+ * @typedef {{ transport: import('pino').TransportSingleOptions }} LoggerTransport
+ * @typedef {Pick<LoggerOptions, 'messageKey' | 'timestamp' | 'formatters'>} LoggerFormat
+ */

designer/server/src/common/helpers/logging/request-logger.js

@@ -2,9 +2,19 @@ import hapiPino from 'hapi-pino'
 
 import { loggerOptions } from '~/src/common/helpers/logging/logger-options.js'
 
-const requestLogger = {
+/**
+ * @satisfies {ServerRegisterPluginObject<Options>}
+ */
+export const requestLogger = {
   plugin: hapiPino,
   options: loggerOptions
 }
 
-export { requestLogger }
+/**
+ * @template {object | void} [PluginOptions=void]
+ * @typedef {import('@hapi/hapi').ServerRegisterPluginObject<PluginOptions>} ServerRegisterPluginObject
+ */
+
+/**
+ * @typedef {import('hapi-pino').Options} Options
+ */