Split getJSONAssignment into getJSONStringAssignment and getParsedJSONAssignment by bumping common library version [FF-899] (#27)

* Update tests

* Commit pre-commit file

* Increment common library version and help jest find in node_modules

* increment common version to use IEppoClient with getParsedJSONAssignment

Author: sameerank

.eslintrc.pre-commit.js

@@ -0,0 +1,40 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+    es6: true,
+    jest: true,
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:promise/recommended',
+    'plugin:import/recommended',
+  ],
+  plugins: ['@typescript-eslint', 'import', 'promise'],
+  rules: {
+    '@typescript-eslint/ban-ts-comment': 'warn',
+    'import/namespace': 'off',
+    'import/named': 'off',
+    'import/no-unresolved': 'off',
+    'import/order': [
+      'warn',
+      {
+        pathGroups: [
+          {
+            pattern: 'src/**',
+            group: 'parent',
+            position: 'before',
+          },
+        ],
+        groups: ['builtin', 'external', 'parent', 'sibling', 'index'],
+        'newlines-between': 'always',
+        alphabetize: {
+          order: 'asc' /* sort in ascending order. Options: ['ignore', 'asc', 'desc'] */,
+          caseInsensitive: true /* ignore case. Options: [true, false] */,
+        },
+      },
+    ],
+  },
+};

.gitignore

@@ -8,3 +8,5 @@ temp
 yarn-error.log
 
 test/data
+
+.eslintcache

jest.config.js

@@ -4,6 +4,7 @@ module.exports = {
   moduleNameMapper: {
     '^src/(.*)': ['<rootDir>/src/$1'],
     '^test/(.*)': ['<rootDir>/test/$1'],
+    '@eppo(.*)': '<rootDir>/node_modules/@eppo/$1',
   },
   testRegex: '.*\\..*spec\\.ts$',
   transform: {

package.json

@@ -57,7 +57,7 @@
     "xhr-mock": "^2.5.1"
   },
   "dependencies": {
-    "@eppo/js-client-sdk-common": "^1.4.1",
+    "@eppo/js-client-sdk-common": "^1.5.1",
     "axios": "^0.27.2",
     "md5": "^2.3.0"
   }

src/index.spec.ts

@@ -2,11 +2,13 @@
  * @jest-environment jsdom
  */
 
+import { EppoValue } from '@eppo/js-client-sdk-common/dist/eppo_value';
 import * as td from 'testdouble';
 import mock from 'xhr-mock';
 
 import {
   IAssignmentTestCase,
+  ValueTestType,
   readAssignmentTestData,
   readMockRacResponse,
 } from '../test/testHelpers';
@@ -207,22 +209,37 @@ describe('EppoJSClient E2E test', () => {
       'test variation assignment splits',
       ({
         experiment,
-        valueType = 'string',
+        valueType = ValueTestType.StringType,
         subjects,
         subjectsWithAttributes,
         expectedAssignments,
       }: IAssignmentTestCase) => {
-        `---- Test Case for ${experiment} Experiment ----`;
-
-        if (valueType === 'string') {
-          const assignments = subjectsWithAttributes
-            ? getAssignmentsWithSubjectAttributes(subjectsWithAttributes, experiment)
-            : getAssignments(subjects, experiment);
-          expect(assignments).toEqual(expectedAssignments);
-          expect(assignments.length).toBeGreaterThan(0);
-        } else {
-          // skip for now
-          expect(true).toBe(true);
+        console.log(`---- Test Case for ${experiment} Experiment ----`);
+        const assignments = subjectsWithAttributes
+          ? getAssignmentsWithSubjectAttributes(subjectsWithAttributes, experiment, valueType)
+          : getAssignments(subjects, experiment, valueType);
+
+        switch (valueType) {
+          case ValueTestType.BoolType: {
+            const boolAssignments = assignments.map((a) => a?.boolValue ?? null);
+            expect(boolAssignments).toEqual(expectedAssignments);
+            break;
+          }
+          case ValueTestType.NumericType: {
+            const numericAssignments = assignments.map((a) => a?.numericValue ?? null);
+            expect(numericAssignments).toEqual(expectedAssignments);
+            break;
+          }
+          case ValueTestType.StringType: {
+            const stringAssignments = assignments.map((a) => a?.stringValue ?? null);
+            expect(stringAssignments).toEqual(expectedAssignments);
+            break;
+          }
+          case ValueTestType.JSONType: {
+            const jsonStringAssignments = assignments.map((a) => a?.stringValue ?? null);
+            expect(jsonStringAssignments).toEqual(expectedAssignments);
+            break;
+          }
         }
       },
     );
@@ -232,9 +249,35 @@ describe('EppoJSClient E2E test', () => {
     });
   });
 
-  function getAssignments(subjects: string[], experiment: string): (string | null)[] {
+  function getAssignments(
+    subjects: string[],
+    experiment: string,
+    valueTestType: ValueTestType = ValueTestType.StringType,
+  ): (EppoValue | null)[] {
     return subjects.map((subjectKey) => {
-      return globalClient.getAssignment(subjectKey, experiment);
+      switch (valueTestType) {
+        case ValueTestType.BoolType: {
+          const ba = globalClient.getBoolAssignment(subjectKey, experiment);
+          if (ba === null) return null;
+          return EppoValue.Bool(ba);
+        }
+        case ValueTestType.NumericType: {
+          const na = globalClient.getNumericAssignment(subjectKey, experiment);
+          if (na === null) return null;
+          return EppoValue.Numeric(na);
+        }
+        case ValueTestType.StringType: {
+          const sa = globalClient.getStringAssignment(subjectKey, experiment);
+          if (sa === null) return null;
+          return EppoValue.String(sa);
+        }
+        case ValueTestType.JSONType: {
+          const sa = globalClient.getJSONStringAssignment(subjectKey, experiment);
+          const oa = globalClient.getParsedJSONAssignment(subjectKey, experiment);
+          if (oa == null || sa === null) return null;
+          return EppoValue.JSON(sa, oa);
+        }
+      }
     });
   }
 
@@ -245,9 +288,52 @@ describe('EppoJSClient E2E test', () => {
       subjectAttributes: Record<string, any>;
     }[],
     experiment: string,
-  ): (string | null)[] {
+    valueTestType: ValueTestType = ValueTestType.StringType,
+  ): (EppoValue | null)[] {
     return subjectsWithAttributes.map((subject) => {
-      return globalClient.getAssignment(subject.subjectKey, experiment, subject.subjectAttributes);
+      switch (valueTestType) {
+        case ValueTestType.BoolType: {
+          const ba = globalClient.getBoolAssignment(
+            subject.subjectKey,
+            experiment,
+            subject.subjectAttributes,
+          );
+          if (ba === null) return null;
+          return EppoValue.Bool(ba);
+        }
+        case ValueTestType.NumericType: {
+          const na = globalClient.getNumericAssignment(
+            subject.subjectKey,
+            experiment,
+            subject.subjectAttributes,
+          );
+          if (na === null) return null;
+          return EppoValue.Numeric(na);
+        }
+        case ValueTestType.StringType: {
+          const sa = globalClient.getStringAssignment(
+            subject.subjectKey,
+            experiment,
+            subject.subjectAttributes,
+          );
+          if (sa === null) return null;
+          return EppoValue.String(sa);
+        }
+        case ValueTestType.JSONType: {
+          const sa = globalClient.getJSONStringAssignment(
+            subject.subjectKey,
+            experiment,
+            subject.subjectAttributes,
+          );
+          const oa = globalClient.getParsedJSONAssignment(
+            subject.subjectKey,
+            experiment,
+            subject.subjectAttributes,
+          );
+          if (oa == null || sa === null) return null;
+          return EppoValue.JSON(sa, oa);
+        }
+      }
     });
   }
 });

