chore: pr comments

Author: joker23

packages/tooling/client-testing-plugin/README.md

@@ -39,14 +39,15 @@ client.stringVariation('greeting', '(default)'); // 'Hello!'
 td.setBool('new-ui', false).setString('greeting', 'Welcome');
 ```
 
-### Why these options matter
+### Required LD client options
+In order to successfully set up a LD client to use the testing plugin, you **MUST** set the following options:
 
-- **`plugins: [td]`** -- registers the testing plugin so it can inject overrides.
-- **`sendEvents: false`** -- keeps analytics events off in tests.
-- **`streaming: false`** -- prevents the SDK from auto-starting a streaming connection when a `change` listener is registered. Without this, the React SDK provider (and any other code that registers `change` listeners) will trigger a real network call to `clientstream.launchdarkly.com`.
+- **`plugins: [td]`** - registers the testing plugin so it can inject overrides.
+- **`sendEvents: false`** - keeps analytics events off in tests.
+- **`streaming: false`** - (required for `js-client-sdk` and its derivativs, eg `react-sdk`), having streaming on will cause the `js-client-sdk` to automatically open a streaming connection.
 - **`bootstrap: {}` (passed to `start()`)** -- gives the SDK an empty initial flag set so it does not block on a network identify call. The plugin's overrides are applied immediately afterward.
 
-If you forget any of these, the SDK may attempt to fetch flags from LaunchDarkly during initialization and produce real network traffic, console errors, or stray evaluation events.
+> Refer to the usage example above.
 
 ## API
 
@@ -67,6 +68,6 @@ class TestData implements LDPlugin {
 ```
 
 - **`new TestData(initialFlags?)`** -- seed the instance with a base map of flag keys to values. The values are applied to the SDK client when it initializes.
-- **`setBool` / `setString` / `setNumber` / `setJson`** -- set or update a single flag. If the SDK is already running, the change propagates immediately and listeners receive a `change:<key>` event. Updates dedup by reference equality (`===`); pass a fresh object/array reference if you want a change event after mutating a previous value.
+- **`setBool` / `setString` / `setNumber` / `setJson`** -- set or update a single flag. If the SDK is already running, the change propagates immediately and listeners receive a `change:<key>` event. Every write applies the override, even when the value is unchanged -- mirroring a real connection that can re-deliver a flag and fire a `change` event without the value differing.
 - **`remove(key)`** -- drop the override for a single key. If the SDK is connected, also calls `removeOverride`.
 - **`clear()`** -- drop all overrides. Useful in `beforeEach` for shared `TestData` instances.

packages/tooling/client-testing-plugin/__tests__/TestData.test.ts

@@ -21,194 +21,172 @@ function createMockDebugOverride(): LDDebugOverride & {
   };
 }
 
