@knowark/loggarkjs 0.3.1 → 0.3.3

package/lib/index.d.ts

@@ -1,10 +1,14 @@
 export declare class Logger {
+  static Logger(): void
+
   constructor (dependencies?: {
     namespace?: string,
-    labels?: object,
+    context?: object,
     global?: object
   })
 
+  context?: object
+
   log(...args: string[]): void
 
   error(...args: string[]): void

package/lib/logger.js

@@ -1,37 +1,48 @@
 export class Logger {
-  constructor ({ namespace = '', labels = null, global = globalThis } = {}) {
+  static context () {
+    return null
+  }
+
+  #context = {}
+
+  constructor ({ namespace = '', context = null, global = globalThis } = {}) {
     const levels = ['error', 'warn', 'info', 'debug']
     const logvar = [namespace, 'LOGLEVEL'].filter(
       Boolean).join('_').toUpperCase().replaceAll(' ', '_')
     const loglevel = String(global[logvar]).toLowerCase()
     this.global = global
     this.logindex = levels.indexOf(loglevel)
-    this.labels = labels
+    this.#context = context
+  }
+
+  get context () {
+    const context = this.constructor.context()
+    return !(context || this.#context) ? null : { ...context, ...this.#context }
   }
 
   log (...args) {
-    if (this.logindex >= 0) log(this.global, 'log', this.labels, args)
+    if (this.logindex >= 0) log(this.global, 'log', this.context, args)
   }
 
   error (...args) {
-    if (this.logindex >= 0) log(this.global, 'error', this.labels, args) 
+    if (this.logindex >= 0) log(this.global, 'error', this.context, args) 
   }
 
   warn (...args) {
-    if (this.logindex >= 1) log(this.global, 'warn', this.labels, args)
+    if (this.logindex >= 1) log(this.global, 'warn', this.context, args)
   }
 
   info (...args) {
-    if (this.logindex >= 2) log(this.global, 'info', this.labels, args)
+    if (this.logindex >= 2) log(this.global, 'info', this.context, args)
   }
 
   debug (...args) {
-    if (this.logindex >= 3) log(this.global, 'debug', this.labels, args)
+    if (this.logindex >= 3) log(this.global, 'debug', this.context, args)
   }
 }
 
-function log (global, level, labels, args) {
+function log (global, level, context, args) {
   return global.console[level](
   `[${level.toUpperCase()}]`,
-  ...[labels ? JSON.stringify(labels) : false, ...args].filter(Boolean))
+  ...[context ? JSON.stringify(context) : false, ...args].filter(Boolean))
 }

package/lib/logger.test.js

@@ -1,104 +1,122 @@
-import { describe, expect, it, beforeEach } from '@jest/globals'
+import { test, expect } from '@jest/globals'
 import { Logger } from './logger.js'
 
-describe('Logger', () => {
-  let mockGlobal = null
-
-  beforeEach(() => {
-    mockGlobal = {
-      console: {
-        log (...args) { mockGlobal.logArgs = args },
-        error (...args) { mockGlobal.errorArgs = args },
-        warn (...args) { mockGlobal.warnArgs = args },
-        info (...args) { mockGlobal.infoArgs = args },
-        debug (...args) { mockGlobal.debugArgs = args }
-      }
+
+function setup () {
+  const mockGlobal = {
+    console: {
+      log (...args) { mockGlobal.logArgs = args },
+      error (...args) { mockGlobal.errorArgs = args },
+      warn (...args) { mockGlobal.warnArgs = args },
+      info (...args) { mockGlobal.infoArgs = args },
+      debug (...args) { mockGlobal.debugArgs = args }
     }
-  })
-
-  it('can be instantiated', () => {
-    const logger = new Logger()
-    expect(logger).toBeTruthy()
-  })
-
-  it('can be instantiated', () => {
-    const logger = new Logger()
-    expect(logger).toBeTruthy()
-  })
-
-  it('is disabled by default', () => {
-    const logger = new Logger({ global: mockGlobal })
-
-    logger.log('Logging something...')
-    expect(mockGlobal.logArgs).toBeFalsy()
-
-    logger.error('Logging something...')
-    expect(mockGlobal.errorArgs).toBeFalsy()
-
-    logger.warn('Logging something...')
-    expect(mockGlobal.warnArgs).toBeFalsy()
-
-    logger.info('Logging something...')
-    expect(mockGlobal.infoArgs).toBeFalsy()
-
-    logger.debug('Logging something...')
-    expect(mockGlobal.debugArgs).toBeFalsy()
-  })
-
-  it('adds a prefix to the logging methods according to loglevel', () => {
-    mockGlobal.LOGLEVEL = 'debug'
-    const logger = new Logger({ global: mockGlobal })
-
-    logger.log('Logging something...')
-    expect(mockGlobal.logArgs).toEqual(['[LOG]', 'Logging something...'])
-
-    logger.error('Logging something...')
-    expect(mockGlobal.errorArgs).toEqual(['[ERROR]', 'Logging something...'])
-
-    logger.warn('Logging something...')
-    expect(mockGlobal.warnArgs).toEqual(['[WARN]', 'Logging something...'])
-
-    logger.info('Logging something...')
-    expect(mockGlobal.infoArgs).toEqual(['[INFO]', 'Logging something...'])
-
-    logger.debug('Logging something...')
-    expect(mockGlobal.debugArgs).toEqual(['[DEBUG]', 'Logging something...'])
-  })
-
-  it('adds the provided logging labels to its final output', () => {
-    mockGlobal.LOGLEVEL = 'debug'
-    const labels = { correlationId: 'ABCD1234' }
-    const logger = new Logger({ global: mockGlobal, labels })
-
-    logger.log('Logging something...')
-    expect(mockGlobal.logArgs).toEqual([
-      '[LOG]',
-      JSON.stringify({ correlationId: 'ABCD1234' }),
-      'Logging something...'])
-
-    logger.labels.interactor = 'Informer'
-    logger.error('Logging something...')
-    expect(mockGlobal.errorArgs).toEqual([
-      '[ERROR]', 
-      JSON.stringify({ correlationId: 'ABCD1234', interactor: 'Informer' }),
-      'Logging something...'])
-
-    logger.warn('Logging something...')
-    expect(mockGlobal.warnArgs).toEqual([
-      '[WARN]', 
-      JSON.stringify({ correlationId: 'ABCD1234', interactor: 'Informer' }),
-      'Logging something...'])
-
-    logger.info('Logging something...')
-    expect(mockGlobal.infoArgs).toEqual([
-      '[INFO]', 
-      JSON.stringify({ correlationId: 'ABCD1234', interactor: 'Informer' }),
-      'Logging something...'])
-
-    logger.debug('Logging something...')
-    expect(mockGlobal.debugArgs).toEqual([
-      '[DEBUG]',
-      JSON.stringify({ correlationId: 'ABCD1234', interactor: 'Informer' }),
-      'Logging something...'])
-  })
+  }
+  return {mockGlobal}
+}
+
+test('can be instantiated', () => {
+  const logger = new Logger()
+  expect(logger).toBeTruthy()
+})
+
+test('can be instantiated', () => {
+  const logger = new Logger()
+  expect(logger).toBeTruthy()
+})
+
+test('is disabled by default', () => {
+  const { mockGlobal } = setup()
+  const logger = new Logger({ global: mockGlobal })
+
+  logger.log('Logging something...')
+  expect(mockGlobal.logArgs).toBeFalsy()
+
+  logger.error('Logging something...')
+  expect(mockGlobal.errorArgs).toBeFalsy()
+
+  logger.warn('Logging something...')
+  expect(mockGlobal.warnArgs).toBeFalsy()
+
+  logger.info('Logging something...')
+  expect(mockGlobal.infoArgs).toBeFalsy()
+
+  logger.debug('Logging something...')
+  expect(mockGlobal.debugArgs).toBeFalsy()
+})
+
+test('adds a prefix to the logging methods according to loglevel', () => {
+  const { mockGlobal } = setup()
+  mockGlobal.LOGLEVEL = 'debug'
+  const logger = new Logger({ global: mockGlobal })
+
+  logger.log('Logging something...')
+  expect(mockGlobal.logArgs).toEqual(['[LOG]', 'Logging something...'])
+
+  logger.error('Logging something...')
+  expect(mockGlobal.errorArgs).toEqual(['[ERROR]', 'Logging something...'])
+
+  logger.warn('Logging something...')
+  expect(mockGlobal.warnArgs).toEqual(['[WARN]', 'Logging something...'])
+
+  logger.info('Logging something...')
+  expect(mockGlobal.infoArgs).toEqual(['[INFO]', 'Logging something...'])
+
+  logger.debug('Logging something...')
+  expect(mockGlobal.debugArgs).toEqual(['[DEBUG]', 'Logging something...'])
 })
+
+test('adds the provided logging context labels to its final output', () => {
+  const { mockGlobal } = setup()
+  mockGlobal.LOGLEVEL = 'debug'
+  const context = { correlationId: 'ABCD1234', interactor: 'Informer' }
+  const logger = new Logger({ global: mockGlobal, context })
+
+  logger.log('Logging something...')
+  expect(mockGlobal.logArgs).toEqual([
+    '[LOG]',
+    JSON.stringify({ correlationId: 'ABCD1234', interactor: 'Informer' }),
+    'Logging something...'])
+
+  logger.error('Logging something...')
+  expect(mockGlobal.errorArgs).toEqual([
+    '[ERROR]', 
+    JSON.stringify({ correlationId: 'ABCD1234', interactor: 'Informer' }),
+    'Logging something...'])
+
+  logger.warn('Logging something...')
+  expect(mockGlobal.warnArgs).toEqual([
+    '[WARN]', 
+    JSON.stringify({ correlationId: 'ABCD1234', interactor: 'Informer' }),
+    'Logging something...'])
+
+  logger.info('Logging something...')
+  expect(mockGlobal.infoArgs).toEqual([
+    '[INFO]', 
+    JSON.stringify({ correlationId: 'ABCD1234', interactor: 'Informer' }),
+    'Logging something...'])
+
+  logger.debug('Logging something...')
+  expect(mockGlobal.debugArgs).toEqual([
+    '[DEBUG]',
+    JSON.stringify({ correlationId: 'ABCD1234', interactor: 'Informer' }),
+    'Logging something...'])
+})
+
+test('supports including static context labels', () => {
+  Logger.context = () => {
+    return { correlationId: 'ABCD1234' }
+  }
+
+  const { mockGlobal } = setup()
+  mockGlobal.LOGLEVEL = 'debug'
+  const context = { model: 'Product' }
+  const logger = new Logger({ global: mockGlobal, context })
+
+  logger.info('Logging something...')
+  expect(mockGlobal.infoArgs).toEqual([
+    '[INFO]',
+    JSON.stringify({ correlationId: 'ABCD1234', model: 'Product' }),
+    'Logging something...'])
+
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowark/loggarkjs",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Utilitarian Logging Library",
   "main": "./lib/index.js",
   "type": "module",