feat: add waitForInitialization to RN SDK #1048

joker23 · 2026-01-02T21:42:59Z

Requirements

I have added test coverage for new or changed functionality
I have followed the repository's pull request submission guidelines
I have validated my changes against all supported platform versions

Related issues

sdk-1680

Describe the solution you've provided

refactors the waitForInitialization function to client common, which exposes this capability for react native sdk
added unit tests to test the common capabilities
adds back ready event to be compatible with previous versions

Additional context

For React Native SDK, waitForInitialization is not, and is still not, part of the documented initialization flow. While this capability works, it will ONLY work if users are using the identifyResults function
There is a separate piece of work that will consolidate the identify and identifyResults` function in the common code (eg make both resolve to a result).

Note

Centralizes initialization waiting in shared client and exposes it to platforms

Implements waitForInitialization in LDClientImpl with timeout handling (promiseWithTimeout), init state tracking (initializedPromise, initializeResult), and emits ready/initialized events; adds shared types in api/LDWaitForInitialization and exports
Refactors Browser client to rely on common initialization flow (removes local wait/timeout logic); start() now uses common promiseWithTimeout and shared init state; imports updated
Extends LDEmitter with ready event; updates LDClient API to include waitForInitialization
Adds unit tests validating waitForInitialization complete/timeout/failure paths
Updates RN Jest tooling to mock waitForInitialization

^{Written by Cursor Bugbot for commit 25f2444. This will update automatically on new commits. Configure here.}

- refactors the `waitForInitialization` function to client common - exposes `waitForInitialization` to react native SDK

github-actions · 2026-01-02T21:44:20Z

@launchdarkly/browser size report
This is the brotli compressed size of the ESM build.
Compressed size: 171379 bytes
Compressed size limit: 200000
Uncompressed size: 798483 bytes

github-actions · 2026-01-02T21:44:27Z

@launchdarkly/js-sdk-common size report
This is the brotli compressed size of the ESM build.
Compressed size: 25394 bytes
Compressed size limit: 26000
Uncompressed size: 124693 bytes

github-actions · 2026-01-02T21:44:42Z

@launchdarkly/js-client-sdk-common size report
This is the brotli compressed size of the ESM build.
Compressed size: 19359 bytes
Compressed size limit: 20000
Uncompressed size: 99863 bytes

github-actions · 2026-01-02T21:44:46Z

@launchdarkly/js-client-sdk size report
This is the brotli compressed size of the ESM build.
Compressed size: 23344 bytes
Compressed size limit: 25000
Uncompressed size: 81374 bytes

kinyoklion · 2026-01-06T21:58:43Z

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

-          return { status: 'error', error: res.error } as LDIdentifyError;
+          const errorResult = { status: 'error', error: res.error } as LDIdentifyError;
+          // Track initialization state for waitForInitialization
+          this.setInitializationResult({ status: 'failed', error: res.error });


We only want to actually set the initialization result when initializing.

cursor · 2026-01-06T22:55:23Z

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

+          const errorResult = { status: 'error', error: res.error } as LDIdentifyError;
+          // Track initialization state for waitForInitialization
+          this.setInitializationResult({ status: 'failed', error: res.error });
+          return errorResult;


Missing initialization result when identify is shed

Low Severity

When identifyResult completes with status: 'shed', the code returns immediately without calling setInitializationResult. This means initializeResult remains undefined and initializedPromise never resolves. If a user calls waitForInitialization alongside a sheddable identifyResult that gets shed, waitForInitialization will timeout rather than returning a meaningful status. While the browser SDK mitigates this by using sheddable: false for initial identifies, and waitForInitialization is not the documented flow for React Native, this could cause unexpected behavior if users rely on both features together.

cursor · 2026-01-06T23:45:06Z

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

+        this.initResolve(result);
+        this.initResolve = undefined;
+      }
+    }


initialized event now fires only once instead of every identify

Medium Severity

The initialized event behavior has changed. Previously, this.emitter.emit('initialized') was called in the .then() callback on every successful identifyResult call. Now it's called inside maybeSetInitializationResult, which only emits the event when this.initializeResult === undefined (the first successful identify). Code listening to initialized to detect each identify completion will no longer work as expected for subsequent identify calls. While semantically "initialized" may only need to fire once, this is a breaking change from the previous behavior.

Additional Locations (1)

packages/shared/sdk-client/src/LDClientImpl.ts#L362-L366

🤖 I have created a release *beep* *boop* --- <details><summary>browser-telemetry: 1.0.16</summary> ## [1.0.16](browser-telemetry-v1.0.15...browser-telemetry-v1.0.16) (2026-01-06) ### Dependencies * The following workspace dependencies were updated * devDependencies * @launchdarkly/js-client-sdk bumped from 0.11.0 to 0.12.0 </details> <details><summary>jest: 0.2.0</summary> ## [0.2.0](jest-v0.1.15...jest-v0.2.0) (2026-01-06) ### Features * add waitForInitialization to RN SDK ([#1048](#1048)) ([13ce456](13ce456)) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/react-native-client-sdk bumped from ~10.12.3 to ~10.12.4 </details> <details><summary>js-client-sdk: 0.12.0</summary> ## [0.12.0](js-client-sdk-v0.11.0...js-client-sdk-v0.12.0) (2026-01-06) ### Features * add legacy storage key cleanup functionality ([#1043](#1043)) ([fe4725e](fe4725e)) * add waitForInitialization to RN SDK ([#1048](#1048)) ([13ce456](13ce456)) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/js-client-sdk-common bumped from 1.16.0 to 1.17.0 </details> <details><summary>js-client-sdk-common: 1.17.0</summary> ## [1.17.0](js-client-sdk-common-v1.16.0...js-client-sdk-common-v1.17.0) (2026-01-06) ### Features * add legacy storage key cleanup functionality ([#1043](#1043)) ([fe4725e](fe4725e)) * add waitForInitialization to RN SDK ([#1048](#1048)) ([13ce456](13ce456)) </details> <details><summary>react-native-client-sdk: 10.12.4</summary> ## [10.12.4](react-native-client-sdk-v10.12.3...react-native-client-sdk-v10.12.4) (2026-01-06) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/js-client-sdk-common bumped from 1.16.0 to 1.17.0 </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).  --- > [!NOTE] > Releases multiple packages and aligns versions/dependencies across the workspace. > > - Publish `@launchdarkly/js-client-sdk` 0.12.0 (adds legacy storage key cleanup); `@launchdarkly/js-client-sdk-common` 1.17.0; `@launchdarkly/react-native-client-sdk` 10.12.4; `@launchdarkly/browser-telemetry` 1.0.16; `@launchdarkly/jest` 0.2.0 (notes RN waitForInitialization) > - Bump deps to `@launchdarkly/js-client-sdk-common@1.17.0` in browser/RN SDKs and devDep `@launchdarkly/js-client-sdk@0.12.0` in telemetry; update `@launchdarkly/react-native-client-sdk` dep in `@launchdarkly/jest` > - Update version metadata in code (`BrowserInfo.ts`, `PlatformInfo.ts`) and `.release-please-manifest.json` > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 2d4e276. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>  Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

joker23 added 2 commits January 2, 2026 11:48

feat: move waitForInitialization to client common

9ea4ab9

- refactors the `waitForInitialization` function to client common - exposes `waitForInitialization` to react native SDK

chore: fix lint issues

c5567d4

joker23 requested a review from a team as a code owner January 2, 2026 21:43

test: add unit tests for waitForInitialization in client common

1c46a53

joker23 force-pushed the skz/sdk-1680/wait-for-init-common branch from c0519a4 to 1c46a53 Compare January 2, 2026 21:51

kinyoklion reviewed Jan 6, 2026

View reviewed changes

kinyoklion approved these changes Jan 6, 2026

View reviewed changes

cursor bot reviewed Jan 6, 2026

View reviewed changes

chore: addressing PR comments

25f2444

joker23 force-pushed the skz/sdk-1680/wait-for-init-common branch from 39f5e85 to 25f2444 Compare January 6, 2026 23:33

cursor bot reviewed Jan 6, 2026

View reviewed changes

joker23 merged commit 13ce456 into main Jan 6, 2026
37 checks passed

joker23 deleted the skz/sdk-1680/wait-for-init-common branch January 6, 2026 23:51

github-actions bot mentioned this pull request Jan 6, 2026

chore: release main #1050

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add waitForInitialization to RN SDK #1048

feat: add waitForInitialization to RN SDK #1048

Uh oh!

joker23 commented Jan 2, 2026 •

edited by cursor bot

Loading

Uh oh!

github-actions bot commented Jan 2, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 2, 2026

Uh oh!

github-actions bot commented Jan 2, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 2, 2026 •

edited

Loading

Uh oh!

kinyoklion Jan 6, 2026

Uh oh!

cursor bot Jan 6, 2026

Uh oh!

cursor bot Jan 6, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add waitForInitialization to RN SDK #1048

feat: add waitForInitialization to RN SDK #1048

Uh oh!

Conversation

joker23 commented Jan 2, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 2, 2026

Uh oh!

github-actions bot commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kinyoklion Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

cursor bot Jan 6, 2026

Choose a reason for hiding this comment

Missing initialization result when identify is shed

Uh oh!

cursor bot Jan 6, 2026

Choose a reason for hiding this comment

initialized event now fires only once instead of every identify

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

joker23 commented Jan 2, 2026 •

edited by cursor bot

Loading

github-actions bot commented Jan 2, 2026 •

edited

Loading

github-actions bot commented Jan 2, 2026 •

edited

Loading

github-actions bot commented Jan 2, 2026 •

edited

Loading

`initialized` event now fires only once instead of every identify