Merge pull request #186 from pharindoko/fix/185-pino-pretty

fix(logging): fix error when pino pretty is not found

Author: pharindoko

package-lock.json

@@ -58,6 +58,7 @@
     "@types/lodash": "4.14.149",
     "@types/lowdb": "1.0.9",
     "@types/node": "10.14.16",
+    "@types/pino": "^5.14.0",
     "@types/supertest": "2.0.8",
     "@types/swagger-schema-official": "2.0.20",
     "@types/swagger-ui-express": "4.1.0",

package.json

@@ -22,8 +22,6 @@ custom:
     webpackConfig: 'webpack.config.prod.js'   # Name of webpack configuration file
     includeModules:
       packagePath: './package.json' 
-      forceInclude:
-        - pino-pretty
     packager: 'npm'   # Packager that will be used to package your external modules
     excludeFiles: src/**/*.test.js # Provide a glob for files to ignore
 # The `provider` block defines where your service will be deployed

serverless.yml

@@ -12,7 +12,7 @@ export class CoreApp {
   storageAdapter: StorageAdapter;
   static storage = {} as lowdb.AdapterAsync;
   static adapter = {} as lowdb.LowdbAsync<{}>;
-  logger = new Logger().logger;
+  private prettyPrintLog = false;
   appConfig: AppConfig;
   protected server: express.Express;
   private apispec: ApiSpecification;
@@ -21,12 +21,15 @@ export class CoreApp {
     appConfig: AppConfig,
     server: express.Express,
     storageAdapter: StorageAdapter,
-    apispec: ApiSpecification
+    apispec: ApiSpecification,
+    prettyPrintLog = false
   ) {
     this.appConfig = appConfig;
     this.server = server;
     this.storageAdapter = storageAdapter;
     this.apispec = apispec;
+    this.prettyPrintLog = prettyPrintLog;
+    Logger.init(this.prettyPrintLog);
   }
 
   async setup(): Promise<void> {

src/server/app/core.app.ts

@@ -1,6 +1,6 @@
 import express from 'express';
 import { Logger } from '../utils/logger';
-const logger = new Logger().logger;
+const logger = Logger.getInstance();
 import { CoreApp } from '../app/core.app';
 export abstract class CoreServer {
   core: CoreApp;

src/server/coreserver/server.ts

@@ -26,7 +26,8 @@ export class ServerFactory {
           Environment,
           new FileStorageAdapter(appConfig.jsonFile),
           appConfig,
-          server
+          server,
+          true
         );
         break;
       }
@@ -37,7 +38,8 @@ export class ServerFactory {
           Environment,
           new FileStorageAdapter(appConfig.jsonFile),
           appConfig,
-          server
+          server,
+          true
         );
         break;
       }
@@ -49,7 +51,8 @@ export class ServerFactory {
           DevEnvironment,
           new S3StorageAdapter(environment.s3Bucket, environment.s3File),
           appConfig,
-          server
+          server,
+          true
         );
         break;
       }
@@ -61,7 +64,8 @@ export class ServerFactory {
           DevEnvironment,
           new S3StorageAdapter(environment.s3Bucket, environment.s3File),
           appConfig,
-          server
+          server,
+          true
         );
         break;
       }
@@ -72,7 +76,8 @@ export class ServerFactory {
           Environment,
           new FileStorageAdapter(appConfig.jsonFile),
           appConfig,
-          server
+          server,
+          true
         );
         break;
       }
@@ -84,7 +89,8 @@ export class ServerFactory {
           CloudEnvironment,
           new S3StorageAdapter(environment.s3Bucket, environment.s3File),
           appConfig,
-          server
+          server,
+          false
         );
         break;
       }
@@ -105,13 +111,15 @@ export class ServerFactory {
         appConfig: AppConfig,
         server: express.Express,
         storage: S,
-        specification: ApiSpecification
+        specification: ApiSpecification,
+        prettyPrintLog: boolean
       ): A;
     },
     environment: { new (): E },
     storage: S,
     appConfig: AppConfig,
-    server: express.Express
+    server: express.Express,
+    prettyPrintLog = false
   ): C {
     const env = new environment();
     const swagger = new Swagger(
@@ -121,7 +129,7 @@ export class ServerFactory {
     );
     const core = new coreserver(
       server,
-      new app(appConfig, server, storage, swagger)
+      new app(appConfig, server, storage, swagger, prettyPrintLog)
     );
     return core;
   }

src/server/factory.ts

@@ -11,7 +11,7 @@ import { Output } from '../../utils/output';
 export class Swagger implements ApiSpecification {
   private swaggerSpec = new SwaggerSpec();
   private swaggerDefGen = new SwaggerDefGen();
-  private logger = new Logger().logger;
+  private logger = Logger.getInstance();
   private spec = {} as Spec;
   private server: express.Express;
   private config: SwaggerConfig;

src/server/specifications/swagger/swagger.ts

@@ -1,8 +1,27 @@
+import * as pino from 'pino';
+
 export class Logger {
-  logger = require('pino')(
-    {
-      prettyPrint: { colorize: true },
-    },
-    process.stderr
-  );
+  private static instance: pino.Logger;
+  private constructor() {}
+
+  static init(prettyPrint = false) {
+    Logger.instance = pino.default(
+      {
+        prettyPrint,
+      },
+      process.stderr
+    );
+  }
+
+  static getInstance(): pino.Logger {
+    if (!Logger.instance) {
+      return (Logger.instance = pino.default(
+        {
+          prettyPrint: false,
+        },
+        process.stderr
+      ));
+    }
+    return Logger.instance;
+  }
 }

src/server/utils/logger.ts

@@ -2,12 +2,12 @@ import { Logger } from './logger';
 
 export class Output {
   static setWarning(message: string) {
-    new Logger().logger.warning(message);
+    Logger.getInstance().warning(message);
   }
   static setError(message: string) {
-    new Logger().logger.error(message);
+    Logger.getInstance().error(message);
   }
   static setInfo(message: string) {
-    new Logger().logger.info(message);
+    Logger.getInstance().info(message);
   }
 }