@splitsoftware/splitio-commons 1.7.1 → 1.7.2

package/CHANGES.txt

@@ -1,3 +1,6 @@
+1.7.2 (October 14, 2022)
+- Bugfixing - Handle `Navigator.sendBeacon` API exceptions in the browser, and fallback to regular Fetch/XHR transport in case of error.
+
 1.7.1 (October 5, 2022)
 - Updated default value of `scheduler.featuresRefreshRate` config parameter to 60 seconds.
 

package/cjs/listeners/browser.js

@@ -100,13 +100,14 @@ var BrowserSignalListener = /** @class */ (function () {
         if (!cache.isEmpty()) {
             var dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.pop()) : cache.pop();
             if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
-                postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op just to catch a possible exception
+                postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op to handle possible promise rejection
             }
         }
     };
     /**
      * _sendBeacon method.
      * Util method that check if beacon API is available, build the payload and send it.
+     * Returns true if beacon API was used successfully, false otherwise.
      */
     BrowserSignalListener.prototype._sendBeacon = function (url, data, extraMetadata) {
         // eslint-disable-next-line compat/compat
@@ -121,8 +122,13 @@ var BrowserSignalListener = /** @class */ (function () {
                 (0, objectAssign_1.objectAssign)(json, extraMetadata);
             // Stringify the payload
             var payload = JSON.stringify(json);
-            // eslint-disable-next-line compat/compat
-            return navigator.sendBeacon(url, payload);
+            // https://xgwang.me/posts/you-may-not-know-beacon/#it-may-throw-error%2C-be-sure-to-catch
+            try { // eslint-disable-next-line compat/compat
+                return navigator.sendBeacon(url, payload);
+            }
+            catch (e) {
+                return false;
+            }
         }
         return false;
     };

package/esm/listeners/browser.js

@@ -97,13 +97,14 @@ var BrowserSignalListener = /** @class */ (function () {
         if (!cache.isEmpty()) {
             var dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.pop()) : cache.pop();
             if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
-                postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op just to catch a possible exception
+                postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op to handle possible promise rejection
             }
         }
     };
     /**
      * _sendBeacon method.
      * Util method that check if beacon API is available, build the payload and send it.
+     * Returns true if beacon API was used successfully, false otherwise.
      */
     BrowserSignalListener.prototype._sendBeacon = function (url, data, extraMetadata) {
         // eslint-disable-next-line compat/compat
@@ -118,8 +119,13 @@ var BrowserSignalListener = /** @class */ (function () {
                 objectAssign(json, extraMetadata);
             // Stringify the payload
             var payload = JSON.stringify(json);
-            // eslint-disable-next-line compat/compat
-            return navigator.sendBeacon(url, payload);
+            // https://xgwang.me/posts/you-may-not-know-beacon/#it-may-throw-error%2C-be-sure-to-catch
+            try { // eslint-disable-next-line compat/compat
+                return navigator.sendBeacon(url, payload);
+            }
+            catch (e) {
+                return false;
+            }
         }
         return false;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/listeners/browser.ts

@@ -114,7 +114,7 @@ export class BrowserSignalListener implements ISignalListener {
     if (!cache.isEmpty()) {
       const dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.pop()) : cache.pop();
       if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
-        postService(JSON.stringify(dataPayload)).catch(() => { }); // no-op just to catch a possible exception
+        postService(JSON.stringify(dataPayload)).catch(() => { }); // no-op to handle possible promise rejection
       }
     }
   }
@@ -122,6 +122,7 @@ export class BrowserSignalListener implements ISignalListener {
   /**
    * _sendBeacon method.
    * Util method that check if beacon API is available, build the payload and send it.
+   * Returns true if beacon API was used successfully, false otherwise.
    */
   private _sendBeacon(url: string, data: any, extraMetadata?: {}) {
     // eslint-disable-next-line compat/compat
@@ -138,8 +139,12 @@ export class BrowserSignalListener implements ISignalListener {
       // Stringify the payload
       const payload = JSON.stringify(json);
 
-      // eslint-disable-next-line compat/compat
-      return navigator.sendBeacon(url, payload);
+      // https://xgwang.me/posts/you-may-not-know-beacon/#it-may-throw-error%2C-be-sure-to-catch
+      try { // eslint-disable-next-line compat/compat
+        return navigator.sendBeacon(url, payload);
+      } catch (e) {
+        return false;
+      }
     }
     return false;
   }

package/types/listeners/browser.d.ts

@@ -35,6 +35,7 @@ export declare class BrowserSignalListener implements ISignalListener {
     /**
      * _sendBeacon method.
      * Util method that check if beacon API is available, build the payload and send it.
+     * Returns true if beacon API was used successfully, false otherwise.
      */
     private _sendBeacon;
 }