update

Author: raju-opti

lib/project_config/config.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright 2022-2023, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const DEFAULT_UPDATE_INTERVAL_MINUTES = 5;
+/** Standard interval (5 minutes in milliseconds) for polling datafile updates.; */
+export const DEFAULT_UPDATE_INTERVAL = DEFAULT_UPDATE_INTERVAL_MINUTES * 60 * 1000;
+
+const MIN_UPDATE_INTERVAL_SECONDS = 30;
+/** Minimum allowed interval (30 seconds in milliseconds) for polling datafile updates. */
+export const MIN_UPDATE_INTERVAL = MIN_UPDATE_INTERVAL_SECONDS * 1000;
+
+export const UPDATE_INTERVAL_BELOW_MINIMUM_MESSAGE = `Polling intervals below ${MIN_UPDATE_INTERVAL_SECONDS} seconds are not recommended.`;
+
+export const DEFAULT_URL_TEMPLATE = `https://cdn.optimizely.com/datafiles/%s.json`;
+
+export const DEFAULT_AUTHENTICATED_URL_TEMPLATE = `https://config.optimizely.com/datafiles/auth/%s.json`;
+
+export const BACKOFF_BASE_WAIT_SECONDS_BY_ERROR_COUNT = [0, 8, 16, 32, 64, 128, 256, 512];
+
+export const REQUEST_TIMEOUT_MS = 60 * 1000; // 1 minute

lib/project_config/config_manager_factory.browser.ts

@@ -0,0 +1,15 @@
+import { Transformer } from "../utils/type";
+import { ProjectConfigManagerImpl, ProjectConfigManager } from "./project_config_manager";
+import { DatafileManagerConfig } from "./datafileManager";
+import { PollingConfigManagerConfig, PollingConfigManagerFactoryOptions } from "./config_manager_factory";
+import { createPollingConfigManager as createPollingConfigManagerInternal } from "./config_manager_factory";
+import { BrowserRequestHandler } from "../utils/http_request_handler/browser_request_handler";
+
+export const createPollingConfigManager = (config: PollingConfigManagerConfig): ProjectConfigManager => {
+  const options: PollingConfigManagerFactoryOptions = {
+    autoUpdate: false,
+    requestHandler: new BrowserRequestHandler(),
+    ...config,
+  }
+  return createPollingConfigManagerInternal(options);
+}

lib/project_config/config_manager_factory.node.ts

@@ -0,0 +1,3 @@
+import { HttpPollingDatafileManager } from "./httpPollingDatafileManager";
+import { ProjectConfigManagerImpl, ProjectConfigManager } from "./project_config_manager";
+

lib/project_config/config_manager_factory.react_native.ts

@@ -0,0 +1,50 @@
+import { RequestHandler } from "../utils/http_request_handler/http";
+import { Transformer } from "../utils/type";
+import { DatafileManagerConfig } from "./datafileManager";
+import { ProjectConfigManagerImpl, ProjectConfigManager } from "./project_config_manager";
+import { HttpPollingDatafileManager } from "./httpPollingDatafileManager";
+
+export const createStaticProjectConfigManager = (
+  datafile: string,
+  jsonSchemaValidator?: Transformer<unknown, boolean>
+): ProjectConfigManager => {
+  const config = {
+    datafile,
+    jsonSchemaValidator,
+  };
+  return new ProjectConfigManagerImpl(config);
+};
+
+export type PollingConfigManagerConfig = {
+  datafile?: string,
+  sdkKey: string,
+  jsonSchemaValidator?: Transformer<unknown, boolean>,
+  autoUpdate?: boolean;
+  updateInterval?: number;
+  urlTemplate?: string;
+  datafileAccessToken?: string;
+};
+
+export type PollingConfigManagerFactoryOptions = PollingConfigManagerConfig & { requestHandler: RequestHandler };
+
+export const createPollingConfigManager = (
+  opt: PollingConfigManagerFactoryOptions
+): ProjectConfigManager => {
+
+  const datafileManagerConfig: DatafileManagerConfig = {
+    sdkKey: opt.sdkKey,
+    autoUpdate: opt.autoUpdate,
+    updateInterval: opt.updateInterval,
+    urlTemplate: opt.urlTemplate,
+    datafileAccessToken: opt.datafileAccessToken,
+    requestHandler: opt.requestHandler,
+  };
+  
+  const datafileManager = new HttpPollingDatafileManager(datafileManagerConfig);
+
+  return new ProjectConfigManagerImpl({
+    datafile: opt.datafile,
+    datafileManager,
+    jsonSchemaValidator: opt.jsonSchemaValidator,
+  });
+};

