Merge pull request #1467 from Hirobreak/logger

Logger and Reporting all uncaught exceptions

Author: danieltigse

.gitignore

@@ -18,6 +18,8 @@ CriptextEncrypt.db-wal
 recovery.key
 umzug.json
 migration.json
+criptext-*.log
+*-audit.json
 
 # production
 *_interface/build

electron_app/electron-starter.js

@@ -28,6 +28,7 @@ require('./src/ipc/client.js');
 const ipcUtils = require('./src/ipc/utils.js');
 const { checkDatabaseStep, deleteNotEncryptDatabase } = require('./src/utils/dataBaseUtils');
 const { APP_DOMAIN } = require('./src/utils/const');
+const logger = require('./src/logger');
 
 globalManager.forcequit.set(false);
 
@@ -41,6 +42,16 @@ const oldVersionUrl = () => {
   }
 }
 
+process.on('uncaughtException', err => {
+  logger.error('Uncaught Error: ', err);
+  closeAlice();
+  process.exit(1);
+})
+
+process.on('unhandledRejection', err => {
+  logger.error('Unhandled Rejection: ', err);
+})
+
 async function initApp() {
   const step = await checkDatabaseStep(dbManager);
   switch (step) {
@@ -65,15 +76,15 @@ async function initApp() {
         closeAlice();
         app.relaunch();
         app.exit(0);
-        console.log(ex);
+        logger.error(ex)
       }
       break;
     }
     case 3:{
       try {
         await upStepNewUser();
       } catch (ex) {
-        console.log(ex);
+        logger.error(ex)
       }
       break;
     }

electron_app/package.json

@@ -1,6 +1,6 @@
 {
   "name": "criptext",
-  "version": "0.29.0",
+  "version": "0.29.1",
   "author": {
     "name": "Criptext Inc",
     "email": "[email protected]",
@@ -178,7 +178,9 @@
     "sqlite3": "^4.1.0",
     "umzug": "^2.2.0",
     "unused-filename": "^2.1.0",
-    "websocket": "^1.0.28"
+    "websocket": "^1.0.28",
+    "winston": "^3.2.1",
+    "winston-daily-rotate-file": "^4.4.2"
   },
   "jest": {
     "verbose": true,

electron_app/src/aliceManager.js

@@ -7,6 +7,7 @@ const http = require('http');
 const ps = require('ps-node');
 const globalManager = require('./globalManager');
 const { encryptTextSimple } = require('./filescript/helpers');
+const logger = require('./logger');
 
 const ALICE_PROJECT_NAME = 'criptext-encryption-service';
 
@@ -127,13 +128,13 @@ const handShake = ({ alicePath, dbpath, myPort, logspath, onAppOpened }) => {
         'Service Error',
         `Unable to initialize encryption service. ${data}`
       );
-      console.log(`-----alice-----\nError:\n${data}\n -----end-----`);
+      logger.error(`-----alice-----\nError:\n${data}\n -----end-----`);
       if (onAppOpened) app.quit();
     });
     alice.stdout.setEncoding('utf8');
     alice.stdout.on('data', async data => {
       if (!passwordRegex.test(data)) {
-        console.log(`-----alice-----\n${data}\n -----end-----`);
+        logger.debug(`-----alice-----\n${data}\n -----end-----`);
         return;
       }
       token = data.replace(passwordRegex, '').replace(/\r?\n|\r/g, '');
@@ -145,17 +146,17 @@ const handShake = ({ alicePath, dbpath, myPort, logspath, onAppOpened }) => {
       }
     });
     alice.on('exit', (code, signal) => {
-      console.log(`alice exited with code ${code} and signal ${signal}`);
+      logger.error(`alice exited with code ${code} and signal ${signal}`);
+      closeAlice();
       if (signal !== 'SIGTERM' && signal !== 'SIGABRT') {
-        closeAlice();
         reject();
         return;
       }
       reject({ retry: true });
     });
 
     alice.on('close', code => {
-      console.log(`alice closed with code ${code}`);
+      logger.info(`alice closed with code ${code}`);
       closeAlice();
       reject();
     });
@@ -208,20 +209,20 @@ const isReachable = () => {
       return;
     }
     const req = http.request(options, res => {
-      console.log(`statusCode: ${res.statusCode}`);
+      logger.info(`statusCode: ${res.statusCode}`);
       resolve(res.statusCode === 200);
     });
 
     req.on('error', error => {
-      console.log(error);
+      logger.error(error);
       resolve(false);
     });
     try {
       const data = await encryptTextSimple(getPassword(), token);
       req.write(JSON.stringify(data));
       req.end();
     } catch (ex) {
-      console.log(ex);
+      logger.error(ex);
       resolve(false);
     }
   });
