includePaths, fixes #72

Author: mattrobenolt

docs/config/index.rst

@@ -55,6 +55,17 @@ Similar to ``ignoreErrors``, but will ignore errors from whole urls patching a r
       ignoreUrls: [/graph\.facebook\.com/i]
     }
 
+includePaths
+------------
+
+An array of regex patterns to indicate which urls are a part of your app. All other frames will appear collapsed inside Sentry to make it easier to discern between frames that happened in your code vs other code. It'd be suggested to add the current page url, and the host for your CDN.
+
+.. code-block:: javascript
+
+    {
+        includePaths: [/https?:\/\/getsentry\.com/, /https?:\/\/cdn\.getsentry\.com/]
+    }
+
 Putting it all together
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -73,6 +84,10 @@ Putting it all together
                 ],
                 ignoreErrors: [
                     'fb_xd_fragment'
+                ],
+                includePaths: [
+                    /https?:\/\/(www\.)?getsentry\.com/,
+                    /https?:\/\/d3nslu0hdya83q\.cloudfront\.net/
                 ]
             };
             Raven.config('https://[email protected]/1', options).install();

src/raven.js

@@ -13,6 +13,7 @@ var _Raven = window.Raven,
         logger: 'javascript',
         ignoreErrors: [],
         ignoreUrls: [],
+        includePaths: [],
         tags: {}
     };
 
@@ -59,6 +60,10 @@ var Raven = {
             });
         }
 
+        // join regexp rules into one big rule
+        globalOptions.ignoreUrls = globalOptions.ignoreUrls.length ? joinRegExp(globalOptions.ignoreUrls) : false;
+        globalOptions.includePaths = joinRegExp(globalOptions.includePaths);
+
         // "Script error." is hard coded into browsers for errors that it can't read.
         // this is the result of a script being pulled in from an external domain and CORS.
         globalOptions.ignoreErrors.push('Script error.');
@@ -301,14 +306,22 @@ function normalizeFrame(frame) {
         lineno:     frame.line,
         colno:      frame.column,
         'function': frame.func || '?'
-    }, context = extractContextFromFrame(frame);
+    }, context = extractContextFromFrame(frame), i;
 
     if (context) {
-        var i = 3, keys = ['pre_context', 'context_line', 'post_context'];
+        var keys = ['pre_context', 'context_line', 'post_context'];
+        i = 3;
         while (i--) normalized[keys[i]] = context[i];
     }
 
-    // normalized.in_app = !/(Raven|TraceKit)\./.test(normalized['function']);
+    normalized.in_app = !( // determine if an exception came from outside of our app
+        // first we check the global includePaths list.
+        !globalOptions.includePaths.test(normalized.filename) ||
+        // Now we check for fun, if the function name is Raven or TraceKit
+        /(Raven|TraceKit)\./.test(normalized['function']) ||
+        // finally, we do a last ditch effort and check for raven.min.js
+        /raven\.(min\.)js$/.test(normalized.filename)
+    );
 
     return normalized;
 }
@@ -376,12 +389,7 @@ function processException(type, message, fileurl, lineno, frames, options) {
         };
     }
 
-    i = globalOptions.ignoreUrls.length;
-    while (i--) {
-        if (globalOptions.ignoreUrls[i].test(fileurl)) {
-            return;
-        }
-    }
+    if (globalOptions.ignoreUrls && globalOptions.ignoreUrls.test(fileurl)) return;
 
     label = lineno ? message + ' at ' + lineno : message;
 
@@ -480,3 +488,11 @@ function wrapArguments(what) {
     for (var k in what) wrapped[k] = what[k];
     return wrapped;
 }
+
+function joinRegExp(patterns) {
+    // Combine an array of regular expressions into one large regexp
+    var sources = [], i = patterns.length;
+    // lol, map
+    while (i--) sources[i] = patterns[i].source;
+    return new RegExp(sources.join('|'), 'i');
+}

test/raven.test.js

@@ -8,6 +8,7 @@ function flushRavenState() {
     logger: 'javascript',
     ignoreErrors: [],
     ignoreUrls: [],
+    includePaths: [],
     tags: {}
   };
   Raven.uninstall();
@@ -32,6 +33,7 @@ function setupRaven() {
 
 describe('globals', function() {
   beforeEach(function() {
+    setupRaven();
     globalOptions.fetchContext = true;
   });
 
@@ -160,7 +162,7 @@ describe('globals', function() {
         pre_context: ['line1'],
         context_line: 'line2',
         post_context: ['line3'],
-        // in_app: true
+        in_app: true
       });
     });
 
@@ -181,7 +183,51 @@ describe('globals', function() {
         lineno: 10,
         colno: 11,
         'function': 'lol',
-        // in_app: true
+        in_app: true
+      });
+    });
+
+    it('should not mark `in_app` if rules match', function() {
+      this.sinon.stub(window, 'extractContextFromFrame').returns(undefined);
+      var frame = {
+        url: 'http://example.com/path/file.js',
+        line: 10,
+        column: 11,
+        func: 'lol'
+        // context: []  context is stubbed
+      };
+
+      globalOptions.fetchContext = true;
+      globalOptions.includePaths = /^http:\/\/example\.com/;
+
+      assert.deepEqual(normalizeFrame(frame), {
+        filename: 'http://example.com/path/file.js',
+        lineno: 10,
+        colno: 11,
+        'function': 'lol',
+        in_app: true
+      });
+    });
+
+    it('should mark `in_app` if rules do not match', function() {
+      this.sinon.stub(window, 'extractContextFromFrame').returns(undefined);
+      var frame = {
+        url: 'http://lol.com/path/file.js',
+        line: 10,
+        column: 11,
+        func: 'lol'
+        // context: []  context is stubbed
+      };
+
+      globalOptions.fetchContext = true;
+      globalOptions.includePaths = /^http:\/\/example\.com/;
+
+      assert.deepEqual(normalizeFrame(frame), {
+        filename: 'http://lol.com/path/file.js',
+        lineno: 10,
+        colno: 11,
+        'function': 'lol',
+        in_app: false
       });
     });
   });
@@ -278,7 +324,7 @@ describe('globals', function() {
     it('should respect `ignoreUrls`', function() {
       this.sinon.stub(window, 'send');
 
-      globalOptions.ignoreUrls = [/.+?host1.+/, /.+?host2.+/];
+      globalOptions.ignoreUrls = joinRegExp([/.+?host1.+/, /.+?host2.+/]);
       processException('Error', 'error', 'http://host1/', []);
       assert.isFalse(window.send.called);
       processException('Error', 'error', 'http://host2/', []);