Include logging for format

Author: sameerank

src/client/eppo-client.ts

@@ -839,7 +839,13 @@ export default class EppoClient {
         'FLAG_UNRECOGNIZED_OR_DISABLED',
         `Unrecognized or disabled flag: ${flagKey}`,
       );
-      return noneResult(flagKey, subjectKey, subjectAttributes, flagEvaluationDetails);
+      return noneResult(
+        flagKey,
+        subjectKey,
+        subjectAttributes,
+        flagEvaluationDetails,
+        configDetails.configFormat,
+      );
     }
 
     if (!checkTypeMatch(expectedVariationType, flag.variationType)) {
@@ -849,7 +855,13 @@ export default class EppoClient {
           'TYPE_MISMATCH',
           errorMessage,
         );
-        return noneResult(flagKey, subjectKey, subjectAttributes, flagEvaluationDetails);
+        return noneResult(
+          flagKey,
+          subjectKey,
+          subjectAttributes,
+          flagEvaluationDetails,
+          configDetails.configFormat,
+        );
       }
       throw new TypeError(errorMessage);
     }
@@ -861,7 +873,13 @@ export default class EppoClient {
         'FLAG_UNRECOGNIZED_OR_DISABLED',
         `Unrecognized or disabled flag: ${flagKey}`,
       );
-      return noneResult(flagKey, subjectKey, subjectAttributes, flagEvaluationDetails);
+      return noneResult(
+        flagKey,
+        subjectKey,
+        subjectAttributes,
+        flagEvaluationDetails,
+        configDetails.configFormat,
+      );
     }
 
     const result = this.evaluator.evaluateFlag(
@@ -904,6 +922,7 @@ export default class EppoClient {
       configFetchedAt: this.flagConfigurationStore.getConfigFetchedAt() ?? '',
       configPublishedAt: this.flagConfigurationStore.getConfigPublishedAt() ?? '',
       configEnvironment: this.flagConfigurationStore.getEnvironment() ?? { name: '' },
+      configFormat: this.flagConfigurationStore.getFormat() ?? '',
     };
   }
 

src/client/eppo-precomputed-client.spec.ts

@@ -613,4 +613,18 @@ describe('EppoPrecomputedClient E2E test', () => {
       );
     });
   });
+
+  it('logs variation assignment with format from precomputed flags response', () => {
+    const mockLogger = td.object<IAssignmentLogger>();
+    storage.setEntries({ [precomputedFlagKey]: mockPrecomputedFlag });
+    const client = new EppoPrecomputedClient(storage);
+    client.setAssignmentLogger(mockLogger);
+
+    client.getStringAssignment(precomputedFlagKey, 'default');
+
+    expect(td.explain(mockLogger.logAssignment).callCount).toEqual(1);
+    const loggedEvent = td.explain(mockLogger.logAssignment).calls[0].args[0];
+
+    expect(loggedEvent.format).toEqual('PRECOMPUTED');
+  });
 });

src/client/eppo-precomputed-client.ts

@@ -17,7 +17,7 @@ import {
 import { decodePrecomputedFlag } from '../decoding';
 import { FlagEvaluationWithoutDetails } from '../evaluator';
 import FetchHttpClient from '../http-client';
-import { PrecomputedFlag } from '../interfaces';
+import { FormatEnum, PrecomputedFlag } from '../interfaces';
 import { getMD5Hash } from '../obfuscation';
 import initPoller, { IPoller } from '../poller';
 import PrecomputedRequestor from '../precomputed-requestor';
@@ -151,6 +151,7 @@ export default class EppoPrecomputedClient {
 
     const result: FlagEvaluationWithoutDetails = {
       flagKey,
+      format: this.precomputedFlagStore.getFormat() ?? '',
       subjectKey: this.precomputedFlagsRequestParameters?.precompute.subjectKey ?? '',
       subjectAttributes: this.precomputedFlagsRequestParameters?.precompute.subjectAttributes ?? {},
       variation: {
@@ -225,19 +226,21 @@ export default class EppoPrecomputedClient {
     eventsToFlush.forEach((event) => {
       try {
         logFunction(event);
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
       } catch (error: any) {
         logger.error(`[Eppo SDK] Error flushing event to logger: ${error.message}`);
       }
     });
   }
 
   private logAssignment(result: FlagEvaluationWithoutDetails) {
-    const { flagKey, subjectKey, allocationKey, subjectAttributes, variation } = result;
+    const { flagKey, subjectKey, allocationKey, subjectAttributes, variation, format } = result;
     const event: IAssignmentEvent = {
       ...(result.extraLogging ?? {}),
       allocation: allocationKey ?? null,
       experiment: allocationKey ? `${flagKey}-${allocationKey}` : null,
       featureFlag: flagKey,
+      format,
       variation: variation?.key ?? null,
       subject: subjectKey,
       timestamp: new Date().toISOString(),
@@ -272,6 +275,7 @@ export default class EppoPrecomputedClient {
         allocationKey: allocationKey ?? '__eppo_no_allocation',
         variationKey: variation?.key ?? '__eppo_no_variation',
       });
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
     } catch (error: any) {
       logger.error(`[Eppo SDK] Error logging assignment event: ${error.message}`);
     }

src/configuration-requestor.ts

@@ -24,6 +24,7 @@ export default class ConfigurationRequestor {
       entries: configResponse.flags,
       environment: configResponse.environment,
       createdAt: configResponse.createdAt,
+      format: configResponse.format,
     });
 
     const flagsHaveBandits = Object.keys(configResponse.bandits ?? {}).length > 0;
@@ -38,6 +39,7 @@ export default class ConfigurationRequestor {
         entries: banditVariations,
         environment: configResponse.environment,
         createdAt: configResponse.createdAt,
+        format: configResponse.format,
       });
 
       // TODO: different polling intervals for bandit parameters
@@ -51,6 +53,7 @@ export default class ConfigurationRequestor {
           entries: banditResponse.bandits,
           environment: configResponse.environment,
           createdAt: configResponse.createdAt,
+          format: configResponse.format,
         });
       }
     }

