featu: [Add support for exporting the configuration[ (FF-2437) (#90)

* featu: [Add support for exporting the configuration[ (FF-2437)

* rename getAll to entries

* getFlagConfigurations

* bump to 3.4.0

Author: leoromanovsky

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eppo/js-client-sdk-common",
-  "version": "3.3.3",
+  "version": "3.4.0",
   "description": "Eppo SDK for client-side JavaScript applications (base for both web and react native)",
   "main": "dist/index.js",
   "files": [

src/client/eppo-client.spec.ts

@@ -354,6 +354,12 @@ describe('EppoClient E2E test', () => {
     expect(assignment).toEqual('variation-a');
   });
 
+  it('exports flag configuration', () => {
+    storage.setEntries({ [flagKey]: mockFlag });
+    const client = new EppoClient(storage);
+    expect(client.getFlagConfigurations()).toEqual({ [flagKey]: mockFlag });
+  });
+
   describe('assignment logging deduplication', () => {
     let client: EppoClient;
     let mockLogger: IAssignmentLogger;

src/client/eppo-client.ts

@@ -143,6 +143,8 @@ export interface IEppoClient {
 
   getFlagKeys(): string[];
 
+  getFlagConfigurations(): Record<string, Flag>;
+
   isInitialized(): boolean;
 }
 
@@ -503,6 +505,10 @@ export default class EppoClient implements IEppoClient {
     this.isGracefulFailureMode = gracefulFailureMode;
   }
 
+  public getFlagConfigurations(): Record<string, Flag> {
+    return this.configurationStore.entries();
+  }
+
   private flushQueuedEvents() {
     const eventsToFlush = this.queuedEvents;
     this.queuedEvents = [];

src/configuration-store/configuration-store.ts

@@ -23,6 +23,7 @@
 export interface IConfigurationStore<T> {
   init(): Promise<void>;
   get(key: string): T | null;
+  entries(): Record<string, T>;
   getKeys(): string[];
   isInitialized(): boolean;
   isExpired(): Promise<boolean>;
@@ -31,6 +32,7 @@ export interface IConfigurationStore<T> {
 
 export interface ISyncStore<T> {
   get(key: string): T | null;
+  entries(): Record<string, T>;
   getKeys(): string[];
   isInitialized(): boolean;
   setEntries(entries: Record<string, T>): void;
@@ -39,6 +41,6 @@ export interface ISyncStore<T> {
 export interface IAsyncStore<T> {
   isInitialized(): boolean;
   isExpired(): Promise<boolean>;
-  getEntries(): Promise<Record<string, T>>;
+  entries(): Promise<Record<string, T>>;
   setEntries(entries: Record<string, T>): Promise<void>;
 }

src/configuration-store/hybrid.store.spec.ts

@@ -9,13 +9,14 @@ describe('HybridConfigurationStore', () => {
   beforeEach(() => {
     syncStoreMock = {
       get: jest.fn(),
+      entries: jest.fn(),
       getKeys: jest.fn(),
       isInitialized: jest.fn(),
       setEntries: jest.fn(),
     };
 
     asyncStoreMock = {
-      getEntries: jest.fn(),
+      entries: jest.fn(),
       isInitialized: jest.fn(),
       isExpired: jest.fn(),
       setEntries: jest.fn(),
@@ -28,7 +29,7 @@ describe('HybridConfigurationStore', () => {
     it('should initialize the serving store with entries from the persistent store if the persistent store is initialized', async () => {
       const entries = { key1: 'value1', key2: 'value2' };
       (asyncStoreMock.isInitialized as jest.Mock).mockReturnValue(true);
-      (asyncStoreMock.getEntries as jest.Mock).mockResolvedValue(entries);
+      (asyncStoreMock.entries as jest.Mock).mockResolvedValue(entries);
 
       await store.init();
 
@@ -67,6 +68,14 @@ describe('HybridConfigurationStore', () => {
     });
   });
 
+  describe('entries', () => {
+    it('should return all entries from the serving store', () => {
+      const entries = { key1: 'value1', key2: 'value2' };
+      (syncStoreMock.entries as jest.Mock).mockReturnValue(entries);
+      expect(store.entries()).toEqual(entries);
+    });
+  });
+
   describe('setEntries', () => {
     it('should set entries in both stores if the persistent store is present', async () => {
       const entries = { key1: 'value1', key2: 'value2' };

src/configuration-store/hybrid.store.ts

@@ -29,7 +29,7 @@ export class HybridConfigurationStore<T> implements IConfigurationStore<T> {
       );
     }
 
-    const entries = await this.persistentStore.getEntries();
+    const entries = await this.persistentStore.entries();
     this.servingStore.setEntries(entries);
   }
 
@@ -49,6 +49,10 @@ export class HybridConfigurationStore<T> implements IConfigurationStore<T> {
     return this.servingStore.get(key);
   }
 
+  public entries(): Record<string, T> {
+    return this.servingStore.entries();
+  }
+
   public getKeys(): string[] {
     return this.servingStore.getKeys();
   }

src/configuration-store/memory.store.spec.ts

@@ -36,6 +36,12 @@ describe('MemoryOnlyConfigurationStore', () => {
     expect(memoryStore.getKeys()).toEqual(['key1', 'key2', 'key3']);
   });
 
+  it('should return all entries', async () => {
+    const entries = { key1: 'value1', key2: 'value2', key3: 'value3' };
+    await memoryStore.setEntries(entries);
+    expect(memoryStore.entries()).toEqual(entries);
+  });
+
   it('should overwrite existing entries', async () => {
     await memoryStore.setEntries({ toBeReplaced: 'old value', toBeRemoved: 'delete me' });
     expect(memoryStore.get('toBeReplaced')).toBe('old value');

src/configuration-store/memory.store.ts

@@ -8,6 +8,10 @@ export class MemoryStore<T> implements ISyncStore<T> {
     return this.store[key] ?? null;
   }
 
+  entries(): Record<string, T> {
+    return this.store;
+  }
+
   getKeys(): string[] {
     return Object.keys(this.store);
   }
@@ -35,6 +39,10 @@ export class MemoryOnlyConfigurationStore<T> implements IConfigurationStore<T> {
     return this.servingStore.get(key);
   }
 
+  entries(): Record<string, T> {
+    return this.servingStore.entries();
+  }
+
   getKeys(): string[] {
     return this.servingStore.getKeys();
   }