[browser][MT] Add new test for multi-threading SignalR in Blazor WBT

eng/testing/scenarios/BuildWasmAppsJobsList.txt

@@ -36,12 +36,13 @@ Wasm.Build.Tests.TestAppScenarios.AppSettingsTests
 Wasm.Build.Tests.TestAppScenarios.LazyLoadingTests
 Wasm.Build.Tests.TestAppScenarios.LibraryInitializerTests
 Wasm.Build.Tests.TestAppScenarios.SatelliteLoadingTests
+Wasm.Build.Tests.TestAppScenarios.DownloadResourceProgressTests
+Wasm.Build.Tests.TestAppScenarios.SignalRClientTests
 Wasm.Build.Tests.WasmBuildAppTest
 Wasm.Build.Tests.WasmNativeDefaultsTests
 Wasm.Build.Tests.WasmRunOutOfAppBundleTests
 Wasm.Build.Tests.WasmSIMDTests
 Wasm.Build.Tests.WasmTemplateTests
 Wasm.Build.Tests.WorkloadTests
-Wasm.Build.Tests.TestAppScenarios.DownloadResourceProgressTests
 Wasm.Build.Tests.MT.Blazor.SimpleMultiThreadedTests
 Wasm.Build.Tests.TestAppScenarios.DebugLevelTests

src/mono/nuget/Microsoft.NET.Sdk.WebAssembly.Pack/build/Microsoft.NET.Sdk.WebAssembly.Browser.targets

@@ -225,7 +225,7 @@ Copyright (c) .NET Foundation. All rights reserved.
 
       <!-- Remove dotnet.js/wasm from runtime pack, in favor of the relinked ones in @(WasmNativeAsset) -->
       <ReferenceCopyLocalPaths Remove="@(ReferenceCopyLocalPaths)"
-                               Condition="@(WasmNativeAsset->Count()) > 0 and ( '%(FileName)' == 'dotnet' or '%(FileName)' == 'dotnet.native' ) and ('%(Extension)' == '.wasm' or '%(Extension)' == '.js')" />
+                               Condition="@(WasmNativeAsset->Count()) > 0 and ( '%(FileName)' == 'dotnet' or '%(FileName)' == 'dotnet.native' or '%(FileName)' == 'dotnet.native.worker' ) and ('%(Extension)' == '.wasm' or '%(Extension)' == '.js')" />
     </ItemGroup>
 
     <PropertyGroup>

src/mono/wasm/Wasm.Build.Tests/Blazor/BlazorWasmTestBase.cs

@@ -237,6 +237,6 @@ void OnErrorMessage(string msg)
         }
     }
 
-    public string FindBlazorBinFrameworkDir(string config, bool forPublish, string framework = DefaultTargetFrameworkForBlazor)
-        => _provider.FindBinFrameworkDir(config: config, forPublish: forPublish, framework: framework);
+    public string FindBlazorBinFrameworkDir(string config, bool forPublish, string framework = DefaultTargetFrameworkForBlazor, string? projectDir = null)
+        => _provider.FindBinFrameworkDir(config: config, forPublish: forPublish, framework: framework, projectDir: projectDir);
 }

src/mono/wasm/Wasm.Build.Tests/BrowserRunner.cs