@@ -252,11 +253,10 @@ const cleanAliceRemenants = () => {
   return new Promise(resolve => {
     ps.lookup({ command: ALICE_PROJECT_NAME }, async (err, list) => {
       if (err) {
-        console.log(err);
+        logger.error(err);
         resolve();
         return;
       }
-      console.log(list);
       await Promise.all(
         list.map(p => {
           return killPs(p.pid);

electron_app/src/database/DBEmanager.js

@@ -35,6 +35,7 @@ const { setLanguage } = require('../lang');
 const systemLabels = require('../systemLabels');
 const myAccount = require('../Account');
 const mySettings = require('../Settings');
+const logger = require('../logger');
 
 const EMAIL_CONTACT_TYPE_FROM = 'from';
 
@@ -449,7 +450,9 @@ const deleteEmailByKeys = async ({ accountId, keys }) => {
           transaction: trx
         });
       })
-      .catch(ex => console.log(ex)); //To do
+      .catch(ex => {
+        logger.error(ex);
+      });
   });
 };
 

electron_app/src/database/DBEmigrations/20200123161254-multipleAccounts.js

@@ -8,6 +8,8 @@ const {
   File
 } = require('../DBEmodel');
 
+const logger = require('../../logger');
+
 const TABLE_ACCOUNT_ID_INDEX = '_accountid_index';
 const tables = [
   Table.EMAIL,
@@ -456,7 +458,7 @@ module.exports = {
 
       await transaction.commit();
     } catch (ex) {
-      console.log(ex);
+      logger.error(ex);
       await transaction.rollback();
       throw new Error(ex.toString());
     }

electron_app/src/ipc/nucleus.js

@@ -4,3 +4,7 @@ const { addEventError, NUCLEUS_EVENTS } = require('./../nucleusManager');
 ipc.answerRenderer('nucleups-report-content-unencrypted', error =>
   addEventError(NUCLEUS_EVENTS.REPORT_CONTENT_UNENCRYPTED, error)
 );
+
+ipc.answerRenderer('nucleups-report-uncaught-error', error =>
+  addEventError(NUCLEUS_EVENTS.UNCAUGHT_ERROR, error)
+);

electron_app/src/logger.js

@@ -0,0 +1,40 @@
+const winston = require('winston');
+const { combine, timestamp, json } = winston.format;
+const WinstonRotation = require('winston-daily-rotate-file');
+const path = require('path');
+const { app } = require('electron');
+
+const getLogsPath = node_env => {
+  switch (node_env) {
+    case 'test': {
+      return './src/__integrations__/alice_logs.txt';
+    }
+    case 'development': {
+      return path.normalize(__dirname).replace('/app.asar', '');
+    }
+    default: {
+      const userDataPath = app.getPath('userData');
+      return path.normalize(userDataPath).replace('/app.asar', '');
+    }
+  }
+};
+
+const rotationOpts = {
+  filename: 'criptext-app.log',
+  dirname: getLogsPath(process.env.NODE_ENV),
+  datePattern: 'YYYY-MM-DD-HH',
+  frequency: '48h',
+  maxSize: '20m',
+  maxFiles: '2'
+};
+
+const logger = winston.createLogger({
+  level: 'debug',
+  format: combine(timestamp(), json()),
+  transports: [
+    new winston.transports.Console(),
+    new WinstonRotation(rotationOpts)
+  ]
+});
+
+module.exports = logger;

electron_app/src/nucleusManager.js

@@ -35,7 +35,8 @@ const NUCLEUS_EVENTS = {
   MAILBOX_OPENED: 'MAILBOX_OPENED',
   NEW_USER: 'NEW_USER',
   POST_PEER_EVENT: 'POST_PEER_EVENT',
-  REPORT_CONTENT_UNENCRYPTED: 'REPORT_CONTENT_UNENCRYPTED'
+  REPORT_CONTENT_UNENCRYPTED: 'REPORT_CONTENT_UNENCRYPTED',
+  UNCAUGHT_ERROR: 'UNCAUGHT_ERROR'
 };
 
 module.exports = {

electron_app/src/windows/loading.js

@@ -30,7 +30,8 @@ const create = () => {
     transparent: true,
     center: true,
     webPreferences: {
-      nodeIntegration: true
+      nodeIntegration: true,
+      devTools: true
     }
   });
   loadingWindow.loadURL(loadingUrl);