Add getRegisteredSegment utility function, to compute the segments in use for server-side

Author: EmilianoSanchez

src/storages/AbstractMySegmentsCacheSync.ts

@@ -11,6 +11,7 @@ export abstract class AbstractMySegmentsCacheSync implements ISegmentsCacheSync
   protected abstract addSegment(name: string): boolean
   protected abstract removeSegment(name: string): boolean
   protected abstract setChangeNumber(changeNumber?: number): boolean | void
+  protected abstract getSegments(): string[]
 
   /**
    * For server-side synchronizer: check if `key` is in `name` segment.
@@ -27,14 +28,14 @@ export abstract class AbstractMySegmentsCacheSync implements ISegmentsCacheSync
 
 
   // No-op. Not used in client-side.
-  registerSegments(): boolean { return false; }
   update() { return false; }
 
   /**
-   * For server-side synchronizer: get the list of segments to fetch changes.
-   * Also used for the `seC` (segment count) telemetry stat.
+   * Used for the `seC` (segment count) telemetry stat.
    */
-  abstract getRegisteredSegments(): string[]
+  getSegmentsCount() {
+    return this.getSegments().length;
+  }
 
   /**
    * Only used for the `skC`(segment keys count) telemetry stat: 1 for client-side, and total count of keys in server-side.
@@ -68,7 +69,7 @@ export abstract class AbstractMySegmentsCacheSync implements ISegmentsCacheSync
     }
 
     const names = ((segmentsData as IMySegmentsResponse).k || []).map(s => s.n).sort();
-    const storedSegmentKeys = this.getRegisteredSegments().sort();
+    const storedSegmentKeys = this.getSegments().sort();
 
     // Extreme fast => everything is empty
     if (!names.length && !storedSegmentKeys.length) return false;

src/storages/AbstractSplitsCacheAsync.ts

@@ -31,7 +31,7 @@ export abstract class AbstractSplitsCacheAsync implements ISplitsCacheAsync {
   abstract trafficTypeExists(trafficType: string): Promise<boolean>
   abstract clear(): Promise<boolean | void>
 
-  // @TODO revisit segment-related methods ('usesSegments', 'getRegisteredSegments', 'registerSegments')
+  // @TODO revisit segment-related methods ('usesSegments')
   // noop, just keeping the interface. This is used by standalone client-side API only, and so only implemented by InMemory and InLocalStorage.
   usesSegments(): Promise<boolean> {
     return Promise.resolve(true);

src/storages/KeyBuilderSS.ts

@@ -29,10 +29,6 @@ export class KeyBuilderSS extends KeyBuilder {
     this.versionablePrefix = `${metadata.s}/${metadata.n}/${metadata.i}`;
   }
 
-  buildRegisteredSegmentsKey() {
-    return `${this.prefix}.segments.registered`;
-  }
-
   buildImpressionsKey() {
     return `${this.prefix}.impressions`;
   }

src/storages/__tests__/KeyBuilder.spec.ts

@@ -36,15 +36,8 @@ test('KEYS / segments keys', () => {
   const expectedKey = `SPLITIO.segment.${segmentName}`;
   const expectedTill = `SPLITIO.segment.${segmentName}.till`;
 
-  const expectedSegmentRegistered = 'SPLITIO.segments.registered';
-
   expect(builder.buildSegmentNameKey(segmentName) === expectedKey).toBe(true);
   expect(builder.buildSegmentTillKey(segmentName) === expectedTill).toBe(true);
-  expect(builder.buildRegisteredSegmentsKey() === expectedSegmentRegistered).toBe(true);
-
-  // NOT USED
-  // const expectedReady = 'SPLITIO.segments.ready';
-  // expect(builder.buildSegmentsReady() === expectedReady).toBe(true);
 });
 
 test('KEYS / traffic type keys', () => {

src/storages/inLocalStorage/MySegmentsCacheInLocal.ts

@@ -46,7 +46,7 @@ export class MySegmentsCacheInLocal extends AbstractMySegmentsCacheSync {
     return localStorage.getItem(this.keys.buildSegmentNameKey(name)) === DEFINED;
   }
 
-  getRegisteredSegments(): string[] {
+  protected getSegments(): string[] {
     // Scan current values from localStorage
     return Object.keys(localStorage).reduce((accum, key) => {
       let segmentName = this.keys.extractSegmentName(key);

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(name => this.get(name) as IRBSegment);
+  }
+
   contains(names: Set<string>): boolean {
     const namesArray = setToArray(names);
     const namesInStorage = this.getNames();

src/storages/inLocalStorage/__tests__/MySegmentsCacheInLocal.spec.ts

@@ -17,7 +17,6 @@ test('SEGMENT CACHE / in LocalStorage', () => {
     expect(cache.getChangeNumber()).toBe(-1);
 
     expect(cache.isInSegment('mocked-segment')).toBe(true);
-    expect(cache.getRegisteredSegments()).toEqual(['mocked-segment', 'mocked-segment-2']);
     expect(cache.getKeysCount()).toBe(1);
   });
 
@@ -29,7 +28,6 @@ test('SEGMENT CACHE / in LocalStorage', () => {
     });
 
     expect(cache.isInSegment('mocked-segment')).toBe(false);
-    expect(cache.getRegisteredSegments()).toEqual(['mocked-segment-2']);
     expect(cache.getKeysCount()).toBe(1);
   });
 

src/storages/inMemory/MySegmentsCacheInMemory.ts

@@ -38,7 +38,7 @@ export class MySegmentsCacheInMemory extends AbstractMySegmentsCacheSync {
     return this.cn || -1;
   }
 
-  getRegisteredSegments() {
+  protected getSegments() {
     return Object.keys(this.segmentCache);
   }
 

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(name => this.get(name) as IRBSegment);
+  }
+
   contains(names: Set<string>): boolean {
     const namesArray = setToArray(names);
     const namesInStorage = this.getNames();

src/storages/inMemory/SegmentsCacheInMemory.ts

@@ -36,24 +36,8 @@ export class SegmentsCacheInMemory implements ISegmentsCacheSync {
     this.segmentChangeNumber = {};
   }
 
-  private _registerSegment(name: string) {
-    if (!this.segmentCache[name]) {
-      this.segmentCache[name] = new Set<string>();
-    }
-
-    return true;
-  }
-
-  registerSegments(names: string[]) {
-    for (let i = 0; i < names.length; i++) {
-      this._registerSegment(names[i]);
-    }
-
-    return true;
-  }
-
-  getRegisteredSegments() {
-    return Object.keys(this.segmentCache);
+  getSegmentsCount() {
+    return Object.keys(this.segmentCache).length;
   }
 
   getKeysCount() {