@knowark/loggarkjs 0.1.2 → 0.3.0

package/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "workbench.colorCustomizations": {
+    "activityBar.background": "#2C2D34",
+    "titleBar.activeBackground": "#3E3F49",
+    "titleBar.activeForeground": "#FAFAFB"
+  }
+}

package/lib/index.d.ts

@@ -4,6 +4,8 @@ export declare class Logger {
     global?: object
   })
 
+  log(...args: string[]): void
+
   error(...args: string[]): void
 
   warn(...args: string[]): void

package/lib/logger.js

@@ -1,26 +1,37 @@
 export class Logger {
-  constructor ({ namespace = '', global = globalThis } = {}) {
+  constructor ({ namespace = '', labels = 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
+  }
+
+  log (...args) {
+    if (this.logindex >= 0) log(this.global, 'log', this.labels, args)
   }
 
   error (...args) {
-    if (this.logindex >= 0) this.global.console.error('[ERROR]', ...args)
+    if (this.logindex >= 0) log(this.global, 'error', this.labels, args) 
   }
 
   warn (...args) {
-    if (this.logindex >= 1) this.global.console.warn('[WARN]', ...args)
+    if (this.logindex >= 1) log(this.global, 'warn', this.labels, args)
   }
 
   info (...args) {
-    if (this.logindex >= 2) this.global.console.info('[INFO]', ...args)
+    if (this.logindex >= 2) log(this.global, 'info', this.labels, args)
   }
 
   debug (...args) {
-    if (this.logindex >= 3) this.global.console.debug('[DEBUG]', ...args)
+    if (this.logindex >= 3) log(this.global, 'debug', this.labels, args)
   }
 }
+
+function log (global, level, labels, args) {
+  return global.console[level](
+  `[${level.toUpperCase()}]`,
+  ...[labels ? JSON.stringify(labels) : false, ...args].filter(Boolean))
+}

package/lib/logger.test.js

@@ -1,21 +1,13 @@
 import { describe, expect, it, beforeEach } from '@jest/globals'
 import { Logger } from './logger.js'
 
-const mockGlobal = {
-  console: {
-    error (...args) { mockGlobal.erroArgs = args },
-    warn (...args) { mockGlobal.warnArgs = args },
-    info (...args) { mockGlobal.infoArgs = args },
-    debug (...args) { mockGlobal.debugArgs = args }
-  }
-}
-
 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 },
@@ -37,6 +29,9 @@ describe('Logger', () => {
   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()
 
@@ -54,6 +49,9 @@ describe('Logger', () => {
     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...'])
 
@@ -66,4 +64,41 @@ describe('Logger', () => {
     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...'])
+  })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowark/loggarkjs",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "Utilitarian Logging Library",
   "main": "./lib/index.js",
   "type": "module",
@@ -23,6 +23,6 @@
   },
   "homepage": "https://github.com/knowark/loggarkjs#readme",
   "devDependencies": {
-    "jest": "^29.1.1"
+    "jest": "^29.7.0"
   }
 }