[browser] Add application environment to boot config (#113164)

Author: maraf

src/mono/browser/runtime/loader/config.ts

@@ -325,6 +325,11 @@ async function loadBootConfig (module: DotnetModuleInternal): Promise<void> {
         }
     }
 
+    // Prefer user-defined application environment
+    if (loaderHelpers.config.applicationEnvironment) {
+        loadedConfig.applicationEnvironment = loaderHelpers.config.applicationEnvironment;
+    }
+
     deep_merge_config(loaderHelpers.config, loadedConfig);
 
     if (!loaderHelpers.config.applicationEnvironment) {
@@ -344,7 +349,7 @@ async function readBootConfigResponse (loadConfigResponse: Response): Promise<Mo
     const config = loaderHelpers.config;
     const loadedConfig: MonoConfig = await loadConfigResponse.json();
 
-    if (!config.applicationEnvironment) {
+    if (!config.applicationEnvironment && !loadedConfig.applicationEnvironment) {
         loadedConfig.applicationEnvironment = loadConfigResponse.headers.get("Blazor-Environment") || loadConfigResponse.headers.get("DotNet-Environment") || undefined;
     }
 

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

@@ -325,6 +325,8 @@ Copyright (c) .NET Foundation. All rights reserved.
   <Target Name="_GenerateBuildWasmBootJson" DependsOnTargets="$(GenerateBuildWasmBootJsonDependsOn)">
     <PropertyGroup>
       <_WasmBuildBootJsonPath>$(IntermediateOutputPath)$(_WasmBootConfigFileName)</_WasmBuildBootJsonPath>
+      <_WasmBuildApplicationEnvironmentName>$(WasmApplicationEnvironmentName)</_WasmBuildApplicationEnvironmentName>
+      <_WasmBuildApplicationEnvironmentName Condition="'$(_WasmBuildApplicationEnvironmentName)' == ''">Development</_WasmBuildApplicationEnvironmentName>
     </PropertyGroup>
 
     <ItemGroup>
@@ -359,6 +361,7 @@ Copyright (c) .NET Foundation. All rights reserved.
 
     <GenerateWasmBootJson
       AssemblyPath="@(IntermediateAssembly)"
+      ApplicationEnvironment="$(_WasmBuildApplicationEnvironmentName)"
       Resources="@(WasmStaticWebAsset);@(_WasmJsModuleCandidatesForBuild)"
       Endpoints="@(_WasmResolvedEndpoints)"
       DebugBuild="true"
@@ -617,6 +620,9 @@ Copyright (c) .NET Foundation. All rights reserved.
   </Target>
 
   <Target Name="GeneratePublishWasmBootJson" DependsOnTargets="$(GeneratePublishWasmBootJsonDependsOn)">
+    <PropertyGroup>
+      <_WasmPublishApplicationEnvironmentName>$(WasmApplicationEnvironmentName)</_WasmPublishApplicationEnvironmentName>
+    </PropertyGroup>
     <ItemGroup>
       <_WasmPublishAsset
         Include="@(StaticWebAsset)"
@@ -649,6 +655,7 @@ Copyright (c) .NET Foundation. All rights reserved.
 
     <GenerateWasmBootJson
       AssemblyPath="@(IntermediateAssembly)"
+      ApplicationEnvironment="$(_WasmPublishApplicationEnvironmentName)"
       Resources="@(_WasmPublishAsset);@(_WasmJsModuleCandidatesForPublish)"
       Endpoints="@(_WasmResolvedEndpointsForPublish)"
       DebugBuild="false"

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

@@ -21,22 +21,49 @@ public AppSettingsTests(ITestOutputHelper output, SharedBuildPerTestClassFixture
     {
     }
 
+    public static IEnumerable<object?[]> LoadAppSettingsBasedOnApplicationEnvironmentData()
+    {
+        // Defaults
+        yield return new object?[] { false, null, null, "Development" };
+        yield return new object?[] { true, null, null, "Production" };
+
+        // Override defaults from MSBuild
+        yield return new object?[] { false, "Production", null, "Production" };
+        yield return new object?[] { true, "Development", null, "Development" };
+
+        // Override defaults from JavaScript
+        yield return new object?[] { false, null, "Production", "Production" };
+        yield return new object?[] { true, null, "Development", "Development" };
+
+        // Override MSBuild from JavaScript
+        yield return new object?[] { false, "FromMSBuild", "Production", "Production" };
+        yield return new object?[] { true, "FromMSBuild", "Development", "Development" };
+    }
+
     [Theory]
-    [InlineData("Development")]
-    [InlineData("Production")]
-    public async Task LoadAppSettingsBasedOnApplicationEnvironment(string applicationEnvironment)
+    [MemberData(nameof(LoadAppSettingsBasedOnApplicationEnvironmentData))]
+    public async Task LoadAppSettingsBasedOnApplicationEnvironment(bool publish, string? msBuildApplicationEnvironment, string? queryApplicationEnvironment, string expectedApplicationEnvironment)
     {
         Configuration config = Configuration.Debug;
         ProjectInfo info = CopyTestAsset(config, aot: false, TestAsset.WasmBasicTestApp, "AppSettingsTest");
-        PublishProject(info, config);
-        BrowserRunOptions options = new(
+        string extraMSBuildArgs = msBuildApplicationEnvironment != null ? $"-p:WasmApplicationEnvironmentName={msBuildApplicationEnvironment}" : string.Empty;
+
+        if (publish)
+            PublishProject(info, config, new PublishOptions(ExtraMSBuildArgs: extraMSBuildArgs));
+        else
+            BuildProject(info, config, new BuildOptions(ExtraMSBuildArgs: extraMSBuildArgs));
+        
+        BrowserRunOptions runOptions = new(
             config,
             TestScenario: "AppSettingsTest",
-            BrowserQueryString: new NameValueCollection { { "applicationEnvironment", applicationEnvironment } }
+            BrowserQueryString: new NameValueCollection { { "applicationEnvironment", queryApplicationEnvironment } }
         );
-        RunResult result = await RunForPublishWithWebServer(options);
+        RunResult result = publish
+            ? await RunForPublishWithWebServer(runOptions)
+            : await RunForBuildWithDotnetRun(runOptions);
+
         Assert.Contains(result.TestOutput, m => m.Contains("'/appsettings.json' exists 'True'"));
-        Assert.Contains(result.TestOutput, m => m.Contains($"'/appsettings.Development.json' exists '{applicationEnvironment == "Development"}'"));
-        Assert.Contains(result.TestOutput, m => m.Contains($"'/appsettings.Production.json' exists '{applicationEnvironment == "Production"}'"));
+        Assert.Contains(result.TestOutput, m => m.Contains($"'/appsettings.Development.json' exists '{expectedApplicationEnvironment == "Development"}'"));
+        Assert.Contains(result.TestOutput, m => m.Contains($"'/appsettings.Production.json' exists '{expectedApplicationEnvironment == "Production"}'"));
     }
 }

src/mono/wasm/Wasm.Build.Tests/Templates/WasmTemplateTestsBase.cs

@@ -60,7 +60,7 @@ public ProjectInfo CreateWasmTemplateProject(
         Configuration config,
         bool aot,
         string idPrefix = "wbt",
-        bool appendUnicodeToPath = true,
+        bool? appendUnicodeToPath = null,
         string extraArgs = "",
         bool runAnalyzers = true,
         bool addFrameworkArg = false,
@@ -69,7 +69,7 @@ public ProjectInfo CreateWasmTemplateProject(
         string insertAtEnd = "")
     {
         (string projectName, string logPath, string nugetDir) =
-            InitProjectLocation(idPrefix, config, aot, appendUnicodeToPath);
+            InitProjectLocation(idPrefix, config, aot, appendUnicodeToPath ?? s_buildEnv.IsRunningOnCI);
 
         if (addFrameworkArg)
             extraArgs += $" -f {DefaultTargetFramework}";
@@ -107,14 +107,14 @@ protected ProjectInfo CopyTestAsset(
         bool aot,
         TestAsset asset,
         string idPrefix,
-        bool appendUnicodeToPath = true,
+        bool? appendUnicodeToPath = null,
         bool runAnalyzers = true,
         string extraProperties = "",
         string extraItems = "",
         string insertAtEnd = "")
     {
         (string projectName, string logPath, string nugetDir) =
-            InitProjectLocation(idPrefix, config, aot, appendUnicodeToPath, avoidAotLongPathIssue: s_isWindows && aot);
+            InitProjectLocation(idPrefix, config, aot, appendUnicodeToPath ?? s_buildEnv.IsRunningOnCI, avoidAotLongPathIssue: s_isWindows && aot);
         Utils.DirectoryCopy(Path.Combine(BuildEnvironment.TestAssetsPath, asset.Name), Path.Combine(_projectDir));
         if (!string.IsNullOrEmpty(asset.RunnableProjectSubPath))
         {

src/mono/wasm/testassets/WasmBasicTestApp/App/wwwroot/main.js

@@ -44,7 +44,10 @@ switch (testCase) {
         }
         break;
     case "AppSettingsTest":
-        dotnet.withApplicationEnvironment(params.get("applicationEnvironment"));
+        const applicationEnvironment = params.get("applicationEnvironment");
+        if (applicationEnvironment) {
+            dotnet.withApplicationEnvironment(applicationEnvironment);
+        }
         break;
     case "LazyLoadingTest":
         dotnet.withDiagnosticTracing(true);

src/mono/wasm/testassets/WasmBasicTestApp/App/wwwroot/README.md renamed to src/mono/wasm/testassets/WasmBasicTestApp/README.md

@@ -8,7 +8,7 @@ It typically suits scenario where you need more than a plain template app. If th
 The app reads `test` query parameter and uses it to switch between test cases. Entrypoint is `main.js`.
 There is common unit, then switch based on test case for modifying app startup, then app starts and executes next switch based on test case for actually running code.
 
-Some test cases passes additional parameters to differentiate behavior, see `src/mono/wasm/Wasm.Build.Tests/TestAppScenarios`.
+Some test cases passes additional parameters to differentiate behavior, see `src/mono/wasm/Wasm.Build.Tests`.
 
 ### Running out side of WBT
 

src/tasks/Microsoft.NET.Sdk.WebAssembly.Pack.Tasks/BootJsonData.cs

@@ -24,6 +24,9 @@ public class BootJsonData
 
     public string mainAssemblyName { get; set; }
 
+    [DataMember(EmitDefaultValue = false)]
+    public string applicationEnvironment { get; set; }
+
     /// <summary>
     /// Gets the set of resources needed to boot the application. This includes the transitive
     /// closure of .NET assemblies (including the entrypoint assembly), the dotnet.wasm file,

src/tasks/Microsoft.NET.Sdk.WebAssembly.Pack.Tasks/GenerateWasmBootJson.cs

@@ -84,6 +84,8 @@ public class GenerateWasmBootJson : Task
 
     public bool FingerprintAssets { get; set; }
 
+    public string ApplicationEnvironment { get; set; }
+
     public override bool Execute()
     {
         var entryAssemblyName = AssemblyName.GetAssemblyName(AssemblyPath).Name;
@@ -107,9 +109,14 @@ private void WriteBootConfig(string entryAssemblyName)
         var result = new BootJsonData
         {
             resources = new ResourcesData(),
-            startupMemoryCache = helper.ParseOptionalBool(StartupMemoryCache),
+            startupMemoryCache = helper.ParseOptionalBool(StartupMemoryCache)
         };
 
+        if (IsTargeting100OrLater())
+        {
+            result.applicationEnvironment = ApplicationEnvironment;
+        }
+
         if (IsTargeting80OrLater())
         {
             result.mainAssemblyName = entryAssemblyName;
@@ -489,13 +496,17 @@ private static bool TryGetLazyLoadedAssembly(Dictionary<string, ITaskItem> lazyL
     private Version? parsedTargetFrameworkVersion;
     private static readonly Version version80 = new Version(8, 0);
     private static readonly Version version90 = new Version(9, 0);
+    private static readonly Version version100 = new Version(10, 0);
 
     private bool IsTargeting80OrLater()
         => IsTargetingVersionOrLater(version80);
 
     private bool IsTargeting90OrLater()
         => IsTargetingVersionOrLater(version90);
 
+    private bool IsTargeting100OrLater()
+        => IsTargetingVersionOrLater(version100);
+
     private bool IsTargetingVersionOrLater(Version version)
     {
         if (parsedTargetFrameworkVersion == null)