From f1fd191d068182293af8261986ce43b442bb95ca Mon Sep 17 00:00:00 2001
From: Jay McDoniel <jmcdo29@gmail.com>
Date: Sun, 25 Oct 2020 14:24:31 -0700
Subject: [PATCH] fix(service): fixes logger methods to follow `LoggerService`
 interface

`OgmaService` methods now adhere to NestJS\'s `LoggerService`
interface, but still _can_ accept an object as the second parameter.
This will allow `app.setLogger(OgmaService)` to work properly, but
still allow for extra metadata to be logged in services.
---
 .codebeatignore                            |  2 ++
 packages/nestjs-module/src/ogma.service.ts | 40 +++++++++++++++++-----
 2 files changed, 33 insertions(+), 9 deletions(-)
 create mode 100644 .codebeatignore

diff --git a/.codebeatignore b/.codebeatignore
new file mode 100644
index 000000000..bb2888395
--- /dev/null
+++ b/.codebeatignore
@@ -0,0 +1,2 @@
+benchmarks/*
+tools/*
diff --git a/packages/nestjs-module/src/ogma.service.ts b/packages/nestjs-module/src/ogma.service.ts
index 7fa32078a..2b257d83d 100644
--- a/packages/nestjs-module/src/ogma.service.ts
+++ b/packages/nestjs-module/src/ogma.service.ts
@@ -1,11 +1,11 @@
-import { Injectable, Optional } from '@nestjs/common';
+import { Injectable, LoggerService, Optional } from '@nestjs/common';
 import { Ogma } from '@ogma/logger';
 import { InjectOgma, InjectOgmaContext } from './decorators';
 import { OgmaServiceMeta } from './interfaces';
 import { RequestContext } from './interfaces/request-context.interface';
 
 @Injectable()
-export class OgmaService {
+export class OgmaService implements LoggerService {
   private readonly context?: string;
   private readonly ogma: Ogma;
 
@@ -45,7 +45,11 @@ export class OgmaService {
    * @param context Optional context if you want to change what the original context was
    * @param requestId Optional id of an request
    */
-  public info(message: any, meta?: OgmaServiceMeta): void {
+
+  public info(message: any, meta?: OgmaServiceMeta | string): void {
+    if (typeof meta === 'string') {
+      meta = { context: meta };
+    }
     this.printMessage(message, 'info', meta);
   }
 
@@ -54,7 +58,10 @@ export class OgmaService {
    * @param message What to print to the Ogma instance
    * @param context Optional context if you want to change what the original context was
    */
-  public error(message: any, meta?: OgmaServiceMeta): void {
+  public error(message: any, meta?: OgmaServiceMeta | string): void {
+    if (typeof meta === 'string') {
+      meta = { context: meta };
+    }
     this.printMessage(message, 'error', meta);
   }
 
@@ -64,7 +71,10 @@ export class OgmaService {
    * @param context Optional context if you want to change what the original context was
    * @param requestId Optional id of an request
    */
-  public warn(message: any, meta?: OgmaServiceMeta): void {
+  public warn(message: any, meta?: OgmaServiceMeta | string): void {
+    if (typeof meta === 'string') {
+      meta = { context: meta };
+    }
     this.printMessage(message, 'warn', meta);
   }
 
@@ -74,7 +84,10 @@ export class OgmaService {
    * @param context Optional context if you want to change what the original context was
    * @param requestId Optional id of an request
    */
-  public debug(message: any, meta?: OgmaServiceMeta): void {
+  public debug(message: any, meta?: OgmaServiceMeta | string): void {
+    if (typeof meta === 'string') {
+      meta = { context: meta };
+    }
     this.printMessage(message, 'debug', meta);
   }
 
@@ -84,7 +97,10 @@ export class OgmaService {
    * @param context Optional context if you want to change what the original context was
    * @param requestId Optional id of an request
    */
-  public fatal(message: any, meta?: OgmaServiceMeta): void {
+  public fatal(message: any, meta?: OgmaServiceMeta | string): void {
+    if (typeof meta === 'string') {
+      meta = { context: meta };
+    }
     this.printMessage(message, 'fatal', meta);
   }
 
@@ -94,7 +110,10 @@ export class OgmaService {
    * @param context Optional context if you want to change what the original context was
    * @param requestId Optional id of an request
    */
-  public silly(message: any, meta?: OgmaServiceMeta): void {
+  public silly(message: any, meta?: OgmaServiceMeta | string): void {
+    if (typeof meta === 'string') {
+      meta = { context: meta };
+    }
     this.printMessage(message, 'silly', meta);
   }
 
@@ -104,7 +123,10 @@ export class OgmaService {
    * @param context Optional context if you want to change what the original context was
    * @param requestId Optional id of an request
    */
-  public verbose(message: any, meta?: OgmaServiceMeta): void {
+  public verbose(message: any, meta?: OgmaServiceMeta | string): void {
+    if (typeof meta === 'string') {
+      meta = { context: meta };
+    }
     this.printMessage(message, 'verbose', meta);
   }