@splitsoftware/splitio-commons 3.1.1-rc.1 → 3.1.1-rc.10

package/src/sync/streaming/types.ts

@@ -16,19 +16,20 @@ export type MEMBERSHIPS_LS_UPDATE = 'MEMBERSHIPS_LS_UPDATE';
 export type SEGMENT_UPDATE = 'SEGMENT_UPDATE';
 export type SPLIT_KILL = 'SPLIT_KILL';
 export type SPLIT_UPDATE = 'SPLIT_UPDATE';
+export type CONFIG_UPDATE = 'CONFIG_UPDATE';
 export type RB_SEGMENT_UPDATE = 'RB_SEGMENT_UPDATE';
 
 // Control-type push notifications, handled by NotificationKeeper
 export type CONTROL = 'CONTROL';
 export type OCCUPANCY = 'OCCUPANCY';
 
-export type IPushEvent = PUSH_SUBSYSTEM_UP | PUSH_SUBSYSTEM_DOWN | PUSH_NON_RETRYABLE_ERROR | PUSH_RETRYABLE_ERROR | MEMBERSHIPS_MS_UPDATE | MEMBERSHIPS_LS_UPDATE | SEGMENT_UPDATE | SPLIT_UPDATE | SPLIT_KILL | RB_SEGMENT_UPDATE | ControlType.STREAMING_RESET
+export type IPushEvent = PUSH_SUBSYSTEM_UP | PUSH_SUBSYSTEM_DOWN | PUSH_NON_RETRYABLE_ERROR | PUSH_RETRYABLE_ERROR | MEMBERSHIPS_MS_UPDATE | MEMBERSHIPS_LS_UPDATE | SEGMENT_UPDATE | SPLIT_UPDATE | CONFIG_UPDATE | SPLIT_KILL | RB_SEGMENT_UPDATE | ControlType.STREAMING_RESET
 
 type IParsedData<T extends IPushEvent> =
   T extends MEMBERSHIPS_MS_UPDATE ? IMembershipMSUpdateData :
   T extends MEMBERSHIPS_LS_UPDATE ? IMembershipLSUpdateData :
   T extends SEGMENT_UPDATE ? ISegmentUpdateData :
-  T extends SPLIT_UPDATE | RB_SEGMENT_UPDATE ? ISplitUpdateData :
+  T extends SPLIT_UPDATE | CONFIG_UPDATE | RB_SEGMENT_UPDATE ? ISplitUpdateData :
   T extends SPLIT_KILL ? ISplitKillData : INotificationData;
 
 /**

package/src/sync/submitters/impressionsSubmitter.ts

@@ -1,14 +1,14 @@
 import { groupBy, forOwn } from '../../utils/lang';
 import SplitIO from '../../../types/splitio';
 import { submitterFactory } from './submitter';
-import { ImpressionsPayload } from './types';
+import { EntityType, ImpressionsPayload } from './types';
 import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
 
 /**
  * Converts `impressions` data from cache into request payload.
  */
-export function fromImpressionsCollector(sendLabels: boolean, data: SplitIO.ImpressionDTO[]): ImpressionsPayload {
+export function fromImpressionsCollector(sendLabels: boolean, data: (SplitIO.ImpressionDTO & { entityType?: EntityType })[]): ImpressionsPayload {
   let groupedByFeature = groupBy(data, 'feature');
   let dto: ImpressionsPayload = [];
 
@@ -25,7 +25,7 @@ export function fromImpressionsCollector(sendLabels: boolean, data: SplitIO.Impr
           b: entry.bucketingKey, // Bucketing Key
           pt: entry.pt, // Previous time
           properties: entry.properties, // Properties
-          // @ts-expect-error - entityType is not yet public. @TODO: add to SplitIO.ImpressionDTO type
+          // @TODO: add entityType to public SplitIO.ImpressionDTO type
           et: entry.entityType, // Definition type
         };
       })

package/src/sync/submitters/types.ts

@@ -3,7 +3,7 @@ import { IMetadata } from '../../dtos/types';
 import SplitIO from '../../../types/splitio';
 import { ISyncTask } from '../types';
 
