Remove feature flag name from SDK not ready warning message and simplify validation function signatures

Author: EmilianoSanchez

src/logger/messages/warn.ts

@@ -14,7 +14,7 @@ export const codesWarn: [number, string][] = codesError.concat([
   [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Dropping %s after retry. Reason: %s.'],
   [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s.'],
   // client status
-  [c.CLIENT_NOT_READY_FROM_CACHE, '%s: the SDK is not ready to evaluate. Results may be incorrect%s. Make sure to wait for SDK readiness before using this method.'],
+  [c.CLIENT_NOT_READY_FROM_CACHE, '%s: the SDK is not ready to evaluate. Results may be incorrect. Make sure to wait for SDK readiness before using this method.'],
   [c.CLIENT_NO_LISTENER, 'No listeners for SDK_READY event detected. Incorrect control treatments could have been logged if you called getTreatment/s while the SDK was not yet synchronized with the backend.'],
   // input validation
   [c.WARN_SETTING_NULL, '%s: Property "%s" is of invalid type. Setting value to null.'],

src/sdkClient/clientInputValidation.ts

@@ -46,7 +46,7 @@ export function clientInputValidationDecorator<TClient extends SplitIO.IClient |
     const isNotDestroyed = validateIfNotDestroyed(log, readinessManager, methodName);
     const options = validateEvaluationOptions(log, maybeOptions, methodName);
 
-    validateIfReadyFromCache(log, readinessManager, methodName, nameOrNames);
+    validateIfReadyFromCache(log, readinessManager, methodName);
 
     const valid = isNotDestroyed && key && nameOrNames && attributes !== false;
 

src/sdkConfig/index-ff-wrapper.ts

@@ -41,7 +41,7 @@ export function configsClientFactory(params: ISdkFactoryParams): SplitIO.Configs
         if (target) {
           // Serve config with target
           if (validateTarget(log, target, GET_CONFIG)) {
-            const result = ffClient.getTreatmentWithConfig(target.key, name, target.attributes, target) as SplitIO.TreatmentWithConfig;
+            const result = ffClient.getTreatmentWithConfig(target.key, name, target.attributes) as SplitIO.TreatmentWithConfig;
             return parseConfig(result.config);
           } else {
             log.error('Invalid target for getConfig.');

src/utils/inputValidation/__tests__/isOperational.spec.ts

@@ -46,7 +46,7 @@ describe('validateIfReadyFromCache', () => {
     // @ts-ignore
     expect(validateIfReadyFromCache(loggerMock, readinessManagerMock, 'test_method')).toBe(false); // It should return true if SDK was ready.
     expect(readinessManagerMock.isReadyFromCache).toBeCalledTimes(1); // It checks for SDK_READY_FROM_CACHE status.
-    expect(loggerMock.warn).toBeCalledWith(CLIENT_NOT_READY_FROM_CACHE, ['test_method', '']); // It should log the expected warning.
+    expect(loggerMock.warn).toBeCalledWith(CLIENT_NOT_READY_FROM_CACHE, ['test_method']); // It should log the expected warning.
     expect(loggerMock.error).not.toBeCalled(); // But it should not log any errors.
   });
 });

src/utils/inputValidation/isOperational.ts

@@ -9,14 +9,14 @@ export function validateIfNotDestroyed(log: ILogger, readinessManager: IReadines
   return false;
 }
 
-export function validateIfReadyFromCache(log: ILogger, readinessManager: IReadinessManager, method: string, featureFlagNameOrNames?: string | string[] | false) {
+export function validateIfReadyFromCache(log: ILogger, readinessManager: IReadinessManager, method: string) {
   if (readinessManager.isReadyFromCache()) return true;
 
-  log.warn(CLIENT_NOT_READY_FROM_CACHE, [method, featureFlagNameOrNames ? ` for feature flag ${featureFlagNameOrNames.toString()}` : '']);
+  log.warn(CLIENT_NOT_READY_FROM_CACHE, [method]);
   return false;
 }
 
 // Operational means that the SDK is ready to evaluate (not destroyed and ready from cache)
-export function validateIfOperational(log: ILogger, readinessManager: IReadinessManager, method: string, featureFlagNameOrNames?: string | string[] | false) {
-  return validateIfNotDestroyed(log, readinessManager, method) && validateIfReadyFromCache(log, readinessManager, method, featureFlagNameOrNames);
+export function validateIfOperational(log: ILogger, readinessManager: IReadinessManager, method: string) {
+  return validateIfNotDestroyed(log, readinessManager, method) && validateIfReadyFromCache(log, readinessManager, method);
 }

types/splitio.d.ts

@@ -2287,7 +2287,7 @@ declare namespace SplitIO {
 
   // Configs SDK
 
-  interface Target extends EvaluationOptions {
+  interface Target {
     key: SplitKey;
     attributes?: Attributes;
   }
@@ -2300,6 +2300,7 @@ declare namespace SplitIO {
     getArray(propertyName: string): ConfigArray;
     getObject(propertyName: string): Config;
   }
+
   interface ConfigArray {
     value: any;
     getString(index: number, propertyDefaultValue?: string): string;
@@ -2310,7 +2311,7 @@ declare namespace SplitIO {
   }
 
   /**
-   * Common definitions between SDK instances for different environments interface.
+   * Configs SDK client interface.
    */
   interface ConfigsClient extends IStatusInterface {
     /**
@@ -2342,7 +2343,7 @@ declare namespace SplitIO {
      * @param target - The target of the config we want to get.
      * @returns The config object.
      */
-    getConfig(name: string, target?: Target): Config;
+    getConfig(name: string, target?: Target, options?: EvaluationOptions): Config;
     /**
      * Tracks an event to be fed to the results product on Split user interface.
      *
@@ -2355,4 +2356,51 @@ declare namespace SplitIO {
      */
     track(key: SplitKey, trafficType: string, eventType: string, value?: number, properties?: Properties): boolean;
   }
+
+  /**
+   * Configs SDK client interface with async methods.
+   */
+  interface AsyncConfigsClient extends IStatusInterface {
+    /**
+     * Current settings of the SDK instance.
+     */
+    settings: ISettings;
+    /**
+     * Logger API.
+     */
+    Logger: ILoggerAPI;
+    /**
+     * Initializes the client.
+     */
+    init(): void;
+    /**
+     * Flushes the client.
+     */
+    flush(): Promise<void>;
+    /**
+     * Destroys the client.
+     *
+     * @returns A promise that resolves once all clients are destroyed.
+     */
+    destroy(): Promise<void>;
+    /**
+     * Gets the config object for a given config name and optional target. If no target is provided, the default variant of the config is returned.
+     *
+     * @param name - The name of the config we want to get.
+     * @param target - The target of the config we want to get.
+     * @returns A promise that resolves with the config object.
+     */
+    getConfig(name: string, target?: Target, options?: EvaluationOptions): Promise<Config>;
+    /**
+     * Tracks an event to be fed to the results product on Split user interface.
+     *
+     * @param key - The key that identifies the entity related to this event.
+     * @param trafficType - The traffic type of the entity related to this event. See {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/fme-settings/traffic-types/}
+     * @param eventType - The event type corresponding to this event.
+     * @param value - The value of this event.
+     * @param properties - The properties of this event. Values can be string, number, boolean or null.
+     * @returns A promise that resolves with a boolean indicating whether the event was added to the queue successfully or not.
+     */
+    track(key: SplitKey, trafficType: string, eventType: string, value?: number, properties?: Properties): Promise<boolean>;
+  }
 }