chore: replace bunyan-middleware

app.js

@@ -2,10 +2,10 @@
 
 import express from 'express'
 import bodyParser from 'body-parser'
-import bunyanMiddleware from 'bunyan-middleware'
 import AsyncEventEmitter from 'events-async'
 
 import logger from './lib/logger.js'
+import requestLogger from './lib/request-logger.js'
 import authMiddleware from './lib/auth-middleware.js'
 import githubEvents from './lib/github-events.js'
 import jenkinsEvents from './lib/jenkins-events.js'
@@ -23,13 +23,8 @@ if (logsDir) {
   app.use('/logs', authMiddleware, express.static(logsDir))
 }
 
-// bunyanMiddleware gives us request id's and unique loggers per incoming request,
-// for safety reasons we don't want to include the webhook GitHub secret in logs
-app.use(bunyanMiddleware({
-  logger,
-  level: 'trace',
-  obscureHeaders: ['x-hub-signature']
-}))
+// Give each request a unique logger and avoid logging the GitHub webhook secret.
+app.use(requestLogger(logger))
 
 githubEvents(app, events)
 jenkinsEvents(app, events)

lib/request-logger.js

@@ -0,0 +1,44 @@
+import { randomUUID } from 'node:crypto'
+
+function obscureHeaders (headers) {
+  return Object.fromEntries(Object.entries(headers).map(([name, value]) => [
+    name,
+    name === 'x-hub-signature' ? null : value
+  ]))
+}
+
+function requestSerializer (req) {
+  return {
+    method: req.method,
+    url: req.originalUrl || req.url,
+    headers: obscureHeaders(req.headers),
+    query: req.query,
+    remoteAddress: req.socket.remoteAddress,
+    remotePort: req.socket.remotePort
+  }
+}
+
+export default function requestLogger (logger) {
+  const parentLogger = logger.child({
+    serializers: {
+      req: requestSerializer,
+      res: logger.constructor.stdSerializers.res
+    }
+  })
+
+  return function logRequest (req, res, next) {
+    const requestId = req.reqId || req.headers['x-request-id'] || randomUUID()
+    const start = process.hrtime.bigint()
+
+    req.log = res.log = parentLogger.child({ req_id: requestId }, true)
+    req.reqId = res.reqId = requestId
+    res.setHeader('X-Request-Id', requestId)
+
+    res.on('finish', () => {
+      const duration = Number(process.hrtime.bigint() - start) / 1e6
+      req.log.trace({ req, res, duration }, 'request finish')
+    })
+
+    next()
+  }
+}