feat: Evaluation Details (#97)

* feat: New "Details" assignment functions

* code review changes

Author: greghuels

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
   "eslint.format.enable": true,
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eppo/js-client-sdk-common",
-  "version": "3.6.0",
+  "version": "4.0.0",
   "description": "Eppo SDK for client-side JavaScript applications (base for both web and react native)",
   "main": "dist/index.js",
   "files": [

src/assignment-logger.spec.ts

@@ -1,4 +1,5 @@
 import { IAssignmentEvent } from './assignment-logger';
+import { AllocationEvaluationCode } from './flag-evaluation-details-builder';
 
 describe('IAssignmentEvent', () => {
   it('should allow adding arbitrary fields', () => {
@@ -11,6 +12,25 @@ describe('IAssignmentEvent', () => {
       timestamp: new Date().toISOString(),
       subjectAttributes: { age: 25, country: 'USA' },
       holdoutKey: 'holdout_key_123',
+      evaluationDetails: {
+        environmentName: 'Test',
+        variationKey: 'variationKey',
+        variationValue: 'variation_123',
+        banditKey: null,
+        banditAction: null,
+        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');

src/assignment-logger.ts

@@ -1,3 +1,5 @@
+import { IFlagEvaluationDetails } from './flag-evaluation-details-builder';
+
 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
+   */
+  evaluationDetails: IFlagEvaluationDetails;
 }
 
 /**

src/bandit-logger.ts

@@ -1,3 +1,4 @@
+import { IFlagEvaluationDetails } from './flag-evaluation-details-builder';
 import { Attributes } from './types';
 
 export interface IBanditEvent {
@@ -14,6 +15,7 @@ export interface IBanditEvent {
   actionNumericAttributes: Attributes;
   actionCategoricalAttributes: Attributes;
   metaData?: Record<string, unknown>;
+  evaluationDetails: IFlagEvaluationDetails;
 }
 
 export interface IBanditLogger {

src/cache/lru-cache.ts

@@ -13,6 +13,8 @@
  */
 export class LRUCache implements Map<string, string> {
   private readonly cache = new Map<string, string>();
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
   [Symbol.toStringTag]: string;
 
   constructor(private readonly capacity: number) {}