Reshape BrowserConfiguration API per review (BrowserOptions) while preserving the JS wire format - #67337
Merged
Merged
Conversation
…tions, reshape API, preserve wire format) Co-authored-by: javiercn <6995051+javiercn@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Review feedback on BrowserConfiguration shape and placement
Reshape BrowserConfiguration API per review (BrowserOptions) while preserving the JS wire format
Jun 21, 2026
javiercn
requested changes
Jun 21, 2026
… the model Co-authored-by: javiercn <6995051+javiercn@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Reshapes the Blazor server-to-browser configuration surface to follow ASP.NET Core “options” conventions (renaming BrowserConfiguration → BrowserOptions, adjusting option types), while keeping the serialized <!--Blazor-Configuration:...--> payload compatible with the existing JS consumer.
Changes:
- Renames/reshapes the public API surface (
WithBrowserConfiguration→WithBrowserOptions,GetBrowserConfiguration→GetBrowserOptions,ConfigureBrowser.Configuration→.Options) and updates option types (TimeSpan?,LogLevel?, positivePreserveDom). - Serializes
BrowserOptionsdirectly using source-generatedJsonSerializerContextplus internal converters to preserve the existing JS wire format. - Moves/removes the old public types from
Componentsand introduces the new public types inComponents.Endpoints(public namespace remainsMicrosoft.AspNetCore.Components).
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/Components/test/testassets/Components.TestServer/RazorComponentEndpointsStartup.cs | Updates test-asset endpoint setup to use WithBrowserOptions. |
| src/Components/Endpoints/src/Rendering/EndpointHtmlRenderer.Streaming.cs | Switches runtime emission to GetBrowserOptions() and BrowserOptionsJsonContext. |
| src/Components/Endpoints/src/Rendering/BrowserOptionsJsonContext.cs | Renames/moves the source-gen JSON context to target BrowserOptions. |
| src/Components/Endpoints/src/PublicAPI.Unshipped.txt | Updates public API tracking for the new/moved types and members. |
| src/Components/Endpoints/src/Builder/RazorComponentsEndpointConventionBuilderExtensions.cs | Renames endpoint builder API to WithBrowserOptions(...). |
| src/Components/Endpoints/src/BrowserConfiguration/WebAssemblyBrowserOptions.cs | Makes EnvironmentVariables get-only/non-null and changes type to IDictionary<,>. |
| src/Components/Endpoints/src/BrowserConfiguration/SsrBrowserOptions.cs | Introduces SSR options with converters for JS wire compatibility (PreserveDom, TimeSpan). |
| src/Components/Endpoints/src/BrowserConfiguration/InteractiveServerBrowserOptions.cs | Renames server options type and switches retry interval to TimeSpan? with ms converter. |
| src/Components/Endpoints/src/BrowserConfiguration/ConfigureBrowser.cs | Renames parameter to Options and updates merge behavior for new shapes. |
| src/Components/Endpoints/src/BrowserConfiguration/BrowserOptionsJsonConverters.cs | Adds internal converters to adapt idiomatic C# shapes to the existing JS payload format. |
| src/Components/Endpoints/src/BrowserConfiguration/BrowserOptionsHttpContextExtensions.cs | Renames HttpContext accessor to GetBrowserOptions(). |
| src/Components/Endpoints/src/BrowserConfiguration/BrowserOptions.cs | Adds the new root options model with get-only nested option objects. |
| src/Components/Components/src/PublicAPI.Unshipped.txt | Removes the old API entries from the Components assembly public API tracking. |
| src/Components/Components/src/BrowserConfiguration/SsrBrowserOptions.cs | Removes old SSR options shape from Components. |
| src/Components/Components/src/BrowserConfiguration/BrowserConfiguration.cs | Removes old root configuration model from Components. |
Comments suppressed due to low confidence (2)
src/Components/Endpoints/src/Rendering/BrowserOptionsJsonContext.cs:12
BrowserOptionsis declared inMicrosoft.AspNetCore.Components, but this file is inMicrosoft.AspNetCore.Components.Endpointsand doesn’t import the parent namespace. As written,[JsonSerializable(typeof(BrowserOptions))]won’t compile becauseBrowserOptionscan’t be resolved from this namespace.
src/Components/Endpoints/src/BrowserConfiguration/BrowserOptionsHttpContextExtensions.cs:32GetBrowserOptionscurrently returns theBrowserOptionsinstance stored in endpoint metadata directly. SinceBrowserOptions(and its nested options/dictionaries) are mutable and callers/components merge into it per request, this can cause cross-request state leakage and concurrency issues. Clone into a per-request instance before storing it inHttpContext.Items.
Comment on lines
345
to
348
| _browserConfigurationEmitted = true; | ||
|
|
||
| var config = _httpContext.GetBrowserConfiguration(); | ||
| var config = _httpContext.GetBrowserOptions(); | ||
|
|
pavelsavara
approved these changes
Jun 22, 2026
danroth27
added a commit
to dotnet/core
that referenced
this pull request
Jul 14, 2026
…eature WithBrowserOptions flows client-side Blazor.start configuration from the server in C# (log level, Server reconnection, SSR DOM preservation, WASM environment), serialized to the client across Server/WebAssembly/Auto render modes. Introduced in Preview 4 (server-to-browser config via DOM comment) and reshaped in Preview 6 (dotnet/aspnetcore#67337, proposal #66393). Includes the reshape/rename migration for earlier adopters. Sample build-verified on 11.0.100-preview.6.26359.118. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
rbhanda
added a commit
to dotnet/core
that referenced
this pull request
Jul 14, 2026
* [release-notes] .NET 11 Preview 6 base metadata changes.json, features.json, build-metadata.json, and README for the .NET 11 Preview 6 milestone (VMR base v11.0.0-preview.5.26302.115 -> head release/11.0.1xx-preview6). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [release-notes] C# in .NET 11 Preview 6 (#10460) * [release-notes] C# in .NET 11 Preview 6 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update release-notes/11.0/preview/preview6/csharp.md --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Bill Wagner <wiwagn@microsoft.com> * [release-notes] MSBuild in .NET 11 Preview 6 (#10463) * [release-notes] MSBuild in .NET 11 Preview 6 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add bug-fix note for architecture-agnostic Runtime=NET task host handshake (dotnet/msbuild#13890) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Remove HTML comments from Preview 6 MSBuild release notes Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Chet Husk <chusk3@gmail.com> * [release-notes] NuGet in .NET 11 Preview 6 (#10464) * [release-notes] NuGet in .NET 11 Preview 6 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix STJ feature-flag env var value and remove VS reference Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Chet Husk <chusk3@gmail.com> * [release-notes] .NET SDK in .NET 11 Preview 6 (#10459) * [release-notes] .NET SDK in .NET 11 Preview 6 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clarify NativeAOT CLI updates in preview6/sdk.md Updated the NativeAOT CLI section to clarify the unification of managed and NativeAOT parsers, and removed filtered content related to internal changes. * Add live running-tests display to dotnet test notes Document the in-flight test progress panel (dotnet/sdk#54486) and fix pre-existing trailing-space lint errors in the NativeAOT section. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Chet Husk <baronfel@users.noreply.github.com> Co-authored-by: Chet Husk <chusk3@gmail.com> * [release-notes] Windows Forms in .NET 11 Preview 6 (#10465) * [release-notes] Windows Forms in .NET 11 Preview 6 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Revise Windows Forms release notes for Preview 6 Updated release notes for .NET 11 Preview 6 to include bug fixes and improvements for various Windows Forms components. --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Klaus Löffelmann <9663150+KlausLoeffelmann@users.noreply.github.com> * [release-notes] .NET MAUI in .NET 11 Preview 6 (#10467) * [release-notes] .NET MAUI in .NET 11 Preview 6 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Draft .NET MAUI and friends notes for .NET 11 Preview 6 Combined highlights for .NET MAUI, .NET for Android, and .NET for iOS, Mac Catalyst, macOS, and tvOS: CollectionView2 on Windows, handler-based Shell on Android, Compatibility package removal, AOT-safe HybridWebView, Geolocation minimum-distance filter, a reliability wave, the AndroidMessageHandler HTTP-contract work, and the Apple platform toolchain and NSUrlSessionHandler updates. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Add Preview 6 items from MAUI maintainer review Incorporates jfversluis review feedback on #10467: - Android MediaPicker result recovery APIs (dotnet/maui#35455) - HybridWebView Android message-source filtering (dotnet/maui#35717) - XAML C# expression source generator CS1061 fix (dotnet/maui#35922) - Testable permissions via IPermissions/Permissions.Current (dotnet/maui#35987) - XA0149 warning for legacy __AndroidEnvironment__ resources (dotnet/android#11700) - Skip library proguard.txt with disallowed R8 global options (dotnet/android#11709) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Ortinau <david.ortinau@microsoft.com> * [release-notes] EF Core in .NET 11 Preview 6 (#10462) Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com> * [release-notes] F# in .NET 11 Preview 6 (#10461) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [release-notes] Containers in .NET 11 Preview 6 (#10468) * [release-notes] Containers in .NET 11 Preview 6 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update release notes --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Logan Bussell <loganbussell@microsoft.com> * [release-notes] .NET Libraries in .NET 11 Preview 6 (#10457) * [release-notes] .NET Libraries in .NET 11 Preview 6 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix async DataAnnotations sample after testing on the Preview 6 SDK AsyncValidationAttribute is overridden via the protected IsValidAsync (and IsValid) members, not GetValidationResultAsync (which is the public method the framework calls and is not virtual). Verified the corrected sample compiles and runs against the Preview 6 build. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Verify Preview 6 library samples and fix inaccuracies - Stream adapters: read from the read-only stream via StreamContent/PostAsync instead of copying HttpContent into it - Cross-lane vectors: replace nonexistent Concat with ConcatLowerLower/LowerUpper/UpperLower/UpperUpper and drop preexisting Shuffle/ShuffleNative - Async validation: swap the unique-username example for a VAT registry lookup, layer StringLength and RegularExpression sync rules with the async rule, and add a server-side validation note Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com> * [release-notes] ASP.NET Core in .NET 11 Preview 6 (#10456) * [release-notes] WPF in .NET 11 Preview 6 (#10466) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Throw InvalidOperationException for sync validation of async validator Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Apply late review suggestions from #10456 to the ASP.NET Core notes - OpenAPI unions: correct the third-party generator claim (ApiExplorer does not detect unions via JsonTypeInfoKind.Union; Swashbuckle/NSwag don't yet recognize unions). Per @DeagleGross review on #10456. - Blazor Virtualize: note that a user scroll during ScrollToIndexAsync wins. Per @ilonatommy review on #10456. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add P6 Blazor items to align with docs (dotnet/AspNetCore.Docs#37322) - CSRF: note that Blazor Web App templates no longer call app.UseAntiforgery(). - Bug fixes/Blazor: Virtualize is now CSP-compliant (#66680); session cookie is issued before streaming SSR for [SupplyParameterFromSession]/TempData (#66832). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Document 'Configure Blazor client behavior from the server' as a P6 feature WithBrowserOptions flows client-side Blazor.start configuration from the server in C# (log level, Server reconnection, SSR DOM preservation, WASM environment), serialized to the client across Server/WebAssembly/Auto render modes. Introduced in Preview 4 (server-to-browser config via DOM comment) and reshaped in Preview 6 (dotnet/aspnetcore#67337, proposal #66393). Includes the reshape/rename migration for earlier adopters. Sample build-verified on 11.0.100-preview.6.26359.118. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Correct Virtualize CSP note: data-blazor-virtualize-reserved-height Reviewing dotnet/AspNetCore.Docs#37322 surfaced that the attribute is data-blazor-virtualize-reserved-height (only the server-computed spacer height), not the generic data-blazor-style. Verified in the P6 source (Virtualize.cs / Virtualize.ts). @ilonatommy corrected the same wording on the docs PR. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [release-notes] .NET Runtime in .NET 11 Preview 6 (#10458) * [release-notes] .NET Runtime in .NET 11 Preview 6 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Enrich Preview 6 runtime notes with additional verified features Fold verified .NET 11 Preview 6 runtime changes into runtime.md (JIT improvements, in-process crash logging, NativeAOT interface dispatch, SIMD lane APIs, and an expanded bug-fix list), and rebuild the TOC to match the current sections. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: ade796bb-8052-4946-b204-a88518267e77 --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Rich Lander <2608468+richlander@users.noreply.github.com> * fix markdown lint in preview6 containers note Co-authored-by: jongalloway <68539+jongalloway@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Bill Wagner <wiwagn@microsoft.com> Co-authored-by: Chet Husk <chusk3@gmail.com> Co-authored-by: Chet Husk <baronfel@users.noreply.github.com> Co-authored-by: Klaus Löffelmann <9663150+KlausLoeffelmann@users.noreply.github.com> Co-authored-by: David Ortinau <david.ortinau@microsoft.com> Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com> Co-authored-by: Logan Bussell <loganbussell@microsoft.com> Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Rich Lander <2608468+richlander@users.noreply.github.com> Co-authored-by: Rahul Bhandari <rbhanda@microsoft.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jongalloway <68539+jongalloway@users.noreply.github.com>
This file contains hidden or 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
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.
API-review feedback on the server-to-client Blazor browser configuration (#66393): rename/reshape the public surface to match ASP.NET Core options conventions, while keeping the serialized
<!--Blazor-Configuration:...-->payload aligned with the existing Web.JS consumer.Description
BrowserConfiguration→BrowserOptions.LogLevelis nowMicrosoft.Extensions.Logging.LogLevel?(JS enum values are identical, 0–6).Server/Ssr/WebAssemblyare get-only and pre-initialized to avoid NREs on the common path.InteractiveServerBrowserOptions(wasServerBrowserOptions):ReconnectionRetryIntervalMilliseconds(int?) →ReconnectionRetryInterval(TimeSpan?).SsrBrowserOptions:CircuitInactivityTimeoutMs→CircuitInactivityTimeout(TimeSpan?);DisableDomPreservation→ positivePreserveDom(bool?).WebAssemblyBrowserOptions:EnvironmentVariablesis now a get-only, non-nullIDictionary<string, string>.ConfigureBrowser:Configurationparameter →Options.BrowserOptionsand theInteractiveServerBrowserOptions/SsrBrowserOptions/WebAssemblyBrowserOptionstypes now live inMicrosoft.AspNetCore.Components.Endpoints(the public namespace staysMicrosoft.AspNetCore.Components), alongside the relatedConfigureBrowsercomponent and helpers, since they are written by the ASP.NET Core host during SSR and only read by JS.BrowserConfigurationHttpContextExtensions.GetBrowserConfiguration→BrowserOptionsHttpContextExtensions.GetBrowserOptions.WithBrowserConfiguration→WithBrowserOptions(configureOptions).BrowserOptionsis serialized directly with[JsonPropertyName]plus small internalJsonConverters that adapt the idiomatic C# shapes to the JS-expected JSON (TimeSpan→ milliseconds, positivePreserveDom→disableDomPreservation,LogLevel→ int). JS remains the source of truth and is kept in sync with the .NET bits. No TypeScript changes required.PublicAPI.Unshipped.txtfor both assemblies and the E2E test-asset startup.All types are sealed (as they already were).
ConfigureBrowserretains[Parameter, EditorRequired]onOptionsand[CascadingParameter]onHttpContext.