Merge pull request #1 from duizendnegen/master

fill a meta tag with the current revision when uploading

Author: dschmidt

README.md

@@ -36,28 +36,33 @@ ENV.sentry {
 ```
 - Integrate [raven-js][2] in your page
 
-It's important to initialize the client with `release` as the `revisionKey`.
-You will probably need to either write the `revisionKey` into your `index.html` file at build time or when serving it.
-
-For example add this to your `index.html` and dynamically replace the `$REVISION` string with `revisionKey`:
+By default a meta tag with the key name `sentry:revision` is inserted in your index.html, like so
 ```html
-<meta name="revision" content="$REVISION">
+<meta name="sentry:revision" content="(revision)">
+```
+
+Disabling this behavior is done by configuring in `deploy.js`:
+```javascript
+ENV.sentry {
+  // ... other config options
+  enableRevisionTagging: false
+}
 ```
 
-Then when you setup [raven-js][2] you can retrieve it like so:
+When you setup [raven-js][2] you can retrieve it like so:
 
 ```javascript
 Raven.config({
-    release: $("meta[name='revision']").attr('content')
+    release: $("meta[name='sentry:revision']").attr('content')
 });
 ```
 
 Last but not least make sure to setup proper exception catching like [this](https://github.com/getsentry/raven-js/blob/master/plugins/ember.js).
 
 
-We don't use it (yet), but [ember-cli-sentry](https://github.com/damiencaselli/ember-cli-sentry) is probably useful to get started quickly. (It also sets up the exception handlers for you)
-Apparently for it to work you will need to set `revisionKey` to your application's `config.APP.version` or set [raven-js][2]'s `release` option later via
-`Raven.setReleaseContext($("meta[name='revision']").attr('content'))`.
+Also, [ember-cli-sentry](https://github.com/damiencaselli/ember-cli-sentry) is useful to get started quickly. (It also sets up the exception handlers for you)
+For it to work you will need to set `revisionKey` to your application's `config.APP.version` or set [raven-js][2]'s `release` option later via
+`Raven.setReleaseContext($("meta[name='sentry:revision']").attr('content'))`. Doing this automatically
 
 - Build sourcemaps in production environment
 

index.js

@@ -13,6 +13,12 @@ var fs = require('fs');
 module.exports = {
   name: 'ember-cli-deploy-sentry',
 
+  contentFor: function(type, config) {
+    if (type === 'head-footer') {
+      return '<meta name="sentry:revision"></meta>';
+    }
+  },
+
   createDeployPlugin: function(options) {
     var DeployPlugin = DeployPluginBase.extend({
       name: options.name,
@@ -24,6 +30,7 @@ module.exports = {
         revisionKey: function(context) {
           return context.revisionData && context.revisionData.revisionKey;
         },
+        enableRevisionTagging: true,
 
         didDeployMessage: function(context){
           return "Uploaded sourcemaps to sentry release: "
@@ -46,9 +53,30 @@ module.exports = {
         this.log('config ok');
       },
 
+      willUpload: function(context) {
+        var isEnabled = this.readConfig('enableRevisionTagging');
+        if(!isDisabled) {
+          return;
+        }
+
+        var revisionKey = this.readConfig('revisionKey');
+        if(!revisionKey) {
+          return new SilentError("Could not find revision key to fingerprint Sentry revision with.");
+        }
+
+        // TODO instead of plainly reading index.html, minimatch
+        // getConfig('revision patterns') on context.distFiles
+        var indexPath = path.join(context.distDir, "index.html");
+        var index = fs.readFileSync(indexPath, 'utf8');
+        var index = index.replace('<meta name="sentry:revision">',
+            '<meta name="sentry:revision" content="'+revisionKey+'">');
+
+        fs.writeFileSync(indexPath, index);
+      },
+
       _createRelease: function createRelease(sentrySettings) {
         var url = urljoin(sentrySettings.url, '/api/0/projects/', sentrySettings.organizationSlug,  sentrySettings.projectSlug, '/releases/');
-      
+
         return request({
           uri: url,
           method: 'POST',
@@ -64,7 +92,7 @@ module.exports = {
       },
       _deleteRelease: function createRelease(sentrySettings) {
         var url = urljoin(sentrySettings.url, '/api/0/projects/', sentrySettings.organizationSlug,  sentrySettings.projectSlug, '/releases/', sentrySettings.release) + '/';
-      
+
         return request({
           uri: url,
           method: 'DELETE',
@@ -78,7 +106,7 @@ module.exports = {
           resolveWithFullResponse: true
         });
       },
-    
+
       _getUploadFiles: function getUploadFiles(dir, filePattern) {
         var pattern = path.join(dir, filePattern);
         return new Promise(function(resolve, reject) {
@@ -94,17 +122,17 @@ module.exports = {
           return files.map(function(file) {
             return path.relative(dir, file);
           });
-        });     
+        });
       },
-      
+
       _uploadFile: function uploadFile(sentrySettings, distDir, filePath) {
         var url = urljoin(sentrySettings.url, '/api/0/projects/', sentrySettings.organizationSlug,  sentrySettings.projectSlug, '/releases/', sentrySettings.release, '/files/');
-  
+
         var formData = {
           name: urljoin(sentrySettings.publicUrl, filePath),
           file: fs.createReadStream(path.join(distDir, filePath))
         };
-        
+
         return request({
           method: 'POST',
           uri: url,
@@ -114,7 +142,7 @@ module.exports = {
           formData: formData
         });
       },
-      
+
       _getReleaseFiles: function getReleaseFiles(sentrySettings) {
         var url = urljoin(sentrySettings.url, '/api/0/projects/', sentrySettings.organizationSlug,  sentrySettings.projectSlug, '/releases/', sentrySettings.release, '/files') + '/';
         return request({
@@ -141,15 +169,15 @@ module.exports = {
             release: plugin.readConfig('revisionKey')
         };
         var filePattern = this.readConfig('filePattern');
-        
+
         if(!sentrySettings.release) {
           throw new SilentError('revisionKey setting is not available, either provide it manually or make sure the ember-cli-deploy-revision-data plugin is loaded');
         }
         return this._deleteRelease(sentrySettings).then(function() {}, function() {}).then(function() {
           return plugin._createRelease(sentrySettings).then(function(response) {
             return plugin._getUploadFiles(distDir, filePattern).then(function(files) {
                 var uploads = [];
-                for(var i=0;i<files.length;i++) { 
+                for(var i=0;i<files.length;i++) {
                     var file = files[i];
                     uploads.push(plugin._uploadFile(sentrySettings, distDir, files[i]));
                 }