feat: add winston as a sole logging package

Signed-off-by: Anthony Benites <[email protected]>

package.json

@@ -31,7 +31,6 @@
     "cli-spinners": "^2.6.1",
     "cors": "^2.8.5",
     "csvtojson": "^2.0.10",
-    "debug": "~2.6.9",
     "dotenv": "^10.0.0",
     "express": "~4.16.1",
     "express-fileupload": "^1.2.1",
@@ -55,7 +54,8 @@
     "toad-scheduler": "^1.6.0",
     "updeep": "^1.2.1",
     "uuidv4": "^6.2.12",
-    "winston": "^3.6.0"
+    "winston": "^3.7.2",
+    "winston-daily-rotate-file": "^4.6.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.16.0",

src/config/config.cjs

@@ -5,16 +5,21 @@ const yaml = require('js-yaml');
 const fs = require('fs');
 const os = require('os');
 const path = require('path');
+const logger = require('./logger.cjs').logger;
+
 const homeDir = os.homedir();
 const defaultConfig = require('../utils/defaultConfig.json');
 
 const persistanceFolder = `${homeDir}/.chia/climate-warehouse`;
 
 // Adding this duplicate function here because im having trouble
 // importing it in from utils folder
+const configPath = `${homeDir}/.chia/climate-warehouse/config.yaml`;
 const getConfig = _.memoize(() => {
+  logger.info(`Reading config file at ${configPath}`);
+
   const configFile = path.resolve(
-    `${homeDir}/.chia/climate-warehouse/config.yaml`,
+    configPath,
   );
 
   // First write it to chia home
@@ -28,7 +33,7 @@ const getConfig = _.memoize(() => {
         defaultConfig.APP.USE_SIMULATOR = true;
       }
 
-      console.log('Cant write config file, falling back to defaults');
+      logger.error('Cant write config file, falling back to defaults');
       return yaml.load(yaml.dump(defaultConfig));
     }
   }
@@ -42,7 +47,7 @@ const getConfig = _.memoize(() => {
 
     return yml;
   } catch (e) {
-    console.log(e, `Config file not found at ${configFile}`);
+    logger.error(`Config file not found at ${configFile}`, e);
   }
 });
 

src/config/logger.cjs

@@ -0,0 +1,94 @@
+const winston = require('winston');
+const { format, transports, createLogger } = winston
+
+const DailyRotateFile = require('winston-daily-rotate-file');
+
+const fs = require('fs');
+const os = require('os');
+const homeDir = os.homedir();
+const logDir = `${homeDir}/.chia/climate-warehouse/logs`;
+
+if (!fs.existsSync(logDir)) {
+  fs.mkdirSync(logDir, { recursive: true });
+}
+const logFormat = format.printf(info => `${info.timestamp} [${info.level}]: ${info.message} ${Object.keys(info.metadata || {}).length > 0 ? JSON.stringify(info.metadata) : ''}`)
+
+const logger = createLogger({
+  level: 'info',
+  format: format.combine(
+    logFormat,
+    // format.label({ label: path.basename(process.main.filename) }),
+    format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
+    format.metadata({ fillExcept: ['message', 'level', 'timestamp'] }),
+  ),
+  transports: [
+    // Write all logs with importance level of `error` or less to `error.log`
+    new transports.File({
+      filename: `${logDir}/error.log`,
+      level: 'error',
+      format: format.combine(
+        format.json(),
+      ),
+    }),
+    // Write all logs with importance level of `info` or less to `combined.log`
+    new transports.File({
+      filename: `${logDir}/combined.log`,
+      format: format.combine(
+        format.json(),
+      ),
+    }),
+    // Rotate logs to `application-%DATE%.log`
+    new DailyRotateFile({
+      filename: `${logDir}/application-%DATE%.log`,
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      utc: true,
+      format: format.combine(
+        format.json(),
+      ),
+    }),
+  ],
+  exceptionHandlers: [
+    new transports.File({
+      filename: `${logDir}/exceptions.log`,
+    }),
+    new DailyRotateFile({
+      filename: `${logDir}/exceptions-%DATE%.log`,
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      utc: true,
+    }),
+  ],
+  rejectionHandlers: [
+    new transports.File({
+      filename: `${logDir}/rejections.log`,
+    }),
+    new DailyRotateFile({
+      filename: `${logDir}/rejections-%DATE%.log`,
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      utc: true,
+    }),
+  ],
+  exitOnError: false
+});
+
+//
+// If not in production then log to the `console`
+//
+if (process.env.NODE_ENV !== 'production') {
+  logger.add(new transports.Console({
+    format: format.combine(
+      format.colorize(),
+      format.prettyPrint(),
+      logFormat,
+    )
+  }));
+}
+
+module.exports = {
+  logger,
+};

src/controllers/project.controller.js

@@ -6,6 +6,8 @@ import { uuid as uuidv4 } from 'uuidv4';
 
 import { Staging, Project, Organization, ModelKeys } from '../models';
 
+import { logger } from '../config/logger.cjs';
+
 import {
   columnsToInclude,
   optionallyPaginatedResponse,
@@ -318,7 +320,7 @@ export const update = async (req, res) => {
       message: 'Error adding update to stage',
       error: err.message,
     });
-    console.log(err);
+    logger.error('Error adding update to stage', err);
   }
 };
 

src/database/index.js

@@ -1,8 +1,6 @@
 import { Sequelize } from 'sequelize';
 import config from '../config/config.cjs';
