createLogger() as a singleton

Author: jbarnsley10

src/api/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/api/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/api/forms/repositories/form-definition-repository.js

@@ -34,11 +34,9 @@ import {
   modifyUpdatePageFields,
   removeById
 } from '~/src/api/forms/repositories/helpers.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { DEFINITION_COLLECTION_NAME, db } from '~/src/mongo.js'
 
-const logger = createLogger()
-
 /**
  * Adds a form to the Form Store
  * @param {string} id - id

src/api/forms/repositories/form-metadata-repository.js

@@ -15,13 +15,11 @@ import {
   MongoError,
   partialAuditFields
 } from '~/src/api/forms/service/shared.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { METADATA_COLLECTION_NAME, db } from '~/src/mongo.js'
 
 export const MAX_RESULTS = 100
 
-const logger = createLogger()
-
 /**
  * Retrieves the list of documents from the database
  */

src/api/forms/repositories/form-metadata-repository.test.js

@@ -70,10 +70,10 @@ jest.mock('~/src/mongo.js', () => {
 })
 
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: () => ({
+  logger: {
     error: jest.fn(),
     info: jest.fn()
-  })
+  }
 }))
 
 describe('form-metadata-repository', () => {

src/api/forms/repositories/form-versions-repository.js

@@ -1,13 +1,11 @@
 import { getErrorMessage } from '@defra/forms-model'
 import Boom from '@hapi/boom'
 
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { VERSIONS_COLLECTION_NAME, db } from '~/src/mongo.js'
 
 export const MAX_VERSIONS = 100
 
-const logger = createLogger()
-
 /**
  * Creates a new form version in the database
  * @param {FormVersionDocument} versionDocument - The form version document to create

src/api/forms/repositories/helpers.js

@@ -22,13 +22,11 @@ import * as formMetadataRepository from '~/src/api/forms/repositories/form-metad
 import * as formVersionsRepository from '~/src/api/forms/repositories/form-versions-repository.js'
 import { validate } from '~/src/api/forms/service/helpers/definition.js'
 import { repositionPaymentAndSummary } from '~/src/api/forms/service/migration-helpers.js'
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { DEFINITION_COLLECTION_NAME, db } from '~/src/mongo.js'
 
 export const FORM_VERSION_METADATA_KEY = '$$__formVersion'
 
-const logger = createLogger()
-
 /**
  * Removes a row in a MongoDB collection by its unique ID and fail if not completed.
  * @param {ClientSession} session

src/api/forms/repositories/secrets-repository.js

@@ -2,13 +2,11 @@ import { getErrorMessage } from '@defra/forms-model'
 import Boom from '@hapi/boom'
 import { MongoServerError } from 'mongodb'
 
-import { createLogger } from '~/src/helpers/logging/logger.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { SECRETS_COLLECTION_NAME, db } from '~/src/mongo.js'
 
 export const MAX_RESULTS = 100
 
-const logger = createLogger()
-
 /**
  * Retrieves a form secret by form id and secret name
  * @param {string} formId - ID of the form

src/api/forms/repositories/secrets-repository.test.js

@@ -58,12 +58,12 @@ const mockLoggerInfo = jest.fn()
 const mockLoggerWarn = jest.fn()
 
 jest.mock('~/src/helpers/logging/logger.js', () => ({
-  createLogger: jest.fn().mockReturnValue({
+  logger: {
     // @ts-expect-error - error handling uses any type
     error: (err, message) => mockLoggerError(err, message),
     warn: () => mockLoggerWarn(),
     info: () => mockLoggerInfo()
-  })
+  }
 }))
 
 describe('secrets-repository', () => {

src/api/forms/service/component.js

@@ -10,7 +10,7 @@ import * as formMetadata from '~/src/api/forms/repositories/form-metadata-reposi
 import { findComponent } from '~/src/api/forms/repositories/helpers.js'
 import { getFormDefinition } from '~/src/api/forms/service/definition.js'
 import { getFormDefinitionPage } from '~/src/api/forms/service/page.js'
-import { logger } from '~/src/api/forms/service/shared.js'
+import { logger } from '~/src/helpers/logging/logger.js'
 import { publishFormUpdatedEvent } from '~/src/messaging/publish.js'
 import { client } from '~/src/mongo.js'