Test localhost mode updates

Author: EmilianoSanchez

.github/workflows/ci-cd.yml

@@ -47,7 +47,7 @@ jobs:
         run: BUILD_BRANCH=$(echo "${GITHUB_REF#refs/heads/}") npm run build
 
       - name: Store assets
-        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/development' || github.ref == 'refs/heads/main') }}
+        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/update_js_commons' || github.ref == 'refs/heads/main') }}
         uses: actions/upload-artifact@v3
         with:
           name: assets
@@ -58,7 +58,7 @@ jobs:
     name: Upload assets
     runs-on: ubuntu-20.04
     needs: build
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development' }}
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/update_js_commons' }}
     strategy:
       matrix:
         environment:

CHANGES.txt

@@ -1,5 +1,7 @@
-0.14.1 (June XX, 2024)
- - Updated @splitsoftware/splitio-commons package to version 1.15.1 that includes updates on input validation logs.
+0.14.1 (June 14, 2024)
+ - Updated @splitsoftware/splitio-commons package to version 1.16.0 that includes some vulnerability and bug fixes.
+ - Bugfixing - Restored some input validation error logs that were removed in version 10.24.0. The logs inform the user when the `getTreatment(s)` methods are called with an invalid value as feature flag name or flag set name.
+ - Bugfixing - Fixed localhost mode to emit SDK_UPDATE when mocked feature flags are updated in the `features` object map of the config object (Related to issue https://github.com/splitio/javascript-browser-client/issues/119).
 
 0.14.0 (May 6, 2024)
  - Updated @splitsoftware/splitio-commons package to version 1.14.0 that includes minor updates:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.14.0",
+  "version": "0.14.1-rc.0",
   "description": "Split SDK for JavaScript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -64,7 +64,7 @@
   "bugs": "https://github.com/splitio/javascript-browser-client/issues",
   "homepage": "https://github.com/splitio/javascript-browser-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.15.1-rc.0",
+    "@splitsoftware/splitio-commons": "1.16.0",
     "@types/google.analytics": "0.0.40",
     "tslib": "^2.3.1",
     "unfetch": "^4.2.0"

package.json

@@ -92,10 +92,13 @@ tape('Browser offline mode', function (assert) {
     SplitFactory({ ...config, storage: InLocalStorage() }),
     SplitFactorySlim({ ...config, storage: InLocalStorage(), sync: { localhostMode: LocalhostFromObject() } }) // slim factory requires localhostFromObject module
   ];
-  const factoriesReady = [ // Multiple factories must handle their own `features` mock, even if instantiated with the same config.
-    SplitFactory(config),
-    SplitFactory({ ...config }),
-    SplitFactory({ ...config, features: { ...config.features }, storage: InLocalStorage /* invalid */, sync: { localhostMode: LocalhostFromObject /* invalid */ } }),
+  const configs = [
+    { ...config, features: { ...config.features }, storage: InLocalStorage /* invalid */, sync: { localhostMode: LocalhostFromObject /* invalid */ } },
+    { ...config },
+    config,
+  ];
+  const factoriesReady = [
+    ...configs.map(config => SplitFactory(config)),
     ...factoriesReadyFromCache
   ];
   const factoriesTimeout = [ // slim factory without a valid localhostFromObject module will timeout
@@ -115,7 +118,7 @@ tape('Browser offline mode', function (assert) {
       readyCount++;
     });
     client.on(client.Event.SDK_UPDATE, () => {
-      assert.deepEqual(manager.names(), ['testing_split', 'testing_split_2', 'testing_split_3', 'testing_split_with_config']);
+      assert.deepEqual(manager.names().sort(), ['testing_split', 'testing_split_2', 'testing_split_3', 'testing_split_with_config']);
       assert.equal(client.getTreatment('testing_split_with_config'), 'nope');
       updateCount++;
     });
@@ -225,7 +228,7 @@ tape('Browser offline mode', function (assert) {
     });
 
     setTimeout(() => {
-      // Update the features
+      // Update features reference in settings
       factory.settings.features = {
         testing_split: 'on',
         testing_split_2: 'off',
@@ -235,10 +238,23 @@ tape('Browser offline mode', function (assert) {
           config: null
         }
       };
-      // Update the features in all factories except one
-      for (let i = 1; i < factories.length; i++) {
-        factories[i].settings.features = factory.settings.features;
+
+      // Update features properties in config
+      configs[0].features['testing_split'] = 'on';
+      configs[0].features['testing_split_2'] = 'off';
+      configs[0].features['testing_split_3'] = 'custom_treatment';
+      configs[0].features['testing_split_with_config'] = {
+        treatment: 'nope',
+        config: null
+      };
+
+      // Update the features in all remaining factories except the last one
+      for (let i = 1; i < factoriesReady.length - 1; i++) {
+        factoriesReady[i].settings.features = factory.settings.features;
       }
+
+      // Assigning a new object to the features property in the config object doesn't trigger an update
+      configs[configs.length - 1].features = { ...factory.settings.features };
     }, 1000);
 
     setTimeout(() => { factory.settings.features = originalFeaturesMap; }, 200);

src/__tests__/offline/browser.spec.js

@@ -2,7 +2,7 @@ import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/src/
 import { ConsentStatus, LogLevel } from '@splitsoftware/splitio-commons/src/types';
 import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/src/utils/constants';
 
-const packageVersion = '0.14.0';
+const packageVersion = '0.14.1-rc.0';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.