Accept blazor.web.js startup options format in blazor.server.js and blazor.webassembly.js #64629
Conversation
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
Contributor
|
Greetings! You've submitted a PR that modifies code that is shared with https://github.com/dotnet/runtime . Please make sure you synchronize this code with the changes in that repo! |
…lazor.webassembly.js Co-authored-by: javiercn <6995051+javiercn@users.noreply.github.com>
Co-authored-by: javiercn <6995051+javiercn@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add support for blazor.web.js startup options format
Accept blazor.web.js startup options format in blazor.server.js and blazor.webassembly.js
Dec 3, 2025
Copilot finished work on behalf of
javiercn
December 3, 2025 12:47
Copilot finished reviewing on behalf of
javiercn
December 3, 2025 13:00
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enables blazor.server.js and blazor.webassembly.js to accept the same nested options format used by blazor.web.js, eliminating a pit of failure for developers who copy examples from documentation.
Key Changes:
- Modified boot functions to accept nested
circuit:andwebAssembly:properties - Maintained backward compatibility with top-level options format
- Added E2E tests verifying both formats work correctly
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/Components/Web.JS/src/Boot.Server.ts |
Added type alias and logic to accept nested circuit: property with fallback to top-level options |
src/Components/Web.JS/src/Boot.WebAssembly.ts |
Added type alias and logic to accept nested webAssembly: property with fallback to top-level options |
src/Components/test/E2ETest/ServerExecutionTests/ServerNestedOptionsTest.cs |
Added E2E test verifying nested circuit options work with blazor.server.js |
src/Components/test/E2ETest/Tests/WebAssemblyNestedOptionsTest.cs |
Added E2E test verifying nested webAssembly options work with blazor.webassembly.js |
src/Components/test/testassets/Components.TestServer/Pages/NestedCircuitOptions.cshtml |
Added test page demonstrating nested circuit options format |
src/Components/test/testassets/BasicTestApp/wwwroot/nestedWebAssemblyOptions.html |
Added test page demonstrating nested webAssembly options format |
javiercn
reviewed
Dec 3, 2025
src/Components/test/E2ETest/Tests/WebAssemblyNestedOptionsTest.cs
Outdated
Show resolved
Hide resolved
javiercn
reviewed
Dec 3, 2025
src/Components/test/E2ETest/Tests/WebAssemblyNestedOptionsTest.cs
Outdated
Show resolved
Hide resolved
javiercn
reviewed
Dec 3, 2025
src/Components/test/E2ETest/Tests/WebAssemblyNestedOptionsTest.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: javiercn <6995051+javiercn@users.noreply.github.com>
Contributor
Author
Removed the Regarding the |
Copilot finished work on behalf of
javiercn
December 3, 2025 13:37
MackinnonBuck
approved these changes
Dec 3, 2025
ilonatommy
reviewed
Dec 4, 2025
Comment on lines
39
to
54
| function setElementValue(element, newValue) { | ||
| element.value = newValue; | ||
| return element.value; | ||
| } | ||
|
|
||
| function navigationManagerNavigate() { | ||
| Blazor.navigateTo('/subdir/some-path'); | ||
| } | ||
|
|
||
| function getCurrentUrl() { | ||
| return location.href; | ||
| } | ||
|
|
||
| function getRuntimeBuildConfiguration() { | ||
| return Blazor.runtime.runtimeBuildInfo.buildConfiguration; | ||
| } |
Member
There was a problem hiding this comment.
Why do we need to define all of them for our use case? Here and in server file.
Contributor
Author
There was a problem hiding this comment.
Simplified both test files in f3abc77. Removed all the unnecessary helper functions, script includes, and stylesheets - now they only contain the minimal code needed to test the nested options format.
Member
There was a problem hiding this comment.
Some of them were necessary:
Microsoft.AspNetCore.Components.E2ETest.Tests.WebAssemblyNestedOptionsTest.NestedWebAssemblyOptionsAreAccepted
OpenQA.Selenium.BrowserAssertFailedException : Xunit.Sdk.NotEmptyException: Assert.NotEmpty() Failure: Collection was empty
...
ManagedError: AggregateException_ctor_DefaultMessage (Error: The value 'getCurrentUrl' is not a function.)
Co-authored-by: javiercn <6995051+javiercn@users.noreply.github.com>
Copilot finished work on behalf of
javiercn
December 4, 2025 16:18
javiercn
reviewed
Dec 4, 2025
Member
javiercn
left a comment
javiercn
left a comment
There was a problem hiding this comment.
@copilot run the tests manually
Microsoft.AspNetCore.Components.E2ETest.Tests.WebAssemblyNestedOptionsTest.NestedWebAssemblyOptionsAreAccepted
OpenQA.Selenium.BrowserAssertFailedException : Xunit.Sdk.NotEmptyException: Assert.NotEmpty() Failure: Collection was empty
at Xunit.Assert.NotEmpty(IEnumerable collection) in /_/src/xunit.assert/Asserts/CollectionAsserts.cs:line 539
at Microsoft.AspNetCore.E2ETesting.WaitAssert.<>c__DisplayClass21_0`1.<WaitAssertCore>b__0(IWebDriver _) in /home/vsts/work/1/s/src/Shared/E2ETesting/WaitAssert.cs:line 109
Screen shot captured at '/home/vsts/work/1/s/src/Components/test/E2ETest/bin/screenshots/dfff87a674f94999b9711214ea2035ff.png'
Encountered browser errors
[2025-12-04T16:38:46Z] [Severe] http://127.0.0.1:38907/subdir/_framework/blazor.webassembly.js 0:61163 ManagedError: AggregateException_ctor_DefaultMessage (Error: The value 'getCurrentUrl' is not a function.)Page content:
<head>
<meta charset="utf-8">
<title>Basic test app - Nested WebAssembly Options</title>
<base href="/subdir/">
<link href="style.css" rel="stylesheet">
<link rel="icon" href="data:,">
</head>
<body>
<root>Loading...</root>
<div id="blazor-error-ui" style="display: block;">
An unhandled error has occurred.
<a href="." class="reload">Reload</a>
<span class="dismiss">\ud83d\uddd9</span>
</div>
<script src="_framework/blazor.webassembly.js" autostart="false"></script>
<script>
Blazor.start({
webAssembly: {
configureRuntime: dotnet => {
dotnet.withEnvironmentVariable("CONFIGURE_RUNTIME", "true");
}
}
});
</script>
</body>
---- Assert.NotEmpty() Failure: Collection was empty
…onfiguration function Co-authored-by: javiercn <6995051+javiercn@users.noreply.github.com>
Contributor
Author
javiercn
reviewed
Dec 5, 2025
Member
javiercn
left a comment
javiercn
left a comment
There was a problem hiding this comment.
@copilot Microsoft.AspNetCore.Components.E2ETest.Tests.WebAssemblyNestedOptionsTest.NestedWebAssemblyOptionsAreAccepted is still failing.
Follow src/Components/AGENTS.md
Take a deep look into your heart, run the test with dotnet test DisplayName~NestedWebAssemblyOptionsAreAccepted to ensure it is fixed after you make changes and don't send an update until you get those tests passing.
Co-authored-by: javiercn <6995051+javiercn@users.noreply.github.com>
auto-merge was automatically disabled
December 5, 2025 11:22
Head branch was pushed to by a user without write access
Copilot stopped work on behalf of
javiercn due to an error
December 5, 2025 11:22
Member
|
@copilot Try again |
…separate HTML file Co-authored-by: javiercn <6995051+javiercn@users.noreply.github.com>
Contributor
Author
Fixed in 7181172. The test now passes locally. Changed approach: instead of using a separate HTML file (which had issues with static file serving), I modified Both tests pass:
Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot finished work on behalf of
javiercn
December 5, 2025 11:56
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.
Boot.Server.tsto accept thecircuit:nested option formatBoot.WebAssembly.tsto accept thewebAssembly:nested option format///XML doc comments from test filesChanges in this commit
index.htmlto support both top-level and nested options format via?nested-options=truequery parameterWebAssemblyNestedOptionsTest.csto navigate with query parameter instead of separate HTML filenestedWebAssemblyOptions.htmlfile that wasn't being served correctlySecurity Summary
No security vulnerabilities were introduced by these changes.
Original prompt
This section details on the original issue you should resolve
<issue_title>[Blazor] Accept the
blazor.web.jsstartup options format inblazor.{server|webassembly}.js</issue_title><issue_description>## Problem
When a Blazor app uses
blazor.web.js, the options object passed toBlazor.start()has the following format:However, when using
blazor.server.jsorblazor.webassembly.js, runtime-specific options are specified as top-level properties on the options object. So, for example, if you're usingblazor.webassembly.jsand you attempt to customize the loading of boot resources like this:...then it will just silently "not work". This could create a pit of failure for customers who see examples in docs using the
blazor.web.jsoptions format but are writing a Blazor WebAssembly standalone app, for example.Solution
We should update
blazor.webassembly.jsandblazor.server.jsto accept the options format used byblazor.web.js.Include end-to-end test that will assert that options are passed correctly
Summary Comment: #51611 (comment)
</issue_description>
<agent_instructions>Follow the instructions in src/Components/Agents.md
You MUST follow this workflow when implementing new features or fixing bugs in the Components area.
todosand follow it strictly.In this case, for the E2E tests you can probably modify one of the
App.razorfiles in the testassets that use blazor.web.js and take parameters to use the new format. Make sure that there is at least one file that uses the new format and one that uses the old format.</agent_instructions>Comments on the Issue (you are @copilot in this section)
@ Thanks for contacting us.We're moving this issue to the
.NET 9 Planningmilestone for future evaluation / consideration. We would like to keep this around to collect more feedback, which can help us with prioritizing this work. We will re-evaluate this issue, during our next planning meeting(s).If we later determine, that the issue has no community involvement, or it's very rare and low-impact issue, we will close it - so that the team can focus on more important and high impact issues.
To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.</comment_new>
<comment_new>@
Thanks for contacting us.
We're moving this issue to the
.NET 9 Planningmilestone for future evaluation / consideration. We would like to keep this around to collect more feedback, which can help us with prioritizing this work. We will re-evaluate this issue, during our next planning meeting(s).If we later determine, that the issue has no community involvement, or it's very rare and low-impact issue, we will close it - so that the team can focus on more important and high impact issues.
To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.</comment_new>
<comment_new>@MackinnonBuck
Help Wanted
Issue Summary
See #51611 (comment)
Potential Design
We can add one additional property to
CircuitStartOptionsand `WebAssemblySt...blazor.web.jsstartup options format inblazor.{server|webassembly}.js#51611✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.