Merge PR: Use Winston logger and refine some logs

Author: hussein-m-kandil

package-lock.json

@@ -53,6 +53,7 @@
     "passport": "^0.7.0",
     "passport-jwt": "^4.0.1",
     "passport-local": "^1.0.0",
+    "winston": "^3.17.0",
     "zod": "^3.24.3"
   },
   "devDependencies": {

package.json

@@ -1,11 +1,12 @@
-import logger from './logger';
-
-if (!process.env.SECRET) logger.error('Missing Env Var: SECRET');
-if (!process.env.ADMIN_SECRET) logger.error('Missing Env Var: ADMIN_SECRET');
+if (!process.env.NODE_ENV) console.warn('Miss Env Var: NODE_ENV');
+if (!process.env.SECRET) console.error('Missing Env Var: SECRET');
+if (!process.env.ADMIN_SECRET) console.error('Missing Env Var: ADMIN_SECRET');
 
 export const SALT = (Number(process.env.SALT) || process.env.SALT) ?? 10;
 export const SECRET = process.env.SECRET ?? 'secret';
 export const ADMIN_SECRET = process.env.ADMIN_SECRET ?? 'admin_secret';
 export const TOKEN_EXP_PERIOD = process.env.TOKEN_EXP_PERIOD ?? '3d';
+export const NODE_ENV = process.env.NODE_ENV;
+export const CI = Boolean(process.env.CI);
 
-export default { SALT, SECRET, ADMIN_SECRET, TOKEN_EXP_PERIOD };
+export default { SALT, SECRET, ADMIN_SECRET, TOKEN_EXP_PERIOD, NODE_ENV, CI };

src/lib/config.ts

@@ -6,7 +6,6 @@ const globalForPrisma = global as GlobalWithPrisma;
 
 export let prismaClient: PrismaClient;
 
-logger.info();
 logger.info(`using prisma client in ${process.env.NODE_ENV} mode`);
 
 if (globalForPrisma.prisma) {
@@ -29,6 +28,4 @@ if (process.env.NODE_ENV !== 'production') {
   globalForPrisma.prisma = prismaClient;
 }
 
-logger.info();
-
 export default prismaClient;

src/lib/db.ts

@@ -1,21 +1,60 @@
-export default {
-  log(...args: unknown[]) {
-    console.log(...args);
-  },
+import { CI, NODE_ENV } from './config';
+import winston from 'winston';
+import util from 'node:util';
 
-  info(...args: unknown[]) {
-    console.info(...args);
-  },
-
-  warn(...args: unknown[]) {
-    console.warn(...args);
-  },
+const stripSymbols = (anyObj: unknown): unknown => {
+  return typeof anyObj === 'object' &&
+    anyObj !== null &&
+    Object.keys(anyObj).length &&
+    !Array.isArray(anyObj)
+    ? Object.fromEntries(Object.entries(anyObj))
+    : anyObj;
+};
 
-  error(...args: unknown[]) {
-    if (args.every((a) => a instanceof Error)) {
-      console.error(...args.map((a) => a.toString()));
-    } else {
-      console.error(...args);
-    }
-  },
+const inspectObj = (anyObj: unknown): string => {
+  if (typeof anyObj === 'string') return anyObj;
+  const obj = stripSymbols(anyObj);
+  return util.inspect(obj, { depth: null, colors: true, compact: CI });
 };
+
+const winstonLevelColorsExt = Object.fromEntries(
+  Object.entries(winston.config.npm.colors).map(([level, color]) => [
+    level.toUpperCase(),
+    color,
+  ])
+);
+
+winston.addColors(winstonLevelColorsExt);
+
+export const logger = winston.createLogger({
+  format: winston.format.combine(
+    winston.format((info) => {
+      info.level = info.level.toUpperCase();
+      return info;
+    })(),
+    winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
+    winston.format.colorize({ level: true }),
+    winston.format.printf(({ timestamp, level, message, ...meta }) => {
+      return `[${timestamp}] ${level}: ${inspectObj(message)}${
+        Object.keys(meta).length ? '\n' + inspectObj(meta) : ''
+      }`;
+    })
+  ),
+  transports: [new winston.transports.Console()],
+  silent: NODE_ENV === 'test',
+  level: 'info',
+});
+
+if (!CI) {
+  logger.add(
+    new winston.transports.File({
+      tailable: true,
+      filename: 'logs/app.log',
+      format: winston.format.json(),
+      maxsize: 1024 * 1024 * 5, // 5MB
+      maxFiles: 3,
+    })
+  );
+}
+
+export default logger;

src/lib/logger.ts

@@ -1,12 +1,14 @@
 import { NextFunction, Request, Response } from 'express';
 import logger from '../lib/logger';
 
-export const logReq = (req: Request, res: Response, next: NextFunction) => {
-  logger.log('<---');
-  logger.info(`${req.method}: ${req.originalUrl}`);
-  if (req.body) logger.info(req.body);
-  logger.log('--->');
+export const requestLogger = (
+  req: Request,
+  res: Response,
+  next: NextFunction
+) => {
+  const body = req.body as unknown;
+  logger.info(`${req.method}: ${req.originalUrl}`, { body });
   next();
 };
 
-export default logReq;
+export default requestLogger;

src/middlewares/request-logger.ts

@@ -1,5 +1,6 @@
+import logger from './lib/logger';
 import app from './app';
 
 const PORT = Number(process.env.PORT) || 3001;
 
-app.listen(PORT, () => console.log(`Listening on port ${PORT}`));
+app.listen(PORT, () => logger.info(`The server is running on prot ${PORT}...`));

src/server.ts

@@ -80,7 +80,6 @@ describe('Authentication endpoint', () => {
     it('should sign in and response with JWT and user insensitive-info', async () => {
       const res = await api.post(SIGNIN_URL).send(signInData);
       const resBody = res.body as SignInResponse;
-      console.log(resBody);
       const resUser = resBody.user as User;
       const resJwtPayload = jwt.decode(
         resBody.token.replace(/^Bearer /, '')