@splitsoftware/splitio-commons 3.1.1-rc.11 → 3.1.1-rc.13

package/src/sync/streaming/UpdateWorkers/DefinitionsUpdateWorker.ts

@@ -1,24 +1,28 @@
 import { IRBSegment, IDefinition } from '../../../dtos/types';
 import { STREAMING_PARSING_SPLIT_UPDATE } from '../../../logger/constants';
-import { ILogger } from '../../../logger/types';
-import { SDK_DEFINITIONS_ARRIVED } from '../../../readiness/constants';
-import { IDefinitionsEventEmitter } from '../../../readiness/types';
-import { IRBSegmentsCacheSync, IDefinitionsCacheSync, IStorageSync } from '../../../storages/types';
-import { ITelemetryTracker } from '../../../trackers/types';
+import { SDK_DEFINITIONS_ARRIVED, FLAGS_UPDATE } from '../../../readiness/constants';
+import { ISdkFactoryContextSync } from '../../../sdkFactory/types';
+import { IRBSegmentsCacheSync, IDefinitionsCacheSync } from '../../../storages/types';
 import { Backoff } from '../../../utils/Backoff';
 import { SPLITS } from '../../../utils/constants';
-import { IDefinitionsSyncTask } from '../../polling/types';
-import { InstantUpdate } from '../../polling/updaters/definitionChangesUpdater';
+import { IPollingManager } from '../../polling/types';
+import { InstantUpdate } from '../../polling/types';
 import { RB_SEGMENT_UPDATE } from '../constants';
-import { parseFFUpdatePayload } from '../parseUtils';
+import { parseUpdatePayload } from '../parseUtils';
 import { ISplitKillData, ISplitUpdateData } from '../SSEHandler/types';
 import { FETCH_BACKOFF_BASE, FETCH_BACKOFF_MAX_WAIT, FETCH_BACKOFF_MAX_RETRIES } from './constants';
-import { IUpdateWorker } from './types';
+import { IDefinitionsUpdateWorker } from './types';
 
 /**
- * DefinitionsUpdateWorker factory
+ * DefinitionsUpdateWorker factory for Flags SDKs, where notifications pcn and changeNumber are environment-scoped
  */
