From eeb0b4a666281251913899f00776ffebdb705525 Mon Sep 17 00:00:00 2001 From: Abhigyan Khaund Date: Wed, 27 Jun 2018 15:31:01 +0530 Subject: [PATCH] logger: Replace all instances of console.log with our logger-util. --- app/main/linuxupdater.js | 11 +++++++++-- app/main/menu.js | 9 ++++++++- app/renderer/js/main.js | 8 +++++++- app/renderer/js/notification/helpers.js | 10 ++++++++-- app/renderer/js/pages/preference/add-certificate.js | 1 - app/renderer/js/spellchecker.js | 8 +++++++- app/renderer/js/utils/certificate-util.js | 1 - app/renderer/js/utils/domain-util.js | 11 +++++++---- app/renderer/js/utils/reconnect-util.js | 10 ++++++++-- 9 files changed, 54 insertions(+), 15 deletions(-) diff --git a/app/main/linuxupdater.js b/app/main/linuxupdater.js index c89a9b15..9f860efc 100644 --- a/app/main/linuxupdater.js +++ b/app/main/linuxupdater.js @@ -5,6 +5,12 @@ const request = require('request'); const semver = require('semver'); const ConfigUtil = require('../renderer/js/utils/config-util'); const LinuxUpdateUtil = require('../renderer/js/utils/linux-update-util'); +const Logger = require('../renderer/js/utils/logger-util'); + +const logger = new Logger({ + file: 'linux-update-util.log', + timestamp: true +}); function linuxUpdateNotification() { let url = 'https://api.github.com/repos/zulip/zulip-electron/releases'; @@ -17,7 +23,8 @@ function linuxUpdateNotification() { request(options, (error, response, body) => { if (error) { - console.log('Error:', error); + logger.error('Linux update error.'); + logger.error(error); return; } if (response.statusCode < 400) { @@ -32,7 +39,7 @@ function linuxUpdateNotification() { } } } else { - console.log('Status:', response.statusCode); + logger.log('Linux update response status: ', response.statusCode); } }); } diff --git a/app/main/menu.js b/app/main/menu.js index 69014628..f8ccf645 100644 --- a/app/main/menu.js +++ b/app/main/menu.js @@ -8,9 +8,15 @@ const { appUpdater } = require('./autoupdater'); const ConfigUtil = require(__dirname + '/../renderer/js/utils/config-util.js'); const DNDUtil = require(__dirname + '/../renderer/js/utils/dnd-util.js'); +const Logger = require(__dirname + '/../renderer/js/utils/logger-util.js'); const appName = app.getName(); +const logger = new Logger({ + file: 'errors.log', + timestamp: true +}); + class AppMenu { getHistorySubmenu() { return [{ @@ -431,7 +437,8 @@ class AppMenu { const getSettingFilesPath = path.join(app.getPath('appData'), appName, settingFileName); fs.access(getSettingFilesPath, error => { if (error) { - console.log(error); + logger.error('Error while resetting app settings.'); + logger.error(error); } else { fs.unlink(getSettingFilesPath, () => { AppMenu.sendAction('clear-app-data'); diff --git a/app/renderer/js/main.js b/app/renderer/js/main.js index 01fca189..27b75a91 100644 --- a/app/renderer/js/main.js +++ b/app/renderer/js/main.js @@ -13,10 +13,16 @@ const FunctionalTab = require(__dirname + '/js/components/functional-tab.js'); const ConfigUtil = require(__dirname + '/js/utils/config-util.js'); const DNDUtil = require(__dirname + '/js/utils/dnd-util.js'); const ReconnectUtil = require(__dirname + '/js/utils/reconnect-util.js'); +const Logger = require(__dirname + '/js/utils/logger-util.js'); const { feedbackHolder } = require(__dirname + '/js/feedback.js'); const escape = require('escape-html'); +const logger = new Logger({ + file: 'errors.log', + timestamp: true +}); + class ServerManagerView { constructor() { this.$addServerButton = document.getElementById('add-tab'); @@ -583,7 +589,7 @@ window.onload = () => { window.addEventListener('offline', () => { reconnectUtil.clearState(); - console.log('No internet connection, you are offline.'); + logger.log('No internet connection, you are offline.'); }); // only start electron-connect (auto reload on change) when its ran diff --git a/app/renderer/js/notification/helpers.js b/app/renderer/js/notification/helpers.js index ff6c7d4b..ca18b56f 100644 --- a/app/renderer/js/notification/helpers.js +++ b/app/renderer/js/notification/helpers.js @@ -1,4 +1,10 @@ const { remote } = require('electron'); +const Logger = require('../utils/logger-util.js'); + +const logger = new Logger({ + file: 'errors.log', + timestamp: true +}); // Do not change this const appId = 'org.zulip.zulip-electron'; @@ -28,8 +34,8 @@ function loadBots(sync = false) { botsListLoaded = true; }) .fail(error => { - console.log('Request failed: ', error.responseText); - console.log('Request status: ', error.statusText); + logger.log('Load bots request failed: ', error.responseText); + logger.log('Load bots request status: ', error.statusText); }); if (sync) { $.ajaxSetup({async: true}); diff --git a/app/renderer/js/pages/preference/add-certificate.js b/app/renderer/js/pages/preference/add-certificate.js index ba3d8944..b4a6b454 100644 --- a/app/renderer/js/pages/preference/add-certificate.js +++ b/app/renderer/js/pages/preference/add-certificate.js @@ -44,7 +44,6 @@ class AddCertificate extends BaseComponent { const fileName = certificate.substring(certificate.lastIndexOf('/') + 1); const copy = CertificateUtil.copyCertificate(server, certificate, fileName); if (!copy) { - console.log('We encountered error while saving the certificate.'); return; } CertificateUtil.setCertificate(server, fileName); diff --git a/app/renderer/js/spellchecker.js b/app/renderer/js/spellchecker.js index 751a6213..b77548e2 100644 --- a/app/renderer/js/spellchecker.js +++ b/app/renderer/js/spellchecker.js @@ -3,6 +3,12 @@ const { SpellCheckHandler, ContextMenuListener, ContextMenuBuilder } = require('electron-spellchecker'); const ConfigUtil = require(__dirname + '/utils/config-util.js'); +const Logger = require(__dirname + '/utils/logger-util.js'); + +const logger = new Logger({ + file: 'errors.log', + timestamp: true +}); class SetupSpellChecker { init() { @@ -16,7 +22,7 @@ class SetupSpellChecker { try { this.SpellCheckHandler = new SpellCheckHandler(); } catch (err) { - console.log(err); + logger.error(err); } } diff --git a/app/renderer/js/utils/certificate-util.js b/app/renderer/js/utils/certificate-util.js index 83a5f560..c22eab78 100644 --- a/app/renderer/js/utils/certificate-util.js +++ b/app/renderer/js/utils/certificate-util.js @@ -51,7 +51,6 @@ class CertificateUtil { ); logger.error('Error while copying the certificate to certificates folder.'); logger.error(err); - console.log(err); } return copied; } diff --git a/app/renderer/js/utils/domain-util.js b/app/renderer/js/utils/domain-util.js index 1c337804..ea11ad53 100644 --- a/app/renderer/js/utils/domain-util.js +++ b/app/renderer/js/utils/domain-util.js @@ -116,7 +116,7 @@ class DomainUtil { try { certificateLocation = fs.readFileSync(certificate); } catch (err) { - console.log(err); + logger.warn('Error while trying to get certificate: ' + err); } } // If certificate for the domain exists add it as a ca key in the request's parameter else consider only domain as the parameter for request @@ -219,18 +219,21 @@ class DomainUtil { try { request(url).on('response', response => { response.on('error', err => { - console.log(err); + logger.log('Could not get server icon.'); + logger.log(err); resolve(defaultIconUrl); }); response.pipe(file).on('finish', () => { resolve(filePath); }); }).on('error', err => { - console.log(err); + logger.log('Could not get server icon.'); + logger.log(err); resolve(defaultIconUrl); }); } catch (err) { - console.log(err); + logger.log('Could not get server icon.'); + logger.log(err); resolve(defaultIconUrl); } }); diff --git a/app/renderer/js/utils/reconnect-util.js b/app/renderer/js/utils/reconnect-util.js index 04c77343..4a051d03 100644 --- a/app/renderer/js/utils/reconnect-util.js +++ b/app/renderer/js/utils/reconnect-util.js @@ -1,4 +1,10 @@ const isOnline = require('is-online'); +const Logger = require('./logger-util'); + +const logger = new Logger({ + file: `domain-util.log`, + timestamp: true +}); class ReconnectUtil { constructor(serverManagerView) { @@ -31,11 +37,11 @@ class ReconnectUtil { if (!this.alreadyReloaded) { this.serverManagerView.reloadView(); } - console.log('You\'re back online.'); + logger.log('You\'re back online.'); return resolve(true); } - console.log('There is no internet connection, try checking network cables, modem and router.'); + logger.log('There is no internet connection, try checking network cables, modem and router.'); const errMsgHolder = document.querySelector('#description'); if (errMsgHolder) { errMsgHolder.innerHTML = `