feat/df-1026: createLogger() as a singleton

src/helpers/logging/logger.js

@@ -5,6 +5,10 @@ import { loggerOptions } from '~/src/helpers/logging/logger-options.js'
 /**
  * Create a logger instance.
  */
-export function createLogger() {
+function createPinoLogger() {
   return pino(loggerOptions)
 }
+
+// Singleton logger instance - pino adds 'exit' listeners to process,
+// so we reuse a single instance to avoid MaxListenersExceededWarning
+export const logger = createPinoLogger()

src/index.js

@@ -2,9 +2,7 @@ import { chdir } from 'node:process'
 
 import { getErrorMessage } from '@defra/forms-model'
 
-import { createLogger } from '~/src/helpers/logging/logger.js'
-
-const logger = createLogger()
+import { logger } from '~/src/helpers/logging/logger.js'
 
 // Move working directory to build output
 chdir(import.meta.dirname)

src/messaging/event.js

@@ -6,7 +6,7 @@ import {
 } from '@aws-sdk/client-sqs'
 
 import { config } from '~/src/config/index.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { sqsClient } from '~/src/messaging/sqs.js'
 
 export const receiveMessageTimeout = config.get('receiveMessageTimeout')
@@ -16,8 +16,6 @@ const deadLetterQueueArn = config.get('sqsEventsDlqArn')
 const maxNumberOfMessages = config.get('maxNumberOfMessages')
 const visibilityTimeout = config.get('visibilityTimeout')
 
-const logger = createLogger()
-
 /**
  * @type {ReceiveMessageCommandInput}
  */

src/messaging/event.test.js

@@ -17,7 +17,13 @@ import {
   resubmitDlqMessage
 } from '~/src/messaging/event.js'
 
-jest.mock('~/src/helpers/logging/logger.js')
+jest.mock('~/src/helpers/logging/logger.js', () => ({
+  logger: {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn()
+  }
+}))
 
 describe('event', () => {
   const snsMock = mockClient(SQSClient)

src/plugins/auth/auth.test.js

@@ -3,11 +3,11 @@ const mockActualTestWarnFn = jest.fn()
 const mockActualTestInfoFn = jest.fn()
 
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: jest.fn().mockReturnValue({
+  logger: {
     error: mockActualTestErrorFn,
     warn: mockActualTestWarnFn,
     info: mockActualTestInfoFn
-  })
+  }
 }))
 
 jest.mock('~/src/config/index.js', () => ({

src/plugins/auth/index.js

@@ -1,15 +1,13 @@
 import Jwt from '@hapi/jwt'
 
 import { config } from '~/src/config/index.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { getUserScopes } from '~/src/service/entitlements/service.js'
 
 const oidcJwksUri = config.get('oidcJwksUri')
 const oidcVerifyAud = config.get('oidcVerifyAud')
 const oidcVerifyIss = config.get('oidcVerifyIss')
 
-const logger = createLogger()
-
 /**
  * Validates user credentials from JWT token
  * @param {Artifacts<UserCredentials>} artifacts - JWT artifacts

src/routes/admin.js

@@ -1,16 +1,14 @@
 import { Scopes } from '@defra/forms-model'
 import Joi from 'joi'
 
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import {
   deleteDlqMessage,
   receiveDlqMessages,
   redriveDlqMessages,
   resubmitDlqMessage
 } from '~/src/messaging/event.js'
 
-const logger = createLogger()
-
 const OK_RESPONSE = 200
 
 const messageIdSchema = Joi.object({

src/server.js

@@ -2,9 +2,7 @@ import { getErrorMessage } from '@defra/forms-model'
 
 import { createServer } from '~/src/api/server.js'
 import { config } from '~/src/config/index.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
-
-const logger = createLogger()
+import { logger } from '~/src/helpers/logging/logger.js'
 
 process.on('unhandledRejection', (err) => {
   logger.error(

src/service/entitlements/service.js

@@ -1,12 +1,11 @@
 import Boom from '@hapi/boom'
 
 import { config } from '~/src/config/index.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { getJson } from '~/src/lib/fetch.js'
 
 const entitlementUrl = config.get('entitlementUrl')
 const entitlementsEndpoint = new URL('/', entitlementUrl)
-const logger = createLogger()
 
 /**
  * Fetches user scopes from the entitlements API

src/service/entitlements/service.test.js

@@ -37,7 +37,7 @@ describe('entitlements service', () => {
       }
     }))
     jest.doMock('~/src/helpers/logging/logger.js', () => ({
-      createLogger: jest.fn().mockReturnValue(mockLogger)
+      logger: mockLogger
     }))
 
     const fetchModule = await import('~/src/lib/fetch.js')

src/service/events.js

@@ -2,11 +2,9 @@ import { formAdapterSubmissionMessagePayloadSchema } from '@defra/forms-engine-p
 import { getErrorMessage } from '@defra/forms-model'
 import Joi from 'joi'
 
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { deleteEventMessage } from '~/src/messaging/event.js'
 
-const logger = createLogger()
-
 /**
  * @param {Message} message
  * @returns {FormAdapterSubmissionMessage}

src/service/events.test.js

@@ -17,7 +17,13 @@ import {
 } from '~/src/service/events.js'
 
 jest.mock('~/src/messaging/event.js')
-jest.mock('~/src/helpers/logging/logger.js')
+jest.mock('~/src/helpers/logging/logger.js', () => ({
+  logger: {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn()
+  }
+}))
 jest.mock('~/src/config/index.js', () => ({
   config: {
     get: jest.fn(() => {

src/service/notify.js

@@ -2,15 +2,14 @@ import { isFeedbackForm, replaceCustomControllers } from '@defra/forms-model'
 
 import { config } from '~/src/config/index.js'
 import { getBoomErrorMessage } from '~/src/helpers/logging/error-helper.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { getFormDefinition, getFormMetadata } from '~/src/lib/manager.js'
 import { sendNotification } from '~/src/lib/notify.js'
 import { getFormatter } from '~/src/service/mappers/formatters/index.js'
 import { getUserConfirmationEmailBody } from '~/src/service/mappers/user-confirmation.js'
 
 const templateId = config.get('notifyTemplateId')
 const notifyReplyToId = config.get('notifyReplyToId')
-const logger = createLogger()
 
 /**
  * Sends one or more mails to GovNotify

src/service/notify.test.js

@@ -25,11 +25,11 @@ import {
 } from '~/src/service/notify.js'
 
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: () => ({
+  logger: {
     info: jest.fn(),
     error: jest.fn(),
     debug: jest.fn()
-  })
+  }
 }))
 jest.mock('nunjucks', () => {
   const environment = {

src/tasks/receive-messages.js

@@ -1,14 +1,12 @@
 import { getErrorMessage } from '@defra/forms-model'
 
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import {
   receiveEventMessages,
   receiveMessageTimeout
 } from '~/src/messaging/event.js'
 import { handleEvent } from '~/src/service/index.js'
 
-const logger = createLogger()
-
 /**
  * @returns {Promise<void>}
  */

src/tasks/receive-messages.test.js

@@ -7,7 +7,13 @@ import { handleEvent } from '~/src/service/index.js'
 import { runTask, runTaskOnce } from '~/src/tasks/receive-messages.js'
 jest.mock('~/src/messaging/event.js')
 jest.mock('~/src/service/index.js')
-jest.mock('~/src/helpers/logging/logger.js')
+jest.mock('~/src/helpers/logging/logger.js', () => ({
+  logger: {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn()
+  }
+}))
 
 describe('receive-messages', () => {
   const message = /** @type {Message} */ ({