@splitsoftware/splitio-commons 1.10.1-rc.3 → 1.11.0

package/CHANGES.txt

@@ -1,4 +1,4 @@
-1.11.0 (November XX, 2023)
+1.11.0 (November 3, 2023)
   - Added support for Flag Sets on the SDK, which enables grouping feature flags and interacting with the group rather than individually (more details in our documentation):
     - Added new variations of the get treatment methods to support evaluating flags in given flag set/s.
       - getTreatmentsByFlagSet and getTreatmentsByFlagSets
@@ -6,6 +6,7 @@
     - Added a new optional Split Filter configuration option. This allows the SDK and Split services to only synchronize the flags in the specified flag sets, avoiding unused or unwanted flags from being synced on the SDK instance, bringing all the benefits from a reduced payload.
       - Note: Only applicable when the SDK is in charge of the rollout data synchronization. When not applicable, the SDK will log a warning on init.
     - Added `sets` property to the `SplitView` object returned by the `split` and `splits` methods of the SDK manager to expose flag sets on flag views.
+  - Bugfixing - Fixed SDK key validation in NodeJS to ensure the SDK_READY_TIMED_OUT event is emitted when a client-side type SDK key is provided instead of a server-side one (Related to issue https://github.com/splitio/javascript-client/issues/768).
 
 1.10.0 (October 20, 2023)
  - Added `defaultTreatment` property to the `SplitView` object returned by the `split` and `splits` methods of the SDK manager (Related to issue https://github.com/splitio/javascript-commons/issues/225).

package/cjs/evaluator/index.js

@@ -68,7 +68,10 @@ function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage) {
     }
     // evaluate related features
     return (0, thenable_1.thenable)(storedFlagNames) ?
-        storedFlagNames.then(function (splitNames) { return evaluateFeatures(log, key, (0, sets_1.setToArray)(splitNames), attributes, storage); }) :
+        storedFlagNames.then(function (splitNames) { return evaluateFeatures(log, key, (0, sets_1.setToArray)(splitNames), attributes, storage); })
+            .catch(function () {
+            return {};
+        }) :
         evaluateFeatures(log, key, (0, sets_1.setToArray)(storedFlagNames), attributes, storage);
 }
 exports.evaluateFeaturesByFlagSets = evaluateFeaturesByFlagSets;

package/cjs/readiness/readinessManager.js

@@ -101,7 +101,12 @@ function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
             refCount++;
             return readinessManagerFactory(EventEmitter, readyTimeout, splits);
         },
+        // @TODO review/remove next methods when non-recoverable errors are reworked
+        // Called on consumer mode, when storage fails to connect
         timeout: timeout,
