chore: tsc strict, CI test matrix (#101)

felipecsl · web-flow · commit ba443c261fca · 2024-11-20T14:37:04.000-08:00
* chore: tsc strict, CI test matrix

* minor cleanup

* braces
diff --git a/.github/workflows/lint-test-sdk.yml b/.github/workflows/lint-test-sdk.yml
@@ -21,28 +21,34 @@ on:
 env:
   SDK_BRANCH_NAME: ${{ inputs.sdk_branch  || github.head_ref || github.ref_name || 'main' }}
   TEST_DATA_BRANCH_NAME: ${{ inputs.test_data_branch || 'main' }}
-        
+
 jobs:
   lint-test-sdk:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ '18', '20', '22', '23' ]
     steps:
       - name: Display Testing Details
         run: |
           echo "Running SDK Test using"
           echo "Test Data: sdk-test-data@${TEST_DATA_BRANCH_NAME}"
           echo "SDK Branch: js-client-sdk@${SDK_BRANCH_NAME}"
-      - uses: actions/checkout@v2
-        with:
-          repository: Eppo-exp/js-client-sdk
-          ref: ${{ env.SDK_BRANCH_NAME }}
+      - uses: actions/checkout@v3
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        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: ./
@@ -54,19 +60,25 @@ jobs:
         working-directory: ./
   typecheck:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ '18', '20', '22', '23' ]
     steps:
-      - uses: actions/checkout@v2
-        with:
-          repository: Eppo-exp/js-client-sdk
-          ref: ${{ env.SDK_BRANCH_NAME }}
+      - uses: actions/checkout@v3
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        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/package.json b/package.json
@@ -60,5 +60,6 @@
   },
   "dependencies": {
     "@eppo/js-client-sdk-common": "4.3.0"
-  }
-}
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}
diff --git a/src/cache/local-storage-assignment-cache.ts b/src/cache/local-storage-assignment-cache.ts
@@ -1,8 +1,7 @@
 import { AbstractAssignmentCache } from '@eppo/js-client-sdk-common';
 
-import { hasWindowLocalStorage } from '../configuration-factory';
-
 import { BulkReadAssignmentCache, BulkWriteAssignmentCache } from './hybrid-assignment-cache';
+import { LocalStorageAssignmentShim } from './local-storage-assignment-shim';
 
 export class LocalStorageAssignmentCache
   extends AbstractAssignmentCache<LocalStorageAssignmentShim>
@@ -24,74 +23,3 @@ export class LocalStorageAssignmentCache
     return Promise.resolve(Array.from(this.entries()));
   }
 }