src/configuration-store/configuration-store-utils.ts

@@ -16,6 +16,7 @@ export async function hydrateConfigurationStore<T extends Entry>(
     entries: Record<string, T>;
     environment: Environment;
     createdAt: string;
+    format: string;
   },
 ): Promise<void> {
   if (configurationStore) {
@@ -24,6 +25,7 @@ export async function hydrateConfigurationStore<T extends Entry>(
       configurationStore.setEnvironment(response.environment);
       configurationStore.setConfigFetchedAt(new Date().toISOString());
       configurationStore.setConfigPublishedAt(response.createdAt);
+      configurationStore.setFormat(response.format);
     }
   }
 }

src/configuration-store/configuration-store.ts

@@ -36,6 +36,8 @@ export interface IConfigurationStore<T> {
   setConfigFetchedAt(configFetchedAt: string): void;
   getConfigPublishedAt(): string | null;
   setConfigPublishedAt(configPublishedAt: string): void;
+  getFormat(): string | null;
+  setFormat(format: string): void;
 }
 
 export interface ISyncStore<T> {

src/configuration-store/memory.store.ts

@@ -34,7 +34,7 @@ export class MemoryOnlyConfigurationStore<T> implements IConfigurationStore<T> {
   private configFetchedAt: string | null = null;
   private configPublishedAt: string | null = null;
   private environment: Environment | null = null;
-
+  private format: string | null = null;
   init(): Promise<void> {
     this.initialized = true;
     return Promise.resolve();
@@ -89,4 +89,12 @@ export class MemoryOnlyConfigurationStore<T> implements IConfigurationStore<T> {
   public setConfigPublishedAt(configPublishedAt: string): void {
     this.configPublishedAt = configPublishedAt;
   }
+
+  public getFormat(): string | null {
+    return this.format;
+  }
+
+  public setFormat(format: string): void {
+    this.format = format;
+  }
 }

src/evaluator.ts

@@ -22,6 +22,7 @@ import { Attributes } from './types';
 
 export interface FlagEvaluationWithoutDetails {
   flagKey: string;
+  format: string;
   subjectKey: string;
   subjectAttributes: Attributes;
   allocationKey: string | null;
@@ -65,6 +66,7 @@ export class Evaluator {
             'FLAG_UNRECOGNIZED_OR_DISABLED',
             `Unrecognized or disabled flag: ${flag.key}`,
           ),
+          configDetails.configFormat,
         );
       }
 
@@ -111,6 +113,7 @@ export class Evaluator {
                 .build(flagEvaluationCode, flagEvaluationDescription);
               return {
                 flagKey: flag.key,
+                format: configDetails.configFormat,
                 subjectKey,
                 subjectAttributes,
                 allocationKey: allocation.key,
@@ -135,6 +138,7 @@ export class Evaluator {
           'DEFAULT_ALLOCATION_NULL',
           'No allocations matched. Falling back to "Default Allocation", serving NULL',
         ),
+        configDetails.configFormat,
       );
     } catch (err: any) {
       const flagEvaluationDetails = flagEvaluationDetailsBuilder.gracefulBuild(
@@ -206,9 +210,11 @@ export function noneResult(
   subjectKey: string,
   subjectAttributes: Attributes,
   flagEvaluationDetails: IFlagEvaluationDetails,
+  format: string,
 ): FlagEvaluation {
   return {
     flagKey,
+    format,
     subjectKey,
     subjectAttributes,
     allocationKey: null,

src/interfaces.ts

@@ -46,6 +46,7 @@ export interface ConfigDetails {
   configFetchedAt: string;
   configPublishedAt: string;
   configEnvironment: Environment;
+  configFormat: string;
 }
 
 export interface Flag {

src/precomputed-requestor.ts

@@ -20,6 +20,7 @@ export default class PrecomputedFlagRequestor {
       entries: precomputedResponse.flags,
       environment: precomputedResponse.environment,
       createdAt: precomputedResponse.createdAt,
+      format: precomputedResponse.format,
     });
   }
 }