Merge pull request #509 from DEFRA/feat/df-1026-max-listeners

feat/df-1026: createLogger() as singleton

Author: jbarnsley10

src/api/server.js

@@ -7,7 +7,7 @@ import { ProxyAgent } from 'proxy-agent'
 
 import { config } from '~/src/config/index.js'
 import { failAction } from '~/src/helpers/fail-action.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { requestTracing } from '~/src/helpers/request-tracing.js'
 import { prepareDb } from '~/src/mongo.js'
 import { auth } from '~/src/plugins/auth/index.js'
@@ -21,8 +21,6 @@ import { prepareSecureContext } from '~/src/secure-context.js'
 import { runTask as runSaveAndExitTask } from '~/src/tasks/receive-save-and-exit-messages.js'
 import { runTask as runSubmissionTask } from '~/src/tasks/receive-submission-messages.js'
 
-const logger = createLogger()
-
 const isProduction = config.get('isProduction')
 
 const proxyAgent = new ProxyAgent()

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

@@ -5,16 +5,14 @@ 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/tasks/sqs.js'
 
 export const receiveMessageTimeout = config.get('receiveMessageTimeout')
 
 const maxNumberOfMessages = config.get('maxNumberOfMessages')
 const visibilityTimeout = config.get('visibilityTimeout')
 
-const logger = createLogger()
-
 /**
  * @param {string} dlqName
  */

src/plugins/auth/index.js

@@ -2,7 +2,7 @@ import Boom from '@hapi/boom'
 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/services/entitlements-service.js'
 
 const oidcJwksUri = config.get('oidcJwksUri')
@@ -30,8 +30,6 @@ const cognitoClientIds = Object.fromEntries(
   ])
 )
 
-const logger = createLogger()
-
 /**
  * @satisfies {ServerRegisterPluginObject<void>}
  */

src/plugins/scheduler.test.js

@@ -3,11 +3,11 @@ const mockWarnFn = jest.fn()
 const mockInfoFn = jest.fn()
 
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: jest.fn().mockReturnValue({
+  logger: {
     error: mockErrorFn,
     warn: mockWarnFn,
     info: mockInfoFn
-  })
+  }
 }))
 
 const mockInitialiseEmailExpiringSoonScheduler = jest.fn()

src/repositories/file-repository.js

@@ -1,8 +1,6 @@
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { FILES_COLLECTION_NAME, db } from '~/src/mongo.js'
 
-const logger = createLogger()
-
 /**
  * Adds a file status to the database
  * @param {FormFileUploadStatus} fileStatus - file status

src/repositories/save-and-exit-repository.js

@@ -5,11 +5,10 @@ import Boom from '@hapi/boom'
 
 import { config } from '~/src/config/index.js'
 import { addDays } from '~/src/helpers/date-helper.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { createTimer } from '~/src/helpers/timer.js'
 import { SAVE_AND_EXIT_COLLECTION_NAME, db } from '~/src/mongo.js'
 
-const logger = createLogger()
 const expiryInDays = config.get('saveAndExitExpiryInDays')
 
 export const saveAndExitLabel = 'save-and-exit'

src/repositories/submission-repository.js

@@ -1,10 +1,8 @@
 import { getErrorMessage } from '@defra/forms-model'
 
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { SUBMISSIONS_COLLECTION_NAME, db } from '~/src/mongo.js'
 
-const logger = createLogger()
-
 /**
  * Gets submission records based on formId
  * @param {string} formId - the form id

src/routes/admin.js

@@ -1,7 +1,7 @@
 import { Scopes, idSchema } 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,
@@ -24,8 +24,6 @@ import {
 
 const OK_RESPONSE = 200
 
-const logger = createLogger()
-
 export default [
   /**
    * @satisfies {ServerRoute<ResetSaveAndExit>}