[FSSDK-10993] additional cleanup for project config manager (#977)

lib/project_config/config_manager_factory.browser.spec.ts

@@ -30,6 +30,7 @@ vi.mock('../utils/http_request_handler/browser_request_handler', () => {
 import { getPollingConfigManager, PollingConfigManagerConfig, PollingConfigManagerFactoryOptions } from './config_manager_factory';
 import { createPollingProjectConfigManager } from './config_manager_factory.browser';
 import { BrowserRequestHandler } from '../utils/http_request_handler/browser_request_handler';
+import { getMockSyncCache } from '../tests/mock/mock_cache';
 
 describe('createPollingConfigManager', () => {
   const mockGetPollingConfigManager = vi.mocked(getPollingConfigManager);
@@ -76,7 +77,7 @@ describe('createPollingConfigManager', () => {
       autoUpdate: true,
       urlTemplate: 'urlTemplate',
       datafileAccessToken: 'datafileAccessToken',
-      cache: { get: vi.fn(), set: vi.fn(), contains: vi.fn(), remove: vi.fn() },
+      cache: getMockSyncCache<string>(),
     };
 
     const projectConfigManager = createPollingProjectConfigManager(config);

lib/project_config/config_manager_factory.node.spec.ts

@@ -30,7 +30,7 @@ vi.mock('../utils/http_request_handler/node_request_handler', () => {
 import { getPollingConfigManager, PollingConfigManagerConfig } from './config_manager_factory';
 import { createPollingProjectConfigManager } from './config_manager_factory.node';
 import { NodeRequestHandler } from '../utils/http_request_handler/node_request_handler';
-import { DEFAULT_AUTHENTICATED_URL_TEMPLATE, DEFAULT_URL_TEMPLATE } from './constant';
+import { getMockSyncCache } from '../tests/mock/mock_cache';
 
 describe('createPollingConfigManager', () => {
   const mockGetPollingConfigManager = vi.mocked(getPollingConfigManager);
@@ -77,7 +77,7 @@ describe('createPollingConfigManager', () => {
       autoUpdate: false,
       urlTemplate: 'urlTemplate',
       datafileAccessToken: 'datafileAccessToken',
-      cache: { get: vi.fn(), set: vi.fn(), contains: vi.fn(), remove: vi.fn() },
+      cache: getMockSyncCache(),
     };
 
     const projectConfigManager = createPollingProjectConfigManager(config);

lib/project_config/config_manager_factory.react_native.spec.ts

@@ -29,7 +29,7 @@ async function mockRequireAsyncStorage() {
   M._load_original = M._load;
   M._load = (uri: string, parent: string) => {
     if (uri === '@react-native-async-storage/async-storage') {
-      if (isAsyncStorageAvailable) return {};
+      if (isAsyncStorageAvailable) return { default: {} };
       throw new Error('Module not found: @react-native-async-storage/async-storage');
     }
     return M._load_original(uri, parent);
@@ -47,25 +47,30 @@ vi.mock('../utils/http_request_handler/browser_request_handler', () => {
   return { BrowserRequestHandler };
 });
 
-vi.mock('../plugins/key_value_cache/reactNativeAsyncStorageCache', () => {
-  const ReactNativeAsyncStorageCache = vi.fn();
-  return { default: ReactNativeAsyncStorageCache };
+vi.mock('../utils/cache/async_storage_cache.react_native', async (importOriginal) => {
+  const original: any = await importOriginal();
+  const OriginalAsyncStorageCache = original.AsyncStorageCache;
+  const MockAsyncStorageCache = vi.fn().mockImplementation(function (this: any, ...args) {
+    Object.setPrototypeOf(this, new OriginalAsyncStorageCache(...args));
+  });
+  return { AsyncStorageCache: MockAsyncStorageCache };
 });
 
 import { getPollingConfigManager, PollingConfigManagerConfig } from './config_manager_factory';
 import { createPollingProjectConfigManager } from './config_manager_factory.react_native';
 import { BrowserRequestHandler } from '../utils/http_request_handler/browser_request_handler';
-import ReactNativeAsyncStorageCache from '../plugins/key_value_cache/reactNativeAsyncStorageCache';
+import { AsyncStorageCache } from '../utils/cache/async_storage_cache.react_native';
+import { getMockSyncCache } from '../tests/mock/mock_cache';
 
 describe('createPollingConfigManager', () => {
   const mockGetPollingConfigManager = vi.mocked(getPollingConfigManager);
   const MockBrowserRequestHandler = vi.mocked(BrowserRequestHandler);
-  const MockReactNativeAsyncStorageCache = vi.mocked(ReactNativeAsyncStorageCache);
+  const MockAsyncStorageCache = vi.mocked(AsyncStorageCache);
 
   beforeEach(() => {
     mockGetPollingConfigManager.mockClear();
     MockBrowserRequestHandler.mockClear();
-    MockReactNativeAsyncStorageCache.mockClear();
+    MockAsyncStorageCache.mockClear();
   });
 
   it('creates and returns the instance by calling getPollingConfigManager', () => {
@@ -110,7 +115,7 @@ describe('createPollingConfigManager', () => {
     createPollingProjectConfigManager(config);
 
     expect(
-      Object.is(mockGetPollingConfigManager.mock.calls[0][0].cache, MockReactNativeAsyncStorageCache.mock.instances[0])
+      Object.is(mockGetPollingConfigManager.mock.calls[0][0].cache, MockAsyncStorageCache.mock.instances[0])
     ).toBe(true);
   });
 
@@ -123,7 +128,7 @@ describe('createPollingConfigManager', () => {
       autoUpdate: false,
       urlTemplate: 'urlTemplate',
       datafileAccessToken: 'datafileAccessToken',
-      cache: { get: vi.fn(), set: vi.fn(), contains: vi.fn(), remove: vi.fn() },
+      cache: getMockSyncCache(),
     };
 
     createPollingProjectConfigManager(config);
@@ -133,38 +138,24 @@ describe('createPollingConfigManager', () => {
 
   it('Should not throw error if a cache is present in the config, and async storage is not available', async () => {
     isAsyncStorageAvailable = false;
-    const { default: ReactNativeAsyncStorageCache } = await vi.importActual<
-      typeof import('../plugins/key_value_cache/reactNativeAsyncStorageCache')
-    >('../plugins/key_value_cache/reactNativeAsyncStorageCache');
     const config = {
       sdkKey: 'sdkKey',
       requestHandler: { makeRequest: vi.fn() },
-      cache: { get: vi.fn(), set: vi.fn(), contains: vi.fn(), remove: vi.fn() },
+      cache: getMockSyncCache<string>(),
     };
 
-    MockReactNativeAsyncStorageCache.mockImplementationOnce(() => {
-      return new ReactNativeAsyncStorageCache();
-    });
-
     expect(() => createPollingProjectConfigManager(config)).not.toThrow();
     isAsyncStorageAvailable = true;
   });
 
   it('should throw an error if cache is not present in the config, and async storage is not available', async () => {
     isAsyncStorageAvailable = false;
 
-    const { default: ReactNativeAsyncStorageCache } = await vi.importActual<
-      typeof import('../plugins/key_value_cache/reactNativeAsyncStorageCache')
-    >('../plugins/key_value_cache/reactNativeAsyncStorageCache');
     const config = {
       sdkKey: 'sdkKey',
       requestHandler: { makeRequest: vi.fn() },
     };
 
-    MockReactNativeAsyncStorageCache.mockImplementationOnce(() => {
-      return new ReactNativeAsyncStorageCache();
-    });
-
     expect(() => createPollingProjectConfigManager(config)).toThrowError(
       'Module not found: @react-native-async-storage/async-storage'
     );

lib/project_config/config_manager_factory.react_native.ts

@@ -17,13 +17,13 @@
 import { getPollingConfigManager, PollingConfigManagerConfig } from "./config_manager_factory";
 import { BrowserRequestHandler } from "../utils/http_request_handler/browser_request_handler";
 import { ProjectConfigManager } from "./project_config_manager";
-import ReactNativeAsyncStorageCache from "../plugins/key_value_cache/reactNativeAsyncStorageCache";
+import { AsyncStorageCache } from "../utils/cache/async_storage_cache.react_native";
 
 export const createPollingProjectConfigManager = (config: PollingConfigManagerConfig): ProjectConfigManager => {
   const defaultConfig = {
     autoUpdate: true,
     requestHandler: new BrowserRequestHandler(),
-    cache: config.cache || new ReactNativeAsyncStorageCache()
+    cache: config.cache || new AsyncStorageCache(),
   };
 
   return getPollingConfigManager({ ...defaultConfig, ...config });

lib/project_config/config_manager_factory.spec.ts

@@ -36,7 +36,9 @@ import { ProjectConfigManagerImpl } from './project_config_manager';
 import { PollingDatafileManager } from './polling_datafile_manager';
 import { ExponentialBackoff, IntervalRepeater } from '../utils/repeater/repeater';
 import { getPollingConfigManager } from './config_manager_factory';
-import { DEFAULT_UPDATE_INTERVAL } from './constant';
+import { DEFAULT_UPDATE_INTERVAL, UPDATE_INTERVAL_BELOW_MINIMUM_MESSAGE } from './constant';
+import { getMockSyncCache } from '../tests/mock/mock_cache';
+import { LogLevel } from '../modules/logging';
 
 describe('getPollingConfigManager', () => {
   const MockProjectConfigManagerImpl = vi.mocked(ProjectConfigManagerImpl);
@@ -73,7 +75,32 @@ describe('getPollingConfigManager', () => {
     };
     getPollingConfigManager(config);
     expect(MockIntervalRepeater.mock.calls[0][0]).toBe(DEFAULT_UPDATE_INTERVAL);
-    expect(MockPollingDatafileManager.mock.calls[0][0].updateInterval).toBe(DEFAULT_UPDATE_INTERVAL);
+  });
+
+  it('adds a startup log if the update interval is below the minimum', () => {
+    const config = {
+      sdkKey: 'abcd',
+      requestHandler: { makeRequest: vi.fn() },
+      updateInterval: 10000,
+    };
+    getPollingConfigManager(config);
+    const startupLogs = MockPollingDatafileManager.mock.calls[0][0].startupLogs;
+    expect(startupLogs).toEqual(expect.arrayContaining([{
+      level: LogLevel.WARNING,
+      message: UPDATE_INTERVAL_BELOW_MINIMUM_MESSAGE,
+      params: [],
+    }]));
+  });
+
+  it('does not add any startup log if the update interval above the minimum', () => {
+    const config = {
+      sdkKey: 'abcd',
+      requestHandler: { makeRequest: vi.fn() },
+      updateInterval: 40000,
+    };
+    getPollingConfigManager(config);
+    const startupLogs = MockPollingDatafileManager.mock.calls[0][0].startupLogs;
+    expect(startupLogs).toEqual([]);
   });
 
   it('uses the provided options', () => {
@@ -86,7 +113,7 @@ describe('getPollingConfigManager', () => {
       autoUpdate: true,
       urlTemplate: 'urlTemplate',
       datafileAccessToken: 'datafileAccessToken',
-      cache: { get: vi.fn(), set: vi.fn(), contains: vi.fn(), remove: vi.fn() },
+      cache: getMockSyncCache<string>(),
     };
 
     getPollingConfigManager(config);
@@ -96,7 +123,6 @@ describe('getPollingConfigManager', () => {
     expect(MockPollingDatafileManager).toHaveBeenNthCalledWith(1, expect.objectContaining({
       sdkKey: config.sdkKey,
       autoUpdate: config.autoUpdate,
-      updateInterval: config.updateInterval,
       urlTemplate: config.urlTemplate,
       datafileAccessToken: config.datafileAccessToken,
       requestHandler: config.requestHandler,

lib/project_config/config_manager_factory.ts

@@ -19,9 +19,12 @@ import { Transformer } from "../utils/type";
 import { DatafileManagerConfig } from "./datafile_manager";
 import { ProjectConfigManagerImpl, ProjectConfigManager } from "./project_config_manager";
 import { PollingDatafileManager } from "./polling_datafile_manager";
-import PersistentKeyValueCache from "../plugins/key_value_cache/persistentKeyValueCache";
+import { Cache } from "../utils/cache/cache";
 import { DEFAULT_UPDATE_INTERVAL } from './constant';
 import { ExponentialBackoff, IntervalRepeater } from "../utils/repeater/repeater";
+import { StartupLog } from "../service";
+import { MIN_UPDATE_INTERVAL, UPDATE_INTERVAL_BELOW_MINIMUM_MESSAGE } from './constant';
+import { LogLevel } from "../modules/logging";
 
 export type StaticConfigManagerConfig = {
   datafile: string,
@@ -42,7 +45,7 @@ export type PollingConfigManagerConfig = {
   updateInterval?: number;
   urlTemplate?: string;
   datafileAccessToken?: string;
-  cache?: PersistentKeyValueCache;
+  cache?: Cache<string>;
 };
 
 export type PollingConfigManagerFactoryOptions = PollingConfigManagerConfig & { requestHandler: RequestHandler };
@@ -55,15 +58,25 @@ export const getPollingConfigManager = (
   const backoff = new ExponentialBackoff(1000, updateInterval, 500);
   const repeater = new IntervalRepeater(updateInterval, backoff);
 
+  const startupLogs: StartupLog[] = []
+
+  if (updateInterval < MIN_UPDATE_INTERVAL) {
+    startupLogs.push({
+      level: LogLevel.WARNING,
+      message: UPDATE_INTERVAL_BELOW_MINIMUM_MESSAGE,
+      params: [],
+    });
+  }
+
   const datafileManagerConfig: DatafileManagerConfig = {
     sdkKey: opt.sdkKey,
     autoUpdate: opt.autoUpdate,
-    updateInterval: updateInterval,
     urlTemplate: opt.urlTemplate,
     datafileAccessToken: opt.datafileAccessToken,
     requestHandler: opt.requestHandler,
     cache: opt.cache,
     repeater,
+    startupLogs,
   };
 
   const datafileManager = new PollingDatafileManager(datafileManagerConfig);

lib/project_config/datafile_manager.ts

@@ -13,8 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Service } from '../service';
-import PersistentKeyValueCache from '../plugins/key_value_cache/persistentKeyValueCache';
+import { Service, StartupLog } from '../service';
+import { Cache } from '../utils/cache/cache';
 import { RequestHandler } from '../utils/http_request_handler/http';
 import { Fn, Consumer } from '../utils/type';
 import { Repeater } from '../utils/repeater/repeater';
@@ -30,12 +30,11 @@ export type DatafileManagerConfig = {
   requestHandler: RequestHandler;
   autoUpdate?: boolean;
   sdkKey: string;
-  /** Polling interval in milliseconds to check for datafile updates. */
-  updateInterval?: number;
   urlTemplate?: string;
-  cache?: PersistentKeyValueCache;
+  cache?: Cache<string>;
   datafileAccessToken?: string;
   initRetry?: number;
   repeater: Repeater;
   logger?: LoggerFacade;
+  startupLogs?: StartupLog[];
 }

lib/core/optimizely_config/index.tests.js → lib/project_config/optimizely_config.tests.js

@@ -17,15 +17,15 @@ import { assert } from 'chai';
 import { cloneDeep } from 'lodash';
 import sinon from 'sinon';
 
-import { createOptimizelyConfig, OptimizelyConfig } from './';
-import { createProjectConfig } from '../../project_config/project_config';
+import { createOptimizelyConfig, OptimizelyConfig } from './optimizely_config';
+import { createProjectConfig } from './project_config';
 import {
   getTestProjectConfigWithFeatures,
   getTypedAudiencesConfig,
   getSimilarRuleKeyConfig,
   getSimilarExperimentKeyConfig,
   getDuplicateExperimentKeyConfig,
-} from '../../tests/test_data';
+} from '../tests/test_data';
 
 var datafile = getTestProjectConfigWithFeatures();
 var typedAudienceDatafile = getTypedAudiencesConfig();

lib/core/optimizely_config/index.ts → lib/project_config/optimizely_config.ts

@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { LoggerFacade, getLogger } from '../../modules/logging';
-import { ProjectConfig } from '../../project_config/project_config';
-import { DEFAULT_OPERATOR_TYPES } from '../condition_tree_evaluator';
+import { LoggerFacade, getLogger } from '../modules/logging';
+import { ProjectConfig } from '../project_config/project_config';
+import { DEFAULT_OPERATOR_TYPES } from '../core/condition_tree_evaluator';
 import {
   Audience,
   Experiment,
@@ -32,7 +32,7 @@ import {
   Rollout,
   Variation,
   VariationVariable,
-} from '../../shared_types';
+} from '../shared_types';
 
 interface FeatureVariablesMap {
   [key: string]: FeatureVariable[];