Merge pull request #630 from Countly/rc-delay-merge-fix

RC ID change fix

Author: turtledreams

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 26.1.2
+
+- Delayed remote config refresh after merged device ID changes to reduce request ordering races.
+
 ## 26.1.1
 
 - Improved device metric detection capabilities.

cypress/e2e/bridged_utils.cy.js

@@ -15,7 +15,7 @@ function initMain(name, version) {
 }
 
 const SDK_NAME = "javascript_native_web";
-const SDK_VERSION = "26.1.1";
+const SDK_VERSION = "26.1.2";
 
 // tests
 describe("Bridged SDK Utilities Tests", () => {

cypress/e2e/device_id_change.cy.js

@@ -275,3 +275,48 @@ describe("Set ID change tests ", () => {
     });
 
 });
+
+describe("Device ID remote config sequencing", () => {
+    it("delays remote config refetch by 1 second after merge device ID changes", () => {
+        hp.haltAndClearStorage(() => {
+            var fakeServer = hp.createFakeRequestHandler({
+                onRequest: function (req) {
+                    if (req.functionName === "fetch_remote_config_explicit") {
+                        return { status: 200, responseText: "{}" };
+                    }
+
+                    return { status: 200, responseText: '{"result":"Success"}' };
+                }
+            });
+
+            var inst = Countly.init({
+                app_key: hp.appKey,
+                url: "https://test.count.ly",
+                device_id: "old ID",
+                debug: true,
+                use_explicit_rc_api: true,
+                disable_sdk_behavior_settings_updates: true,
+                fake_request_handler: fakeServer.handler
+            });
+
+            cy.wait(hp.sWait).then(() => {
+                inst.remote_config = function () { };
+                fakeServer.clear();
+                Countly.change_id("new ID", true);
+            });
+
+            cy.wait(300).then(() => {
+                var earlyRemoteConfigRequest = fakeServer.getRequests().find((req) => req.functionName === "fetch_remote_config_explicit");
+                expect(earlyRemoteConfigRequest).to.not.exist;
+            });
+
+            cy.wait(1100).then(() => {
+                var requests = fakeServer.getRequests();
+                var remoteConfigRequest = requests.find((req) => req.functionName === "fetch_remote_config_explicit");
+
+                expect(remoteConfigRequest).to.exist;
+                expect(remoteConfigRequest.params.device_id).to.equal("new ID");
+            });
+        });
+    });
+});

cypress/e2e/sdk_info.cy.js

@@ -3,7 +3,7 @@
 var Countly = require("../../lib/countly");
 var hp = require("../support/helper.js");
 const SDK_NAME = "javascript_native_web";
-const SDK_VERSION = "26.1.1";
+const SDK_VERSION = "26.1.2";
 
 function initMain(name, version) {
     Countly.init({

lib/countly.js

@@ -350,7 +350,7 @@
         backoffCount: "cly_hc_backoff_count",
         consecutiveBackoffCount: "cly_hc_consecutive_backoff_count"
     });
-    var SDK_VERSION = "26.1.1";
+    var SDK_VERSION = "26.1.2";
     var SDK_NAME = "javascript_native_web";
 
     // Using this on document.referrer would return an array with 17 elements in it. The 12th element (array[11]) would be the path we are looking for. Others would be things like password and such (use https://regex101.com/ to check more)
@@ -1200,6 +1200,7 @@
     var _clientHintsPromise = /*#__PURE__*/new WeakMap();
     var _pendingRequestBuffer = /*#__PURE__*/new WeakMap();
     var _clientHintsBufferTimeoutId = /*#__PURE__*/new WeakMap();
+    var _changeIdRemoteConfigTimeoutId = /*#__PURE__*/new WeakMap();
     var _initializeClientHints = /*#__PURE__*/new WeakMap();
     var _flushPendingRequestBuffer = /*#__PURE__*/new WeakMap();
     var _getAndSetServerConfig = /*#__PURE__*/new WeakMap();
@@ -1396,6 +1397,7 @@
         _classPrivateFieldInitSpec(this, _clientHintsPromise, void 0);
         _classPrivateFieldInitSpec(this, _pendingRequestBuffer, void 0);
         _classPrivateFieldInitSpec(this, _clientHintsBufferTimeoutId, void 0);
+        _classPrivateFieldInitSpec(this, _changeIdRemoteConfigTimeoutId, void 0);
         /**
          * Fetch User-Agent Client Hints and cache values for metrics enrichment.
          * @private
@@ -2201,6 +2203,10 @@
                 clearTimeout(_classPrivateFieldGet2(_clientHintsBufferTimeoutId, _this));
                 _classPrivateFieldSet2(_clientHintsBufferTimeoutId, _this, null);
             }
+            if (_classPrivateFieldGet2(_changeIdRemoteConfigTimeoutId, _this)) {
+                clearTimeout(_classPrivateFieldGet2(_changeIdRemoteConfigTimeoutId, _this));
+                _classPrivateFieldSet2(_changeIdRemoteConfigTimeoutId, _this, null);
+            }
             _classPrivateFieldSet2(_pendingRequestBuffer, _this, null);
             _classPrivateFieldSet2(_clientHintsPromise, _this, null);
             _classPrivateFieldSet2(_uaClientHints, _this, null);
@@ -2635,7 +2641,17 @@
             if (_this.remote_config) {
                 _classPrivateFieldSet2(_remoteConfigs, _this, {});
                 _classPrivateFieldGet2(_setValueInStorage, _this).call(_this, "cly_remote_configs", _classPrivateFieldGet2(_remoteConfigs, _this));
-                _this.fetch_remote_config(_this.remote_config);
+                if (merge) {
+                    if (_classPrivateFieldGet2(_changeIdRemoteConfigTimeoutId, _this)) {
+                        clearTimeout(_classPrivateFieldGet2(_changeIdRemoteConfigTimeoutId, _this));
+                    }
+                    _classPrivateFieldSet2(_changeIdRemoteConfigTimeoutId, _this, setTimeout(function () {
+                        _classPrivateFieldSet2(_changeIdRemoteConfigTimeoutId, _this, null);
+                        _this.fetch_remote_config(_this.remote_config);
+                    }, 1000));
+                } else {
+                    _this.fetch_remote_config(_this.remote_config);
+                }
             }
         });
         /**
@@ -7642,6 +7658,7 @@
         _classPrivateFieldSet2(_clientHintsPromise, this, null);
         _classPrivateFieldSet2(_pendingRequestBuffer, this, null);
         _classPrivateFieldSet2(_clientHintsBufferTimeoutId, this, null);
+        _classPrivateFieldSet2(_changeIdRemoteConfigTimeoutId, this, null);
         this.app_key = getConfig("app_key", _ob, null);
         this.url = stripTrailingSlash(getConfig("url", _ob, ""));
         this.serialize = getConfig("serialize", _ob, Countly.serialize);