@splitsoftware/splitio-commons 1.10.1-rc.2 → 1.10.1-rc.4

package/CHANGES.txt

@@ -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/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/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/cjs/sync/polling/updaters/splitChangesUpdater.js

@@ -100,7 +100,7 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments,
         return promise;
     }
     /** Returns true if at least one split was updated */
-    function update(flagsChange) {
+    function isThereUpdate(flagsChange) {
         var added = flagsChange[1], removed = flagsChange[2];
         // There is at least one added or modified feature flag
         if (added && added.some(function (update) { return update; }))
@@ -143,10 +143,9 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments,
                     splits.removeSplits(mutation.removed),
                     segments.registerSegments(mutation.segments)
                 ]).then(function (flagsChange) {
-                    var isThereUpdate = update(flagsChange);
                     if (splitsEventEmitter) {
                         // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
-                        return Promise.resolve(!splitsEventEmitter.splitsArrived || (since !== splitChanges.till && isThereUpdate && (isClientSide || checkAllSegmentsExist(segments))))
+                        return Promise.resolve(!splitsEventEmitter.splitsArrived || (since !== splitChanges.till && isThereUpdate(flagsChange) && (isClientSide || checkAllSegmentsExist(segments))))
                             .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
                             .then(function (emitSplitsArrivedEvent) {
                             // emit SDK events

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/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/esm/sync/polling/updaters/splitChangesUpdater.js

@@ -95,7 +95,7 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, seg
         return promise;
     }
     /** Returns true if at least one split was updated */
-    function update(flagsChange) {
+    function isThereUpdate(flagsChange) {
         var added = flagsChange[1], removed = flagsChange[2];
         // There is at least one added or modified feature flag
         if (added && added.some(function (update) { return update; }))
@@ -138,10 +138,9 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, seg
                     splits.removeSplits(mutation.removed),
                     segments.registerSegments(mutation.segments)
                 ]).then(function (flagsChange) {
-                    var isThereUpdate = update(flagsChange);
                     if (splitsEventEmitter) {
                         // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
-                        return Promise.resolve(!splitsEventEmitter.splitsArrived || (since !== splitChanges.till && isThereUpdate && (isClientSide || checkAllSegmentsExist(segments))))
+                        return Promise.resolve(!splitsEventEmitter.splitsArrived || (since !== splitChanges.till && isThereUpdate(flagsChange) && (isClientSide || checkAllSegmentsExist(segments))))
                             .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
                             .then(function (emitSplitsArrivedEvent) {
                             // emit SDK events

package/package.json

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

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/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/src/sync/polling/updaters/splitChangesUpdater.ts

@@ -128,7 +128,7 @@ export function splitChangesUpdaterFactory(
   }
 
   /** Returns true if at least one split was updated */
-  function update(flagsChange: [boolean | void, void | boolean[], void | boolean[], boolean | void] | [any, any, any]) {
+  function isThereUpdate(flagsChange: [boolean | void, void | boolean[], void | boolean[], boolean | void] | [any, any, any]) {
     const [, added, removed, ] = flagsChange;
     // There is at least one added or modified feature flag
     if (added && added.some((update: boolean) => update)) return true;
@@ -174,10 +174,9 @@ export function splitChangesUpdaterFactory(
             splits.removeSplits(mutation.removed),
             segments.registerSegments(mutation.segments)
           ]).then((flagsChange) => {
-            const isThereUpdate = update(flagsChange);
             if (splitsEventEmitter) {
               // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
-              return Promise.resolve(!splitsEventEmitter.splitsArrived || (since !== splitChanges.till && isThereUpdate && (isClientSide || checkAllSegmentsExist(segments))))
+              return Promise.resolve(!splitsEventEmitter.splitsArrived || (since !== splitChanges.till && isThereUpdate(flagsChange) && (isClientSide || checkAllSegmentsExist(segments))))
                 .catch(() => false /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
                 .then(emitSplitsArrivedEvent => {
                   // emit SDK events

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;

package/types/sdkClient/identity.d.ts

@@ -0,0 +1,6 @@
+import { SplitIO } from '../types';
+export declare function buildInstanceId(key: SplitIO.SplitKey, trafficType?: string): string;
+export declare function parseInstanceId(instanceId: string): {
+    key: SplitIO.SplitKey;
+    trafficType?: string;
+};

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

@@ -0,0 +1,7 @@
+import { ILogger } from '../../logger/types';
+/** validates the given SDK key */
+export declare function validateApiKey(log: ILogger, maybeSdkKey: any): string | false;
+export declare const usedKeysMap: Record<string, number>;
+/** validates the given SDK key and also warns if it is in use */
+export declare function validateAndTrackApiKey(log: ILogger, maybeSdkKey: any): string | false;
+export declare function releaseApiKey(sdkKey: string): void;

package/types/myLogger.d.ts

@@ -1,5 +0,0 @@
-export declare const myLogger: {
-    log: (msg: any) => void;
-    logCsv: (msg: any) => void;
-    logToFile: (file: any, msg: any) => void;
-};

package/types/sdkClient/types.d.ts

@@ -1,18 +0,0 @@
-import { ISignalListener } from '../listeners/types';
-import { ISdkReadinessManager } from '../readiness/types';
-import { IStorageAsync, IStorageSync } from '../storages/types';
-import { ISyncManager } from '../sync/types';
-import { IEventTracker, IImpressionsTracker } from '../trackers/types';
-import { ISettings } from '../types';
-export interface IClientFactoryParams {
-    storage: IStorageSync | IStorageAsync;
-    sdkReadinessManager: ISdkReadinessManager;
-    settings: ISettings;
-    impressionsTracker: IImpressionsTracker;
-    eventTracker: IEventTracker;
-}
-export interface ISdkClientFactoryParams extends IClientFactoryParams {
-    signalListener?: ISignalListener;
-    syncManager?: ISyncManager;
-    sharedClient?: boolean;
-}

package/types/storages/inMemory/CountsCacheInMemory.d.ts

@@ -1,20 +0,0 @@
-import { ICountsCacheSync } from '../types';
-export declare class CountsCacheInMemory implements ICountsCacheSync {
-    private counters;
-    /**
-     * Add counts.
-     */
-    track(metricName: string): boolean;
-    /**
-     * Clear the collector
-     */
-    clear(): void;
-    /**
-     * Get the collected data, used as payload for posting.
-     */
-    state(): Record<string, number>;
-    /**
-     * Check if the cache is empty.
-     */
-    isEmpty(): boolean;
-}

package/types/storages/inMemory/LatenciesCacheInMemory.d.ts

@@ -1,20 +0,0 @@
-import { ILatenciesCacheSync } from '../types';
-export declare class LatenciesCacheInMemory implements ILatenciesCacheSync {
-    private counters;
-    /**
-     * Add latencies.
-     */
-    track(metricName: string, latency: number): boolean;
-    /**
-     * Clear the collector
-     */
-    clear(): void;
-    /**
-     * Get the collected data, used as payload for posting.
-     */
-    state(): Record<string, number[]>;
-    /**
-     * Check if the cache is empty.
-     */
-    isEmpty(): boolean;
-}

package/types/storages/inRedis/CountsCacheInRedis.d.ts

@@ -1,9 +0,0 @@
-import { ICountsCacheAsync } from '../types';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { Redis } from 'ioredis';
-export declare class CountsCacheInRedis implements ICountsCacheAsync {
-    private readonly redis;
-    private readonly keys;
-    constructor(keys: KeyBuilderSS, redis: Redis);
-    track(metricName: string): Promise<boolean>;
-}

package/types/storages/inRedis/LatenciesCacheInRedis.d.ts

@@ -1,9 +0,0 @@
-import { ILatenciesCacheAsync } from '../types';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { Redis } from 'ioredis';
-export declare class LatenciesCacheInRedis implements ILatenciesCacheAsync {
-    private readonly redis;
-    private readonly keys;
-    constructor(keys: KeyBuilderSS, redis: Redis);
-    track(metricName: string, latency: number): Promise<boolean>;
-}

package/types/storages/metadataBuilder.d.ts

@@ -1,3 +0,0 @@
-import { IMetadata } from '../dtos/types';
-import { ISettings } from '../types';
-export declare function metadataBuilder(settings: Pick<ISettings, 'version' | 'runtime'>): IMetadata;

package/types/sync/offline/LocalhostFromFile.d.ts

@@ -1,2 +0,0 @@
-import { SplitIO } from '../../types';
-export declare function LocalhostFromFile(): SplitIO.LocalhostFactory;

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

@@ -1,2 +0,0 @@
-import { ISplitsParser } from './types';
-export declare function splitsParserFromFileFactory(): ISplitsParser;

package/types/sync/submitters/eventsSyncTask.d.ts

@@ -1,8 +0,0 @@
-import { IEventsCacheSync } from '../../storages/types';
-import { IPostEventsBulk } from '../../services/types';
-import { ISyncTask, ITimeTracker } from '../types';
-import { ILogger } from '../../logger/types';
-/**
- * Sync task that periodically posts tracked events
- */
-export declare function eventsSyncTaskFactory(log: ILogger, postEventsBulk: IPostEventsBulk, eventsCache: IEventsCacheSync, eventsPushRate: number, eventsFirstPushWindow: number, latencyTracker?: ITimeTracker): ISyncTask;

package/types/sync/submitters/impressionCountsSubmitterInRedis.d.ts

@@ -1,5 +0,0 @@
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-/**
- * Submitter that periodically posts impression counts
- */
-export declare function impressionCountsSubmitterInRedisFactory(params: ISdkFactoryContextSync): import("../types").ISyncTask<[], void>;

package/types/sync/submitters/impressionCountsSyncTask.d.ts

@@ -1,13 +0,0 @@
-import { ISyncTask, ITimeTracker } from '../types';
-import { IPostTestImpressionsCount } from '../../services/types';
-import { IImpressionCountsCacheSync } from '../../storages/types';
-import { ImpressionCountsPayload } from './types';
-import { ILogger } from '../../logger/types';
-/**
- * Converts `impressionCounts` data from cache into request payload.
- */
-export declare function fromImpressionCountsCollector(impressionsCount: Record<string, number>): ImpressionCountsPayload;
-/**
- * Sync task that periodically posts impression counts
- */
-export declare function impressionCountsSyncTaskFactory(log: ILogger, postTestImpressionsCount: IPostTestImpressionsCount, impressionCountsCache: IImpressionCountsCacheSync, latencyTracker?: ITimeTracker): ISyncTask;

package/types/sync/submitters/impressionsSyncTask.d.ts

@@ -1,14 +0,0 @@
-import { ISyncTask, ITimeTracker } from '../types';
-import { IPostTestImpressionsBulk } from '../../services/types';
-import { IImpressionsCacheSync } from '../../storages/types';
-import { ImpressionDTO } from '../../types';
-import { ImpressionsPayload } from './types';
-import { ILogger } from '../../logger/types';
-/**
- * Converts `impressions` data from cache into request payload.
- */
-export declare function fromImpressionsCollector(sendLabels: boolean, data: ImpressionDTO[]): ImpressionsPayload;
-/**
- * Sync task that periodically posts impressions data
- */
-export declare function impressionsSyncTaskFactory(log: ILogger, postTestImpressionsBulk: IPostTestImpressionsBulk, impressionsCache: IImpressionsCacheSync, impressionsRefreshRate: number, sendLabels?: boolean, latencyTracker?: ITimeTracker): ISyncTask;

package/types/sync/submitters/metricsSyncTask.d.ts

@@ -1,12 +0,0 @@
-import { ICountsCacheSync, ILatenciesCacheSync } from '../../storages/types';
-import { IPostMetricsCounters, IPostMetricsTimes } from '../../services/types';
-import { ISyncTask, ITimeTracker } from '../types';
-import { ILogger } from '../../logger/types';
-/**
- * Sync task that periodically posts telemetry counts
- */
-export declare function countsSyncTaskFactory(log: ILogger, postMetricsCounters: IPostMetricsCounters, countsCache: ICountsCacheSync, metricsRefreshRate: number, latencyTracker?: ITimeTracker): ISyncTask;
-/**
- * Sync task that periodically posts telemetry latencies
- */
-export declare function latenciesSyncTaskFactory(log: ILogger, postMetricsLatencies: IPostMetricsTimes, latenciesCache: ILatenciesCacheSync, metricsRefreshRate: number, latencyTracker?: ITimeTracker): ISyncTask;

package/types/sync/submitters/submitterSyncTask.d.ts

@@ -1,10 +0,0 @@
-import { ISyncTask, ITimeTracker } from '../types';
-import { IRecorderCacheProducerSync } from '../../storages/types';
-import { ILogger } from '../../logger/types';
-import { IResponse } from '../../services/types';
-/**
- * Base function to create submitter sync tasks, such as ImpressionsSyncTask and EventsSyncTask
- */
-export declare function submitterSyncTaskFactory<TState extends {
-    length?: number;
-}>(log: ILogger, postClient: (body: string) => Promise<IResponse>, sourceCache: IRecorderCacheProducerSync<TState>, postRate: number, dataName: string, latencyTracker?: ITimeTracker, fromCacheToPayload?: (cacheData: TState) => any, maxRetries?: number, debugLogs?: boolean): ISyncTask<[], void>;

package/types/sync/submitters/uniqueKeysSubmitterInRedis.d.ts

@@ -1,5 +0,0 @@
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-/**
- * Submitter that periodically posts impression counts
- */
-export declare function uniqueKeysSubmitterInRedisFactory(params: ISdkFactoryContextSync): import("../types").ISyncTask<[], void>;

package/types/sync/syncTaskComposite.d.ts

@@ -1,5 +0,0 @@
-import { ISyncTask } from './types';
-/**
- * Composite Sync Task: group of sync tasks that are treated as a single one.
- */
-export declare function syncTaskComposite(syncTasks: ISyncTask[]): ISyncTask;

package/types/trackers/filter/bloomFilter.d.ts

@@ -1,10 +0,0 @@
-import { IFilter } from './types';
-export declare class BloomFilterImp implements IFilter {
-    private spectedInsertions;
-    private errorRate;
-    private filter;
-    constructor(spectedInsertions: number, errorRate: number);
-    add(data: string): boolean;
-    contains(data: string): boolean;
-    clear(): void;
-}

package/types/trackers/filter/dictionaryFilter.d.ts

@@ -1,8 +0,0 @@
-import { IFilter } from './types';
-export declare class DictionaryFilter implements IFilter {
-    private filter;
-    constructor();
-    add(data: string): boolean;
-    contains(data: string): boolean;
-    clear(): void;
-}

package/types/trackers/filter/types.d.ts

@@ -1,5 +0,0 @@
-export interface IFilter {
-    add(data: string): boolean;
-    contains(data: string): boolean;
-    clear(): void;
-}

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

@@ -1,70 +0,0 @@
-import { ILogger } from '../../logger/types';
-import { IResponse } from '../../services/types';
-interface MetricsCollector {
-    countException(): void;
-    count(status: number): void;
-    latency(ms: number): void;
-    ready(ms: number): void;
-    getTreatment(ms: number): void;
-    getTreatments(ms: number): void;
-    getTreatmentWithConfig(ms: number): void;
-    getTreatmentsWithConfig(ms: number): void;
-    [method: string]: (ms: number) => void;
-}
-export declare const TrackerAPI: {
-    /**
-     * "Private" method, used to attach count/countException and stop callbacks to a promise.
-     *
-     * @param {ILogger} log - Logger.
-     * @param {Promise} promise - The promise we want to attach the callbacks.
-     * @param {string} task - The name of the task.
-     * @param {number | string} modifier - (optional) The modifier for the task, if any.
-     */
-    __attachToPromise(log: ILogger, promise: Promise<IResponse>, task: string, collector: false | MetricsCollector, modifier?: string | number | undefined): Promise<IResponse>;
-    /**
-     * Starts tracking the time for a given task. All tasks tracked are considered "unique" because
-     * there may be multiple SDK instances tracking a "generic" task, making any task non-generic.
-     *
-     * @param {ILogger} log - Logger.
-     * @param {string} task - The task we are starting.
-     * @param {Object} collectors - The collectors map.
-     * @param {Promise} promise - (optional) The promise we are tracking.
-     * @return {Function | Promise} The stop function for this specific task or the promise received with the callbacks registered.
-     */
-    start(log: ILogger, task: string, collectors?: Record<string, MetricsCollector> | undefined, promise?: Promise<IResponse> | undefined, now?: (() => number) | undefined): Promise<IResponse> | (() => number);
-    /**
-     * Setup the collector for a task that reports metrics.
-     *
-     * @param {string} task - The task name
-     * @param {number | string} taskUniqueId - The unique identifier for this task
-     * @param {Object} collectors - The collectors map.
-     */
-    setCollectorForTask(task: string, taskUniqueId: number | string, collectors: Record<string, MetricsCollector>): void;
-    /**
-     * Stops the tracking of a given task.
-     *
-     * @param {ILogger} log - Logger.
-     * @param {string} task - The task we are starting.
-     * @param {number | string} modifier - (optional) The modifier for that specific task.
-     */
-    stop(log: ILogger, task: string, modifier?: string | number | undefined): number | undefined;
-    /**
-     * The constants shortcut for the task names.
-     */
-    TaskNames: {
-        SDK_READY: string;
-        SDK_GET_TREATMENT: string;
-        SDK_GET_TREATMENTS: string;
-        SDK_GET_TREATMENT_WITH_CONFIG: string;
-        SDK_GET_TREATMENTS_WITH_CONFIG: string;
-        SPLITS_READY: string;
-        SEGMENTS_READY: string;
-        METRICS_PUSH: string;
-        IMPRESSIONS_PUSH: string;
-        EVENTS_PUSH: string;
-        MY_SEGMENTS_FETCH: string;
-        SEGMENTS_FETCH: string;
-        SPLITS_FETCH: string;
-    };
-};
-export {};