refactor: make it a builder

Author: joker23

packages/sdk/browser/contract-tests/entity/src/ClientEntity.ts

@@ -1,28 +1,22 @@
 import {
   createClient,
   InitializerEntry,
-  LDClient,
-  LDLogger,
   LDOptions,
   ModeDefinition,
   SynchronizerEntry,
 } from '@launchdarkly/js-client-sdk';
 import {
-  CommandParams,
-  CommandType,
+  ClientEntity,
   CreateInstanceParams,
-  makeLogger,
+  IClientEntity,
+  makeDefaultInitialContext,
+  makeSdkConfig,
   SDKConfigDataInitializer,
   SDKConfigDataSynchronizer,
   SDKConfigModeDefinition,
   SDKConfigParams,
-  ClientSideTestHook as TestHook,
-  ValueType,
 } from '@launchdarkly/js-contract-test-utils/client';
 
-export const badCommandError = new Error('unsupported command');
-export const malformedCommand = new Error('command was malformed');
-
 function translateInitializer(init: SDKConfigDataInitializer): InitializerEntry | undefined {
   if (init.polling) {
     return {
@@ -76,25 +70,15 @@ function translateModeDefinition(modeDef: SDKConfigModeDefinition): ModeDefiniti
   return { initializers, synchronizers };
 }
 
-function makeSdkConfig(options: SDKConfigParams, tag: string) {
-  if (!options.clientSide) {
-    throw new Error('configuration did not include clientSide options');
-  }
-
+/**
+ * Browser-specific makeSdkConfig that wraps the shared base config with
+ * FDv2 data system translation and browser-specific options.
+ */
+function makeBrowserSdkConfig(options: SDKConfigParams, tag: string): LDOptions {
   const isSet = (x?: unknown) => x !== null && x !== undefined;
-  const maybeTime = (seconds?: number) => (isSet(seconds) ? seconds / 1000 : undefined);
+  const maybeTime = (seconds?: number) => (isSet(seconds) ? seconds! / 1000 : undefined);
 
-  const cf: LDOptions = {
-    withReasons: options.clientSide.evaluationReasons,
-    logger: makeLogger(`${tag}.sdk`),
-    useReport: options.clientSide.useReport ?? undefined,
-  };
-
-  if (options.serviceEndpoints) {
-    cf.streamUri = options.serviceEndpoints.streaming;
-    cf.baseUri = options.serviceEndpoints.polling;
-    cf.eventsUri = options.serviceEndpoints.events;
-  }
+  const cf = { ...makeSdkConfig(options, tag), fetchGoals: false } as LDOptions;
 
   if (options.dataSystem?.payloadFilter) {
     cf.payloadFilterKey = options.dataSystem.payloadFilter;
@@ -136,189 +120,33 @@ function makeSdkConfig(options: SDKConfigParams, tag: string) {
     }
 
     (cf as any).dataSystem = dataSystem;
-  } else {
-    if (options.polling) {
-      if (options.polling.baseUri) {
-        cf.baseUri = options.polling.baseUri;
-      }
-    }
-
-    if (options.streaming) {
-      if (options.streaming.baseUri) {
-        cf.streamUri = options.streaming.baseUri;
-      }
-      cf.streaming = true;
-      cf.streamInitialReconnectDelay = maybeTime(options.streaming.initialRetryDelayMs);
-    }
   }
 
-  if (options.events) {
-    if (options.events.baseUri) {
-      cf.eventsUri = options.events.baseUri;
-    }
-    cf.allAttributesPrivate = options.events.allAttributesPrivate;
-    cf.capacity = options.events.capacity;
-    cf.diagnosticOptOut = !options.events.enableDiagnostics;
-    cf.flushInterval = maybeTime(options.events.flushIntervalMs);
-    cf.privateAttributes = options.events.globalPrivateAttributes;
-  } else {
-    cf.sendEvents = false;
-  }
-
-  if (options.tags) {
-    cf.applicationInfo = {
-      id: options.tags.applicationId,
-      version: options.tags.applicationVersion,
-    };
-  }
-
-  if (options.hooks) {
-    cf.hooks = options.hooks.hooks.map(
-      (hook) => new TestHook(hook.name, hook.callbackUri, hook.data, hook.errors),
-    );
-  }
-
-  cf.fetchGoals = false;
-
   return cf;
 }
 
-function makeDefaultInitialContext() {
-  return { kind: 'user', key: 'key-not-specified' };
-}
-
-export class ClientEntity {
-  constructor(
-    private readonly _client: LDClient,
-    private readonly _logger: LDLogger,
-  ) {}
-
-  close() {
-    this._client.close();
-    this._logger.info('Test ended');
-  }
-
-  async doCommand(params: CommandParams) {
-    this._logger.info(`Received command: ${params.command}`);
-    switch (params.command) {
-      case CommandType.EvaluateFlag: {
-        const evaluationParams = params.evaluate;
-        if (!evaluationParams) {
-          throw malformedCommand;
-        }
-        if (evaluationParams.detail) {
-          switch (evaluationParams.valueType) {
-            case ValueType.Bool:
-              return this._client.boolVariationDetail(
-                evaluationParams.flagKey,
-                evaluationParams.defaultValue as boolean,
-              );
-            case ValueType.Int: // Intentional fallthrough.
-            case ValueType.Double:
-              return this._client.numberVariationDetail(
-                evaluationParams.flagKey,
-                evaluationParams.defaultValue as number,
-              );
-            case ValueType.String:
-              return this._client.stringVariationDetail(
-                evaluationParams.flagKey,
-                evaluationParams.defaultValue as string,
-              );
-            default:
-              return this._client.variationDetail(
-                evaluationParams.flagKey,
-                evaluationParams.defaultValue,
-              );
-          }
-        }
-        switch (evaluationParams.valueType) {
-          case ValueType.Bool:
-            return {
-              value: this._client.boolVariation(
-                evaluationParams.flagKey,
-                evaluationParams.defaultValue as boolean,
-              ),
-            };
-          case ValueType.Int: // Intentional fallthrough.
-          case ValueType.Double:
-            return {
-              value: this._client.numberVariation(
-                evaluationParams.flagKey,
-                evaluationParams.defaultValue as number,
-              ),
-            };
-          case ValueType.String:
-            return {
-              value: this._client.stringVariation(
-                evaluationParams.flagKey,
-                evaluationParams.defaultValue as string,
-              ),
-            };
-          default:
-            return {
-              value: this._client.variation(
-                evaluationParams.flagKey,
-                evaluationParams.defaultValue,
-              ),
-            };
-        }
-      }
-
-      case CommandType.EvaluateAllFlags:
-        return { state: this._client.allFlags() };
-
-      case CommandType.IdentifyEvent: {
-        const identifyParams = params.identifyEvent;
-        if (!identifyParams) {
-          throw malformedCommand;
-        }
-        await this._client.identify(identifyParams.user || identifyParams.context);
-        return undefined;
-      }
-
-      case CommandType.CustomEvent: {
-        const customEventParams = params.customEvent;
-        if (!customEventParams) {
-          throw malformedCommand;
-        }
-        this._client.track(
-          customEventParams.eventKey,
-          customEventParams.data,
-          customEventParams.metricValue,
-        );
-        return undefined;
-      }
-
-      case CommandType.FlushEvents:
-        this._client.flush();
-        return undefined;
-
-      default:
-        throw badCommandError;
-    }
-  }
-}
-
-export async function newSdkClientEntity(options: CreateInstanceParams) {
-  const logger = makeLogger(options.tag);
-
-  logger.info(`Creating client with configuration: ${JSON.stringify(options.configuration)}`);
-
+export async function newSdkClientEntity(
+  _id: string,
+  options: CreateInstanceParams,
+): Promise<IClientEntity> {
   const timeout =
     options.configuration.startWaitTimeMs !== null &&
     options.configuration.startWaitTimeMs !== undefined
       ? options.configuration.startWaitTimeMs
       : 5000;
-  const sdkConfig = makeSdkConfig(options.configuration, options.tag);
+
+  const sdkConfig = makeBrowserSdkConfig(options.configuration, options.tag);
   const initialContext =
     options.configuration.clientSide?.initialUser ||
     options.configuration.clientSide?.initialContext ||
     makeDefaultInitialContext();
+
   const client = createClient(
     options.configuration.credential || 'unknown-env-id',
     initialContext,
     sdkConfig,
   );
+
   let failed = false;
   try {
     await Promise.race([
@@ -328,13 +156,12 @@ export async function newSdkClientEntity(options: CreateInstanceParams) {
       }),
     ]);
   } catch (_) {
-    // we get here if waitForInitialization() rejects or if we timed out
     failed = true;
   }
   if (failed && !options.configuration.initCanFail) {
     client.close();
     throw new Error('client initialization failed');
   }
 
-  return new ClientEntity(client, logger);
+  return new ClientEntity(client, options.tag);
 }

packages/sdk/browser/contract-tests/entity/src/TestHarnessWebSocket.ts

@@ -1,22 +1,25 @@
-import { TestHarnessWebSocket as BaseTestHarnessWebSocket } from '@launchdarkly/js-contract-test-utils/client';
+import {
+  CLIENT_SIDE_CAPABILITIES,
+  IClientEntity,
+  TestHarnessWebSocketBuilder,
+} from '@launchdarkly/js-contract-test-utils/client';
 
 import { newSdkClientEntity } from './ClientEntity';
 
-const CAPABILITIES = [
-  'client-side',
-  'service-endpoints',
-  'tags',
-  'user-type',
-  'inline-context-all',
-  'anonymous-redaction',
-  'strongly-typed',
-  'client-prereq-events',
-  'client-per-context-summaries',
-  'track-hooks',
-];
+export function createTestHarnessWebSocket() {
+  const entities = new Map<string, IClientEntity>();
 
-export default class TestHarnessWebSocket extends BaseTestHarnessWebSocket {
-  constructor(url: string) {
-    super(url, CAPABILITIES, newSdkClientEntity);
-  }
+  return new TestHarnessWebSocketBuilder()
+    .setCapabilities(CLIENT_SIDE_CAPABILITIES)
+    .onCreateClient(async (id, params) => {
+      const entity = await newSdkClientEntity(id, params);
+      entities.set(id, entity);
+      return entity;
+    })
+    .onGetClient((id) => entities.get(id))
+    .onDeleteClient((id) => {
+      entities.get(id)?.close();
+      entities.delete(id);
+    })
+    .build();
 }

packages/sdk/browser/contract-tests/entity/src/main.ts

@@ -1,9 +1,9 @@
 // eslint-disable-next-line prettier/prettier
 import './style.css';
-import TestHarnessWebSocket from './TestHarnessWebSocket';
+import { createTestHarnessWebSocket } from './TestHarnessWebSocket';
 
 async function runContractTests() {
-  const ws = new TestHarnessWebSocket('ws://localhost:8001');
+  const ws = createTestHarnessWebSocket();
   ws.connect();
 }
 

packages/sdk/react-native/contract-tests/entity/App.tsx

@@ -1,23 +1,16 @@
 import React, { useEffect, useState } from 'react';
 import { StyleSheet, Text, View } from 'react-native';
 
-import { TestHarnessWebSocket } from '@launchdarkly/js-contract-test-utils/client';
+import {
+  Capability,
+  CLIENT_SIDE_CAPABILITIES,
+  IClientEntity,
+  TestHarnessWebSocketBuilder,
+} from '@launchdarkly/js-contract-test-utils/client';
 
 import { newSdkClientEntity } from './src/ClientEntity';
 
-const RN_CAPABILITIES = [
-  'client-side',
-  'mobile',
-  'service-endpoints',
-  'tags',
-  'user-type',
-  'inline-context-all',
-  'anonymous-redaction',
-  'strongly-typed',
-  'client-prereq-events',
-  'client-per-context-summaries',
-  'track-hooks',
-];
+const RN_CAPABILITIES: Capability[] = [...CLIENT_SIDE_CAPABILITIES, 'mobile'];
 
 const styles = StyleSheet.create({
   container: {
@@ -40,12 +33,21 @@ export default function App() {
   const [connected, setConnected] = useState(false);
 
   useEffect(() => {
-    const ws = new TestHarnessWebSocket(
-      'ws://localhost:8001',
-      RN_CAPABILITIES,
-      newSdkClientEntity,
-      setConnected,
-    );
+    const entities = new Map<string, IClientEntity>();
+    const ws = new TestHarnessWebSocketBuilder()
+      .setCapabilities(RN_CAPABILITIES)
+      .onCreateClient(async (id, params) => {
+        const entity = await newSdkClientEntity(id, params);
+        entities.set(id, entity);
+        return entity;
+      })
+      .onGetClient((id) => entities.get(id))
+      .onDeleteClient((id) => {
+        entities.get(id)?.close();
+        entities.delete(id);
+      })
+      .onConnectionChange(setConnected)
+      .build();
     ws.connect();
     return () => ws.disconnect();
   }, []);