Merge pull request #3708 from MetaMask/build-sourcemaps

A Tale Of Sourcemaps and Sentries

app/scripts/lib/setupRaven.js

@@ -1,4 +1,4 @@
-const Raven = require('../vendor/raven.min.js')
+const Raven = require('raven-js')
 const METAMASK_DEBUG = 'GULP_METAMASK_DEBUG'
 const PROD = 'https://3567c198f8a8412082d32655da2961d0@sentry.io/273505'
 const DEV = 'https://f59f3dd640d2429d9d0e2445a87ea8e1@sentry.io/273496'
@@ -18,9 +18,35 @@ function setupRaven(opts) {
     ravenTarget = PROD
   }
 
-  Raven.config(ravenTarget, {
+  const client = Raven.config(ravenTarget, {
     release,
-  }).install()
+    transport: function(opts) {
+      // modify report urls
+      const report = opts.data
+      rewriteReportUrls(report)
+      // make request normally
+      client._makeRequest(opts)
+    },
+  })
+  client.install()
 
   return Raven
 }
+
+function rewriteReportUrls(report) {
+  // update request url
+  report.request.url = toMetamaskUrl(report.request.url)
+  // update exception stack trace
+  report.exception.values.forEach(item => {
+    item.stacktrace.frames.forEach(frame => {
+      frame.filename = toMetamaskUrl(frame.filename)
+    })
+  })
+}
+
+function toMetamaskUrl(origUrl) {
+  const filePath = origUrl.split(location.origin)[1]
+  if (!filePath) return origUrl
+  const metamaskUrl = `metamask${filePath}`
+  return metamaskUrl
+}

gulpfile.js

@@ -339,7 +339,7 @@ function generateBundler(opts, performBundle) {
   const browserifyOpts = assign({}, watchify.args, {
     entries: ['./app/scripts/'+opts.filename],
     plugin: 'browserify-derequire',
-    debug: debug,
+    debug: true,
     fullPaths: debug,
   })
 
@@ -405,13 +405,13 @@ function bundleTask(opts) {
       .pipe(buffer())
       // sourcemaps
       // loads map from browserify file
-      .pipe(gulpif(debug, sourcemaps.init({ loadMaps: true })))
+      .pipe(sourcemaps.init({ loadMaps: true }))
       // Minification
       .pipe(gulpif(opts.isBuild, uglify({
         mangle: {  reserved: [ 'MetamaskInpageProvider' ] },
       })))
       // writes .map file
-      .pipe(gulpif(debug, sourcemaps.write('./')))
+      .pipe(sourcemaps.write(debug ? './' : '../../sourcemaps'))
       // write completed bundles
       .pipe(gulp.dest('./dist/firefox/scripts'))
       .pipe(gulp.dest('./dist/chrome/scripts'))

package-lock.json

@@ -182,6 +182,48 @@
         "through2": "2.0.3"
       }
     },
+    "@sentry/cli": {
+      "version": "1.30.3",
+      "resolved": "https://registry.npmjs.org/@sentry/cli/-/cli-1.30.3.tgz",
+      "integrity": "sha1-AtD3eBwe5eG+WkMSoyX76LGzcjE=",
+      "dev": true,
+      "requires": {
+        "https-proxy-agent": "2.2.0",
+        "node-fetch": "1.7.3",
+        "progress": "2.0.0",
+        "proxy-from-env": "1.0.0"
+      },
+      "dependencies": {
+        "agent-base": {
+          "version": "4.2.0",
+          "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-4.2.0.tgz",
+          "integrity": "sha512-c+R/U5X+2zz2+UCrCFv6odQzJdoqI+YecuhnAJLa1zYaMc13zPfwMwZrr91Pd1DYNo/yPRbiM4WVf9whgwFsIg==",
+          "dev": true,
+          "requires": {
+            "es6-promisify": "5.0.0"
+          }
+        },
+        "debug": {
+          "version": "3.1.0",
+          "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz",
+          "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==",
+          "dev": true,
+          "requires": {
+            "ms": "2.0.0"
+          }
+        },
+        "https-proxy-agent": {
+          "version": "2.2.0",
+          "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-2.2.0.tgz",
+          "integrity": "sha512-uUWcfXHvy/dwfM9bqa6AozvAjS32dZSTUYd/4SEpYKRg6LEcPLshksnQYRudM9AyNvUARMfAg5TLjUDyX/K4vA==",
+          "dev": true,
+          "requires": {
+            "agent-base": "4.2.0",
+            "debug": "3.1.0"
+          }
+        }
+      }
+    },
     "@types/node": {
       "version": "8.5.5",
       "resolved": "https://registry.npmjs.org/@types/node/-/node-8.5.5.tgz",
@@ -4932,6 +4974,21 @@
         "event-emitter": "0.3.5"
       }
     },
