Blazor Web template updates (#49801)

Author: SteveSandersonMS

src/Components/Components/src/Routing/Router.cs

@@ -7,6 +7,7 @@
 using System.Reflection.Metadata;
 using System.Runtime.ExceptionServices;
 using Microsoft.AspNetCore.Components.HotReload;
+using Microsoft.AspNetCore.Components.Rendering;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -67,7 +68,6 @@ static readonly IReadOnlyDictionary<string, object> _emptyParametersDictionary
     /// Gets or sets the content to display when no match is found for the requested route.
     /// </summary>
     [Parameter]
-    [EditorRequired]
     public RenderFragment NotFound { get; set; }
 
     /// <summary>
@@ -130,13 +130,6 @@ public async Task SetParametersAsync(ParameterView parameters)
             throw new InvalidOperationException($"The {nameof(Router)} component requires a value for the parameter {nameof(Found)}.");
         }
 
-        // NotFound content is mandatory, because even though we could display a default message like "Not found",
-        // it has to be specified explicitly so that it can also be wrapped in a specific layout
-        if (NotFound == null)
-        {
-            throw new InvalidOperationException($"The {nameof(Router)} component requires a value for the parameter {nameof(NotFound)}.");
-        }
-
         if (!_onNavigateCalled)
         {
             _onNavigateCalled = true;
@@ -255,7 +248,7 @@ internal virtual void Refresh(bool isNavigationIntercepted)
                 // We did not find a Component that matches the route.
                 // Only show the NotFound content if the application developer programatically got us here i.e we did not
                 // intercept the navigation. In all other cases, force a browser navigation since this could be non-Blazor content.
-                _renderHandle.Render(NotFound);
+                _renderHandle.Render(NotFound ?? DefaultNotFoundContent);
             }
             else
             {
@@ -265,6 +258,17 @@ internal virtual void Refresh(bool isNavigationIntercepted)
         }
     }
 
