feat: Add fetchParameters to configure fetch (#1177)

* Add `fetchParameters` to configure `fetch` * Add referrerPolicy: 'origin' * Add typescript definition for fetchParameters
getsentry · Dec 20, 2017 · f5ddf9e · f5ddf9e
1 parent bd3bd9d
commit f5ddf9e
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 12 deletions.
diff --git a/docs/config.rst b/docs/config.rst
@@ -303,6 +303,20 @@ Those configuration options are documented below:
             }
         }
 
+.. describe:: fetchParameters
+
+    ``fetch()`` init parameters (https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Parameters).
+
+    Defaults:
+
+    .. code-block:: javascript
+        {
+            method: 'POST',
+            credentials: 'include',
+            keepalive: true,
+            referrerPolicy: 'origin'
+        }
+
 
 .. describe:: allowDuplicates
 

diff --git a/src/raven.js b/src/raven.js
@@ -85,6 +85,12 @@ function Raven() {
     instrument: true,
     sampleRate: 1
   };
+  this._fetchDefaults = {
+    method: 'POST',
+    credentials: 'include',
+    keepalive: true,
+    referrerPolicy: 'origin'
+  };
   this._ignoreOnError = 0;
   this._isRavenInstalled = false;
   this._originalErrorStackTraceLimit = Error.stackTraceLimit;
@@ -1903,15 +1909,21 @@ Raven.prototype = {
     var url = opts.url + '?' + urlencode(opts.auth);
 
     var evaluatedHeaders = null;
+    var evaluatedFetchParameters = {};
+
     if (opts.options.headers) {
-      evaluatedHeaders = this._evaluateHeaders(opts.options.headers);
+      evaluatedHeaders = this._evaluateHash(opts.options.headers);
+    }
+
+    if (opts.options.fetchParameters) {
+      evaluatedFetchParameters = this._evaluateHash(opts.options.fetchParameters);
     }
 
     if (supportsFetch()) {
-      var fetchOptions = {
-        method: 'POST',
-        body: stringify(opts.data)
-      };
+      evaluatedFetchParameters.body = stringify(opts.data);
+
+      var defaultFetchOptions = objectMerge({}, this._fetchDefaults);
+      var fetchOptions = objectMerge(defaultFetchOptions, evaluatedFetchParameters);
 
       if (evaluatedHeaders) {
         fetchOptions.headers = evaluatedHeaders;
@@ -1986,17 +1998,17 @@ Raven.prototype = {
     request.send(stringify(opts.data));
   },
 
-  _evaluateHeaders: function(headers) {
-    var evaluatedHeaders = {};
+  _evaluateHash: function(hash) {
+    var evaluated = {};
 
-    for (var key in headers) {
-      if (headers.hasOwnProperty(key)) {
-        var value = headers[key];
-        evaluatedHeaders[key] = typeof value === 'function' ? value() : value;
+    for (var key in hash) {
+      if (hash.hasOwnProperty(key)) {
+        var value = hash[key];
+        evaluated[key] = typeof value === 'function' ? value() : value;
       }
     }
 
-    return evaluatedHeaders;
+    return evaluated;
   },
 
   _logDebug: function(level) {

diff --git a/test/raven.test.js b/test/raven.test.js
@@ -1783,6 +1783,9 @@ describe('globals', function() {
           assert.deepEqual(window.fetch.lastCall.args, [
             'http://localhost/?a=1&b=2',
             {
+              credentials: 'include',
+              keepalive: true,
+              referrerPolicy: 'origin',
               method: 'POST',
               body: '{"foo":"bar"}'
             }

diff --git a/typescript/raven.d.ts b/typescript/raven.d.ts
@@ -68,6 +68,11 @@ declare module Raven {
           [key: string]: (string | Function);
         };
 
+        /** `fetch` init parameters */
+        fetchParameters?: {
+          [key: string]: (string | Function);
+        };
+
         /** Allow use of private/secretKey. */
         allowSecretKey?: boolean;