+    "es6-promise": {
+      "version": "4.2.4",
+      "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-4.2.4.tgz",
+      "integrity": "sha512-/NdNZVJg+uZgtm9eS3O6lrOLYmQag2DjdEXuPaHlZ6RuVqgqaVZfgYCepEIKsLqwdQArOPtC3XzRLqGGfT8KQQ==",
+      "dev": true
+    },
+    "es6-promisify": {
+      "version": "5.0.0",
+      "resolved": "https://registry.npmjs.org/es6-promisify/-/es6-promisify-5.0.0.tgz",
+      "integrity": "sha1-UQnWLz5W6pZ8S2NQWu8IKRyKUgM=",
+      "dev": true,
+      "requires": {
+        "es6-promise": "4.2.4"
+      }
+    },
     "es6-set": {
       "version": "0.1.5",
       "resolved": "https://registry.npmjs.org/es6-set/-/es6-set-0.1.5.tgz",
@@ -16914,6 +16971,12 @@
         }
       }
     },
+    "proxy-from-env": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.0.0.tgz",
+      "integrity": "sha1-M8UDmPcOp+uW0h97gXYwpVeRx+4=",
+      "dev": true
+    },
     "prr": {
       "version": "1.0.1",
       "resolved": "https://registry.npmjs.org/prr/-/prr-1.0.1.tgz",
@@ -17237,6 +17300,11 @@
         "eve-raphael": "0.5.0"
       }
     },
+    "raven-js": {
+      "version": "3.24.0",
+      "resolved": "https://registry.npmjs.org/raven-js/-/raven-js-3.24.0.tgz",
+      "integrity": "sha512-+/ygcWib8PXAE7Xq53j1tYxCgkzFyp9z05LYAKp2PA9KwO4Ek74q1tkGwZyPWI/FoXOgas6jNtQ7O3tdPif6uA=="
+    },
     "raw-body": {
       "version": "2.3.2",
       "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.3.2.tgz",

package.json

@@ -29,6 +29,13 @@
     "test:mascara:build:ui": "browserify mascara/test/test-ui.js -o dist/mascara/ui.js",
     "test:mascara:build:background": "browserify mascara/src/background.js -o dist/mascara/background.js",
     "test:mascara:build:tests": "browserify test/integration/lib/first-time.js -o dist/mascara/tests.js",
+    "sentry": "export RELEASE=`cat app/manifest.json| jq -r .version` && npm run sentry:release && npm run sentry:upload",
+    "sentry:release": "npm run sentry:release:new && npm run sentry:release:clean",
+    "sentry:release:new": "sentry-cli releases --org 'metamask' --project 'metamask' new $RELEASE",
+    "sentry:release:clean": "sentry-cli releases --org 'metamask' --project 'metamask' files $RELEASE delete --all",
+    "sentry:upload": "npm run sentry:upload:source && npm run sentry:upload:maps",
+    "sentry:upload:source": "for FILEPATH in ./dist/chrome/scripts/*.js; do [ -e $FILEPATH ] || continue; export FILE=`basename $FILEPATH` && echo uploading $FILE && sentry-cli releases --org 'metamask' --project 'metamask' files $RELEASE upload $FILEPATH metamask/scripts/$FILE; done;",
+    "sentry:upload:maps": "sentry-cli releases --org 'metamask' --project 'metamask' files $RELEASE upload-sourcemaps ./dist/sourcemaps/ --url-prefix 'sourcemaps' --rewrite",
     "lint": "gulp lint",
     "lint:fix": "gulp lint:fix",
     "disc": "gulp disc --debug",
@@ -144,6 +151,7 @@
     "pumpify": "^1.3.4",
     "qrcode-npm": "0.0.3",
     "ramda": "^0.24.1",
+    "raven-js": "^3.24.0",
     "react": "^15.6.2",
     "react-addons-css-transition-group": "^15.6.0",
     "react-dom": "^15.6.2",
@@ -179,6 +187,7 @@
     "xtend": "^4.0.1"
   },
   "devDependencies": {
+    "@sentry/cli": "^1.30.3",
     "babel-core": "^6.24.1",
     "babel-eslint": "^8.0.0",
     "babel-plugin-transform-async-to-generator": "^6.24.1",