Change MapBlazorWebAssemblyApplication to UseBlazorFrameworkFiles (#19198)

javiercn · web-flow · commit 9ded8e17d44e · 2020-02-21T04:20:41.000-08:00
diff --git a/src/Components/WebAssembly/DevServer/src/Server/Startup.cs b/src/Components/WebAssembly/DevServer/src/Server/Startup.cs
@@ -46,13 +46,13 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment environment,
 
             app.UseBlazorDebugging();
 
+            app.UseBlazorFrameworkFiles();
             app.UseStaticFiles();
 
             app.UseRouting();
 
             app.UseEndpoints(endpoints =>
             {
-                endpoints.MapBlazorWebAssemblyApplication();
                 endpoints.MapFallbackToFile("index.html");
             });
         }
diff --git a/src/Components/WebAssembly/Server/src/ComponentsWebAssemblyApplicationBuilderExtensions.cs b/src/Components/WebAssembly/Server/src/ComponentsWebAssemblyApplicationBuilderExtensions.cs
@@ -0,0 +1,86 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Net.Mime;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.StaticFiles;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.FileProviders;
+using Microsoft.Net.Http.Headers;
+
+namespace Microsoft.AspNetCore.Builder
+{
+    /// <summary>
+    /// Extensions for mapping Blazor WebAssembly applications.
+    /// </summary>
+    public static class ComponentsWebAssemblyApplicationBuilderExtensions
+    {
+        /// <summary>
+        /// Configures the application to serve Blazor WebAssembly framework files from the path <paramref name="pathPrefix"/>. This path must correspond to a referenced Blazor WebAssembly application project.
+        /// </summary>
+        /// <param name="builder">The <see cref="IApplicationBuilder"/>.</param>
+        /// <param name="pathPrefix">The <see cref="PathString"/> that indicates the prefix for the Blazor WebAssembly application.</param>
+        /// <returns>The <see cref="IApplicationBuilder"/></returns>
+        public static IApplicationBuilder MapBlazorFrameworkFiles(this IApplicationBuilder builder, PathString pathPrefix)
+        {
+            if (builder is null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+
+            var webHostEnvironment = builder.ApplicationServices.GetRequiredService<IWebHostEnvironment>();
+
+            var options = CreateStaticFilesOptions(webHostEnvironment.WebRootFileProvider);
+
+            builder.MapWhen(ctx => ctx.Request.Path.StartsWithSegments(pathPrefix, out var rest) && rest.StartsWithSegments("/_framework") && !rest.StartsWithSegments("/_framework/blazor.server.js"),
+            subBuilder =>
+            {
+                subBuilder.Use(async (ctx, next) =>
+                {
+                    // At this point we mapped something from the /_framework
+                    ctx.Response.Headers.Append(HeaderNames.CacheControl, "no-cache");
+                    // This will invoke the static files middleware plugged-in below.
+                    await next();
+                });
+
+                subBuilder.UseStaticFiles(options);
+            });
+
+            return builder;
+        }
+
+        /// <summary>
+        /// Configures the application to serve Blazor WebAssembly framework files from the root path "/".
+        /// </summary>
+        /// <param name="applicationBuilder">The <see cref="IApplicationBuilder"/>.</param>
+        /// <param name="pathPrefix">The <see cref="PathString"/> that indicates the prefix for the Blazor WebAssembly application.</param>
+        /// <returns>The <see cref="IApplicationBuilder"/></returns>
+        public static IApplicationBuilder UseBlazorFrameworkFiles(this IApplicationBuilder applicationBuilder) =>
+            MapBlazorFrameworkFiles(applicationBuilder, default);
+
+        private static StaticFileOptions CreateStaticFilesOptions(IFileProvider webRootFileProvider)
+        {
+            var options = new StaticFileOptions();
+            options.FileProvider = webRootFileProvider;
+            var contentTypeProvider = new FileExtensionContentTypeProvider();
+            AddMapping(contentTypeProvider, ".dll", MediaTypeNames.Application.Octet);
+            // We unconditionally map pdbs as there will be no pdbs in the output folder for
+            // release builds unless BlazorEnableDebugging is explicitly set to true.
+            AddMapping(contentTypeProvider, ".pdb", MediaTypeNames.Application.Octet);
+
+            options.ContentTypeProvider = contentTypeProvider;
+
+            return options;
+        }
+
+        private static void AddMapping(FileExtensionContentTypeProvider provider, string name, string mimeType)
+        {
+            if (!provider.Mappings.ContainsKey(name))
+            {
+                provider.Mappings.Add(name, mimeType);
+            }
+        }
+    }
+}
diff --git a/src/Components/WebAssembly/Server/src/ComponentsWebAssemblyEndpointRouteBuilderExtensions.cs b/src/Components/WebAssembly/Server/src/ComponentsWebAssemblyEndpointRouteBuilderExtensions.cs
diff --git a/src/Components/WebAssembly/testassets/HostedInAspNet.Server/Startup.cs b/src/Components/WebAssembly/testassets/HostedInAspNet.Server/Startup.cs
@@ -33,11 +33,13 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, RequestL
                 app.UseBlazorDebugging();
             }
 
