Added ability to configure the url where the errors get sent (#29)

- This is primarily necessary to support web clients that would like to avoid using api keys.

Author: trevtrich

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: Follow [these instructions](https://support.google.com/cloud/answer/6158862) to get an API key for your project.
+1. Create a browser API key: Follow [these instructions](https://support.google.com/cloud/answer/6158862) to get an API key for your project. If this is not an option for your team, you can [use a custom url](#configuring-without-an-api-key) to send your errors to.
 
 ## Quickstart
 
@@ -132,10 +132,25 @@ If you wish, you can manually delegate exceptions, e.g. `try { ... } catch(e) {
 
 ## Setup for ReactJS
 
-Follow the general instructions denoted in _Setup for JavaScript_ to load and initialize the library.  
+Follow the general instructions denoted in _Setup for JavaScript_ to load and initialize the library.
 
 There is nothing specific that needs to be done with React, other than making sure to initialize the library in your root entry point(typically `index.js`).
 
+## Configuring without an API key
+
+If you are in a situation where an API key is not an option but you already have an acceptable way to communicate with the Stackdriver API (e.g., a secure back end service running in App Engine), you can configure the endpoint that errors are sent to with the following:
+
+```javascript
+const errorHandler = new StackdriverErrorReporter();
+errorHandler.start({
+  targetUrl: '<my-custom-url>',
+  service: '<my-service>',              // (optional)
+  version: '<my-service-version>'       // (optional)
+});
+```
+
+where `targetUrl` is the url you'd like to send errors to and can be relative or absolute. This endpoint will need to support the [Report API endpoint](https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.events/report).
+
 ## Best Practices
 
 ### Only reporting in the production environment with Webpack
@@ -168,7 +183,7 @@ if (environment === 'production') {
     service: '<my-service>',              // (optional)
     version: '<my-service-version>'       // (optional)
   });
-}    
+}
 ```
 
 ### Usage as a utility

stackdriver-errors.js

@@ -40,15 +40,16 @@
    * @param {Boolean} [config.disabled=false] - Set to true to not report errors when calling report(), this can be used when developping locally.
    */
   StackdriverErrorReporter.prototype.start = function(config) {
-    if(!config.key) {
-      throw new Error('Cannot initialize: No API key provided.');
+    if(!config.key && !config.targetUrl) {
+      throw new Error('Cannot initialize: No API key or target url provided.');
     }
-    if(!config.projectId) {
-      throw new Error('Cannot initialize: No project ID provided.');
+    if(!config.projectId && !config.targetUrl) {
+      throw new Error('Cannot initialize: No project ID or target url provided.');
     }
 
     this.apiKey = config.key;
     this.projectId = config.projectId;
+    this.targetUrl = config.targetUrl;
     this.context = config.context || {};
     this.serviceContext = {service: config.service || 'web'};
     if(config.version) {
@@ -129,7 +130,8 @@
   };
 
   StackdriverErrorReporter.prototype.sendErrorPayload = function(payload, callback) {
-    var url = baseAPIUrl + this.projectId + "/events:report?key=" + this.apiKey;
+    var defaultUrl = baseAPIUrl + this.projectId + "/events:report?key=" + this.apiKey;
+    var url = this.targetUrl || defaultUrl;
 
     var xhr = new XMLHttpRequest();
     xhr.open('POST', url, true);

test/test.js

@@ -69,14 +69,18 @@ describe('Initialization', function () {
    expect(errorHandler.reportUncaughtExceptions).to.equal(true);
  });
 
- it('should fail if no API key', function () {
+ it('should fail if no API key or custom url', function () {
    expect(function() {errorHandler.start({projectId:'projectId'});}).to.throw(Error, /API/);
  });
 
- it('should fail if no project ID', function () {
+ it('should fail if no project ID or custom url', function () {
    expect(function() {errorHandler.start({key:'key'});}).to.throw(Error, /project/);
  });
 
+ it('should succeed if custom target url provided without API key or project id', function () {
+   expect(function() {errorHandler.start({targetUrl:'custom-url'});}).to.not.throw();
+ });
+
  it('should have default context', function () {
    errorHandler.start({key:'key', projectId:'projectId'});
    expect(errorHandler.context).to.eql({});
@@ -102,60 +106,75 @@ describe('Disabling', function () {
 });
 
 describe('Reporting errors', function () {
-  beforeEach(function() {
-    errorHandler.start({key:'key', projectId:'projectId'});
-  });
-
-  it('should report error messages with location', function (done) {
-    var message = 'Something broke!';
-    errorHandler.report(message, function() {
-      expectRequestWithMessage(message);
-      done();
+  describe('Default configuration', function() {
+    beforeEach(function() {
+      errorHandler.start({key:'key', projectId:'projectId'});
     });
-  });
-
 
-  it('should extract and send stack traces from Errors', function (done) {
-    var message = 'custom message';
-    // PhantomJS only attaches a stack to thrown errors
-    try {
-      throw new TypeError(message);
-    } catch(e) {
-      errorHandler.report(e, function() {
+    it('should report error messages with location', function (done) {
+      var message = 'Something broke!';
+      errorHandler.report(message, function() {
         expectRequestWithMessage(message);
         done();
       });
-    }
-  });
+    });
 
-  it('should extract and send functionName in stack traces', function (done) {
-    var message = 'custom message';
-    // PhantomJS only attaches a stack to thrown errors
-    try {
-      throwError(message)
-    } catch(e) {
-      errorHandler.report(e, function() {
-        expectRequestWithMessage('throwError');
-        done();
-      });
-    }
+    it('should extract and send stack traces from Errors', function (done) {
+      var message = 'custom message';
+      // PhantomJS only attaches a stack to thrown errors
+      try {
+        throw new TypeError(message);
+      } catch(e) {
+        errorHandler.report(e, function() {
+          expectRequestWithMessage(message);
+          done();
+        });
+      }
+    });
+
+    it('should extract and send functionName in stack traces', function (done) {
+      var message = 'custom message';
+      // PhantomJS only attaches a stack to thrown errors
+      try {
+        throwError(message)
+      } catch(e) {
+        errorHandler.report(e, function() {
+          expectRequestWithMessage('throwError');
+          done();
+        });
+      }
+    });
+
+    it('should set in stack traces when frame is anonymous', function (done) {
+      var message = 'custom message';
+      // PhantomJS only attaches a stack to thrown errors
+      try {
+        (function () {
+          throw new TypeError(message);
+        })()
+      } catch(e) {
+        errorHandler.report(e, function() {
+          expectRequestWithMessage('<anonymous>');
+          done();
+        });
+      }
+    });
   });
 
-  it('should set in stack traces when frame is anonymous', function (done) {
-    var message = 'custom message';
-    // PhantomJS only attaches a stack to thrown errors
-    try {
-      (function () {
-        throw new TypeError(message);
-      })()
-    } catch(e) {
-      errorHandler.report(e, function() {
-        expectRequestWithMessage('<anonymous>');
+  describe('Custom target url configuration', function() {
+    it('should report error messages with custom url config', function (done) {
+      var targetUrl = 'config-uri-clouderrorreporting';
+      errorHandler.start({targetUrl:targetUrl});
+
+      var message = 'Something broke!';
+      errorHandler.report(message, function() {
+        expectRequestWithMessage(message);
+        expect(requests[0].url).to.equal(targetUrl);
+
         done();
       });
-    }
+    });
   });
-
 });
 
 describe('Unhandled exceptions', function () {