add entityId

Author: felipecsl

src/assignment-logger.ts

@@ -13,34 +13,22 @@ export type NullableHoldoutVariationType = HoldoutVariationEnum | null;
  */
 
 export interface IAssignmentEvent {
-  /**
-   * An Eppo allocation key
-   */
+  /** * An Eppo allocation key */
   allocation: string | null;
 
-  /**
-   * An Eppo experiment key
-   */
+  /** * An Eppo experiment key */
   experiment: string | null;
 
-  /**
-   * An Eppo feature flag key
-   */
+  /** * An Eppo feature flag key */
   featureFlag: string;
 
-  /**
-   * The assigned variation
-   */
+  /** * The assigned variation */
   variation: string | null;
 
-  /**
-   * The entity or user that was assigned to a variation
-   */
+  /** * The entity or user that was assigned to a variation */
   subject: string;
 
-  /**
-   * The time the subject was exposed to the variation.
-   */
+  /** * The time the subject was exposed to the variation. */
   timestamp: string;
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -49,15 +37,14 @@ export interface IAssignmentEvent {
 
   metaData?: Record<string, unknown>;
 
-  /**
-   * The format of the flag.
-   */
+  /** * The format of the flag. */
   format: string;
 
-  /**
-   * The flag evaluation details. Null if the flag was precomputed.
-   */
+  /** * The flag evaluation details. Null if the flag was precomputed. */
   evaluationDetails: IFlagEvaluationDetails | null;
+
+  /** * The entity ID of the subject, if present. */
+  entityId?: number;
 }
 
 /**

src/client/eppo-client.ts

@@ -1288,7 +1288,7 @@ export default class EppoClient {
     });
   }
 
-  private maybeLogAssignment(result: FlagEvaluation) {
+  private maybeLogAssignment(result: FlagEvaluation & { entityId?: number }) {
     const {
       flagKey,
       format,
@@ -1298,6 +1298,7 @@ export default class EppoClient {
       variation,
       flagEvaluationDetails,
       extraLogging = {},
+      entityId,
     } = result;
     const event: IAssignmentEvent = {
       ...extraLogging,
@@ -1311,6 +1312,7 @@ export default class EppoClient {
       subjectAttributes,
       metaData: this.buildLoggerMetadata(),
       evaluationDetails: flagEvaluationDetails,
+      entityId,
     };
 
     if (variation && allocationKey) {

src/eppo-assignment-logger.spec.ts

@@ -0,0 +1,88 @@
+import { IAssignmentEvent } from './assignment-logger';
+import EppoClient from './client/eppo-client';
+import { IConfigurationStore } from './configuration-store/configuration-store';
+import { EppoAssignmentLogger } from './eppo-assignment-logger';
+import { Flag } from './interfaces';
+
+jest.mock('./client/eppo-client');
+
+describe('EppoAssignmentLogger', () => {
+  let mockEppoClient: jest.Mocked<EppoClient>;
+  let logger: EppoAssignmentLogger;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    mockEppoClient = new EppoClient({
+      flagConfigurationStore: {} as IConfigurationStore<Flag>,
+    }) as jest.Mocked<EppoClient>;
+    mockEppoClient.track = jest.fn();
+    logger = new EppoAssignmentLogger(mockEppoClient);
+  });
+
+  it('should log assignment events correctly', () => {
+    // Arrange
+    const assignmentEvent: IAssignmentEvent = {
+      subject: 'user-123',
+      experiment: 'experiment-abc',
+      variant: 'control',
+      entityId: 456, // Changed to number
+      holdoutKey: 'holdout-xyz',
+      holdoutVariation: 'holdout-variant-1',
+      // Add required properties based on the IAssignmentEvent interface
+      allocation: 'allocation-1',
+      featureFlag: 'feature-flag-1',
+      variation: 'variation-1',
+      timestamp: new Date().toISOString(),
+      subjectAttributes: {},
+      flagKey: 'flag-key-1',
+      format: 'json',
+      evaluationDetails: null,
+    };
+
+    // Act
+    logger.logAssignment(assignmentEvent);
+
+    // Assert
+    expect(mockEppoClient.track).toHaveBeenCalledTimes(1);
+    expect(mockEppoClient.track).toHaveBeenCalledWith('__eppo_assignment', {
+      subject_id: 'user-123',
+      experiment: 'experiment-abc',
+      variant: 'control',
+      entity_id: 456,
+      holdout: 'holdout-xyz',
+      holdout_variant: 'holdout-variant-1',
+    });
+  });
+
+  it('should handle missing optional fields', () => {
+    // Arrange
+    const assignmentEvent: IAssignmentEvent = {
+      subject: 'user-123',
+      experiment: 'experiment-abc',
+      variant: 'control',
+      // Add required properties based on the IAssignmentEvent interface
+      allocation: 'allocation-1',
+      featureFlag: 'feature-flag-1',
+      variation: 'variation-1',
+      timestamp: new Date().toISOString(),
+      subjectAttributes: {},
+      flagKey: 'flag-key-1',
+      format: 'json',
+      evaluationDetails: null,
+    };
+
+    // Act
+    logger.logAssignment(assignmentEvent);
+
+    // Assert
+    expect(mockEppoClient.track).toHaveBeenCalledTimes(1);
+    expect(mockEppoClient.track).toHaveBeenCalledWith('__eppo_assignment', {
+      subject_id: 'user-123',
+      experiment: 'experiment-abc',
+      variant: 'control',
+      entity_id: undefined,
+      holdout: undefined,
+      holdout_variant: undefined,
+    });
+  });
+});

src/eppo-assignment-logger.ts

@@ -1,26 +1,30 @@
 import { IAssignmentEvent, IAssignmentLogger } from './assignment-logger';
 import EppoClient from './client/eppo-client';
 
-/** TODO docs */
+/**
+ * Tracks an assignment event by submitting it to the Eppo Ingestion API.
+ * Events are queued up for delivery according to the EppoClient's `EventDispatcher` implementation.
+ */
 export class EppoAssignmentLogger implements IAssignmentLogger {
   constructor(private readonly eppoClient: EppoClient) {}
 
   logAssignment(event: IAssignmentEvent): void {
-    const entity = event.subjectAttributes.entity;
     const {
+      entityId: entity_id,
+      experiment,
       holdoutKey: holdout,
       holdoutVariation: holdout_variant,
       subject: subject_id,
-      experiment,
       variant,
     } = event;
-    this.eppoClient.track('__eppo_assignment', {
-      subject_id,
+    const payload = {
+      entity_id,
       experiment,
-      variant,
-      entity,
-      holdout,
       holdout_variant,
-    });
+      holdout,
+      subject_id,
+      variant,
+    };
+    this.eppoClient.track('__eppo_assignment', payload);
   }
 }

src/interfaces.ts

@@ -59,6 +59,7 @@ export interface Flag {
   variations: Record<string, Variation>;
   allocations: Allocation[];
   totalShards: number;
+  entityId?: number;
 }
 
 export interface ObfuscatedFlag {