+            app.UseBlazorFrameworkFiles();
+            app.UseStaticFiles();
+
             app.UseRouting();
 
             app.UseEndpoints(endpoints =>
             {
-                endpoints.MapBlazorWebAssemblyApplication();
                 endpoints.MapFallbackToFile("index.html");
             });
         }
diff --git a/src/Components/WebAssembly/testassets/MonoSanity/Startup.cs b/src/Components/WebAssembly/testassets/MonoSanity/Startup.cs
@@ -16,11 +16,11 @@ public void Configure(IApplicationBuilder app)
         {
             app.UseDeveloperExceptionPage();
             app.UseFileServer(new FileServerOptions() { EnableDefaultFiles = true, });
+            app.UseBlazorFrameworkFiles();
             app.UseStaticFiles();
             app.UseRouting();
             app.UseEndpoints(endpoints =>
             {
-                endpoints.MapBlazorWebAssemblyApplication();
                 endpoints.MapFallbackToFile("index.html");
             });
         }
diff --git a/src/Components/WebAssembly/testassets/Wasm.Authentication.Server/Startup.cs b/src/Components/WebAssembly/testassets/Wasm.Authentication.Server/Startup.cs
@@ -56,6 +56,9 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                 app.UseBlazorDebugging();
             }
 
+            app.UseBlazorFrameworkFiles();
+            app.UseStaticFiles();
+
             app.UseRouting();
 
             app.UseAuthentication();
@@ -67,7 +70,6 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                 endpoints.MapControllers();
                 endpoints.MapRazorPages();
 
-                endpoints.MapBlazorWebAssemblyApplication();
                 endpoints.MapFallbackToFile("index.html");
             });
         }
