@splitsoftware/splitio-browserjs 0.14.0 → 0.14.2-rc.0

package/CHANGES.txt

@@ -1,3 +1,11 @@
+0.14.2 (August XX, 2024)
+ - Updated some transitive dependencies for vulnerability fixes.
+
+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 0.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 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:
     - Added support for targeting rules based on semantic versions (https://semver.org/).
@@ -77,7 +85,7 @@
  - Updated some dependencies for vulnerability fixes.
 
 0.7.0 (June 29, 2022)
- - Added a new config option to control the tasks that listen or poll for updates on feature flags and segments, via the new config sync.enabled . Running online, Split will always pull the most recent updates upon initialization, this only affects updates fetching on a running instance. Useful when a consistent session experience is a must or to save resources when updates are not being used.
+ - Added a new config option to control the tasks that listen or poll for updates on feature flags and segments, via the new config `sync.enabled`. Running online, Split will always pull the most recent updates upon initialization, this only affects updates fetching on a running instance. Useful when a consistent session experience is a must or to save resources when updates are not being used.
  - Updated telemetry logic to track the anonymous config for user consent flag set to declined or unknown.
  - Updated submitters logic, to avoid duplicating the post of impressions to Split cloud when the SDK is destroyed while its periodic post of impressions is running.
  - Bugfixing - Updated submitters logic, to avoid dropping impressions and events that are being tracked while POST request is pending.

package/cjs/settings/defaults.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaults = void 0;
 var index_1 = require("@splitsoftware/splitio-commons/cjs/logger/index");
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
-var packageVersion = '0.14.0';
+var packageVersion = '0.14.2-rc.0';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.
@@ -28,7 +28,9 @@ exports.defaults = {
         // Maximum amount of time used before notifies me a timeout.
         readyTimeout: 10,
         // Amount of time we will wait before the first push of events.
-        eventsFirstPushWindow: 10
+        eventsFirstPushWindow: 10,
+        // Wait for large segments to emit SDK_READY event.
+        waitForLargeSegments: true,
     },
     // Consent is considered granted by default
     userConsent: constants_1.CONSENT_GRANTED,

package/cjs/settings/full.js

@@ -9,6 +9,7 @@ var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsVali
 var pluggableLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/pluggableLogger");
 var builtin_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/localhost/builtin");
 var consent_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/consent");
+var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
 var params = {
     defaults: defaults_1.defaults,
     acceptKey: true,
@@ -20,6 +21,10 @@ var params = {
     consent: consent_1.validateConsent,
 };
 function settingsFactory(config) {
-    return (0, index_1.settingsValidation)(config, params);
+    var settings = (0, index_1.settingsValidation)(config, params);
+    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+    if (settings.mode !== constants_1.STANDALONE_MODE)
+        settings.sync.largeSegmentsEnabled = false;
+    return settings;
 }
 exports.settingsFactory = settingsFactory;

package/cjs/settings/index.js

@@ -9,6 +9,7 @@ var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsVali
 var pluggableLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/pluggableLogger");
 var pluggable_2 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/localhost/pluggable");
 var consent_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/consent");
+var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
 var params = {
     defaults: defaults_1.defaults,
     acceptKey: true,
@@ -20,6 +21,10 @@ var params = {
     consent: consent_1.validateConsent,
 };
 function settingsFactory(config) {
-    return (0, index_1.settingsValidation)(config, params);
+    var settings = (0, index_1.settingsValidation)(config, params);
+    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+    if (settings.mode !== constants_1.STANDALONE_MODE)
+        settings.sync.largeSegmentsEnabled = false;
+    return settings;
 }
 exports.settingsFactory = settingsFactory;

package/esm/settings/defaults.js

@@ -1,6 +1,6 @@
 import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/esm/logger/index';
 import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/esm/utils/constants';
-var packageVersion = '0.14.0';
+var packageVersion = '0.14.2-rc.0';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.
@@ -25,7 +25,9 @@ export var defaults = {
         // Maximum amount of time used before notifies me a timeout.
         readyTimeout: 10,
         // Amount of time we will wait before the first push of events.
-        eventsFirstPushWindow: 10
+        eventsFirstPushWindow: 10,
+        // Wait for large segments to emit SDK_READY event.
+        waitForLargeSegments: true,
     },
     // Consent is considered granted by default
     userConsent: CONSENT_GRANTED,

package/esm/settings/full.js

@@ -6,6 +6,7 @@ import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/es
 import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhostWithDefault } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/localhost/builtin';
 import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
+import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
 var params = {
     defaults: defaults,
     acceptKey: true,
@@ -17,5 +18,9 @@ var params = {
     consent: validateConsent,
 };
 export function settingsFactory(config) {
-    return settingsValidation(config, params);
+    var settings = settingsValidation(config, params);
+    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+    if (settings.mode !== STANDALONE_MODE)
+        settings.sync.largeSegmentsEnabled = false;
+    return settings;
 }

package/esm/settings/index.js

@@ -6,6 +6,7 @@ import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/es
 import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhost } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/localhost/pluggable';
 import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
+import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
 var params = {
     defaults: defaults,
     acceptKey: true,
@@ -17,5 +18,9 @@ var params = {
     consent: validateConsent,
 };
 export function settingsFactory(config) {
-    return settingsValidation(config, params);
+    var settings = settingsValidation(config, params);
+    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+    if (settings.mode !== STANDALONE_MODE)
+        settings.sync.largeSegmentsEnabled = false;
+    return settings;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.14.0",
+  "version": "0.14.2-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.14.0",
+    "@splitsoftware/splitio-commons": "1.16.1-rc.5",
     "@types/google.analytics": "0.0.40",
     "tslib": "^2.3.1",
     "unfetch": "^4.2.0"

package/src/settings/defaults.ts

@@ -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.2-rc.0';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
@@ -30,7 +30,9 @@ export const defaults = {
     // Maximum amount of time used before notifies me a timeout.
     readyTimeout: 10,
     // Amount of time we will wait before the first push of events.
-    eventsFirstPushWindow: 10
+    eventsFirstPushWindow: 10,
+    // Wait for large segments to emit SDK_READY event.
+    waitForLargeSegments: true,
   },
 
   // Consent is considered granted by default

package/src/settings/full.ts

@@ -6,6 +6,7 @@ import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/sr
 import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhostWithDefault } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/localhost/builtin';
 import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/consent';
+import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
 
 const params = {
   defaults,
@@ -19,5 +20,10 @@ const params = {
 };
 
 export function settingsFactory(config: any) {
-  return settingsValidation(config, params);
+  const settings = settingsValidation(config, params);
+
+  // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+  if (settings.mode !== STANDALONE_MODE) settings.sync.largeSegmentsEnabled = false;
+
+  return settings;
 }

package/src/settings/index.ts

@@ -6,6 +6,7 @@ import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/sr
 import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhost } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/localhost/pluggable';
 import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/consent';
+import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
 
 const params = {
   defaults,
@@ -19,5 +20,10 @@ const params = {
 };
 
 export function settingsFactory(config: any) {
-  return settingsValidation(config, params);
+  const settings = settingsValidation(config, params);
+
+  // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+  if (settings.mode !== STANDALONE_MODE) settings.sync.largeSegmentsEnabled = false;
+
+  return settings;
 }

package/types/splitio.d.ts

@@ -61,6 +61,7 @@ interface ISettings {
     impressionsQueueSize: number,
     telemetryRefreshRate: number,
     segmentsRefreshRate: number,
+    largeSegmentsRefreshRate: number,
     offlineRefreshRate: number,
     eventsPushRate: number,
     eventsQueueSize: number,
@@ -70,7 +71,8 @@ interface ISettings {
     readyTimeout: number,
     requestTimeoutBeforeReady: number,
     retriesOnFailureBeforeReady: number,
-    eventsFirstPushWindow: number
+    eventsFirstPushWindow: number,
+    waitForLargeSegments: boolean
   },
   readonly storage?: SplitIO.StorageSyncFactory | SplitIO.StorageAsyncFactory,
   readonly urls: {
@@ -92,6 +94,8 @@ interface ISettings {
     splitFilters: SplitIO.SplitFilter[],
     impressionsMode: SplitIO.ImpressionsMode,
     enabled: boolean,
+    largeSegmentsEnabled: boolean,
+    flagSpecVersion: string,
     localhostMode?: SplitIO.LocalhostFactory
   },
   readonly userConsent: SplitIO.ConsentStatus
@@ -963,6 +967,13 @@ declare namespace SplitIO {
        * @default 10
        */
       eventsFirstPushWindow?: number,
+      /**
+       * Whether the SDK should wait for large segments to be ready before emitting SDK_READY event.
+       * It only applies if largeSegmentsEnabled is true.
+       * @property {boolean} waitForLargeSegments
+       * @default true
+       */
+      waitForLargeSegments?: boolean
     },
     /**
      * SDK scheduler settings.
@@ -1000,6 +1011,13 @@ declare namespace SplitIO {
        * @default 60
        */
       segmentsRefreshRate?: number,
+      /**
+       * The SDK polls Split servers for changes to large segment definitions. This parameter controls this polling period in seconds.
+       * It only applies if largeSegmentsEnabled is true.
+       * @property {number} largeSegmentsRefreshRate
+       * @default 60
+       */
+      largeSegmentsRefreshRate?: number,
       /**
        * The SDK posts the queued events data in bulks. This parameter controls the posting rate in seconds.
        * @property {number} eventsPushRate
@@ -1027,6 +1045,14 @@ declare namespace SplitIO {
        * @default 1
        */
       pushRetryBackoffBase?: number,
+    },
+    sync?: ISharedSettings['sync'] & {
+      /**
+       * Enables synchronization of large segments.
+       * @property {boolean} largeSegmentsEnabled
+       * @default false
+       */
+      largeSegmentsEnabled?: boolean
     }
   }
   /**