added logging mechanism

Author: Rupeshiya

.gitignore

@@ -1,5 +1,6 @@
 .env
 .vscode/
+logs
 client/.next/
 node_modules/
 client/config.js

package-lock.json

@@ -38,6 +38,7 @@
     "@sentry/apm": "^5.21.1",
     "@sentry/node": "^5.21.1",
     "@sentry/react": "^5.21.1",
+    "app-root-path": "^3.0.0",
     "axios": "^0.21.1",
     "babel-plugin-inline-react-svg": "^1.1.0",
     "bcryptjs": "^2.4.3",
@@ -95,7 +96,8 @@
     "url-regex": "^4.1.1",
     "use-media": "^1.4.0",
     "useragent": "^2.2.1",
-    "uuid": "^3.4.0"
+    "uuid": "^3.4.0",
+    "winston": "^3.3.3"
   },
   "devDependencies": {
     "@babel/cli": "^7.8.3",

package.json

@@ -0,0 +1,65 @@
+import appRoot from "app-root-path";
+import winston from "winston";
+
+const { combine, colorize, printf, timestamp } = winston.format;
+
+const logFormat = printf(info => {
+  return `[${info.timestamp}] ${info.level}: ${info.message}`;
+});
+
+const rawFormat = printf(info => {
+  return `[${info.timestamp}] ${info.level}: ${info.message}`;
+});
+
+// define the custom settings for each transport (file, console)
+const options = {
+  file: {
+    level: "info",
+    filename: `${appRoot}/logs/app.log`,
+    handleExceptions: true,
+    json: true,
+    maxsize: 5242880, // 5MB
+    maxFiles: 5,
+    colorize: false
+  },
+  errorFile: {
+    level: "error",
+    name: "file.error",
+    filename: `${appRoot}/logs/error.log`,
+    handleExceptions: true,
+    json: true,
+    maxsize: 5242880, // 5MB
+    maxFiles: 100,
+    colorize: true
+  },
+  console: {
+    level: "debug",
+    handleExceptions: true,
+    json: false,
+    format: combine(colorize(), rawFormat)
+  }
+};
+
+// instantiate a new Winston Logger with the settings defined above
+export const logger = winston.createLogger({
+  format: combine(timestamp({ format: "YYYY-MM-DD HH:mm:ss" }), logFormat),
+  transports: [
+    new winston.transports.File(options.file),
+    new winston.transports.Console(options.console)
+  ],
+  exitOnError: false // do not exit on handled exceptions
+});
+
+// create a stream object with a 'write' function that will be used by `morgan`
+export const stream = {
+  write: message => {
+    logger.info(message);
+  }
+};
+
+winston.addColors({
+  debug: "white",
+  error: "red",
+  info: "green",
+  warn: "yellow"
+});

server/config/winston.ts

@@ -14,6 +14,7 @@ import * as links from "./handlers/links";
 import * as auth from "./handlers/auth";
 import __v1Routes from "./__v1";
 import routes from "./routes";
+import { stream } from "./config/winston";
 
 import "./cron";
 import "./passport";
@@ -28,7 +29,7 @@ app.prepare().then(async () => {
   server.set("trust proxy", true);
 
   if (env.isDev) {
-    server.use(morgan("dev"));
+    server.use(morgan("combined", { stream }));
   } else if (env.SENTRY_PRIVATE_DSN) {
     Sentry.init({
       dsn: env.SENTRY_PRIVATE_DSN,