@splitsoftware/splitio-commons 1.13.1 → 1.13.2-rc.0

package/CHANGES.txt

@@ -1,3 +1,7 @@
+1.14.0 (April XX, 2024)
+ - Updated impression label to 'unsupported matcher type' when the matcher type is not supported by the SDK.
+ - Updated Split API client to use the version query param for the `splitChanges` endpoint.
+
 1.13.1 (January 10, 2024)
  - Updated client `destroy` method to release SDK key immediately and avoid unexpected warning logs when a factory is created with the same SDK key after the previous one was destroyed.
 

package/CONTRIBUTORS-GUIDE.md

@@ -1,4 +1,4 @@
-# Contributing to the Split Javascript SDK Commons
+# Contributing to the Split JavaScript SDK Commons
 
 Split SDK is an open source project and we welcome feedback and contribution. The information below describes how to build the project with your changes, run the tests, and send the Pull Request(PR).
 

package/README.md

@@ -1,4 +1,4 @@
-# Split Javascript SDK common components
+# Split JavaScript SDK common components
 
 [![npm version](https://badge.fury.io/js/%40splitsoftware%2Fsplitio-commons.svg)](https://badge.fury.io/js/%40splitsoftware%2Fsplitio-commons) [![Build Status](https://github.com/splitio/javascript-commons/actions/workflows/ci.yml/badge.svg)](https://github.com/splitio/javascript-commons/actions/workflows/ci.yml)
 
@@ -27,13 +27,15 @@ Split has built and maintains SDKs for:
 * .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
 * Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
+* Flutter [Github](https://github.com/splitio/flutter-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/8096158017165-Flutter-plugin)
 * GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
 * iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
-* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
-* Javascript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
+* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
+* PHP thin-client [Github](https://github.com/splitio/php-thin-client) [Docs](https://help.split.io/hc/en-us/articles/18305128673933-PHP-Thin-Client-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
 * React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
 * React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)

package/cjs/evaluator/combiners/ifelseif.js

@@ -12,7 +12,7 @@ function ifElseIfCombinerContext(log, predicates) {
         log.error(constants_2.ERROR_ENGINE_COMBINER_IFELSEIF);
         return {
             treatment: constants_1.CONTROL,
-            label: LabelsConstants.EXCEPTION
+            label: LabelsConstants.UNSUPPORTED_MATCHER_TYPE
         };
     }
     function computeTreatment(predicateResults) {

package/cjs/sdkClient/sdkClient.js

@@ -31,6 +31,8 @@ function sdkClientFactory(params, isSharedClient) {
     function __flush() {
         return syncManager ? syncManager.flush() : Promise.resolve();
     }
+    // Same promise if `destroy` is called multiple times
+    var destroyPromise;
     return (0, objectAssign_1.objectAssign)(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus), 
@@ -43,6 +45,8 @@ function sdkClientFactory(params, isSharedClient) {
             return __cooldown(__flush, COOLDOWN_TIME_IN_MILLIS);
         },
         destroy: function () {
+            if (destroyPromise)
+                return destroyPromise;
             // Mark the SDK as destroyed immediately
             sdkReadinessManager.readinessManager.destroy();
             // For main client, release the SDK Key and record stat before flushing data
@@ -52,7 +56,7 @@ function sdkClientFactory(params, isSharedClient) {
             }
             // Stop background jobs
             syncManager && syncManager.stop();
-            return __flush().then(function () {
+            destroyPromise = __flush().then(function () {
                 // Cleanup event listeners
                 signalListener && signalListener.stop();
                 // @TODO stop only if last client is destroyed
@@ -61,6 +65,7 @@ function sdkClientFactory(params, isSharedClient) {
                 // Cleanup storage
                 return storage.destroy();
             });
+            return destroyPromise;
         }
     });
 }

package/cjs/services/splitApi.js

@@ -41,7 +41,7 @@ function splitApiFactory(settings, platform, telemetryTracker) {
             return splitHttpClient(url, undefined, telemetryTracker.trackHttp(constants_1.TOKEN));
         },
         fetchSplitChanges: function (since, noCache, till) {
-            var url = urls.sdk + "/splitChanges?since=" + since + (till ? '&till=' + till : '') + (filterQueryString || '');
+            var url = urls.sdk + "/splitChanges?v=1.0&since=" + since + (till ? '&till=' + till : '') + (filterQueryString || '');
             return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.SPLITS))
                 .catch(function (err) {
                 if (err.statusCode === 414)

package/cjs/storages/KeyBuilder.js

@@ -66,10 +66,10 @@ var KeyBuilder = /** @class */ (function () {
 }());
 exports.KeyBuilder = KeyBuilder;
 /**
- * Generates a murmur32 hash based on the authorization key and the feature flags filter query.
+ * Generates a murmur32 hash based on the authorization key, the feature flags filter query, and version of SplitChanges API.
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 function getStorageHash(settings) {
-    return (0, murmur3_1.hash)(settings.core.authorizationKey + "::" + settings.sync.__splitFiltersValidation.queryString).toString(16);
+    return (0, murmur3_1.hash)(settings.core.authorizationKey + "::" + settings.sync.__splitFiltersValidation.queryString + "::1.0").toString(16);
 }
 exports.getStorageHash = getStorageHash;

package/cjs/utils/labels/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NOT_IN_SPLIT = exports.SPLIT_ARCHIVED = exports.EXCEPTION = exports.SDK_NOT_READY = exports.SPLIT_NOT_FOUND = exports.NO_CONDITION_MATCH = exports.SPLIT_KILLED = void 0;
+exports.UNSUPPORTED_MATCHER_TYPE = exports.NOT_IN_SPLIT = exports.SPLIT_ARCHIVED = exports.EXCEPTION = exports.SDK_NOT_READY = exports.SPLIT_NOT_FOUND = exports.NO_CONDITION_MATCH = exports.SPLIT_KILLED = void 0;
 exports.SPLIT_KILLED = 'killed';
 exports.NO_CONDITION_MATCH = 'default rule';
 exports.SPLIT_NOT_FOUND = 'definition not found';
@@ -8,3 +8,4 @@ exports.SDK_NOT_READY = 'not ready';
 exports.EXCEPTION = 'exception';
 exports.SPLIT_ARCHIVED = 'archived';
 exports.NOT_IN_SPLIT = 'not in split';
+exports.UNSUPPORTED_MATCHER_TYPE = 'unsupported matcher type';

package/esm/evaluator/combiners/ifelseif.js

@@ -8,7 +8,7 @@ export function ifElseIfCombinerContext(log, predicates) {
         log.error(ERROR_ENGINE_COMBINER_IFELSEIF);
         return {
             treatment: CONTROL,
-            label: LabelsConstants.EXCEPTION
+            label: LabelsConstants.UNSUPPORTED_MATCHER_TYPE
         };
     }
     function computeTreatment(predicateResults) {

package/esm/sdkClient/sdkClient.js

@@ -28,6 +28,8 @@ export function sdkClientFactory(params, isSharedClient) {
     function __flush() {
         return syncManager ? syncManager.flush() : Promise.resolve();
     }
+    // Same promise if `destroy` is called multiple times
+    var destroyPromise;
     return objectAssign(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus), 
@@ -40,6 +42,8 @@ export function sdkClientFactory(params, isSharedClient) {
             return __cooldown(__flush, COOLDOWN_TIME_IN_MILLIS);
         },
         destroy: function () {
+            if (destroyPromise)
+                return destroyPromise;
             // Mark the SDK as destroyed immediately
             sdkReadinessManager.readinessManager.destroy();
             // For main client, release the SDK Key and record stat before flushing data
@@ -49,7 +53,7 @@ export function sdkClientFactory(params, isSharedClient) {
             }
             // Stop background jobs
             syncManager && syncManager.stop();
-            return __flush().then(function () {
+            destroyPromise = __flush().then(function () {
                 // Cleanup event listeners
                 signalListener && signalListener.stop();
                 // @TODO stop only if last client is destroyed
@@ -58,6 +62,7 @@ export function sdkClientFactory(params, isSharedClient) {
                 // Cleanup storage
                 return storage.destroy();
             });
+            return destroyPromise;
         }
     });
 }

package/esm/services/splitApi.js

@@ -38,7 +38,7 @@ export function splitApiFactory(settings, platform, telemetryTracker) {
             return splitHttpClient(url, undefined, telemetryTracker.trackHttp(TOKEN));
         },
         fetchSplitChanges: function (since, noCache, till) {
-            var url = urls.sdk + "/splitChanges?since=" + since + (till ? '&till=' + till : '') + (filterQueryString || '');
+            var url = urls.sdk + "/splitChanges?v=1.0&since=" + since + (till ? '&till=' + till : '') + (filterQueryString || '');
             return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(SPLITS))
                 .catch(function (err) {
                 if (err.statusCode === 414)

package/esm/storages/KeyBuilder.js

@@ -62,9 +62,9 @@ var KeyBuilder = /** @class */ (function () {
 }());
 export { KeyBuilder };
 /**
- * Generates a murmur32 hash based on the authorization key and the feature flags filter query.
+ * Generates a murmur32 hash based on the authorization key, the feature flags filter query, and version of SplitChanges API.
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 export function getStorageHash(settings) {
-    return hash(settings.core.authorizationKey + "::" + settings.sync.__splitFiltersValidation.queryString).toString(16);
+    return hash(settings.core.authorizationKey + "::" + settings.sync.__splitFiltersValidation.queryString + "::1.0").toString(16);
 }

package/esm/utils/labels/index.js

@@ -5,3 +5,4 @@ export var SDK_NOT_READY = 'not ready';
 export var EXCEPTION = 'exception';
 export var SPLIT_ARCHIVED = 'archived';
 export var NOT_IN_SPLIT = 'not in split';
+export var UNSUPPORTED_MATCHER_TYPE = 'unsupported matcher type';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.13.1",
-  "description": "Split Javascript SDK common components",
+  "version": "1.13.2-rc.0",
+  "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
   "types": "types",

package/src/evaluator/combiners/ifelseif.ts

@@ -14,7 +14,7 @@ export function ifElseIfCombinerContext(log: ILogger, predicates: IEvaluator[]):
 
     return {
       treatment: CONTROL,
-      label: LabelsConstants.EXCEPTION
+      label: LabelsConstants.UNSUPPORTED_MATCHER_TYPE
     };
   }
 

package/src/evaluator/matchers/matcherTypes.ts

@@ -1,5 +1,5 @@
 export const matcherTypes: Record<string, number> = {
-  UNDEFINED: 0,
+  UNDEFINED: 0, // Value for unsupported or invalid matchers
   ALL_KEYS: 1,
   IN_SEGMENT: 2,
   WHITELIST: 3,

package/src/sdkClient/sdkClient.ts

@@ -35,6 +35,9 @@ export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: bo
     return syncManager ? syncManager.flush() : Promise.resolve();
   }
 
+  // Same promise if `destroy` is called multiple times
+  let destroyPromise: Promise<void> | undefined;
+
   return objectAssign(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus) as IStatusInterface,
@@ -53,6 +56,8 @@ export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: bo
         return __cooldown(__flush, COOLDOWN_TIME_IN_MILLIS);
       },
       destroy() {
+        if (destroyPromise) return destroyPromise;
+
         // Mark the SDK as destroyed immediately
         sdkReadinessManager.readinessManager.destroy();
 
@@ -65,7 +70,7 @@ export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: bo
         // Stop background jobs
         syncManager && syncManager.stop();
 
-        return __flush().then(() => {
+        destroyPromise = __flush().then(() => {
           // Cleanup event listeners
           signalListener && signalListener.stop();
 
@@ -75,6 +80,8 @@ export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: bo
           // Cleanup storage
           return storage.destroy();
         });
+
+        return destroyPromise;
       }
     }
   );

package/src/services/splitApi.ts

@@ -54,7 +54,7 @@ export function splitApiFactory(
     },
 
     fetchSplitChanges(since: number, noCache?: boolean, till?: number) {
-      const url = `${urls.sdk}/splitChanges?since=${since}${till ? '&till=' + till : ''}${filterQueryString || ''}`;
+      const url = `${urls.sdk}/splitChanges?v=1.0&since=${since}${till ? '&till=' + till : ''}${filterQueryString || ''}`;
       return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(SPLITS))
         .catch((err) => {
           if (err.statusCode === 414) settings.log.error(ERROR_TOO_MANY_SETS);

package/src/storages/KeyBuilder.ts

@@ -81,9 +81,9 @@ export class KeyBuilder {
 }
 
 /**
- * Generates a murmur32 hash based on the authorization key and the feature flags filter query.
+ * Generates a murmur32 hash based on the authorization key, the feature flags filter query, and version of SplitChanges API.
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 export function getStorageHash(settings: ISettings) {
-  return hash(`${settings.core.authorizationKey}::${settings.sync.__splitFiltersValidation.queryString}`).toString(16);
+  return hash(`${settings.core.authorizationKey}::${settings.sync.__splitFiltersValidation.queryString}::1.0`).toString(16);
 }

package/src/utils/labels/index.ts

@@ -5,3 +5,4 @@ export const SDK_NOT_READY = 'not ready';
 export const EXCEPTION = 'exception';
 export const SPLIT_ARCHIVED = 'archived';
 export const NOT_IN_SPLIT = 'not in split';
+export const UNSUPPORTED_MATCHER_TYPE = 'unsupported matcher type';

package/types/storages/KeyBuilder.d.ts

@@ -16,7 +16,7 @@ export declare class KeyBuilder {
     buildHashKey(): string;
 }
 /**
- * Generates a murmur32 hash based on the authorization key and the feature flags filter query.
+ * Generates a murmur32 hash based on the authorization key, the feature flags filter query, and version of SplitChanges API.
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 export declare function getStorageHash(settings: ISettings): string;

package/types/utils/labels/index.d.ts

@@ -5,3 +5,4 @@ export declare const SDK_NOT_READY = "not ready";
 export declare const EXCEPTION = "exception";
 export declare const SPLIT_ARCHIVED = "archived";
 export declare const NOT_IN_SPLIT = "not in split";
+export declare const UNSUPPORTED_MATCHER_TYPE = "unsupported matcher type";