[0.76] Cleanup ReactNativeAppBuilder and ReactNativeWin32App #14025
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR backports microsoft#13983 to 0.76. ## Description This PR simplifies and scopes down the API for `ReactNativeAppBuilder` and `ReactNativeWin32App`. ### Type of Change - Bug fix (non-breaking change which fixes an issue) ### Why `ReactNativeAppBuilder`'s API surface made it too easy to call incorrectly and not realize it. Resolves microsoft#13946 ### What There are a variety of changes to the API surface: * `ReactInstanceSettingsBuilder` deleted: not only are there are simply too many APIs that would need to be exposed to be useful, the very act of creating and replacing the app's `ReactNativeHost`'s `ReactInstanceSettings` with a new one is what caused the bug in microsoft#13946 in the first place * `ReactNativeAppBuilder` now only exposes APIs to specify the intial, non-ReactNative, WinAppSDK types, (i.e. `DispatcherQueueController`, `Compositor`, and `AppWindow`), objects the app developer may already have created for their existing app, and otherwise is only responsible for building a `ReactNativeWin32App` with those types properly pre-made * `ReactNativeWin32App::Start()` is now more responsible for the stitching together all of the relevant types to make a working Win32 fabric app * All WinRT APIs without an immediate use-case have been commented out until we are sure they are necessary and that it is safe to expose them * The template has been updated to follow the pattern of: * Use `ReactNativeAppBuilder` to get a `ReactNativeWin32` app with the base WinAppSDK types ready * Get and modify the types as necessary from the created app object (like the `ReactInstanceSettings` and the `AppWindow`) * Call `app.Start()` ## Screenshots N/A ## Testing Verified new apps and example apps in libraryes build and run properly. ## Changelog Should this change be included in the release notes: _yes_ Cleanup ReactNativeAppBuilder and ReactNativeWin32App
TatianaKapos
approved these changes
Oct 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR backports #13983 to 0.76.
Description
This PR simplifies and scopes down the API for
ReactNativeAppBuilderandReactNativeWin32App.Type of Change
Why
ReactNativeAppBuilder's API surface made it too easy to call incorrectly and not realize it.Resolves #13946
What
There are a variety of changes to the API surface:
ReactInstanceSettingsBuilderdeleted: not only are there are simply too many APIs that would need to be exposed to be useful, the very act of creating and replacing the app'sReactNativeHost'sReactInstanceSettingswith a new one is what caused the bug in When Using New App Template (with ReactNativeAppBuilder) In-App Defined Native Modules Are Not Automatically Registered #13946 in the first placeReactNativeAppBuildernow only exposes APIs to specify the intial, non-ReactNative, WinAppSDK types, (i.e.DispatcherQueueController,Compositor, andAppWindow), objects the app developer may already have created for their existing app, and otherwise is only responsible for building aReactNativeWin32Appwith those types properly pre-madeReactNativeWin32App::Start()is now more responsible for the stitching together all of the relevant types to make a working Win32 fabric appReactNativeAppBuilderto get aReactNativeWin32app with the base WinAppSDK types readyReactInstanceSettingsand theAppWindow)app.Start()Screenshots
N/A
Testing
Verified new apps and example apps in libraryes build and run properly.
Changelog
Should this change be included in the release notes: yes
Cleanup ReactNativeAppBuilder and ReactNativeWin32App
Microsoft Reviewers: Open in CodeFlow