+    private static void DefaultNotFoundContent(RenderTreeBuilder builder)
+    {
+        // This output can't use any layout (none is specified), and it can't use any web-specific concepts
+        // such as <p role="alert">, and we can't localize the output. However none of that matters because
+        // in all cases we expect either:
+        // 1. The app to be hosted with MapRazorPages, and then it will never use any NotFound content
+        // 2. Or, the app to supply its own NotFound content
+        // ... so this is just a fallback for badly-set-up apps.
+        builder.AddContent(0, "Not found");
+    }
+
     internal async ValueTask RunOnNavigateAsync(string path, bool isNavigationIntercepted)
     {
         // Cancel the CTS instead of disposing it, since disposing does not

src/Components/Components/test/Routing/RouterTest.cs

@@ -182,7 +182,7 @@ public async Task UsesCurrentRouteMatchingIfSpecified()
         // Arrange
         // Current routing prefers exactly-matched patterns over {*someWildcard}, no matter
         // how many segments are in the exact match
-        _navigationManager.NotifyLocationChanged("https://www.example.com/subdir/a/b", false);
+        _navigationManager.NotifyLocationChanged("https://www.example.com/subdir/a/b/c", false);
         var parameters = new Dictionary<string, object>
             {
                 { nameof(Router.AppAssembly), typeof(RouterTest).Assembly },
@@ -224,6 +224,47 @@ await _renderer.Dispatcher.InvokeAsync(() =>
         Assert.Equal(1, refreshCalled);
     }
 
+    [Fact]
+    public async Task UsesNotFoundContentIfSpecified()
+    {
+        // Arrange
+        _navigationManager.NotifyLocationChanged("https://www.example.com/subdir/nonexistent", false);
+        var parameters = new Dictionary<string, object>
+        {
+            { nameof(Router.AppAssembly), typeof(RouterTest).Assembly },
+            { nameof(Router.NotFound), (RenderFragment)(builder => builder.AddContent(0, "Custom content")) },
+        };
+
+        // Act
+        await _renderer.Dispatcher.InvokeAsync(() =>
+            _router.SetParametersAsync(ParameterView.FromDictionary(parameters)));
+
+        // Assert
+        var renderedFrame = _renderer.Batches.First().ReferenceFrames.First();
+        Assert.Equal(RenderTreeFrameType.Text, renderedFrame.FrameType);
+        Assert.Equal("Custom content", renderedFrame.TextContent);
+    }
+
+    [Fact]
+    public async Task UsesDefaultNotFoundContentIfNotSpecified()
+    {
+        // Arrange
+        _navigationManager.NotifyLocationChanged("https://www.example.com/subdir/nonexistent", false);
+        var parameters = new Dictionary<string, object>
+        {
+            { nameof(Router.AppAssembly), typeof(RouterTest).Assembly }
+        };
+
+        // Act
+        await _renderer.Dispatcher.InvokeAsync(() =>
+            _router.SetParametersAsync(ParameterView.FromDictionary(parameters)));
+
+        // Assert
+        var renderedFrame = _renderer.Batches.First().ReferenceFrames.First();
+        Assert.Equal(RenderTreeFrameType.Text, renderedFrame.FrameType);
+        Assert.Equal("Not found", renderedFrame.TextContent);
+    }
+
     internal class TestNavigationManager : NavigationManager
     {
         public TestNavigationManager() =>
@@ -260,9 +301,9 @@ public class FebComponent : ComponentBase { }
     [Route("jan")]
     public class JanComponent : ComponentBase { }
 
-    [Route("{*matchAnything}")]
+    [Route("a/{*matchAnything}")]
     public class MatchAnythingComponent : ComponentBase { }
 
-    [Route("a/b")]
+    [Route("a/b/c")]
     public class MultiSegmentRouteComponent : ComponentBase { }
 }

src/ProjectTemplates/Web.ProjectTemplates/BlazorWeb-CSharp.Client.csproj.in

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk.BlazorWebAssembly">
+
+  <PropertyGroup>
+    <TargetFramework>${DefaultNetCoreTargetFramework}</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <NoDefaultLaunchSettingsFile>true</NoDefaultLaunchSettingsFile>
+    <StaticWebAssetProjectMode>Default</StaticWebAssetProjectMode>
+    <RootNamespace Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">BlazorWeb-CSharp.Client</RootNamespace>
+    <AssemblyName Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">`$(AssemblyName.Replace(' ', '_'))</AssemblyName>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" Version="${MicrosoftAspNetCoreComponentsWebAssemblyVersion}" />
+  </ItemGroup>
+
+</Project>

src/ProjectTemplates/Web.ProjectTemplates/BlazorWeb-CSharp.csproj.in

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>${DefaultNetCoreTargetFramework}</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <NoDefaultLaunchSettingsFile Condition="'$(ExcludeLaunchSettings)' == 'True'">True</NoDefaultLaunchSettingsFile>
+    <RootNamespace Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">BlazorWeb-CSharp</RootNamespace>
+    <AssemblyName Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">`$(AssemblyName.Replace(' ', '_'))</AssemblyName>
+  </PropertyGroup>
+  <!--#if UseWebAssembly -->
+
+  <ItemGroup>
+    <ProjectReference Include="..\BlazorWeb-CSharp.Client\BlazorWeb-CSharp.Client.csproj" />
+    <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.Server" Version="${MicrosoftAspNetCoreComponentsWebAssemblyServerVersion}" />
+  </ItemGroup>
+  <!--#endif -->
+
+</Project>

src/ProjectTemplates/Web.ProjectTemplates/Components-CSharp.csproj.in

@@ -62,7 +62,8 @@
     <GeneratedContent Include="WebApi-FSharp.fsproj.in" OutputPath="content/WebApi-FSharp/Company.WebApplication1.fsproj" />
     <GeneratedContent Include="Worker-CSharp.csproj.in" OutputPath="content/Worker-CSharp/Company.Application1.csproj" />
     <GeneratedContent Include="Worker-FSharp.fsproj.in" OutputPath="content/Worker-FSharp/Company.Application1.fsproj" />
-    <GeneratedContent Include="Components-CSharp.csproj.in" OutputPath="content/Components-CSharp/Components-CSharp.csproj" />
+    <GeneratedContent Include="BlazorWeb-CSharp.csproj.in" OutputPath="content/BlazorWeb-CSharp/BlazorWeb-CSharp/BlazorWeb-CSharp.csproj" />
+    <GeneratedContent Include="BlazorWeb-CSharp.Client.csproj.in" OutputPath="content/BlazorWeb-CSharp/BlazorWeb-CSharp.Client/BlazorWeb-CSharp.Client.csproj" />
     <GeneratedContent Include="ComponentsWebAssembly-CSharp.csproj.in" OutputPath="content/ComponentsWebAssembly-CSharp/ComponentsWebAssembly-CSharp.csproj" />
     <GeneratedContent Include="EmptyComponentsWebAssembly-CSharp.csproj.in" OutputPath="content/EmptyComponentsWebAssembly-CSharp/EmptyComponentsWebAssembly-CSharp.csproj" />
   </ItemGroup>

src/ProjectTemplates/Web.ProjectTemplates/Microsoft.DotNet.Web.ProjectTemplates.csproj

@@ -5,15 +5,16 @@
       "longName": "no-restore",
       "shortName": ""
     },
-    "PWA": {
-      "longName": "pwa",
-      "isHidden": true
-    },
     "UseServer": {
       "longName": "use-server"
     },
     "UseWebAssembly": {
-      "longName": "use-wasm",
+      "longName": "use-wasm"
+    },
+    "Empty": {
+      "longName": "empty"
+    },
+    "IncludeSampleContent": {
       "isHidden": true
     },
     "Framework": {

src/ProjectTemplates/Web.ProjectTemplates/content/Components-CSharp/.template.config/dotnetcli.host.json renamed to src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/.template.config/dotnetcli.host.json

@@ -11,16 +11,17 @@
     },
     {
       "id": "UseWebAssembly",
-      "isVisible": false,
+      "isVisible": true,
       "persistenceScope": "templateGroup"
     },
     {
-      "id": "PWA",
-      "isVisible": false,
-      "persistenceScope": "templateGroup"
+      "id": "UseProgramMain",
+      "isVisible": true,
+      "persistenceScope": "shared",
+      "persistenceScopeName": "Microsoft"
     },
     {
-      "id": "UseProgramMain",
+      "id": "IncludeSampleContent",
       "isVisible": true,
       "persistenceScope": "shared",
       "persistenceScopeName": "Microsoft"

src/ProjectTemplates/Web.ProjectTemplates/content/Components-CSharp/.template.config/icon.png renamed to src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/.template.config/icon.png

@@ -14,8 +14,9 @@
   "symbols/UseWebAssembly/description": "Pokud je zadáno, nakonfiguruje projekt tak, aby vykreslovat komponenty interaktivně v prohlížeči pomocí WebAssembly.",
   "symbols/UseServer/displayName": "_Použít interaktivní serverové komponenty",
   "symbols/UseServer/description": "Pokud je zadáno, nakonfiguruje projekt tak, aby vykresloval komponenty interaktivně na serveru.",
-  "symbols/PWA/displayName": "_Progresivní webová aplikace",
-  "symbols/PWA/description": "Pokud je tato možnost zadaná, vytvoří progresivní webovou aplikaci (PWA), která podporuje instalaci a offline použití.",
+  "symbols/IncludeSampleContent/displayName": "_Include sample pages",
+  "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and styling to demonstrate basic usage patterns.",
+  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/NoHttps/description": "Určuje, jestli se má protokol HTTPS vypnout. Tato možnost platí jenom v případě, že se pro --auth nepoužívají Individual, IndividualB2C, SingleOrg ani MultiOrg.",
   "symbols/UseProgramMain/displayName": "Nepoužívat _příkazy nejvyšší úrovně",
   "symbols/UseProgramMain/description": "Určuje, jestli se má místo příkazů nejvyšší úrovně generovat explicitní třída Program a metoda Main.",

src/ProjectTemplates/Web.ProjectTemplates/content/Components-CSharp/.template.config/ide.host.json renamed to src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/.template.config/ide.host.json

@@ -14,8 +14,9 @@
   "symbols/UseWebAssembly/description": "Bei Angabe dieser Option wird das Projekt so konfiguriert, dass Komponenten interaktiv mithilfe von WebAssembly im Browser gerendert werden.",
   "symbols/UseServer/displayName": "_Interaktive Serverkomponenten verwenden",
   "symbols/UseServer/description": "Bei Angabe dieser Option wird das Projekt so konfiguriert, dass Komponenten interaktiv auf dem Server gerendert werden.",
-  "symbols/PWA/displayName": "_Progressive Webanwendung",
-  "symbols/PWA/description": "Wenn angegeben, wird eine Progressive Web Application (PWA) erstellt, die die Installation und Offlineverwendung unterstützt.",
+  "symbols/IncludeSampleContent/displayName": "_Include sample pages",
+  "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and styling to demonstrate basic usage patterns.",
+  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/NoHttps/description": "Ob HTTPS deaktiviert werden soll. Diese Option gilt nur, wenn Individual, IndividualB2C, SingleOrg oder MultiOrg nicht für --auth verwendet werden.",
   "symbols/UseProgramMain/displayName": "Keine Anweisungen_der obersten Ebene verwenden",
   "symbols/UseProgramMain/description": "Gibt an, ob anstelle von Anweisungen der obersten Ebene eine explizite Programmklasse und eine Main-Methode generiert werden soll.",

src/ProjectTemplates/Web.ProjectTemplates/content/Components-CSharp/.template.config/localize/templatestrings.cs.json renamed to src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/.template.config/localize/templatestrings.cs.json

@@ -11,11 +11,12 @@
   "symbols/iisHttpPort/description": "Port number to use for the IIS Express HTTP endpoint in launchSettings.json.",
   "symbols/iisHttpsPort/description": "Port number to use for the IIS Express HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
   "symbols/UseWebAssembly/displayName": "_Use interactive WebAssembly components",
-  "symbols/UseWebAssembly/description": "If specified, configures the project to render components interactively in the browser using WebAssembly.",
+  "symbols/UseWebAssembly/description": "Configures whether to support rendering components interactively in the browser using WebAssembly. The default value is false.",
   "symbols/UseServer/displayName": "_Use interactive server components",
-  "symbols/UseServer/description": "If specified, configures the project to render components interactively on the server.",
-  "symbols/PWA/displayName": "_Progressive Web Application",
-  "symbols/PWA/description": "If specified, produces a Progressive Web Application (PWA) supporting installation and offline use.",
+  "symbols/UseServer/description": "Configures whether to support rendering components interactively on the server via a SignalR WebSocket connection. The default value is true.",
+  "symbols/IncludeSampleContent/displayName": "_Include sample pages",
+  "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and styling to demonstrate basic usage patterns.",
+  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/NoHttps/description": "Whether to turn off HTTPS. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't used for --auth.",
   "symbols/UseProgramMain/displayName": "Do not use _top-level statements",
   "symbols/UseProgramMain/description": "Whether to generate an explicit Program class and Main method instead of top-level statements.",

src/ProjectTemplates/Web.ProjectTemplates/content/Components-CSharp/.template.config/localize/templatestrings.de.json renamed to src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/.template.config/localize/templatestrings.de.json

@@ -14,8 +14,9 @@
   "symbols/UseWebAssembly/description": "Si se especifica, esta opción configura el proyecto para representar los componentes de forma interactiva en el explorador mediante WebAssembly.",
   "symbols/UseServer/displayName": "_Use componentes de servidor interactivos",
   "symbols/UseServer/description": "Si se especifica, esta opción configura el proyecto para representar los componentes de forma interactiva en el servidor.",
-  "symbols/PWA/displayName": "_Aplicación web progresiva",
-  "symbols/PWA/description": "Si se especifica, produce una aplicación web progresiva (PWA) compatible con la instalación y el uso sin conexión.",
+  "symbols/IncludeSampleContent/displayName": "_Include sample pages",
+  "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and styling to demonstrate basic usage patterns.",
+  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/NoHttps/description": "Si se va a desactivar HTTPS. Esta opción solo se aplica si Individual, IndividualB2C, SingleOrg o MultiOrg no se usan para --auth.",
   "symbols/UseProgramMain/displayName": "No usar instrucciones de _nivel superior",
   "symbols/UseProgramMain/description": "Indica si se debe generar una clase Program explícita y un método Main en lugar de instrucciones de nivel superior.",

src/ProjectTemplates/Web.ProjectTemplates/content/Components-CSharp/.template.config/localize/templatestrings.en.json renamed to src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/.template.config/localize/templatestrings.en.json

@@ -14,8 +14,9 @@
   "symbols/UseWebAssembly/description": "S’il est spécifié, configure le projet pour afficher les composants de manière interactive dans le navigateur à l’aide de WebAssembly.",
   "symbols/UseServer/displayName": "_Utiliser les composants serveur interactifs",
   "symbols/UseServer/description": "Si ce paramètre est spécifié, configure le projet pour afficher les composants de manière interactive sur le serveur.",
-  "symbols/PWA/displayName": "_Application web progressive",
-  "symbols/PWA/description": "Si ce paramètre est spécifié, produit une application web progressive (PWA) qui prend en charge l’installation et l’utilisation hors connexion.",
+  "symbols/IncludeSampleContent/displayName": "_Include sample pages",
+  "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and styling to demonstrate basic usage patterns.",
+  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/NoHttps/description": "Indique s’il faut désactiver HTTPS. Cette option s’applique uniquement si Individual, IndividualB2C, SingleOrg ou MultiOrg ne sont pas utilisés pour --auth.",
   "symbols/UseProgramMain/displayName": "N’utilisez pas _d’instructions de niveau supérieur.",
   "symbols/UseProgramMain/description": "Indique s’il faut générer une classe Programme explicite et une méthode Main au lieu d’instructions de niveau supérieur.",