wip

Author: typotter

src/client-options-converter.spec.ts

@@ -6,7 +6,7 @@ import {
 } from '@eppo/js-client-sdk-common';
 import * as td from 'testdouble';
 
-import { clientOptionsToParameters } from './client-options-converter';
+import { clientOptionsToEppoClientParameters } from './client-options-converter';
 import { IClientOptions } from './i-client-config';
 import { sdkName, sdkVersion } from './sdk-data';
 
@@ -20,7 +20,7 @@ describe('clientOptionsToParameters', () => {
       assignmentLogger: { logAssignment: jest.fn() },
     };
 
-    const result = clientOptionsToParameters(options, mockStore);
+    const result = clientOptionsToEppoClientParameters(options, mockStore);
 
     expect(result.isObfuscated).toBe(true);
     expect(result.flagConfigurationStore).toBeDefined();
@@ -46,7 +46,7 @@ describe('clientOptionsToParameters', () => {
       assignmentLogger: { logAssignment: jest.fn() },
     };
 
-    const result = clientOptionsToParameters(options, mockStore);
+    const result = clientOptionsToEppoClientParameters(options, mockStore);
 
     expect(result.flagConfigurationStore).toBe(mockStore);
   });
@@ -58,7 +58,7 @@ describe('clientOptionsToParameters', () => {
     };
     const mockDispatcher: EventDispatcher = td.object<EventDispatcher>();
 
-    const result = clientOptionsToParameters(options, mockStore, mockDispatcher);
+    const result = clientOptionsToEppoClientParameters(options, mockStore, mockDispatcher);
 
     expect(result.eventDispatcher).toBeDefined();
   });
@@ -73,7 +73,7 @@ describe('clientOptionsToParameters', () => {
       skipInitialRequest: true,
     };
 
-    const result = clientOptionsToParameters(options, mockStore);
+    const result = clientOptionsToEppoClientParameters(options, mockStore);
 
     expect(result.configurationRequestParameters).toMatchObject({
       pollingIntervalMs: 30000,
@@ -92,7 +92,7 @@ describe('clientOptionsToParameters', () => {
       numPollRequestRetries: 2,
     };
 
-    const result = clientOptionsToParameters(options, mockStore);
+    const result = clientOptionsToEppoClientParameters(options, mockStore);
 
     expect(result.configurationRequestParameters).toMatchObject({
       requestTimeoutMs: 5000,
@@ -107,7 +107,7 @@ describe('clientOptionsToParameters', () => {
       assignmentLogger: { logAssignment: jest.fn() },
     };
 
-    const result = clientOptionsToParameters(options, mockStore);
+    const result = clientOptionsToEppoClientParameters(options, mockStore);
 
     expect(result.configurationRequestParameters).toMatchObject({
       baseUrl: undefined,
@@ -124,7 +124,7 @@ describe('clientOptionsToParameters', () => {
       assignmentLogger: { logAssignment: jest.fn() },
     };
 
-    const result = clientOptionsToParameters(options, mockStore);
+    const result = clientOptionsToEppoClientParameters(options, mockStore);
 
     expect(result.configurationRequestParameters).toMatchObject({
       sdkName,

src/client-options-converter.ts

@@ -1,11 +1,8 @@
 import {
-  BanditParameters,
-  BanditVariation, EppoClientParameters,
+  EppoClientParameters,
   EventDispatcher,
   Flag,
-  FlagConfigurationRequestParameters,
   IConfigurationStore,
-  ObfuscatedFlag,
 } from '@eppo/js-client-sdk-common';
 
 import { IClientOptions } from './i-client-config';
@@ -15,7 +12,7 @@ import { sdkName, sdkVersion } from './sdk-data';
  * Converts IClientOptions to EppoClientParameters
  * @internal
  */
-export function clientOptionsToParameters(
+export function clientOptionsToEppoClientParameters(
   options: IClientOptions,
   flagConfigurationStore: IConfigurationStore<Flag>,
   eventDispatcher?: EventDispatcher,

src/i-client-config.ts

@@ -258,7 +258,7 @@ export type IClientOptions = IApiOptions &
  * @public
  */
 export type IClientConfig = Omit<IClientOptions, 'sdkKey' | 'offline'> &
-  Pick<IBaseRequestConfig, 'apiKey'>;
+  Pick<IBaseRequestConfig, 'apiKey'>; // Could also just use `& IBaseRequestConfig` here instead of picking just `apiKey`.
 
 export function convertClientOptionsToClientConfig(options: IClientOptions): IClientConfig {
   return {

src/index.ts

@@ -21,12 +21,14 @@ import {
   IConfigurationWire,
   Subject,
   IBanditLogger,
-  IObfuscatedPrecomputedConfigurationResponse, buildStorageKeySuffix, EppoClientParameters,
+  IObfuscatedPrecomputedConfigurationResponse,
+  buildStorageKeySuffix,
+  EppoClientParameters,
 } from '@eppo/js-client-sdk-common';
 
 import { assignmentCacheFactory } from './cache/assignment-cache-factory';
 import HybridAssignmentCache from './cache/hybrid-assignment-cache';
-import { clientOptionsToParameters } from './client-options-converter';
+import { clientOptionsToEppoClientParameters } from './client-options-converter';
 import {
   ConfigLoaderStatus,
   ConfigLoadResult,
@@ -105,7 +107,17 @@ const memoryOnlyPrecomputedBanditsStore = precomputedBanditStoreFactory();
  * @public
  */
 export class EppoJSClient extends EppoClient {
+  /**
+   * Resolved when the client is initialized
+   * @private
+   */
   private readonly readyPromise: Promise<void>;
+
+  /**
+   * Used when the client is initialized from outside the constructor, namely, from the `init` or
+   * `EppoJSClient.initializeClient` methods.
+   * @private
+   */
   private readyPromiseResolver: (() => void) | null = null;
 
   public static instance = new EppoJSClient({
@@ -119,7 +131,7 @@ export class EppoJSClient extends EppoClient {
 
     super(
       v2Constructor
-        ? clientOptionsToParameters(
+        ? clientOptionsToEppoClientParameters(
             optionsOrConfig, // The IClientOptions wrapper
             optionsOrConfig.flagConfigurationStore ?? // create a new, memory only FCS if none was provided
               configurationStorageFactory({