Sentry report improvements (#330)

* [sentry][m]: promisified sending reports to Sentry - refs #329

This is necessary as we want to process.exit once report is sent but we also don't want rest of the code to run if an error occured. To make it work, we've decided to promisify the report sending part of the 'handleError' function and await until it finishes from the caller.
This commit also includes changes in `/bin/` modules to work with refactored `handleError` function.

* [validate][xs]: don't use 'handleError' function as it is tableschema error so we handle it withing the module - refs #329

* [Sentry][xs]: include all arguments into a report - refs #329

Also sending report before printing errors so it has better UX

* [Sentry][xs]: include user's OS in the report - refs #329

Author: anuveyatsu

bin/data-cat.js

@@ -54,7 +54,8 @@ const dumpIt = async (res, {sheet}={}) => {
       if (isUrl(argv._[0])) {
         error('Provided URL is invalid')
       }
-      handleError(err)
+      await handleError(err)
+      process.exit(1)
     }
 
     if (outFormat === 'ascii') { // Write to stdout

bin/data-get.js

@@ -81,7 +81,7 @@ const run = async () => {
         if (!checkDestIsEmpty(owner, name)) {
           throw new Error(`${owner}/${name} is not empty!`)
         }
-        
+
         /** For datasets from the datahub we get zipped version and unzip it.
                 - less traffic
                 - zipped version has a fancy file structure
@@ -112,7 +112,8 @@ const run = async () => {
     if (argv.debug) {
       console.log('> [debug]\n' + err.stack)
     }
-    handleError(err)
+    await handleError(err)
+    process.exit(1)
   }
 }
 
@@ -137,7 +138,8 @@ const saveFileFromUrl = (url, format) => {
       if (err.message === 'Not Found') {
         err.message += ' or Forbidden.'
       }
-      handleError(err)
+      await handleError(err)
+      process.exit(1)
     }
     stream.pipe(fs.createWriteStream(destPath)).on('finish', () => {
       resolve(destPath)

bin/data-info.js

@@ -69,6 +69,7 @@ Promise.resolve().then(async () => {
     if (!argv._[0]) {
       printInfo('Running `data info` without an argument will search a `datapackage.json` file in the current working directory.')
     }
-    handleError(err)
+    await handleError(err)
+    process.exit(1)
   }
 })

bin/data-login.js

@@ -37,7 +37,8 @@ Promise.resolve().then(async () => {
   try {
     out = await authenticate(apiUrl, token)
   } catch (err) {
-    handleError(err)
+    await handleError(err)
+    process.exit(1)
   }
   if (out.authenticated) {
     stopSpinner()
@@ -67,7 +68,8 @@ Promise.resolve().then(async () => {
   try {
     await login(apiUrl, authUrl, config.get('domain'))
   } catch (err) {
-    handleError(err)
+    await handleError(err)
+    process.exit(1)
   }
   info('You are logged in!')
   process.exit(0)

bin/data-push-flow.js

@@ -41,7 +41,8 @@ Promise.resolve().then(async () => {
   try {
     out = await authenticate(apiUrl, token)
   } catch (err) {
-    handleError(err)
+    await handleError(err)
+    process.exit(1)
   }
   if (!out.authenticated) {
     info('You need to login in order to push your data. Please, use `data login` command.')
@@ -75,6 +76,7 @@ Promise.resolve().then(async () => {
     if (argv.debug) {
       console.log('> [debug]\n' + err.stack)
     }
-    handleError(err)
+    await handleError(err)
+    process.exit(1)
   }
 })

bin/data-push.js

@@ -47,7 +47,8 @@ Promise.resolve().then(async () => {
     try {
       out = await authenticate(apiUrl, token)
     } catch (err) {
-      handleError(err)
+      await handleError(err)
+      process.exit(1)
     }
   }
   if (!out.authenticated) {
@@ -69,7 +70,8 @@ Promise.resolve().then(async () => {
         info("'data validate' to check your data.")
         info("'data init' to create a datapackage.")
         info("'data help push' to get more info.")
-        handleError(err)
+        await handleError(err)
+        process.exit(1)
       }
     } else {
       dataset = await prepareDatasetFromFile(filePath)
@@ -137,7 +139,8 @@ Promise.resolve().then(async () => {
     if (argv.debug) {
       console.log('> [debug]\n' + err.stack)
     }
-    handleError(err)
+    await handleError(err)
+    process.exit(1)
   }
 })
 

bin/data-validate.js

@@ -11,7 +11,7 @@ const {eraseLines} = require('ansi-escapes')
 
 // Ours
 const {customMarked} = require('../lib/utils/tools')
-const {handleError, error} = require('../lib/utils/error')
+const {error} = require('../lib/utils/error')
 const wait = require('../lib/utils/output/wait')
 const info = require('../lib/utils/output/info')
 
@@ -71,7 +71,11 @@ validator.validate().then(result => {
       })
     }
     else {
-      handleError(result)
+      if (result.constructor.name === 'Array') {
+        result.forEach(err => error(err.message))
+      } else {
+        error(result)
+      }
     }
   }
 }).catch(err => {

bin/data.js

@@ -19,12 +19,14 @@ const updateNotifier = require('../lib/utils/update')
 require('events').EventEmitter.defaultMaxListeners = 120;
 
 // Handle all uncaught exceptions and unhandled rejections
-process.on('uncaughtException', (err) => {
-  handleError(err)
+process.on('uncaughtException', async (err) => {
+  await handleError(err)
+  process.exit(1)
 })
 
-process.on('unhandledRejection', (err) => {
-  handleError(err)
+process.on('unhandledRejection', async (err) => {
+  await handleError(err)
+  process.exit(1)
 })
 
 // Check and notify if any updates are available:

lib/utils/error.js

@@ -7,25 +7,28 @@ const {version} = require('../../package.json')
 const {installedWithNPM} = require('./tools')
 
 
-function handleError(err, {debug = false} = {}) {
+async function handleError(err, {debug = false} = {}) {
   if (process.env.datahub !== 'dev') { // Send report to Sentry if not dev env
     // Setup Sentry:
     Raven.config('https://e29902aa81ed414d867f51bd0d1ab91a:[email protected]/305079', {
       release: version,
       extra: {
-        firstArg: process.argv.slice(2, 3),
-        rest: process.argv.slice(3, process.argv.length),
-        nodejsOrBin: installedWithNPM ? process.version : 'bin'
+        args: process.argv,
+        nodejsOrBin: installedWithNPM ? process.version : 'bin',
+        os: process.platform
       }
     })
 
-    // Capture errors:
-    Raven.captureException(err, (sendErr, eventId) => {
-      // Once report is sent exit with code 1:
-      process.exit(1)
+    await new Promise((resolve, reject) => {
+      // Capture errors:
+      Raven.captureException(err, (sendErr, eventId) => {
+        // Once report is sent resolve the promise. However, we resolve it even
+        // if it failed to send a report:
+        resolve()
+      })
     })
   }
-
+  
   // Coerce Strings to Error instances
   if (typeof err === 'string') {
     err = new Error(err)