chore: adds applyChanges to LDFeatureStore and impls. Adds TransactionalPersistentStore.

Author: Todd Anderson

packages/sdk/fastly/src/api/EdgeFeatureStore.ts

@@ -1,5 +1,7 @@
+import { InitMetadata } from '@launchdarkly/js-sdk-common/dist/esm/internal';
 import type {
   DataKind,
+  internal,
   LDFeatureStore,
   LDFeatureStoreDataStorage,
   LDFeatureStoreItem,
@@ -113,6 +115,16 @@ export class EdgeFeatureStore implements LDFeatureStore {
   }
 
   init(allData: LDFeatureStoreDataStorage, callback: () => void): void {
+    this.applyChanges(true, allData, callback);
+  }
+
+  applyChanges(
+    _basis: boolean,
+    _data: LDFeatureStoreDataStorage,
+    callback: () => void,
+    _initMetadata?: internal.InitMetadata,
+    _selector?: String,
+  ): void {
     callback();
   }
 

packages/shared/akamai-edgeworker-sdk/src/featureStore/index.ts

@@ -128,6 +128,10 @@ export class EdgeFeatureStore implements LDFeatureStore {
   }
 
   init(allData: LDFeatureStoreDataStorage, callback: () => void): void {
+    this.applyChanges(true, allData, callback);
+  }
+
+  applyChanges(basis: boolean, data: LDFeatureStoreDataStorage, callback: () => void): void {
     callback();
   }
 

packages/shared/sdk-server-edge/src/api/EdgeFeatureStore.ts

@@ -1,5 +1,6 @@
 import type {
   DataKind,
+  internal,
   LDFeatureStore,
   LDFeatureStoreDataStorage,
   LDFeatureStoreItem,
@@ -114,6 +115,16 @@ export class EdgeFeatureStore implements LDFeatureStore {
   }
 
   init(allData: LDFeatureStoreDataStorage, callback: () => void): void {
+    this.applyChanges(true, allData, callback);
+  }
+
+  applyChanges(
+    _basis: boolean,
+    _data: LDFeatureStoreDataStorage,
+    callback: () => void,
+    _initMetadata?: internal.InitMetadata,
+    _selector?: String,
+  ): void {
     callback();
   }
 

packages/shared/sdk-server-edge/src/utils/mockFeatureStore.ts

@@ -6,6 +6,7 @@ const mockFeatureStore: LDFeatureStore = {
   init: jest.fn(),
   initialized: jest.fn(),
   upsert: jest.fn(),
+  applyChanges: jest.fn(),
   get: jest.fn(),
   delete: jest.fn(),
 };

packages/shared/sdk-server/__tests__/data_sources/OneShotInitializerFDv2.test.ts

@@ -0,0 +1,78 @@
+import { DataSourceErrorKind, LDPollingError, subsystem } from '../../src';
+import OneShotInitializerFDv2 from '../../src/data_sources/OneShotInitializerFDv2';
+import PollingProcessorFDv2 from '../../src/data_sources/PollingProcessorFDv2';
+import Requestor from '../../src/data_sources/Requestor';
+import TestLogger, { LogLevel } from '../Logger';
+
+describe('given a one shot initializer', () => {
+  const requestor = {
+    requestAllData: jest.fn(),
+  };
+  const allEvents = {
+    events: [
+      {
+        event: 'server-intent',
+        data: { payloads: [{ code: 'xfer-full', id: 'mockId' }] },
+      },
+      {
+        event: 'put-object',
+        data: {
+          kind: 'flag',
+          key: 'flagA',
+          version: 123,
+          object: { objectFieldA: 'objectValueA' },
+        },
+      },
+      {
+        event: 'payload-transferred',
+        data: { state: 'mockState', version: 1 },
+      },
+    ],
+  };
+  const jsonData = JSON.stringify(allEvents);
+
+  let initializer: OneShotInitializerFDv2;
+  const mockDataCallback = jest.fn();
+  const mockStatusCallback = jest.fn();
+  let testLogger: TestLogger;
+
+  beforeEach(() => {
+    testLogger = new TestLogger();
+    initializer = new OneShotInitializerFDv2(requestor as unknown as Requestor, testLogger);
+  });
+
+  afterEach(() => {
+    initializer.stop();
+    jest.restoreAllMocks();
+  });
+
+  it('makes no requests before being started', () => {
+    expect(requestor.requestAllData).not.toHaveBeenCalled();
+  });
+
+  it('polls immediately on start', () => {
+    initializer.start(mockDataCallback, mockStatusCallback);
+    expect(requestor.requestAllData).toHaveBeenCalledTimes(1);
+    expect(mockDataCallback).not.toHaveBeenCalled();
+    expect(mockStatusCallback).toHaveBeenNthCalledWith(1, subsystem.DataSourceState.Initializing);
+  });
+
+  it('calls callback on success', () => {
+    requestor.requestAllData = jest.fn((cb) => cb(undefined, jsonData));
+    initializer.start(mockDataCallback, mockStatusCallback);
+    expect(mockDataCallback).toHaveBeenNthCalledWith(1, true, {
+      basis: true,
+      id: `mockId`,
+      state: `mockState`,
+      updates: [
+        {
+          kind: `flag`,
+          key: `flagA`,
+          version: 123,
+          object: { objectFieldA: 'objectValueA' },
+        },
+      ],
+      version: 1,
+    });
+  });
+});

packages/shared/sdk-server/__tests__/data_sources/PollingProcessor.test.ts

@@ -1,13 +1,9 @@
-import { ClientContext } from '@launchdarkly/js-sdk-common';
-
 import { LDFeatureStore } from '../../src';
 import PollingProcessor from '../../src/data_sources/PollingProcessor';
 import Requestor from '../../src/data_sources/Requestor';
-import Configuration from '../../src/options/Configuration';
 import AsyncStoreFacade from '../../src/store/AsyncStoreFacade';
 import InMemoryFeatureStore from '../../src/store/InMemoryFeatureStore';
 import VersionedDataKinds from '../../src/store/VersionedDataKinds';
-import { createBasicPlatform } from '../createBasicPlatform';
 import TestLogger, { LogLevel } from '../Logger';
 
 describe('given an event processor', () => {
@@ -23,24 +19,19 @@ describe('given an event processor', () => {
 
   let store: LDFeatureStore;
   let storeFacade: AsyncStoreFacade;
-  let config: Configuration;
   let processor: PollingProcessor;
   let initSuccessHandler: jest.Mock;
 
   beforeEach(() => {
     store = new InMemoryFeatureStore();
     storeFacade = new AsyncStoreFacade(store);
-    config = new Configuration({
-      featureStore: store,
-      pollInterval: longInterval,
-      logger: new TestLogger(),
-    });
     initSuccessHandler = jest.fn();
 
     processor = new PollingProcessor(
-      config,
       requestor as unknown as Requestor,
-      config.featureStoreFactory(new ClientContext('', config, createBasicPlatform())),
+      longInterval,
+      store,
+      new TestLogger(),
       initSuccessHandler,
     );
   });
@@ -99,27 +90,22 @@ describe('given a polling processor with a short poll duration', () => {
   const jsonData = JSON.stringify(allData);
 
   let store: LDFeatureStore;
-  let config: Configuration;
+  let testLogger: TestLogger;
   let processor: PollingProcessor;
   let initSuccessHandler: jest.Mock;
   let errorHandler: jest.Mock;
 
   beforeEach(() => {
     store = new InMemoryFeatureStore();
-    config = new Configuration({
-      featureStore: store,
-      pollInterval: shortInterval,
-      logger: new TestLogger(),
-    });
+    testLogger = new TestLogger();
     initSuccessHandler = jest.fn();
     errorHandler = jest.fn();
 
-    // Configuration will not let us set this as low as needed for the test.
-    Object.defineProperty(config, 'pollInterval', { value: 0.1 });
     processor = new PollingProcessor(
-      config,
       requestor as unknown as Requestor,
-      config.featureStoreFactory(new ClientContext('', config, createBasicPlatform())),
+      shortInterval,
+      store,
+      testLogger,
       initSuccessHandler,
       errorHandler,
     );
@@ -158,7 +144,6 @@ describe('given a polling processor with a short poll duration', () => {
       expect(errorHandler).not.toBeCalled();
       setTimeout(() => {
         expect(requestor.requestAllData.mock.calls.length).toBeGreaterThanOrEqual(2);
-        const testLogger = config.logger as TestLogger;
         expect(testLogger.getCount(LogLevel.Error)).toBe(0);
         expect(testLogger.getCount(LogLevel.Warn)).toBeGreaterThan(2);
         (done as jest.DoneCallback)();
@@ -176,7 +161,6 @@ describe('given a polling processor with a short poll duration', () => {
 
     setTimeout(() => {
       expect(requestor.requestAllData.mock.calls.length).toBeGreaterThanOrEqual(2);
-      const testLogger = config.logger as TestLogger;
       expect(testLogger.getCount(LogLevel.Error)).toBeGreaterThan(2);
       (done as jest.DoneCallback)();
     }, 300);
@@ -199,7 +183,6 @@ describe('given a polling processor with a short poll duration', () => {
 
       setTimeout(() => {
         expect(requestor.requestAllData.mock.calls.length).toBe(1);
-        const testLogger = config.logger as TestLogger;
         expect(testLogger.getCount(LogLevel.Error)).toBe(1);
         (done as jest.DoneCallback)();
       }, 300);