-type EntityType = 'config' | 'flag' | 'ai-config';
+export type EntityType = 'config' | 'flag' | 'ai-config';
 
 type ImpressionPayload = {
   /** Matching Key */
@@ -15,7 +15,7 @@ type ImpressionPayload = {
   /** Timestamp */
   m: number;
   /** Change number */
-  c: number;
+  c?: number;
   /** Rule label */
   r?: string;
   /** Previous time */

package/src/sync/syncManagerOnline.ts

@@ -11,9 +11,6 @@ import { POLLING, STREAMING, SYNC_MODE_UPDATE } from '../utils/constants';
 import { ISdkFactoryContextSync } from '../sdkFactory/types';
 import { SDK_DEFINITIONS_CACHE_LOADED } from '../readiness/constants';
 import { usesSegmentsSync } from '../storages/AbstractDefinitionsCacheSync';
-import { splitChangesFetcherFactory } from './polling/fetchers/splitChangesFetcher';
-import { IDefinitionChangesFetcher, ISegmentChangesFetcher } from './polling/fetchers/types';
-import { segmentChangesFetcherFactory } from './polling/fetchers/segmentChangesFetcher';
 
 /**
  * Online SyncManager factory.
@@ -22,13 +19,10 @@ import { segmentChangesFetcherFactory } from './polling/fetchers/segmentChangesF
  * @param pollingManagerFactory - allows to specialize the SyncManager for server-side or client-side API by passing
  * `pollingManagerSSFactory` or `pollingManagerCSFactory` respectively.
  * @param pushManagerFactory - optional to build a SyncManager with or without streaming support
- * @param definitionChangesFetcherFactory - optional to replace the default split changes fetcher
  */
 export function syncManagerOnlineFactory(
-  pollingManagerFactory?: (params: ISdkFactoryContextSync, definitionChangesFetcher: IDefinitionChangesFetcher, segmentChangesFetcher: ISegmentChangesFetcher) => IPollingManager,
+  pollingManagerFactory?: (params: ISdkFactoryContextSync) => IPollingManager,
   pushManagerFactory?: (params: ISdkFactoryContextSync, pollingManager: IPollingManager) => IPushManager | undefined,
-  definitionFetcherFactory = splitChangesFetcherFactory,
-  segmentFetcherFactory = (params: ISdkFactoryContextSync) => segmentChangesFetcherFactory(params.serviceApi.fetchSegmentChanges)
 ): (params: ISdkFactoryContextSync) => ISyncManagerCS {
 
   /**
@@ -39,7 +33,7 @@ export function syncManagerOnlineFactory(
     const { settings, settings: { log, streamingEnabled, sync: { enabled: syncEnabled } }, telemetryTracker, storage, readiness } = params;
 
     /** Polling Manager */
-    const pollingManager = pollingManagerFactory && pollingManagerFactory(params, definitionFetcherFactory(params), segmentFetcherFactory(params));
+    const pollingManager = pollingManagerFactory && pollingManagerFactory(params);
 
     /** Push Manager */
     const pushManager = syncEnabled && streamingEnabled && pollingManager && pushManagerFactory ?

package/src/utils/Backoff.ts

@@ -12,9 +12,11 @@ export class Backoff {
   attempts: number;
   cb: (...args: any[]) => any;
   timeoutID: ReturnType<typeof setTimeout> | undefined;
+  pending: { resolve: (value: any) => void, reject: (error: any) => void } | undefined;
 
   /**
-   * Schedule function calls with exponential backoff
+   * Schedule function calls with exponential backoff.
+   * @param cb - The function to call. Must return a promise if used with `scheduleCallAsync`.
    */
   constructor(cb: (...args: any[]) => any, baseMillis?: number, maxMillis?: number) {
     this.baseMillis = Backoff.__TEST__BASE_MILLIS || baseMillis || Backoff.DEFAULT_BASE_MILLIS;
@@ -31,11 +33,12 @@ export class Backoff {
     let delayInMillis = Math.min(this.baseMillis * Math.pow(2, this.attempts), this.maxMillis);
 
     if (this.timeoutID) clearTimeout(this.timeoutID);
+    this.attempts++;
+
     this.timeoutID = setTimeout(() => {
       this.timeoutID = undefined;
       this.cb();
     }, delayInMillis);
-    this.attempts++;
 
     return delayInMillis;
   }
@@ -51,22 +54,31 @@ export class Backoff {
     this.attempts++;
 
     return new Promise<T>((resolve, reject) => {
+      this.pending = { resolve, reject };
       this.timeoutID = setTimeout(() => {
         this.timeoutID = undefined;
+        this.pending = undefined;
         this.cb().then(resolve, reject);
       }, delayInMillis);
     });
   }
 
   /**
-   * Reset the backoff attempts
+   * Reset the backoff attempts, canceling any scheduled `cb` call. If a `scheduleCallAsync` call is pending
+   * and the caller wants to settle it immediately instead of waiting for `cb` to be invoked, pass `settle`:
+   * `{ value }` to resolve, or `{ error }` to reject.
    */
-  reset() {
+  reset<T>(settle?: { value: T } | { error: any }) {
     this.attempts = 0;
     if (this.timeoutID) {
       clearTimeout(this.timeoutID);
       this.timeoutID = undefined;
     }
+    if (settle && this.pending) {
+      if ('value' in settle) this.pending.resolve(settle.value);
+      else this.pending.reject(settle.error);
+      this.pending = undefined;
+    }
   }
 
 }

package/types/splitio.d.ts

@@ -1,7 +1,7 @@
 // Type definitions for Split Software SDKs
 // Project: https://www.split.io/
 
-import type { RedisOptions } from 'ioredis';
+import type { ConnectionOptions } from 'tls';
 import type { RequestOptions } from 'http';
 
 export as namespace SplitIO;
@@ -1031,9 +1031,10 @@ declare namespace SplitIO {
      */
     label: string;
     /**
-     * Version of the feature flag
+     * Version of the feature flag.
+     * Undefined if the feature flag was not found, for example, if the label is 'not ready', 'exception' or 'definition not found'.
      */
-    changeNumber: number;
+    changeNumber?: number;
     /**
      * Previous time
      */
@@ -1714,7 +1715,7 @@ declare namespace SplitIO {
          *
          * @defaultValue `undefined`
          */
-        tls?: RedisOptions['tls'];
+        tls?: ConnectionOptions;
       };
       /**
        * Optional prefix to prevent any kind of data collision between SDK versions.

package/cjs/platform/browser.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.platform = void 0;
-var EventEmitter_1 = require("../utils/EventEmitter");
-var browser_1 = require("../platform/getFetch/browser");
-var browser_2 = require("../platform/getEventSource/browser");
-var browser_3 = require("../listeners/browser");
-var browser_4 = require("../utils/timeTracker/now/browser");
-exports.platform = {
-    getFetch: browser_1.getFetch,
-    getEventSource: browser_2.getEventSource,
-    EventEmitter: EventEmitter_1.EventEmitter,
-    now: browser_4.now,
-    SignalListener: browser_3.BrowserSignalListener
-};

package/cjs/platform/getEventSource/browser.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEventSource = void 0;
-function getEventSource() {
-    // eslint-disable-next-line no-undef -- Feature detection for EventSource
-    return typeof EventSource === 'function' ? EventSource : undefined;
-}
-exports.getEventSource = getEventSource;