-describe('TestData', () => {
-  it('returns correct plugin metadata', () => {
-    expect(new TestData().getMetadata()).toEqual({ name: 'test-data' });
-  });
-
-  it('register is a no-op', () => {
-    const td = new TestData();
-    expect(() =>
-      td.register(undefined, {
-        sdk: { name: 'test', version: '0.0.0' },
-        clientSideId: 'test-key',
-      } as never),
-    ).not.toThrow();
-  });
-
-  it('seeds initial flags from the constructor and applies them on registerDebug', () => {
-    const td = new TestData({
-      'show-banner': true,
-      greeting: 'Hello',
-      'max-retries': 3,
-      config: { theme: 'dark' },
-    });
-
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
-
-    expect(debugOverride.overrides['show-banner']).toBe(true);
-    expect(debugOverride.overrides.greeting).toBe('Hello');
-    expect(debugOverride.overrides['max-retries']).toBe(3);
-    expect(debugOverride.overrides.config).toEqual({ theme: 'dark' });
-  });
-
-  it('typed setters chain and apply pre-registration', () => {
-    const td = new TestData()
-      .setBool('show-banner', true)
-      .setString('greeting', 'Hello')
-      .setNumber('max-retries', 3)
-      .setJson('config', { theme: 'dark' });
+it('returns correct plugin metadata', () => {
+  expect(new TestData().getMetadata()).toEqual({ name: 'test-data' });
+});
 
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
+it('register is a no-op', () => {
+  const td = new TestData();
+  expect(() =>
+    td.register(undefined, {
+      sdk: { name: 'test', version: '0.0.0' },
+      clientSideId: 'test-key',
+    } as never),
+  ).not.toThrow();
+});
 
-    expect(debugOverride.overrides['show-banner']).toBe(true);
-    expect(debugOverride.overrides.greeting).toBe('Hello');
-    expect(debugOverride.overrides['max-retries']).toBe(3);
-    expect(debugOverride.overrides.config).toEqual({ theme: 'dark' });
+it('seeds initial flags from the constructor and applies them on registerDebug', () => {
+  const td = new TestData({
+    'show-banner': true,
+    greeting: 'Hello',
+    'max-retries': 3,
+    config: { theme: 'dark' },
   });
 
-  it('typed setters propagate live updates after registration', () => {
-    const td = new TestData();
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
-
-    td.setBool('show-banner', true);
-    expect(debugOverride.setOverride).toHaveBeenCalledWith('show-banner', true);
+  const debugOverride = createMockDebugOverride();
+  td.registerDebug(debugOverride);
 
-    td.setString('greeting', 'Howdy');
-    expect(debugOverride.setOverride).toHaveBeenCalledWith('greeting', 'Howdy');
+  expect(debugOverride.overrides['show-banner']).toBe(true);
+  expect(debugOverride.overrides.greeting).toBe('Hello');
+  expect(debugOverride.overrides['max-retries']).toBe(3);
+  expect(debugOverride.overrides.config).toEqual({ theme: 'dark' });
+});
 
-    td.setNumber('max-retries', 5);
-    expect(debugOverride.setOverride).toHaveBeenCalledWith('max-retries', 5);
+it('typed setters chain and apply pre-registration', () => {
+  const td = new TestData()
+    .setBool('show-banner', true)
+    .setString('greeting', 'Hello')
+    .setNumber('max-retries', 3)
+    .setJson('config', { theme: 'dark' });
 
-    td.setJson('config', [1, 2, 3]);
-    expect(debugOverride.setOverride).toHaveBeenCalledWith('config', [1, 2, 3]);
-  });
+  const debugOverride = createMockDebugOverride();
+  td.registerDebug(debugOverride);
 
-  it('skips setOverride when the same primitive value is set twice', () => {
-    const td = new TestData();
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
+  expect(debugOverride.overrides['show-banner']).toBe(true);
+  expect(debugOverride.overrides.greeting).toBe('Hello');
+  expect(debugOverride.overrides['max-retries']).toBe(3);
+  expect(debugOverride.overrides.config).toEqual({ theme: 'dark' });
+});
 
-    td.setBool('flag', true);
-    expect(debugOverride.setOverride).toHaveBeenCalledTimes(1);
+it('typed setters propagate live updates after registration', () => {
+  const td = new TestData();
+  const debugOverride = createMockDebugOverride();
+  td.registerDebug(debugOverride);
 
-    td.setBool('flag', true);
-    expect(debugOverride.setOverride).toHaveBeenCalledTimes(1);
+  td.setBool('show-banner', true);
+  expect(debugOverride.setOverride).toHaveBeenCalledWith('show-banner', true);
 
-    td.setBool('flag', false);
-    expect(debugOverride.setOverride).toHaveBeenCalledTimes(2);
-  });
+  td.setString('greeting', 'Howdy');
+  expect(debugOverride.setOverride).toHaveBeenCalledWith('greeting', 'Howdy');
 
-  it('dedups by reference equality, so passing a new object always fires', () => {
-    const td = new TestData();
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
+  td.setNumber('max-retries', 5);
+  expect(debugOverride.setOverride).toHaveBeenCalledWith('max-retries', 5);
 
-    td.setJson('cfg', { showBanner: true });
-    expect(debugOverride.setOverride).toHaveBeenCalledTimes(1);
+  td.setJson('config', [1, 2, 3]);
+  expect(debugOverride.setOverride).toHaveBeenCalledWith('config', [1, 2, 3]);
+});
 
-    // New object reference -- fires even though structurally identical.
-    td.setJson('cfg', { showBanner: true });
-    expect(debugOverride.setOverride).toHaveBeenCalledTimes(2);
+it('fires setOverride on every write, including repeated identical values', () => {
+  const td = new TestData();
+  const debugOverride = createMockDebugOverride();
+  td.registerDebug(debugOverride);
 
-    // Same reference twice in a row -- deduped.
-    const same = { showBanner: false };
-    td.setJson('cfg', same);
-    td.setJson('cfg', same);
-    expect(debugOverride.setOverride).toHaveBeenCalledTimes(3);
-  });
+  td.setBool('flag', true);
+  td.setBool('flag', true);
+  td.setBool('flag', true);
 
-  it('remove clears stored state and the active override', () => {
-    const td = new TestData({ flag: true });
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
+  expect(debugOverride.setOverride).toHaveBeenCalledTimes(3);
+  expect(debugOverride.setOverride).toHaveBeenNthCalledWith(1, 'flag', true);
+  expect(debugOverride.setOverride).toHaveBeenNthCalledWith(3, 'flag', true);
+});
 
-    td.remove('flag');
+it('fires setOverride for repeated NaN and object writes', () => {
+  const td = new TestData();
+  const debugOverride = createMockDebugOverride();
+  td.registerDebug(debugOverride);
 
-    expect(debugOverride.removeOverride).toHaveBeenCalledWith('flag');
-    expect(debugOverride.overrides.flag).toBeUndefined();
-  });
+  td.setNumber('n', NaN);
+  td.setNumber('n', NaN);
+  expect(debugOverride.setOverride).toHaveBeenCalledTimes(2);
 
-  it('remove before registerDebug prevents the flag from being applied later', () => {
-    const td = new TestData({ flag: true });
-    td.remove('flag');
+  const same = { showBanner: true };
+  td.setJson('cfg', same);
+  td.setJson('cfg', same);
+  expect(debugOverride.setOverride).toHaveBeenCalledTimes(4);
+});
 
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
+it('remove clears stored state and the active override', () => {
+  const td = new TestData({ flag: true });
+  const debugOverride = createMockDebugOverride();
+  td.registerDebug(debugOverride);
 
-    expect(debugOverride.setOverride).not.toHaveBeenCalled();
-    expect(debugOverride.overrides.flag).toBeUndefined();
-  });
+  td.remove('flag');
 
-  it('clear resets all flags and clears the override interface', () => {
-    const td = new TestData({ a: true, b: 'x' });
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
+  expect(debugOverride.removeOverride).toHaveBeenCalledWith('flag');
+  expect(debugOverride.overrides.flag).toBeUndefined();
+});
 
-    td.clear();
+it('remove before registerDebug prevents the flag from being applied later', () => {
+  const td = new TestData({ flag: true });
+  td.remove('flag');
 
-    expect(debugOverride.clearAllOverrides).toHaveBeenCalledTimes(1);
-  });
+  const debugOverride = createMockDebugOverride();
+  td.registerDebug(debugOverride);
 
-  it('clear before registerDebug drops queued flags', () => {
-    const td = new TestData({ a: true });
-    td.clear();
+  expect(debugOverride.setOverride).not.toHaveBeenCalled();
+  expect(debugOverride.overrides.flag).toBeUndefined();
+});
 
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
+it('clear resets all flags and clears the override interface', () => {
+  const td = new TestData({ a: true, b: 'x' });
+  const debugOverride = createMockDebugOverride();
+  td.registerDebug(debugOverride);
 
-    expect(debugOverride.setOverride).not.toHaveBeenCalled();
-  });
+  td.clear();
 
-  it('throws if registerDebug is called twice', () => {
-    const td = new TestData();
-    td.registerDebug(createMockDebugOverride());
+  expect(debugOverride.clearAllOverrides).toHaveBeenCalledTimes(1);
+});
 
-    expect(() => td.registerDebug(createMockDebugOverride())).toThrow(
-      /already been registered/,
-    );
-  });
+it('clear before registerDebug drops queued flags', () => {
+  const td = new TestData({ a: true });
+  td.clear();
 
-  it('setJson rejects undefined and other non-object values', () => {
-    const td = new TestData();
-    expect(() => td.setJson('flag', undefined as unknown as object)).toThrow(TypeError);
-    expect(() => td.setJson('flag', null as unknown as object)).toThrow(TypeError);
-    expect(() => td.setJson('flag', 'string' as unknown as object)).toThrow(TypeError);
-    expect(() => td.setJson('flag', 42 as unknown as object)).toThrow(TypeError);
-  });
+  const debugOverride = createMockDebugOverride();
+  td.registerDebug(debugOverride);
 
-  it('dedups NaN values via Object.is semantics', () => {
-    const td = new TestData();
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
+  expect(debugOverride.setOverride).not.toHaveBeenCalled();
+});
 
-    td.setNumber('flag', NaN);
-    expect(debugOverride.setOverride).toHaveBeenCalledTimes(1);
+it('throws if registerDebug is called twice', () => {
+  const td = new TestData();
+  td.registerDebug(createMockDebugOverride());
 
-    td.setNumber('flag', NaN);
-    expect(debugOverride.setOverride).toHaveBeenCalledTimes(1);
+  expect(() => td.registerDebug(createMockDebugOverride())).toThrow(
+    /already been registered/,
+  );
+});
 
-    td.setNumber('flag', 0);
-    expect(debugOverride.setOverride).toHaveBeenCalledTimes(2);
-  });
+it('setJson rejects undefined and other non-object values', () => {
+  const td = new TestData();
+  expect(() => td.setJson('flag', undefined as unknown as object)).toThrow(TypeError);
+  expect(() => td.setJson('flag', null as unknown as object)).toThrow(TypeError);
+  expect(() => td.setJson('flag', 'string' as unknown as object)).toThrow(TypeError);
+  expect(() => td.setJson('flag', 42 as unknown as object)).toThrow(TypeError);
+});
 
-  it('remove and clear return this for chaining', () => {
-    const td = new TestData({ a: true, b: 'x' });
-    expect(td.remove('a')).toBe(td);
-    expect(td.clear()).toBe(td);
-  });
+it('remove and clear return this for chaining', () => {
+  const td = new TestData({ a: true, b: 'x' });
+  expect(td.remove('a')).toBe(td);
+  expect(td.clear()).toBe(td);
+});
 
-  it('handles flag keys that collide with Object prototype names safely', () => {
-    const td = new TestData();
-    const debugOverride = createMockDebugOverride();
-    td.registerDebug(debugOverride);
+it('handles flag keys that collide with Object prototype names safely', () => {
+  const td = new TestData();
+  const debugOverride = createMockDebugOverride();
+  td.registerDebug(debugOverride);
 
-    td.setString('toString', 'overridden').setNumber('hasOwnProperty', 42);
+  td.setString('toString', 'overridden').setNumber('hasOwnProperty', 42);
 
-    expect(debugOverride.setOverride).toHaveBeenCalledWith('toString', 'overridden');
-    expect(debugOverride.setOverride).toHaveBeenCalledWith('hasOwnProperty', 42);
-  });
+  expect(debugOverride.setOverride).toHaveBeenCalledWith('toString', 'overridden');
+  expect(debugOverride.setOverride).toHaveBeenCalledWith('hasOwnProperty', 42);
 });

packages/tooling/client-testing-plugin/setup-jest.js

@@ -13,11 +13,8 @@ if (typeof global.EventSource === 'undefined') {
     constructor() {
       // no-op
     }
-
     addEventListener() {}
-
     removeEventListener() {}
-
     close() {}
   };
 }