Add CONFIGS_UPDATE constant and update splitChangesUpdater for configs support

Author: EmilianoSanchez

src/readiness/constants.ts

@@ -14,3 +14,4 @@ export const SDK_UPDATE = 'state::update';
 // SdkUpdateMetadata types:
 export const FLAGS_UPDATE =  'FLAGS_UPDATE';
 export const SEGMENTS_UPDATE = 'SEGMENTS_UPDATE';
+export const CONFIGS_UPDATE = 'CONFIGS_UPDATE';

src/sdkConfigs/index.ts

@@ -67,10 +67,9 @@ export function sdkConfigsFactory(params: ISdkFactoryParams): SplitIO.ConfigsCli
     Object.create(sdkReadinessManager.sdkStatus) as SplitIO.IStatusInterface,
     sdkLifecycleFactory(ctx),
     {
-      getConfig(name: string, target?: SplitIO.Target): SplitIO.Config {
-        return {
-          value: name + target,
-        } as SplitIO.Config;
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      getConfig(_name: string, _target?: SplitIO.Target): SplitIO.Config {
+        throw new Error('getConfig not implemented');
       },
 
       track() {

src/sync/polling/syncTasks/splitsSyncTask.ts

@@ -20,7 +20,7 @@ export function splitsSyncTaskFactory(
   return syncTaskFactory(
     settings.log,
     splitChangesUpdaterFactory(
-      settings.log,
+      settings,
       splitChangesFetcherFactory(fetchSplitChanges, settings, storage),
       storage,
       settings.sync.__splitFiltersValidation,

src/sync/polling/updaters/__tests__/splitChangesUpdater.spec.ts

@@ -205,7 +205,7 @@ describe('splitChangesUpdater', () => {
 
   let splitFiltersValidation = { queryString: null, groupedFilters: { bySet: [], byName: [], byPrefix: [] }, validFilters: [] };
 
-  let splitChangesUpdater = splitChangesUpdaterFactory(loggerMock, splitChangesFetcher, storage, splitFiltersValidation, readinessManager.splits, 1000, 1);
+  let splitChangesUpdater = splitChangesUpdaterFactory({ log: loggerMock }, splitChangesFetcher, storage, splitFiltersValidation, readinessManager.splits, 1000, 1);
 
   afterEach(() => {
     jest.clearAllMocks();
@@ -279,7 +279,7 @@ describe('splitChangesUpdater', () => {
       { sets: ['set_a'], shouldEmit: true }, /* should emit if flag is back in configured sets */
     ];
 
-    splitChangesUpdater = splitChangesUpdaterFactory(loggerMock, splitChangesFetcher, storage, splitFiltersValidation, readinessManager.splits, 1000, 1, true);
+    splitChangesUpdater = splitChangesUpdaterFactory({ log: loggerMock }, splitChangesFetcher, storage, splitFiltersValidation, readinessManager.splits, 1000, 1, true);
 
     let index = 0;
     let calls = 0;
@@ -294,7 +294,7 @@ describe('splitChangesUpdater', () => {
     // @ts-ignore
     splitFiltersValidation = { queryString: null, groupedFilters: { bySet: ['set_a'], byName: [], byPrefix: [] }, validFilters: [] };
     storage.splits.clear();
-    splitChangesUpdater = splitChangesUpdaterFactory(loggerMock, splitChangesFetcher, storage, splitFiltersValidation, readinessManager.splits, 1000, 1, true);
+    splitChangesUpdater = splitChangesUpdaterFactory({ log: loggerMock }, splitChangesFetcher, storage, splitFiltersValidation, readinessManager.splits, 1000, 1, true);
     splitsEmitSpy.mockReset();
     index = 0;
     for (const setMock of setMocks) {
@@ -414,7 +414,7 @@ describe('splitChangesUpdater', () => {
     readinessManager.segments.segmentsArrived = false; // Segments not ready - client-side should still emit
 
     // Create client-side updater (isClientSide = true)
-    const clientSideUpdater = splitChangesUpdaterFactory(loggerMock, splitChangesFetcher, storage, splitFiltersValidation, readinessManager.splits, 1000, 1, true);
+    const clientSideUpdater = splitChangesUpdaterFactory({ log: loggerMock }, splitChangesFetcher, storage, splitFiltersValidation, readinessManager.splits, 1000, 1, true);
 
     const flag1 = { name: 'client-flag', status: 'ACTIVE', changeNumber: 300, conditions: [] } as unknown as ISplit;
     fetchMock.once('*', { status: 200, body: { ff: { d: [flag1], t: 300 } } });

src/sync/polling/updaters/splitChangesUpdater.ts

@@ -3,14 +3,14 @@ import { ISplitChangesFetcher } from '../fetchers/types';
 import { IRBSegment, ISplit, ISplitChangesResponse, ISplitFiltersValidation, MaybeThenable } from '../../../dtos/types';
 import { ISplitsEventEmitter } from '../../../readiness/types';
 import { timeout } from '../../../utils/promise/timeout';
-import { SDK_SPLITS_ARRIVED, FLAGS_UPDATE, SEGMENTS_UPDATE } from '../../../readiness/constants';
-import { ILogger } from '../../../logger/types';
+import { SDK_SPLITS_ARRIVED, FLAGS_UPDATE, SEGMENTS_UPDATE, CONFIGS_UPDATE } from '../../../readiness/constants';
 import { SYNC_SPLITS_FETCH, SYNC_SPLITS_UPDATE, SYNC_RBS_UPDATE, SYNC_SPLITS_FETCH_FAILS, SYNC_SPLITS_FETCH_RETRY } from '../../../logger/constants';
 import { startsWith } from '../../../utils/lang';
 import { IN_RULE_BASED_SEGMENT, IN_SEGMENT, RULE_BASED_SEGMENT, STANDARD_SEGMENT } from '../../../utils/constants';
 import { setToArray } from '../../../utils/lang/sets';
 import { SPLIT_UPDATE } from '../../streaming/constants';
 import { SdkUpdateMetadata } from '../../../../types/splitio';
+import { ISettings } from '../../../types';
 
 export type InstantUpdate = { payload: ISplit | IRBSegment, changeNumber: number, type: string };
 type SplitChangesUpdater = (noCache?: boolean, till?: number, instantUpdate?: InstantUpdate) => Promise<boolean>
@@ -120,7 +120,7 @@ export function computeMutation<T extends ISplit | IRBSegment>(rules: Array<T>,
  * @param retriesOnFailureBeforeReady -  How many retries on `/splitChanges` we the updater do in case of failure or timeout. Default 0, i.e., no retries.
  */
 export function splitChangesUpdaterFactory(
-  log: ILogger,
+  settings: Pick<ISettings, 'log' | 'definitionsType'>,
   splitChangesFetcher: ISplitChangesFetcher,
   storage: Pick<IStorageBase, 'splits' | 'rbSegments' | 'segments' | 'save'>,
   splitFiltersValidation: ISplitFiltersValidation,
@@ -129,6 +129,7 @@ export function splitChangesUpdaterFactory(
   retriesOnFailureBeforeReady = 0,
   isClientSide?: boolean
 ): SplitChangesUpdater {
+  const { log, definitionsType } = settings;
   const { splits, rbSegments, segments } = storage;
 
   let startingUp = true;
@@ -202,7 +203,9 @@ export function splitChangesUpdaterFactory(
                   // emit SDK events
                   if (emitSplitsArrivedEvent) {
                     const metadata: SdkUpdateMetadata = {
-                      type: updatedFlags.length > 0 ? FLAGS_UPDATE : SEGMENTS_UPDATE,
+                      type: updatedFlags.length > 0 ?
+                        definitionsType === 'configs' ? CONFIGS_UPDATE : FLAGS_UPDATE :
+                        SEGMENTS_UPDATE,
                       names: updatedFlags.length > 0 ? updatedFlags : []
                     };
                     splitsEventEmitter.emit(SDK_SPLITS_ARRIVED, metadata);

types/splitio.d.ts

@@ -509,7 +509,7 @@ declare namespace SplitIO {
   /**
    * Metadata type for SDK update events.
    */
-  type SdkUpdateMetadataType = 'FLAGS_UPDATE' | 'SEGMENTS_UPDATE';
+  type SdkUpdateMetadataType = 'CONFIGS_UPDATE' | 'FLAGS_UPDATE' | 'SEGMENTS_UPDATE';
 
   /**
    * Metadata for the ready events emitted when the SDK is ready to evaluate feature flags.
@@ -2339,7 +2339,11 @@ declare namespace SplitIO {
     /**
      * Custom endpoints to replace the default ones used by the SDK.
      */
-    urls?: UrlSettings;
+    urls?: UrlSettings | string;
+    /**
+     * Fallback configuration objects to use when the SDK is unable to fetch the configurations from the server.
+     */
+    fallbacks?: FallbackTreatmentConfiguration;
     // /**
     //  * Defines what impressions are sent to Split servers.
     //  * - DEBUG: all impressions are sent.