-
-// noinspection JSUnusedGlobalSymbols (methods are used by common repository)
-class LocalStorageAssignmentShim implements Map<string, string> {
-  private readonly localStorageKey: string;
-
-  public constructor(storageKeySuffix: string) {
-    if (!hasWindowLocalStorage()) {
-      throw new Error('LocalStorage is not available');
-    }
-    const keySuffix = storageKeySuffix ? `-${storageKeySuffix}` : '';
-    this.localStorageKey = `eppo-assignment${keySuffix}`;
-  }
-
-  clear(): void {
-    this.getCache().clear();
-  }
-
-  delete(key: string): boolean {
-    return this.getCache().delete(key);
-  }
-
-  forEach(
-    callbackfn: (value: string, key: string, map: Map<string, string>) => void,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    thisArg?: any,
-  ): void {
-    this.getCache().forEach(callbackfn, thisArg);
-  }
-
-  size: number;
-
-  entries(): IterableIterator<[string, string]> {
-    return this.getCache().entries();
-  }
-
-  keys(): IterableIterator<string> {
-    return this.getCache().keys();
-  }
-
-  values(): IterableIterator<string> {
-    return this.getCache().values();
-  }
-
-  [Symbol.iterator](): IterableIterator<[string, string]> {
-    return this.getCache()[Symbol.iterator]();
-  }
-
-  [Symbol.toStringTag]: string;
-
-  public has(key: string): boolean {
-    return this.getCache().has(key);
-  }
-
-  public get(key: string): string | undefined {
-    return this.getCache().get(key) ?? undefined;
-  }
-
-  public set(key: string, value: string): this {
-    return this.setCache(this.getCache().set(key, value));
-  }
-
-  private getCache(): Map<string, string> {
-    const cache = window.localStorage.getItem(this.localStorageKey);
-    return cache ? new Map(JSON.parse(cache)) : new Map();
-  }
-
-  private setCache(cache: Map<string, string>): this {
-    window.localStorage.setItem(this.localStorageKey, JSON.stringify(Array.from(cache.entries())));
-    return this;
-  }
-}
diff --git a/src/cache/local-storage-assignment-shim.ts b/src/cache/local-storage-assignment-shim.ts
@@ -0,0 +1,72 @@
+// noinspection JSUnusedGlobalSymbols (methods are used by common repository)
+import { hasWindowLocalStorage } from '../configuration-factory';
+
+export class LocalStorageAssignmentShim implements Map<string, string> {
+  private readonly localStorageKey: string;
+
+  public constructor(storageKeySuffix: string) {
+    if (!hasWindowLocalStorage()) {
+      throw new Error('LocalStorage is not available');
+    }
+    const keySuffix = storageKeySuffix ? `-${storageKeySuffix}` : '';
+    this.localStorageKey = `eppo-assignment${keySuffix}`;
+  }
+
+  clear(): void {
+    this.getCache().clear();
+  }
+
+  delete(key: string): boolean {
+    return this.getCache().delete(key);
+  }
+
+  forEach(
+    callbackfn: (value: string, key: string, map: Map<string, string>) => void,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    thisArg?: any,
+  ): void {
+    this.getCache().forEach(callbackfn, thisArg);
+  }
+
+  size: number = this.getCache().size;
+
+  entries(): IterableIterator<[string, string]> {
+    return this.getCache().entries();
+  }
+
+  keys(): IterableIterator<string> {
+    return this.getCache().keys();
+  }
+
+  values(): IterableIterator<string> {
+    return this.getCache().values();
+  }
+
+  [Symbol.iterator](): IterableIterator<[string, string]> {
+    return this.getCache()[Symbol.iterator]();
+  }
+
+  [Symbol.toStringTag]: string = this.getCache()[Symbol.toStringTag];
+
+  public has(key: string): boolean {
+    return this.getCache().has(key);
+  }
+
+  public get(key: string): string | undefined {
+    return this.getCache().get(key) ?? undefined;
+  }
+
+  public set(key: string, value: string): this {
+    return this.setCache(this.getCache().set(key, value));
+  }
+
+  private getCache(): Map<string, string> {
+    const cache = window.localStorage.getItem(this.localStorageKey);
+    return cache ? new Map(JSON.parse(cache)) : new Map();
+  }
+
+  private setCache(cache: Map<string, string>): this {
+    window.localStorage.setItem(this.localStorageKey, JSON.stringify(Array.from(cache.entries())));
+    return this;
+  }
+}
diff --git a/src/index.ts b/src/index.ts
@@ -401,8 +401,21 @@ export async function init(config: IClientConfig): Promise<EppoClient> {
   validation.validateNotBlank(config.apiKey, 'API key required');
   let initializationError: Error | undefined;
   const instance = EppoJSClient.instance;
-  const { apiKey, persistentStore, baseUrl, maxCacheAgeSeconds, updateOnFetch, forceReinitialize } =
-    config;
+  const {
+    apiKey,
+    persistentStore,
+    baseUrl,
+    maxCacheAgeSeconds,
+    updateOnFetch,
+    forceReinitialize,
+    requestTimeoutMs,
+    numInitialRequestRetries,
+    numPollRequestRetries,
+    pollingIntervalMs,
+    pollAfterSuccessfulInitialization = false,
+    pollAfterFailedInitialization = false,
+    skipInitialRequest = false,
+  } = config;
   try {
     if (EppoJSClient.initialized) {
       if (forceReinitialize) {
@@ -461,14 +474,14 @@ export async function init(config: IClientConfig): Promise<EppoClient> {
       sdkName,
       sdkVersion,
       baseUrl,
-      requestTimeoutMs: config.requestTimeoutMs ?? undefined,
-      numInitialRequestRetries: config.numInitialRequestRetries ?? undefined,
-      numPollRequestRetries: config.numPollRequestRetries ?? undefined,
-      pollAfterSuccessfulInitialization: config.pollAfterSuccessfulInitialization ?? false,
-      pollAfterFailedInitialization: config.pollAfterFailedInitialization ?? false,
-      pollingIntervalMs: config.pollingIntervalMs ?? undefined,
+      requestTimeoutMs,
+      numInitialRequestRetries,
+      numPollRequestRetries,
+      pollAfterSuccessfulInitialization,
+      pollAfterFailedInitialization,
+      pollingIntervalMs,
       throwOnFailedInitialization: true, // always use true here as underlying instance fetch is surrounded by try/catch
-      skipInitialPoll: config.skipInitialRequest ?? false,
+      skipInitialPoll: skipInitialRequest,
     };
     instance.setConfigurationRequestParameters(requestConfiguration);
 
@@ -504,9 +517,7 @@ export async function init(config: IClientConfig): Promise<EppoClient> {
       });
     const attemptInitFromFetch = instance
       .fetchFlagConfigurations()
-      .then(() => {
-        return 'fetch';
-      })
+      .then(() => 'fetch')
       .catch((e) => {
         applicationLogger.warn('Eppo SDK encountered an error initializing from fetching', e);
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -531,7 +542,7 @@ export async function init(config: IClientConfig): Promise<EppoClient> {
       // both failed, make the "fatal" error the fetch one
       initializationError = initFromFetchError;
     }
-  } catch (error) {
+  } catch (error: any) {
     initializationError = error;
   }
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -8,7 +8,7 @@
     "target": "es2017",
     "outDir": "dist",
     "noImplicitAny": true,
-    "strictNullChecks": true
+    "strict": true
   },
   "include": [
     "src/**/*.ts"
@@ -19,4 +19,4 @@
     "src/**/*.spec.ts",
     "test/**/*"
   ]
-}
+}

-Original file line number
+Diff line change
   },
   "dependencies": {
     "@eppo/js-client-sdk-common": "4.3.0"
 -  }
 -}
 +  },
 +  "packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 +}