diff --git a/src/Components/test/testassets/TestServer/AuthenticationStartup.cs b/src/Components/test/testassets/TestServer/AuthenticationStartup.cs
@@ -49,12 +49,12 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             // Mount the server-side Blazor app on /subdir
             app.Map("/subdir", app =>
             {
+                app.UseBlazorFrameworkFiles();
                 app.UseStaticFiles();
 
                 app.UseRouting();
                 app.UseEndpoints(endpoints =>
                 {
-                    endpoints.MapBlazorWebAssemblyApplication();
                     endpoints.MapControllers();
                     endpoints.MapRazorPages();
                     endpoints.MapBlazorHub();
diff --git a/src/Components/test/testassets/TestServer/ClientStartup.cs b/src/Components/test/testassets/TestServer/ClientStartup.cs
@@ -37,13 +37,12 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             app.Map("/subdir", app =>
             {
                 // Add it before to ensure it takes priority over files in wwwroot
+                app.UseBlazorFrameworkFiles();
                 app.UseStaticFiles();
 
                 app.UseRouting();
                 app.UseEndpoints(endpoints =>
                 {
-                    endpoints.MapBlazorWebAssemblyApplication();
-
                     endpoints.MapRazorPages();
                     endpoints.MapControllers();
                     endpoints.MapFallbackToFile("index.html");
diff --git a/src/Components/test/testassets/TestServer/CorsStartup.cs b/src/Components/test/testassets/TestServer/CorsStartup.cs
@@ -45,6 +45,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             // Mount the server-side Blazor app on /subdir
             app.Map("/subdir", app =>
             {
+                app.UseBlazorFrameworkFiles();
                 app.UseStaticFiles();
 
                 app.UseRouting();
@@ -53,8 +54,6 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 
                 app.UseEndpoints(endpoints =>
                 {
-                    endpoints.MapBlazorWebAssemblyApplication();
-
                     endpoints.MapControllers();
                     endpoints.MapFallbackToFile("index.html");
                 });
diff --git a/src/Components/test/testassets/TestServer/InternationalizationStartup.cs b/src/Components/test/testassets/TestServer/InternationalizationStartup.cs
@@ -36,6 +36,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             // Mount the server-side Blazor app on /subdir
             app.Map("/subdir", app =>
             {
+                app.UseBlazorFrameworkFiles();
                 app.UseStaticFiles();
 
                 app.UseRequestLocalization(options =>
@@ -54,8 +55,6 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                 app.UseRouting();
                 app.UseEndpoints(endpoints =>
                 {
-                    endpoints.MapBlazorWebAssemblyApplication();
-
                     endpoints.MapControllers();
                     endpoints.MapBlazorHub();
                     endpoints.MapFallbackToPage("/_ServerHost");
diff --git a/src/Components/test/testassets/TestServer/StartupWithMapFallbackToClientSideBlazor.cs b/src/Components/test/testassets/TestServer/StartupWithMapFallbackToClientSideBlazor.cs
@@ -33,12 +33,8 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             // The client-side files middleware needs to be here because the base href in hardcoded to /subdir/
             app.Map("/subdir", app =>
             {
-                app.UseRouting();
-
-                app.UseEndpoints(endpoints =>
-                {
-                    endpoints.MapBlazorWebAssemblyApplication();
-                });
+                app.UseBlazorFrameworkFiles();
+                app.UseStaticFiles();
             });
 
             // The calls to `Map` allow us to test each of these overloads, while keeping them isolated.
diff --git a/src/ProjectTemplates/ComponentsWebAssembly.ProjectTemplates/content/ComponentsWebAssembly-CSharp/Server/Startup.cs b/src/ProjectTemplates/ComponentsWebAssembly.ProjectTemplates/content/ComponentsWebAssembly-CSharp/Server/Startup.cs
@@ -104,6 +104,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             }
 
 #endif
+            app.UseBlazorFrameworkFiles();
             app.UseStaticFiles();
 
             app.UseRouting();
@@ -124,8 +125,6 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                 endpoints.MapRazorPages();
 #endif
                 endpoints.MapControllers();
-
-                endpoints.MapBlazorWebAssemblyApplication();
                 endpoints.MapFallbackToFile("index.html");
             });
         }

Original file line number	Diff line number	Diff line change
`@@ -46,13 +46,13 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment environment,`
`46`	`46`
`47`	`47`	`app.UseBlazorDebugging();`
`48`	`48`
	`49`	`+ app.UseBlazorFrameworkFiles();`
`49`	`50`	`app.UseStaticFiles();`
`50`	`51`
`51`	`52`	`app.UseRouting();`
`52`	`53`
`53`	`54`	`app.UseEndpoints(endpoints =>`
`54`	`55`	`{`
`55`		`- endpoints.MapBlazorWebAssemblyApplication();`
`56`	`56`	`endpoints.MapFallbackToFile("index.html");`
`57`	`57`	`});`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,11 +33,13 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, RequestL`
`33`	`33`	`app.UseBlazorDebugging();`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ app.UseBlazorFrameworkFiles();`
	`37`	`+ app.UseStaticFiles();`
	`38`	`+`
`36`	`39`	`app.UseRouting();`
`37`	`40`
`38`	`41`	`app.UseEndpoints(endpoints =>`
`39`	`42`	`{`
`40`		`- endpoints.MapBlazorWebAssemblyApplication();`
`41`	`43`	`endpoints.MapFallbackToFile("index.html");`
`42`	`44`	`});`
`43`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,11 +16,11 @@ public void Configure(IApplicationBuilder app)`
`16`	`16`	`{`
`17`	`17`	`app.UseDeveloperExceptionPage();`
`18`	`18`	`app.UseFileServer(new FileServerOptions() { EnableDefaultFiles = true, });`
	`19`	`+ app.UseBlazorFrameworkFiles();`
`19`	`20`	`app.UseStaticFiles();`
`20`	`21`	`app.UseRouting();`
`21`	`22`	`app.UseEndpoints(endpoints =>`
`22`	`23`	`{`
`23`		`- endpoints.MapBlazorWebAssemblyApplication();`
`24`	`24`	`endpoints.MapFallbackToFile("index.html");`
`25`	`25`	`});`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,9 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`56`	`56`	`app.UseBlazorDebugging();`
`57`	`57`	`}`
`58`	`58`
	`59`	`+ app.UseBlazorFrameworkFiles();`
	`60`	`+ app.UseStaticFiles();`
	`61`	`+`
`59`	`62`	`app.UseRouting();`
`60`	`63`
`61`	`64`	`app.UseAuthentication();`
`@@ -67,7 +70,6 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`67`	`70`	`endpoints.MapControllers();`
`68`	`71`	`endpoints.MapRazorPages();`
`69`	`72`
`70`		`- endpoints.MapBlazorWebAssemblyApplication();`
`71`	`73`	`endpoints.MapFallbackToFile("index.html");`
`72`	`74`	`});`
`73`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,12 +49,12 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`49`	`49`	`// Mount the server-side Blazor app on /subdir`
`50`	`50`	`app.Map("/subdir", app =>`
`51`	`51`	`{`
	`52`	`+ app.UseBlazorFrameworkFiles();`
`52`	`53`	`app.UseStaticFiles();`
`53`	`54`
`54`	`55`	`app.UseRouting();`
`55`	`56`	`app.UseEndpoints(endpoints =>`
`56`	`57`	`{`
`57`		`- endpoints.MapBlazorWebAssemblyApplication();`
`58`	`58`	`endpoints.MapControllers();`
`59`	`59`	`endpoints.MapRazorPages();`
`60`	`60`	`endpoints.MapBlazorHub();`
Original file line number	Diff line number	Diff line change
`@@ -37,13 +37,12 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`37`	`37`	`app.Map("/subdir", app =>`
`38`	`38`	`{`
`39`	`39`	`// Add it before to ensure it takes priority over files in wwwroot`
	`40`	`+ app.UseBlazorFrameworkFiles();`
`40`	`41`	`app.UseStaticFiles();`
`41`	`42`
`42`	`43`	`app.UseRouting();`
`43`	`44`	`app.UseEndpoints(endpoints =>`
`44`	`45`	`{`
`45`		`- endpoints.MapBlazorWebAssemblyApplication();`
`46`		`-`
`47`	`46`	`endpoints.MapRazorPages();`
`48`	`47`	`endpoints.MapControllers();`
`49`	`48`	`endpoints.MapFallbackToFile("index.html");`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`45`	`45`	`// Mount the server-side Blazor app on /subdir`
`46`	`46`	`app.Map("/subdir", app =>`
`47`	`47`	`{`
	`48`	`+ app.UseBlazorFrameworkFiles();`
`48`	`49`	`app.UseStaticFiles();`
`49`	`50`
`50`	`51`	`app.UseRouting();`
`@@ -53,8 +54,6 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`53`	`54`
`54`	`55`	`app.UseEndpoints(endpoints =>`
`55`	`56`	`{`
`56`		`- endpoints.MapBlazorWebAssemblyApplication();`
`57`		`-`
`58`	`57`	`endpoints.MapControllers();`
`59`	`58`	`endpoints.MapFallbackToFile("index.html");`
`60`	`59`	`});`
Original file line number	Diff line number	Diff line change
`@@ -104,6 +104,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`#endif`
	`107`	`+ app.UseBlazorFrameworkFiles();`
`107`	`108`	`app.UseStaticFiles();`
`108`	`109`
`109`	`110`	`app.UseRouting();`
`@@ -124,8 +125,6 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`124`	`125`	`endpoints.MapRazorPages();`
`125`	`126`	`#endif`
`126`	`127`	`endpoints.MapControllers();`
`127`		`-`
`128`		`- endpoints.MapBlazorWebAssemblyApplication();`
`129`	`128`	`endpoints.MapFallbackToFile("index.html");`
`130`	`129`	`});`
`131`	`130`	`}`