FF-2525 Add Assignment Details to logger

Eppo-exp · Jun 27, 2024 · 274704a · 274704a
1 parent 4454928
commit 274704a
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 39 deletions.
diff --git a/src/assignment-logger.spec.ts b/src/assignment-logger.spec.ts
@@ -1,4 +1,5 @@
 import { IAssignmentEvent } from './assignment-logger';
+import { AllocationEvaluationCode } from './flag-evaluation-details';
 
 describe('IAssignmentEvent', () => {
   it('should allow adding arbitrary fields', () => {
@@ -11,6 +12,22 @@ describe('IAssignmentEvent', () => {
       timestamp: new Date().toISOString(),
       subjectAttributes: { age: 25, country: 'USA' },
       holdoutKey: 'holdout_key_123',
+      details: {
+        variationKey: 'variationKey',
+        variationValue: 'variation_123',
+        flagEvaluationCode: 'MATCH',
+        flagEvaluationDescription: '',
+        configFetchedAt: new Date().toISOString(),
+        configPublishedAt: new Date().toISOString(),
+        matchedRule: null,
+        matchedAllocation: {
+          key: 'allocation_123',
+          allocationEvaluationCode: AllocationEvaluationCode.MATCH,
+          orderPosition: 1,
+        },
+        unmatchedAllocations: [],
+        unevaluatedAllocations: [],
+      },
     };
 
     expect(event.holdoutKey).toBe('holdout_key_123');

diff --git a/src/assignment-logger.ts b/src/assignment-logger.ts
@@ -1,3 +1,5 @@
+import { IFlagEvaluationDetails } from './flag-evaluation-details';
+
 export enum HoldoutVariationEnum {
   STATUS_QUO = 'status_quo',
   ALL_SHIPPED = 'all_shipped_variants',
@@ -46,6 +48,11 @@ export interface IAssignmentEvent {
   [propName: string]: unknown;
 
   metaData?: Record<string, unknown>;
+
+  /**
+   * The flag evaluation details
+   */
+  details: IFlagEvaluationDetails;
 }
 
 /**

diff --git a/src/client/eppo-client-assignment-details.spec.ts b/src/client/eppo-client-assignment-details.spec.ts
@@ -15,7 +15,7 @@ import FetchHttpClient from '../http-client';
 import { Flag, ObfuscatedFlag, VariationType } from '../interfaces';
 import { OperatorType } from '../rules';
 
-import EppoClient, { AssignmentDetails } from './eppo-client';
+import EppoClient, { IAssignmentDetails } from './eppo-client';
 
 async function init(configurationStore: IConfigurationStore<Flag | ObfuscatedFlag>) {
   const apiEndpoints = new ApiEndpoints({
@@ -57,7 +57,7 @@ describe('EppoClient get*AssignmentDetails', () => {
       subjectAttributes,
       0,
     );
-    const expected: AssignmentDetails<number> = {
+    const expected: IAssignmentDetails<number> = {
       value: 3,
       variationKey: 'three',
       variationValue: 3,
@@ -102,7 +102,7 @@ describe('EppoClient get*AssignmentDetails', () => {
       subjectAttributes,
       0,
     );
-    const expected: AssignmentDetails<number> = {
+    const expected: IAssignmentDetails<number> = {
       value: 2,
       variationKey: 'two',
       variationValue: 2,
@@ -139,7 +139,7 @@ describe('EppoClient get*AssignmentDetails', () => {
       subjectAttributes,
       '',
     );
-    const expected: AssignmentDetails<string> = {
+    const expected: IAssignmentDetails<string> = {
       value: 'control',
       flagEvaluationCode: 'MATCH',
       flagEvaluationDescription:
@@ -201,7 +201,7 @@ describe('EppoClient get*AssignmentDetails', () => {
       matchedAllocation: null,
       unmatchedAllocations: [],
       unevaluatedAllocations: [],
-    } as AssignmentDetails<number>);
+    } as IAssignmentDetails<number>);
   });
 
   describe('UFC General Test Cases', () => {

diff --git a/src/client/eppo-client.spec.ts b/src/client/eppo-client.spec.ts
@@ -6,11 +6,9 @@ import {
   MOCK_UFC_RESPONSE_FILE,
   OBFUSCATED_MOCK_UFC_RESPONSE_FILE,
   SubjectTestCase,
-  getTestAssignmentDetails,
   getTestAssignments,
   readAssignmentTestData,
   readMockUFCResponse,
-  validateTestAssignmentDetails,
   validateTestAssignments,
 } from '../../test/testHelpers';
 import ApiEndpoints from '../api-endpoints';
@@ -19,16 +17,10 @@ import { IConfigurationStore } from '../configuration-store/configuration-store'
 import { MemoryOnlyConfigurationStore } from '../configuration-store/memory.store';
 import { MAX_EVENT_QUEUE_SIZE, POLL_INTERVAL_MS, POLL_JITTER_PCT } from '../constants';
 import FlagConfigurationRequestor from '../flag-configuration-requestor';
-import { AllocationEvaluationCode } from '../flag-evaluation-details';
 import FetchHttpClient from '../http-client';
 import { Flag, ObfuscatedFlag, VariationType } from '../interfaces';
-import { OperatorType } from '../rules';
 
-import EppoClient, {
-  AssignmentDetails,
-  FlagConfigurationRequestParameters,
-  checkTypeMatch,
-} from './eppo-client';
+import EppoClient, { FlagConfigurationRequestParameters, checkTypeMatch } from './eppo-client';
 
 export async function init(configurationStore: IConfigurationStore<Flag | ObfuscatedFlag>) {
   const apiEndpoints = new ApiEndpoints({

diff --git a/src/client/eppo-client.ts b/src/client/eppo-client.ts
@@ -18,7 +18,7 @@ import { decodeFlag } from '../decoding';
 import { EppoValue } from '../eppo_value';
 import { Evaluator, FlagEvaluation, noneResult } from '../evaluator';
 import FlagConfigurationRequestor from '../flag-configuration-requestor';
-import { FlagEvaluationDetails, FlagEvaluationDetailsBuilder } from '../flag-evaluation-details';
+import { IFlagEvaluationDetails, FlagEvaluationDetailsBuilder } from '../flag-evaluation-details';
 import FetchHttpClient from '../http-client';
 import { Flag, ObfuscatedFlag, Variation, VariationType } from '../interfaces';
 import { getMD5Hash } from '../obfuscation';
@@ -27,8 +27,8 @@ import { AttributeType, ValueType } from '../types';
 import { validateNotBlank } from '../validation';
 import { LIB_VERSION } from '../version';
 
-export interface AssignmentDetails<T extends Variation['value'] | object>
-  extends FlagEvaluationDetails {
+export interface IAssignmentDetails<T extends Variation['value'] | object>
+  extends IFlagEvaluationDetails {
   value: T;
 }
 
@@ -177,7 +177,7 @@ export default class EppoClient {
     subjectKey: string,
     subjectAttributes: Record<string, AttributeType>,
     defaultValue: string,
-  ): AssignmentDetails<string> {
+  ): IAssignmentDetails<string> {
     const { eppoValue, flagEvaluationDetails } = this.getAssignmentVariation(
       flagKey,
       subjectKey,
@@ -239,7 +239,7 @@ export default class EppoClient {
     subjectKey: string,
     subjectAttributes: Record<string, AttributeType>,
     defaultValue: boolean,
-  ): AssignmentDetails<boolean> {
+  ): IAssignmentDetails<boolean> {
     const { eppoValue, flagEvaluationDetails } = this.getAssignmentVariation(
       flagKey,
       subjectKey,
@@ -289,7 +289,7 @@ export default class EppoClient {
     subjectKey: string,
     subjectAttributes: Record<string, AttributeType>,
     defaultValue: number,
-  ): AssignmentDetails<number> {
+  ): IAssignmentDetails<number> {
     const { eppoValue, flagEvaluationDetails } = this.getAssignmentVariation(
       flagKey,
       subjectKey,
@@ -339,7 +339,7 @@ export default class EppoClient {
     subjectKey: string,
     subjectAttributes: Record<string, AttributeType>,
     defaultValue: number,
-  ): AssignmentDetails<number> {
+  ): IAssignmentDetails<number> {
     const { eppoValue, flagEvaluationDetails } = this.getAssignmentVariation(
       flagKey,
       subjectKey,
@@ -377,7 +377,7 @@ export default class EppoClient {
     subjectKey: string,
     subjectAttributes: Record<string, AttributeType>,
     defaultValue: object,
-  ): AssignmentDetails<object> {
+  ): IAssignmentDetails<object> {
     const { eppoValue, flagEvaluationDetails } = this.getAssignmentVariation(
       flagKey,
       subjectKey,
@@ -397,7 +397,7 @@ export default class EppoClient {
     subjectAttributes: Record<string, AttributeType>,
     defaultValue: EppoValue,
     expectedVariationType: VariationType,
-  ): { eppoValue: EppoValue; flagEvaluationDetails: FlagEvaluationDetails } {
+  ): { eppoValue: EppoValue; flagEvaluationDetails: IFlagEvaluationDetails } {
     try {
       const result = this.getAssignmentDetail(
         flagKey,
@@ -619,6 +619,7 @@ export default class EppoClient {
         sdkLanguage: 'javascript',
         sdkLibVersion: LIB_VERSION,
       },
+      details: result.flagEvaluationDetails,
     };
 
     if (variation && allocationKey) {

diff --git a/src/evaluator.ts b/src/evaluator.ts
@@ -1,7 +1,7 @@
 import {
   AllocationEvaluation,
   AllocationEvaluationCode,
-  FlagEvaluationDetails,
+  IFlagEvaluationDetails,
   FlagEvaluationDetailsBuilder,
 } from './flag-evaluation-details';
 import { Flag, Shard, Range, Variation, Allocation, Split, VariationType } from './interfaces';
@@ -17,7 +17,7 @@ export interface FlagEvaluation {
   variation: Variation | null;
   extraLogging: Record<string, string>;
   doLog: boolean;
-  flagEvaluationDetails: FlagEvaluationDetails;
+  flagEvaluationDetails: IFlagEvaluationDetails;
 }
 
 export class Evaluator {
@@ -166,7 +166,7 @@ export function noneResult(
   flagKey: string,
   subjectKey: string,
   subjectAttributes: SubjectAttributes,
-  flagEvaluationDetails: FlagEvaluationDetails,
+  flagEvaluationDetails: IFlagEvaluationDetails,
 ): FlagEvaluation {
   return {
     flagKey,

diff --git a/src/flag-evaluation-details.ts b/src/flag-evaluation-details.ts
@@ -26,7 +26,7 @@ export interface AllocationEvaluation {
   orderPosition: number;
 }
 
-export interface FlagEvaluationDetails {
+export interface IFlagEvaluationDetails {
   variationKey: string | null;
   variationValue: Variation['value'] | null;
   flagEvaluationCode: FlagEvaluationCode;
@@ -40,12 +40,12 @@ export interface FlagEvaluationDetails {
 }
 
 export class FlagEvaluationDetailsBuilder {
-  private variationKey: FlagEvaluationDetails['variationKey'];
-  private variationValue: FlagEvaluationDetails['variationValue'];
-  private matchedRule: FlagEvaluationDetails['matchedRule'];
-  private matchedAllocation: FlagEvaluationDetails['matchedAllocation'];
-  private unmatchedAllocations: FlagEvaluationDetails['unmatchedAllocations'];
-  private unevaluatedAllocations: FlagEvaluationDetails['unevaluatedAllocations'];
+  private variationKey: IFlagEvaluationDetails['variationKey'];
+  private variationValue: IFlagEvaluationDetails['variationValue'];
+  private matchedRule: IFlagEvaluationDetails['matchedRule'];
+  private matchedAllocation: IFlagEvaluationDetails['matchedAllocation'];
+  private unmatchedAllocations: IFlagEvaluationDetails['unmatchedAllocations'];
+  private unevaluatedAllocations: IFlagEvaluationDetails['unevaluatedAllocations'];
 
   constructor(
     private readonly allocations: Allocation[],
@@ -121,12 +121,12 @@ export class FlagEvaluationDetailsBuilder {
   buildForNoneResult = (
     flagEvaluationCode: FlagEvaluationCode,
     flagEvaluationDescription: string,
-  ): FlagEvaluationDetails => this.setNone().build(flagEvaluationCode, flagEvaluationDescription);
+  ): IFlagEvaluationDetails => this.setNone().build(flagEvaluationCode, flagEvaluationDescription);
 
   build = (
     flagEvaluationCode: FlagEvaluationCode,
     flagEvaluationDescription: string,
-  ): FlagEvaluationDetails => ({
+  ): IFlagEvaluationDetails => ({
     flagEvaluationCode,
     flagEvaluationDescription,
     variationKey: this.variationKey,

diff --git a/test/testHelpers.ts b/test/testHelpers.ts
@@ -1,6 +1,6 @@
 import * as fs from 'fs';
 
-import { AssignmentDetails } from '../src/client/eppo-client';
+import { IAssignmentDetails } from '../src/client/eppo-client';
 import { Flag, VariationType } from '../src/interfaces';
 import { AttributeType } from '../src/types';
 
@@ -13,7 +13,7 @@ export interface SubjectTestCase {
   subjectKey: string;
   subjectAttributes: Record<string, AttributeType>;
   assignment: string | number | boolean | object;
-  assignmentDetails: AssignmentDetails<string | number | boolean | object>;
+  assignmentDetails: IAssignmentDetails<string | number | boolean | object>;
 }
 
 export interface IAssignmentTestCase {
@@ -70,7 +70,7 @@ export function getTestAssignmentDetails(
   ) => never,
 ): {
   subject: SubjectTestCase;
-  assignmentDetails: AssignmentDetails<string | boolean | number | object>;
+  assignmentDetails: IAssignmentDetails<string | boolean | number | object>;
 }[] {
   return testCase.subjects.map((subject) => ({
     subject,
@@ -108,7 +108,7 @@ export function validateTestAssignments(
 export function validateTestAssignmentDetails(
   assignments: {
     subject: SubjectTestCase;
-    assignmentDetails: AssignmentDetails<string | boolean | number | object>;
+    assignmentDetails: IAssignmentDetails<string | boolean | number | object>;
   }[],
   flag: string,
 ) {