Merge pull request #92 from AthennaIO/develop

feat(driver): add lambda driver

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "4.15.0",
+  "version": "4.16.0",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -61,13 +61,14 @@
     "#tests": "./tests/index.js"
   },
   "dependencies": {
-    "telegraf": "^4.15.3",
-    "cls-rtracer": "^2.6.3"
+    "@aws-lambda-powertools/logger": "^1.18.0",
+    "cls-rtracer": "^2.6.3",
+    "telegraf": "^4.15.3"
   },
   "devDependencies": {
-    "@athenna/common": "^4.32.0",
-    "@athenna/config": "^4.14.0",
-    "@athenna/ioc": "^4.14.0",
+    "@athenna/common": "^4.33.0",
+    "@athenna/config": "^4.15.0",
+    "@athenna/ioc": "^4.15.0",
     "@athenna/test": "^4.21.0",
     "@athenna/tsconfig": "^4.12.0",
     "@typescript-eslint/eslint-plugin": "^6.7.4",

src/constants/VanillaChannels.ts

@@ -37,6 +37,11 @@ export const VANILLA_CHANNELS = {
     formatter: 'cli',
     driver: 'console'
   },
+  lambda: {
+    level: 'trace',
+    formatter: 'json',
+    driver: 'lambda'
+  },
   request: {
     level: 'trace',
     formatter: 'request',

src/drivers/LambdaDriver.ts

@@ -0,0 +1,37 @@
+/**
+ * @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 { debug } from '#src/debug'
+import type { Level } from '#src/types'
+import { Driver } from '#src/drivers/Driver'
+import { logger } from '#src/helpers/AwsLogger'
+
+export class LambdaDriver extends Driver {
+  public transport(level: Level, message: any): any {
+    if (!this.couldBeTransported(level)) {
+      return
+    }
+
+    const levelMap = {
+      info: 'info',
+      warn: 'warn',
+      trace: 'debug',
+      debug: 'debug',
+      error: 'error',
+      success: 'info',
+      fatal: 'critical'
+    }
+
+    const formatted = this.format(levelMap[level], message)
+
+    debug('[%s] Transporting logs using AWS Powertools.', LambdaDriver.name)
+
+    return logger[levelMap[level]](formatted)
+  }
+}

src/factories/DriverFactory.ts

@@ -14,6 +14,7 @@ import { FileDriver } from '#src/drivers/FileDriver'
 import { NullDriver } from '#src/drivers/NullDriver'
 import { SlackDriver } from '#src/drivers/SlackDriver'
 import { StackDriver } from '#src/drivers/StackDriver'
+import { LambdaDriver } from '#src/drivers/LambdaDriver'
 import { ConsoleDriver } from '#src/drivers/ConsoleDriver'
 import { DiscordDriver } from '#src/drivers/DiscordDriver'
 import { FactoryHelper } from '#src/helpers/FactoryHelper'
@@ -31,6 +32,7 @@ export class DriverFactory {
     .set('null', { Driver: NullDriver })
     .set('slack', { Driver: SlackDriver })
     .set('stack', { Driver: StackDriver })
+    .set('lambda', { Driver: LambdaDriver })
     .set('console', { Driver: ConsoleDriver })
     .set('discord', { Driver: DiscordDriver })
     .set('telegram', { Driver: TelegramDriver })

src/helpers/AwsLogger.ts

@@ -0,0 +1,18 @@
+/**
+ * @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 { Logger } from '@aws-lambda-powertools/logger'
+
+/**
+ * Expose the AWS logger to be able to make changes on it.
+ * By default the log level is set to `debug` because the
+ * responsible of deciding if the message should be logged
+ * or not is from Athenna.
+ */
+export const logger = new Logger({ logLevel: 'debug' })

src/index.ts

@@ -7,9 +7,11 @@
  * file that was distributed with this source code.
  */
 
+export * from '#src/types'
 export * from '#src/facades/Log'
 export * from '#src/logger/Logger'
 export * from '#src/drivers/Driver'
+export * from '#src/helpers/AwsLogger'
 export * from '#src/formatters/Formatter'
 export * from '#src/helpers/FactoryHelper'
 export * from '#src/factories/DriverFactory'

src/types/Level.ts

@@ -0,0 +1,17 @@
+/**
+ * @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 type Level =
+  | 'trace'
+  | 'debug'
+  | 'info'
+  | 'success'
+  | 'warn'
+  | 'error'
+  | 'fatal'

src/types/index.ts

@@ -0,0 +1,10 @@
+/**
+ * @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 * from '#src/types/Level'

tests/fixtures/config/logging.ts

@@ -32,7 +32,7 @@ export default {
   | Here you may configure the log channels for your application.
   |
   | Available Drivers:
-  |   "console", "discord", "file", "null", "slack", "telegram".
+  |   "console", "discord", "file", "null", "slack", "telegram", "lambda".
   | Available Formatters:
   |   "cli", "simple", "json", "request", "message", "none".
   |
@@ -48,6 +48,10 @@ export default {
       formatter: 'simple',
       level: 'debug'
     },
+    lambda: {
+      driver: 'lambda',
+      formatter: 'json'
+    },
     request: {
       driver: 'console',
       formatter: 'request',

tests/fixtures/transporters/consoleLambda.ts

@@ -0,0 +1,31 @@
+/**
+ * @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')).copy(Path.config())
+await Config.safeLoad(Path.config('logging.ts'))
+
+new LoggerProvider().register()
+
+const simpleLogger = Log.channel('discard', 'lambda')
+const noneLogger = Log.config({ formatter: 'none' }).channel('discard', 'lambda')
+
+simpleLogger.trace('hello')
+simpleLogger.debug('%s', 'hello')
+simpleLogger.info('hello')
+noneLogger.success('%s', 'hello')
+noneLogger.warn('({yellow,notFound,bold} hello) hello')
+noneLogger.error('%s', 'hello')
+noneLogger.fatal('hello')
+
+await Folder.safeRemove(Path.config())
+await Folder.safeRemove(Path.storage())

tests/unit/drivers/LambdaDriverTest.ts

@@ -0,0 +1,27 @@
+/**
+ * @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 { Path, Exec } from '@athenna/common'
+import { Test, type Context } from '@athenna/test'
+
+export default class LambdaDriverTest {
+  @Test()
+  public async shouldBeAbleToLogInConsoleWithLambdaLib({ assert }: Context) {
+    const { stdout, stderr } = await Exec.node(Path.fixtures('transporters/consoleLambda.ts'))
+
+    const logs = [...stdout.split('\n').filter(l => l !== ''), ...stderr.split('\n').filter(l => l !== '')].filter(
+      v => !v.startsWith('(')
+    )
+
+    logs.forEach(log => {
+      assert.isFalse(log.includes('DEBUG'))
+      assert.isTrue(log.includes('hello'))
+    })
+  }
+}

tests/unit/factories/DriverFactoryTest.ts

@@ -38,7 +38,7 @@ export default class DriverFactoryTest {
   public async shouldBeAbleToListAllAvailableDrivers({ assert }: Context) {
     const drivers = DriverFactory.availableDrivers()
 
-    assert.deepEqual(drivers, ['file', 'null', 'slack', 'stack', 'console', 'discord', 'telegram'])
+    assert.deepEqual(drivers, ['file', 'null', 'slack', 'stack', 'lambda', 'console', 'discord', 'telegram'])
   }
 
   @Test()