[browser] Update browser template to use Wasm SDK#90871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
radical merged 18 commits into from
Aug 23, 2023
Merged

[browser] Update browser template to use Wasm SDK #90871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
827b090
Use WasmSdk in browser template
maraf Aug 17, 2023
b2ff838
Remove default html-path
maraf Aug 18, 2023
59498d1
Use wwwroot when looking for main.js in template for replacement
maraf Aug 18, 2023
351651f
Temporarily remove WasmRuntimeAssetsLocation from WBT because WasmSDK…
maraf Aug 18, 2023
d6698d5
Integrate console log forward into DevServer
maraf Aug 18, 2023
41f0c75
Replace UseRouter
maraf Aug 18, 2023
9600a1e
Use next middleware only if it's not console
maraf Aug 21, 2023
139ff28
CancellationTokenSource on CancelKeyPress
maraf Aug 21, 2023
0350207
Address feedback from initial DevServer integration
maraf Aug 21, 2023
9948fe5
Update src/mono/wasm/host/BrowserHost.cs
maraf Aug 22, 2023
cc20713
Remove debugging code
maraf Aug 22, 2023
f0076c8
Fix WBT
maraf Aug 22, 2023
6b66a33
Fix starting outside of project directory
maraf Aug 22, 2023
33ec123
Merge remote-tracking branch 'upstream/main' into WasmSdkTemplate2
maraf Aug 22, 2023
b3844c0
Support WasmRuntimeAssetsLocation in Wasm SDK
maraf Aug 22, 2023
18d9da5
Revert "Support WasmRuntimeAssetsLocation in Wasm SDK"
maraf Aug 23, 2023
c448e94
Active issue for WasmRuntimeAssetsLocation
maraf Aug 23, 2023
cfaf8c0
Feedback
maraf Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions ...et/Microsoft.NET.Sdk.WebAssembly.Pack/build/Microsoft.NET.Sdk.WebAssembly.Browser.targets
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,13 @@ Copyright (c) .NET Foundation. All rights reserved.
<RunCommand Condition="'$(RunCommand)' == ''">dotnet</RunCommand>

<WasmAppHostDir>$([MSBuild]::NormalizeDirectory($(MSBuildThisFileDirectory), '..', 'WasmAppHost'))</WasmAppHostDir>
<_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(OutputPath), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

<_RunWorkingDirectory>$(OutputPath)</_RunWorkingDirectory>
<_RunWorkingDirectory Condition="'$(_RunWorkingDirectory)' != '' and !$([System.IO.Path]::IsPathRooted($(_RunWorkingDirectory)))">$([System.IO.Path]::Combine($(MSBuildProjectDirectory), $(_RunWorkingDirectory)))</_RunWorkingDirectory>
<_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(_RunWorkingDirectory), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

<RunArguments>exec &quot;$([MSBuild]::NormalizePath($(WasmAppHostDir), 'WasmAppHost.dll'))&quot; --use-staticwebassets --runtime-config &quot;$(_RuntimeConfigJsonPath)&quot; $(WasmHostArguments)</RunArguments>
<RunWorkingDirectory>$(OutputPath)</RunWorkingDirectory>
<RunWorkingDirectory>$(_RunWorkingDirectory)</RunWorkingDirectory>
</PropertyGroup>

<PropertyGroup>
Expand Down
7 changes: 4 additions & 3 deletions src/mono/wasm/Wasm.Build.Tests/Templates/WasmTemplateTests.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private void UpdateProgramCS()