@@ -91,7 +91,8 @@ public async Task<IBrowser> SpawnBrowserAsync(
     ) {
         var url = new Uri(browserUrl);
         Playwright = await Microsoft.Playwright.Playwright.CreateAsync();
-        string[] chromeArgs = new[] { $"--explicitly-allowed-ports={url.Port}" };
+        // ignore certificate error -> Microsoft.Playwright.PlaywrightException : net::ERR_CERT_AUTHORITY_INVALID
+        string[] chromeArgs = new[] { $"--explicitly-allowed-ports={url.Port}", "--ignore-certificate-errors" };
         _testOutput.WriteLine($"Launching chrome ('{s_chromePath.Value}') via playwright with args = {string.Join(',', chromeArgs)}");
         return Browser = await Playwright.Chromium.LaunchAsync(new BrowserTypeLaunchOptions{
             ExecutablePath = s_chromePath.Value,

src/mono/wasm/Wasm.Build.Tests/ProjectProviderBase.cs

@@ -490,10 +490,10 @@ private void AssertFileNames(IEnumerable<string> expected, IEnumerable<string> a
         Assert.Equal(expected, actualFileNames);
     }
 
-    public virtual string FindBinFrameworkDir(string config, bool forPublish, string framework, string? bundleDirName = null)
+    public virtual string FindBinFrameworkDir(string config, bool forPublish, string framework, string? bundleDirName = null, string? projectDir = null)
     {
         EnsureProjectDirIsSet();
-        string basePath = Path.Combine(ProjectDir!, "bin", config, framework);
+        string basePath = Path.Combine(projectDir ?? ProjectDir!, "bin", config, framework);
         if (forPublish)
             basePath = FindSubDirIgnoringCase(basePath, "publish");
 

src/mono/wasm/Wasm.Build.Tests/TestAppScenarios/AppTestBase.cs

@@ -31,14 +31,32 @@ protected void CopyTestAsset(string assetName, string generatedProjectNamePrefix
         LogPath = Path.Combine(s_buildEnv.LogRootPath, Id);
         Utils.DirectoryCopy(Path.Combine(BuildEnvironment.TestAssetsPath, assetName), Path.Combine(_projectDir!));
 
-        // WasmBasicTestApp consists of App + Library projects
-        if (assetName == "WasmBasicTestApp")
-            _projectDir = Path.Combine(_projectDir!, "App");
+        switch(assetName)
+        {
+            case "WasmBasicTestApp":
+                // WasmBasicTestApp consists of App + Library projects
+                _projectDir = Path.Combine(_projectDir!, "App");
+                break;
+            case "BlazorHostedApp":
+                // BlazorHostedApp consists of BlazorHosted.Client and BlazorHosted.Server projects
+                _projectDir = Path.Combine(_projectDir!, "BlazorHosted.Server");
+                break;
+        }
     }
 
-    protected void BuildProject(string configuration, params string[] extraArgs)
+    protected void BuildProject(
+        string configuration,
+        string? binFrameworkDir = null,
+        RuntimeVariant runtimeType = RuntimeVariant.SingleThreaded,
+        bool assertAppBundle = true,
+        params string[] extraArgs)
     {
-        (CommandResult result, _) = BlazorBuild(new BlazorBuildOptions(Id, configuration), extraArgs);
+        (CommandResult result, _) = BlazorBuild(new BlazorBuildOptions(
+            Id: Id,
+            Config: configuration,
+            BinFrameworkDir: binFrameworkDir,
+            RuntimeType: runtimeType,
+            AssertAppBundle: assertAppBundle), extraArgs); 
         result.EnsureSuccessful();
     }
 
@@ -74,6 +92,7 @@ private async Task<RunResult> RunSdkStyleApp(RunOptions options, BlazorRunHost h
                 Config: options.Configuration,
                 OnConsoleMessage: OnConsoleMessage,
                 QueryString: queryString,
+                ExtraArgs: options.ExtraArgs,
                 Host: host);
 
         await BlazorRunTest(blazorRunOptions);
@@ -114,7 +133,8 @@ protected record RunOptions(
         string TestScenario,
         Dictionary<string, string> BrowserQueryString = null,
         Action<IConsoleMessage> OnConsoleMessage = null,
-        int? ExpectedExitCode = 0
+        int? ExpectedExitCode = 0,
+        string? ExtraArgs = null
     );
 
     protected record RunResult(

src/mono/wasm/Wasm.Build.Tests/TestAppScenarios/BlazorHostedApp/SignalRClientTests.cs

@@ -0,0 +1,57 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Text.RegularExpressions;
+using System.Threading.Tasks;
+using Microsoft.Playwright;
+using Xunit.Abstractions;
+using Xunit;
+
+#nullable enable
+
+namespace Wasm.Build.Tests.TestAppScenarios;
+
+public class SignalRClientTests : AppTestBase
+{
+    public SignalRClientTests(ITestOutputHelper output, SharedBuildPerTestClassFixture buildContext)
+        : base(output, buildContext)
+    {
+    }
+
+    [ConditionalTheory(typeof(BuildTestBase), nameof(IsWorkloadWithMultiThreadingForDefaultFramework))]
+    [InlineData("Debug", "LongPolling")]
+    [InlineData("Release", "LongPolling")]
+    [InlineData("Debug", "WebSockets")]
+    [InlineData("Release", "WebSockets")]
+    public async Task SignalRPassMessages(string config, string transport)
+    {
+        CopyTestAsset("BlazorHostedApp", "SignalRClientTests");
+        RunOptions options = new(
+            Configuration: config,
+            TestScenario: "SignalRPassMessages",
+            BrowserQueryString: new Dictionary<string, string> { ["message"] = "test",  ["transport"] = transport },
+            ExtraArgs: $"--logRootPath {s_buildEnv.LogRootPath}"
+        );
+
+        string rootProjectPath = Directory.GetParent(_projectDir!)?.FullName ?? "";
+        string clientProjectDir = Path.Combine(rootProjectPath, "BlazorHosted.Client");
+        string frameworkDir = FindBlazorBinFrameworkDir(config, forPublish: false, projectDir: clientProjectDir);
+        BuildProject(
+            configuration: config,
+            binFrameworkDir: frameworkDir,
+            runtimeType: RuntimeVariant.MultiThreaded);
+
+        var result = await RunSdkStyleAppForBuild(options);
+
+        // make sure we're not in the main thread (id != 1)
+        var confirmation = result.TestOutput.FirstOrDefault(m => m.Contains($"[{transport}] Client confirms receiving message=test CurrentManagedThreadId="));
+        Assert.NotNull(confirmation);
+        string currentManagedThreadId = confirmation.Split("CurrentManagedThreadId=")[1];
+        Assert.NotEqual("1", currentManagedThreadId);
+    }
+}

src/mono/wasm/Wasm.Build.Tests/TestAppScenarios/DebugLevelTests.cs

@@ -51,7 +51,7 @@ public async Task BuildWithDefaultLevel(string configuration)
     public async Task BuildWithExplicitValue(string configuration, int debugLevel)
     {
         CopyTestAsset("WasmBasicTestApp", $"DebugLevelTests_BuildWithExplicitValue_{configuration}");
-        BuildProject(configuration, $"-p:WasmDebugLevel={debugLevel}");
+        BuildProject(configuration: configuration, extraArgs: $"-p:WasmDebugLevel={debugLevel}");
 
         var result = await RunSdkStyleAppForBuild(new(
             Configuration: configuration,

src/mono/wasm/Wasm.Build.Tests/TestMainJsProjectProvider.cs

@@ -108,9 +108,9 @@ public void AssertBundle(BuildArgs buildArgs, BuildProjectOptions buildProjectOp
         AssertBundle(assertOptions);
     }
 
-    public override string FindBinFrameworkDir(string config, bool forPublish, string framework, string? bundleDirName = null)
+    public override string FindBinFrameworkDir(string config, bool forPublish, string framework, string? bundleDirName = null, string? projectDir = null)
     {
         EnsureProjectDirIsSet();
-        return Path.Combine(ProjectDir!, "bin", config, framework, "browser-wasm", bundleDirName ?? this.BundleDirName, "_framework");
+        return Path.Combine(projectDir ?? ProjectDir!, "bin", config, framework, "browser-wasm", bundleDirName ?? this.BundleDirName, "_framework");
     }
 }

src/mono/wasm/testassets/BlazorHostedApp/BlazorHosted.Client/App.razor

@@ -0,0 +1,12 @@
+<Router AppAssembly="@typeof(App).Assembly">
+    <Found Context="routeData">
+        <RouteView RouteData="@routeData" DefaultLayout="@typeof(MainLayout)" />
+        <FocusOnNavigate RouteData="@routeData" Selector="h1" />
+    </Found>
+    <NotFound>
+        <PageTitle>Not found</PageTitle>
+        <LayoutView Layout="@typeof(MainLayout)">
+            <p role="alert">Sorry, there's nothing at this address.</p>
+        </LayoutView>
+    </NotFound>
+</Router>

src/mono/wasm/testassets/BlazorHostedApp/BlazorHosted.Client/BlazorHosted.Client.csproj

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk.BlazorWebAssembly">
+
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <WasmEnableThreads>true</WasmEnableThreads>
+    <!-- nullablility warnings -->
+    <NoWarn>CS8604</NoWarn>
+  </PropertyGroup>
+
+  <!-- versions are pinned but when run from WBT level, it's taking in-tree runtime -->
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" Version="9.0.0-alpha.1.23614.6" />
+    <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="9.0.0-alpha.1.23614.6" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="8.0.1" />
+    <PackageReference Include="System.Net.Http.Json" Version="8.0.0" />
+  </ItemGroup>
+</Project>

src/mono/wasm/testassets/BlazorHostedApp/BlazorHosted.Client/Helper.cs

@@ -0,0 +1,42 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Collections.Specialized;
+using Microsoft.AspNetCore.Http.Connections;
+
+namespace BlazorHosted.Client;
+
+public static class Helper
+{
+    public static string GetValue(NameValueCollection parameters, string key)
+    {
+        var values = parameters.GetValues(key);
+        if (values == null || values.Length == 0)
+        {
+            throw new Exception($"Parameter '{key}' is required in the query string");
+        }
+        if (values.Length > 1)
+        {
+            throw new Exception($"Parameter '{key}' should be unique in the query string");
+        }
+        return values[0];
+    }
+
+    public static HttpTransportType StringToTransportType(string transport)
+    {
+        switch (transport.ToLowerInvariant())
+        {
+            case "longpolling":
+                return HttpTransportType.LongPolling;
+            case "websockets":
+                return HttpTransportType.WebSockets;
+            default:
+                throw new Exception($"{transport} is invalid transport type");
+        }
+    }
+
+    public static void TestOutputWriteLine(string message)
+    {
+        Console.WriteLine("TestOutput -> " + message);
+    }
+}

src/mono/wasm/testassets/BlazorHostedApp/BlazorHosted.Client/Layout/MainLayout.razor

@@ -0,0 +1,13 @@
+@inherits LayoutComponentBase
+
+<div class="page">
+    <main>
+        <div class="top-row px-4">
+            <a href="https://learn.microsoft.com/aspnet/core/" target="_blank">About</a>
+        </div>
+
+        <article class="content px-4">
+            @Body
+        </article>
+    </main>
+</div>

src/mono/wasm/testassets/BlazorHostedApp/BlazorHosted.Client/Pages/Chat.razor

@@ -0,0 +1,108 @@
+@page "/"
+@using Microsoft.AspNetCore.SignalR
+@using Microsoft.AspNetCore.SignalR.Client
+@using Microsoft.AspNetCore.Http.Connections;
+@using System.Web;
+@inject NavigationManager NavigationManager
+
+<h1>Chat Room</h1>
+<div>
+    @foreach (var chatMessage in chatMessages)
+    {
+        <p>@chatMessage</p>
+    }
+</div>
+
+@code {
+    private string _hubUrl = string.Empty;
+    private HubConnection? _hubConnection;
+    private string message = string.Empty;
+    private string transport = string.Empty;
+    private string scenario = string.Empty;
+    private List<string> chatMessages = new List<string>();
+
+    protected override async Task OnInitializedAsync()
+    {
+        GetQueryParameters();
+        await Connect();
+        if (_hubConnection == null)
+        {
+            throw new Exception($"Hub connection is not initialized for transport={transport}");
+        }
+
+        // wait one second before activating the test scenario
+        await Task.Delay(1000);
+        switch (scenario.ToLower())
+        {
+            case "signalrpassmessages":
+                await SignalRPassMessages();
+                break;
+            default:
+                await FailAndExit($"{scenario} is invalid test scenario name");
+                break;
+        }
+    }
+
+    private async Task SignalRPassMessages() =>
+        await Task.Run(async () =>
+            {
+                Helper.TestOutputWriteLine($"Client: sends message={message} with CurrentManagedThreadId={Environment.CurrentManagedThreadId}");
+                await _hubConnection.SendAsync(
+                    "SendMessage",
+                    message,
+                    Environment.CurrentManagedThreadId);
+            });
+
+    private void GetQueryParameters()
+    {
+        var uri = new Uri(NavigationManager.Uri);
+        if (string.IsNullOrEmpty(uri.Query))
+        {
+            throw new Exception("Query string with parameters 'test', 'message' and 'transport' are required");
+        }
+        var parameters = HttpUtility.ParseQueryString(uri.Query);
+        if (parameters == null)
+        {
+            throw new Exception("Query string with parameters  'test', 'message' and 'transport' are required");
+        }
+        scenario = Helper.GetValue(parameters, "test");
+        transport = Helper.GetValue(parameters, "transport");
+        message = $"[{transport} {Helper.GetValue(parameters, "message")}]" ;
+    }
+
+    private async Task Connect()
+    {
+        _hubUrl = NavigationManager.BaseUri + "chathub";
+        HttpTransportType httpTransportType = Helper.StringToTransportType(transport);
+        _hubConnection = new HubConnectionBuilder()
+            .WithUrl(_hubUrl, options =>
+                {
+                    options.Transports = httpTransportType;
+                })
+            .Build();
+
+        _hubConnection.On<string>("ReceiveMessage", async (message) =>
+        {
+            chatMessages.Add(message);
+            Helper.TestOutputWriteLine($"Client: sends confirmation of receiving the reply from server = {message}, tread receiving the reply = {Environment.CurrentManagedThreadId}");
+            // on this message server calls "Environment.Exit(0)"
+            await _hubConnection.SendAsync("ConfirmClientReceivedMessageAndExitWithSuccess", message);
+            Console.WriteLine("WASM EXIT 0");
+        });
+
+        await _hubConnection.StartAsync();
+    }
+
+    private async Task FailAndExit(string message)
+    {
+        int code = 1;
+        await _hubConnection.SendAsync("Exit", code);
+        Console.WriteLine($"WASM EXIT {code}");
+        throw new Exception(message);
+    }
+
+    public ValueTask? DisposeAsync()
+    {
+        return _hubConnection?.DisposeAsync();
+    }
+}