Merge pull request #3353 from MetaMask/sentry-fail-tx-1

Sentry - improve ethjs-rpc error formating for failed txs

app/scripts/background.js

@@ -13,9 +13,11 @@ const PortStream = require('./lib/port-stream.js')
 const NotificationManager = require('./lib/notification-manager.js')
 const MetamaskController = require('./metamask-controller')
 const firstTimeState = require('./first-time-state')
-const setupRaven = require('./setupRaven')
+const setupRaven = require('./lib/setupRaven')
+const reportFailedTxToSentry = require('./lib/reportFailedTxToSentry')
 const setupMetamaskMeshMetrics = require('./lib/setupMetamaskMeshMetrics')
 
+
 const STORAGE_KEY = 'metamask-config'
 const METAMASK_DEBUG = 'GULP_METAMASK_DEBUG'
 
@@ -86,11 +88,7 @@ function setupController (initState) {
   controller.txController.on(`tx:status-update`, (txId, status) => {
     if (status !== 'failed') return
     const txMeta = controller.txController.txStateManager.getTx(txId)
-    const errorMessage = `Transaction Failed: ${txMeta.err.message}`
+    reportFailedTxToSentry({ raven, txMeta })
-    raven.captureMessage(errorMessage, {
-      // "extra" key is required by Sentry
-      extra: txMeta,
-    })
   })
 
   // setup state persistence

app/scripts/lib/reportFailedTxToSentry.js

@@ -0,0 +1,38 @@
+const ethJsRpcSlug = 'Error: [ethjs-rpc] rpc error with payload '
+const errorLabelPrefix = 'Error: '
+
+module.exports = reportFailedTxToSentry
+
+//
+// utility for formatting failed transaction messages
+// for sending to sentry
+//
+
+function reportFailedTxToSentry({ raven, txMeta }) {
+  const errorMessage = extractErrorMessage(txMeta.err.message)
+  raven.captureMessage(errorMessage, {
+    // "extra" key is required by Sentry
+    extra: txMeta,
+  })
+}
+
+//
+// ethjs-rpc provides overly verbose error messages
+// if we detect this type of message, we extract the important part
+// Below is an example input and output
+//
+// Error: [ethjs-rpc] rpc error with payload {"id":3947817945380,"jsonrpc":"2.0","params":["0xf8eb8208708477359400830398539406012c8cf97bead5deae237070f9587f8e7a266d80b8843d7d3f5a0000000000000000000000000000000000000000000000000000000000081d1a000000000000000000000000000000000000000000000000001ff973cafa800000000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000000000000000000000000000000000000003f48025a04c32a9b630e0d9e7ff361562d850c86b7a884908135956a7e4a336fa0300d19ca06830776423f25218e8d19b267161db526e66895567147015b1f3fc47aef9a3c7"],"method":"eth_sendRawTransaction"} Error: replacement transaction underpriced
+//
+// Transaction Failed: replacement transaction underpriced
+//
+
+function extractErrorMessage(errorMessage) {
+  const isEthjsRpcError = errorMessage.includes(ethJsRpcSlug)
+  if (isEthjsRpcError) {
+    const payloadAndError = errorMessage.slice(ethJsRpcSlug.length)
+    const originalError = payloadAndError.slice(payloadAndError.indexOf(errorLabelPrefix) + errorLabelPrefix.length)
+    return `Transaction Failed: ${originalError}`
+  } else {
+    return `Transaction Failed: ${errorMessage}`
+  }
+}

app/scripts/lib/setupRaven.js

@@ -1,4 +1,4 @@
-const Raven = require('./vendor/raven.min.js')
+const Raven = require('../vendor/raven.min.js')
 const METAMASK_DEBUG = 'GULP_METAMASK_DEBUG'
 const PROD = 'https://3567c198f8a8412082d32655da2961d0@sentry.io/273505'
 const DEV = 'https://f59f3dd640d2429d9d0e2445a87ea8e1@sentry.io/273496'

app/scripts/popup.js

@@ -8,7 +8,7 @@ const extension = require('extensionizer')
 const ExtensionPlatform = require('./platforms/extension')
 const NotificationManager = require('./lib/notification-manager')
 const notificationManager = new NotificationManager()
-const setupRaven = require('./setupRaven')
+const setupRaven = require('./lib/setupRaven')
 
 // create platform global
 global.platform = new ExtensionPlatform()