@splitsoftware/splitio-commons 1.9.2 → 1.10.0

package/CHANGES.txt

@@ -1,3 +1,7 @@
+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).
+ - Updated log warning message to include the feature flag name when `getTreatment` method is called and the SDK client is not ready.
+
 1.9.2 (October 19, 2023)
  - Updated client module to support the Split Suite.
  - Updated some transitive dependencies for vulnerability fixes.

package/cjs/logger/messages/warn.js

@@ -17,7 +17,7 @@ exports.codesWarn = error_1.codesError.concat([
     [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Dropping %s after retry. Reason: %s.'],
     [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s.'],
     // client status
-    [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect. Make sure to wait for SDK readiness before using this method.'],
+    [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect%s. Make sure to wait for SDK readiness before using this method.'],
     [c.CLIENT_NO_LISTENER, 'No listeners for SDK Readiness detected. Incorrect control treatments could have been logged if you called getTreatment/s while the SDK was not yet ready.'],
     // input validation
     [c.WARN_SETTING_NULL, '%s: Property "%s" is of invalid type. Setting value to null.'],

package/cjs/sdkClient/clientInputValidation.js

@@ -22,7 +22,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         var splitOrSplits = multi ? (0, inputValidation_1.validateSplits)(log, maybeFeatureFlagNameOrNames, methodName) : (0, inputValidation_1.validateSplit)(log, maybeFeatureFlagNameOrNames, methodName);
         var attributes = (0, inputValidation_1.validateAttributes)(log, maybeAttributes, methodName);
         var isNotDestroyed = (0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, methodName);
-        (0, inputValidation_1.validateIfOperational)(log, readinessManager, methodName);
+        (0, inputValidation_1.validateIfOperational)(log, readinessManager, methodName, splitOrSplits);
         var valid = isNotDestroyed && key && splitOrSplits && attributes !== false;
         return {
             valid: valid,

package/cjs/sdkManager/index.js

@@ -27,7 +27,8 @@ function objectToView(splitObject) {
         killed: splitObject.killed,
         changeNumber: splitObject.changeNumber || 0,
         treatments: collectTreatments(splitObject),
-        configs: splitObject.configurations || {}
+        configs: splitObject.configurations || {},
+        defaultTreatment: splitObject.defaultTreatment
     };
 }
 function objectsToViews(splitObjects) {

package/cjs/utils/inputValidation/isOperational.js

@@ -9,10 +9,10 @@ function validateIfNotDestroyed(log, readinessManager, method) {
     return false;
 }
 exports.validateIfNotDestroyed = validateIfNotDestroyed;
-function validateIfOperational(log, readinessManager, method) {
+function validateIfOperational(log, readinessManager, method, featureFlagNameOrNames) {
     if (readinessManager.isReady() || readinessManager.isReadyFromCache())
         return true;
-    log.warn(constants_1.CLIENT_NOT_READY, [method]);
+    log.warn(constants_1.CLIENT_NOT_READY, [method, featureFlagNameOrNames ? " for feature flag " + featureFlagNameOrNames.toString() : '']);
     return false;
 }
 exports.validateIfOperational = validateIfOperational;

package/esm/logger/messages/warn.js

@@ -13,7 +13,7 @@ export var codesWarn = codesError.concat([
     [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Dropping %s after retry. Reason: %s.'],
     [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s.'],
     // client status
-    [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect. Make sure to wait for SDK readiness before using this method.'],
+    [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect%s. Make sure to wait for SDK readiness before using this method.'],
     [c.CLIENT_NO_LISTENER, 'No listeners for SDK Readiness detected. Incorrect control treatments could have been logged if you called getTreatment/s while the SDK was not yet ready.'],
     // input validation
     [c.WARN_SETTING_NULL, '%s: Property "%s" is of invalid type. Setting value to null.'],

package/esm/sdkClient/clientInputValidation.js

@@ -19,7 +19,7 @@ export function clientInputValidationDecorator(settings, client, readinessManage
         var splitOrSplits = multi ? validateSplits(log, maybeFeatureFlagNameOrNames, methodName) : validateSplit(log, maybeFeatureFlagNameOrNames, methodName);
         var attributes = validateAttributes(log, maybeAttributes, methodName);
         var isNotDestroyed = validateIfNotDestroyed(log, readinessManager, methodName);
-        validateIfOperational(log, readinessManager, methodName);
+        validateIfOperational(log, readinessManager, methodName, splitOrSplits);
         var valid = isNotDestroyed && key && splitOrSplits && attributes !== false;
         return {
             valid: valid,

package/esm/sdkManager/index.js

@@ -24,7 +24,8 @@ function objectToView(splitObject) {
         killed: splitObject.killed,
         changeNumber: splitObject.changeNumber || 0,
         treatments: collectTreatments(splitObject),
-        configs: splitObject.configurations || {}
+        configs: splitObject.configurations || {},
+        defaultTreatment: splitObject.defaultTreatment
     };
 }
 function objectsToViews(splitObjects) {

package/esm/utils/inputValidation/isOperational.js

@@ -5,9 +5,9 @@ export function validateIfNotDestroyed(log, readinessManager, method) {
     log.error(ERROR_CLIENT_DESTROYED, [method]);
     return false;
 }
-export function validateIfOperational(log, readinessManager, method) {
+export function validateIfOperational(log, readinessManager, method, featureFlagNameOrNames) {
     if (readinessManager.isReady() || readinessManager.isReadyFromCache())
         return true;
-    log.warn(CLIENT_NOT_READY, [method]);
+    log.warn(CLIENT_NOT_READY, [method, featureFlagNameOrNames ? " for feature flag " + featureFlagNameOrNames.toString() : '']);
     return false;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.9.2",
+  "version": "1.10.0",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -22,7 +22,7 @@
     "build": "npm run build:cjs && npm run build:esm",
     "build:esm": "rimraf esm && tsc -m es2015 --outDir esm -d true --declarationDir types",
     "build:cjs": "rimraf cjs && tsc -m CommonJS --outDir cjs",
-    "test": "jest",
+    "test": "jest --runInBand",
     "test:coverage": "jest --coverage",
     "all": "npm run check && npm run build && npm run test",
     "publish:rc": "npm run check && npm run test && npm run build && npm publish --tag rc",

package/src/logger/messages/warn.ts

@@ -14,7 +14,7 @@ export const codesWarn: [number, string][] = codesError.concat([
   [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Dropping %s after retry. Reason: %s.'],
   [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s.'],
   // client status
-  [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect. Make sure to wait for SDK readiness before using this method.'],
+  [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect%s. Make sure to wait for SDK readiness before using this method.'],
   [c.CLIENT_NO_LISTENER, 'No listeners for SDK Readiness detected. Incorrect control treatments could have been logged if you called getTreatment/s while the SDK was not yet ready.'],
   // input validation
   [c.WARN_SETTING_NULL, '%s: Property "%s" is of invalid type. Setting value to null.'],

package/src/sdkClient/clientInputValidation.ts

@@ -37,7 +37,7 @@ export function clientInputValidationDecorator<TClient extends SplitIO.IClient |
     const attributes = validateAttributes(log, maybeAttributes, methodName);
     const isNotDestroyed = validateIfNotDestroyed(log, readinessManager, methodName);
 
-    validateIfOperational(log, readinessManager, methodName);
+    validateIfOperational(log, readinessManager, methodName, splitOrSplits);
 
     const valid = isNotDestroyed && key && splitOrSplits && attributes !== false;
 

package/src/sdkManager/index.ts

@@ -31,7 +31,8 @@ function objectToView(splitObject: ISplit | null): SplitIO.SplitView | null {
     killed: splitObject.killed,
     changeNumber: splitObject.changeNumber || 0,
     treatments: collectTreatments(splitObject),
-    configs: splitObject.configurations || {}
+    configs: splitObject.configurations || {},
+    defaultTreatment: splitObject.defaultTreatment
   };
 }
 

package/src/types.ts

@@ -610,6 +610,11 @@ export namespace SplitIO {
     configs: {
       [treatmentName: string]: string
     }
+    /**
+     * The default treatment of the feature flag.
+     * @property {string} defaultTreatment
+     */
+    defaultTreatment: string,
   };
   /**
    * A promise that resolves to a feature flag view.

package/src/utils/inputValidation/isOperational.ts

@@ -9,9 +9,9 @@ export function validateIfNotDestroyed(log: ILogger, readinessManager: IReadines
   return false;
 }
 
-export function validateIfOperational(log: ILogger, readinessManager: IReadinessManager, method: string) {
+export function validateIfOperational(log: ILogger, readinessManager: IReadinessManager, method: string, featureFlagNameOrNames?: string | string[] | false) {
   if (readinessManager.isReady() || readinessManager.isReadyFromCache()) return true;
 
-  log.warn(CLIENT_NOT_READY, [method]);
+  log.warn(CLIENT_NOT_READY, [method, featureFlagNameOrNames ? ` for feature flag ${featureFlagNameOrNames.toString()}` : '']);
   return false;
 }

package/types/types.d.ts

@@ -601,6 +601,11 @@ export declare namespace SplitIO {
         configs: {
             [treatmentName: string]: string;
         };
+        /**
+         * The default treatment of the feature flag.
+         * @property {string} defaultTreatment
+         */
+        defaultTreatment: string;
     };
     /**
      * A promise that resolves to a feature flag view.

package/types/utils/inputValidation/isOperational.d.ts

@@ -1,4 +1,4 @@
 import { ILogger } from '../../logger/types';
 import { IReadinessManager } from '../../readiness/types';
 export declare function validateIfNotDestroyed(log: ILogger, readinessManager: IReadinessManager, method: string): boolean;
-export declare function validateIfOperational(log: ILogger, readinessManager: IReadinessManager, method: string): boolean;
+export declare function validateIfOperational(log: ILogger, readinessManager: IReadinessManager, method: string, featureFlagNameOrNames?: string | string[] | false): boolean;