feat/df-1026: createLogger() as singleton

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>}

src/routes/admin.test.js

@@ -22,11 +22,11 @@ jest.mock('~/src/tasks/receive-save-and-exit-messages.js')
 jest.mock('~/src/tasks/receive-submission-messages.js')
 jest.mock('~/src/services/submission-service.js')
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: () => ({
+  logger: {
     error: jest.fn(),
     info: jest.fn(),
     debug: jest.fn()
-  })
+  }
 }))
 jest.mock('~/src/messaging/event.js')
 

src/routes/files.test.js

@@ -14,11 +14,11 @@ jest.mock('~/src/services/file-service.js')
 jest.mock('~/src/tasks/receive-save-and-exit-messages.js')
 jest.mock('~/src/tasks/receive-submission-messages.js')
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: () => ({
+  logger: {
     error: jest.fn(),
     info: jest.fn(),
     debug: jest.fn()
-  })
+  }
 }))
 
 describe('Files route', () => {

src/routes/form.test.js

@@ -18,11 +18,11 @@ jest.mock('~/src/tasks/receive-submission-messages.js')
 jest.mock('~/src/services/submission-service.js')
 jest.mock('~/src/services/report.js')
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: () => ({
+  logger: {
     error: jest.fn(),
     info: jest.fn(),
     debug: jest.fn()
-  })
+  }
 }))
 
 describe('Forms route', () => {

src/routes/health.test.js

@@ -4,11 +4,11 @@ jest.mock('~/src/mongo.js')
 jest.mock('~/src/tasks/receive-save-and-exit-messages.js')
 jest.mock('~/src/tasks/receive-submission-messages.js')
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: () => ({
+  logger: {
     error: jest.fn(),
     info: jest.fn(),
     debug: jest.fn()
-  })
+  }
 }))
 
 describe('Health route', () => {

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/services/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/services/httpService.js'
 
 const entitlementUrl = config.get('entitlementUrl')
 const entitlementsEndpoint = new URL('/', entitlementUrl)
-const logger = createLogger()
 
 /**
  * Fetches user scopes from the entitlements API

src/services/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/services/httpService.js')

src/services/expiring-save-and-exit.js

@@ -2,7 +2,7 @@ import { getErrorMessage } from '@defra/forms-model'
 
 import { config } from '~/src/config/index.js'
 import { requireConfig } from '~/src/config/require-config.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 {
   findExpiringRecords,
@@ -13,8 +13,6 @@ import {
 import { getFormMetadataById } from '~/src/services/forms-service.js'
 import { sendNotification } from '~/src/services/notify.js'
 
-const logger = createLogger()
-
 const minimumHoursRemaining = config.get(
   'emailUsersExpiringSoonSavedForLaterLink.minimumHoursRemaining'
 )

src/services/file-service.js

@@ -13,7 +13,7 @@ import contentDisposition from 'content-disposition'
 import { MongoServerError } from 'mongodb'
 
 import { config } from '~/src/config/index.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { isRetrievalKeyCaseSensitive } from '~/src/helpers/retrieval-key/retrieval-key.js'
 import { client as mongoClient } from '~/src/mongo.js'
 import * as repository from '~/src/repositories/file-repository.js'
@@ -23,7 +23,6 @@ import {
 } from '~/src/services/service-helpers.js'
 import { getS3Client } from '~/src/services/utils.js'
 
-const logger = createLogger()
 const loadedPrefix = config.get('loadedPrefix')
 
 const ALREADY_INGESTED = 11000

src/services/notify.js

@@ -2,11 +2,9 @@ import { token } from '@hapi/jwt'
 
 import { config } from '~/src/config/index.js'
 import { requireConfig } from '~/src/config/require-config.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { postJson } from '~/src/services/httpService.js'
 
-const logger = createLogger()
-
 const INT_36 = 36
 const INT_37 = 37
 const INT_73 = 73

src/services/report.js

@@ -1,10 +1,8 @@
 import { FormMetricType, FormStatus, getErrorMessage } from '@defra/forms-model'
 
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { getSubmissionRecordsForDate } from '~/src/repositories/submission-repository.js'
 
-const logger = createLogger()
-
 /**
  * @param {Map<string, number>} map
  * @param {string} formId

src/services/save-and-exit-events.js

@@ -5,14 +5,12 @@ import Joi from 'joi'
 import { config } from '~/src/config/index.js'
 import { requireConfig } from '~/src/config/require-config.js'
 import { getBoomErrorMessage } from '~/src/helpers/error-helper.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { deleteMessage } from '~/src/messaging/event.js'
 import { client } from '~/src/mongo.js'
 import { createSaveAndExitRecord } from '~/src/repositories/save-and-exit-repository.js'
 import { sendNotification } from '~/src/services/notify.js'
 
-const logger = createLogger()
-
 const queueUrl = config.get('saveAndExitQueueUrl')
 const expiryInDays = config.get('saveAndExitExpiryInDays')
 /**

src/services/save-and-exit-events.test.js

@@ -25,11 +25,11 @@ jest.mock('~/src/messaging/event.js')
 jest.mock('~/src/repositories/save-and-exit-repository.js')
 jest.mock('~/src/services/notify.js')
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: () => ({
+  logger: {
     error: jest.fn(),
     info: jest.fn(),
     debug: jest.fn()
-  })
+  }
 }))
 
 jest.mock('~/src/mongo.js', () => {

src/services/save-and-exit-service.js

@@ -2,7 +2,7 @@ import { getErrorMessage } from '@defra/forms-model'
 import Boom from '@hapi/boom'
 import argon2 from 'argon2'
 
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import {
   deleteSaveAndExitGroup,
   getLatestSaveAndExitByGroup,
@@ -11,8 +11,6 @@ import {
   resetSaveAndExitRecord
 } from '~/src/repositories/save-and-exit-repository.js'
 
-const logger = createLogger()
-
 const INVALID_MAGIC_LINK = 'Invalid magic link'
 const CONSUMED_MAGIC_LINK = 'Magic link has already been consumed'
 

src/services/save-and-exit-service.test.js

@@ -18,11 +18,11 @@ import {
 
 jest.mock('~/src/repositories/save-and-exit-repository.js')
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: () => ({
+  logger: {
     error: jest.fn(),
     info: jest.fn(),
     debug: jest.fn()
-  })
+  }
 }))
 
 describe('save-and-exit service', () => {

src/services/scheduler.js

@@ -2,11 +2,9 @@ import { getErrorMessage } from '@defra/forms-model'
 import cron from 'node-cron'
 
 import { config } from '~/src/config/index.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { processExpiringSaveAndExitRecords } from '~/src/services/expiring-save-and-exit.js'
 
-const logger = createLogger()
-
 /**
  * Scheduler service for managing periodic tasks
  */

src/services/scheduler.test.js

@@ -33,12 +33,12 @@ jest.mock('~/src/config/index.js', () => ({
 }))
 
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: () => ({
+  logger: {
     debug: jest.fn(),
     info: jest.fn(),
     warn: jest.fn(),
     error: jest.fn()
-  })
+  }
 }))
 
 jest.mock('~/src/services/notify.js')

src/services/service-helpers.test.js

@@ -13,11 +13,11 @@ import { createCsv, createS3File, getS3Client } from '~/src/services/utils.js'
 jest.mock('~/src/services/utils.js')
 jest.mock('~/src/repositories/file-repository.js')
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: () => ({
+  logger: {
     error: jest.fn(),
     info: jest.fn(),
     debug: jest.fn()
-  })
+  }
 }))
 
 describe('Service Helpers', () => {