Update metadata properties

ZamoraEmmanuel · ZamoraEmmanuel · commit f4a698888376 · 2026-01-12T10:39:53.000-03:00
diff --git a/src/readiness/__tests__/readinessManager.spec.ts b/src/readiness/__tests__/readinessManager.spec.ts
@@ -310,7 +310,8 @@ test('READINESS MANAGER / SDK_UPDATE should emit with metadata', () => {
   readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED);
 
   const metadata: SdkUpdateMetadata = {
-    [SdkUpdateMetadataKeys.UPDATED_FLAGS]: ['flag1', 'flag2']
+    type: SdkUpdateMetadataKeys.FLAGS_UPDATE,
+    names: ['flag1', 'flag2']
   };
 
   let receivedMetadata: SdkUpdateMetadata | undefined;
@@ -348,7 +349,8 @@ test('READINESS MANAGER / SDK_UPDATE should forward metadata from segments', ()
   readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED);
 
   const metadata: SdkUpdateMetadata = {
-    [SdkUpdateMetadataKeys.UPDATED_SEGMENTS]: ['segment1', 'segment2']
+    type: SdkUpdateMetadataKeys.SEGMENTS_UPDATE,
+    names: ['segment1', 'segment2']
   };
 
   let receivedMetadata: SdkUpdateMetadata | undefined;
diff --git a/src/readiness/readinessManager.ts b/src/readiness/readinessManager.ts
@@ -3,7 +3,6 @@ import { ISettings } from '../types';
 import SplitIO from '../../types/splitio';
 import { SDK_SPLITS_ARRIVED, SDK_SPLITS_CACHE_LOADED, SDK_SEGMENTS_ARRIVED, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE, SDK_READY } from './constants';
 import { IReadinessEventEmitter, IReadinessManager, ISegmentsEventEmitter, ISplitsEventEmitter } from './types';
-import { SdkUpdateMetadata } from '../sync/polling/types';
 
 function splitsEventEmitterFactory(EventEmitter: new () => SplitIO.IEventEmitter): ISplitsEventEmitter {
   const splitsEventEmitter = objectAssign(new EventEmitter(), {
@@ -16,7 +15,7 @@ function splitsEventEmitterFactory(EventEmitter: new () => SplitIO.IEventEmitter
   // `isSplitKill` condition avoids an edge-case of wrongly emitting SDK_READY if:
   // - `/memberships` fetch and SPLIT_KILL occurs before `/splitChanges` fetch, and
   // - storage has cached splits (for which case `splitsStorage.killLocally` can return true)
-  splitsEventEmitter.on(SDK_SPLITS_ARRIVED, (metadata: SdkUpdateMetadata, isSplitKill: boolean) => { if (!isSplitKill) splitsEventEmitter.splitsArrived = true; });
+  splitsEventEmitter.on(SDK_SPLITS_ARRIVED, (metadata: SplitIO.SdkUpdateMetadata, isSplitKill: boolean) => { if (!isSplitKill) splitsEventEmitter.splitsArrived = true; });
   splitsEventEmitter.once(SDK_SPLITS_CACHE_LOADED, () => { splitsEventEmitter.splitsCacheLoaded = true; });
 
   return splitsEventEmitter;
@@ -99,7 +98,7 @@ export function readinessManagerFactory(
     }
   }
 
-  function checkIsReadyOrUpdate(metadata: SdkUpdateMetadata) {
+  function checkIsReadyOrUpdate(metadata: SplitIO.SdkUpdateMetadata) {
     if (isDestroyed) return;
     if (isReady) {
       try {
diff --git a/src/readiness/types.ts b/src/readiness/types.ts
@@ -1,5 +1,4 @@
 import SplitIO from '../../types/splitio';
-import { SdkUpdateMetadata } from '../sync/polling/types';
 
 /** Readiness event types */
 
@@ -23,7 +22,7 @@ type ISplitsEvent = SDK_SPLITS_ARRIVED | SDK_SPLITS_CACHE_LOADED
 export interface ISplitsEventEmitter extends SplitIO.IEventEmitter {
   emit(event: ISplitsEvent, ...args: any[]): boolean
   on(event: ISplitsEvent, listener: (...args: any[]) => void): this;
-  on(event: SDK_UPDATE, listener: (metadata: SdkUpdateMetadata) => void): this;
+  on(event: SDK_UPDATE, listener: (metadata: SplitIO.SdkUpdateMetadata) => void): this;
   once(event: ISplitsEvent, listener: (...args: any[]) => void): this;
   splitsArrived: boolean
   splitsCacheLoaded: boolean
@@ -39,7 +38,7 @@ type ISegmentsEvent = SDK_SEGMENTS_ARRIVED
 export interface ISegmentsEventEmitter extends SplitIO.IEventEmitter {
   emit(event: ISegmentsEvent, ...args: any[]): boolean
   on(event: ISegmentsEvent, listener: (...args: any[]) => void): this;
-  on(event: SDK_UPDATE, listener: (metadata: SdkUpdateMetadata) => void): this;
+  on(event: SDK_UPDATE, listener: (metadata: SplitIO.SdkUpdateMetadata) => void): this;
   once(event: ISegmentsEvent, listener: (...args: any[]) => void): this;
   segmentsArrived: boolean
 }
diff --git a/src/sync/polling/types.ts b/src/sync/polling/types.ts
@@ -33,11 +33,13 @@ export interface IPollingManagerCS extends IPollingManager {
 }
 
 export enum SdkUpdateMetadataKeys {
-  UPDATED_FLAGS = 'updatedFlags',
-  UPDATED_SEGMENTS = 'updatedSegments'
+  FLAGS_UPDATE = 'FLAGS_UPDATE',
+  SEGMENTS_UPDATE = 'SEGMENTS_UPDATE'
 }
-
+/**
+ * SdkUpdateMetadata type for polling updaters
+ */
 export type SdkUpdateMetadata = {
-  [SdkUpdateMetadataKeys.UPDATED_FLAGS]?: string[]
-  [SdkUpdateMetadataKeys.UPDATED_SEGMENTS]?: string[]
+  type: SdkUpdateMetadataKeys.FLAGS_UPDATE | SdkUpdateMetadataKeys.SEGMENTS_UPDATE
+  names: string[]
 }
diff --git a/src/sync/polling/updaters/__tests__/segmentChangesUpdater.spec.ts b/src/sync/polling/updaters/__tests__/segmentChangesUpdater.spec.ts
@@ -7,6 +7,7 @@ import { loggerMock } from '../../../../logger/__tests__/sdkLogger.mock';
 import { ISegmentChangesFetcher } from '../../fetchers/types';
 import { ISegmentChangesResponse } from '../../../../dtos/types';
 import { SDK_SEGMENTS_ARRIVED } from '../../../../readiness/constants';
+import { SdkUpdateMetadataKeys } from '../../types';
 
 describe('segmentChangesUpdater', () => {
   const segments = new SegmentsCacheInMemory();
@@ -47,6 +48,6 @@ describe('segmentChangesUpdater', () => {
     await segmentChangesUpdater(undefined, segmentName);
 
     expect(updateSegments).toHaveBeenCalledWith(segmentName, segmentChange.added, segmentChange.removed, segmentChange.till);
-    expect(segmentsEmitSpy).toBeCalledWith(SDK_SEGMENTS_ARRIVED, { updatedSegments: [segmentName] });
+    expect(segmentsEmitSpy).toBeCalledWith(SDK_SEGMENTS_ARRIVED, { type: SdkUpdateMetadataKeys.SEGMENTS_UPDATE, names: [segmentName] });
   });
 });
diff --git a/src/sync/polling/updaters/__tests__/splitChangesUpdater.spec.ts b/src/sync/polling/updaters/__tests__/splitChangesUpdater.spec.ts
@@ -16,6 +16,7 @@ import { RBSegmentsCacheInMemory } from '../../../../storages/inMemory/RBSegment
 import { RB_SEGMENT_UPDATE, SPLIT_UPDATE } from '../../../streaming/constants';
 import { IN_RULE_BASED_SEGMENT } from '../../../../utils/constants';
 import { SDK_SPLITS_ARRIVED } from '../../../../readiness/constants';
+import { SdkUpdateMetadataKeys } from '../../types';
 
 const ARCHIVED_FF = 'ARCHIVED';
 
@@ -221,7 +222,7 @@ describe('splitChangesUpdater', () => {
     expect(updateSplits).lastCalledWith(splitChangesMock1.ff.d, [], splitChangesMock1.ff.t);
     expect(updateRbSegments).toBeCalledTimes(0); // no rbSegments to update
     expect(registerSegments).toBeCalledTimes(1);
-    expect(splitsEmitSpy).toBeCalledWith(SDK_SPLITS_ARRIVED, { updatedFlags });
+    expect(splitsEmitSpy).toBeCalledWith(SDK_SPLITS_ARRIVED, { type: SdkUpdateMetadataKeys.FLAGS_UPDATE, names: updatedFlags });
     expect(result).toBe(true);
   });
 
@@ -287,7 +288,7 @@ describe('splitChangesUpdater', () => {
     for (const setMock of setMocks) {
       await expect(splitChangesUpdater(undefined, undefined, { payload: { ...payload, sets: setMock.sets, status: 'ACTIVE' }, changeNumber: index, type: SPLIT_UPDATE })).resolves.toBe(true);
       expect(splitsEmitSpy.mock.calls[index][0]).toBe(SDK_SPLITS_ARRIVED);
-      expect(splitsEmitSpy.mock.calls[index][1]).toEqual({ updatedFlags: [payload.name] });
+      expect(splitsEmitSpy.mock.calls[index][1]).toEqual({ type: SdkUpdateMetadataKeys.FLAGS_UPDATE, names: [payload.name] });
       index++;
     }
 
@@ -317,7 +318,7 @@ describe('splitChangesUpdater', () => {
 
     await expect(splitChangesUpdater(undefined, undefined, { payload, changeNumber: changeNumber, type: SPLIT_UPDATE })).resolves.toBe(true);
 
-    expect(splitsEmitSpy).toBeCalledWith(SDK_SPLITS_ARRIVED, { updatedFlags: [payload.name] });
+    expect(splitsEmitSpy).toBeCalledWith(SDK_SPLITS_ARRIVED, { type: SdkUpdateMetadataKeys.FLAGS_UPDATE, names: [payload.name] });
   });
 
 });
diff --git a/src/sync/polling/updaters/segmentChangesUpdater.ts b/src/sync/polling/updaters/segmentChangesUpdater.ts
@@ -5,6 +5,8 @@ import { SDK_SEGMENTS_ARRIVED } from '../../../readiness/constants';
 import { ILogger } from '../../../logger/types';
 import { LOG_PREFIX_INSTANTIATION, LOG_PREFIX_SYNC_SEGMENTS } from '../../../logger/constants';
 import { timeout } from '../../../utils/promise/timeout';
+import { SdkUpdateMetadata, SdkUpdateMetadataKeys } from '../types';
+
 
 type ISegmentChangesUpdater = (fetchOnlyNew?: boolean, segmentName?: string, noCache?: boolean, till?: number) => Promise<boolean>
 
@@ -83,7 +85,11 @@ export function segmentChangesUpdaterFactory(
         // if at least one segment fetch succeeded, mark segments ready
         if (shouldUpdateFlags.some(update => update) || readyOnAlreadyExistentState) {
           readyOnAlreadyExistentState = false;
-          if (readiness) readiness.segments.emit(SDK_SEGMENTS_ARRIVED, { updatedSegments: segmentNames });
+          const metadata: SdkUpdateMetadata = {
+            type: SdkUpdateMetadataKeys.SEGMENTS_UPDATE,
+            names: segmentNames
+          };
+          if (readiness) readiness.segments.emit(SDK_SEGMENTS_ARRIVED, metadata);
         }
         return true;
       });
diff --git a/src/sync/polling/updaters/splitChangesUpdater.ts b/src/sync/polling/updaters/splitChangesUpdater.ts
@@ -10,6 +10,7 @@ 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, SdkUpdateMetadataKeys } from '../types';
 
 export type InstantUpdate = { payload: ISplit | IRBSegment, changeNumber: number, type: string };
 type SplitChangesUpdater = (noCache?: boolean, till?: number, instantUpdate?: InstantUpdate) => Promise<boolean>
@@ -89,15 +90,14 @@ export function computeMutation<T extends ISplit | IRBSegment>(rules: Array<T>,
   return rules.reduce((accum, ruleEntity) => {
     if (ruleEntity.status === 'ACTIVE' && (!filters || matchFilters(ruleEntity as ISplit, filters))) {
       accum.added.push(ruleEntity);
-      accum.names.push(ruleEntity.name);
 
       parseSegments(ruleEntity).forEach((segmentName: string) => {
         segments.add(segmentName);
       });
     } else {
       accum.removed.push(ruleEntity);
-      accum.names.push(ruleEntity.name);
     }
+    accum.names.push(ruleEntity.name);
 
     return accum;
   }, { added: [], removed: [], names: [] } as ISplitMutations<T>);
@@ -197,8 +197,12 @@ export function splitChangesUpdaterFactory(
               return Promise.resolve(!splitsEventEmitter.splitsArrived || ((ffChanged || rbsChanged) && (isClientSide || checkAllSegmentsExist(segments))))
                 .catch(() => false /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
                 .then(emitSplitsArrivedEvent => {
+                  const metadata: SdkUpdateMetadata = {
+                    type: SdkUpdateMetadataKeys.FLAGS_UPDATE,
+                    names: updatedFlags
+                  };
                   // emit SDK events
-                  if (emitSplitsArrivedEvent) splitsEventEmitter.emit(SDK_SPLITS_ARRIVED, { updatedFlags });
+                  if (emitSplitsArrivedEvent) splitsEventEmitter.emit(SDK_SPLITS_ARRIVED, metadata);
                   return true;
                 });
             }
diff --git a/src/sync/streaming/types.ts b/src/sync/streaming/types.ts
@@ -1,9 +1,8 @@
 import { IMembershipMSUpdateData, IMembershipLSUpdateData, ISegmentUpdateData, ISplitUpdateData, ISplitKillData, INotificationData } from './SSEHandler/types';
 import { ITask } from '../types';
-import { IMySegmentsSyncTask, SdkUpdateMetadata } from '../polling/types';
+import { IMySegmentsSyncTask } from '../polling/types';
 import SplitIO from '../../../types/splitio';
 import { ControlType } from './constants';
-import { SDK_UPDATE } from '../../readiness/types';
 
 // Internal SDK events, subscribed by SyncManager and PushManager
 export type PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP'
@@ -38,7 +37,7 @@ type IParsedData<T extends IPushEvent> =
  */
 export interface IPushEventEmitter extends SplitIO.IEventEmitter {
   once<T extends IPushEvent>(event: T, listener: (parsedData: IParsedData<T>) => void): this;
-  on<T extends IPushEvent>(event: T, listener: (metadata: T extends SDK_UPDATE ? SdkUpdateMetadata : never) => void): this;
+  on<T extends IPushEvent>(event: T, listener: (parsedData: IParsedData<T>) => void): this;
   emit<T extends IPushEvent>(event: T, parsedData?: IParsedData<T>): boolean;
 }
 
diff --git a/types/splitio.d.ts b/types/splitio.d.ts
@@ -3,8 +3,6 @@
 
 import { RedisOptions } from 'ioredis';
 import { RequestOptions } from 'http';
-import { SDK_UPDATE } from '../src/readiness/types';
-import { SdkUpdateMetadata } from '../src/sync/polling/types';
 
 export as namespace SplitIO;
 export = SplitIO;
@@ -494,12 +492,28 @@ declare namespace SplitIO {
     removeItem(key: string): void | Promise<void>;
   }
 
+  /**
+   * Metadata keys for SDK update events.
+   */
+  enum SdkUpdateMetadataKeys {
+    FLAGS_UPDATE = 'FLAGS_UPDATE',
+    SEGMENTS_UPDATE = 'SEGMENTS_UPDATE'
+  }
+
+  /**
+   * List of modified flags or segments
+   * when a sdk update event is emitted.
+   */
+  type SdkUpdateMetadata = {
+    type: SdkUpdateMetadataKeys.FLAGS_UPDATE | SdkUpdateMetadataKeys.SEGMENTS_UPDATE
+    names: string[]
+  }
+
   /**
    * EventEmitter interface based on a subset of the Node.js EventEmitter methods.
    */
   interface IEventEmitter {
     addListener(event: string, listener: (...args: any[]) => void): this;
-    on(event: SDK_UPDATE, listener: (metadata: SdkUpdateMetadata) => void): this;
     on(event: string, listener: (...args: any[]) => void): this;
     once(event: string, listener: (...args: any[]) => void): this;
     removeListener(event: string, listener: (...args: any[]) => void): this;
@@ -512,9 +526,11 @@ declare namespace SplitIO {
    * @see {@link https://nodejs.org/api/events.html}
    */
   interface EventEmitter extends IEventEmitter {
+    addListener(event: EventConsts['SDK_UPDATE'], listener: (metadata: SdkUpdateMetadata) => void): this;
     addListener(event: string | symbol, listener: (...args: any[]) => void): this;
-    on(event: SDK_UPDATE, listener: (metadata: SdkUpdateMetadata) => void): this;
+    on(event: EventConsts['SDK_UPDATE'], listener: (metadata: SdkUpdateMetadata) => void): this;
     on(event: string | symbol, listener: (...args: any[]) => void): this;
+    once(event: EventConsts['SDK_UPDATE'], listener: (metadata: SdkUpdateMetadata) => void): this;
     once(event: string | symbol, listener: (...args: any[]) => void): this;
     removeListener(event: string | symbol, listener: (...args: any[]) => void): this;
     off(event: string | symbol, listener: (...args: any[]) => void): this;

Original file line number	Diff line number	Diff line change
`@@ -33,11 +33,13 @@ export interface IPollingManagerCS extends IPollingManager {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`export enum SdkUpdateMetadataKeys {`
`36`		`- UPDATED_FLAGS = 'updatedFlags',`
`37`		`- UPDATED_SEGMENTS = 'updatedSegments'`
	`36`	`+ FLAGS_UPDATE = 'FLAGS_UPDATE',`
	`37`	`+ SEGMENTS_UPDATE = 'SEGMENTS_UPDATE'`
`38`	`38`	`}`
`39`		`-`
	`39`	`+/**`
	`40`	`+ * SdkUpdateMetadata type for polling updaters`
	`41`	`+ */`
`40`	`42`	`export type SdkUpdateMetadata = {`
`41`		`- [SdkUpdateMetadataKeys.UPDATED_FLAGS]?: string[]`
`42`		`- [SdkUpdateMetadataKeys.UPDATED_SEGMENTS]?: string[]`
	`43`	`+ type: SdkUpdateMetadataKeys.FLAGS_UPDATE \| SdkUpdateMetadataKeys.SEGMENTS_UPDATE`
	`44`	`+ names: string[]`
`43`	`45`	`}`