Clean up LDClient implementation and add eventsUri option

Author: ldhenry

packages/sdk/fastly/__tests__/api/LDClient.test.ts

@@ -17,17 +17,18 @@ jest.mock('@launchdarkly/js-sdk-common', () => {
   };
 });
 
-const mockEventProcessor = internal.EventProcessor as jest.Mock;
+let mockEventProcessor = internal.EventProcessor as jest.Mock;
+beforeEach(() => {
+  mockEventProcessor = internal.EventProcessor as jest.Mock;
+  mockEventProcessor.mockClear();
+});
+
 describe('Edge LDClient', () => {
   it('uses clientSideID endpoints', async () => {
-    const client = new LDClient(
-      'client-side-id',
-      createBasicPlatform().info,
-      {
-        sendEvents: true,
-      },
-      'launchdarkly',
-    );
+    const client = new LDClient('client-side-id', createBasicPlatform().info, {
+      sendEvents: true,
+      eventsBackendName: 'launchdarkly',
+    });
     await client.waitForInitialization({ timeout: 10 });
     const passedConfig = mockEventProcessor.mock.calls[0][0];
 
@@ -43,4 +44,25 @@ describe('Edge LDClient', () => {
       },
     });
   });
+  it('uses custom eventsUri when specified', async () => {
+    const client = new LDClient('client-side-id', createBasicPlatform().info, {
+      sendEvents: true,
+      eventsBackendName: 'launchdarkly',
+      eventsUri: 'https://custom-base-uri.launchdarkly.com',
+    });
+    await client.waitForInitialization({ timeout: 10 });
+    const passedConfig = mockEventProcessor.mock.calls[0][0];
+
+    expect(passedConfig).toMatchObject({
+      sendEvents: true,
+      serviceEndpoints: {
+        includeAuthorizationHeader: false,
+        analyticsEventPath: '/events/bulk/client-side-id',
+        diagnosticEventPath: '/events/diagnostic/client-side-id',
+        events: 'https://custom-base-uri.launchdarkly.com',
+        polling: 'https://custom-base-uri.launchdarkly.com',
+        streaming: 'https://stream.launchdarkly.com',
+      },
+    });
+  });
 });

packages/sdk/fastly/src/api/LDClient.ts

@@ -1,23 +1,30 @@
-import { Info, internal, LDClientImpl, LDOptions } from '@launchdarkly/js-server-sdk-common';
+import { Info, internal, LDClientImpl } from '@launchdarkly/js-server-sdk-common';
 
 import EdgePlatform from '../platform';
+import { FastlySDKOptions } from '../utils/validateOptions';
 import createCallbacks from './createCallbacks';
 import createOptions from './createOptions';
 