lib/project_config/config_manager_factory.ts

@@ -13,10 +13,10 @@
  * 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 { RequestHandler } from '../../utils/http_request_handler/http';
-import { Fn, Consumer } from '../../utils/type';
+import { Service } from '../service';
+import PersistentKeyValueCache from '../plugins/key_value_cache/persistentKeyValueCache';
+import { RequestHandler } from '../utils/http_request_handler/http';
+import { Fn, Consumer } from '../utils/type';
 
 export interface DatafileUpdate {
   datafile: string;

lib/modules/datafile-manager/datafileManager.ts renamed to lib/project_config/datafileManager.ts

@@ -14,22 +14,18 @@
  * limitations under the License.
  */
 
-import { getLogger } from '../logging';
-import { sprintf } from '../../utils/fns';
-import { DatafileManager, DatafileManagerConfig, DatafileUpdate } from './datafileManager';
-import { EventEmitter } from '../../utils/event_emitter/eventEmitter';
+import { getLogger } from '../modules/logging';
+import { sprintf } from '../utils/fns';
+import { DatafileManager, DatafileManagerConfig } from './datafileManager';
+import { EventEmitter } from '../utils/event_emitter/eventEmitter';
 import { DEFAULT_UPDATE_INTERVAL, MIN_UPDATE_INTERVAL, DEFAULT_URL_TEMPLATE, UPDATE_INTERVAL_BELOW_MINIMUM_MESSAGE } from './config';
-import BackoffController from './backoffController';
-import PersistentKeyValueCache from '../../plugins/key_value_cache/persistentKeyValueCache';
-
-import { NotificationRegistry } from './../../core/notification_center/notification_registry';
-import { NOTIFICATION_TYPES } from '../../utils/enums';
-import { ServiceState } from '../../service';
-import { RequestHandler, AbortableRequest, Headers, Response } from '../../utils/http_request_handler/http';
-import { resolvablePromise, ResolvablePromise } from '../../utils/promise/resolvablePromise';
-import { Ticker, ExponentialBackoff, IntervalTicker } from '../../utils/ticker/ticker';
-import { promises } from 'dns';
-import { Consumer, Fn } from '../../utils/type';
+import PersistentKeyValueCache from '../plugins/key_value_cache/persistentKeyValueCache';
+
+import { ServiceState } from '../service';
+import { RequestHandler, AbortableRequest, Headers, Response } from '../utils/http_request_handler/http';
+import { resolvablePromise, ResolvablePromise } from '../utils/promise/resolvablePromise';
+import { Ticker, ExponentialBackoff, IntervalTicker } from '../utils/ticker/ticker';
+import { Consumer, Fn } from '../utils/type';
 
 const logger = getLogger('DatafileManager');
 

lib/modules/datafile-manager/httpPollingDatafileManager.ts renamed to lib/project_config/httpPollingDatafileManager.ts

@@ -22,12 +22,12 @@ import { REQUEST_TIMEOUT_MS } from '../enums';
  * Handles sending requests and receiving responses over HTTP via XMLHttpRequest
  */
 export class BrowserRequestHandler implements RequestHandler {
-  private readonly logger: LogHandler;
-  private readonly timeout: number;
+  private logger?: LogHandler;
+  private timeout: number;
 
-  public constructor(logger: LogHandler, timeout: number = REQUEST_TIMEOUT_MS) {
-    this.logger = logger;
-    this.timeout = timeout;
+  public constructor(opt: { logger?: LogHandler, timeout?: number } = {}) {
+    this.logger = opt.logger;
+    this.timeout = opt.timeout ?? REQUEST_TIMEOUT_MS;
   }
 
   /**
@@ -67,7 +67,7 @@ export class BrowserRequestHandler implements RequestHandler {
       request.timeout = this.timeout;
 
       request.ontimeout = (): void => {
-        this.logger.log(LogLevel.WARNING, 'Request timed out');
+        this.logger?.log(LogLevel.WARNING, 'Request timed out');
       };
 
       request.send(data);
@@ -122,7 +122,7 @@ export class BrowserRequestHandler implements RequestHandler {
           }
         }
       } catch {
-        this.logger.log(LogLevel.WARNING, `Unable to parse & skipped header item '${headerLine}'`);
+        this.logger?.log(LogLevel.WARNING, `Unable to parse & skipped header item '${headerLine}'`);
       }
     });
     return headers;