private void UpdateBrowserMainJs(string targetFramework, string runtimeAssetsRelativePath = DefaultRuntimeAssetsRelativePath)
{
string mainJsPath = Path.Combine(_projectDir!, "main.js");
string mainJsPath = Path.Combine(_projectDir!, "wwwroot", "main.js");
string mainJsContent = File.ReadAllText(mainJsPath);

// .withExitOnUnhandledError() is available only only >net7.0
Expand DownExpand Up@@ -408,11 +408,12 @@ public void ConsolePublishAndRun(string config, bool aot, bool relinking)

[Theory]
[InlineData("", BuildTestBase.DefaultTargetFramework, DefaultRuntimeAssetsRelativePath)]
[InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
// [ActiveIssue("https://github.com/dotnet/runtime/issues/90979")]
// [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
// [InlineData("-f net8.0", "net8.0", "./")]
// [ActiveIssue("https://github.com/dotnet/runtime/issues/79313")]
// [InlineData("-f net7.0", "net7.0")]
[InlineData("-f net8.0", "net8.0", DefaultRuntimeAssetsRelativePath)]
[InlineData("-f net8.0", "net8.0", "./")]
public async Task BrowserBuildAndRun(string extraNewArgs, string targetFramework, string runtimeAssetsRelativePath)
{
string config = "Debug";
Expand Down
15 changes: 15 additions & 0 deletions src/mono/wasm/Wasm.Build.Tests/WasmSdkBasedProjectProvider.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,21 @@ protected override IReadOnlySet<string> GetDotNetFilesExpectedSet(AssertBundleOp
return res;
}


public void AssertBundle(BuildArgs buildArgs, BuildProjectOptions buildProjectOptions)
{
AssertBundle(new(
Config: buildArgs.Config,
IsPublish: buildProjectOptions.Publish,
TargetFramework: buildProjectOptions.TargetFramework,
BinFrameworkDir: buildProjectOptions.BinFrameworkDir ?? FindBinFrameworkDir(buildArgs.Config, buildProjectOptions.Publish, buildProjectOptions.TargetFramework),
PredefinedIcudt: buildProjectOptions.PredefinedIcudt,
GlobalizationMode: buildProjectOptions.GlobalizationMode,
AssertSymbolsFile: false,
ExpectedFileType: buildProjectOptions.Publish && buildArgs.Config == "Release" ? NativeFilesType.Relinked : NativeFilesType.FromRuntimePack
));
}

public void AssertBundle(AssertWasmSdkBundleOptions assertOptions)
{
IReadOnlyDictionary<string, DotNetFileName> actualDotnetFiles = AssertBasicBundle(assertOptions);
Expand Down
28 changes: 23 additions & 5 deletions src/mono/wasm/Wasm.Build.Tests/WasmTemplateTestBase.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,31 +59,49 @@ public string CreateWasmTemplateProject(string id, string template = "wasmbrowse

public (string projectDir, string buildOutput) BuildTemplateProject(BuildArgs buildArgs,
string id,
BuildProjectOptions buildProjectOptions,
AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
BuildProjectOptions buildProjectOptions)
{
(CommandResult res, string logFilePath) = BuildProjectWithoutAssert(id, buildArgs.Config, buildProjectOptions);
if (buildProjectOptions.UseCache)
_buildContext.CacheBuild(buildArgs, new BuildProduct(_projectDir!, logFilePath, true, res.Output));

if (buildProjectOptions.AssertAppBundle)
AssertBundle(buildArgs, buildProjectOptions, res.Output, assertAppBundleOptions);
{
if (buildProjectOptions.IsBrowserProject)
AssertWasmSdkBundle(buildArgs, buildProjectOptions, res.Output);
else
AssertTestMainJsBundle(buildArgs, buildProjectOptions, res.Output);
}
return (_projectDir!, res.Output);
}

public void AssertBundle(BuildArgs buildArgs,
public void AssertTestMainJsBundle(BuildArgs buildArgs,
Comment thread
radical marked this conversation as resolved.
BuildProjectOptions buildProjectOptions,
string? buildOutput = null,
AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
{
if (buildOutput is not null)
ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

// TODO: templates don't use wasm sdk yet
var testMainJsProvider = new TestMainJsProjectProvider(_testOutput, _projectDir!);
if (assertAppBundleOptions is not null)
testMainJsProvider.AssertBundle(assertAppBundleOptions);
else
testMainJsProvider.AssertBundle(buildArgs, buildProjectOptions);
}

public void AssertWasmSdkBundle(BuildArgs buildArgs,
BuildProjectOptions buildProjectOptions,
string? buildOutput = null,
AssertWasmSdkBundleOptions? assertAppBundleOptions = null)
{
if (buildOutput is not null)
ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

var projectProvider = new WasmSdkBasedProjectProvider(_testOutput, _projectDir!);
if (assertAppBundleOptions is not null)
projectProvider.AssertBundle(assertAppBundleOptions);
else
projectProvider.AssertBundle(buildArgs, buildProjectOptions);
}
}
4 changes: 2 additions & 2 deletions src/mono/wasm/host/BrowserHost.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,7 +167,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
devServerOptions = CreateDevServerOptions(urls, staticWebAssetsPath, onConsoleConnected);

if (devServerOptions == null)
throw new CommandLineException("Please, provide mainAssembly in hostProperties of runtimeconfig");
throw new CommandLineException($"Please, provide mainAssembly in hostProperties of runtimeconfig. Alternatively leave the static web assets manifest ('*{staticWebAssetsV2Extension}') in the build output directory '{appPath}' .");
}

return devServerOptions;
Expand All@@ -183,7 +183,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
);

private static string? FindFirstFileWithExtension(string directory, string extension)
=> Directory.EnumerateFiles(directory, "*" + extension).First();
=> Directory.EnumerateFiles(directory, "*" + extension).FirstOrDefault();

private async Task RunConsoleMessagesPump(WebSocket socket, WasmTestMessagesProcessor messagesProcessor, CancellationToken token)
{
Expand Down
3 changes: 1 addition & 2 deletions src/mono/wasm/host/DevServer/DevServer.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -70,8 +70,7 @@ private static IConfiguration ConfigureHostConfiguration(DevServerOptions option
[WebHostDefaults.EnvironmentKey] = "Development",
["Logging:LogLevel:Microsoft"] = "Warning",
["Logging:LogLevel:Microsoft.Hosting.Lifetime"] = "Information",
[WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath,
["ApplyCopHeaders"] = options.WebServerUseCrossOriginPolicy.ToString()
[WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath
};

config.AddInMemoryCollection(inMemoryConfiguration);
Expand Down
34 changes: 30 additions & 4 deletions src/mono/wasm/host/DevServer/DevServerStartup.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,13 +2,16 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.IO;
using System.Net.WebSockets;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.WebAssembly.AppHost;

namespace Microsoft.WebAssembly.AppHost.DevServer;
Expand All@@ -27,16 +30,16 @@ public static void ConfigureServices(IServiceCollection services)
services.AddRouting();
}

public static void Configure(IApplicationBuilder app, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
public static void Configure(IApplicationBuilder app, IOptions<DevServerOptions> optionsContainer, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
{
app.UseDeveloperExceptionPage();
EnableConfiguredPathbase(app, configuration);

app.UseWebAssemblyDebugging();

bool applyCopHeaders = configuration.GetValue<bool>("ApplyCopHeaders");
DevServerOptions options = optionsContainer.Value;

if (applyCopHeaders)
if (options.WebServerUseCrossOriginPolicy)
{
app.Use(async (ctx, next) =>
{
Expand All@@ -63,14 +66,37 @@ public static void Configure(IApplicationBuilder app, TaskCompletionSource<Serve
});

app.UseRouting();
app.UseWebSockets();

if (options.OnConsoleConnected is not null)
{
app.Use(async (ctx, next) =>
{
if (ctx.Request.Path.StartsWithSegments("/console"))
{
if (!ctx.WebSockets.IsWebSocketRequest)
{
ctx.Response.StatusCode = 400;
return;
}

using WebSocket socket = await ctx.WebSockets.AcceptWebSocketAsync();
await options.OnConsoleConnected(socket);
}
else
{
await next(ctx);
}
});
}

app.UseEndpoints(endpoints =>
{
endpoints.MapFallbackToFile("index.html", new StaticFileOptions
{
OnPrepareResponse = fileContext =>
{
if (applyCopHeaders)
if (options.WebServerUseCrossOriginPolicy)
{
// Browser multi-threaded runtime requires cross-origin policy headers to enable SharedArrayBuffer.
ApplyCrossOriginPolicyHeaders(fileContext.Context);
Expand Down
3 changes: 3 additions & 0 deletions src/mono/wasm/host/Program.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ public static async Task<int> Main(string[] args)
RegisterHostHandler(WasmHost.Wasmtime, WasiEngineHost.InvokeAsync);

using CancellationTokenSource cts = new();

Console.CancelKeyPress += (object? sender, ConsoleCancelEventArgs e) => cts.Cancel();
Comment thread
maraf marked this conversation as resolved.

ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
builder
.AddPassThroughConsole()
Expand Down
26 changes: 0 additions & 26 deletions src/mono/wasm/templates/templates/browser/README.md
View file
Open in desktop

This file was deleted.

11 changes: 2 additions & 9 deletions src/mono/wasm/templates/templates/browser/browser.0.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk.WebAssembly">
<PropertyGroup>
<TargetFramework>net7.0</TargetFramework>
<RuntimeIdentifier>browser-wasm</RuntimeIdentifier>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
</PropertyGroup>

<ItemGroup>
<WasmExtraFilesToDeploy Include="index.html" />
<WasmExtraFilesToDeploy Include="main.js" />
</ItemGroup>
</Project>
5 changes: 2 additions & 3 deletions src/mono/wasm/templates/templates/browser/runtimeconfig.template.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,9 +3,8 @@
"perHostConfig": [
{
"name": "browser",
"html-path": "index.html",
"Host": "browser"
"host": "browser"
}
]
}
}
}
0 ...sm/templates/templates/browser/index.html → ...ates/templates/browser/wwwroot/index.html
View file
Open in desktop
File renamed without changes.
0 .../wasm/templates/templates/browser/main.js → ...mplates/templates/browser/wwwroot/main.js
View file
Open in desktop
File renamed without changes.
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
[browser] Update browser template to use Wasm SDK#90871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

radical
merged 18 commits into

from

Aug 23, 2023
 Merged


[browser] Update browser template to use Wasm SDK
#90871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


18 commits


Select commit
Hold shift + click to select a range
827b090

Use WasmSdk in browser template


maraf Aug 17, 2023
b2ff838

Remove default html-path


maraf Aug 18, 2023
59498d1

Use wwwroot when looking for main.js in template for replacement


maraf Aug 18, 2023
351651f

Temporarily remove WasmRuntimeAssetsLocation from WBT because WasmSDK…


maraf Aug 18, 2023
d6698d5

Integrate console log forward into DevServer


maraf Aug 18, 2023
41f0c75

Replace UseRouter


maraf Aug 18, 2023
9600a1e

Use next middleware only if it's not console


maraf Aug 21, 2023
139ff28

CancellationTokenSource on CancelKeyPress


maraf Aug 21, 2023
0350207

Address feedback from initial DevServer integration


maraf Aug 21, 2023
9948fe5

Update src/mono/wasm/host/BrowserHost.cs


maraf Aug 22, 2023
cc20713

Remove debugging code


maraf Aug 22, 2023
f0076c8

Fix WBT


maraf Aug 22, 2023
6b66a33

Fix starting outside of project directory


maraf Aug 22, 2023
33ec123

Merge remote-tracking branch 'upstream/main' into WasmSdkTemplate2


maraf Aug 22, 2023
b3844c0

Support WasmRuntimeAssetsLocation in Wasm SDK


maraf Aug 22, 2023
18d9da5

Revert "Support WasmRuntimeAssetsLocation in Wasm SDK"


maraf Aug 23, 2023
c448e94

Active issue for WasmRuntimeAssetsLocation


maraf Aug 23, 2023
cfaf8c0

Feedback


maraf Aug 23, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 6 additions & 2 deletions
...et/Microsoft.NET.Sdk.WebAssembly.Pack/build/Microsoft.NET.Sdk.WebAssembly.Browser.targets

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,13 @@ Copyright (c) .NET Foundation. All rights reserved.
 <RunCommand Condition="'$(RunCommand)' == ''">dotnet</RunCommand>

 <WasmAppHostDir>$([MSBuild]::NormalizeDirectory($(MSBuildThisFileDirectory), '..', 'WasmAppHost'))</WasmAppHostDir>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(OutputPath), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <_RunWorkingDirectory>$(OutputPath)</_RunWorkingDirectory>
 <_RunWorkingDirectory Condition="'$(_RunWorkingDirectory)' != '' and !$([System.IO.Path]::IsPathRooted($(_RunWorkingDirectory)))">$([System.IO.Path]::Combine($(MSBuildProjectDirectory), $(_RunWorkingDirectory)))</_RunWorkingDirectory>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(_RunWorkingDirectory), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <RunArguments>exec &quot;$([MSBuild]::NormalizePath($(WasmAppHostDir), 'WasmAppHost.dll'))&quot; --use-staticwebassets --runtime-config &quot;$(_RuntimeConfigJsonPath)&quot; $(WasmHostArguments)</RunArguments>
 <RunWorkingDirectory>$(OutputPath)</RunWorkingDirectory>
 <RunWorkingDirectory>$(_RunWorkingDirectory)</RunWorkingDirectory>
 </PropertyGroup>

 <PropertyGroup>
Expand Down

7 changes: 4 additions & 3 deletions
src/mono/wasm/Wasm.Build.Tests/Templates/WasmTemplateTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private void UpdateProgramCS()

 private void UpdateBrowserMainJs(string targetFramework, string runtimeAssetsRelativePath = DefaultRuntimeAssetsRelativePath)
 {
 string mainJsPath = Path.Combine(_projectDir!, "main.js");
 string mainJsPath = Path.Combine(_projectDir!, "wwwroot", "main.js");
 string mainJsContent = File.ReadAllText(mainJsPath);

 // .withExitOnUnhandledError() is available only only >net7.0
Expand DownExpand Up@@ -408,11 +408,12 @@ public void ConsolePublishAndRun(string config, bool aot, bool relinking)

 [Theory]
 [InlineData("", BuildTestBase.DefaultTargetFramework, DefaultRuntimeAssetsRelativePath)]
 [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/90979")]
 // [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [InlineData("-f net8.0", "net8.0", "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/79313")]
 // [InlineData("-f net7.0", "net7.0")]
 [InlineData("-f net8.0", "net8.0", DefaultRuntimeAssetsRelativePath)]
 [InlineData("-f net8.0", "net8.0", "./")]
 public async Task BrowserBuildAndRun(string extraNewArgs, string targetFramework, string runtimeAssetsRelativePath)
 {
 string config = "Debug";
Expand Down

15 changes: 15 additions & 0 deletions
src/mono/wasm/Wasm.Build.Tests/WasmSdkBasedProjectProvider.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,21 @@ protected override IReadOnlySet<string> GetDotNetFilesExpectedSet(AssertBundleOp
 return res;
 }


 public void AssertBundle(BuildArgs buildArgs, BuildProjectOptions buildProjectOptions)
 {
 AssertBundle(new(
 Config: buildArgs.Config,
 IsPublish: buildProjectOptions.Publish,
 TargetFramework: buildProjectOptions.TargetFramework,
 BinFrameworkDir: buildProjectOptions.BinFrameworkDir ?? FindBinFrameworkDir(buildArgs.Config, buildProjectOptions.Publish, buildProjectOptions.TargetFramework),
 PredefinedIcudt: buildProjectOptions.PredefinedIcudt,
 GlobalizationMode: buildProjectOptions.GlobalizationMode,
 AssertSymbolsFile: false,
 ExpectedFileType: buildProjectOptions.Publish && buildArgs.Config == "Release" ? NativeFilesType.Relinked : NativeFilesType.FromRuntimePack
 ));
 }

 public void AssertBundle(AssertWasmSdkBundleOptions assertOptions)
 {
 IReadOnlyDictionary<string, DotNetFileName> actualDotnetFiles = AssertBasicBundle(assertOptions);
Expand Down

28 changes: 23 additions & 5 deletions
src/mono/wasm/Wasm.Build.Tests/WasmTemplateTestBase.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,31 +59,49 @@ public string CreateWasmTemplateProject(string id, string template = "wasmbrowse

 public (string projectDir, string buildOutput) BuildTemplateProject(BuildArgs buildArgs,
 string id,
 BuildProjectOptions buildProjectOptions,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 BuildProjectOptions buildProjectOptions)
 {
 (CommandResult res, string logFilePath) = BuildProjectWithoutAssert(id, buildArgs.Config, buildProjectOptions);
 if (buildProjectOptions.UseCache)
 _buildContext.CacheBuild(buildArgs, new BuildProduct(_projectDir!, logFilePath, true, res.Output));

 if (buildProjectOptions.AssertAppBundle)
 AssertBundle(buildArgs, buildProjectOptions, res.Output, assertAppBundleOptions);
 {
 if (buildProjectOptions.IsBrowserProject)
 AssertWasmSdkBundle(buildArgs, buildProjectOptions, res.Output);
 else
 AssertTestMainJsBundle(buildArgs, buildProjectOptions, res.Output);
 }
 return (_projectDir!, res.Output);
 }

 public void AssertBundle(BuildArgs buildArgs,
 public void AssertTestMainJsBundle(BuildArgs buildArgs,
Comment thread
radical marked this conversation as resolved.

 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 // TODO: templates don't use wasm sdk yet
 var testMainJsProvider = new TestMainJsProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 testMainJsProvider.AssertBundle(assertAppBundleOptions);
 else
 testMainJsProvider.AssertBundle(buildArgs, buildProjectOptions);
 }

 public void AssertWasmSdkBundle(BuildArgs buildArgs,
 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertWasmSdkBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 var projectProvider = new WasmSdkBasedProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 projectProvider.AssertBundle(assertAppBundleOptions);
 else
 projectProvider.AssertBundle(buildArgs, buildProjectOptions);
 }
}

4 changes: 2 additions & 2 deletions
src/mono/wasm/host/BrowserHost.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,7 +167,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 devServerOptions = CreateDevServerOptions(urls, staticWebAssetsPath, onConsoleConnected);

 if (devServerOptions == null)
 throw new CommandLineException("Please, provide mainAssembly in hostProperties of runtimeconfig");
 throw new CommandLineException($"Please, provide mainAssembly in hostProperties of runtimeconfig. Alternatively leave the static web assets manifest ('*{staticWebAssetsV2Extension}') in the build output directory '{appPath}' .");
 }

 return devServerOptions;
Expand All@@ -183,7 +183,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 );

 private static string? FindFirstFileWithExtension(string directory, string extension)
 => Directory.EnumerateFiles(directory, "*" + extension).First();
 => Directory.EnumerateFiles(directory, "*" + extension).FirstOrDefault();

 private async Task RunConsoleMessagesPump(WebSocket socket, WasmTestMessagesProcessor messagesProcessor, CancellationToken token)
 {
Expand Down

3 changes: 1 addition & 2 deletions
src/mono/wasm/host/DevServer/DevServer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,8 +70,7 @@ private static IConfiguration ConfigureHostConfiguration(DevServerOptions option
 [WebHostDefaults.EnvironmentKey] = "Development",
 ["Logging:LogLevel:Microsoft"] = "Warning",
 ["Logging:LogLevel:Microsoft.Hosting.Lifetime"] = "Information",
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath,
 ["ApplyCopHeaders"] = options.WebServerUseCrossOriginPolicy.ToString()
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath
 };

 config.AddInMemoryCollection(inMemoryConfiguration);
Expand Down

34 changes: 30 additions & 4 deletions
src/mono/wasm/host/DevServer/DevServerStartup.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,13 +2,16 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.IO;
using System.Net.WebSockets;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.WebAssembly.AppHost;

namespace Microsoft.WebAssembly.AppHost.DevServer;
Expand All@@ -27,16 +30,16 @@ public static void ConfigureServices(IServiceCollection services)
 services.AddRouting();
 }

 public static void Configure(IApplicationBuilder app, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 public static void Configure(IApplicationBuilder app, IOptions<DevServerOptions> optionsContainer, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 {
 app.UseDeveloperExceptionPage();
 EnableConfiguredPathbase(app, configuration);

 app.UseWebAssemblyDebugging();

bool applyCopHeaders = configuration.GetValue<bool>("ApplyCopHeaders");
DevServerOptions options = optionsContainer.Value;

 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 app.Use(async (ctx, next) =>
 {
Expand All@@ -63,14 +66,37 @@ public static void Configure(IApplicationBuilder app, TaskCompletionSource<Serve
 });

 app.UseRouting();
 app.UseWebSockets();

 if (options.OnConsoleConnected is not null)
 {
 app.Use(async (ctx, next) =>
 {
 if (ctx.Request.Path.StartsWithSegments("/console"))
 {
 if (!ctx.WebSockets.IsWebSocketRequest)
 {
 ctx.Response.StatusCode = 400;
 return;
 }

 using WebSocket socket = await ctx.WebSockets.AcceptWebSocketAsync();
 await options.OnConsoleConnected(socket);
 }
 else
 {
 await next(ctx);
 }
 });
 }

 app.UseEndpoints(endpoints =>
 {
 endpoints.MapFallbackToFile("index.html", new StaticFileOptions
 {
 OnPrepareResponse = fileContext =>
 {
 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 // Browser multi-threaded runtime requires cross-origin policy headers to enable SharedArrayBuffer.
 ApplyCrossOriginPolicyHeaders(fileContext.Context);
Expand Down

3 changes: 3 additions & 0 deletions
src/mono/wasm/host/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ public static async Task<int> Main(string[] args)
 RegisterHostHandler(WasmHost.Wasmtime, WasiEngineHost.InvokeAsync);

 using CancellationTokenSource cts = new();

 Console.CancelKeyPress += (object? sender, ConsoleCancelEventArgs e) => cts.Cancel();
Comment thread
maraf marked this conversation as resolved.


 ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
 builder
 .AddPassThroughConsole()
Expand Down

26 changes: 0 additions & 26 deletions
src/mono/wasm/templates/templates/browser/README.md

View file


Open in desktop


This file was deleted.


11 changes: 2 additions & 9 deletions
src/mono/wasm/templates/templates/browser/browser.0.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk.WebAssembly">
 <PropertyGroup>
 <TargetFramework>net7.0</TargetFramework>
 <RuntimeIdentifier>browser-wasm</RuntimeIdentifier>
 <OutputType>Exe</OutputType>
 <TargetFramework>net8.0</TargetFramework>
 <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 </PropertyGroup>

 <ItemGroup>
 <WasmExtraFilesToDeploy Include="index.html" />
 <WasmExtraFilesToDeploy Include="main.js" />
 </ItemGroup>
</Project>

5 changes: 2 additions & 3 deletions
src/mono/wasm/templates/templates/browser/runtimeconfig.template.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,9 +3,8 @@
 "perHostConfig": [
 {
 "name": "browser",
 "html-path": "index.html",
 "Host": "browser"
 "host": "browser"
 }
 ]
 }
}
}

0
...sm/templates/templates/browser/index.html → ...ates/templates/browser/wwwroot/index.html

View file


Open in desktop


File renamed without changes.


0
.../wasm/templates/templates/browser/main.js → ...mplates/templates/browser/wwwroot/main.js

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[browser] Update browser template to use Wasm SDK#90871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

radical
merged 18 commits into

from

Aug 23, 2023
 Merged


[browser] Update browser template to use Wasm SDK
#90871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


18 commits


Select commit
Hold shift + click to select a range
827b090

Use WasmSdk in browser template


maraf Aug 17, 2023
b2ff838

Remove default html-path


maraf Aug 18, 2023
59498d1

Use wwwroot when looking for main.js in template for replacement


maraf Aug 18, 2023
351651f

Temporarily remove WasmRuntimeAssetsLocation from WBT because WasmSDK…


maraf Aug 18, 2023
d6698d5

Integrate console log forward into DevServer


maraf Aug 18, 2023
41f0c75

Replace UseRouter


maraf Aug 18, 2023
9600a1e

Use next middleware only if it's not console


maraf Aug 21, 2023
139ff28

CancellationTokenSource on CancelKeyPress


maraf Aug 21, 2023
0350207

Address feedback from initial DevServer integration


maraf Aug 21, 2023
9948fe5

Update src/mono/wasm/host/BrowserHost.cs


maraf Aug 22, 2023
cc20713

Remove debugging code


maraf Aug 22, 2023
f0076c8

Fix WBT


maraf Aug 22, 2023
6b66a33

Fix starting outside of project directory


maraf Aug 22, 2023
33ec123

Merge remote-tracking branch 'upstream/main' into WasmSdkTemplate2


maraf Aug 22, 2023
b3844c0

Support WasmRuntimeAssetsLocation in Wasm SDK


maraf Aug 22, 2023
18d9da5

Revert "Support WasmRuntimeAssetsLocation in Wasm SDK"


maraf Aug 23, 2023
c448e94

Active issue for WasmRuntimeAssetsLocation


maraf Aug 23, 2023
cfaf8c0

Feedback


maraf Aug 23, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 6 additions & 2 deletions
...et/Microsoft.NET.Sdk.WebAssembly.Pack/build/Microsoft.NET.Sdk.WebAssembly.Browser.targets

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,13 @@ Copyright (c) .NET Foundation. All rights reserved.
 <RunCommand Condition="'$(RunCommand)' == ''">dotnet</RunCommand>

 <WasmAppHostDir>$([MSBuild]::NormalizeDirectory($(MSBuildThisFileDirectory), '..', 'WasmAppHost'))</WasmAppHostDir>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(OutputPath), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <_RunWorkingDirectory>$(OutputPath)</_RunWorkingDirectory>
 <_RunWorkingDirectory Condition="'$(_RunWorkingDirectory)' != '' and !$([System.IO.Path]::IsPathRooted($(_RunWorkingDirectory)))">$([System.IO.Path]::Combine($(MSBuildProjectDirectory), $(_RunWorkingDirectory)))</_RunWorkingDirectory>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(_RunWorkingDirectory), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <RunArguments>exec &quot;$([MSBuild]::NormalizePath($(WasmAppHostDir), 'WasmAppHost.dll'))&quot; --use-staticwebassets --runtime-config &quot;$(_RuntimeConfigJsonPath)&quot; $(WasmHostArguments)</RunArguments>
 <RunWorkingDirectory>$(OutputPath)</RunWorkingDirectory>
 <RunWorkingDirectory>$(_RunWorkingDirectory)</RunWorkingDirectory>
 </PropertyGroup>

 <PropertyGroup>
Expand Down

7 changes: 4 additions & 3 deletions
src/mono/wasm/Wasm.Build.Tests/Templates/WasmTemplateTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private void UpdateProgramCS()

 private void UpdateBrowserMainJs(string targetFramework, string runtimeAssetsRelativePath = DefaultRuntimeAssetsRelativePath)
 {
 string mainJsPath = Path.Combine(_projectDir!, "main.js");
 string mainJsPath = Path.Combine(_projectDir!, "wwwroot", "main.js");
 string mainJsContent = File.ReadAllText(mainJsPath);

 // .withExitOnUnhandledError() is available only only >net7.0
Expand DownExpand Up@@ -408,11 +408,12 @@ public void ConsolePublishAndRun(string config, bool aot, bool relinking)

 [Theory]
 [InlineData("", BuildTestBase.DefaultTargetFramework, DefaultRuntimeAssetsRelativePath)]
 [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/90979")]
 // [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [InlineData("-f net8.0", "net8.0", "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/79313")]
 // [InlineData("-f net7.0", "net7.0")]
 [InlineData("-f net8.0", "net8.0", DefaultRuntimeAssetsRelativePath)]
 [InlineData("-f net8.0", "net8.0", "./")]
 public async Task BrowserBuildAndRun(string extraNewArgs, string targetFramework, string runtimeAssetsRelativePath)
 {
 string config = "Debug";
Expand Down

15 changes: 15 additions & 0 deletions
src/mono/wasm/Wasm.Build.Tests/WasmSdkBasedProjectProvider.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,21 @@ protected override IReadOnlySet<string> GetDotNetFilesExpectedSet(AssertBundleOp
 return res;
 }


 public void AssertBundle(BuildArgs buildArgs, BuildProjectOptions buildProjectOptions)
 {
 AssertBundle(new(
 Config: buildArgs.Config,
 IsPublish: buildProjectOptions.Publish,
 TargetFramework: buildProjectOptions.TargetFramework,
 BinFrameworkDir: buildProjectOptions.BinFrameworkDir ?? FindBinFrameworkDir(buildArgs.Config, buildProjectOptions.Publish, buildProjectOptions.TargetFramework),
 PredefinedIcudt: buildProjectOptions.PredefinedIcudt,
 GlobalizationMode: buildProjectOptions.GlobalizationMode,
 AssertSymbolsFile: false,
 ExpectedFileType: buildProjectOptions.Publish && buildArgs.Config == "Release" ? NativeFilesType.Relinked : NativeFilesType.FromRuntimePack
 ));
 }

 public void AssertBundle(AssertWasmSdkBundleOptions assertOptions)
 {
 IReadOnlyDictionary<string, DotNetFileName> actualDotnetFiles = AssertBasicBundle(assertOptions);
Expand Down

28 changes: 23 additions & 5 deletions
src/mono/wasm/Wasm.Build.Tests/WasmTemplateTestBase.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,31 +59,49 @@ public string CreateWasmTemplateProject(string id, string template = "wasmbrowse

 public (string projectDir, string buildOutput) BuildTemplateProject(BuildArgs buildArgs,
 string id,
 BuildProjectOptions buildProjectOptions,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 BuildProjectOptions buildProjectOptions)
 {
 (CommandResult res, string logFilePath) = BuildProjectWithoutAssert(id, buildArgs.Config, buildProjectOptions);
 if (buildProjectOptions.UseCache)
 _buildContext.CacheBuild(buildArgs, new BuildProduct(_projectDir!, logFilePath, true, res.Output));

 if (buildProjectOptions.AssertAppBundle)
 AssertBundle(buildArgs, buildProjectOptions, res.Output, assertAppBundleOptions);
 {
 if (buildProjectOptions.IsBrowserProject)
 AssertWasmSdkBundle(buildArgs, buildProjectOptions, res.Output);
 else
 AssertTestMainJsBundle(buildArgs, buildProjectOptions, res.Output);
 }
 return (_projectDir!, res.Output);
 }

 public void AssertBundle(BuildArgs buildArgs,
 public void AssertTestMainJsBundle(BuildArgs buildArgs,
Comment thread
radical marked this conversation as resolved.

 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 // TODO: templates don't use wasm sdk yet
 var testMainJsProvider = new TestMainJsProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 testMainJsProvider.AssertBundle(assertAppBundleOptions);
 else
 testMainJsProvider.AssertBundle(buildArgs, buildProjectOptions);
 }

 public void AssertWasmSdkBundle(BuildArgs buildArgs,
 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertWasmSdkBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 var projectProvider = new WasmSdkBasedProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 projectProvider.AssertBundle(assertAppBundleOptions);
 else
 projectProvider.AssertBundle(buildArgs, buildProjectOptions);
 }
}

4 changes: 2 additions & 2 deletions
src/mono/wasm/host/BrowserHost.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,7 +167,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 devServerOptions = CreateDevServerOptions(urls, staticWebAssetsPath, onConsoleConnected);

 if (devServerOptions == null)
 throw new CommandLineException("Please, provide mainAssembly in hostProperties of runtimeconfig");
 throw new CommandLineException($"Please, provide mainAssembly in hostProperties of runtimeconfig. Alternatively leave the static web assets manifest ('*{staticWebAssetsV2Extension}') in the build output directory '{appPath}' .");
 }

 return devServerOptions;
Expand All@@ -183,7 +183,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 );

 private static string? FindFirstFileWithExtension(string directory, string extension)
 => Directory.EnumerateFiles(directory, "*" + extension).First();
 => Directory.EnumerateFiles(directory, "*" + extension).FirstOrDefault();

 private async Task RunConsoleMessagesPump(WebSocket socket, WasmTestMessagesProcessor messagesProcessor, CancellationToken token)
 {
Expand Down

3 changes: 1 addition & 2 deletions
src/mono/wasm/host/DevServer/DevServer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,8 +70,7 @@ private static IConfiguration ConfigureHostConfiguration(DevServerOptions option
 [WebHostDefaults.EnvironmentKey] = "Development",
 ["Logging:LogLevel:Microsoft"] = "Warning",
 ["Logging:LogLevel:Microsoft.Hosting.Lifetime"] = "Information",
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath,
 ["ApplyCopHeaders"] = options.WebServerUseCrossOriginPolicy.ToString()
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath
 };

 config.AddInMemoryCollection(inMemoryConfiguration);
Expand Down

34 changes: 30 additions & 4 deletions
src/mono/wasm/host/DevServer/DevServerStartup.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,13 +2,16 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.IO;
using System.Net.WebSockets;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.WebAssembly.AppHost;

namespace Microsoft.WebAssembly.AppHost.DevServer;
Expand All@@ -27,16 +30,16 @@ public static void ConfigureServices(IServiceCollection services)
 services.AddRouting();
 }

 public static void Configure(IApplicationBuilder app, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 public static void Configure(IApplicationBuilder app, IOptions<DevServerOptions> optionsContainer, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 {
 app.UseDeveloperExceptionPage();
 EnableConfiguredPathbase(app, configuration);

 app.UseWebAssemblyDebugging();

bool applyCopHeaders = configuration.GetValue<bool>("ApplyCopHeaders");
DevServerOptions options = optionsContainer.Value;

 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 app.Use(async (ctx, next) =>
 {
Expand All@@ -63,14 +66,37 @@ public static void Configure(IApplicationBuilder app, TaskCompletionSource<Serve
 });

 app.UseRouting();
 app.UseWebSockets();

 if (options.OnConsoleConnected is not null)
 {
 app.Use(async (ctx, next) =>
 {
 if (ctx.Request.Path.StartsWithSegments("/console"))
 {
 if (!ctx.WebSockets.IsWebSocketRequest)
 {
 ctx.Response.StatusCode = 400;
 return;
 }

 using WebSocket socket = await ctx.WebSockets.AcceptWebSocketAsync();
 await options.OnConsoleConnected(socket);
 }
 else
 {
 await next(ctx);
 }
 });
 }

 app.UseEndpoints(endpoints =>
 {
 endpoints.MapFallbackToFile("index.html", new StaticFileOptions
 {
 OnPrepareResponse = fileContext =>
 {
 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 // Browser multi-threaded runtime requires cross-origin policy headers to enable SharedArrayBuffer.
 ApplyCrossOriginPolicyHeaders(fileContext.Context);
Expand Down

3 changes: 3 additions & 0 deletions
src/mono/wasm/host/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ public static async Task<int> Main(string[] args)
 RegisterHostHandler(WasmHost.Wasmtime, WasiEngineHost.InvokeAsync);

 using CancellationTokenSource cts = new();

 Console.CancelKeyPress += (object? sender, ConsoleCancelEventArgs e) => cts.Cancel();
Comment thread
maraf marked this conversation as resolved.


 ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
 builder
 .AddPassThroughConsole()
Expand Down

26 changes: 0 additions & 26 deletions
src/mono/wasm/templates/templates/browser/README.md

View file


Open in desktop


This file was deleted.


11 changes: 2 additions & 9 deletions
src/mono/wasm/templates/templates/browser/browser.0.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk.WebAssembly">
 <PropertyGroup>
 <TargetFramework>net7.0</TargetFramework>
 <RuntimeIdentifier>browser-wasm</RuntimeIdentifier>
 <OutputType>Exe</OutputType>
 <TargetFramework>net8.0</TargetFramework>
 <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 </PropertyGroup>

 <ItemGroup>
 <WasmExtraFilesToDeploy Include="index.html" />
 <WasmExtraFilesToDeploy Include="main.js" />
 </ItemGroup>
</Project>

5 changes: 2 additions & 3 deletions
src/mono/wasm/templates/templates/browser/runtimeconfig.template.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,9 +3,8 @@
 "perHostConfig": [
 {
 "name": "browser",
 "html-path": "index.html",
 "Host": "browser"
 "host": "browser"
 }
 ]
 }
}
}

0
...sm/templates/templates/browser/index.html → ...ates/templates/browser/wwwroot/index.html

View file


Open in desktop


File renamed without changes.


0
.../wasm/templates/templates/browser/main.js → ...mplates/templates/browser/wwwroot/main.js

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[browser] Update browser template to use Wasm SDK#90871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

radical
merged 18 commits into

from

Aug 23, 2023
 Merged


[browser] Update browser template to use Wasm SDK
#90871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


18 commits


Select commit
Hold shift + click to select a range
827b090

Use WasmSdk in browser template


maraf Aug 17, 2023
b2ff838

Remove default html-path


maraf Aug 18, 2023
59498d1

Use wwwroot when looking for main.js in template for replacement


maraf Aug 18, 2023
351651f

Temporarily remove WasmRuntimeAssetsLocation from WBT because WasmSDK…


maraf Aug 18, 2023
d6698d5

Integrate console log forward into DevServer


maraf Aug 18, 2023
41f0c75

Replace UseRouter


maraf Aug 18, 2023
9600a1e

Use next middleware only if it's not console


maraf Aug 21, 2023
139ff28

CancellationTokenSource on CancelKeyPress


maraf Aug 21, 2023
0350207

Address feedback from initial DevServer integration


maraf Aug 21, 2023
9948fe5

Update src/mono/wasm/host/BrowserHost.cs


maraf Aug 22, 2023
cc20713

Remove debugging code


maraf Aug 22, 2023
f0076c8

Fix WBT


maraf Aug 22, 2023
6b66a33

Fix starting outside of project directory


maraf Aug 22, 2023
33ec123

Merge remote-tracking branch 'upstream/main' into WasmSdkTemplate2


maraf Aug 22, 2023
b3844c0

Support WasmRuntimeAssetsLocation in Wasm SDK


maraf Aug 22, 2023
18d9da5

Revert "Support WasmRuntimeAssetsLocation in Wasm SDK"


maraf Aug 23, 2023
c448e94

Active issue for WasmRuntimeAssetsLocation


maraf Aug 23, 2023
cfaf8c0

Feedback


maraf Aug 23, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 6 additions & 2 deletions
...et/Microsoft.NET.Sdk.WebAssembly.Pack/build/Microsoft.NET.Sdk.WebAssembly.Browser.targets

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,13 @@ Copyright (c) .NET Foundation. All rights reserved.
 <RunCommand Condition="'$(RunCommand)' == ''">dotnet</RunCommand>

 <WasmAppHostDir>$([MSBuild]::NormalizeDirectory($(MSBuildThisFileDirectory), '..', 'WasmAppHost'))</WasmAppHostDir>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(OutputPath), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <_RunWorkingDirectory>$(OutputPath)</_RunWorkingDirectory>
 <_RunWorkingDirectory Condition="'$(_RunWorkingDirectory)' != '' and !$([System.IO.Path]::IsPathRooted($(_RunWorkingDirectory)))">$([System.IO.Path]::Combine($(MSBuildProjectDirectory), $(_RunWorkingDirectory)))</_RunWorkingDirectory>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(_RunWorkingDirectory), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <RunArguments>exec &quot;$([MSBuild]::NormalizePath($(WasmAppHostDir), 'WasmAppHost.dll'))&quot; --use-staticwebassets --runtime-config &quot;$(_RuntimeConfigJsonPath)&quot; $(WasmHostArguments)</RunArguments>
 <RunWorkingDirectory>$(OutputPath)</RunWorkingDirectory>
 <RunWorkingDirectory>$(_RunWorkingDirectory)</RunWorkingDirectory>
 </PropertyGroup>

 <PropertyGroup>
Expand Down

7 changes: 4 additions & 3 deletions
src/mono/wasm/Wasm.Build.Tests/Templates/WasmTemplateTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private void UpdateProgramCS()

 private void UpdateBrowserMainJs(string targetFramework, string runtimeAssetsRelativePath = DefaultRuntimeAssetsRelativePath)
 {
 string mainJsPath = Path.Combine(_projectDir!, "main.js");
 string mainJsPath = Path.Combine(_projectDir!, "wwwroot", "main.js");
 string mainJsContent = File.ReadAllText(mainJsPath);

 // .withExitOnUnhandledError() is available only only >net7.0
Expand DownExpand Up@@ -408,11 +408,12 @@ public void ConsolePublishAndRun(string config, bool aot, bool relinking)

 [Theory]
 [InlineData("", BuildTestBase.DefaultTargetFramework, DefaultRuntimeAssetsRelativePath)]
 [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/90979")]
 // [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [InlineData("-f net8.0", "net8.0", "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/79313")]
 // [InlineData("-f net7.0", "net7.0")]
 [InlineData("-f net8.0", "net8.0", DefaultRuntimeAssetsRelativePath)]
 [InlineData("-f net8.0", "net8.0", "./")]
 public async Task BrowserBuildAndRun(string extraNewArgs, string targetFramework, string runtimeAssetsRelativePath)
 {
 string config = "Debug";
Expand Down

15 changes: 15 additions & 0 deletions
src/mono/wasm/Wasm.Build.Tests/WasmSdkBasedProjectProvider.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,21 @@ protected override IReadOnlySet<string> GetDotNetFilesExpectedSet(AssertBundleOp
 return res;
 }


 public void AssertBundle(BuildArgs buildArgs, BuildProjectOptions buildProjectOptions)
 {
 AssertBundle(new(
 Config: buildArgs.Config,
 IsPublish: buildProjectOptions.Publish,
 TargetFramework: buildProjectOptions.TargetFramework,
 BinFrameworkDir: buildProjectOptions.BinFrameworkDir ?? FindBinFrameworkDir(buildArgs.Config, buildProjectOptions.Publish, buildProjectOptions.TargetFramework),
 PredefinedIcudt: buildProjectOptions.PredefinedIcudt,
 GlobalizationMode: buildProjectOptions.GlobalizationMode,
 AssertSymbolsFile: false,
 ExpectedFileType: buildProjectOptions.Publish && buildArgs.Config == "Release" ? NativeFilesType.Relinked : NativeFilesType.FromRuntimePack
 ));
 }

 public void AssertBundle(AssertWasmSdkBundleOptions assertOptions)
 {
 IReadOnlyDictionary<string, DotNetFileName> actualDotnetFiles = AssertBasicBundle(assertOptions);
Expand Down

28 changes: 23 additions & 5 deletions
src/mono/wasm/Wasm.Build.Tests/WasmTemplateTestBase.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,31 +59,49 @@ public string CreateWasmTemplateProject(string id, string template = "wasmbrowse

 public (string projectDir, string buildOutput) BuildTemplateProject(BuildArgs buildArgs,
 string id,
 BuildProjectOptions buildProjectOptions,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 BuildProjectOptions buildProjectOptions)
 {
 (CommandResult res, string logFilePath) = BuildProjectWithoutAssert(id, buildArgs.Config, buildProjectOptions);
 if (buildProjectOptions.UseCache)
 _buildContext.CacheBuild(buildArgs, new BuildProduct(_projectDir!, logFilePath, true, res.Output));

 if (buildProjectOptions.AssertAppBundle)
 AssertBundle(buildArgs, buildProjectOptions, res.Output, assertAppBundleOptions);
 {
 if (buildProjectOptions.IsBrowserProject)
 AssertWasmSdkBundle(buildArgs, buildProjectOptions, res.Output);
 else
 AssertTestMainJsBundle(buildArgs, buildProjectOptions, res.Output);
 }
 return (_projectDir!, res.Output);
 }

 public void AssertBundle(BuildArgs buildArgs,
 public void AssertTestMainJsBundle(BuildArgs buildArgs,
Comment thread
radical marked this conversation as resolved.

 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 // TODO: templates don't use wasm sdk yet
 var testMainJsProvider = new TestMainJsProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 testMainJsProvider.AssertBundle(assertAppBundleOptions);
 else
 testMainJsProvider.AssertBundle(buildArgs, buildProjectOptions);
 }

 public void AssertWasmSdkBundle(BuildArgs buildArgs,
 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertWasmSdkBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 var projectProvider = new WasmSdkBasedProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 projectProvider.AssertBundle(assertAppBundleOptions);
 else
 projectProvider.AssertBundle(buildArgs, buildProjectOptions);
 }
}

4 changes: 2 additions & 2 deletions
src/mono/wasm/host/BrowserHost.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,7 +167,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 devServerOptions = CreateDevServerOptions(urls, staticWebAssetsPath, onConsoleConnected);

 if (devServerOptions == null)
 throw new CommandLineException("Please, provide mainAssembly in hostProperties of runtimeconfig");
 throw new CommandLineException($"Please, provide mainAssembly in hostProperties of runtimeconfig. Alternatively leave the static web assets manifest ('*{staticWebAssetsV2Extension}') in the build output directory '{appPath}' .");
 }

 return devServerOptions;
Expand All@@ -183,7 +183,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 );

 private static string? FindFirstFileWithExtension(string directory, string extension)
 => Directory.EnumerateFiles(directory, "*" + extension).First();
 => Directory.EnumerateFiles(directory, "*" + extension).FirstOrDefault();

 private async Task RunConsoleMessagesPump(WebSocket socket, WasmTestMessagesProcessor messagesProcessor, CancellationToken token)
 {
Expand Down

3 changes: 1 addition & 2 deletions
src/mono/wasm/host/DevServer/DevServer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,8 +70,7 @@ private static IConfiguration ConfigureHostConfiguration(DevServerOptions option
 [WebHostDefaults.EnvironmentKey] = "Development",
 ["Logging:LogLevel:Microsoft"] = "Warning",
 ["Logging:LogLevel:Microsoft.Hosting.Lifetime"] = "Information",
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath,
 ["ApplyCopHeaders"] = options.WebServerUseCrossOriginPolicy.ToString()
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath
 };

 config.AddInMemoryCollection(inMemoryConfiguration);
Expand Down

34 changes: 30 additions & 4 deletions
src/mono/wasm/host/DevServer/DevServerStartup.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,13 +2,16 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.IO;
using System.Net.WebSockets;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.WebAssembly.AppHost;

namespace Microsoft.WebAssembly.AppHost.DevServer;
Expand All@@ -27,16 +30,16 @@ public static void ConfigureServices(IServiceCollection services)
 services.AddRouting();
 }

 public static void Configure(IApplicationBuilder app, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 public static void Configure(IApplicationBuilder app, IOptions<DevServerOptions> optionsContainer, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 {
 app.UseDeveloperExceptionPage();
 EnableConfiguredPathbase(app, configuration);

 app.UseWebAssemblyDebugging();

bool applyCopHeaders = configuration.GetValue<bool>("ApplyCopHeaders");
DevServerOptions options = optionsContainer.Value;

 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 app.Use(async (ctx, next) =>
 {
Expand All@@ -63,14 +66,37 @@ public static void Configure(IApplicationBuilder app, TaskCompletionSource<Serve
 });

 app.UseRouting();
 app.UseWebSockets();

 if (options.OnConsoleConnected is not null)
 {
 app.Use(async (ctx, next) =>
 {
 if (ctx.Request.Path.StartsWithSegments("/console"))
 {
 if (!ctx.WebSockets.IsWebSocketRequest)
 {
 ctx.Response.StatusCode = 400;
 return;
 }

 using WebSocket socket = await ctx.WebSockets.AcceptWebSocketAsync();
 await options.OnConsoleConnected(socket);
 }
 else
 {
 await next(ctx);
 }
 });
 }

 app.UseEndpoints(endpoints =>
 {
 endpoints.MapFallbackToFile("index.html", new StaticFileOptions
 {
 OnPrepareResponse = fileContext =>
 {
 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 // Browser multi-threaded runtime requires cross-origin policy headers to enable SharedArrayBuffer.
 ApplyCrossOriginPolicyHeaders(fileContext.Context);
Expand Down

3 changes: 3 additions & 0 deletions
src/mono/wasm/host/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ public static async Task<int> Main(string[] args)
 RegisterHostHandler(WasmHost.Wasmtime, WasiEngineHost.InvokeAsync);

 using CancellationTokenSource cts = new();

 Console.CancelKeyPress += (object? sender, ConsoleCancelEventArgs e) => cts.Cancel();
Comment thread
maraf marked this conversation as resolved.


 ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
 builder
 .AddPassThroughConsole()
Expand Down

26 changes: 0 additions & 26 deletions
src/mono/wasm/templates/templates/browser/README.md

View file


Open in desktop


This file was deleted.


11 changes: 2 additions & 9 deletions
src/mono/wasm/templates/templates/browser/browser.0.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk.WebAssembly">
 <PropertyGroup>
 <TargetFramework>net7.0</TargetFramework>
 <RuntimeIdentifier>browser-wasm</RuntimeIdentifier>
 <OutputType>Exe</OutputType>
 <TargetFramework>net8.0</TargetFramework>
 <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 </PropertyGroup>

 <ItemGroup>
 <WasmExtraFilesToDeploy Include="index.html" />
 <WasmExtraFilesToDeploy Include="main.js" />
 </ItemGroup>
</Project>

5 changes: 2 additions & 3 deletions
src/mono/wasm/templates/templates/browser/runtimeconfig.template.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,9 +3,8 @@
 "perHostConfig": [
 {
 "name": "browser",
 "html-path": "index.html",
 "Host": "browser"
 "host": "browser"
 }
 ]
 }
}
}

0
...sm/templates/templates/browser/index.html → ...ates/templates/browser/wwwroot/index.html

View file


Open in desktop


File renamed without changes.


0
.../wasm/templates/templates/browser/main.js → ...mplates/templates/browser/wwwroot/main.js

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
[browser] Update browser template to use Wasm SDK#90871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

radical
merged 18 commits into

from

Aug 23, 2023
 Merged


[browser] Update browser template to use Wasm SDK
#90871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


18 commits


Select commit
Hold shift + click to select a range
827b090

Use WasmSdk in browser template


maraf Aug 17, 2023
b2ff838

Remove default html-path


maraf Aug 18, 2023
59498d1

Use wwwroot when looking for main.js in template for replacement


maraf Aug 18, 2023
351651f

Temporarily remove WasmRuntimeAssetsLocation from WBT because WasmSDK…


maraf Aug 18, 2023
d6698d5

Integrate console log forward into DevServer


maraf Aug 18, 2023
41f0c75

Replace UseRouter


maraf Aug 18, 2023
9600a1e

Use next middleware only if it's not console


maraf Aug 21, 2023
139ff28

CancellationTokenSource on CancelKeyPress


maraf Aug 21, 2023
0350207

Address feedback from initial DevServer integration


maraf Aug 21, 2023
9948fe5

Update src/mono/wasm/host/BrowserHost.cs


maraf Aug 22, 2023
cc20713

Remove debugging code


maraf Aug 22, 2023
f0076c8

Fix WBT


maraf Aug 22, 2023
6b66a33

Fix starting outside of project directory


maraf Aug 22, 2023
33ec123

Merge remote-tracking branch 'upstream/main' into WasmSdkTemplate2


maraf Aug 22, 2023
b3844c0

Support WasmRuntimeAssetsLocation in Wasm SDK


maraf Aug 22, 2023
18d9da5

Revert "Support WasmRuntimeAssetsLocation in Wasm SDK"


maraf Aug 23, 2023
c448e94

Active issue for WasmRuntimeAssetsLocation


maraf Aug 23, 2023
cfaf8c0

Feedback


maraf Aug 23, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 6 additions & 2 deletions
...et/Microsoft.NET.Sdk.WebAssembly.Pack/build/Microsoft.NET.Sdk.WebAssembly.Browser.targets

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,13 @@ Copyright (c) .NET Foundation. All rights reserved.
 <RunCommand Condition="'$(RunCommand)' == ''">dotnet</RunCommand>

 <WasmAppHostDir>$([MSBuild]::NormalizeDirectory($(MSBuildThisFileDirectory), '..', 'WasmAppHost'))</WasmAppHostDir>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(OutputPath), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <_RunWorkingDirectory>$(OutputPath)</_RunWorkingDirectory>
 <_RunWorkingDirectory Condition="'$(_RunWorkingDirectory)' != '' and !$([System.IO.Path]::IsPathRooted($(_RunWorkingDirectory)))">$([System.IO.Path]::Combine($(MSBuildProjectDirectory), $(_RunWorkingDirectory)))</_RunWorkingDirectory>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(_RunWorkingDirectory), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <RunArguments>exec &quot;$([MSBuild]::NormalizePath($(WasmAppHostDir), 'WasmAppHost.dll'))&quot; --use-staticwebassets --runtime-config &quot;$(_RuntimeConfigJsonPath)&quot; $(WasmHostArguments)</RunArguments>
 <RunWorkingDirectory>$(OutputPath)</RunWorkingDirectory>
 <RunWorkingDirectory>$(_RunWorkingDirectory)</RunWorkingDirectory>
 </PropertyGroup>

 <PropertyGroup>
Expand Down

7 changes: 4 additions & 3 deletions
src/mono/wasm/Wasm.Build.Tests/Templates/WasmTemplateTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private void UpdateProgramCS()

 private void UpdateBrowserMainJs(string targetFramework, string runtimeAssetsRelativePath = DefaultRuntimeAssetsRelativePath)
 {
 string mainJsPath = Path.Combine(_projectDir!, "main.js");
 string mainJsPath = Path.Combine(_projectDir!, "wwwroot", "main.js");
 string mainJsContent = File.ReadAllText(mainJsPath);

 // .withExitOnUnhandledError() is available only only >net7.0
Expand DownExpand Up@@ -408,11 +408,12 @@ public void ConsolePublishAndRun(string config, bool aot, bool relinking)

 [Theory]
 [InlineData("", BuildTestBase.DefaultTargetFramework, DefaultRuntimeAssetsRelativePath)]
 [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/90979")]
 // [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [InlineData("-f net8.0", "net8.0", "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/79313")]
 // [InlineData("-f net7.0", "net7.0")]
 [InlineData("-f net8.0", "net8.0", DefaultRuntimeAssetsRelativePath)]
 [InlineData("-f net8.0", "net8.0", "./")]
 public async Task BrowserBuildAndRun(string extraNewArgs, string targetFramework, string runtimeAssetsRelativePath)
 {
 string config = "Debug";
Expand Down

15 changes: 15 additions & 0 deletions
src/mono/wasm/Wasm.Build.Tests/WasmSdkBasedProjectProvider.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,21 @@ protected override IReadOnlySet<string> GetDotNetFilesExpectedSet(AssertBundleOp
 return res;
 }


 public void AssertBundle(BuildArgs buildArgs, BuildProjectOptions buildProjectOptions)
 {
 AssertBundle(new(
 Config: buildArgs.Config,
 IsPublish: buildProjectOptions.Publish,
 TargetFramework: buildProjectOptions.TargetFramework,
 BinFrameworkDir: buildProjectOptions.BinFrameworkDir ?? FindBinFrameworkDir(buildArgs.Config, buildProjectOptions.Publish, buildProjectOptions.TargetFramework),
 PredefinedIcudt: buildProjectOptions.PredefinedIcudt,
 GlobalizationMode: buildProjectOptions.GlobalizationMode,
 AssertSymbolsFile: false,
 ExpectedFileType: buildProjectOptions.Publish && buildArgs.Config == "Release" ? NativeFilesType.Relinked : NativeFilesType.FromRuntimePack
 ));
 }

 public void AssertBundle(AssertWasmSdkBundleOptions assertOptions)
 {
 IReadOnlyDictionary<string, DotNetFileName> actualDotnetFiles = AssertBasicBundle(assertOptions);
Expand Down

28 changes: 23 additions & 5 deletions
src/mono/wasm/Wasm.Build.Tests/WasmTemplateTestBase.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,31 +59,49 @@ public string CreateWasmTemplateProject(string id, string template = "wasmbrowse

 public (string projectDir, string buildOutput) BuildTemplateProject(BuildArgs buildArgs,
 string id,
 BuildProjectOptions buildProjectOptions,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 BuildProjectOptions buildProjectOptions)
 {
 (CommandResult res, string logFilePath) = BuildProjectWithoutAssert(id, buildArgs.Config, buildProjectOptions);
 if (buildProjectOptions.UseCache)
 _buildContext.CacheBuild(buildArgs, new BuildProduct(_projectDir!, logFilePath, true, res.Output));

 if (buildProjectOptions.AssertAppBundle)
 AssertBundle(buildArgs, buildProjectOptions, res.Output, assertAppBundleOptions);
 {
 if (buildProjectOptions.IsBrowserProject)
 AssertWasmSdkBundle(buildArgs, buildProjectOptions, res.Output);
 else
 AssertTestMainJsBundle(buildArgs, buildProjectOptions, res.Output);
 }
 return (_projectDir!, res.Output);
 }

 public void AssertBundle(BuildArgs buildArgs,
 public void AssertTestMainJsBundle(BuildArgs buildArgs,
Comment thread
radical marked this conversation as resolved.

 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 // TODO: templates don't use wasm sdk yet
 var testMainJsProvider = new TestMainJsProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 testMainJsProvider.AssertBundle(assertAppBundleOptions);
 else
 testMainJsProvider.AssertBundle(buildArgs, buildProjectOptions);
 }

 public void AssertWasmSdkBundle(BuildArgs buildArgs,
 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertWasmSdkBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 var projectProvider = new WasmSdkBasedProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 projectProvider.AssertBundle(assertAppBundleOptions);
 else
 projectProvider.AssertBundle(buildArgs, buildProjectOptions);
 }
}

4 changes: 2 additions & 2 deletions
src/mono/wasm/host/BrowserHost.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,7 +167,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 devServerOptions = CreateDevServerOptions(urls, staticWebAssetsPath, onConsoleConnected);

 if (devServerOptions == null)
 throw new CommandLineException("Please, provide mainAssembly in hostProperties of runtimeconfig");
 throw new CommandLineException($"Please, provide mainAssembly in hostProperties of runtimeconfig. Alternatively leave the static web assets manifest ('*{staticWebAssetsV2Extension}') in the build output directory '{appPath}' .");
 }

 return devServerOptions;
Expand All@@ -183,7 +183,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 );

 private static string? FindFirstFileWithExtension(string directory, string extension)
 => Directory.EnumerateFiles(directory, "*" + extension).First();
 => Directory.EnumerateFiles(directory, "*" + extension).FirstOrDefault();

 private async Task RunConsoleMessagesPump(WebSocket socket, WasmTestMessagesProcessor messagesProcessor, CancellationToken token)
 {
Expand Down

3 changes: 1 addition & 2 deletions
src/mono/wasm/host/DevServer/DevServer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,8 +70,7 @@ private static IConfiguration ConfigureHostConfiguration(DevServerOptions option
 [WebHostDefaults.EnvironmentKey] = "Development",
 ["Logging:LogLevel:Microsoft"] = "Warning",
 ["Logging:LogLevel:Microsoft.Hosting.Lifetime"] = "Information",
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath,
 ["ApplyCopHeaders"] = options.WebServerUseCrossOriginPolicy.ToString()
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath
 };

 config.AddInMemoryCollection(inMemoryConfiguration);
Expand Down

34 changes: 30 additions & 4 deletions
src/mono/wasm/host/DevServer/DevServerStartup.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,13 +2,16 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.IO;
using System.Net.WebSockets;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.WebAssembly.AppHost;

namespace Microsoft.WebAssembly.AppHost.DevServer;
Expand All@@ -27,16 +30,16 @@ public static void ConfigureServices(IServiceCollection services)
 services.AddRouting();
 }

 public static void Configure(IApplicationBuilder app, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 public static void Configure(IApplicationBuilder app, IOptions<DevServerOptions> optionsContainer, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 {
 app.UseDeveloperExceptionPage();
 EnableConfiguredPathbase(app, configuration);

 app.UseWebAssemblyDebugging();

bool applyCopHeaders = configuration.GetValue<bool>("ApplyCopHeaders");
DevServerOptions options = optionsContainer.Value;

 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 app.Use(async (ctx, next) =>
 {
Expand All@@ -63,14 +66,37 @@ public static void Configure(IApplicationBuilder app, TaskCompletionSource<Serve
 });

 app.UseRouting();
 app.UseWebSockets();

 if (options.OnConsoleConnected is not null)
 {
 app.Use(async (ctx, next) =>
 {
 if (ctx.Request.Path.StartsWithSegments("/console"))
 {
 if (!ctx.WebSockets.IsWebSocketRequest)
 {
 ctx.Response.StatusCode = 400;
 return;
 }

 using WebSocket socket = await ctx.WebSockets.AcceptWebSocketAsync();
 await options.OnConsoleConnected(socket);
 }
 else
 {
 await next(ctx);
 }
 });
 }

 app.UseEndpoints(endpoints =>
 {
 endpoints.MapFallbackToFile("index.html", new StaticFileOptions
 {
 OnPrepareResponse = fileContext =>
 {
 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 // Browser multi-threaded runtime requires cross-origin policy headers to enable SharedArrayBuffer.
 ApplyCrossOriginPolicyHeaders(fileContext.Context);
Expand Down

3 changes: 3 additions & 0 deletions
src/mono/wasm/host/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ public static async Task<int> Main(string[] args)
 RegisterHostHandler(WasmHost.Wasmtime, WasiEngineHost.InvokeAsync);

 using CancellationTokenSource cts = new();

 Console.CancelKeyPress += (object? sender, ConsoleCancelEventArgs e) => cts.Cancel();
Comment thread
maraf marked this conversation as resolved.


 ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
 builder
 .AddPassThroughConsole()
Expand Down

26 changes: 0 additions & 26 deletions
src/mono/wasm/templates/templates/browser/README.md

View file


Open in desktop


This file was deleted.


11 changes: 2 additions & 9 deletions
src/mono/wasm/templates/templates/browser/browser.0.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk.WebAssembly">
 <PropertyGroup>
 <TargetFramework>net7.0</TargetFramework>
 <RuntimeIdentifier>browser-wasm</RuntimeIdentifier>
 <OutputType>Exe</OutputType>
 <TargetFramework>net8.0</TargetFramework>
 <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 </PropertyGroup>

 <ItemGroup>
 <WasmExtraFilesToDeploy Include="index.html" />
 <WasmExtraFilesToDeploy Include="main.js" />
 </ItemGroup>
</Project>

5 changes: 2 additions & 3 deletions
src/mono/wasm/templates/templates/browser/runtimeconfig.template.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,9 +3,8 @@
 "perHostConfig": [
 {
 "name": "browser",
 "html-path": "index.html",
 "Host": "browser"
 "host": "browser"
 }
 ]
 }
}
}

0
...sm/templates/templates/browser/index.html → ...ates/templates/browser/wwwroot/index.html

View file


Open in desktop


File renamed without changes.


0
.../wasm/templates/templates/browser/main.js → ...mplates/templates/browser/wwwroot/main.js

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[browser] Update browser template to use Wasm SDK#90871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

radical
merged 18 commits into

from

Aug 23, 2023
 Merged


[browser] Update browser template to use Wasm SDK
#90871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


18 commits


Select commit
Hold shift + click to select a range
827b090

Use WasmSdk in browser template


maraf Aug 17, 2023
b2ff838

Remove default html-path


maraf Aug 18, 2023
59498d1

Use wwwroot when looking for main.js in template for replacement


maraf Aug 18, 2023
351651f

Temporarily remove WasmRuntimeAssetsLocation from WBT because WasmSDK…


maraf Aug 18, 2023
d6698d5

Integrate console log forward into DevServer


maraf Aug 18, 2023
41f0c75

Replace UseRouter


maraf Aug 18, 2023
9600a1e

Use next middleware only if it's not console


maraf Aug 21, 2023
139ff28

CancellationTokenSource on CancelKeyPress


maraf Aug 21, 2023
0350207

Address feedback from initial DevServer integration


maraf Aug 21, 2023
9948fe5

Update src/mono/wasm/host/BrowserHost.cs


maraf Aug 22, 2023
cc20713

Remove debugging code


maraf Aug 22, 2023
f0076c8

Fix WBT


maraf Aug 22, 2023
6b66a33

Fix starting outside of project directory


maraf Aug 22, 2023
33ec123

Merge remote-tracking branch 'upstream/main' into WasmSdkTemplate2


maraf Aug 22, 2023
b3844c0

Support WasmRuntimeAssetsLocation in Wasm SDK


maraf Aug 22, 2023
18d9da5

Revert "Support WasmRuntimeAssetsLocation in Wasm SDK"


maraf Aug 23, 2023
c448e94

Active issue for WasmRuntimeAssetsLocation


maraf Aug 23, 2023
cfaf8c0

Feedback


maraf Aug 23, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 6 additions & 2 deletions
...et/Microsoft.NET.Sdk.WebAssembly.Pack/build/Microsoft.NET.Sdk.WebAssembly.Browser.targets

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,13 @@ Copyright (c) .NET Foundation. All rights reserved.
 <RunCommand Condition="'$(RunCommand)' == ''">dotnet</RunCommand>

 <WasmAppHostDir>$([MSBuild]::NormalizeDirectory($(MSBuildThisFileDirectory), '..', 'WasmAppHost'))</WasmAppHostDir>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(OutputPath), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <_RunWorkingDirectory>$(OutputPath)</_RunWorkingDirectory>
 <_RunWorkingDirectory Condition="'$(_RunWorkingDirectory)' != '' and !$([System.IO.Path]::IsPathRooted($(_RunWorkingDirectory)))">$([System.IO.Path]::Combine($(MSBuildProjectDirectory), $(_RunWorkingDirectory)))</_RunWorkingDirectory>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(_RunWorkingDirectory), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <RunArguments>exec &quot;$([MSBuild]::NormalizePath($(WasmAppHostDir), 'WasmAppHost.dll'))&quot; --use-staticwebassets --runtime-config &quot;$(_RuntimeConfigJsonPath)&quot; $(WasmHostArguments)</RunArguments>
 <RunWorkingDirectory>$(OutputPath)</RunWorkingDirectory>
 <RunWorkingDirectory>$(_RunWorkingDirectory)</RunWorkingDirectory>
 </PropertyGroup>

 <PropertyGroup>
Expand Down

7 changes: 4 additions & 3 deletions
src/mono/wasm/Wasm.Build.Tests/Templates/WasmTemplateTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private void UpdateProgramCS()

 private void UpdateBrowserMainJs(string targetFramework, string runtimeAssetsRelativePath = DefaultRuntimeAssetsRelativePath)
 {
 string mainJsPath = Path.Combine(_projectDir!, "main.js");
 string mainJsPath = Path.Combine(_projectDir!, "wwwroot", "main.js");
 string mainJsContent = File.ReadAllText(mainJsPath);

 // .withExitOnUnhandledError() is available only only >net7.0
Expand DownExpand Up@@ -408,11 +408,12 @@ public void ConsolePublishAndRun(string config, bool aot, bool relinking)

 [Theory]
 [InlineData("", BuildTestBase.DefaultTargetFramework, DefaultRuntimeAssetsRelativePath)]
 [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/90979")]
 // [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [InlineData("-f net8.0", "net8.0", "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/79313")]
 // [InlineData("-f net7.0", "net7.0")]
 [InlineData("-f net8.0", "net8.0", DefaultRuntimeAssetsRelativePath)]
 [InlineData("-f net8.0", "net8.0", "./")]
 public async Task BrowserBuildAndRun(string extraNewArgs, string targetFramework, string runtimeAssetsRelativePath)
 {
 string config = "Debug";
Expand Down

15 changes: 15 additions & 0 deletions
src/mono/wasm/Wasm.Build.Tests/WasmSdkBasedProjectProvider.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,21 @@ protected override IReadOnlySet<string> GetDotNetFilesExpectedSet(AssertBundleOp
 return res;
 }


 public void AssertBundle(BuildArgs buildArgs, BuildProjectOptions buildProjectOptions)
 {
 AssertBundle(new(
 Config: buildArgs.Config,
 IsPublish: buildProjectOptions.Publish,
 TargetFramework: buildProjectOptions.TargetFramework,
 BinFrameworkDir: buildProjectOptions.BinFrameworkDir ?? FindBinFrameworkDir(buildArgs.Config, buildProjectOptions.Publish, buildProjectOptions.TargetFramework),
 PredefinedIcudt: buildProjectOptions.PredefinedIcudt,
 GlobalizationMode: buildProjectOptions.GlobalizationMode,
 AssertSymbolsFile: false,
 ExpectedFileType: buildProjectOptions.Publish && buildArgs.Config == "Release" ? NativeFilesType.Relinked : NativeFilesType.FromRuntimePack
 ));
 }

 public void AssertBundle(AssertWasmSdkBundleOptions assertOptions)
 {
 IReadOnlyDictionary<string, DotNetFileName> actualDotnetFiles = AssertBasicBundle(assertOptions);
Expand Down

28 changes: 23 additions & 5 deletions
src/mono/wasm/Wasm.Build.Tests/WasmTemplateTestBase.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,31 +59,49 @@ public string CreateWasmTemplateProject(string id, string template = "wasmbrowse

 public (string projectDir, string buildOutput) BuildTemplateProject(BuildArgs buildArgs,
 string id,
 BuildProjectOptions buildProjectOptions,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 BuildProjectOptions buildProjectOptions)
 {
 (CommandResult res, string logFilePath) = BuildProjectWithoutAssert(id, buildArgs.Config, buildProjectOptions);
 if (buildProjectOptions.UseCache)
 _buildContext.CacheBuild(buildArgs, new BuildProduct(_projectDir!, logFilePath, true, res.Output));

 if (buildProjectOptions.AssertAppBundle)
 AssertBundle(buildArgs, buildProjectOptions, res.Output, assertAppBundleOptions);
 {
 if (buildProjectOptions.IsBrowserProject)
 AssertWasmSdkBundle(buildArgs, buildProjectOptions, res.Output);
 else
 AssertTestMainJsBundle(buildArgs, buildProjectOptions, res.Output);
 }
 return (_projectDir!, res.Output);
 }

 public void AssertBundle(BuildArgs buildArgs,
 public void AssertTestMainJsBundle(BuildArgs buildArgs,
Comment thread
radical marked this conversation as resolved.

 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 // TODO: templates don't use wasm sdk yet
 var testMainJsProvider = new TestMainJsProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 testMainJsProvider.AssertBundle(assertAppBundleOptions);
 else
 testMainJsProvider.AssertBundle(buildArgs, buildProjectOptions);
 }

 public void AssertWasmSdkBundle(BuildArgs buildArgs,
 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertWasmSdkBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 var projectProvider = new WasmSdkBasedProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 projectProvider.AssertBundle(assertAppBundleOptions);
 else
 projectProvider.AssertBundle(buildArgs, buildProjectOptions);
 }
}

4 changes: 2 additions & 2 deletions
src/mono/wasm/host/BrowserHost.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,7 +167,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 devServerOptions = CreateDevServerOptions(urls, staticWebAssetsPath, onConsoleConnected);

 if (devServerOptions == null)
 throw new CommandLineException("Please, provide mainAssembly in hostProperties of runtimeconfig");
 throw new CommandLineException($"Please, provide mainAssembly in hostProperties of runtimeconfig. Alternatively leave the static web assets manifest ('*{staticWebAssetsV2Extension}') in the build output directory '{appPath}' .");
 }

 return devServerOptions;
Expand All@@ -183,7 +183,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 );

 private static string? FindFirstFileWithExtension(string directory, string extension)
 => Directory.EnumerateFiles(directory, "*" + extension).First();
 => Directory.EnumerateFiles(directory, "*" + extension).FirstOrDefault();

 private async Task RunConsoleMessagesPump(WebSocket socket, WasmTestMessagesProcessor messagesProcessor, CancellationToken token)
 {
Expand Down

3 changes: 1 addition & 2 deletions
src/mono/wasm/host/DevServer/DevServer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,8 +70,7 @@ private static IConfiguration ConfigureHostConfiguration(DevServerOptions option
 [WebHostDefaults.EnvironmentKey] = "Development",
 ["Logging:LogLevel:Microsoft"] = "Warning",
 ["Logging:LogLevel:Microsoft.Hosting.Lifetime"] = "Information",
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath,
 ["ApplyCopHeaders"] = options.WebServerUseCrossOriginPolicy.ToString()
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath
 };

 config.AddInMemoryCollection(inMemoryConfiguration);
Expand Down

34 changes: 30 additions & 4 deletions
src/mono/wasm/host/DevServer/DevServerStartup.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,13 +2,16 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.IO;
using System.Net.WebSockets;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.WebAssembly.AppHost;

namespace Microsoft.WebAssembly.AppHost.DevServer;
Expand All@@ -27,16 +30,16 @@ public static void ConfigureServices(IServiceCollection services)
 services.AddRouting();
 }

 public static void Configure(IApplicationBuilder app, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 public static void Configure(IApplicationBuilder app, IOptions<DevServerOptions> optionsContainer, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 {
 app.UseDeveloperExceptionPage();
 EnableConfiguredPathbase(app, configuration);

 app.UseWebAssemblyDebugging();

bool applyCopHeaders = configuration.GetValue<bool>("ApplyCopHeaders");
DevServerOptions options = optionsContainer.Value;

 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 app.Use(async (ctx, next) =>
 {
Expand All@@ -63,14 +66,37 @@ public static void Configure(IApplicationBuilder app, TaskCompletionSource<Serve
 });

 app.UseRouting();
 app.UseWebSockets();

 if (options.OnConsoleConnected is not null)
 {
 app.Use(async (ctx, next) =>
 {
 if (ctx.Request.Path.StartsWithSegments("/console"))
 {
 if (!ctx.WebSockets.IsWebSocketRequest)
 {
 ctx.Response.StatusCode = 400;
 return;
 }

 using WebSocket socket = await ctx.WebSockets.AcceptWebSocketAsync();
 await options.OnConsoleConnected(socket);
 }
 else
 {
 await next(ctx);
 }
 });
 }

 app.UseEndpoints(endpoints =>
 {
 endpoints.MapFallbackToFile("index.html", new StaticFileOptions
 {
 OnPrepareResponse = fileContext =>
 {
 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 // Browser multi-threaded runtime requires cross-origin policy headers to enable SharedArrayBuffer.
 ApplyCrossOriginPolicyHeaders(fileContext.Context);
Expand Down

3 changes: 3 additions & 0 deletions
src/mono/wasm/host/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ public static async Task<int> Main(string[] args)
 RegisterHostHandler(WasmHost.Wasmtime, WasiEngineHost.InvokeAsync);

 using CancellationTokenSource cts = new();

 Console.CancelKeyPress += (object? sender, ConsoleCancelEventArgs e) => cts.Cancel();
Comment thread
maraf marked this conversation as resolved.


 ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
 builder
 .AddPassThroughConsole()
Expand Down

26 changes: 0 additions & 26 deletions
src/mono/wasm/templates/templates/browser/README.md

View file


Open in desktop


This file was deleted.


11 changes: 2 additions & 9 deletions
src/mono/wasm/templates/templates/browser/browser.0.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk.WebAssembly">
 <PropertyGroup>
 <TargetFramework>net7.0</TargetFramework>
 <RuntimeIdentifier>browser-wasm</RuntimeIdentifier>
 <OutputType>Exe</OutputType>
 <TargetFramework>net8.0</TargetFramework>
 <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 </PropertyGroup>

 <ItemGroup>
 <WasmExtraFilesToDeploy Include="index.html" />
 <WasmExtraFilesToDeploy Include="main.js" />
 </ItemGroup>
</Project>

5 changes: 2 additions & 3 deletions
src/mono/wasm/templates/templates/browser/runtimeconfig.template.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,9 +3,8 @@
 "perHostConfig": [
 {
 "name": "browser",
 "html-path": "index.html",
 "Host": "browser"
 "host": "browser"
 }
 ]
 }
}
}

0
...sm/templates/templates/browser/index.html → ...ates/templates/browser/wwwroot/index.html

View file


Open in desktop


File renamed without changes.


0
.../wasm/templates/templates/browser/main.js → ...mplates/templates/browser/wwwroot/main.js

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[browser] Update browser template to use Wasm SDK#90871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

radical
merged 18 commits into

from

Aug 23, 2023
 Merged


[browser] Update browser template to use Wasm SDK
#90871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


18 commits


Select commit
Hold shift + click to select a range
827b090

Use WasmSdk in browser template


maraf Aug 17, 2023
b2ff838

Remove default html-path


maraf Aug 18, 2023
59498d1

Use wwwroot when looking for main.js in template for replacement


maraf Aug 18, 2023
351651f

Temporarily remove WasmRuntimeAssetsLocation from WBT because WasmSDK…


maraf Aug 18, 2023
d6698d5

Integrate console log forward into DevServer


maraf Aug 18, 2023
41f0c75

Replace UseRouter


maraf Aug 18, 2023
9600a1e

Use next middleware only if it's not console


maraf Aug 21, 2023
139ff28

CancellationTokenSource on CancelKeyPress


maraf Aug 21, 2023
0350207

Address feedback from initial DevServer integration


maraf Aug 21, 2023
9948fe5

Update src/mono/wasm/host/BrowserHost.cs


maraf Aug 22, 2023
cc20713

Remove debugging code


maraf Aug 22, 2023
f0076c8

Fix WBT


maraf Aug 22, 2023
6b66a33

Fix starting outside of project directory


maraf Aug 22, 2023
33ec123

Merge remote-tracking branch 'upstream/main' into WasmSdkTemplate2


maraf Aug 22, 2023
b3844c0

Support WasmRuntimeAssetsLocation in Wasm SDK


maraf Aug 22, 2023
18d9da5

Revert "Support WasmRuntimeAssetsLocation in Wasm SDK"


maraf Aug 23, 2023
c448e94

Active issue for WasmRuntimeAssetsLocation


maraf Aug 23, 2023
cfaf8c0

Feedback


maraf Aug 23, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 6 additions & 2 deletions
...et/Microsoft.NET.Sdk.WebAssembly.Pack/build/Microsoft.NET.Sdk.WebAssembly.Browser.targets

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,13 @@ Copyright (c) .NET Foundation. All rights reserved.
 <RunCommand Condition="'$(RunCommand)' == ''">dotnet</RunCommand>

 <WasmAppHostDir>$([MSBuild]::NormalizeDirectory($(MSBuildThisFileDirectory), '..', 'WasmAppHost'))</WasmAppHostDir>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(OutputPath), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <_RunWorkingDirectory>$(OutputPath)</_RunWorkingDirectory>
 <_RunWorkingDirectory Condition="'$(_RunWorkingDirectory)' != '' and !$([System.IO.Path]::IsPathRooted($(_RunWorkingDirectory)))">$([System.IO.Path]::Combine($(MSBuildProjectDirectory), $(_RunWorkingDirectory)))</_RunWorkingDirectory>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(_RunWorkingDirectory), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <RunArguments>exec &quot;$([MSBuild]::NormalizePath($(WasmAppHostDir), 'WasmAppHost.dll'))&quot; --use-staticwebassets --runtime-config &quot;$(_RuntimeConfigJsonPath)&quot; $(WasmHostArguments)</RunArguments>
 <RunWorkingDirectory>$(OutputPath)</RunWorkingDirectory>
 <RunWorkingDirectory>$(_RunWorkingDirectory)</RunWorkingDirectory>
 </PropertyGroup>

 <PropertyGroup>
Expand Down

7 changes: 4 additions & 3 deletions
src/mono/wasm/Wasm.Build.Tests/Templates/WasmTemplateTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private void UpdateProgramCS()

 private void UpdateBrowserMainJs(string targetFramework, string runtimeAssetsRelativePath = DefaultRuntimeAssetsRelativePath)
 {
 string mainJsPath = Path.Combine(_projectDir!, "main.js");
 string mainJsPath = Path.Combine(_projectDir!, "wwwroot", "main.js");
 string mainJsContent = File.ReadAllText(mainJsPath);

 // .withExitOnUnhandledError() is available only only >net7.0
Expand DownExpand Up@@ -408,11 +408,12 @@ public void ConsolePublishAndRun(string config, bool aot, bool relinking)

 [Theory]
 [InlineData("", BuildTestBase.DefaultTargetFramework, DefaultRuntimeAssetsRelativePath)]
 [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/90979")]
 // [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [InlineData("-f net8.0", "net8.0", "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/79313")]
 // [InlineData("-f net7.0", "net7.0")]
 [InlineData("-f net8.0", "net8.0", DefaultRuntimeAssetsRelativePath)]
 [InlineData("-f net8.0", "net8.0", "./")]
 public async Task BrowserBuildAndRun(string extraNewArgs, string targetFramework, string runtimeAssetsRelativePath)
 {
 string config = "Debug";
Expand Down

15 changes: 15 additions & 0 deletions
src/mono/wasm/Wasm.Build.Tests/WasmSdkBasedProjectProvider.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,21 @@ protected override IReadOnlySet<string> GetDotNetFilesExpectedSet(AssertBundleOp
 return res;
 }


 public void AssertBundle(BuildArgs buildArgs, BuildProjectOptions buildProjectOptions)
 {
 AssertBundle(new(
 Config: buildArgs.Config,
 IsPublish: buildProjectOptions.Publish,
 TargetFramework: buildProjectOptions.TargetFramework,
 BinFrameworkDir: buildProjectOptions.BinFrameworkDir ?? FindBinFrameworkDir(buildArgs.Config, buildProjectOptions.Publish, buildProjectOptions.TargetFramework),
 PredefinedIcudt: buildProjectOptions.PredefinedIcudt,
 GlobalizationMode: buildProjectOptions.GlobalizationMode,
 AssertSymbolsFile: false,
 ExpectedFileType: buildProjectOptions.Publish && buildArgs.Config == "Release" ? NativeFilesType.Relinked : NativeFilesType.FromRuntimePack
 ));
 }

 public void AssertBundle(AssertWasmSdkBundleOptions assertOptions)
 {
 IReadOnlyDictionary<string, DotNetFileName> actualDotnetFiles = AssertBasicBundle(assertOptions);
Expand Down

28 changes: 23 additions & 5 deletions
src/mono/wasm/Wasm.Build.Tests/WasmTemplateTestBase.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,31 +59,49 @@ public string CreateWasmTemplateProject(string id, string template = "wasmbrowse

 public (string projectDir, string buildOutput) BuildTemplateProject(BuildArgs buildArgs,
 string id,
 BuildProjectOptions buildProjectOptions,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 BuildProjectOptions buildProjectOptions)
 {
 (CommandResult res, string logFilePath) = BuildProjectWithoutAssert(id, buildArgs.Config, buildProjectOptions);
 if (buildProjectOptions.UseCache)
 _buildContext.CacheBuild(buildArgs, new BuildProduct(_projectDir!, logFilePath, true, res.Output));

 if (buildProjectOptions.AssertAppBundle)
 AssertBundle(buildArgs, buildProjectOptions, res.Output, assertAppBundleOptions);
 {
 if (buildProjectOptions.IsBrowserProject)
 AssertWasmSdkBundle(buildArgs, buildProjectOptions, res.Output);
 else
 AssertTestMainJsBundle(buildArgs, buildProjectOptions, res.Output);
 }
 return (_projectDir!, res.Output);
 }

 public void AssertBundle(BuildArgs buildArgs,
 public void AssertTestMainJsBundle(BuildArgs buildArgs,
Comment thread
radical marked this conversation as resolved.

 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 // TODO: templates don't use wasm sdk yet
 var testMainJsProvider = new TestMainJsProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 testMainJsProvider.AssertBundle(assertAppBundleOptions);
 else
 testMainJsProvider.AssertBundle(buildArgs, buildProjectOptions);
 }

 public void AssertWasmSdkBundle(BuildArgs buildArgs,
 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertWasmSdkBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 var projectProvider = new WasmSdkBasedProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 projectProvider.AssertBundle(assertAppBundleOptions);
 else
 projectProvider.AssertBundle(buildArgs, buildProjectOptions);
 }
}

4 changes: 2 additions & 2 deletions
src/mono/wasm/host/BrowserHost.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,7 +167,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 devServerOptions = CreateDevServerOptions(urls, staticWebAssetsPath, onConsoleConnected);

 if (devServerOptions == null)
 throw new CommandLineException("Please, provide mainAssembly in hostProperties of runtimeconfig");
 throw new CommandLineException($"Please, provide mainAssembly in hostProperties of runtimeconfig. Alternatively leave the static web assets manifest ('*{staticWebAssetsV2Extension}') in the build output directory '{appPath}' .");
 }

 return devServerOptions;
Expand All@@ -183,7 +183,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 );

 private static string? FindFirstFileWithExtension(string directory, string extension)
 => Directory.EnumerateFiles(directory, "*" + extension).First();
 => Directory.EnumerateFiles(directory, "*" + extension).FirstOrDefault();

 private async Task RunConsoleMessagesPump(WebSocket socket, WasmTestMessagesProcessor messagesProcessor, CancellationToken token)
 {
Expand Down

3 changes: 1 addition & 2 deletions
src/mono/wasm/host/DevServer/DevServer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,8 +70,7 @@ private static IConfiguration ConfigureHostConfiguration(DevServerOptions option
 [WebHostDefaults.EnvironmentKey] = "Development",
 ["Logging:LogLevel:Microsoft"] = "Warning",
 ["Logging:LogLevel:Microsoft.Hosting.Lifetime"] = "Information",
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath,
 ["ApplyCopHeaders"] = options.WebServerUseCrossOriginPolicy.ToString()
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath
 };

 config.AddInMemoryCollection(inMemoryConfiguration);
Expand Down

34 changes: 30 additions & 4 deletions
src/mono/wasm/host/DevServer/DevServerStartup.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,13 +2,16 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.IO;
using System.Net.WebSockets;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.WebAssembly.AppHost;

namespace Microsoft.WebAssembly.AppHost.DevServer;
Expand All@@ -27,16 +30,16 @@ public static void ConfigureServices(IServiceCollection services)
 services.AddRouting();
 }

 public static void Configure(IApplicationBuilder app, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 public static void Configure(IApplicationBuilder app, IOptions<DevServerOptions> optionsContainer, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 {
 app.UseDeveloperExceptionPage();
 EnableConfiguredPathbase(app, configuration);

 app.UseWebAssemblyDebugging();

bool applyCopHeaders = configuration.GetValue<bool>("ApplyCopHeaders");
DevServerOptions options = optionsContainer.Value;

 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 app.Use(async (ctx, next) =>
 {
Expand All@@ -63,14 +66,37 @@ public static void Configure(IApplicationBuilder app, TaskCompletionSource<Serve
 });

 app.UseRouting();
 app.UseWebSockets();

 if (options.OnConsoleConnected is not null)
 {
 app.Use(async (ctx, next) =>
 {
 if (ctx.Request.Path.StartsWithSegments("/console"))
 {
 if (!ctx.WebSockets.IsWebSocketRequest)
 {
 ctx.Response.StatusCode = 400;
 return;
 }

 using WebSocket socket = await ctx.WebSockets.AcceptWebSocketAsync();
 await options.OnConsoleConnected(socket);
 }
 else
 {
 await next(ctx);
 }
 });
 }

 app.UseEndpoints(endpoints =>
 {
 endpoints.MapFallbackToFile("index.html", new StaticFileOptions
 {
 OnPrepareResponse = fileContext =>
 {
 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 // Browser multi-threaded runtime requires cross-origin policy headers to enable SharedArrayBuffer.
 ApplyCrossOriginPolicyHeaders(fileContext.Context);
Expand Down

3 changes: 3 additions & 0 deletions
src/mono/wasm/host/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ public static async Task<int> Main(string[] args)
 RegisterHostHandler(WasmHost.Wasmtime, WasiEngineHost.InvokeAsync);

 using CancellationTokenSource cts = new();

 Console.CancelKeyPress += (object? sender, ConsoleCancelEventArgs e) => cts.Cancel();
Comment thread
maraf marked this conversation as resolved.


 ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
 builder
 .AddPassThroughConsole()
Expand Down

26 changes: 0 additions & 26 deletions
src/mono/wasm/templates/templates/browser/README.md

View file


Open in desktop


This file was deleted.


11 changes: 2 additions & 9 deletions
src/mono/wasm/templates/templates/browser/browser.0.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk.WebAssembly">
 <PropertyGroup>
 <TargetFramework>net7.0</TargetFramework>
 <RuntimeIdentifier>browser-wasm</RuntimeIdentifier>
 <OutputType>Exe</OutputType>
 <TargetFramework>net8.0</TargetFramework>
 <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 </PropertyGroup>

 <ItemGroup>
 <WasmExtraFilesToDeploy Include="index.html" />
 <WasmExtraFilesToDeploy Include="main.js" />
 </ItemGroup>
</Project>

5 changes: 2 additions & 3 deletions
src/mono/wasm/templates/templates/browser/runtimeconfig.template.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,9 +3,8 @@
 "perHostConfig": [
 {
 "name": "browser",
 "html-path": "index.html",
 "Host": "browser"
 "host": "browser"
 }
 ]
 }
}
}

0
...sm/templates/templates/browser/index.html → ...ates/templates/browser/wwwroot/index.html

View file


Open in desktop


File renamed without changes.


0
.../wasm/templates/templates/browser/main.js → ...mplates/templates/browser/wwwroot/main.js

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
[browser] Update browser template to use Wasm SDK#90871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

radical
merged 18 commits into

from

Aug 23, 2023
 Merged


[browser] Update browser template to use Wasm SDK
#90871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


18 commits


Select commit
Hold shift + click to select a range
827b090

Use WasmSdk in browser template


maraf Aug 17, 2023
b2ff838

Remove default html-path


maraf Aug 18, 2023
59498d1

Use wwwroot when looking for main.js in template for replacement


maraf Aug 18, 2023
351651f

Temporarily remove WasmRuntimeAssetsLocation from WBT because WasmSDK…


maraf Aug 18, 2023
d6698d5

Integrate console log forward into DevServer


maraf Aug 18, 2023
41f0c75

Replace UseRouter


maraf Aug 18, 2023
9600a1e

Use next middleware only if it's not console


maraf Aug 21, 2023
139ff28

CancellationTokenSource on CancelKeyPress


maraf Aug 21, 2023
0350207

Address feedback from initial DevServer integration


maraf Aug 21, 2023
9948fe5

Update src/mono/wasm/host/BrowserHost.cs


maraf Aug 22, 2023
cc20713

Remove debugging code


maraf Aug 22, 2023
f0076c8

Fix WBT


maraf Aug 22, 2023
6b66a33

Fix starting outside of project directory


maraf Aug 22, 2023
33ec123

Merge remote-tracking branch 'upstream/main' into WasmSdkTemplate2


maraf Aug 22, 2023
b3844c0

Support WasmRuntimeAssetsLocation in Wasm SDK


maraf Aug 22, 2023
18d9da5

Revert "Support WasmRuntimeAssetsLocation in Wasm SDK"


maraf Aug 23, 2023
c448e94

Active issue for WasmRuntimeAssetsLocation


maraf Aug 23, 2023
cfaf8c0

Feedback


maraf Aug 23, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 6 additions & 2 deletions
...et/Microsoft.NET.Sdk.WebAssembly.Pack/build/Microsoft.NET.Sdk.WebAssembly.Browser.targets

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,13 @@ Copyright (c) .NET Foundation. All rights reserved.
 <RunCommand Condition="'$(RunCommand)' == ''">dotnet</RunCommand>

 <WasmAppHostDir>$([MSBuild]::NormalizeDirectory($(MSBuildThisFileDirectory), '..', 'WasmAppHost'))</WasmAppHostDir>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(OutputPath), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <_RunWorkingDirectory>$(OutputPath)</_RunWorkingDirectory>
 <_RunWorkingDirectory Condition="'$(_RunWorkingDirectory)' != '' and !$([System.IO.Path]::IsPathRooted($(_RunWorkingDirectory)))">$([System.IO.Path]::Combine($(MSBuildProjectDirectory), $(_RunWorkingDirectory)))</_RunWorkingDirectory>
 <_RuntimeConfigJsonPath>$([MSBuild]::NormalizePath($(_RunWorkingDirectory), '$(AssemblyName).runtimeconfig.json'))</_RuntimeConfigJsonPath>

 <RunArguments>exec &quot;$([MSBuild]::NormalizePath($(WasmAppHostDir), 'WasmAppHost.dll'))&quot; --use-staticwebassets --runtime-config &quot;$(_RuntimeConfigJsonPath)&quot; $(WasmHostArguments)</RunArguments>
 <RunWorkingDirectory>$(OutputPath)</RunWorkingDirectory>
 <RunWorkingDirectory>$(_RunWorkingDirectory)</RunWorkingDirectory>
 </PropertyGroup>

 <PropertyGroup>
Expand Down

7 changes: 4 additions & 3 deletions
src/mono/wasm/Wasm.Build.Tests/Templates/WasmTemplateTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private void UpdateProgramCS()

 private void UpdateBrowserMainJs(string targetFramework, string runtimeAssetsRelativePath = DefaultRuntimeAssetsRelativePath)
 {
 string mainJsPath = Path.Combine(_projectDir!, "main.js");
 string mainJsPath = Path.Combine(_projectDir!, "wwwroot", "main.js");
 string mainJsContent = File.ReadAllText(mainJsPath);

 // .withExitOnUnhandledError() is available only only >net7.0
Expand DownExpand Up@@ -408,11 +408,12 @@ public void ConsolePublishAndRun(string config, bool aot, bool relinking)

 [Theory]
 [InlineData("", BuildTestBase.DefaultTargetFramework, DefaultRuntimeAssetsRelativePath)]
 [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/90979")]
 // [InlineData("", BuildTestBase.DefaultTargetFramework, "./")]
 // [InlineData("-f net8.0", "net8.0", "./")]
 // [ActiveIssue("https://github.com/dotnet/runtime/issues/79313")]
 // [InlineData("-f net7.0", "net7.0")]
 [InlineData("-f net8.0", "net8.0", DefaultRuntimeAssetsRelativePath)]
 [InlineData("-f net8.0", "net8.0", "./")]
 public async Task BrowserBuildAndRun(string extraNewArgs, string targetFramework, string runtimeAssetsRelativePath)
 {
 string config = "Debug";
Expand Down

15 changes: 15 additions & 0 deletions
src/mono/wasm/Wasm.Build.Tests/WasmSdkBasedProjectProvider.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,21 @@ protected override IReadOnlySet<string> GetDotNetFilesExpectedSet(AssertBundleOp
 return res;
 }


 public void AssertBundle(BuildArgs buildArgs, BuildProjectOptions buildProjectOptions)
 {
 AssertBundle(new(
 Config: buildArgs.Config,
 IsPublish: buildProjectOptions.Publish,
 TargetFramework: buildProjectOptions.TargetFramework,
 BinFrameworkDir: buildProjectOptions.BinFrameworkDir ?? FindBinFrameworkDir(buildArgs.Config, buildProjectOptions.Publish, buildProjectOptions.TargetFramework),
 PredefinedIcudt: buildProjectOptions.PredefinedIcudt,
 GlobalizationMode: buildProjectOptions.GlobalizationMode,
 AssertSymbolsFile: false,
 ExpectedFileType: buildProjectOptions.Publish && buildArgs.Config == "Release" ? NativeFilesType.Relinked : NativeFilesType.FromRuntimePack
 ));
 }

 public void AssertBundle(AssertWasmSdkBundleOptions assertOptions)
 {
 IReadOnlyDictionary<string, DotNetFileName> actualDotnetFiles = AssertBasicBundle(assertOptions);
Expand Down

28 changes: 23 additions & 5 deletions
src/mono/wasm/Wasm.Build.Tests/WasmTemplateTestBase.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,31 +59,49 @@ public string CreateWasmTemplateProject(string id, string template = "wasmbrowse

 public (string projectDir, string buildOutput) BuildTemplateProject(BuildArgs buildArgs,
 string id,
 BuildProjectOptions buildProjectOptions,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 BuildProjectOptions buildProjectOptions)
 {
 (CommandResult res, string logFilePath) = BuildProjectWithoutAssert(id, buildArgs.Config, buildProjectOptions);
 if (buildProjectOptions.UseCache)
 _buildContext.CacheBuild(buildArgs, new BuildProduct(_projectDir!, logFilePath, true, res.Output));

 if (buildProjectOptions.AssertAppBundle)
 AssertBundle(buildArgs, buildProjectOptions, res.Output, assertAppBundleOptions);
 {
 if (buildProjectOptions.IsBrowserProject)
 AssertWasmSdkBundle(buildArgs, buildProjectOptions, res.Output);
 else
 AssertTestMainJsBundle(buildArgs, buildProjectOptions, res.Output);
 }
 return (_projectDir!, res.Output);
 }

 public void AssertBundle(BuildArgs buildArgs,
 public void AssertTestMainJsBundle(BuildArgs buildArgs,
Comment thread
radical marked this conversation as resolved.

 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertTestMainJsAppBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 // TODO: templates don't use wasm sdk yet
 var testMainJsProvider = new TestMainJsProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 testMainJsProvider.AssertBundle(assertAppBundleOptions);
 else
 testMainJsProvider.AssertBundle(buildArgs, buildProjectOptions);
 }

 public void AssertWasmSdkBundle(BuildArgs buildArgs,
 BuildProjectOptions buildProjectOptions,
 string? buildOutput = null,
 AssertWasmSdkBundleOptions? assertAppBundleOptions = null)
 {
 if (buildOutput is not null)
 ProjectProviderBase.AssertRuntimePackPath(buildOutput, buildProjectOptions.TargetFramework ?? DefaultTargetFramework);

 var projectProvider = new WasmSdkBasedProjectProvider(_testOutput, _projectDir!);
 if (assertAppBundleOptions is not null)
 projectProvider.AssertBundle(assertAppBundleOptions);
 else
 projectProvider.AssertBundle(buildArgs, buildProjectOptions);
 }
}

4 changes: 2 additions & 2 deletions
src/mono/wasm/host/BrowserHost.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,7 +167,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 devServerOptions = CreateDevServerOptions(urls, staticWebAssetsPath, onConsoleConnected);

 if (devServerOptions == null)
 throw new CommandLineException("Please, provide mainAssembly in hostProperties of runtimeconfig");
 throw new CommandLineException($"Please, provide mainAssembly in hostProperties of runtimeconfig. Alternatively leave the static web assets manifest ('*{staticWebAssetsV2Extension}') in the build output directory '{appPath}' .");
 }

 return devServerOptions;
Expand All@@ -183,7 +183,7 @@ private static DevServerOptions CreateDevServerOptions(BrowserArguments args, st
 );

 private static string? FindFirstFileWithExtension(string directory, string extension)
 => Directory.EnumerateFiles(directory, "*" + extension).First();
 => Directory.EnumerateFiles(directory, "*" + extension).FirstOrDefault();

 private async Task RunConsoleMessagesPump(WebSocket socket, WasmTestMessagesProcessor messagesProcessor, CancellationToken token)
 {
Expand Down

3 changes: 1 addition & 2 deletions
src/mono/wasm/host/DevServer/DevServer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,8 +70,7 @@ private static IConfiguration ConfigureHostConfiguration(DevServerOptions option
 [WebHostDefaults.EnvironmentKey] = "Development",
 ["Logging:LogLevel:Microsoft"] = "Warning",
 ["Logging:LogLevel:Microsoft.Hosting.Lifetime"] = "Information",
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath,
 ["ApplyCopHeaders"] = options.WebServerUseCrossOriginPolicy.ToString()
 [WebHostDefaults.StaticWebAssetsKey] = options.StaticWebAssetsPath
 };

 config.AddInMemoryCollection(inMemoryConfiguration);
Expand Down

34 changes: 30 additions & 4 deletions
src/mono/wasm/host/DevServer/DevServerStartup.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,13 +2,16 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.IO;
using System.Net.WebSockets;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.WebAssembly.AppHost;

namespace Microsoft.WebAssembly.AppHost.DevServer;
Expand All@@ -27,16 +30,16 @@ public static void ConfigureServices(IServiceCollection services)
 services.AddRouting();
 }

 public static void Configure(IApplicationBuilder app, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 public static void Configure(IApplicationBuilder app, IOptions<DevServerOptions> optionsContainer, TaskCompletionSource<ServerURLs> realUrlsAvailableTcs, ILogger logger, IHostApplicationLifetime applicationLifetime, IConfiguration configuration)
 {
 app.UseDeveloperExceptionPage();
 EnableConfiguredPathbase(app, configuration);

 app.UseWebAssemblyDebugging();

bool applyCopHeaders = configuration.GetValue<bool>("ApplyCopHeaders");
DevServerOptions options = optionsContainer.Value;

 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 app.Use(async (ctx, next) =>
 {
Expand All@@ -63,14 +66,37 @@ public static void Configure(IApplicationBuilder app, TaskCompletionSource<Serve
 });

 app.UseRouting();
 app.UseWebSockets();

 if (options.OnConsoleConnected is not null)
 {
 app.Use(async (ctx, next) =>
 {
 if (ctx.Request.Path.StartsWithSegments("/console"))
 {
 if (!ctx.WebSockets.IsWebSocketRequest)
 {
 ctx.Response.StatusCode = 400;
 return;
 }

 using WebSocket socket = await ctx.WebSockets.AcceptWebSocketAsync();
 await options.OnConsoleConnected(socket);
 }
 else
 {
 await next(ctx);
 }
 });
 }

 app.UseEndpoints(endpoints =>
 {
 endpoints.MapFallbackToFile("index.html", new StaticFileOptions
 {
 OnPrepareResponse = fileContext =>
 {
 if (applyCopHeaders)
 if (options.WebServerUseCrossOriginPolicy)
 {
 // Browser multi-threaded runtime requires cross-origin policy headers to enable SharedArrayBuffer.
 ApplyCrossOriginPolicyHeaders(fileContext.Context);
Expand Down

3 changes: 3 additions & 0 deletions
src/mono/wasm/host/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ public static async Task<int> Main(string[] args)
 RegisterHostHandler(WasmHost.Wasmtime, WasiEngineHost.InvokeAsync);

 using CancellationTokenSource cts = new();

 Console.CancelKeyPress += (object? sender, ConsoleCancelEventArgs e) => cts.Cancel();
Comment thread
maraf marked this conversation as resolved.


 ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
 builder
 .AddPassThroughConsole()
Expand Down

26 changes: 0 additions & 26 deletions
src/mono/wasm/templates/templates/browser/README.md

View file


Open in desktop


This file was deleted.


11 changes: 2 additions & 9 deletions
src/mono/wasm/templates/templates/browser/browser.0.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk.WebAssembly">
 <PropertyGroup>
 <TargetFramework>net7.0</TargetFramework>
 <RuntimeIdentifier>browser-wasm</RuntimeIdentifier>
 <OutputType>Exe</OutputType>
 <TargetFramework>net8.0</TargetFramework>
 <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 </PropertyGroup>

 <ItemGroup>
 <WasmExtraFilesToDeploy Include="index.html" />
 <WasmExtraFilesToDeploy Include="main.js" />
 </ItemGroup>
</Project>

5 changes: 2 additions & 3 deletions
src/mono/wasm/templates/templates/browser/runtimeconfig.template.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,9 +3,8 @@
 "perHostConfig": [
 {
 "name": "browser",
 "html-path": "index.html",
 "Host": "browser"
 "host": "browser"
 }
 ]
 }
}
}

0
...sm/templates/templates/browser/index.html → ...ates/templates/browser/wwwroot/index.html

View file


Open in desktop


File renamed without changes.


0
.../wasm/templates/templates/browser/main.js → ...mplates/templates/browser/wwwroot/main.js

View file


Open in desktop


File renamed without changes.