-import Debug from 'debug';
-Debug.enable('climate-warehouse:mirror-database');
-const log = Debug('climate-warehouse:mirror-database');
+import { logger } from '../config/logger.cjs';
 import mysql from 'mysql2/promise';
 import { getConfig } from '../utils/config-loader';
 
@@ -19,6 +17,8 @@ const mirrorConfig =
   (process.env.NODE_ENV || 'local') === 'local' ? 'mirror' : 'mirrorTest';
 export const sequelizeMirror = new Sequelize(config[mirrorConfig]);
 
+logger.info('climate-warehouse:mirror-database');
+
 export const safeMirrorDbHandler = (callback) => {
   try {
     sequelizeMirror
@@ -31,12 +31,13 @@ export const safeMirrorDbHandler = (callback) => {
           getConfig().MIRROR_DB.DB_HOST &&
           getConfig().MIRROR_DB.DB_HOST !== ''
         ) {
-          log('Mirror DB not connected');
+          logger.info('Mirror DB not connected');
         }
       });
   } catch (error) {
-    console.log(
+    logger.error(
       'MirrorDB tried to update before it was initialize, will try again later',
+      error,
     );
   }
 };
@@ -54,11 +55,11 @@ export const seedDb = async (db) => {
 
     for (let i = 0; i < seeders.length; i++) {
       const seeder = seeders[i];
-      console.log('SEEDING: ', seeder.name);
+      logger.info(`SEEDING: ${seeder.name}`, seeder);
       await seeder.seed.up(queryInterface, Sequelize);
     }
   } catch (error) {
-    log(error);
+    logger.error('Error seeding data', error);
   }
 };
 
@@ -85,15 +86,15 @@ export const checkForMigrations = async (db) => {
 
     for (let i = 0; i < notCompletedMigrations.length; i++) {
       const notCompleted = notCompletedMigrations[i];
-      console.log('MIGRATING: ', notCompleted.name);
+      logger.info('MIGRATING: ', notCompleted.name);
       await notCompleted.migration.up(db.queryInterface, Sequelize);
       await db.query('INSERT INTO `SequelizeMeta` VALUES(:name)', {
         type: Sequelize.QueryTypes.INSERT,
         replacements: { name: notCompleted.name },
       });
     }
   } catch (error) {
-    log(error);
+    logger.error('Error checking for migrations', error);
   }
 };
 

src/datalayer/persistance.js

@@ -6,10 +6,9 @@ import request from 'request-promise';
 import os from 'os';
 import { getConfig } from '../utils/config-loader';
 
-import Debug from 'debug';
-Debug.enable('climate-warehouse:datalayer:persistance');
+import { logger } from '../config/logger.cjs';
 
-const log = Debug('climate-warehouse:datalayer:persistance');
+logger.info('climate-warehouse:datalayer:persistance');
 
 process.env['NODE_TLS_REJECT_UNAUTHORIZED'] = 0;
 
@@ -43,13 +42,11 @@ export const createDataLayerStore = async () => {
 
   const data = JSON.parse(response);
 
-  console.log(data);
-
   if (data.success) {
     return data.id;
   }
 
-  log(data);
+  logger.info(data);
 
   throw new Error(data.error);
 };
@@ -70,23 +67,24 @@ export const pushChangeListToDataLayer = async (storeId, changelist) => {
 
     const data = JSON.parse(response);
 
-    log(options, data);
+    logger.info(options);
+    logger.info(data);
 
     if (data.success) {
-      log('Success!');
+      logger.info('Success!');
       return true;
     }
 
     if (data.error.includes('Key already present')) {
-      log('Success, I guess...');
+      logger.info('Success, I guess...');
       return true;
     }
 
-    log(data);
+    logger.info(data);
 
     return false;
   } catch (error) {
-    log('There was an error pushing your changes to the datalayer');
+    logger.info('There was an error pushing your changes to the datalayer');
   }
 };
 
@@ -166,12 +164,12 @@ export const getStoreData = async (storeId, rootHash) => {
 
     if (data.success) {
       if (!_.isEmpty(data.keys_values)) {
-        log('Downloaded Data', data);
+        logger.info(`Downloaded Data: ${data}`);
       }
       return data;
     }
 
-    log(data);
+    logger.info(data);
   }
 
   return false;
@@ -195,7 +193,7 @@ export const dataLayerAvailable = async () => {
       return true;
     }
 
-    log(data);
+    logger.info(data);
     return false;
   } catch (error) {
     return false;
@@ -212,7 +210,7 @@ export const subscribeToStoreOnDataLayer = async (storeId, ip, port) => {
     }),
   };
 
-  log('RPC Call: ', `${rpcUrl}/subscribe`, storeId, ip, port);
+  logger.info(`RPC Call: ${rpcUrl}/subscribe ${storeId} ${ip} ${port}`);
 
   try {
     const response = await request(
@@ -222,13 +220,13 @@ export const subscribeToStoreOnDataLayer = async (storeId, ip, port) => {
     const data = JSON.parse(response);
 
     if (Object.keys(data).includes('success') && data.success) {
-      log('Successfully Subscribed: ', storeId, ip, port);
+      logger.info(`Successfully Subscribed: ${storeId}  ${ip} ${port}`);
       return data;
     }
 
     return false;
   } catch (error) {
-    log('Error Subscribing: ', error);
+    logger.info(`Error Subscribing: ${error}`);
     return false;
   }
 };