chore: update client spec tests to 5.2.2 (#800)

Author: sighphyre

package.json

@@ -58,7 +58,7 @@
     "@types/node": "^20.17.17",
     "@types/proxy-from-env": "^1.0.4",
     "@types/semver": "^7.5.0",
-    "@unleash/client-specification": "5.1.9",
+    "@unleash/client-specification": "5.2.2",
     "@vitest/coverage-v8": "4.0.14",
     "@vitest/ui": "4.0.14",
     "del-cli": "^7.0.0",

src/feature.ts

@@ -25,6 +25,8 @@ export interface EnhancedFeatureInterface extends Omit<FeatureInterface, 'strate
   strategies?: EnhancedStrategyTransportInterface[];
 }
 
+export type ApiResponse = ClientFeaturesDelta | ClientFeaturesResponse;
+
 export interface ClientFeaturesResponse {
   version: number;
   features: FeatureInterface[];

src/repository/fetcher.ts

@@ -1,5 +1,5 @@
 import type { EventEmitter } from 'node:events';
-import type { ClientFeaturesDelta, ClientFeaturesResponse } from '../feature';
+import type { ApiResponse } from '../feature';
 import type { CustomHeaders, CustomHeadersFunction } from '../headers';
 import type { HttpOptions } from '../http-options';
 import type { TagFilter } from '../tags';
@@ -18,8 +18,7 @@ export interface CommonFetchingOptions {
   instanceId: string;
   headers?: CustomHeaders;
   connectionId: string;
-  onSave: (response: ClientFeaturesResponse, fromApi: boolean) => Promise<void>;
-  onSaveDelta: (delta: ClientFeaturesDelta) => Promise<void>;
+  onSave: (response: ApiResponse, fromApi: boolean) => Promise<void>;
   onModeChange?: (mode: Mode['type']) => Promise<void>;
 }
 

src/repository/index.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'node:events';
 import { UnleashEvents } from '../events';
 import type {
-  ClientFeaturesDelta,
+  ApiResponse,
   ClientFeaturesResponse,
   EnhancedFeatureInterface,
   FeatureInterface,
@@ -134,7 +134,6 @@ export default class Repository extends EventEmitter implements EventEmitter {
       mode,
       eventSource,
       onSave: this.save.bind(this),
-      onSaveDelta: this.saveDelta.bind(this),
     });
 
     this.setupFetchingStrategyEvents();
@@ -207,52 +206,74 @@ export default class Repository extends EventEmitter implements EventEmitter {
     return new Map(segments.map((segment) => [segment.id, segment]));
   }
 
-  public async save(response: ClientFeaturesResponse, fromApi: boolean): Promise<void> {
+  public async save(response: ApiResponse, fromApi: boolean): Promise<void> {
     if (this.stopped) {
       return;
     }
     if (fromApi) {
       this.connected = true;
-      this.data = this.convertToMap(response.features);
-      this.segments = this.createSegmentLookup(response.segments);
+      this.applyFeatureResponse(response);
     } else if (!this.connected) {
       // Only allow bootstrap if not connected
-      this.data = this.convertToMap(response.features);
-      this.segments = this.createSegmentLookup(response.segments);
+      this.applyFeatureResponse(response);
     }
 
     this.setReady();
-    this.emit(UnleashEvents.Changed, [...response.features]);
-    await this.storageProvider.set(this.appName, response);
+    const newFeatures = Object.values(this.data);
+    this.emit(UnleashEvents.Changed, newFeatures);
+
+    const clientFeatureResponse: ClientFeaturesResponse = {
+      version: 'version' in response ? response.version : 2,
+      features: newFeatures,
+      segments: [...this.segments.values()],
+    };
+
+    await this.storageProvider.set(this.appName, clientFeatureResponse);
   }
 
-  public async saveDelta(delta: ClientFeaturesDelta): Promise<void> {
-    if (this.stopped) {
-      return;
+  private applyFeatureResponse(response: ApiResponse): void {
+    if ('events' in response) {
+      response.events.forEach((event) => {
+        switch (event.type) {
+          case 'feature-updated': {
+            this.data[event.feature.name] = event.feature;
+            break;
+          }
+          case 'feature-removed': {
+            delete this.data[event.featureName];
+            break;
+          }
+          case 'segment-updated': {
+            this.segments.set(event.segment.id, event.segment);
+            break;
+          }
+          case 'segment-removed': {
+            this.segments.delete(event.segmentId);
+            break;
+          }
+          case 'hydration': {
+            this.data = this.convertToMap(event.features);
+            this.segments = this.createSegmentLookup(event.segments);
+            break;
+          }
+          default: {
+            this.emit(
+              UnleashEvents.Warn,
+              `Unknown event type received, this may or may not cause features to evaluate incorrectly: ${JSON.stringify(event)}`,
+            );
+            break;
+          }
+        }
+      });
+    } else if ('features' in response) {
+      this.data = this.convertToMap(response.features);
+      this.segments = this.createSegmentLookup(response.segments);
+    } else {
+      this.emit(
+        UnleashEvents.Warn,
+        `Unknown response when applying feature response: ${JSON.stringify(response)}`,
+      );
     }
-    this.connected = true;
-    delta.events.forEach((event) => {
-      if (event.type === 'feature-updated') {
-        this.data[event.feature.name] = event.feature;
-      } else if (event.type === 'feature-removed') {
-        delete this.data[event.featureName];
-      } else if (event.type === 'segment-updated') {
-        this.segments.set(event.segment.id, event.segment);
-      } else if (event.type === 'segment-removed') {
-        this.segments.delete(event.segmentId);
-      } else if (event.type === 'hydration') {
-        this.data = this.convertToMap(event.features);
-        this.segments = this.createSegmentLookup(event.segments);
-      }
-    });
-
-    this.setReady();
-    this.emit(UnleashEvents.Changed, Object.values(this.data));
-    await this.storageProvider.set(this.appName, {
-      features: Object.values(this.data),
-      segments: [...this.segments.values()],
-      version: 0,
-    });
   }
 
   notEmpty(content: ClientFeaturesResponse): boolean {

src/repository/polling-fetcher.ts

@@ -1,6 +1,5 @@
 import { EventEmitter } from 'node:events';
 import { UnleashEvents } from '../events';
-import { parseClientFeaturesDelta } from '../feature';
 import { get } from '../request';
 import type { TagFilter } from '../tags';
 import getUrl from '../url-utils';
@@ -166,12 +165,7 @@ export class PollingFetcher extends EventEmitter implements FetcherInterface {
             await this.options.onModeChange('streaming');
             return;
           }
-
-          if (this.options.mode.type === 'polling' && this.options.mode.format === 'delta') {
-            await this.options.onSaveDelta(parseClientFeaturesDelta(data));
-          } else {
-            await this.options.onSave(data, true);
-          }
+          await this.options.onSave(data, true);
         } catch (err) {
           this.emit(UnleashEvents.Error, err);
         }

src/repository/streaming-fetcher.ts

@@ -20,7 +20,7 @@ export class StreamingFetcher extends EventEmitter implements FetcherInterface {
 
   private readonly connectionId?: string;
 
-  private readonly onSaveDelta: StreamingFetchingOptions['onSaveDelta'];
+  private readonly onSave: StreamingFetchingOptions['onSave'];
 
   private readonly onModeChange?: StreamingFetchingOptions['onModeChange'];
 
@@ -35,7 +35,7 @@ export class StreamingFetcher extends EventEmitter implements FetcherInterface {
     eventSource,
     maxFailuresUntilFailover = 5,
     failureWindowMs = 60_000,
-    onSaveDelta,
+    onSave,
     onModeChange,
   }: StreamingFetchingOptions) {
     super();
@@ -45,7 +45,7 @@ export class StreamingFetcher extends EventEmitter implements FetcherInterface {
     this.instanceId = instanceId;
     this.headers = headers;
     this.connectionId = connectionId;
-    this.onSaveDelta = onSaveDelta;
+    this.onSave = onSave;
     this.onModeChange = onModeChange;
 
     this.eventSource = eventSource;
@@ -128,7 +128,7 @@ export class StreamingFetcher extends EventEmitter implements FetcherInterface {
   private async handleFlagsFromStream(event: { data: string }) {
     try {
       const data = parseClientFeaturesDelta(JSON.parse(event.data));
-      await this.onSaveDelta(data);
+      await this.onSave(data, true);
     } catch (err) {
       const errorMessage =
         err instanceof Error && typeof err.message === 'string' ? err.message : String(err);

src/test/repository/repository.test.ts

@@ -2074,7 +2074,7 @@ test('SSE with HTTP mocking - should process unleash-updated event', async () =>
   repo.stop();
 });
 
-test('SSE parse error forces full rehydration without Last-Event-ID', async (t) => {
+test('SSE parse error forces full rehydration without Last-Event-ID', async () => {
   const url = 'http://unleash-test-sse-parse-error.app';
 
   const initialHydration = createSSEResponse([

yarn.lock

@@ -676,10 +676,10 @@
   dependencies:
     "@types/node" "*"
 
-"@unleash/client-specification@5.1.9":
-  version "5.1.9"
-  resolved "https://registry.yarnpkg.com/@unleash/client-specification/-/client-specification-5.1.9.tgz#29e3721e2ead91fafb96f7d4a2d3a51e09a4a4f5"
-  integrity sha512-9/Z5Kc3uuSe/3cqTCa0P3nWqv6g5ZpD2ZRi6G3blU1C7SAqs6Zixo2etSz9U9tOHSQdDq39X4SM9KQwDutAdYg==
+"@unleash/client-specification@5.2.2":
+  version "5.2.2"
+  resolved "https://registry.yarnpkg.com/@unleash/client-specification/-/client-specification-5.2.2.tgz#a40601b22f5ceff745ce3871a3317dd83de59729"
+  integrity sha512-0BDc/K9MHMUFaZti9w0niUuOH+plg5lWVj0yd3KK6WppEmvFwDdHMP8ND36Vyjn22ABraYYftDu7MVvgavSUIw==
 
 "@vitest/coverage-v8@4.0.14":
   version "4.0.14"