Merge pull request #126 from AthennaIO/develop

fix: adjust formatter defaults for stack driver

Author: jlenon7

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "5.16.0",
+  "version": "5.17.0",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

package.json

@@ -10,14 +10,22 @@
 import { debug } from '#src/debug'
 import { Json } from '@athenna/common'
 import { Driver } from '#src/drivers/Driver'
+import { FactoryHelper } from '#src/helpers/FactoryHelper'
 import { DriverFactory } from '#src/factories/DriverFactory'
 
 export class StackDriver extends Driver {
   public transport(level: string, message: any): Promise<any> {
     const configs = Json.copy(this.configs)
+    const sharedConfigs = Json.copy(this.configs)
 
     delete configs.driver
     delete configs.channels
+    delete sharedConfigs.driver
+    delete sharedConfigs.channels
+
+    this.driverConfig.channels.forEach(channel => {
+      delete sharedConfigs[channel]
+    })
 
     debug(
       '[%s] Transporting logs in channels: %s.',
@@ -26,7 +34,10 @@ export class StackDriver extends Driver {
     )
 
     const promises = this.driverConfig.channels.map(channel => {
-      const channelConfig = configs?.[channel]
+      const channelConfig = FactoryHelper.groupConfigs(
+        configs?.[channel] || {},
+        sharedConfigs
+      )
 
       return DriverFactory.fabricate(channel, channelConfig).transport(
         level,

src/drivers/StackDriver.ts

@@ -0,0 +1,23 @@
+/**
+ * @athenna/logger
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export default {
+  default: 'stack',
+  channels: {
+    stack: {
+      driver: 'stack',
+      channels: ['simple']
+    },
+    simple: {
+      driver: 'console',
+      formatter: 'json',
+      level: 'trace'
+    }
+  }
+}

tests/fixtures/config-stack-defaults/logging.ts

@@ -16,7 +16,7 @@ await Config.safeLoad(Path.config('logging.ts'))
 
 new LoggerProvider().register()
 
-const logger = Log.config({ formatter: 'json' }).create({ namespace: 'UserService' }).channel('application')
+const logger = Log.config({ formatter: 'json' }).create({ namespace: 'UserService' })
 
 logger.error('failed to retrieve user')
 

tests/fixtures/transporters/loggerCreate.ts

@@ -0,0 +1,24 @@
+/**
+ * @athenna/logger
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { Config } from '@athenna/config'
+import { Log, LoggerProvider } from '#src'
+import { Folder, Path } from '@athenna/common'
+
+await new Folder(Path.fixtures('config-stack-defaults')).copy(Path.config())
+await Config.safeLoad(Path.config('logging.ts'))
+
+new LoggerProvider().register()
+
+const logger = Log.create({ namespace: 'UserService' })
+
+logger.error('failed to retrieve user')
+
+await Folder.safeRemove(Path.config())
+await Folder.safeRemove(Path.storage())

tests/fixtures/transporters/loggerCreateStack.ts

@@ -39,6 +39,20 @@ export default class LoggerTest {
     assert.equal(message.namespace, 'UserService')
   }
 
+  @Test()
+  public async shouldBeAbleToCreateLoggerWithDefaultMessageContentUsingStackChannel({ assert }: Context) {
+    const { stdout, stderr } = await Exec.node(Path.fixtures('transporters/loggerCreateStack.ts'))
+
+    const logs = [...stdout.split('\n').filter(l => l !== ''), ...stderr.split('\n').filter(l => l !== '')].filter(
+      v => !v.startsWith('(')
+    )
+    const message = JSON.parse(logs[0])
+
+    assert.equal(message.msg, 'failed to retrieve user')
+    assert.equal(message.level, 'error')
+    assert.equal(message.namespace, 'UserService')
+  }
+
   @Test()
   public async shouldBeAbleToReapplyDriversWhenConfigIsCalledAfterChannel({ assert }: Context) {
     const { stdout, stderr } = await Exec.node(Path.fixtures('transporters/loggerChannelConfig.ts'))