feat: add fetch options with flag keys option (#23)

amplitude · Jul 19, 2023 · 0d9d901 · 0d9d901
1 parent 17c64e1
commit 0d9d901
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 7 deletions.
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -14,6 +14,7 @@ export {
   RemoteEvaluationDefaults,
 } from './types/config';
 export { Experiment } from './factory';
+export { FetchOptions } from './types/fetch';
 export { ExperimentUser } from './types/user';
 export { Variant, Variants } from './types/variant';
 export { LocalEvaluationClient } from './local/client';

diff --git a/packages/node/src/remote/client.ts b/packages/node/src/remote/client.ts
@@ -5,6 +5,7 @@ import {
   RemoteEvaluationDefaults,
   RemoteEvaluationConfig,
 } from '../types/config';
+import { FetchOptions } from '../types/fetch';
 import { HttpClient } from '../types/transport';
 import { ExperimentUser } from '../types/user';
 import { Variant, Variants } from '../types/variant';
@@ -37,32 +38,39 @@ export class RemoteEvaluationClient {
    * This method will automatically retry if configured (default).
    *
    * @param user The {@link ExperimentUser} context
+   * @param options The {@link FetchOptions} for this specific fetch request.
    * @return The {@link Variants} for the user on success, empty
    * {@link Variants} on error.
    */
-  public async fetch(user: ExperimentUser): Promise<Variants> {
+  public async fetch(
+    user: ExperimentUser,
+    options?: FetchOptions,
+  ): Promise<Variants> {
     if (!this.apiKey) {
       throw Error('Experiment API key is empty');
     }
     try {
-      return await this.fetchInternal(user);
+      return await this.fetchInternal(user, options);
     } catch (e) {
       console.error('[Experiment] Failed to fetch variants: ', e);
       return {};
     }
   }
 
-  private async fetchInternal(user: ExperimentUser): Promise<Variants> {
+  private async fetchInternal(
+    user: ExperimentUser,
+    options?: FetchOptions,
+  ): Promise<Variants> {
     if (!this.apiKey) {
       throw Error('Experiment API key is empty');
     }
     this.debug('[Experiment] Fetching variants for user: ', user);
     try {
-      return await this.doFetch(user, this.config.fetchTimeoutMillis);
+      return await this.doFetch(user, this.config.fetchTimeoutMillis, options);
     } catch (e) {
       console.error('[Experiment] Fetch failed: ', e);
       try {
-        return await this.retryFetch(user);
+        return await this.retryFetch(user, options);
       } catch (e) {
         console.error(e);
       }
@@ -73,6 +81,7 @@ export class RemoteEvaluationClient {
   private async doFetch(
     user: ExperimentUser,
     timeoutMillis: number,
+    options?: FetchOptions,
   ): Promise<Variants> {
     const userContext = this.addContext(user || {});
     const endpoint = `${this.config.serverUrl}/sdk/vardata`;
@@ -83,6 +92,11 @@ export class RemoteEvaluationClient {
       Authorization: `Api-Key ${this.apiKey}`,
       'X-Amp-Exp-User': encodedUser,
     };
+    if (options && options.flagKeys) {
+      headers['X-Amp-Exp-Flag-Keys'] = Buffer.from(
+        JSON.stringify(options.flagKeys),
+      ).toString('base64url');
+    }
     this.debug('[Experiment] Fetch variants for user: ', userContext);
     const response = await this.httpClient.request(
       endpoint,
@@ -102,7 +116,10 @@ export class RemoteEvaluationClient {
     return variants;
   }
 
-  private async retryFetch(user: ExperimentUser): Promise<Variants> {
+  private async retryFetch(
+    user: ExperimentUser,
+    options?: FetchOptions,
+  ): Promise<Variants> {
     if (this.config.fetchRetries == 0) {
       return {};
     }
@@ -112,7 +129,11 @@ export class RemoteEvaluationClient {
     for (let i = 0; i < this.config.fetchRetries; i++) {
       await sleep(delayMillis);
       try {
-        return await this.doFetch(user, this.config.fetchRetryTimeoutMillis);
+        return await this.doFetch(
+          user,
+          this.config.fetchRetryTimeoutMillis,
+          options,
+        );
       } catch (e) {
         console.error('[Experiment] Retry falied: ', e);
         err = e;

diff --git a/packages/node/src/types/fetch.ts b/packages/node/src/types/fetch.ts
@@ -0,0 +1,9 @@
+/**
+ * Options to modify the behavior of a remote evaluation fetch request.
+ */
+export type FetchOptions = {
+  /**
+   * Specific flag keys to evaluate and set variants for.
+   */
+  flagKeys?: string[];
+};
diff --git a/packages/node/test/remote/client.test.ts b/packages/node/test/remote/client.test.ts
@@ -42,3 +42,11 @@ test('ExperimentClient.fetch, retry once, timeout first then succeed with 0 back
   const variant = variants['sdk-ci-test'];
   expect(variant).toEqual({ value: 'on', payload: 'payload' });
 });
+
+test('ExperimentClient.fetch, with flag keys options, success', async () => {
+  const client = new RemoteEvaluationClient(API_KEY, {});
+  const variants = await client.fetch(testUser, { flagKeys: ['sdk-ci-test'] });
+  expect(variants).toEqual({
+    'sdk-ci-test': { value: 'on', payload: 'payload' },
+  });
+});