test/testHelpers.ts

@@ -7,9 +7,16 @@ export const TEST_DATA_DIR = './test/data/';
 export const ASSIGNMENT_TEST_DATA_DIR = TEST_DATA_DIR + 'assignment-v2/';
 export const MOCK_RAC_RESPONSE_FILE = 'rac-experiments-v3.json';
 
+export enum ValueTestType {
+  BoolType = 'boolean',
+  NumericType = 'numeric',
+  StringType = 'string',
+  JSONType = 'json',
+}
+
 export interface IAssignmentTestCase {
   experiment: string;
-  valueType: string;
+  valueType: ValueTestType;
   percentExposure: number;
   variations: IVariation[];
   subjects: string[];

tsconfig.json

@@ -15,4 +15,4 @@
     "src/**/*.spec.ts",
     "test/**/*"
   ]
-}
+}

yarn.lock

@@ -289,10 +289,10 @@
   resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70"
   integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==
 
-"@eppo/js-client-sdk-common@^1.4.1":
-  version "1.4.1"
-  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-1.4.1.tgz#b75bb34c9004ea34070be38250532e04d2683e83"
-  integrity sha512-1dPursZSgtJb7ufLbePI1qIryydFTP6Y+EJYiV+I1njhBEdIUjc/E1+Qe3kBDSXoyowrk8VjUZGV4RD4YnPhcA==
+"@eppo/js-client-sdk-common@^1.5.1":
+  version "1.5.1"
+  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-1.5.1.tgz#f4f86c17aaf8da565613a85ffc6b5f133a382a6a"
+  integrity sha512-cO7lkqO1I0d3aOu43+jeiUTNFn4Rkrg95Fc6ADhLFwYjV3b0hI7KRUPE66YadjgP3Db3J2XgBWtQps2XFbfe5Q==
   dependencies:
     axios "^0.27.2"
     md5 "^2.3.0"