-export function DefinitionsUpdateWorker(log: ILogger, storage: IStorageSync, definitionsSyncTask: IDefinitionsSyncTask, definitionsEventEmitter: IDefinitionsEventEmitter, telemetryTracker: ITelemetryTracker): IUpdateWorker<[updateData: ISplitUpdateData]> & { killDefinition(event: ISplitKillData): void } {
+export function DefinitionsUpdateWorker(
+  params: Pick<ISdkFactoryContextSync, 'settings' | 'storage' | 'telemetryTracker' | 'readiness'>,
+  pollingManager: Pick<IPollingManager, 'definitionsSyncTask'>,
+): IDefinitionsUpdateWorker {
+
+  const { settings: { log }, storage, telemetryTracker, readiness: { definitions: definitionsEventEmitter } } = params;
+  const { definitionsSyncTask } = pollingManager;
 
   const ff = DefinitionsUpdateWorker(storage.definitions);
   const rbs = DefinitionsUpdateWorker(storage.rbSegments);
@@ -108,7 +112,7 @@ export function DefinitionsUpdateWorker(log: ILogger, storage: IStorageSync, def
     put(parsedData) {
       if (parsedData.d && parsedData.c !== undefined) {
         try {
-          const payload = parseFFUpdatePayload(parsedData.c, parsedData.d);
+          const payload = parseUpdatePayload<IDefinition | IRBSegment>(parsedData.c, parsedData.d);
           if (payload) {
             (parsedData.type === RB_SEGMENT_UPDATE ? rbs : ff).put(parsedData, payload);
             return;
@@ -129,7 +133,7 @@ export function DefinitionsUpdateWorker(log: ILogger, storage: IStorageSync, def
     killDefinition({ changeNumber, splitName, defaultTreatment }: ISplitKillData) {
       if (storage.definitions.killLocally(splitName, defaultTreatment, changeNumber)) {
         // trigger an SDK_UPDATE if Split was killed locally
-        definitionsEventEmitter.emit(SDK_DEFINITIONS_ARRIVED, true);
+        definitionsEventEmitter.emit(SDK_DEFINITIONS_ARRIVED, { type: FLAGS_UPDATE, names: [splitName] }, true /* isSplitKill */);
       }
       // queues the SplitChanges fetch (only if changeNumber is newer)
       ff.put({ changeNumber } as ISplitUpdateData);

package/src/sync/streaming/UpdateWorkers/types.ts

@@ -1,4 +1,10 @@
+import { ISplitKillData, ISplitUpdateData } from '../SSEHandler/types';
+
 export interface IUpdateWorker<T extends any[]> {
   stop(): void // clear scheduled tasks (backoff)
   put(...args: T): void // handle new update event
 }
+
+export interface IDefinitionsUpdateWorker extends IUpdateWorker<[updateData: ISplitUpdateData]> {
+  killDefinition: (event: ISplitKillData) => void
+}

package/src/sync/streaming/parseUtils.ts

@@ -2,7 +2,6 @@ import { algorithms } from '../../utils/decompress';
 import { decodeFromBase64 } from '../../utils/base64';
 import { hash } from '../../utils/murmur3/murmur3';
 import { Compression, IMembershipMSUpdateData } from './SSEHandler/types';
-import { IRBSegment, IDefinition } from '../../dtos/types';
 
 const GZIP = 1;
 const ZLIB = 2;
@@ -80,11 +79,11 @@ export function isInBitmap(bitmap: Uint8Array, hash64hex: string) {
 }
 
 /**
- * Parse feature flags notifications for instant feature flag updates
+ * Parse notifications for instant updates
  */
-export function parseFFUpdatePayload(compression: Compression, data: string): IDefinition | IRBSegment | undefined {
+export function parseUpdatePayload<T>(compression: Compression, data: string): T | undefined {
   return compression > 0 ?
-    parseCompressedData<IDefinition | IRBSegment>(data, compression, false) :
+    parseCompressedData<T>(data, compression, false) :
     JSON.parse(decodeFromBase64(data));
 }
 

package/src/sync/streaming/pushManager.ts

@@ -15,7 +15,7 @@ import { STREAMING_FALLBACK, STREAMING_REFRESH_TOKEN, STREAMING_CONNECTING, STRE
 import { IMembershipMSUpdateData, IMembershipLSUpdateData, KeyList, UpdateStrategy } from './SSEHandler/types';
 import { getDelay, isInBitmap, parseBitmap, parseCompressedData } from './parseUtils';
 import { Hash64, hash64 } from '../../utils/murmur3/murmur3_64';
-import { IJwtCredential } from './AuthClient/types';
+import { IJwtCredential } from '../../services/types';
 import { TOKEN_REFRESH, AUTH_REJECTION } from '../../utils/constants';
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
 
@@ -27,9 +27,10 @@ import { ISdkFactoryContextSync } from '../../sdkFactory/types';
 export function pushManagerFactory(
   params: ISdkFactoryContextSync,
   pollingManager: IPollingManager,
+  definitionsUpdateWorkerFactory = DefinitionsUpdateWorker
 ): IPushManager | undefined {
 
-  const { settings, storage, serviceApi, readiness, platform, telemetryTracker } = params;
+  const { settings, storage, serviceApi, platform, telemetryTracker } = params;
 
   // `userKey` is the matching key of main client in client-side SDK.
   // It can be used to check if running on client-side or server-side SDK.
@@ -54,7 +55,7 @@ export function pushManagerFactory(
   // MySegmentsUpdateWorker (client-side) are initiated in `add` method
   const segmentsUpdateWorker = userKey ? undefined : SegmentsUpdateWorker(log, pollingManager.segmentsSyncTask as ISegmentsSyncTask, storage.segments);
   // For server-side we pass the segmentsSyncTask, used by DefinitionsUpdateWorker to fetch new segments
-  const definitionsUpdateWorker = DefinitionsUpdateWorker(log, storage, pollingManager.definitionsSyncTask, readiness.definitions, telemetryTracker);
+  const definitionsUpdateWorker = definitionsUpdateWorkerFactory(params, pollingManager);
 
   // [Only for client-side] map of user keys to their corresponding hash64 and MySegmentsUpdateWorkers.
   // Hash64 is used to process membership update events and dispatch actions to the corresponding MySegmentsUpdateWorker.

package/src/sync/syncManagerOnline.ts

@@ -100,7 +100,6 @@ export function syncManagerOnlineFactory(
             if (!cacheMetadata.initialCacheLoad) {
               readiness.definitions.emit(SDK_DEFINITIONS_CACHE_LOADED, cacheMetadata);
             }
-
           }
 
           // start syncing splits and segments

package/cjs/sync/streaming/AuthClient/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/esm/sync/streaming/AuthClient/types.js

@@ -1 +0,0 @@
-export {};

package/src/sync/streaming/AuthClient/types.ts

@@ -1,19 +0,0 @@
-import { IDecodedJWTToken } from '../../../utils/jwt/types';
-
-export type IJwtCredential = {
-  token: string; // empty string ("") when `"pushEnabled": false`
-  decodedToken: IDecodedJWTToken
-  channels: { [channel: string]: string[] }
-  // /api/v2/auth fields
-  pushEnabled?: boolean | null;
-  connDelay?: number | null;
-  // /api/v3/auth fields
-  config?: {
-    streaming?: {
-      delay?: number | null;
-      enabled?: boolean | null;
-    } | null;
-  } | null;
-}
-
-export type IFetchAuth = (userKeys?: string[]) => Promise<IJwtCredential>