Improve error handling and database logging (#334)

cbovis · web-flow · commit 35f95330ac19 · 2020-01-13T18:38:05.000Z
* Improve error handling and database logging

* Bump yarn version
diff --git a/package.json b/package.json
@@ -26,7 +26,7 @@
   },
   "engines": {
     "node": "10.17.0",
-    "yarn": "1.19.2"
+    "yarn": "1.21.1"
   },
   "private": true,
   "workspaces": [
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -7,6 +7,7 @@
     "@0x-event-extractor/extractor-v2": "^1.0.0",
     "@0x-event-extractor/extractor-v3": "^1.0.0",
     "@0x-event-extractor/shared": "^1.0.0",
+    "@bugsnag/js": "6.5.0",
     "bugsnag": "^2.4.3",
     "delay": "^4.3.0",
     "lodash": "^4.17.15",
diff --git a/packages/core/src/index.js b/packages/core/src/index.js
@@ -4,15 +4,17 @@ const extractorV2 = require('@0x-event-extractor/extractor-v2');
 const extractorV3 = require('@0x-event-extractor/extractor-v3');
 
 const db = require('./util/db');
+const errorLogger = require('./util/error-logger');
 const getJobs = require('./jobs');
 const jobRunner = require('./util/job-runner');
-const logger = require('./util/logger');
 const web3 = require('../../shared/src/web3');
 
-const configure = initialConfig => {
+const configure = async initialConfig => {
   config.init(initialConfig);
-  logger.configure({ bugsnagToken: config.get('bugsnag.token') });
-  db.connect(config.get('database.connectionString'));
+  errorLogger.configure({
+    bugsnagToken: config.get('bugsnag.token'),
+  });
+  await db.connect(config.get('database.connectionString'));
   web3.configure({ endpoint: config.get('web3.endpoint') });
   extractorV1.configure({ networkId: config.get('web3.networkId') });
   extractorV2.configure({ networkId: config.get('web3.networkId') });
diff --git a/packages/core/src/util/db.js b/packages/core/src/util/db.js
@@ -1,28 +1,47 @@
 const mongoose = require('mongoose');
 const signale = require('signale');
 
-const logger = require('./logger');
+const { logError } = require('./error-logger');
+
+const logger = signale.scope('mongodb');
 
 mongoose.Promise = global.Promise;
 
 module.exports = {
-  connect: connectionString => {
-    mongoose.connect(connectionString, {
-      useFindAndModify: false,
-      useNewUrlParser: true,
-      useUnifiedTopology: true,
+  connect: async connectionString => {
+    mongoose.connection.on('connecting', () => {
+      logger.info('connecting to database');
     });
 
     mongoose.connection.on('connected', () => {
-      signale.scope('mongodb').success('database connection established');
+      logger.success('database connection established');
     });
 
     mongoose.connection.on('error', err => {
-      logger.logError(err);
+      logError(err);
+    });
+
+    mongoose.connection.on('disconnecting', () => {
+      logger.warn('disconnecting from database');
     });
 
     mongoose.connection.on('disconnected', () => {
-      signale.scope('mongodb').warn('database connection terminated');
+      logger.warn('database connection terminated');
+    });
+
+    mongoose.connection.on('reconnected', () => {
+      logger.warn('reconnected to database');
+    });
+
+    mongoose.connection.on('reconnectFailed', () => {
+      logError('Database reconnection failed');
+    });
+
+    await mongoose.connect(connectionString, {
+      autoIndex: false,
+      useFindAndModify: false,
+      useNewUrlParser: true,
+      useUnifiedTopology: true,
     });
   },
   disconnect: () => {
diff --git a/packages/core/src/util/error-logger.js b/packages/core/src/util/error-logger.js
@@ -0,0 +1,34 @@
+const _ = require('lodash');
+const bugsnag = require('@bugsnag/js');
+const signale = require('signale');
+
+const logger = signale.scope('application');
+
+let bugsnagClient;
+
+const logError = (error, metaData) => {
+  if (bugsnagClient !== undefined) {
+    bugsnagClient.notify(error, { metaData });
+  }
+
+  logger.error(error);
+};
+
+const configure = ({ appVersion, bugsnagToken }) => {
+  if (_.isString(bugsnagToken)) {
+    // The bugsnag client automatically attaches itself to uncaughtException
+    // and unhandledRejection events.
+    bugsnagClient = bugsnag({
+      apiKey: bugsnagToken,
+      appVersion,
+    });
+  } else {
+    process.on('uncaughtException', logger.error);
+    process.on('unhandledRejection', logger.error);
+  }
+};
+
+module.exports = {
+  configure,
+  logError,
+};
diff --git a/packages/core/src/util/job-runner.js b/packages/core/src/util/job-runner.js
@@ -1,22 +1,22 @@
 const delay = require('delay');
 const withRetry = require('promise-poller').default;
 
-const logger = require('./logger');
+const { logError } = require('./error-logger');
 
 const repeatTask = (task, { minInterval, maxInterval }) =>
   withRetry({
     max: maxInterval,
     min: minInterval,
-    progressCallback: (retriesRemaining, error) => logger.logError(error),
+    progressCallback: (retriesRemaining, error) => logError(error),
     retries: 999999, // Setting a large number because poller does not work properly with Infinity
     strategy: 'exponential-backoff',
     taskFn: task,
   })
     .then(() => delay(minInterval))
     .then(() => repeatTask(task, { maxInterval, minInterval }))
     .catch(error => {
-      logger.logError(error);
-      logger.logError(`Stopped running ${task.name}.`);
+      logError(error);
+      logError(`Stopped running ${task.name}.`);
     });
 
 const runJobs = jobs => {
diff --git a/packages/core/src/util/logger.js b/packages/core/src/util/logger.js
diff --git a/src/index.js b/src/index.js
@@ -8,5 +8,9 @@ require('dotenv-safe').config({
 const extractor = require('@0x-event-extractor/core');
 const config = require('config');
 
-extractor.configure(config.util.toObject());
-extractor.start();
+extractor
+  .configure(config.util.toObject())
+  .then(() => {
+    extractor.start();
+  })
+  .catch(console.error); // eslint-disable-line no-console
diff --git a/yarn.lock b/yarn.lock
@@ -691,6 +691,30 @@
     lodash "^4.17.13"
     to-fast-properties "^2.0.0"
 
+"@bugsnag/browser@^6.5.0":
+  version "6.5.0"
+  resolved "https://registry.yarnpkg.com/@bugsnag/browser/-/browser-6.5.0.tgz#cec29fba00b47cbfca464be7f52b3900dd809cef"
+  integrity sha512-BBUK4XlCkzRsAwFbdAOBPSa353EqDmGuVvbnXom0xG1D2IySGyNmYdPBproTRNKp+h0XuCkXeBrjsyC9Wph6+g==
+
+"@bugsnag/js@6.5.0":
+  version "6.5.0"
+  resolved "https://registry.yarnpkg.com/@bugsnag/js/-/js-6.5.0.tgz#4961e799d93c84ca9dd37877ecdbfa939ebf3404"
+  integrity sha512-iY0e3BOjDkTV6YssVeAC/TfP27RRdqZoZWJGKBU1mTdfKdNb0aSkR8DsU5UTriwY900ughNVONLQm87ecHyNUQ==
+  dependencies:
+    "@bugsnag/browser" "^6.5.0"
+    "@bugsnag/node" "^6.5.0"
+
+"@bugsnag/node@^6.5.0":
+  version "6.5.0"
+  resolved "https://registry.yarnpkg.com/@bugsnag/node/-/node-6.5.0.tgz#10ebba701f3f78bbbc1cf7cc806ffa633d61e5ec"
+  integrity sha512-qW6+MYeXxcUA1nYzfeO637PzwPhKP89udYrIRXhhTLFIZwMyyFRes9Fok4M6RGN6VKP6H4zpQrzMc6/dU08Jxw==
+  dependencies:
+    byline "^5.0.0"
+    error-stack-parser "^2.0.2"
+    iserror "^0.0.2"
+    pump "^3.0.0"
+    stack-generator "^2.0.3"
+
 "@cnakazawa/watch@^1.0.3":
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/@cnakazawa/watch/-/watch-1.0.3.tgz#099139eaec7ebf07a27c1786a3ff64f39464d2ef"
@@ -2509,6 +2533,11 @@ bugsnag@^2.4.3:
     request "^2.81.0"
     stack-trace "~0.0.9"
 
+byline@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/byline/-/byline-5.0.0.tgz#741c5216468eadc457b03410118ad77de8c1ddb1"
+  integrity sha1-dBxSFkaOrcRXsDQQEYrXfejB3bE=
+
 bytes@3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.1.0.tgz#f6cf7933a360e0588fa9fde85651cdc7f805d1f6"
@@ -3597,6 +3626,13 @@ error-ex@^1.2.0, error-ex@^1.3.1:
   dependencies:
     is-arrayish "^0.2.1"
 
+error-stack-parser@^2.0.2:
+  version "2.0.6"
+  resolved "https://registry.yarnpkg.com/error-stack-parser/-/error-stack-parser-2.0.6.tgz#5a99a707bd7a4c58a797902d48d82803ede6aad8"
+  integrity sha512-d51brTeqC+BHlwF0BhPtcYgF5nlzf9ZZ0ZIUQNZpc9ZB9qw5IJ2diTrBY9jlCJkTLITYPjmiX6OWCwH+fuyNgQ==
+  dependencies:
+    stackframe "^1.1.1"
+
 es-abstract@^1.12.0, es-abstract@^1.13.0, es-abstract@^1.5.0, es-abstract@^1.5.1, es-abstract@^1.7.0:
   version "1.15.0"
   resolved "https://registry.yarnpkg.com/es-abstract/-/es-abstract-1.15.0.tgz#8884928ec7e40a79e3c9bc812d37d10c8b24cc57"
@@ -5981,6 +6017,11 @@ isarray@1.0.0, isarray@^1.0.0, isarray@~1.0.0:
   resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11"
   integrity sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=
 
+iserror@^0.0.2:
+  version "0.0.2"
+  resolved "https://registry.yarnpkg.com/iserror/-/iserror-0.0.2.tgz#bd53451fe2f668b9f2402c1966787aaa2c7c0bf5"
+  integrity sha1-vVNFH+L2aLnyQCwZZnh6qix8C/U=
+
 isexe@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10"
@@ -9642,6 +9683,13 @@ sshpk@^1.7.0:
     safer-buffer "^2.0.2"
     tweetnacl "~0.14.0"
 
+stack-generator@^2.0.3:
+  version "2.0.5"
+  resolved "https://registry.yarnpkg.com/stack-generator/-/stack-generator-2.0.5.tgz#fb00e5b4ee97de603e0773ea78ce944d81596c36"
+  integrity sha512-/t1ebrbHkrLrDuNMdeAcsvynWgoH/i4o8EGGfX7dEYDoTXOYVAkEpFdtshlvabzc6JlJ8Kf9YdFEoz7JkzGN9Q==
+  dependencies:
+    stackframe "^1.1.1"
+
 stack-trace@0.0.10, stack-trace@~0.0.9:
   version "0.0.10"
   resolved "https://registry.yarnpkg.com/stack-trace/-/stack-trace-0.0.10.tgz#547c70b347e8d32b4e108ea1a2a159e5fdde19c0"
@@ -9652,6 +9700,11 @@ stack-utils@^1.0.1:
   resolved "https://registry.yarnpkg.com/stack-utils/-/stack-utils-1.0.2.tgz#33eba3897788558bebfc2db059dc158ec36cebb8"
   integrity sha512-MTX+MeG5U994cazkjd/9KNAapsHnibjMLnfXodlkXw76JEea0UiNzrqidzo1emMwk7w5Qhc9jd4Bn9TBb1MFwA==
 
+stackframe@^1.1.1:
+  version "1.1.1"
+  resolved "https://registry.yarnpkg.com/stackframe/-/stackframe-1.1.1.tgz#ffef0a3318b1b60c3b58564989aca5660729ec71"
+  integrity sha512-0PlYhdKh6AfFxRyK/v+6/k+/mMfyiEBbTM5L94D0ZytQnJ166wuwoTYLHFWGbs2dpA8Rgq763KGWmN1EQEYHRQ==
+
 static-extend@^0.1.1:
   version "0.1.2"
   resolved "https://registry.yarnpkg.com/static-extend/-/static-extend-0.1.2.tgz#60809c39cbff55337226fd5e0b520f341f1fb5c6"
