Merge remote-tracking branch 'Eppo-exp/main' into selki/FF-3514-bandit-parameters-polling-only-when-needed

maya-the-mango · maya-the-mango · commit a518d450ed02 · 2024-11-21T16:07:47.000Z
# Conflicts:
#	src/configuration-requestor.spec.ts
diff --git a/.github/workflows/lint-test-sdk.yml b/.github/workflows/lint-test-sdk.yml
@@ -7,16 +7,25 @@ on:
 jobs:
   lint-test-sdk:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ '18', '20', '22', '23' ]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '18.x'
-      - uses: actions/cache@v2
+          node-version: ${{ matrix.node-version }}
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
         with:
-          path: './node_modules'
-          key: ${{ runner.os }}-root-node-modules-${{ hashFiles('./yarn.lock') }}
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
       - name: 'Set up GCP SDK for downloading test data'
         uses: 'google-github-actions/setup-gcloud@v0'
       - name: Install SDK dependencies
@@ -30,16 +39,25 @@ jobs:
         working-directory: ./
   typecheck:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ '18', '20', '22', '23' ]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '18.x'
-      - uses: actions/cache@v2
+          node-version: ${{ matrix.node-version }}
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
         with:
-          path: './node_modules'
-          key: ${{ runner.os }}-root-node-modules-${{ hashFiles('./yarn.lock') }}
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
       - name: Install SDK dependencies
         run: yarn --frozen-lockfile
         working-directory: ./
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Eppo JS Common SDK for library
+# Common library for Eppo's JavasScript SDK
 
 [![](https://img.shields.io/npm/v/@eppo/js-client-sdk-common)](https://www.npmjs.com/package/@eppo/js-client-sdk-common)
 [![](https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8)](https://eppo-exp.github.io/js-client-sdk/js-client-sdk-common.html)
diff --git a/package.json b/package.json
@@ -72,5 +72,6 @@
     "md5": "^2.3.0",
     "pino": "^8.19.0",
     "semver": "^7.5.4"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }
diff --git a/src/bandit-evaluator.ts b/src/bandit-evaluator.ts
@@ -20,8 +20,8 @@ export interface BanditEvaluation {
 }
 
 export class BanditEvaluator {
-  private assignmentShards = BANDIT_ASSIGNMENT_SHARDS; // We just hard code this for now
-  private sharder: Sharder = new MD5Sharder();
+  private readonly assignmentShards = BANDIT_ASSIGNMENT_SHARDS; // We just hard code this for now
+  private readonly sharder: Sharder = new MD5Sharder();
 
   public evaluateBandit(
     flagKey: string,
diff --git a/src/client/eppo-client-assignment-details.spec.ts b/src/client/eppo-client-assignment-details.spec.ts
@@ -9,6 +9,7 @@ import { MemoryOnlyConfigurationStore } from '../configuration-store/memory.stor
 import { AllocationEvaluationCode } from '../flag-evaluation-details-builder';
 import { Flag, ObfuscatedFlag, Variation, VariationType } from '../interfaces';
 import { OperatorType } from '../rules';
+import { AttributeType } from '../types';
 
 import EppoClient, { IAssignmentDetails } from './eppo-client';
 import { initConfiguration } from './test-utils';
@@ -323,7 +324,12 @@ describe('EppoClient get*AssignmentDetails', () => {
                 [VariationType.STRING]: client.getStringAssignmentDetails.bind(client),
                 [VariationType.JSON]: client.getJSONAssignmentDetails.bind(client),
               };
-              const assignmentFn = typeAssignmentDetailsFunctions[variationType];
+              const assignmentFn = typeAssignmentDetailsFunctions[variationType] as (
+                flagKey: string,
+                subjectKey: string,
+                subjectAttributes: Record<string, AttributeType>,
+                defaultValue: boolean | string | number | object,
+              ) => IAssignmentDetails<boolean | string | number | object>;
               if (!assignmentFn) {
                 throw new Error(`Unknown variation type: ${variationType}`);
               }
diff --git a/src/client/eppo-client-with-bandits.spec.ts b/src/client/eppo-client-with-bandits.spec.ts
@@ -163,7 +163,7 @@ describe('EppoClient Bandits E2E test', () => {
       expect(banditEvent.action).toBe('adidas');
       expect(banditEvent.actionProbability).toBeCloseTo(0.099);
       expect(banditEvent.optimalityGap).toBe(7.1);
-      expect(banditEvent.modelVersion).toBe('v123');
+      expect(banditEvent.modelVersion).toBe('123');
       expect(banditEvent.subjectNumericAttributes).toStrictEqual({ age: 25 });
       expect(banditEvent.subjectCategoricalAttributes).toStrictEqual({
         country: 'USA',
diff --git a/src/client/eppo-client.spec.ts b/src/client/eppo-client.spec.ts
@@ -17,6 +17,7 @@ import { IConfigurationStore } from '../configuration-store/configuration-store'
 import { MemoryOnlyConfigurationStore } from '../configuration-store/memory.store';
 import { MAX_EVENT_QUEUE_SIZE, DEFAULT_POLL_INTERVAL_MS, POLL_JITTER_PCT } from '../constants';
 import { Flag, ObfuscatedFlag, VariationType } from '../interfaces';
+import { AttributeType } from '../types';
 
 import EppoClient, { FlagConfigurationRequestParameters, checkTypeMatch } from './eppo-client';
 import { initConfiguration } from './test-utils';
@@ -214,7 +215,12 @@ describe('EppoClient E2E test', () => {
           [VariationType.JSON]: client.getJSONAssignment.bind(client),
         };
 
-        const assignmentFn = typeAssignmentFunctions[variationType];
+        const assignmentFn = typeAssignmentFunctions[variationType] as (
+          flagKey: string,
+          subjectKey: string,
+          subjectAttributes: Record<string, AttributeType>,
+          defaultValue: boolean | string | number | object,
+        ) => never;
         if (!assignmentFn) {
           throw new Error(`Unknown variation type: ${variationType}`);
         }
@@ -258,7 +264,12 @@ describe('EppoClient E2E test', () => {
           [VariationType.JSON]: client.getJSONAssignment.bind(client),
         };
 
-        const assignmentFn = typeAssignmentFunctions[variationType];
+        const assignmentFn = typeAssignmentFunctions[variationType] as (
+          flagKey: string,
+          subjectKey: string,
+          subjectAttributes: Record<string, AttributeType>,
+          defaultValue: boolean | string | number | object,
+        ) => never;
         if (!assignmentFn) {
           throw new Error(`Unknown variation type: ${variationType}`);
         }
diff --git a/src/client/eppo-client.ts b/src/client/eppo-client.ts
@@ -515,7 +515,7 @@ export default class EppoClient {
         );
         evaluationDetails.banditAction = action;
       }
-    } catch (err) {
+    } catch (err: any) {
       logger.error('Error determining bandit action', err);
       if (!this.isGracefulFailureMode) {
         throw err;
@@ -752,7 +752,7 @@ export default class EppoClient {
         expectedVariationType,
       );
       return this.parseVariationWithDetails(result, defaultValue, expectedVariationType);
-    } catch (error) {
+    } catch (error: any) {
       const eppoValue = this.rethrowIfNotGraceful(error, defaultValue);
       if (error instanceof FlagEvaluationError && error.flagEvaluationDetails) {
         return {
@@ -790,7 +790,7 @@ export default class EppoClient {
         eppoValue: EppoValue.valueOf(result.variation.value, expectedVariationType),
         flagEvaluationDetails: result.flagEvaluationDetails,
       };
-    } catch (error) {
+    } catch (error: any) {
       const eppoValue = this.rethrowIfNotGraceful(error, defaultValue);
       return {
         eppoValue,
@@ -1010,7 +1010,7 @@ export default class EppoClient {
     eventsToFlush.forEach((event) => {
       try {
         logFunction(event);
-      } catch (error) {
+      } catch (error: any) {
         logger.error(`[Eppo SDK] Error flushing event to logger: ${error.message}`);
       }
     });
@@ -1057,7 +1057,7 @@ export default class EppoClient {
         allocationKey: allocationKey ?? '__eppo_no_allocation',
         variationKey: variation?.key ?? '__eppo_no_variation',
       });
-    } catch (error) {
+    } catch (error: any) {
       logger.error(`[Eppo SDK] Error logging assignment event: ${error.message}`);
     }
   }
diff --git a/src/configuration-requestor.spec.ts b/src/configuration-requestor.spec.ts
@@ -157,7 +157,7 @@ describe('ConfigurationRequestor', () => {
         const bannerBandit = banditModelStore.get('banner_bandit');
         expect(bannerBandit?.banditKey).toBe('banner_bandit');
         expect(bannerBandit?.modelName).toBe('falcon');
-        expect(bannerBandit?.modelVersion).toBe('v123');
+        expect(bannerBandit?.modelVersion).toBe('123');
         const bannerModelData = bannerBandit?.modelData;
         expect(bannerModelData?.gamma).toBe(1);
         expect(bannerModelData?.defaultActionScore).toBe(0);
diff --git a/src/evaluator.ts b/src/evaluator.ts
@@ -32,7 +32,7 @@ export interface FlagEvaluation {
 }
 
 export class Evaluator {
-  sharder: Sharder;
+  private readonly sharder: Sharder;
 
   constructor(sharder?: Sharder) {
     this.sharder = sharder ?? new MD5Sharder();
@@ -133,7 +133,7 @@ export class Evaluator {
           'No allocations matched. Falling back to "Default Allocation", serving NULL',
         ),
       );
-    } catch (err) {
+    } catch (err: any) {
       const flagEvaluationDetails = flagEvaluationDetailsBuilder.gracefulBuild(
         'ASSIGNMENT_ERROR',
         `Assignment Error: ${err.message}`,
diff --git a/src/http-client.ts b/src/http-client.ts
@@ -61,7 +61,7 @@ export default class FetchHttpClient implements IHttpClient {
         throw new HttpRequestError('Failed to fetch data', response?.status);
       }
       return await response.json();
-    } catch (error) {
+    } catch (error: any) {
       if (error.name === 'AbortError') {
         throw new HttpRequestError('Request timed out', 408, error);
       } else if (error instanceof HttpRequestError) {
diff --git a/src/poller.ts b/src/poller.ts
@@ -48,7 +48,7 @@ export default function initPoller(
         startRequestSuccess = true;
         previousPollFailed = false;
         logger.info('Eppo SDK successfully requested initial configuration');
-      } catch (pollingError) {
+      } catch (pollingError: any) {
         previousPollFailed = true;
         logger.warn(
           `Eppo SDK encountered an error with initial poll of configurations: ${pollingError.message}`,
@@ -116,7 +116,7 @@ export default function initPoller(
         previousPollFailed = false;
         logger.info('Eppo SDK poll successful; resuming normal polling');
       }
-    } catch (error) {
+    } catch (error: any) {
       previousPollFailed = true;
       logger.warn(`Eppo SDK encountered an error polling configurations: ${error.message}`);
       const maxTries = 1 + (options?.maxPollRetries ?? DEFAULT_POLL_CONFIG_REQUEST_RETRIES);
diff --git a/tsconfig.json b/tsconfig.json
@@ -8,7 +8,7 @@
     "target": "es2017",
     "outDir": "dist",
     "noImplicitAny": true,
-    "strictNullChecks": true,
+    "strict": true,
     "strictPropertyInitialization": true
   },
   "include": ["src/**/*.ts"],
diff --git a/yarn.lock b/yarn.lock
@@ -1500,9 +1500,9 @@ create-require@^1.1.0:
   integrity sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==
 
 cross-spawn@^7.0.2, cross-spawn@^7.0.3:
-  version "7.0.3"
-  resolved "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz"
-  integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==
+  version "7.0.6"
+  resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.6.tgz#8a58fe78f00dcd70c370451759dfbfaf03e8ee9f"
+  integrity sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==
   dependencies:
     path-key "^3.1.0"
     shebang-command "^2.0.0"

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Eppo JS Common SDK for library`
	`1`	`+# Common library for Eppo's JavasScript SDK`
`2`	`2`
`3`	`3`	`[![](https://img.shields.io/npm/v/@eppo/js-client-sdk-common)](https://www.npmjs.com/package/@eppo/js-client-sdk-common)`
`4`	`4`	`[![](https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8)](https://eppo-exp.github.io/js-client-sdk/js-client-sdk-common.html)`
Original file line number	Diff line number	Diff line change
`@@ -72,5 +72,6 @@`
`72`	`72`	`"md5": "^2.3.0",`
`73`	`73`	`"pino": "^8.19.0",`
`74`	`74`	`"semver": "^7.5.4"`
`75`		`- }`
	`75`	`+ },`
	`76`	`+ "packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"`
`76`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,8 @@ export interface BanditEvaluation {`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`export class BanditEvaluator {`
`23`		`- private assignmentShards = BANDIT_ASSIGNMENT_SHARDS; // We just hard code this for now`
`24`		`- private sharder: Sharder = new MD5Sharder();`
	`23`	`+ private readonly assignmentShards = BANDIT_ASSIGNMENT_SHARDS; // We just hard code this for now`
	`24`	`+ private readonly sharder: Sharder = new MD5Sharder();`
`25`	`25`
`26`	`26`	`public evaluateBandit(`
`27`	`27`	`flagKey: string,`