+        // Called on 403 error (client-side SDK key on server-side), to set the SDK as destroyed for
+        // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
+        setDestroyed: function () { isDestroyed = true; },
         destroy: function () {
             isDestroyed = true;
             segments.removeAllListeners();

package/cjs/storages/KeyBuilder.js

@@ -17,7 +17,7 @@ var KeyBuilder = /** @class */ (function () {
         return this.prefix + ".trafficType." + trafficType;
     };
     KeyBuilder.prototype.buildFlagSetKey = function (flagSet) {
-        return this.prefix + ".flagset." + flagSet;
+        return this.prefix + ".flagSet." + flagSet;
     };
     KeyBuilder.prototype.buildSplitKey = function (splitName) {
         return this.prefix + ".split." + splitName;

package/cjs/storages/inRedis/SplitsCacheInRedis.js

@@ -5,7 +5,6 @@ var tslib_1 = require("tslib");
 var lang_1 = require("../../utils/lang");
 var constants_1 = require("./constants");
 var AbstractSplitsCacheAsync_1 = require("../AbstractSplitsCacheAsync");
-var sets_1 = require("../../utils/lang/sets");
 /**
  * Discard errors for an answer of multiple operations.
  */
@@ -179,8 +178,8 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
      * @todo this is a no-op method to be implemented
     */
     SplitsCacheInRedis.prototype.getNamesByFlagSets = function () {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        return new Promise(function (flagSets) { return new sets_1._Set([]); });
+        this.log.error(constants_1.LOG_PREFIX + 'ByFlagSet/s evaluations are not supported with Redis storage yet.');
+        return Promise.reject();
     };
     /**
      * Check traffic type existence.

package/cjs/storages/pluggable/SplitsCachePluggable.js

@@ -5,7 +5,6 @@ var tslib_1 = require("tslib");
 var lang_1 = require("../../utils/lang");
 var constants_1 = require("./constants");
 var AbstractSplitsCacheAsync_1 = require("../AbstractSplitsCacheAsync");
-var sets_1 = require("../../utils/lang/sets");
 /**
  * ISplitsCacheAsync implementation for pluggable storages.
  */
@@ -153,8 +152,8 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
      * @todo this is a no-op method to be implemented
     */
     SplitsCachePluggable.prototype.getNamesByFlagSets = function () {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        return new Promise(function (flagSets) { return new sets_1._Set([]); });
+        this.log.error(constants_1.LOG_PREFIX + 'ByFlagSet/s evaluations are not supported with pluggable storage yet.');
+        return Promise.reject();
     };
     /**
      * Check traffic type existence.

package/cjs/sync/polling/updaters/segmentChangesUpdater.js

@@ -83,7 +83,7 @@ function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segments, read
                 // If the operation is forbidden, it may be due to permissions. Destroy the SDK instance.
                 // @TODO although factory status is destroyed, synchronization is not stopped
                 if (readiness)
-                    readiness.destroy();
+                    readiness.setDestroyed();
                 log.error(constants_2.LOG_PREFIX_INSTANTIATION + ": you passed a client-side type authorizationKey, please grab an SDK Key from the Split user interface that is of type server-side.");
             }
             else {

package/esm/evaluator/index.js

@@ -62,7 +62,10 @@ export function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, stora
     }
     // evaluate related features
     return thenable(storedFlagNames) ?
-        storedFlagNames.then(function (splitNames) { return evaluateFeatures(log, key, setToArray(splitNames), attributes, storage); }) :
+        storedFlagNames.then(function (splitNames) { return evaluateFeatures(log, key, setToArray(splitNames), attributes, storage); })
+            .catch(function () {
+            return {};
+        }) :
         evaluateFeatures(log, key, setToArray(storedFlagNames), attributes, storage);
 }
 function getEvaluation(log, splitJSON, key, attributes, storage) {

package/esm/readiness/readinessManager.js

@@ -98,7 +98,12 @@ export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
             refCount++;
             return readinessManagerFactory(EventEmitter, readyTimeout, splits);
         },
+        // @TODO review/remove next methods when non-recoverable errors are reworked
+        // Called on consumer mode, when storage fails to connect
         timeout: timeout,
+        // Called on 403 error (client-side SDK key on server-side), to set the SDK as destroyed for
+        // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
+        setDestroyed: function () { isDestroyed = true; },
         destroy: function () {
             isDestroyed = true;
             segments.removeAllListeners();

package/esm/storages/KeyBuilder.js

@@ -13,7 +13,7 @@ var KeyBuilder = /** @class */ (function () {
         return this.prefix + ".trafficType." + trafficType;
     };
     KeyBuilder.prototype.buildFlagSetKey = function (flagSet) {
-        return this.prefix + ".flagset." + flagSet;
+        return this.prefix + ".flagSet." + flagSet;
     };
     KeyBuilder.prototype.buildSplitKey = function (splitName) {
         return this.prefix + ".split." + splitName;

package/esm/storages/inRedis/SplitsCacheInRedis.js

@@ -2,7 +2,6 @@ import { __extends } from "tslib";
 import { isFiniteNumber, isNaNNumber } from '../../utils/lang';
 import { LOG_PREFIX } from './constants';
 import { AbstractSplitsCacheAsync } from '../AbstractSplitsCacheAsync';
-import { _Set } from '../../utils/lang/sets';
 /**
  * Discard errors for an answer of multiple operations.
  */
@@ -176,8 +175,8 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
      * @todo this is a no-op method to be implemented
     */
     SplitsCacheInRedis.prototype.getNamesByFlagSets = function () {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        return new Promise(function (flagSets) { return new _Set([]); });
+        this.log.error(LOG_PREFIX + 'ByFlagSet/s evaluations are not supported with Redis storage yet.');
+        return Promise.reject();
     };
     /**
      * Check traffic type existence.

package/esm/storages/pluggable/SplitsCachePluggable.js

@@ -2,7 +2,6 @@ import { __extends } from "tslib";
 import { isFiniteNumber, isNaNNumber } from '../../utils/lang';
 import { LOG_PREFIX } from './constants';
 import { AbstractSplitsCacheAsync } from '../AbstractSplitsCacheAsync';
-import { _Set } from '../../utils/lang/sets';
 /**
  * ISplitsCacheAsync implementation for pluggable storages.
  */
@@ -150,8 +149,8 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
      * @todo this is a no-op method to be implemented
     */
     SplitsCachePluggable.prototype.getNamesByFlagSets = function () {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        return new Promise(function (flagSets) { return new _Set([]); });
+        this.log.error(LOG_PREFIX + 'ByFlagSet/s evaluations are not supported with pluggable storage yet.');
+        return Promise.reject();
     };
     /**
      * Check traffic type existence.

package/esm/sync/polling/updaters/segmentChangesUpdater.js

@@ -80,7 +80,7 @@ export function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segment
                 // If the operation is forbidden, it may be due to permissions. Destroy the SDK instance.
                 // @TODO although factory status is destroyed, synchronization is not stopped
                 if (readiness)
-                    readiness.destroy();
+                    readiness.setDestroyed();
                 log.error(LOG_PREFIX_INSTANTIATION + ": you passed a client-side type authorizationKey, please grab an SDK Key from the Split user interface that is of type server-side.");
             }
             else {

package/package.json

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

package/src/evaluator/index.ts

@@ -94,7 +94,7 @@ export function evaluateFeaturesByFlagSets(
   flagSets: string[],
   attributes: SplitIO.Attributes | undefined,
   storage: IStorageSync | IStorageAsync,
-): MaybeThenable<Record<string,IEvaluationResult>> {
+): MaybeThenable<Record<string, IEvaluationResult>> {
   let storedFlagNames: MaybeThenable<ISet<string>>;
 
   // get features by flag sets
@@ -107,7 +107,10 @@ export function evaluateFeaturesByFlagSets(
 
   // evaluate related features
   return thenable(storedFlagNames) ?
-    storedFlagNames.then((splitNames) => evaluateFeatures(log, key, setToArray(splitNames), attributes, storage)) :
+    storedFlagNames.then((splitNames) => evaluateFeatures(log, key, setToArray(splitNames), attributes, storage))
+      .catch(() => {
+        return {};
+      }) :
     evaluateFeatures(log, key, setToArray(storedFlagNames), attributes, storage);
 }
 

package/src/readiness/readinessManager.ts

@@ -112,7 +112,12 @@ export function readinessManagerFactory(
       return readinessManagerFactory(EventEmitter, readyTimeout, splits);
     },
 
+    // @TODO review/remove next methods when non-recoverable errors are reworked
+    // Called on consumer mode, when storage fails to connect
     timeout,
+    // Called on 403 error (client-side SDK key on server-side), to set the SDK as destroyed for
+    // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
+    setDestroyed() { isDestroyed = true; },
 
     destroy() {
       isDestroyed = true;

package/src/readiness/types.ts

@@ -55,6 +55,7 @@ export interface IReadinessManager {
   isOperational(): boolean,
 
   timeout(): void,
+  setDestroyed(): void,
   destroy(): void,
 
   /** for client-side */

package/src/storages/KeyBuilder.ts

@@ -21,7 +21,7 @@ export class KeyBuilder {
   }
 
   buildFlagSetKey(flagSet: string) {
-    return `${this.prefix}.flagset.${flagSet}`;
+    return `${this.prefix}.flagSet.${flagSet}`;
   }
 
   buildSplitKey(splitName: string) {

package/src/storages/inRedis/SplitsCacheInRedis.ts

@@ -5,7 +5,7 @@ import { ILogger } from '../../logger/types';
 import { LOG_PREFIX } from './constants';
 import { ISplit } from '../../dtos/types';
 import { AbstractSplitsCacheAsync } from '../AbstractSplitsCacheAsync';
-import { ISet, _Set } from '../../utils/lang/sets';
+import { ISet } from '../../utils/lang/sets';
 
 /**
  * Discard errors for an answer of multiple operations.
@@ -196,8 +196,8 @@ export class SplitsCacheInRedis extends AbstractSplitsCacheAsync {
    * @todo this is a no-op method to be implemented
   */
   getNamesByFlagSets(): Promise<ISet<string>> {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    return new Promise(flagSets => new _Set([]));
+    this.log.error(LOG_PREFIX + 'ByFlagSet/s evaluations are not supported with Redis storage yet.');
+    return Promise.reject();
   }
 
   /**

package/src/storages/pluggable/SplitsCachePluggable.ts

@@ -5,7 +5,7 @@ import { ILogger } from '../../logger/types';
 import { ISplit } from '../../dtos/types';
 import { LOG_PREFIX } from './constants';
 import { AbstractSplitsCacheAsync } from '../AbstractSplitsCacheAsync';
-import { ISet, _Set } from '../../utils/lang/sets';
+import { ISet } from '../../utils/lang/sets';
 
 /**
  * ISplitsCacheAsync implementation for pluggable storages.
@@ -162,8 +162,8 @@ export class SplitsCachePluggable extends AbstractSplitsCacheAsync {
    * @todo this is a no-op method to be implemented
   */
   getNamesByFlagSets(): Promise<ISet<string>> {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    return new Promise(flagSets => new _Set([]));
+    this.log.error(LOG_PREFIX + 'ByFlagSet/s evaluations are not supported with pluggable storage yet.');
+    return Promise.reject();
   }
 
   /**

package/src/sync/polling/updaters/segmentChangesUpdater.ts

@@ -96,7 +96,7 @@ export function segmentChangesUpdaterFactory(
         if (error && error.statusCode === 403) {
           // If the operation is forbidden, it may be due to permissions. Destroy the SDK instance.
           // @TODO although factory status is destroyed, synchronization is not stopped
-          if (readiness) readiness.destroy();
+          if (readiness) readiness.setDestroyed();
           log.error(`${LOG_PREFIX_INSTANTIATION}: you passed a client-side type authorizationKey, please grab an SDK Key from the Split user interface that is of type server-side.`);
         } else {
           log.warn(`${LOG_PREFIX_SYNC_SEGMENTS}Error while doing fetch of segments. ${error}`);

package/types/readiness/types.d.ts

@@ -42,6 +42,7 @@ export interface IReadinessManager {
     isDestroyed(): boolean;
     isOperational(): boolean;
     timeout(): void;
+    setDestroyed(): void;
     destroy(): void;
     /** for client-side */
     shared(readyTimeout?: number): IReadinessManager;