support configs fetcher

Author: EmilianoSanchez

.eslintrc

@@ -1,4 +1,5 @@
 {
+  "root": true,
   "extends": [
     "eslint:recommended"
   ],

src/sdkClient/sdkLifecycle.ts

@@ -1,4 +1,3 @@
-import SplitIO from '../../types/splitio';
 import { releaseApiKey, validateAndTrackApiKey } from '../utils/inputValidation/apiKey';
 import { ISdkFactoryContext } from '../sdkFactory/types';
 
@@ -7,7 +6,7 @@ const COOLDOWN_TIME_IN_MILLIS = 1000;
 /**
  * Creates an Sdk client, i.e., a base client with status, init, flush and destroy interface
  */
-export function sdkLifecycleFactory(params: ISdkFactoryContext, isSharedClient?: boolean): Pick<SplitIO.ConfigsClient, 'init' | 'flush' | 'destroy'> {
+export function sdkLifecycleFactory(params: ISdkFactoryContext, isSharedClient?: boolean): { init(): void; flush(): Promise<void>; destroy(): Promise<void> } {
   const { sdkReadinessManager, syncManager, storage, signalListener, settings, telemetryTracker, impressionsTracker } = params;
 
   let hasInit = false;

src/sync/polling/pollingManagerSS.ts

@@ -9,13 +9,14 @@ import { ISdkFactoryContextSync } from '../../sdkFactory/types';
  */
 export function pollingManagerSSFactory(
   params: ISdkFactoryContextSync,
-  // @TODO
 ): IPollingManager {
 
   const { splitApi, storage, readiness, settings } = params;
   const log = settings.log;
 
-  const splitsSyncTask: ISplitsSyncTask = splitsSyncTaskFactory(splitApi.fetchSplitChanges, storage, readiness, settings);
+  const fetchingConfigs = settings.definitionsType === 'configs';
+
+  const splitsSyncTask: ISplitsSyncTask = splitsSyncTaskFactory(fetchingConfigs ? splitApi.fetchConfigs : splitApi.fetchSplitChanges, storage, readiness, settings);
   const segmentsSyncTask: ISegmentsSyncTask = segmentsSyncTaskFactory(splitApi.fetchSegmentChanges, storage, readiness, settings);
 
   return {
@@ -25,7 +26,7 @@ export function pollingManagerSSFactory(
     // Start periodic fetching (polling)
     start() {
       log.info(POLLING_START);
-      log.debug(LOG_PREFIX_SYNC_POLLING + `Definitions will be refreshed each ${settings.scheduler.featuresRefreshRate} millis`);
+      log.debug(LOG_PREFIX_SYNC_POLLING + `${fetchingConfigs ? 'configs' : 'feature flags'} will be refreshed each ${fetchingConfigs ? settings.scheduler.configsRefreshRate : settings.scheduler.featuresRefreshRate} millis`);
       log.debug(LOG_PREFIX_SYNC_POLLING + `Segments will be refreshed each ${settings.scheduler.segmentsRefreshRate} millis`);
 
       const startingUp = splitsSyncTask.start();

src/sync/polling/syncTasks/splitsSyncTask.ts

@@ -29,7 +29,7 @@ export function splitsSyncTaskFactory(
       settings.startup.retriesOnFailureBeforeReady,
       isClientSide
     ),
-    settings.scheduler.featuresRefreshRate,
-    'splitChangesUpdater',
+    settings.definitionsType === 'configs' ? settings.scheduler.configsRefreshRate : settings.scheduler.featuresRefreshRate,
+    settings.definitionsType === 'configs' ? 'configsUpdater' : 'splitChangesUpdater',
   );
 }

src/sync/submitters/__tests__/telemetrySubmitter.spec.ts

@@ -77,7 +77,7 @@ describe('Telemetry submitter', () => {
     expect(recordTimeUntilReadySpy).toBeCalledTimes(1);
 
     expect(postMetricsConfig).toBeCalledWith(JSON.stringify({
-      oM: 0, st: 'memory', aF: 0, rF: 0, sE: true, rR: { sp: 0.001, se: 0.001, im: 0.001, ev: 0.001, te: 0.1 }, uO: { s: true, e: true, a: true, st: true, t: true }, iQ: 1, eQ: 1, iM: 0, iL: false, hP: false, tR: 0, tC: 0, nR: 0, t: [], i: ['NoopIntegration'], uC: 0, fsT: 0, fsI: 0
+      oM: 0, st: 'memory', aF: 0, rF: 0, sE: true, rR: { sp: 0.001, cf: 0.001, se: 0.001, im: 0.001, ev: 0.001, te: 0.1 }, uO: { s: true, e: true, a: true, st: true, t: true }, iQ: 1, eQ: 1, iM: 0, iL: false, hP: false, tR: 0, tC: 0, nR: 0, t: [], i: ['NoopIntegration'], uC: 0, fsT: 0, fsI: 0
     }));
 
     // Stop submitter, to not execute the 1st periodic metrics/usage POST

src/sync/submitters/telemetrySubmitter.ts

@@ -81,6 +81,7 @@ export function telemetryCacheConfigAdapter(telemetry: ITelemetryCacheSync, sett
         sE: settings.streamingEnabled,
         rR: {
           sp: scheduler.featuresRefreshRate / 1000,
+          cf: scheduler.configsRefreshRate / 1000,
           se: isServerSide ? scheduler.segmentsRefreshRate / 1000 : undefined,
           ms: isServerSide ? undefined : scheduler.segmentsRefreshRate / 1000,
           im: scheduler.impressionsRefreshRate / 1000,

src/types.ts

@@ -12,6 +12,7 @@ export interface ISettings extends SplitIO.ISettings {
   };
   readonly log: ILogger;
   readonly initialRolloutPlan?: RolloutPlan;
+  readonly definitionsType?: 'ff' | 'configs'; // default is 'ff'
 }
 
 /**

src/utils/settingsValidation/__tests__/settings.mocks.ts

@@ -38,6 +38,7 @@ export const fullSettings: ISettings = {
   },
   scheduler: {
     featuresRefreshRate: 1,
+    configsRefreshRate: 1,
     impressionsRefreshRate: 1,
     telemetryRefreshRate: 1,
     segmentsRefreshRate: 1,

src/utils/settingsValidation/index.ts

@@ -29,6 +29,8 @@ export const base = {
   scheduler: {
     // fetch feature updates each 60 sec
     featuresRefreshRate: 60,
+    // fetch configs updates each 60 sec
+    configsRefreshRate: 60,
     // fetch segments updates each 60 sec
     segmentsRefreshRate: 60,
     // publish telemetry stats each 3600 secs (1 hour)
@@ -129,6 +131,7 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   // Scheduler periods
   const { scheduler, startup } = withDefaults;
   scheduler.featuresRefreshRate = fromSecondsToMillis(scheduler.featuresRefreshRate);
+  scheduler.configsRefreshRate = fromSecondsToMillis(scheduler.configsRefreshRate);
   scheduler.segmentsRefreshRate = fromSecondsToMillis(scheduler.segmentsRefreshRate);
   scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
   scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);

types/splitio.d.ts

@@ -615,6 +615,7 @@ declare namespace SplitIO {
     readonly mode: SDKMode;
     readonly scheduler: {
       featuresRefreshRate: number;
+      configsRefreshRate: number;
       impressionsRefreshRate: number;
       impressionsQueueSize: number;
       /**
@@ -2310,6 +2311,65 @@ declare namespace SplitIO {
     getObject(index: number): Config;
   }
 
+  interface ConfigsOptions {
+    /**
+     * Your SDK key.
+     *
+     * @see {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/account-settings/api-keys/}
+     */
+    authorizationKey: string;
+    /**
+     * Configs definitions refresh rate for polling, in seconds.
+     *
+     * @defaultValue `60`
+     */
+    configsRefreshRate?: number;
+    /**
+     * Logging level.
+     *
+     * @defaultValue `'NONE'`
+     */
+    logLevel?: LogLevel;
+    /**
+     * Time in seconds until SDK ready timeout is emitted.
+     *
+     * @defaultValue `10`
+     */
+    timeout?: number;
+    /**
+     * Custom endpoints to replace the default ones used by the SDK.
+     */
+    urls?: UrlSettings;
+    // /**
+    //  * Defines what impressions are sent to Split servers.
+    //  * - DEBUG: all impressions are sent.
+    //  * - OPTIMIZED: will send unique impressions to Split servers, avoiding a considerable amount of traffic that duplicated impressions could generate.
+    //  * - NONE: will send unique keys evaluated per config to Split servers instead of full blown impressions.
+    //  *
+    //  * @defaultValue `'OPTIMIZED'`
+    //  */
+    // impressionsMode?: ImpressionsMode;
+    // /**
+    //  * The SDK posts the queued events data in bulks. This parameter controls the posting rate in seconds.
+    //  *
+    //  * @defaultValue `1800`
+    //  */
+    // eventsPushRate?: number;
+    // /**
+    //  * The SDK sends impressions back to Split servers. This parameter controls how often this data is sent, in seconds.
+    //  *
+    //  * @defaultValue `1800`
+    //  */
+    // impressionsRefreshRate?: number;
+    // /**
+    //  * Boolean flag to enable the streaming service as default synchronization mechanism. In the event of any issue with streaming,
+    //  * the SDK would fallback to the polling mechanism. If false, the SDK would poll for changes as usual without attempting to use streaming.
+    //  *
+    //  * @defaultValue `true`
+    //  */
+    // streamingEnabled?: boolean;
+  }
+
   /**
    * Configs SDK client interface.
    */
@@ -2322,10 +2382,6 @@ declare namespace SplitIO {
      * Logger API.
      */
     Logger: ILoggerAPI;
-    /**
-     * Initializes the client.
-     */
-    init(): void;
     /**
      * Flushes the client.
      */