@splitsoftware/splitio-commons 1.15.1-rc.2 → 1.15.1-rc.3

package/CHANGES.txt

@@ -1,9 +1,9 @@
-1.16.0 (June XX, 2024)
- - Added the `getOptions` method to the `IPlatform` interface to allow the SDK to pass request options to the `fetch` method and `EventSource` constructor when fetching data from the Split servers. The method is optional and, if provided, it is called twice: first for the `fetch` options and then for the `EventSource` options.
-
-1.15.1 (May 28, 2024)
+1.16.0 (June 13, 2024)
+ - Added the `getOptions` method to the `IPlatform` interface to allow the SDK to pass request options to the `fetch` function and `EventSource` constructor when fetching data from the Split servers. The method is optional and, if provided, it is called twice: first for the `fetch` options and then for the `EventSource` options.
+   Useful for advanced use cases like configuring a proxy or validating certificates in NodeJS.
  - Updated the Redis storage to lazily import the `ioredis` dependency when the storage is created. This prevents errors when the SDK is imported or bundled in a .mjs file, as `ioredis` is a CommonJS module.
  - Bugfixing - Restored some input validation error logs that were removed in version 1.12.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 for client-side SDKs to emit SDK_UPDATE when mocked feature flags are updated in the `features` property of the config object (Related to issue https://github.com/splitio/javascript-browser-client/issues/119).
 
 1.15.0 (May 13, 2024)
  - Added an optional settings validation parameter to let overwrite the default flag spec version, used by the JS Synchronizer.

package/cjs/sync/offline/splitsParser/splitsParserFromSettings.js

@@ -19,7 +19,7 @@ function splitsParserFromSettingsFactory() {
         var names = Object.keys(currentData);
         // Different amount of items
         if (names.length !== Object.keys(previousMock).length) {
-            previousMock = currentData;
+            previousMock = (0, lang_1.merge)({}, currentData);
             return true;
         }
         return names.some(function (name) {
@@ -27,7 +27,7 @@ function splitsParserFromSettingsFactory() {
             var newTreatment = hasTreatmentChanged(previousMock[name], currentData[name]);
             var changed = newSplit || newTreatment;
             if (changed)
-                previousMock = currentData;
+                previousMock = (0, lang_1.merge)({}, currentData);
             return changed;
         });
     }

package/cjs/utils/settingsValidation/index.js

@@ -94,6 +94,8 @@ function settingsValidation(config, validationParams) {
     var defaults = validationParams.defaults, runtime = validationParams.runtime, storage = validationParams.storage, integrations = validationParams.integrations, logger = validationParams.logger, localhost = validationParams.localhost, consent = validationParams.consent, flagSpec = validationParams.flagSpec;
     // creates a settings object merging base, defaults and config objects.
     var withDefaults = (0, lang_1.merge)({}, exports.base, defaults, config);
+    // Keeps reference to the `features` property
+    withDefaults.features = (0, lang_1.get)(config, 'features');
     // ensure a valid logger.
     // First thing to validate, since other validators might use the logger.
     var log = logger(withDefaults); // @ts-ignore, modify readonly prop

package/esm/sync/offline/splitsParser/splitsParserFromSettings.js

@@ -1,4 +1,4 @@
-import { isObject, forOwn } from '../../../utils/lang';
+import { isObject, forOwn, merge } from '../../../utils/lang';
 import { parseCondition } from './parseCondition';
 function hasTreatmentChanged(prev, curr) {
     if (typeof prev !== typeof curr)
@@ -16,7 +16,7 @@ export function splitsParserFromSettingsFactory() {
         var names = Object.keys(currentData);
         // Different amount of items
         if (names.length !== Object.keys(previousMock).length) {
-            previousMock = currentData;
+            previousMock = merge({}, currentData);
             return true;
         }
         return names.some(function (name) {
@@ -24,7 +24,7 @@ export function splitsParserFromSettingsFactory() {
             var newTreatment = hasTreatmentChanged(previousMock[name], currentData[name]);
             var changed = newSplit || newTreatment;
             if (changed)
-                previousMock = currentData;
+                previousMock = merge({}, currentData);
             return changed;
         });
     }

package/esm/utils/settingsValidation/index.js

@@ -91,6 +91,8 @@ export function settingsValidation(config, validationParams) {
     var defaults = validationParams.defaults, runtime = validationParams.runtime, storage = validationParams.storage, integrations = validationParams.integrations, logger = validationParams.logger, localhost = validationParams.localhost, consent = validationParams.consent, flagSpec = validationParams.flagSpec;
     // creates a settings object merging base, defaults and config objects.
     var withDefaults = merge({}, base, defaults, config);
+    // Keeps reference to the `features` property
+    withDefaults.features = get(config, 'features');
     // ensure a valid logger.
     // First thing to validate, since other validators might use the logger.
     var log = logger(withDefaults); // @ts-ignore, modify readonly prop

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.15.1-rc.2",
+  "version": "1.15.1-rc.3",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/sync/offline/splitsParser/splitsParserFromSettings.ts

@@ -1,6 +1,6 @@
 import { ISplitPartial } from '../../../dtos/types';
 import { ISettings, SplitIO } from '../../../types';
-import { isObject, forOwn } from '../../../utils/lang';
+import { isObject, forOwn, merge } from '../../../utils/lang';
 import { parseCondition } from './parseCondition';
 
 function hasTreatmentChanged(prev: string | SplitIO.TreatmentWithConfig, curr: string | SplitIO.TreatmentWithConfig) {
@@ -22,7 +22,7 @@ export function splitsParserFromSettingsFactory() {
 
     // Different amount of items
     if (names.length !== Object.keys(previousMock).length) {
-      previousMock = currentData;
+      previousMock = merge({}, currentData) as SplitIO.MockedFeaturesMap;
       return true;
     }
 
@@ -31,7 +31,7 @@ export function splitsParserFromSettingsFactory() {
       const newTreatment = hasTreatmentChanged(previousMock[name], currentData[name]);
       const changed = newSplit || newTreatment;
 
-      if (changed) previousMock = currentData;
+      if (changed) previousMock = merge({}, currentData) as SplitIO.MockedFeaturesMap;
 
       return changed;
     });
@@ -41,7 +41,7 @@ export function splitsParserFromSettingsFactory() {
    *
    * @param settings validated object with mocked features mapping.
    */
-  return function splitsParserFromSettings(settings: ISettings): false | Record<string, ISplitPartial> {
+  return function splitsParserFromSettings(settings: Pick<ISettings, 'features'>): false | Record<string, ISplitPartial> {
     const features = settings.features as SplitIO.MockedFeaturesMap || {};
 
     if (!mockUpdated(features)) return false;

package/src/utils/settingsValidation/index.ts

@@ -109,6 +109,8 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
 
   // creates a settings object merging base, defaults and config objects.
   const withDefaults = merge({}, base, defaults, config) as ISettings;
+  // Keeps reference to the `features` property
+  withDefaults.features = get(config, 'features');
 
   // ensure a valid logger.
   // First thing to validate, since other validators might use the logger.

package/types/sync/offline/splitsParser/splitsParserFromSettings.d.ts

@@ -1,3 +1,3 @@
 import { ISplitPartial } from '../../../dtos/types';
 import { ISettings } from '../../../types';
-export declare function splitsParserFromSettingsFactory(): (settings: ISettings) => false | Record<string, ISplitPartial>;
+export declare function splitsParserFromSettingsFactory(): (settings: Pick<ISettings, 'features'>) => false | Record<string, ISplitPartial>;