Merge pull request #1134 from AletheiaFact/winston-logging-implementa…

…tion

Implementation of winston logging library

package.json

@@ -155,6 +155,7 @@
     "socket.io": "^4.7.2",
     "storybook": "^7.4.5",
     "styled-components": "^5.3.0",
+    "winston": "^3.13.0",
     "ws": "^8.13.0",
     "xstate": "^4.32.1",
     "y-protocols": "^1.0.5",

server/main.ts

@@ -2,10 +2,11 @@ import { NestFactory } from "@nestjs/core";
 import { AppModule } from "./app.module";
 import { join } from "path";
 import { NestExpressApplication } from "@nestjs/platform-express";
-import { ValidationPipe, Logger } from "@nestjs/common";
+import { ValidationPipe } from "@nestjs/common";
 import { SwaggerModule, DocumentBuilder } from "@nestjs/swagger";
 import loadConfig from "./configLoader";
 import * as dotenv from "dotenv";
+import { WinstonLogger } from "./winstonLogger";
 const cookieParser = require("cookie-parser");
 const mongoose = require("mongoose");
 dotenv.config();
@@ -25,11 +26,13 @@ async function initApp() {
         allowedHeaders: ["accept", "x-requested-with", "content-type"],
     };
 
-    const logger = new Logger();
+    const logger = new WinstonLogger();
+
     const app = await NestFactory.create<NestExpressApplication>(
         AppModule.register(options),
         {
             bodyParser: false,
+            logger: logger,
             cors: corsOptions,
         }
     );
@@ -68,7 +71,6 @@ async function initApp() {
     });
     await app.listen(options.port);
     logger.log(
-        "info",
         `${options.name} with PID ${process.pid} listening on ${
             options.interface || "*"
         }:${options.port}`

server/personality/personality.module.ts

@@ -8,7 +8,7 @@ import { ClaimReviewModule } from "../claim-review/claim-review.module";
 import { ClaimRevisionModule } from "../claim/claim-revision/claim-revision.module";
 import { HistoryModule } from "../history/history.module";
 import { PersonalityController } from "./personality.controller";
-import Logger from "../logger";
+import { WinstonLogger } from "../winstonLogger";
 import { ViewModule } from "../view/view.module";
 import { ConfigModule } from "@nestjs/config";
 import { CaptchaModule } from "../captcha/captcha.module";
@@ -34,7 +34,7 @@ const PersonalityModel = MongooseModule.forFeature([
         CaptchaModule,
     ],
     exports: [PersonalityService],
-    providers: [UtilService, PersonalityService, Logger],
+    providers: [UtilService, PersonalityService, WinstonLogger],
     controllers: [PersonalityController],
 })
 export class PersonalityModule {}

server/seed.ts

@@ -1,22 +1,22 @@
 import { NestFactory } from "@nestjs/core";
 import { AppModule } from "./app.module";
-import { Logger } from "@nestjs/common";
 import { NestExpressApplication } from "@nestjs/platform-express";
 import { EmailService } from "./email/email.service";
 import { ConfigService } from "@nestjs/config";
 import { UsersService } from "./users/users.service";
 import { UtilService } from "./util";
 import loadConfig from "./configLoader";
+import { WinstonLogger } from "./winstonLogger";
 
 async function initApp() {
     const options = loadConfig();
 
-    const logger = new Logger();
+    const logger = new WinstonLogger();
     const app = await NestFactory.create<NestExpressApplication>(
         AppModule.register(options)
     );
 
-    logger.log("info", `AppModule loaded`);
+    logger.log(`AppModule loaded`);
     const emailService = app.get(EmailService);
     const configService = app.get(ConfigService);
     const userService = app.get(UsersService);
@@ -28,7 +28,7 @@ async function initApp() {
         return userService
             .register({ ...userData, password })
             .then(async (user) => {
-                logger.log("info", `${userData.email} seeded`);
+                logger.log(`${userData.email} seeded`);
                 if (userData.sendAuthDetails && !disableSMTP) {
                     const emailResponse = await emailService.sendEmail(
                         userData.email,
@@ -37,14 +37,14 @@ async function initApp() {
                         { ...userData, password },
                         "./templates/userSeed.html"
                     );
-                    logger.log("info", emailResponse);
-                    logger.log("info", `E-mail sent to ${userData.email}`);
+                    logger.log(emailResponse);
+                    logger.log(`E-mail sent to ${userData.email}`);
                 }
                 return user;
             })
             .catch((e) => {
-                logger.log("error", e);
-                logger.log("info", `Error while seeding ${userData.email}`);
+                logger.error("error", e);
+                logger.log(`Error while seeding ${userData.email}`);
                 return null;
             });
     };
@@ -59,7 +59,7 @@ async function initApp() {
         })
     );
 
-    logger.log("info", "Seed is finished");
+    logger.log("Seed is finished");
     await app.close();
 }
 

server/websocket.ts

@@ -2,13 +2,13 @@ import { NestExpressApplication } from "@nestjs/platform-express";
 import { NestFactory } from "@nestjs/core";
 import { WebsocketModule } from "./yjs-websocket/websocket.module";
 import { WsAdapter } from "@nestjs/platform-ws";
-import { Logger } from "@nestjs/common";
 import loadConfig from "./configLoader";
+import { WinstonLogger } from "./winstonLogger";
 
 async function initApp() {
     const options = loadConfig();
 
-    const logger = new Logger();
+    const logger = new WinstonLogger();
     const app = await NestFactory.create<NestExpressApplication>(
         WebsocketModule.register(options)
     );
@@ -18,7 +18,6 @@ async function initApp() {
     await app.listen(options.port);
 
     logger.log(
-        "info",
         `${options.name} with PID ${process.pid} listening on ${
             options.interface || "*"
         }:${options.port}`

server/winstonLogger.ts

@@ -0,0 +1,36 @@
+import { LoggerService } from "@nestjs/common";
+import * as winston from "winston";
+
+export class WinstonLogger implements LoggerService {
+    private logger: winston.Logger;
+
+    constructor() {
+        this.logger = winston.createLogger({
+            transports: [
+                new winston.transports.Console({
+                    format: winston.format.combine(winston.format.json()),
+                }),
+            ],
+        });
+    }
+
+    log(message: string, context?: string) {
+        this.logger.info(message, { context });
+    }
+
+    error(message: string, trace: string, context?: string) {
+        this.logger.error(message, { trace, context });
+    }
+
+    warn(message: string, context?: string) {
+        this.logger.warn(message, { context });
+    }
+
+    debug(message: string, context?: string) {
+        this.logger.debug(message, { context });
+    }
+
+    verbose(message: string, context?: string) {
+        this.logger.verbose(message, { context });
+    }
+}