FF-1749: JS SDK Common UFC update (#45)

Author: schmit

.gitignore

@@ -10,3 +10,5 @@ yarn-error.log
 
 test/data
 .vscode/settings.json
+
+.DS_Store

Makefile

@@ -35,10 +35,7 @@ test-data:
 	rm -rf $(testDataDir)
 	mkdir -p $(tempDir)
 	git clone -b ${branchName} --depth 1 --single-branch ${githubRepoLink} ${gitDataDir}
-	cp ${gitDataDir}rac-experiments-v3.json ${testDataDir}
-	cp ${gitDataDir}rac-experiments-v3-obfuscated.json ${testDataDir}
-	cp -r ${gitDataDir}assignment-v2 ${testDataDir}
-	cp -r ${gitDataDir}assignment-v2-holdouts/. ${testDataDir}assignment-v2
+	cp -r ${gitDataDir}ufc ${testDataDir}
 	rm -rf ${tempDir}
 
 ## prepare

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eppo/js-client-sdk-common",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "description": "Eppo SDK for client-side JavaScript applications (base for both web and react native)",
   "main": "dist/index.js",
   "files": [
@@ -25,7 +25,7 @@
     "typecheck": "tsc",
     "test": "yarn test:unit",
     "test:unit": "NODE_ENV=test jest '.*\\.spec\\.ts'",
-    "obfuscate-mock-rac": "ts-node test/writeObfuscatedMockRac"
+    "obfuscate-mock-ufc": "ts-node test/writeObfuscatedMockUFC"
   },
   "jsdelivr": "dist/eppo-sdk.js",
   "repository": {

src/assignment-cache.ts

@@ -1,11 +1,11 @@
-import { EppoValue } from './eppo_value';
 import { LRUCache } from './lru-cache';
+import { getMD5Hash } from './obfuscation';
 
 export interface AssignmentCacheKey {
   subjectKey: string;
   flagKey: string;
   allocationKey: string;
-  variationValue: EppoValue;
+  variationKey: string;
 }
 
 export interface Cacheable {
@@ -31,15 +31,15 @@ export abstract class AssignmentCache<T extends Cacheable> {
     // the subject has been assigned to a different variation
     // than was previously logged.
     // in this case we need to log the assignment again.
-    if (this.cache.get(this.getCacheKey(key)) !== key.variationValue.toHashedString()) {
+    if (this.cache.get(this.getCacheKey(key)) !== getMD5Hash(key.variationKey)) {
       return false;
     }
 
     return true;
   }
 
   setLastLoggedAssignment(key: AssignmentCacheKey): void {
-    this.cache.set(this.getCacheKey(key), key.variationValue.toHashedString());
+    this.cache.set(this.getCacheKey(key), getMD5Hash(key.variationKey));
   }
 
   protected getCacheKey({ subjectKey, flagKey, allocationKey }: AssignmentCacheKey): string {

src/assignment-logger.spec.ts

@@ -0,0 +1,18 @@
+import { IAssignmentEvent } from './assignment-logger';
+
+describe('IAssignmentEvent', () => {
+  it('should allow adding arbitrary fields', () => {
+    const event: IAssignmentEvent = {
+      allocation: 'allocation_123',
+      experiment: 'experiment_123',
+      featureFlag: 'feature_flag_123',
+      variation: 'variation_123',
+      subject: 'subject_123',
+      timestamp: new Date().toISOString(),
+      subjectAttributes: { age: 25, country: 'USA' },
+      holdoutKey: 'holdout_key_123',
+    };
+
+    expect(event.holdoutKey).toBe('holdout_key_123');
+  });
+});

src/assignment-logger.ts

@@ -9,16 +9,17 @@ export type NullableHoldoutVariationType = HoldoutVariationEnum | null;
  * Holds data about the variation a subject was assigned to.
  * @public
  */
+
 export interface IAssignmentEvent {
   /**
    * An Eppo allocation key
    */
-  allocation: string;
+  allocation: string | null;
 
   /**
    * An Eppo experiment key
    */
-  experiment: string;
+  experiment: string | null;
 
   /**
    * An Eppo feature flag key
@@ -28,7 +29,7 @@ export interface IAssignmentEvent {
   /**
    * The assigned variation
    */
-  variation: string;
+  variation: string | null;
 
   /**
    * The entity or user that was assigned to a variation
@@ -40,18 +41,11 @@ export interface IAssignmentEvent {
    */
   timestamp: string;
 
-  /**
-   * An Eppo holdout key
-   */
-  holdout: string | null;
-
-  /**
-   * The Eppo holdout variation for the assigned variation
-   */
-  holdoutVariation: NullableHoldoutVariationType;
-
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   subjectAttributes: Record<string, any>;
+  [propName: string]: unknown;
+
+  metaData?: Record<string, unknown>;
 }
 
 /**