Add RBSegments

Author: EmilianoSanchez

src/storages/__tests__/dataLoader.spec.ts

@@ -9,7 +9,8 @@ test('loadData & getSnapshot', () => {
   const onReadyFromCacheCb = jest.fn();
   // @ts-expect-error
   const serverStorage = InMemoryStorageFactory({ settings: fullSettings }); // @ts-expect-error
-  serverStorage.splits.update([{ name: 'split1' }], [], 123);
+  serverStorage.splits.update([{ name: 'split1' }], [], 123); // @ts-expect-error
+  serverStorage.rbSegments.update([{ name: 'rbs1' }], [], 321);
   serverStorage.segments.update('segment1', [fullSettings.core.key as string], [], 123);
 
   const preloadedData = dataLoader.getSnapshot(serverStorage, [fullSettings.core.key as string]);
@@ -24,6 +25,8 @@ test('loadData & getSnapshot', () => {
   expect(preloadedData).toEqual({
     since: 123,
     flags: [{ name: 'split1' }],
+    rbSince: 321,
+    rbSegments: [{ name: 'rbs1' }],
     memberships: { [fullSettings.core.key as string]: { ms: { k: [{ n: 'segment1' }] }, ls: { k: [] } } },
     segments: undefined
   });

src/storages/dataLoader.ts

@@ -1,25 +1,26 @@
 import SplitIO from '../../types/splitio';
-import { ISegmentsCacheSync, ISplitsCacheSync, IStorageSync } from './types';
+import { IRBSegmentsCacheSync, ISegmentsCacheSync, ISplitsCacheSync, IStorageSync } from './types';
 import { setToArray } from '../utils/lang/sets';
 import { getMatching } from '../utils/key';
-import { IMembershipsResponse, IMySegmentsResponse, ISplit } from '../dtos/types';
+import { IMembershipsResponse, IMySegmentsResponse, IRBSegment, ISplit } from '../dtos/types';
 
 /**
  *
  * @param preloadedData - validated data
  * @param storage - object containing `splits` and `segments` cache (client-side variant)
  * @param userKey - user key (matching key) of the provided MySegmentsCache
  *
+ * @TODO load data even if current data is more recent?
  * @TODO extend to load largeSegments
  * @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
  * @TODO add logs, and input validation in this module, in favor of size reduction.
  * @TODO unit tests
  */
-export function loadData(preloadedData: SplitIO.PreloadedData, storage: { splits?: ISplitsCacheSync, segments: ISegmentsCacheSync, largeSegments?: ISegmentsCacheSync }, matchingKey?: string) {
+export function loadData(preloadedData: SplitIO.PreloadedData, storage: { splits?: ISplitsCacheSync, rbSegments?: IRBSegmentsCacheSync, segments: ISegmentsCacheSync, largeSegments?: ISegmentsCacheSync }, matchingKey?: string) {
   // Do not load data if current preloadedData is empty
   if (Object.keys(preloadedData).length === 0) return;
 
-  const { segments = {}, since = -1, flags = [] } = preloadedData;
+  const { segments = {}, since = -1, flags = [], rbSince = -1, rbSegments = [] } = preloadedData;
 
   if (storage.splits) {
     const storedSince = storage.splits.getChangeNumber();
@@ -34,6 +35,19 @@ export function loadData(preloadedData: SplitIO.PreloadedData, storage: { splits
     storage.splits.update(flags as ISplit[], [], since);
   }
 
+  if (storage.rbSegments) {
+    const storedSince = storage.rbSegments.getChangeNumber();
+
+    // Do not load data if current data is more recent
+    if (storedSince > rbSince) return;
+
+    // cleaning up the localStorage data, since some cached splits might need be part of the preloaded data
+    storage.rbSegments.clear();
+
+    // splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
+    storage.rbSegments.update(rbSegments as IRBSegment[], [], rbSince);
+  }
+
   if (matchingKey) { // add memberships data (client-side)
     let memberships = preloadedData.memberships && preloadedData.memberships[matchingKey];
     if (!memberships && segments) {
@@ -61,9 +75,10 @@ export function loadData(preloadedData: SplitIO.PreloadedData, storage: { splits
 
 export function getSnapshot(storage: IStorageSync, userKeys?: SplitIO.SplitKey[]): SplitIO.PreloadedData {
   return {
-    // lastUpdated: Date.now(),
     since: storage.splits.getChangeNumber(),
     flags: storage.splits.getAll(),
+    rbSince: storage.rbSegments.getChangeNumber(),
+    rbSegments: storage.rbSegments.getAll(),
     segments: userKeys ?
       undefined : // @ts-ignore accessing private prop
       Object.keys(storage.segments.segmentCache).reduce((prev, cur) => { // @ts-ignore accessing private prop

src/storages/inLocalStorage/RBSegmentsCacheInLocal.ts

@@ -105,6 +105,10 @@ export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
     return item && JSON.parse(item);
   }
 
+  getAll(): IRBSegment[] {
+    return this.getNames().map(key => this.get(key)!);
+  }
+
   contains(names: Set<string>): boolean {
     const namesArray = setToArray(names);
     const namesInStorage = this.getNames();

src/storages/inMemory/RBSegmentsCacheInMemory.ts

@@ -51,6 +51,10 @@ export class RBSegmentsCacheInMemory implements IRBSegmentsCacheSync {
     return this.cache[name] || null;
   }
 
+  getAll(): IRBSegment[] {
+    return this.getNames().map(key => this.get(key)!);
+  }
+
   contains(names: Set<string>): boolean {
     const namesArray = setToArray(names);
     const namesInStorage = this.getNames();

src/storages/types.ts

@@ -235,6 +235,7 @@ export interface IRBSegmentsCacheSync extends IRBSegmentsCacheBase {
   update(toAdd: IRBSegment[], toRemove: IRBSegment[], changeNumber: number): boolean,
   get(name: string): IRBSegment | null,
   getChangeNumber(): number,
+  getAll(): IRBSegment[],
   clear(): void,
   contains(names: Set<string>): boolean,
   // Used only for smart pausing in client-side standalone. Returns true if the storage contains a RBSegment using segments or large segments matchers

types/splitio.d.ts

@@ -1031,14 +1031,17 @@ declare namespace SplitIO {
    */
   type PreloadedData = {
     /**
-     * Change number of the preloaded data.
-     * If this value is older than the current changeNumber at the storage, the data is not used to update the storage content.
+     * Change number of feature flags.
      */
     since: number;
     /**
      * List of feature flags.
      */
     flags: Object[],
+    /**
+     * Change number of rule-based segments.
+     */
+    rbSince?: number,
     /**
      * List of rule-based segments.
      */