+export const DEFAULT_EVENTS_BACKEND_NAME = 'launchdarkly';
+
 /**
  * The LaunchDarkly SDK edge client object.
  */
 export default class LDClient extends LDClientImpl {
   // clientSideID is only used to query the edge key-value store and send analytics, not to initialize with LD servers
-  constructor(clientSideID: string, platformInfo: Info, options: LDOptions, eventsBackend: string) {
-    const platform = new EdgePlatform(platformInfo, eventsBackend);
+  constructor(clientSideID: string, platformInfo: Info, options: FastlySDKOptions) {
+    const { eventsBackendName, ...ldOptions } = options;
+    const platform = new EdgePlatform(
+      platformInfo,
+      eventsBackendName || DEFAULT_EVENTS_BACKEND_NAME,
+    );
     const internalOptions: internal.LDInternalOptions = {
       analyticsEventPath: `/events/bulk/${clientSideID}`,
       diagnosticEventPath: `/events/diagnostic/${clientSideID}`,
       includeAuthorizationHeader: false,
     };
 
-    const finalOptions = createOptions(options);
+    const finalOptions = createOptions(ldOptions);
 
     super(clientSideID, platform, finalOptions, createCallbacks(), internalOptions);
   }

packages/sdk/fastly/src/api/createOptions.ts

@@ -10,6 +10,12 @@ export const defaultOptions: LDOptions = {
 
 const createOptions = (options: LDOptions) => {
   const finalOptions = { ...defaultOptions, ...options };
+
+  // The Fastly SDK does not poll LaunchDarkly for updates, so a custom baseUri does not make sense. However, we need
+  // to set it to something when a custom eventsUri is specified in order to pass validation in sdk-server-common.
+  if (finalOptions.eventsUri) {
+    finalOptions.baseUri = finalOptions.eventsUri;
+  }
   finalOptions.logger?.debug(`Using LD options: ${JSON.stringify(finalOptions)}`);
   return finalOptions;
 };

packages/sdk/fastly/src/index.ts

@@ -1,20 +1,12 @@
 /// <reference types="@fastly/js-compute" />
 import { KVStore } from 'fastly:kv-store';
 
-import { BasicLogger, LDOptions } from '@launchdarkly/js-server-sdk-common';
+import { BasicLogger } from '@launchdarkly/js-server-sdk-common';
 
 import { EdgeFeatureStore, EdgeProvider, LDClient } from './api';
+import { DEFAULT_EVENTS_BACKEND_NAME } from './api/LDClient';
 import createPlatformInfo from './createPlatformInfo';
-import validateOptions from './utils/validateOptions';
-
-const DEFAULT_EVENTS_BACKEND_NAME = 'launchdarkly';
-
-export type FastlySDKOptions = LDOptions & {
-  /**
-   * The Fastly Backend name to send LaunchDarkly events. Backends are configured using the Fastly service backend configuration. This option can be ignored if the `sendEvents` option is set to `false`. See [Fastly's Backend documentation](https://developer.fastly.com/reference/api/services/backend/) for more information. The default value is `launchdarkly`.
-   */
-  eventsBackendName?: string;
-};
+import validateOptions, { FastlySDKOptions } from './utils/validateOptions';
 
 export const init = (
   sdkKey: string,
@@ -30,19 +22,12 @@ export const init = (
     },
   };
 
-  const { eventsBackendName, ...ldOptions } = options;
-
   const finalOptions = {
     featureStore: new EdgeFeatureStore(edgeProvider, sdkKey, 'Fastly', logger),
     logger,
-    ...ldOptions,
+    ...options,
   };
 
   validateOptions(sdkKey, finalOptions);
-  return new LDClient(
-    sdkKey,
-    createPlatformInfo(),
-    finalOptions,
-    eventsBackendName || DEFAULT_EVENTS_BACKEND_NAME,
-  );
+  return new LDClient(sdkKey, createPlatformInfo(), finalOptions);
 };

packages/sdk/fastly/src/utils/validateOptions.ts

@@ -1,20 +1,23 @@
 import { LDOptions as LDOptionsCommon } from '@launchdarkly/js-server-sdk-common';
 
 /**
- * The Launchdarkly Edge SDKs configuration options. Only logger is officially
- * supported. sendEvents is unsupported and is only included as a beta
- * preview.
+ * The Launchdarkly Fastly Compute SDK configuration options.
  */
-export type LDOptions = Pick<LDOptionsCommon, 'logger' | 'sendEvents'>;
+export type FastlySDKOptions = Pick<LDOptionsCommon, 'logger' | 'sendEvents' | 'eventsUri'> & {
+  /**
+   * The Fastly Backend name to send LaunchDarkly events. Backends are configured using the Fastly service backend configuration. This option can be ignored if the `sendEvents` option is set to `false`. See [Fastly's Backend documentation](https://developer.fastly.com/reference/api/services/backend/) for more information. The default value is `launchdarkly`.
+   */
+  eventsBackendName?: string;
+};
 
 /**
  * The internal options include featureStore because that's how the LDClient
  * implementation expects it.
  */
-export type LDOptionsInternal = LDOptions & Pick<LDOptionsCommon, 'featureStore'>;
+export type LDOptionsInternal = FastlySDKOptions & Pick<LDOptionsCommon, 'featureStore'>;
 
 const validateOptions = (sdkKey: string, options: LDOptionsInternal) => {
-  const { featureStore, logger, sendEvents, ...rest } = options;
+  const { eventsBackendName, featureStore, logger, sendEvents, ...rest } = options;
   if (!sdkKey) {
     throw new Error('You must configure the client with a client key');
   }