Merge pull request #807 from splitio/add_getOptions

Fix localhost mode and add `getOptions` method

Author: EmilianoSanchez

CHANGES.txt

@@ -1,6 +1,8 @@
-10.26.1 (June XX, 2024)
- - Updated the internal imports of 'os' and 'ioredis' modules for NodeJS to use EcmaScript 'import' rather than CommonJS 'require' for the ES modules build, avoiding runtime errors when bundling or importing the SDK in a .mjs file.
- - Updated @splitsoftware/splitio-commons package to version 1.15.1 that includes updates on input validation logs.
+10.26.1 (June 14, 2024)
+ - Updated the internal imports of 'os' and 'ioredis' modules for NodeJS, to use EcmaScript 'import' rather than CommonJS 'require' for the ES modules build. This avoids runtime errors on some scenarios when bundling the SDK into a .mjs file or importing it from a .mjs file.
+ - 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).
 
 10.26.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",
-  "version": "10.26.1-rc.1",
+  "version": "10.26.1",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -40,7 +40,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.15.1-rc.1",
+    "@splitsoftware/splitio-commons": "1.16.0",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "bloom-filters": "^3.0.0",
@@ -50,9 +50,6 @@
     "tslib": "^2.3.1",
     "unfetch": "^4.2.0"
   },
-  "optionalDependencies": {
-    "eventsource": "^1.1.2"
-  },
   "devDependencies": {
     "@types/node-fetch": "^2.6.10",
     "@types/seedrandom": "^3.0.2",

package.json

@@ -53,15 +53,15 @@ function testInitializationFail(fetchMock, assert, fallbackToPolling) {
     fetchMock.getOnce(url(settings, '/splitChanges?s=1.1&since=1457552620999'), function () {
       assert.true(ready, 'client ready');
       const lapse = Date.now() - start;
-      assert.true(nearlyEqual(lapse, 0), 'polling (first fetch)');
+      assert.true(nearlyEqual(lapse, 0, 100), 'polling (first fetch)');
       return { status: 200, body: splitChangesMock2 };
     });
   }
 
   fetchMock.getOnce(url(settings, '/splitChanges?s=1.1&since=1457552620999'), function () {
     assert.true(ready, 'client ready');
     const lapse = Date.now() - start;
-    assert.true(nearlyEqual(lapse, settings.scheduler.featuresRefreshRate), 'polling (second fetch)');
+    assert.true(nearlyEqual(lapse, settings.scheduler.featuresRefreshRate, 100), 'polling (second fetch)');
     client.destroy().then(() => {
       assert.end();
     });

src/__tests__/nodeSuites/push-initialization-nopush.spec.js

@@ -58,7 +58,7 @@ const MILLIS_IFFU_UPDATE_EVENT_WITH_NEW_SEGMENTS = 700;
 const MILLIS_IFFU_UPDATE_EVENT_WITH_WRONG_COMPRESS = 800;
 const MILLIS_IFFU_UPDATE_EVENT_WITH_OLD_CHANGENUMBER = 900;
 const MILLIS_IFFU_UPDATE_EVENT_WITH_ZERO_PCN = 1000;
-const MILLIS_IFFU_UPDATE_EVENT_WITH_MISSING_PCN= 1100;
+const MILLIS_IFFU_UPDATE_EVENT_WITH_MISSING_PCN = 1100;
 const MILLIS_IFFU_UPDATE_EVENT_WITH_ARCHIVED = 1200;
 const MILLIS_DESTROY = 1300;
 
@@ -89,13 +89,11 @@ export function testSynchronization(fetchMock, assert) {
   setMockListener(function (eventSourceInstance) {
     const expectedSSEurl = `${url(settings, '/sse')}?channels=NzM2MDI5Mzc0_NDEzMjQ1MzA0Nw%3D%3D_segments,NzM2MDI5Mzc0_NDEzMjQ1MzA0Nw%3D%3D_splits,%5B%3Foccupancy%3Dmetrics.publishers%5Dcontrol_pri,%5B%3Foccupancy%3Dmetrics.publishers%5Dcontrol_sec&accessToken=${authPushEnabled.token}&v=1.1&heartbeats=true`;
     assert.equals(eventSourceInstance.url, expectedSSEurl, 'EventSource URL is the expected');
-    assert.deepEqual(eventSourceInstance.__eventSourceInitDict, {
-      headers: {
-        SplitSDKClientKey: 'h-1>',
-        SplitSDKVersion: settings.version,
-        SplitSDKMachineIP: settings.runtime.ip,
-        SplitSDKMachineName: settings.runtime.hostname
-      }
+    assert.deepEqual(eventSourceInstance.__eventSourceInitDict.headers, {
+      SplitSDKClientKey: 'h-1>',
+      SplitSDKVersion: settings.version,
+      SplitSDKMachineIP: settings.runtime.ip,
+      SplitSDKMachineName: settings.runtime.hostname
     }, 'EventSource headers are the expected');
 
     setTimeout(() => {
@@ -285,7 +283,7 @@ export function testSynchronization(fetchMock, assert) {
 
   // fetch segments due to IFFU SPLIT_UPDATE event with new segments
   fetchMock.getOnce(url(settings, '/segmentChanges/maur-2?since=-1'), function () {
-    return { status: 200, body: { since: 1457552650000, till: 1457552650000, name: 'maur-2', added: ['admin','mauro','nico'], removed: [] } };
+    return { status: 200, body: { since: 1457552650000, till: 1457552650000, name: 'maur-2', added: ['admin', 'mauro', 'nico'], removed: [] } };
   });
 
   // fetch feature flags due to IFFU SPLIT_UPDATE event with wrong compress code

src/__tests__/nodeSuites/push-synchronization.spec.js

@@ -88,12 +88,14 @@ tape('Browser offline mode', function (assert) {
   });
 
   // Multiple factories must handle their own `features` mock, even if instantiated with the same config.
-  const factories = [
-    SplitFactory(config),
-    SplitFactory({ ...config }),
-    SplitFactory({ ...config, features: { ...config.features }, storage: { type: 'INVALID TYPE' } }),
-    SplitFactory({ ...config, storage: { type: 'LOCALSTORAGE' } })
+  const configs = [
+    { ...config, features: { ...config.features }, storage: { type: 'INVALID TYPE' } },
+    { ...config, storage: { type: 'LOCALSTORAGE' } },
+    { ...config },
+    config,
   ];
+  const factories = configs.map(config => SplitFactory(config));
+
   let readyCount = 0, updateCount = 0, readyFromCacheCount = 0;
 
   for (let i = 0; i < factories.length; i++) {
@@ -105,7 +107,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++;
     });
@@ -211,7 +213,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',
@@ -221,10 +223,23 @@ tape('Browser offline mode', function (assert) {
           config: null
         }
       };
-      // Update the features in all factories except the last one
-      for (let i = 0; i < factories.length - 1; i++) {
+
+      // 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 < factories.length - 1; i++) {
         factories[i].settings.features = factory.settings.features;
       }
+
+      // Assigning a new object to the features property in the config 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 tape from 'tape-catch';
 import { getEventSource } from '../node';
 
 tape('getEventSource returns eventsource module in Node', assert => {
-  assert.equal(getEventSource(), require('eventsource'));
+  assert.equal(getEventSource(), require('../eventsource'));
 
   assert.end();
 });