Merge branch 'master' of github.com:GoogleCloudPlatform/stackdriver-errors-js

Author: steren

README.md

@@ -16,7 +16,7 @@ Here's an introductory video:
 
 1. You need a [Google Cloud project](https://console.cloud.google.com).
 1. [Enable the Stackdriver Error Reporting API](https://console.cloud.google.com/apis/api/clouderrorreporting.googleapis.com/overview) for your project. We highly recommend to restrict the usage of the key to your website URL only using an 'HTTP referrer' restriction.
-1. Create a browser API key: 
+1. Create a browser API key:
 
   - Follow [these instructions](https://support.google.com/cloud/answer/6158862) to get an API key for your project.
   - Recommended: Use **Application restrictions** to restrict this key to your website.
@@ -75,11 +75,12 @@ window.addEventListener('DOMContentLoaded', function() {
   errorHandler.start({
     key: '<my-api-key>',
     projectId: '<my-project-id>',
-    service: '<my-service>',              // (optional)
-    version: '<my-service-version>',      // (optional)
-    // reportUncaughtExceptions: false    // (optional) Set to false to stop reporting unhandled exceptions.
-    // disabled: true                     // (optional) Set to true to not report errors when calling report(), this can be used when developping locally.
-    // context: {user: 'user1'}           // (optional) You can set the user later using setUser()
+    service: '<my-service>',                    // (optional)
+    version: '<my-service-version>',            // (optional)
+    // reportUncaughtExceptions: false          // (optional) Set to false to stop reporting unhandled exceptions.
+    // reportUnhandledPromiseRejections: false  // (optional) Set to false to stop reporting unhandled promise rejections.
+    // disabled: true                           // (optional) Set to true to not report errors when calling report(), this can be used when developping locally.
+    // context: {user: 'user1'}                 // (optional) You can set the user later using setUser()
   });
 });
 </script>

stackdriver-errors.js

@@ -60,6 +60,7 @@
       this.serviceContext.version = config.version;
     }
     this.reportUncaughtExceptions = config.reportUncaughtExceptions !== false;
+    this.reportUnhandledPromiseRejections = config.reportUnhandledPromiseRejections !== false;
     this.disabled = config.disabled || false;
 
     // Register as global error handler if requested
@@ -75,6 +76,17 @@
         return true;
       };
     }
+    if(this.reportUnhandledPromiseRejections) {
+      var oldPromiseRejectionHandler = window.onunhandledrejection || function(){};
+
+      window.onunhandledrejection = function(promiseRejectionEvent) {
+        if(promiseRejectionEvent){
+          that.report(promiseRejectionEvent.reason);
+        }
+        oldPromiseRejectionHandler(promiseRejectionEvent.reason);
+        return true;
+      };
+    }
   };
 
   /**

test/test.js

@@ -17,6 +17,7 @@ var expect = chai.expect;
 
 var errorHandler;
 var xhr, requests;
+var WAIT_FOR_STACKTRACE_FROMERROR = 15;
 
 /** 
  * Helper function testing if a given message has been reported
@@ -37,6 +38,7 @@ function throwError(message) {
 
 beforeEach(function() {
   window.onerror= function(){};
+  window.onunhandledrejection = function(){};
 
   errorHandler = new StackdriverErrorReporter();
 
@@ -69,6 +71,11 @@ describe('Initialization', function () {
    expect(errorHandler.reportUncaughtExceptions).to.equal(true);
  });
 
+ it('should by default report unhandled promise rejections', function () {
+   errorHandler.start({key:'key', projectId:'projectId'});
+   expect(errorHandler.reportUnhandledPromiseRejections).to.equal(true);
+ });
+
  it('should fail if no API key or custom url', function () {
    expect(function() {errorHandler.start({projectId:'projectId'});}).to.throw(Error, /API/);
  });
@@ -198,7 +205,7 @@ describe('Unhandled exceptions', function () {
       setTimeout(function(){
         expectRequestWithMessage(message);
         done();
-      }, 10);
+      }, WAIT_FOR_STACKTRACE_FROMERROR);
     }
   });
 
@@ -213,11 +220,51 @@ describe('Unhandled exceptions', function () {
       throw new TypeError(message);
     } catch(e) {
       window.onerror(message, 'test.js', 42, 42, e);
-      expect(originalOnErrorCalled).to.be.true;
-      done();
+
+      setTimeout(function(){
+        expect(originalOnErrorCalled).to.be.true;
+        done();
+      }, WAIT_FOR_STACKTRACE_FROMERROR);
+    }
+  });
+});
+
+describe('Unhandled promise rejections', function () {
+
+  it('should be reported by default', function (done) {
+    errorHandler.start({key:'key', projectId:'projectId'});
+
+    var message = 'custom promise rejection message';
+    try {
+      throwError(message);
+    } catch(e) {
+      var promiseRejectionEvent = {reason: e};
+
+      window.onunhandledrejection(promiseRejectionEvent);
+
+      setTimeout(function(){
+        expectRequestWithMessage(message);
+        done();
+      }, WAIT_FOR_STACKTRACE_FROMERROR);
     }
   });
 
+  it('should keep calling previous promise rejection handler if already present', function (done) {
+    var originalOnUnhandledRejectionCalled = false;
+    window.onunhandledrejection = function(){ originalOnUnhandledRejectionCalled = true;};
+
+    errorHandler.start({key:'key', projectId:'projectId'});
+
+    var message = 'custom promise rejection message';
+    var promiseRejectionEvent = {reason: new TypeError(message)};
+
+    window.onunhandledrejection(promiseRejectionEvent);
+
+    setTimeout(function(){
+      expect(originalOnUnhandledRejectionCalled).to.be.true;
+      done();
+    }, WAIT_FOR_STACKTRACE_FROMERROR);
+  });
 });
 
 describe('Setting user', function() {