Merge branch 'main' into rlamb/prototype-multi-summary

Author: kinyoklion

.release-please-manifest.json

@@ -14,8 +14,8 @@
   "packages/shared/sdk-client": "1.12.5",
   "packages/sdk/react-native": "10.9.8",
   "packages/telemetry/node-server-sdk-otel": "1.1.8",
-  "packages/sdk/browser": "0.5.1",
+  "packages/sdk/browser": "0.5.2",
   "packages/sdk/server-ai": "0.9.5",
-  "packages/telemetry/browser-telemetry": "1.0.4",
+  "packages/telemetry/browser-telemetry": "1.0.5",
   "packages/tooling/jest": "0.1.3"
 }

packages/sdk/browser/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.5.2](https://github.com/launchdarkly/js-core/compare/js-client-sdk-v0.5.1...js-client-sdk-v0.5.2) (2025-04-15)
+
+
+### Bug Fixes
+
+* Handle default flush interval for browser SDK. ([#822](https://github.com/launchdarkly/js-core/issues/822)) ([2c1cc7a](https://github.com/launchdarkly/js-core/commit/2c1cc7a117fd011a329dfcc5332fddf7fd11eff9))
+
 ## [0.5.1](https://github.com/launchdarkly/js-core/compare/js-client-sdk-v0.5.0...js-client-sdk-v0.5.1) (2025-04-08)
 
 

packages/sdk/browser/__tests__/options.test.ts

@@ -2,7 +2,7 @@ import { jest } from '@jest/globals';
 
 import { LDLogger } from '@launchdarkly/js-client-sdk-common';
 
-import validateOptions, { filterToBaseOptions } from '../src/options';
+import validateBrowserOptions, { filterToBaseOptionsWithDefaults } from '../src/options';
 
 let logger: LDLogger;
 
@@ -16,7 +16,7 @@ beforeEach(() => {
 });
 
 it('logs no warnings when all configuration is valid', () => {
-  validateOptions(
+  validateBrowserOptions(
     {
       fetchGoals: true,
       eventUrlTransformer: (url: string) => url,
@@ -31,7 +31,7 @@ it('logs no warnings when all configuration is valid', () => {
 });
 
 it('warns for invalid configuration', () => {
-  validateOptions(
+  validateBrowserOptions(
     {
       // @ts-ignore
       fetchGoals: 'yes',
@@ -50,8 +50,8 @@ it('warns for invalid configuration', () => {
   );
 });
 
-it('applies default options', () => {
-  const opts = validateOptions({}, logger);
+it('applies default browser-specific options', () => {
+  const opts = validateBrowserOptions({}, logger);
 
   expect(opts.fetchGoals).toBe(true);
   expect(opts.eventUrlTransformer).toBeDefined();
@@ -69,9 +69,24 @@ it('filters to base options', () => {
     eventUrlTransformer: (url: string) => url,
   };
 
-  const baseOpts = filterToBaseOptions(opts);
+  const baseOpts = filterToBaseOptionsWithDefaults(opts);
   expect(baseOpts.debug).toBe(false);
-  expect(Object.keys(baseOpts).length).toEqual(1);
+  expect(Object.keys(baseOpts).length).toEqual(2);
   expect(baseOpts).not.toHaveProperty('fetchGoals');
   expect(baseOpts).not.toHaveProperty('eventUrlTransformer');
+  expect(baseOpts.flushInterval).toEqual(2);
+});
+
+it('applies default overrides to common config flushInterval', () => {
+  const opts = {};
+  const result = filterToBaseOptionsWithDefaults(opts);
+  expect(result.flushInterval).toEqual(2);
+});
+
+it('does not override common config flushInterval if it is set', () => {
+  const opts = {
+    flushInterval: 15,
+  };
+  const result = filterToBaseOptionsWithDefaults(opts);
+  expect(result.flushInterval).toEqual(15);
 });

packages/sdk/browser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@launchdarkly/js-client-sdk",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "LaunchDarkly SDK for JavaScript in Browsers",
   "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/sdk/browser",
   "repository": {

packages/sdk/browser/src/BrowserClient.ts

@@ -21,7 +21,7 @@ import { BrowserIdentifyOptions as LDIdentifyOptions } from './BrowserIdentifyOp
 import { registerStateDetection } from './BrowserStateDetector';
 import GoalManager from './goals/GoalManager';
 import { Goal, isClick } from './goals/Goals';
-import validateOptions, { applyBrowserDefaults, BrowserOptions, filterToBaseOptions } from './options';
+import validateBrowserOptions, { BrowserOptions, filterToBaseOptionsWithDefaults } from './options';
 import BrowserPlatform from './platform/BrowserPlatform';
 
 /**
@@ -116,14 +116,16 @@ export class BrowserClient extends LDClientImpl implements LDClient {
     const baseUrl = options.baseUri ?? 'https://clientsdk.launchdarkly.com';
 
     const platform = overridePlatform ?? new BrowserPlatform(logger);
-    const withDefaults = applyBrowserDefaults(options);
-    const validatedBrowserOptions = validateOptions(withDefaults, logger);
+    // Only the browser-specific options are in validatedBrowserOptions.
+    const validatedBrowserOptions = validateBrowserOptions(options, logger);
+    // The base options are in baseOptionsWithDefaults.
+    const baseOptionsWithDefaults = filterToBaseOptionsWithDefaults({ ...options, logger });
     const { eventUrlTransformer } = validatedBrowserOptions;
     super(
       clientSideId,
       autoEnvAttributes,
       platform,
-      filterToBaseOptions({ ...withDefaults, logger }),
+      baseOptionsWithDefaults,
       (
         flagManager: FlagManager,
         configuration: Configuration,

packages/sdk/browser/src/options.ts

@@ -73,8 +73,14 @@ const validators: { [Property in keyof BrowserOptions]: TypeValidator | undefine
   streaming: TypeValidators.Boolean,
 };
 
-export function filterToBaseOptions(opts: BrowserOptions): LDOptionsBase {
-  const baseOptions: LDOptionsBase = { ...opts };
+function withBrowserDefaults(opts: BrowserOptions): BrowserOptions {
+  const output = { ...opts };
+  output.flushInterval ??= DEFAULT_FLUSH_INTERVAL_SECONDS;
+  return output;
+}
+
+export function filterToBaseOptionsWithDefaults(opts: BrowserOptions): LDOptionsBase {
+  const baseOptions: LDOptionsBase = withBrowserDefaults(opts);
 
   // Remove any browser specific configuration keys so we don't get warnings from
   // the base implementation for unknown configuration.
@@ -84,15 +90,11 @@ export function filterToBaseOptions(opts: BrowserOptions): LDOptionsBase {
   return baseOptions;
 }
 
-export function applyBrowserDefaults(opts: BrowserOptions): BrowserOptions {
-  const output = { ...opts };
-  output.flushInterval ??= DEFAULT_FLUSH_INTERVAL_SECONDS;
-  return output;
-}
-
-export default function validateOptions(opts: BrowserOptions, logger: LDLogger): ValidatedOptions {
+export default function validateBrowserOptions(
+  opts: BrowserOptions,
+  logger: LDLogger,
+): ValidatedOptions {
   const output: ValidatedOptions = { ...optDefaults };
-  applyBrowserDefaults(output);
 
   Object.entries(validators).forEach((entry) => {
     const [key, validator] = entry as [keyof BrowserOptions, TypeValidator];

packages/shared/common/__tests__/internal/events/EventSummarizer.test.ts

@@ -7,10 +7,6 @@ describe('given an event summarizer', () => {
   const summarizer = new EventSummarizer();
   const context = Context.fromLDContext({ key: 'key' });
 
-  beforeEach(() => {
-    summarizer.clearSummary();
-  });
-
   it('does nothing for an identify event.', () => {
     const beforeSummary = summarizer.getSummary();
     summarizer.summarizeEvent(new InputIdentifyEvent(context));
@@ -300,4 +296,25 @@ describe('given an event summarizer', () => {
     };
     expect(data.features).toEqual(expectedFeatures);
   });
+
+  it('automatically clears summaries after getSummary() is called', () => {
+    const event = {
+      kind: 'feature',
+      creationDate: 1000,
+      key: 'key1',
+      version: 11,
+      context,
+      variation: 1,
+      value: 100,
+      default: 111,
+    };
+
+    summarizer.summarizeEvent(event as any);
+    summarizer.getSummary();
+
+    const secondSummary = summarizer.getSummary();
+    expect(secondSummary.features).toEqual({});
+    expect(secondSummary.startDate).toBe(0);
+    expect(secondSummary.endDate).toBe(0);
+  });
 });

packages/shared/common/__tests__/setupCrypto.ts

@@ -1,16 +1,16 @@
 import { Hasher } from '../src/api';
 
 class MockHasher implements Hasher {
-  private state: string[] = [];
+  private _state: string[] = [];
 
   update(value: string): Hasher {
-    this.state.push(value);
+    this._state.push(value);
     return this;
   }
 
   digest(): string {
-    const result = this.state.join('');
-    this.state = []; // Reset state after digest
+    const result = this._state.join('');
+    this._state = []; // Reset state after digest
     return result;
   }
 }

packages/shared/common/src/Context.ts

@@ -482,7 +482,7 @@ export default class Context {
     const kinds = this.kinds.sort();
     kinds.forEach((kind) => hasher.update(kind));
 
-    for (const kind of kinds) {
+    kinds.forEach((kind) => {
       hasher.update(kind);
       const context = this._contextForKind(kind)!;
       Object.getOwnPropertyNames(context)
@@ -502,7 +502,7 @@ export default class Context {
         .map((attr) => attr.components.join('/'))
         .sort();
       sortedAttributes.forEach((attr) => hasher.update(attr));
-    }
+    });
 
     while (stack.length > 0) {
       const { target, visited } = stack.pop()!;

packages/shared/common/src/api/subsystem/LDEventSummarizer.ts

@@ -31,10 +31,21 @@ export interface SummarizedFlagsEvent {
   context?: any;
 }
 
+/**
+ * Interface for summarizing feature flag evaluations bucketed by the context.
+ */
 export interface LDMultiEventSummarizer {
+  /**
+   * Processes an event for summarization if it is a feature flag event and not excluded from summaries.
+   * @param event The event to potentially summarize
+   */
   summarizeEvent(event: InputEvent): void;
-  getSummaries(): Promise<SummarizedFlagsEvent[]>;
-  clearSummary(): void;
+
+  /**
+   * Gets the current summary of processed events.
+   * @returns A summary of all processed feature flag events
+   */
+  getSummaries(): SummarizedFlagsEvent[];
 }
 
 /**
@@ -52,9 +63,4 @@ export default interface LDEventSummarizer {
    * @returns A summary of all processed feature flag events
    */
   getSummary(): SummarizedFlagsEvent;
-
-  /**
-   * Clears all summarized event data.
-   */
-  clearSummary(): void;
 }