chore: removing setInitialContext

Author: joker23

packages/sdk/browser/src/BrowserClient.ts

@@ -45,6 +45,7 @@ class BrowserClientImpl extends LDClientImpl {
 
   constructor(
     clientSideId: string,
+    initialContext: LDContext,
     autoEnvAttributes: AutoEnvAttributes,
     options: BrowserOptions = {},
     overridePlatform?: Platform,
@@ -150,6 +151,7 @@ class BrowserClientImpl extends LDClientImpl {
         internal.safeGetHooks(logger, environmentMetadata, validatedBrowserOptions.plugins),
       credentialType: 'clientSideId',
       requiresStart: true,
+      initialContext,
     });
 
     this.setEventSendingEnabled(true, false);
@@ -291,8 +293,13 @@ export function makeClient(
   options: BrowserOptions = {},
   overridePlatform?: Platform,
 ): LDClient {
-  const impl = new BrowserClientImpl(clientSideId, autoEnvAttributes, options, overridePlatform);
-  impl.setInitialContext(initialContext);
+  const impl = new BrowserClientImpl(
+    clientSideId,
+    initialContext,
+    autoEnvAttributes,
+    options,
+    overridePlatform,
+  );
 
   // Return a PIMPL style implementation. This decouples the interface from the interface of the implementation.
   // In the future we should consider updating the common SDK code to not use inheritance and instead compose

packages/sdk/electron/src/ElectronClient.ts

@@ -87,6 +87,7 @@ export class ElectronClient extends LDClientImpl {
         internal.safeGetHooks(logger, _environmentMetadata, validatedElectronOptions.plugins),
       credentialType: useClientSideId ? 'clientSideId' : 'mobileKey',
       requiresStart: true,
+      initialContext,
     };
 
     const platform = new ElectronPlatform(logger, options);
@@ -119,7 +120,6 @@ export class ElectronClient extends LDClientImpl {
       internalOptions,
     );
 
-    this.setInitialContext(initialContext);
     this._plugins = validatedElectronOptions.plugins;
     this.setEventSendingEnabled(!this.isOffline(), false);
 

packages/shared/sdk-client/__tests__/LDClientImpl.start.test.ts

@@ -22,6 +22,7 @@ function setupClient(
     requiresStart?: boolean;
     disableNetwork?: boolean;
     sendEvents?: boolean;
+    initialContext?: LDContext;
   },
 ) {
   const logger = options?.logger ?? {
@@ -46,6 +47,7 @@ function setupClient(
       getImplementationHooks: () => [],
       credentialType: 'clientSideId',
       requiresStart: options?.requiresStart ?? true,
+      initialContext: options?.initialContext,
     },
   );
 
@@ -97,8 +99,7 @@ describe('LDClientImpl.start()', () => {
 
   it('returns the same promise when called multiple times', async () => {
     const mockPlatform = setupStreamingPlatform();
-    const { ldc } = setupClient(mockPlatform);
-    ldc.setInitialContext(context);
+    const { ldc } = setupClient(mockPlatform, { initialContext: context });
 
     const promise1 = ldc.start();
     const promise2 = ldc.start();
@@ -115,8 +116,7 @@ describe('LDClientImpl.start()', () => {
 
   it('returns cached result after initialization completes', async () => {
     const mockPlatform = setupStreamingPlatform();
-    const { ldc } = setupClient(mockPlatform);
-    ldc.setInitialContext(context);
+    const { ldc } = setupClient(mockPlatform, { initialContext: context });
 
     const result1 = await ldc.start();
     expect(result1.status).toBe('complete');
@@ -127,17 +127,15 @@ describe('LDClientImpl.start()', () => {
 
   it('resolves with complete status on successful identify', async () => {
     const mockPlatform = setupStreamingPlatform();
-    const { ldc } = setupClient(mockPlatform);
-    ldc.setInitialContext(context);
+    const { ldc } = setupClient(mockPlatform, { initialContext: context });
 
     const result = await ldc.start();
     expect(result.status).toBe('complete');
   });
 
   it('sets the active context after start completes', async () => {
     const mockPlatform = setupStreamingPlatform();
-    const { ldc } = setupClient(mockPlatform);
-    ldc.setInitialContext(context);
+    const { ldc } = setupClient(mockPlatform, { initialContext: context });
 
     expect(ldc.getContext()).toBeUndefined();
     await ldc.start();
@@ -147,8 +145,7 @@ describe('LDClientImpl.start()', () => {
   describe('bootstrap data', () => {
     it('presets flags from bootstrap in identifyOptions', async () => {
       const mockPlatform = createBasicPlatform();
-      const { ldc } = setupClient(mockPlatform, { disableNetwork: true });
-      ldc.setInitialContext(context);
+      const { ldc } = setupClient(mockPlatform, { disableNetwork: true, initialContext: context });
 
       await ldc.start({
         identifyOptions: { bootstrap: goodBootstrapData },
@@ -162,8 +159,7 @@ describe('LDClientImpl.start()', () => {
 
     it('presets flags from top-level bootstrap option', async () => {
       const mockPlatform = createBasicPlatform();
-      const { ldc } = setupClient(mockPlatform, { disableNetwork: true });
-      ldc.setInitialContext(context);
+      const { ldc } = setupClient(mockPlatform, { disableNetwork: true, initialContext: context });
 
       await ldc.start({ bootstrap: goodBootstrapData });
 
@@ -174,8 +170,7 @@ describe('LDClientImpl.start()', () => {
 
     it('makes flags available synchronously before identify completes', async () => {
       const mockPlatform = createBasicPlatform();
-      const { ldc } = setupClient(mockPlatform, { disableNetwork: true });
-      ldc.setInitialContext(context);
+      const { ldc } = setupClient(mockPlatform, { disableNetwork: true, initialContext: context });
 
       const startPromise = ldc.start({
         identifyOptions: { bootstrap: goodBootstrapDataWithReasons },
@@ -190,8 +185,7 @@ describe('LDClientImpl.start()', () => {
 
     it('supports bootstrap data with evaluation reasons', async () => {
       const mockPlatform = createBasicPlatform();
-      const { ldc } = setupClient(mockPlatform, { disableNetwork: true });
-      ldc.setInitialContext(context);
+      const { ldc } = setupClient(mockPlatform, { disableNetwork: true, initialContext: context });
 
       await ldc.start({
         identifyOptions: { bootstrap: goodBootstrapDataWithReasons },
@@ -206,8 +200,7 @@ describe('LDClientImpl.start()', () => {
 
     it('prefers identifyOptions.bootstrap over top-level bootstrap', async () => {
       const mockPlatform = createBasicPlatform();
-      const { ldc } = setupClient(mockPlatform, { disableNetwork: true });
-      ldc.setInitialContext(context);
+      const { ldc } = setupClient(mockPlatform, { disableNetwork: true, initialContext: context });
 
       const differentBootstrap = {
         'other-flag': true,
@@ -229,8 +222,7 @@ describe('LDClientImpl.start()', () => {
       const readFlagsFromBootstrapSpy = jest.spyOn(bootstrapModule, 'readFlagsFromBootstrap');
 
       const mockPlatform = createBasicPlatform();
-      const { ldc } = setupClient(mockPlatform, { disableNetwork: true });
-      ldc.setInitialContext(context);
+      const { ldc } = setupClient(mockPlatform, { disableNetwork: true, initialContext: context });
 
       await ldc.start({
         identifyOptions: { bootstrap: goodBootstrapDataWithReasons },
@@ -249,8 +241,10 @@ describe('LDClientImpl.start()', () => {
   describe('requiresStart guard', () => {
     it('blocks identify before start when requiresStart is true', async () => {
       const mockPlatform = setupStreamingPlatform();
-      const { ldc, logger } = setupClient(mockPlatform, { requiresStart: true });
-      ldc.setInitialContext(context);
+      const { ldc, logger } = setupClient(mockPlatform, {
+        requiresStart: true,
+        initialContext: context,
+      });
 
       const result = await ldc.identifyResult({ kind: 'user', key: 'other-user' });
 
@@ -265,8 +259,7 @@ describe('LDClientImpl.start()', () => {
 
     it('allows identify after start when requiresStart is true', async () => {
       const mockPlatform = setupStreamingPlatform();
-      const { ldc } = setupClient(mockPlatform, { requiresStart: true });
-      ldc.setInitialContext(context);
+      const { ldc } = setupClient(mockPlatform, { requiresStart: true, initialContext: context });
 
       await ldc.start();
 
@@ -284,8 +277,7 @@ describe('LDClientImpl.start()', () => {
 
     it('defaults sheddable to true for post-start identifies when requiresStart is true', async () => {
       const mockPlatform = setupStreamingPlatform();
-      const { ldc } = setupClient(mockPlatform, { requiresStart: true });
-      ldc.setInitialContext(context);
+      const { ldc } = setupClient(mockPlatform, { requiresStart: true, initialContext: context });
 
       const startPromise = ldc.start();
       const promise1 = ldc.identifyResult({ kind: 'user', key: 'user-1' });
@@ -324,8 +316,7 @@ describe('LDClientImpl.start()', () => {
   describe('waitForInitialization integration', () => {
     it('resolves waitForInitialization when start completes', async () => {
       const mockPlatform = setupStreamingPlatform();
-      const { ldc } = setupClient(mockPlatform);
-      ldc.setInitialContext(context);
+      const { ldc } = setupClient(mockPlatform, { initialContext: context });
 
       const waitPromise = ldc.waitForInitialization({ timeout: 10 });
       const startPromise = ldc.start();

packages/shared/sdk-client/src/LDClientImpl.ts

@@ -129,6 +129,7 @@ export default class LDClientImpl implements LDClient, LDClientIdentifyResult {
     this._config = new ConfigurationImpl(options, internalOptions);
     this.logger = this._config.logger;
     this._requiresStart = internalOptions?.requiresStart ?? false;
+    this.initialContext = internalOptions?.initialContext;
 
     this._baseHeaders = defaultHeaders(
       this.sdkKey,
@@ -275,14 +276,6 @@ export default class LDClientImpl implements LDClient, LDClientIdentifyResult {
     this._flagManager.presetFlags(newFlags);
   }
 
-  /**
-   * Sets the initial context for the client. This must be called before `start()`.
-   * @param context The initial context.
-   */
-  setInitialContext(context: LDContext): void {
-    this.initialContext = context;
-  }
-
   /**
    * Starts the client and returns a promise that resolves to the initialization result.
    *

packages/shared/sdk-client/src/configuration/Configuration.ts

@@ -10,6 +10,7 @@ import {
 } from '@launchdarkly/js-sdk-common';
 
 import { Hook, type LDOptions } from '../api';
+import { LDContext } from '../api/LDContext';
 import { LDInspection } from '../api/LDInspection';
 import type {
   InternalDataSystemOptions,
@@ -32,6 +33,11 @@ export interface LDClientInternalOptions extends internal.LDInternalOptions {
    * Set this value to `true` to use the new initialization pattern.
    */
   requiresStart?: boolean;
+
+  /**
+   * The initial context to use when starting the client.
+   */
+  initialContext?: LDContext;
 }
 
 export interface Configuration {