Merge pull request #851 from rollbar/wj-stack-trace-limit

Allow configuration of stack trace limit
rollbar · May 12, 2020 · 942445a · 942445a
2 parents 029e67d + 62a6cba
commit 942445a
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 1 deletion.
diff --git a/examples/angular2/src/app/rollbar.ts b/examples/angular2/src/app/rollbar.ts
@@ -15,7 +15,8 @@ const rollbarConfig:Rollbar.Configuration = {
   ignoreDuplicateErrors: true,
   wrapGlobalEventHandlers: false,
   scrubRequestBody: true,
-  exitOnUncaughtException: false
+  exitOnUncaughtException: false,
+  stackTraceLimit: 20
 };
 
 export const RollbarService = new InjectionToken<Rollbar>('rollbar');

diff --git a/examples/error.html b/examples/error.html
@@ -16,6 +16,14 @@
       // is true in the config.
       throw new DOMException('test DOMException');
     };
+    // Deep stack error
+    window.throwDeepStackError = function throwDeepStackError(curr, limit) {
+      if (curr < limit) {
+        throwDeepStackError(curr + 1, limit);
+      } else {
+        throw new Error('deep stack error');
+      }
+    };
   </script>
 </head>
 <body>
@@ -26,4 +34,5 @@ <h1>
   </div>
   <button id="throw-error" onclick="throwError()">Throw Error</button>
   <button id="throw-dom-exception" onclick="throwDomException()">Throw DOMException</button>
+  <button id="throw-depp-stack-error" onclick="throwDeepStackError(0,20)">Throw deep stack Error</button>
 </html>
diff --git a/index.d.ts b/index.d.ts
@@ -78,6 +78,7 @@ declare namespace Rollbar {
         scrubRequestBody?: boolean;
         scrubTelemetryInputs?: boolean;
         sendConfig?: boolean;
+        stackTraceLimit?: number;
         telemetryScrubber?: TelemetryScrubber;
         transform?: (data: object) => void;
         transmit?: boolean;

diff --git a/src/rollbar.js b/src/rollbar.js
@@ -20,6 +20,7 @@ function Rollbar(options, api, logger, platform) {
   this.queue = new Queue(Rollbar.rateLimiter, api, logger, this.options);
   this.notifier = new Notifier(this.queue, this.options);
   this.telemeter = new Telemeter(this.options);
+  setStackTraceLimit(options);
   this.lastError = null;
   this.lastErrorHash = 'none';
 }
@@ -45,6 +46,7 @@ Rollbar.prototype.configure = function(options, payloadData) {
   this.options = _.merge(oldOptions, options, payload);
   this.notifier && this.notifier.configure(this.options);
   this.telemeter && this.telemeter.configure(this.options);
+  setStackTraceLimit(options);
   this.global(this.options);
   return this;
 };
@@ -151,4 +153,13 @@ function generateItemHash(item) {
   return message + '::' + stack;
 }
 
+// Node.js, Chrome, Safari, and some other browsers support this property
+// which globally sets the number of stack frames returned in an Error object.
+// If a browser can't use it, no harm done.
+function setStackTraceLimit(options) {
+  if (options.stackTraceLimit) {
+    Error.stackTraceLimit = options.stackTraceLimit;
+  }
+}
+
 module.exports = Rollbar;
diff --git a/test/browser.rollbar.test.js b/test/browser.rollbar.test.js
@@ -478,6 +478,39 @@ describe('options.captureUncaught', function() {
     done();
   });
 
+  it('should capture exta frames when stackTraceLimit is set', function(done) {
+    var server = window.server;
+    stubResponse(server);
+    server.requests.length = 0;
+
+    var oldLimit = Error.stackTraceLimit;
+    var options = {
+      accessToken: 'POST_CLIENT_ITEM_TOKEN',
+      captureUncaught: true,
+      stackTraceLimit: 50
+    };
+    var rollbar = window.rollbar = new Rollbar(options);
+
+    var element = document.getElementById('throw-depp-stack-error');
+    element.click();
+    server.respond();
+
+    var body = JSON.parse(server.requests[0].requestBody);
+
+    expect(body.access_token).to.eql('POST_CLIENT_ITEM_TOKEN');
+    expect(body.data.body.trace.exception.message).to.eql('deep stack error');
+    expect(body.data.body.trace.frames.length).to.be.above(20);
+
+    // karma doesn't unload the browser between tests, so the onerror handler
+    // will remain installed. Unset captureUncaught so the onerror handler
+    // won't affect other tests.
+    rollbar.configure({
+      captureUncaught: false,
+      stackTraceLimit: oldLimit // reset to default
+    });
+
+    done();
+  });
 });
 
 describe('options.captureUnhandledRejections', function() {