huahaofeng
/
aspnetcore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Make Razor Components apps not use Blazor build (#6562) 

* Replace UseServerSideBlazor with UseRazorComponents, which doesn't require Blazor build artifacts

* Make UseRazorComponents serve blazor.server.js from embedded resource

... so we don't need a build step to put it on disk somewhere.

* Fix TestServer

* Update ComponentsApp not to use Blazor build targets

* Update ComponentsApp.App sample to use new build package

* Update string constant in test

* Rename blazor.*.js to components.*.js

* Ensure correct build order

* Update nav menu title in Components sample app

* Fix remaining paths

* Switch ComponentsApp.App to use Sdk="Microsoft.NET.Sdk.Razor"

* Update mono.cecil version

* CR: Replace FrameworkFilesProvider with EmbeddedFileProvider

* CR: Use ManifestEmbeddedFileProvider
This commit is contained in:
Steve Sanderson 2019-01-11 16:14:11 +00:00 committed by GitHub
parent 3cd5054eb5
commit 70cdf11f76
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
41 changed files with 185 additions and 174 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Components/blazor/benchmarks/Microsoft.AspNetCore.Blazor.E2EPerformance/wwwroot/blazor-frame.html
View File

@ -19,6 +19,6 @@
</script> </script>
<app>Loading...</app> <app>Loading...</app>
<script src="_framework/blazor.webassembly.js"></script> <script src="_framework/components.webassembly.js"></script>
</body> </body>
</html> </html>

2
src/Components/blazor/samples/HostedInAspNet.Client/wwwroot/index.html
View File

@ -7,6 +7,6 @@
<body> <body>
<app>Loading...</app> <app>Loading...</app>
<script src="customJsFileForTests.js"></script> <script src="customJsFileForTests.js"></script>
<script src="_framework/blazor.webassembly.js"></script> <script src="_framework/components.webassembly.js"></script>
</body> </body>
</html> </html>

2
src/Components/blazor/samples/StandaloneApp/wwwroot/index.html
View File

@ -11,6 +11,6 @@
<body> <body>
<app>Loading...</app> <app>Loading...</app>
<script src="_framework/blazor.webassembly.js"></script> <script src="_framework/components.webassembly.js"></script>
</body> </body>
</html> </html>

6
src/Components/blazor/src/Microsoft.AspNetCore.Blazor.Build/Microsoft.AspNetCore.Blazor.Build.csproj
View File

@ -43,8 +43,8 @@
<ExcludePackageFileFromSigning Include="System.Text.Encoding.CodePages.dll" /> <ExcludePackageFileFromSigning Include="System.Text.Encoding.CodePages.dll" />
<!-- JS files --> <!-- JS files -->
<ExcludePackageFileFromSigning Include="blazor.server.js" /> <ExcludePackageFileFromSigning Include="components.server.js" />
<ExcludePackageFileFromSigning Include="blazor.webassembly.js" /> <ExcludePackageFileFromSigning Include="components.webassembly.js" />
</ItemGroup> </ItemGroup>
<!-- Executes /t:Publish for all target frameworks before packing--> <!-- Executes /t:Publish for all target frameworks before packing-->
@ -72,7 +72,7 @@
<PackageReference Include="Microsoft.Extensions.CommandLineUtils" Version="1.1.1" /> <PackageReference Include="Microsoft.Extensions.CommandLineUtils" Version="1.1.1" />
<PackageReference Include="Microsoft.Extensions.FileProviders.Composite" Version="$(AspNetCorePackageVersion)" /> <PackageReference Include="Microsoft.Extensions.FileProviders.Composite" Version="$(AspNetCorePackageVersion)" />
<PackageReference Include="Microsoft.Extensions.FileProviders.Physical" Version="$(AspNetCorePackageVersion)" /> <PackageReference Include="Microsoft.Extensions.FileProviders.Physical" Version="$(AspNetCorePackageVersion)" />
<PackageReference Include="Mono.Cecil" Version="0.10.0-beta7" /> <PackageReference Include="Mono.Cecil" Version="$(MonoCecilPackageVersion)" />
<PackageReference Include="System.CodeDom" Version="4.4.0" /> <PackageReference Include="System.CodeDom" Version="4.4.0" />
</ItemGroup> </ItemGroup>
</Project> </Project>

2
src/Components/blazor/src/Microsoft.AspNetCore.Blazor.Build/Microsoft.AspNetCore.Blazor.Build.nuspec
View File

@ -22,6 +22,6 @@
<file src="build\**" target="build" /> <file src="build\**" target="build" />
<file src="targets\**" target="targets" /> <file src="targets\**" target="targets" />
<file src="$publishdir$netcoreapp3.0\**\*" target="tools/" /> <file src="$publishdir$netcoreapp3.0\**\*" target="tools/" />
<file src="..\..\..\src\Microsoft.AspNetCore.Components.Browser.JS\dist\blazor.*.js" target="tools/blazor" /> <file src="..\..\..\src\Microsoft.AspNetCore.Components.Browser.JS\dist\components.*.js" target="tools/blazor" />
</files> </files>
</package> </package>

2
src/Components/blazor/src/Microsoft.AspNetCore.Blazor.Build/ReferenceFromSource.props
View File

@ -13,7 +13,7 @@
<PropertyGroup> <PropertyGroup>
<BlazorBuildReferenceFromSource>true</BlazorBuildReferenceFromSource> <BlazorBuildReferenceFromSource>true</BlazorBuildReferenceFromSource>
<BlazorJsPath>$(MSBuildThisFileDirectory)../../../src/Microsoft.AspNetCore.Components.Browser.JS/dist/blazor.*.js</BlazorJsPath> <BlazorJsPath>$(MSBuildThisFileDirectory)../../../src/Microsoft.AspNetCore.Components.Browser.JS/dist/components.*.js</BlazorJsPath>
</PropertyGroup> </PropertyGroup>
<Import Project="$(MSBuildThisFileDirectory)targets/All.props" /> <Import Project="$(MSBuildThisFileDirectory)targets/All.props" />

2
src/Components/blazor/src/Microsoft.AspNetCore.Blazor.Build/targets/Blazor.MonoRuntime.props
View File

@ -1,7 +1,7 @@
<Project> <Project>
<PropertyGroup Condition="'$(BlazorBuildReferenceFromSource)'==''"> <PropertyGroup Condition="'$(BlazorBuildReferenceFromSource)'==''">
<BlazorJsPath>$(MSBuildThisFileDirectory)../tools/blazor/blazor.*.js</BlazorJsPath> <BlazorJsPath>$(MSBuildThisFileDirectory)../tools/blazor/components.*.js</BlazorJsPath>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Label="Blazor build outputs"> <PropertyGroup Label="Blazor build outputs">

2
src/Components/blazor/src/Microsoft.AspNetCore.Blazor.Server/Microsoft.AspNetCore.Blazor.Server.csproj
View File

@ -13,7 +13,7 @@
<PackageReference Include="Newtonsoft.Json" Version="$(NewtonsoftJsonPackageVersion)" /> <PackageReference Include="Newtonsoft.Json" Version="$(NewtonsoftJsonPackageVersion)" />
<!-- Used by ws-proxy sources only. Remove this once we're able to consume ws-proxy as a NuGet package. --> <!-- Used by ws-proxy sources only. Remove this once we're able to consume ws-proxy as a NuGet package. -->
<PackageReference Include="Mono.Cecil" Version="0.10.0-beta7" /> <PackageReference Include="Mono.Cecil" Version="$(MonoCecilPackageVersion)" />
</ItemGroup> </ItemGroup>
</Project> </Project>

2
src/Components/blazor/src/Microsoft.AspNetCore.Blazor.Templates/content/BlazorHosted-CSharp/BlazorHosted-CSharp.Client/wwwroot/index.html
View File

@ -11,6 +11,6 @@
<body> <body>
<app>Loading...</app> <app>Loading...</app>
<script src="_framework/blazor.webassembly.js"></script> <script src="_framework/components.webassembly.js"></script>
</body> </body>
</html> </html>

2
src/Components/blazor/src/Microsoft.AspNetCore.Blazor.Templates/content/BlazorStandalone-CSharp/wwwroot/index.html
View File

@ -11,6 +11,6 @@
<body> <body>
<app>Loading...</app> <app>Loading...</app>
<script src="_framework/blazor.webassembly.js"></script> <script src="_framework/components.webassembly.js"></script>
</body> </body>
</html> </html>

1
src/Components/blazor/test/Microsoft.AspNetCore.Blazor.Build.Test/Microsoft.AspNetCore.Blazor.Build.Test.csproj
View File

@ -26,7 +26,6 @@
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.5.0" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.5.0" />
<PackageReference Include="xunit" Version="2.3.1" /> <PackageReference Include="xunit" Version="2.3.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.3.1" /> <PackageReference Include="xunit.runner.visualstudio" Version="2.3.1" />
<PackageReference Include="Mono.Cecil" Version="0.10.0-beta7" />
<PackageReference Include="Microsoft.AspNetCore.Blazor.Mono" Version="$(MicrosoftAspNetCoreBlazorMonoPackageVersion)" /> <PackageReference Include="Microsoft.AspNetCore.Blazor.Mono" Version="$(MicrosoftAspNetCoreBlazorMonoPackageVersion)" />
<PackageReference Include="Microsoft.AspNetCore.Mvc.Razor.Extensions" Version="$(MicrosoftNETSdkRazorPackageVersion)" /> <PackageReference Include="Microsoft.AspNetCore.Mvc.Razor.Extensions" Version="$(MicrosoftNETSdkRazorPackageVersion)" />
<PackageReference Include="Microsoft.AspNetCore.Razor.Language" Version="$(MicrosoftNETSdkRazorPackageVersion)" /> <PackageReference Include="Microsoft.AspNetCore.Razor.Language" Version="$(MicrosoftNETSdkRazorPackageVersion)" />

1
src/Components/build/dependencies.props
View File

@ -12,6 +12,7 @@
<MicrosoftAspNetCoreHtmlAbstractionsPackageVersion>3.0.0-alpha1-10605</MicrosoftAspNetCoreHtmlAbstractionsPackageVersion> <MicrosoftAspNetCoreHtmlAbstractionsPackageVersion>3.0.0-alpha1-10605</MicrosoftAspNetCoreHtmlAbstractionsPackageVersion>
<MicrosoftAspNetCoreRazorDesignPackageVersion>3.0.0-alpha1-10605</MicrosoftAspNetCoreRazorDesignPackageVersion> <MicrosoftAspNetCoreRazorDesignPackageVersion>3.0.0-alpha1-10605</MicrosoftAspNetCoreRazorDesignPackageVersion>
<MicrosoftExtensionsDependencyInjectionPackageVersion>3.0.0-alpha1-10605</MicrosoftExtensionsDependencyInjectionPackageVersion> <MicrosoftExtensionsDependencyInjectionPackageVersion>3.0.0-alpha1-10605</MicrosoftExtensionsDependencyInjectionPackageVersion>
<MonoCecilPackageVersion>0.10.1</MonoCecilPackageVersion>
<SignalRPackageVersion>3.0.0-alpha1-10605</SignalRPackageVersion> <SignalRPackageVersion>3.0.0-alpha1-10605</SignalRPackageVersion>
<TemplateBlazorPackageVersion>0.8.0-preview1-20181122.3</TemplateBlazorPackageVersion> <TemplateBlazorPackageVersion>0.8.0-preview1-20181122.3</TemplateBlazorPackageVersion>
<TemplateRazorDesignPackageVersion>2.1.2</TemplateRazorDesignPackageVersion> <TemplateRazorDesignPackageVersion>2.1.2</TemplateRazorDesignPackageVersion>

4
src/Components/samples/ComponentsApp.App/App.cshtml
View File

@ -1,5 +1,5 @@
<!-- <!--
Configuring this stuff here is temporary. Later we'll move the app config Configuring this stuff here is temporary. Later we'll move the app config
into Program.cs, and it won't be necessary to specify AppAssembly. into Startup.cs, and it won't be necessary to specify AppAssembly.
--> -->
<Router AppAssembly=typeof(ComponentsApp.App.Program).Assembly /> <Router AppAssembly=typeof(ComponentsApp.App.Startup).Assembly />

25
src/Components/samples/ComponentsApp.App/ComponentsApp.App.csproj
View File

@ -1,20 +1,21 @@
<Project Sdk="Microsoft.NET.Sdk.Web"> <Project Sdk="Microsoft.NET.Sdk.Razor">
<PropertyGroup> <PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework> <TargetFramework>netstandard2.0</TargetFramework>
<OutputType>Exe</OutputType> </PropertyGroup>
</PropertyGroup>
<ItemGroup> <!-- Local equivalent to a package reference to Microsoft.AspNetCore.Components.Build -->
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="$(AspNetCorePackageVersion)" /> <Import Project="..\..\src\Microsoft.AspNetCore.Components.Build\ReferenceFromSource.props" />
<ProjectReference Include="..\..\src\Microsoft.AspNetCore.Components\Microsoft.AspNetCore.Components.csproj" />
</ItemGroup>
<!-- Local alternative to <PackageReference Include="Microsoft.AspNetCore.Blazor.Build" /> --> <ItemGroup>
<Import Project="..\..\blazor\src\Microsoft.AspNetCore.Blazor.Build\ReferenceFromSource.props" /> <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="$(AspNetCorePackageVersion)" />
<ProjectReference Include="..\..\src\Microsoft.AspNetCore.Components\Microsoft.AspNetCore.Components.csproj" />
</ItemGroup>
<ItemGroup> <ItemGroup>
<!-- Allow the build to specify the version of the Razor SDK directly --> <!-- Allow the build to specify the version of the Razor SDK directly -->
<PackageReference Include="Microsoft.NET.Sdk.Razor" Version="$(MicrosoftNETSdkRazorPackageVersion)" PrivateAssets="All" /> <PackageReference Include="Microsoft.NET.Sdk.Razor" Version="$(MicrosoftNETSdkRazorPackageVersion)" PrivateAssets="All" />
</ItemGroup> </ItemGroup>
</Project>
</Project>

14
src/Components/samples/ComponentsApp.App/Program.cs
View File

@ -1,14 +0,0 @@
// 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.
namespace ComponentsApp.App
{
public class Program
{
public static void Main(string[] args)
{
// TODO: Remove entry point
// Currently it's required because .Components.Build won't generate the boot JSON correctly without seeing an entrypoint
}
}
}

4
src/Components/samples/ComponentsApp.App/Shared/NavMenu.cshtml
View File

@ -1,5 +1,5 @@
<div class="top-row pl-4 navbar navbar-dark"> <div class="top-row pl-4 navbar navbar-dark">
<a class="navbar-brand" href="">Blazor app</a> <a class="navbar-brand" href="">Razor Components</a>
<button class="navbar-toggler" onclick=@ToggleNavMenu> <button class="navbar-toggler" onclick=@ToggleNavMenu>
<span class="navbar-toggler-icon"></span> <span class="navbar-toggler-icon"></span>
</button> </button>

11
src/Components/samples/ComponentsApp.Server/Startup.cs
View File

@ -4,7 +4,6 @@
using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.DependencyInjection;
using ComponentsApp.App;
namespace ComponentsApp.Server namespace ComponentsApp.Server
{ {
@ -12,11 +11,7 @@ namespace ComponentsApp.Server
{ {
public void ConfigureServices(IServiceCollection services) public void ConfigureServices(IServiceCollection services)
{ {
// Adds the Server-Side Blazor services, and those registered by the client startup. services.AddRazorComponents<App.Startup>();
services.AddServerSideBlazor<App.Startup>();
// Since Blazor is running on the server, we can use an application service
// to read the forecast data.
services.AddSingleton<WeatherForecastService, DefaultWeatherForecastService>(); services.AddSingleton<WeatherForecastService, DefaultWeatherForecastService>();
} }
@ -27,8 +22,8 @@ namespace ComponentsApp.Server
app.UseDeveloperExceptionPage(); app.UseDeveloperExceptionPage();
} }
// Use component registrations and static files from the client startup. app.UseStaticFiles();
app.UseServerSideBlazor<App.Startup>(); app.UseRazorComponents<App.Startup>();
} }
} }
} }

0
src/Components/samples/ComponentsApp.App/wwwroot/css/bootstrap/bootstrap.min.css → src/Components/samples/ComponentsApp.Server/wwwroot/css/bootstrap/bootstrap.min.css vendored
View File

0
src/Components/samples/ComponentsApp.App/wwwroot/css/bootstrap/bootstrap.min.css.map → src/Components/samples/ComponentsApp.Server/wwwroot/css/bootstrap/bootstrap.min.css.map
View File

0
src/Components/samples/ComponentsApp.App/wwwroot/css/open-iconic/FONT-LICENSE → src/Components/samples/ComponentsApp.Server/wwwroot/css/open-iconic/FONT-LICENSE
View File

0
src/Components/samples/ComponentsApp.App/wwwroot/css/open-iconic/ICON-LICENSE → src/Components/samples/ComponentsApp.Server/wwwroot/css/open-iconic/ICON-LICENSE
View File

0
src/Components/samples/ComponentsApp.App/wwwroot/css/open-iconic/README.md → src/Components/samples/ComponentsApp.Server/wwwroot/css/open-iconic/README.md
View File

0
src/Components/samples/ComponentsApp.App/wwwroot/css/open-iconic/font/css/open-iconic-bootstrap.min.css → src/Components/samples/ComponentsApp.Server/wwwroot/css/open-iconic/font/css/open-iconic-bootstrap.min.css vendored
View File

0
src/Components/samples/ComponentsApp.App/wwwroot/css/open-iconic/font/fonts/open-iconic.eot → src/Components/samples/ComponentsApp.Server/wwwroot/css/open-iconic/font/fonts/open-iconic.eot
View File

0
src/Components/samples/ComponentsApp.App/wwwroot/css/open-iconic/font/fonts/open-iconic.otf → src/Components/samples/ComponentsApp.Server/wwwroot/css/open-iconic/font/fonts/open-iconic.otf
View File

0
src/Components/samples/ComponentsApp.App/wwwroot/css/open-iconic/font/fonts/open-iconic.svg → src/Components/samples/ComponentsApp.Server/wwwroot/css/open-iconic/font/fonts/open-iconic.svg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

0
src/Components/samples/ComponentsApp.App/wwwroot/css/open-iconic/font/fonts/open-iconic.ttf → src/Components/samples/ComponentsApp.Server/wwwroot/css/open-iconic/font/fonts/open-iconic.ttf
View File

0
src/Components/samples/ComponentsApp.App/wwwroot/css/open-iconic/font/fonts/open-iconic.woff → src/Components/samples/ComponentsApp.Server/wwwroot/css/open-iconic/font/fonts/open-iconic.woff
View File

0
src/Components/samples/ComponentsApp.App/wwwroot/css/site.css → src/Components/samples/ComponentsApp.Server/wwwroot/css/site.css
View File

4
src/Components/samples/ComponentsApp.App/wwwroot/index.html → src/Components/samples/ComponentsApp.Server/wwwroot/index.html
View File

@ -3,7 +3,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width"> <meta name="viewport" content="width=device-width">
<title>Server Side Blazor</title> <title>Razor Components</title>
<base href="/" /> <base href="/" />
<link href="css/bootstrap/bootstrap.min.css" rel="stylesheet" /> <link href="css/bootstrap/bootstrap.min.css" rel="stylesheet" />
<link href="css/site.css" rel="stylesheet" /> <link href="css/site.css" rel="stylesheet" />
@ -11,6 +11,6 @@
<body> <body>
<app>Loading...</app> <app>Loading...</app>
<script src="_framework/blazor.server.js"></script> <script src="_framework/components.server.js"></script>
</body> </body>
</html> </html>

8
src/Components/src/Microsoft.AspNetCore.Components.Browser.JS/Microsoft.AspNetCore.Components.Browser.JS.csproj
View File

@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<TargetFramework>netcoreapp3.0</TargetFramework> <TargetFramework>netstandard2.0</TargetFramework>
<Description>JavaScript runtime files needed for ASP.NET Core Components browser rendering.</Description> <Description>JavaScript runtime files needed for ASP.NET Core Components browser rendering.</Description>
<TypeScriptCompileBlocked>true</TypeScriptCompileBlocked> <TypeScriptCompileBlocked>true</TypeScriptCompileBlocked>
<TypeScriptToolsVersion>Latest</TypeScriptToolsVersion> <TypeScriptToolsVersion>Latest</TypeScriptToolsVersion>
@ -22,13 +22,13 @@
<Exec Command="npm ci" /> <Exec Command="npm ci" />
</Target> </Target>
<Target Name="RunWebpack" AfterTargets="ResolveReferences" Inputs="@(WebpackInputs)" Outputs="dist\blazor.webassembly.js;dist\blazor.server.js" DependsOnTargets="EnsureNpmRestored"> <Target Name="RunWebpack" AfterTargets="ResolveReferences" Inputs="@(WebpackInputs)" Outputs="dist\components.webassembly.js;dist\components.server.js" DependsOnTargets="EnsureNpmRestored">
<RemoveDir Directories="dist" /> <RemoveDir Directories="dist" />
<Exec Command="npm run build:debug" Condition="'$(Configuration)' == 'Debug'" /> <Exec Command="npm run build:debug" Condition="'$(Configuration)' == 'Debug'" />
<Exec Command="npm run build:production" Condition="'$(Configuration)' != 'Debug'" /> <Exec Command="npm run build:production" Condition="'$(Configuration)' != 'Debug'" />
<ItemGroup> <ItemGroup>
<EmbeddedResource Include="dist\blazor.webassembly.js" LogicalName="blazor./blazor.webassembly.js" /> <EmbeddedResource Include="dist\components.webassembly.js" LogicalName="blazor./components.webassembly.js" />
<EmbeddedResource Include="dist\blazor.server.js" LogicalName="blazor./blazor.server.js" /> <EmbeddedResource Include="dist\components.server.js" LogicalName="blazor./components.server.js" />
</ItemGroup> </ItemGroup>
</Target> </Target>
</Project> </Project>

4
src/Components/src/Microsoft.AspNetCore.Components.Browser.JS/webpack.config.js
View File

@ -8,8 +8,8 @@ module.exports = (env, args) => ({
rules: [{ test: /\.ts?$/, loader: 'ts-loader' }] rules: [{ test: /\.ts?$/, loader: 'ts-loader' }]
}, },
entry: { entry: {
'blazor.webassembly': './src/Boot.WebAssembly.ts', 'components.webassembly': './src/Boot.WebAssembly.ts',
'blazor.server': './src/Boot.Server.ts', 'components.server': './src/Boot.Server.ts',
}, },
output: { path: path.join(__dirname, '/dist'), filename: '[name].js' } output: { path: path.join(__dirname, '/dist'), filename: '[name].js' }
}); });

2
src/Components/src/Microsoft.AspNetCore.Components.Server/Builder/BlazorApplicationBuilderExtensions.cs
View File

@ -135,7 +135,7 @@ namespace Microsoft.AspNetCore.Builder
return null; return null;
} }
private static void SetCacheHeaders(StaticFileResponseContext ctx) internal static void SetCacheHeaders(StaticFileResponseContext ctx)
{ {
// By setting "Cache-Control: no-cache", we're allowing the browser to store // By setting "Cache-Control: no-cache", we're allowing the browser to store
// a cached copy of the response, but telling it that it must check with the // a cached copy of the response, but telling it that it must check with the

91
src/Components/src/Microsoft.AspNetCore.Components.Server/Builder/RazorComponentsApplicationBuilderExtensions.cs Normal file
View File

@ -0,0 +1,91 @@
// 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 Microsoft.AspNetCore.Components.Server;
using Microsoft.AspNetCore.Components.Server.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.FileProviders;
namespace Microsoft.AspNetCore.Builder
{
/// <summary>
/// Extension methods to configure an <see cref="IApplicationBuilder"/> for serving interactive components.
/// </summary>
public static class RazorComponentsApplicationBuilderExtensions
{
/// <summary>
/// Adds middleware for serving interactive Razor Components.
/// </summary>
/// <param name="builder">The <see cref="IApplicationBuilder"/>.</param>
/// <typeparam name="TStartup">A components app startup type.</typeparam>
/// <returns>The <see cref="IApplicationBuilder"/>.</returns>
public static IApplicationBuilder UseRazorComponents<TStartup>(
this IApplicationBuilder builder)
{
return UseRazorComponents<TStartup>(builder, null);
}
/// <summary>
/// Adds middleware for serving interactive Razor Components.
/// </summary>
/// <param name="builder">The <see cref="IApplicationBuilder"/>.</param>
/// <param name="configure">A callback that can be used to configure the middleware.</param>
/// <typeparam name="TStartup">A components app startup type.</typeparam>
/// <returns>The <see cref="IApplicationBuilder"/>.</returns>
public static IApplicationBuilder UseRazorComponents<TStartup>(
this IApplicationBuilder builder,
Action<RazorComponentsOptions> configure)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
var options = new RazorComponentsOptions();
configure?.Invoke(options);
// The use case for this flag is when developers want to add their own
// SignalR middleware, e.g., when using Azure SignalR. By default we
// add SignalR and BlazorHub automatically.
if (options.UseSignalRWithBlazorHub)
{
builder.UseSignalR(route => route.MapHub<BlazorHub>(BlazorHub.DefaultPath));
}
// Use embedded static content for /_framework
builder.Map("/_framework", frameworkBuilder =>
{
UseFrameworkFiles(frameworkBuilder);
});
// Use SPA fallback routing for anything else
builder.UseSpa(spa => { });
return builder;
}
private static void UseFrameworkFiles(IApplicationBuilder builder)
{
builder.UseStaticFiles(new StaticFileOptions
{
FileProvider = new ManifestEmbeddedFileProvider(
typeof(RazorComponentsApplicationBuilderExtensions).Assembly,
"frameworkFiles"),
OnPrepareResponse = BlazorApplicationBuilderExtensions.SetCacheHeaders
});
// TODO: Remove this
// This is needed temporarily only until we implement a proper version
// of library-embedded static resources for Razor Components apps.
builder.Map("/blazor.boot.json", bootJsonBuilder =>
{
bootJsonBuilder.Use(async (ctx, next) =>
{
ctx.Response.ContentType = "application/json";
await ctx.Response.WriteAsync(@"{ ""cssReferences"": [], ""jsReferences"": [] }");
});
});
}
}
}

23
src/Components/src/Microsoft.AspNetCore.Components.Server/Builder/RazorComponentsOptions.cs Normal file
View File

@ -0,0 +1,23 @@
// 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 Microsoft.AspNetCore.Builder;
namespace Microsoft.AspNetCore.Components.Server.Builder
{
/// <summary>
/// Specifies options to configure <see cref="RazorComponentsApplicationBuilderExtensions.UseRazorComponents{TStartup}(IApplicationBuilder)"/>
/// </summary>
public class RazorComponentsOptions
{
/// <summary>
/// Gets or sets a flag to indicate whether to attach middleware for
/// communicating with interactive components via SignalR. Defaults
/// to true.
///
/// If the value is set to false, the application must manually add
/// SignalR middleware with <see cref="BlazorHub"/>.
/// </summary>
public bool UseSignalRWithBlazorHub { get; set; } = true;
}
}

76
src/Components/src/Microsoft.AspNetCore.Components.Server/Builder/ServerSideBlazorApplicationBuilderExtensions.cs
View File

@ -1,76 +0,0 @@
// 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 Microsoft.AspNetCore.Components.Server;
using Microsoft.AspNetCore.Http;
namespace Microsoft.AspNetCore.Builder
{
/// <summary>
/// Extension methods to configure an <see cref="IApplicationBuilder"/> for Server-Side Blazor.
/// These are just shorthand for combining UseSignalR with UseBlazor.
/// </summary>
public static class ServerSideBlazorApplicationBuilderExtensions
{
/// <summary>
/// Registers Server-Side Blazor in the pipeline.
/// </summary>
/// <param name="builder">The <see cref="IApplicationBuilder"/>.</param>
/// <typeparam name="TStartup">A Blazor startup type.</typeparam>
/// <returns>The <see cref="IApplicationBuilder"/>.</returns>
public static IApplicationBuilder UseServerSideBlazor<TStartup>(
this IApplicationBuilder builder)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
// WARNING: Don't add extra setup logic here. It's important for
// UseServerSideBlazor just to be shorthand for UseSignalR+UseBlazor,
// so that people who want to call those two manually instead can
// also do so. That's needed for people using Azure SignalR.
// TODO: Also allow configuring the endpoint path.
return UseSignalRWithBlazorHub(builder, BlazorHub.DefaultPath)
.UseBlazor<TStartup>();
}
/// <summary>
/// Registers Server-Side Blazor in the pipeline.
/// </summary>
/// <param name="builder">The <see cref="IApplicationBuilder"/>.</param>
/// <param name="options">A <see cref="BlazorOptions"/> instance used to configure the Blazor file provider.</param>
/// <returns>The <see cref="IApplicationBuilder"/>.</returns>
public static IApplicationBuilder UseServerSideBlazor(
this IApplicationBuilder builder,
BlazorOptions options)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (options == null)
{
throw new ArgumentNullException(nameof(options));
}
// WARNING: Don't add extra setup logic here. It's important for
// UseServerSideBlazor just to be shorthand for UseSignalR+UseBlazor,
// so that people who want to call those two manually instead can
// also do so. That's needed for people using Azure SignalR.
// TODO: Also allow configuring the endpoint path.
return UseSignalRWithBlazorHub(builder, BlazorHub.DefaultPath)
.UseBlazor(options);
}
private static IApplicationBuilder UseSignalRWithBlazorHub(
IApplicationBuilder builder, PathString path)
{
return builder.UseSignalR(route => route.MapHub<BlazorHub>(BlazorHub.DefaultPath));
}
}
}

48
src/Components/src/Microsoft.AspNetCore.Components.Server/DependencyInjection/ServerSideBlazorServiceCollectionExtensions.cs → src/Components/src/Microsoft.AspNetCore.Components.Server/DependencyInjection/RazorComponentsServiceCollectionExtensions.cs
View File

@ -12,33 +12,17 @@ using Microsoft.JSInterop;
namespace Microsoft.Extensions.DependencyInjection namespace Microsoft.Extensions.DependencyInjection
{ {
/// <summary> /// <summary>
/// Extension methods to configure an <see cref="IServiceCollection"/> for Server-Side Blazor. /// Extension methods to configure an <see cref="IServiceCollection"/> for interactive components.
/// </summary> /// </summary>
public static class ServerSideBlazorServiceCollectionExtensions public static class RazorComponentsServiceCollectionExtensions
{ {
/// <summary> /// <summary>
/// Adds Server-Side Blazor services to the service collection. /// Adds Razor Component services to the service collection.
/// </summary> /// </summary>
/// <param name="services">The <see cref="IServiceCollection"/>.</param> /// <param name="services">The <see cref="IServiceCollection"/>.</param>
/// <param name="startupType">A Razor Components project startup type.</param>
/// <returns>The <see cref="IServiceCollection"/>.</returns> /// <returns>The <see cref="IServiceCollection"/>.</returns>
public static IServiceCollection AddServerSideBlazor( public static IServiceCollection AddRazorComponents(
this IServiceCollection services)
{
if (services == null)
{
throw new ArgumentNullException(nameof(services));
}
return AddServerSideBlazor(services, null);
}
/// <summary>
/// Adds Server-Side Blazor services to the service collection.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/>.</param>
/// <param name="startupType">A Blazor startup type.</param>
/// <returns>The <see cref="IServiceCollection"/>.</returns>
public static IServiceCollection AddServerSideBlazor(
this IServiceCollection services, this IServiceCollection services,
Type startupType) Type startupType)
{ {
@ -52,16 +36,16 @@ namespace Microsoft.Extensions.DependencyInjection
throw new ArgumentNullException(nameof(startupType)); throw new ArgumentNullException(nameof(startupType));
} }
return AddServerSideBlazorCore(services, startupType); return AddRazorComponentsCore(services, startupType);
} }
/// <summary> /// <summary>
/// Adds Server-Side Blazor services to the service collection. /// Adds Razor Component app services to the service collection.
/// </summary> /// </summary>
/// <param name="services">The <see cref="IServiceCollection"/>.</param> /// <param name="services">The <see cref="IServiceCollection"/>.</param>
/// <typeparam name="TStartup">A Blazor startup type.</typeparam> /// <typeparam name="TStartup">A Components app startup type.</typeparam>
/// <returns>The <see cref="IServiceCollection"/>.</returns> /// <returns>The <see cref="IServiceCollection"/>.</returns>
public static IServiceCollection AddServerSideBlazor<TStartup>( public static IServiceCollection AddRazorComponents<TStartup>(
this IServiceCollection services) this IServiceCollection services)
{ {
if (services == null) if (services == null)
@ -69,14 +53,14 @@ namespace Microsoft.Extensions.DependencyInjection
throw new ArgumentNullException(nameof(services)); throw new ArgumentNullException(nameof(services));
} }
return AddServerSideBlazorCore(services, typeof(TStartup)); return AddRazorComponentsCore(services, typeof(TStartup));
} }
private static IServiceCollection AddServerSideBlazorCore( private static IServiceCollection AddRazorComponentsCore(
IServiceCollection services, IServiceCollection services,
Type startupType) Type startupType)
{ {
AddStandardServerSideBlazorServices(services); AddStandardRazorComponentsServices(services);
if (startupType != null) if (startupType != null)
{ {
@ -94,7 +78,7 @@ namespace Microsoft.Extensions.DependencyInjection
if (circuitFactoryOptions.StartupActions.ContainsKey(endpoint)) if (circuitFactoryOptions.StartupActions.ContainsKey(endpoint))
{ {
throw new InvalidOperationException( throw new InvalidOperationException(
"Multiple Server Side Blazor entries are configured to use " + "Multiple Components app entries are configured to use " +
$"the same endpoint '{endpoint}'."); $"the same endpoint '{endpoint}'.");
} }
@ -108,11 +92,11 @@ namespace Microsoft.Extensions.DependencyInjection
return services; return services;
} }
private static void AddStandardServerSideBlazorServices(IServiceCollection services) private static void AddStandardRazorComponentsServices(IServiceCollection services)
{ {
// Here we add a bunch of services that don't vary in any way based on the // Here we add a bunch of services that don't vary in any way based on the
// user's configuration. So even if the user has multiple independent server-side // user's configuration. So even if the user has multiple independent server-side
// Blazor entrypoints, this lot is the same and repeated registrations are a no-op. // Components entrypoints, this lot is the same and repeated registrations are a no-op.
services.TryAddSingleton<CircuitFactory, DefaultCircuitFactory>(); services.TryAddSingleton<CircuitFactory, DefaultCircuitFactory>();
services.TryAddScoped<ICircuitAccessor, DefaultCircuitAccessor>(); services.TryAddScoped<ICircuitAccessor, DefaultCircuitAccessor>();
services.TryAddScoped<Circuit>(s => s.GetRequiredService<ICircuitAccessor>().Circuit); services.TryAddScoped<Circuit>(s => s.GetRequiredService<ICircuitAccessor>().Circuit);
@ -122,7 +106,7 @@ namespace Microsoft.Extensions.DependencyInjection
// We've discussed with the SignalR team and believe it's OK to have repeated // We've discussed with the SignalR team and believe it's OK to have repeated
// calls to AddSignalR (making the nonfirst ones no-ops). If we want to change // calls to AddSignalR (making the nonfirst ones no-ops). If we want to change
// this in the future, we could change AddServerSideBlazor to be an extension // this in the future, we could change AddComponents to be an extension
// method on ISignalRServerBuilder so the developer always has to chain it onto // method on ISignalRServerBuilder so the developer always has to chain it onto
// their own AddSignalR call. For now we're keeping it like this because it's // their own AddSignalR call. For now we're keeping it like this because it's
// simpler for developers in common cases. // simpler for developers in common cases.

9
src/Components/src/Microsoft.AspNetCore.Components.Server/Microsoft.AspNetCore.Components.Server.csproj
View File

@ -4,6 +4,7 @@
<TargetFramework>netstandard2.0</TargetFramework> <TargetFramework>netstandard2.0</TargetFramework>
<Description>Runtime server features for ASP.NET Core Components.</Description> <Description>Runtime server features for ASP.NET Core Components.</Description>
<IsProductPackage>true</IsProductPackage> <IsProductPackage>true</IsProductPackage>
<GenerateEmbeddedFilesManifest>true</GenerateEmbeddedFilesManifest>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
@ -16,11 +17,17 @@
<PackageReference Include="Microsoft.AspNetCore.SignalR.Protocols.MessagePack" Version="$(SignalRPackageVersion)" /> <PackageReference Include="Microsoft.AspNetCore.SignalR.Protocols.MessagePack" Version="$(SignalRPackageVersion)" />
<PackageReference Include="Microsoft.AspNetCore.StaticFiles" Version="$(AspNetCorePackageVersion)" /> <PackageReference Include="Microsoft.AspNetCore.StaticFiles" Version="$(AspNetCorePackageVersion)" />
<PackageReference Include="Microsoft.AspNetCore.SpaServices.Extensions" Version="$(AspNetCorePackageVersion)" /> <PackageReference Include="Microsoft.AspNetCore.SpaServices.Extensions" Version="$(AspNetCorePackageVersion)" />
<PackageReference Include="Microsoft.Extensions.FileProviders.Physical" Version="$(AspNetCorePackageVersion)" /> <PackageReference Include="Microsoft.Extensions.FileProviders.Embedded" Version="$(AspNetCorePackageVersion)" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<ProjectReference Include="..\Microsoft.AspNetCore.Components.Browser\Microsoft.AspNetCore.Components.Browser.csproj" /> <ProjectReference Include="..\Microsoft.AspNetCore.Components.Browser\Microsoft.AspNetCore.Components.Browser.csproj" />
</ItemGroup> </ItemGroup>
<ItemGroup>
<!-- We need .Browser.JS to build first so we can embed its .js output -->
<ProjectReference Include="..\Microsoft.AspNetCore.Components.Browser.JS\Microsoft.AspNetCore.Components.Browser.JS.csproj" ReferenceOutputAssembly="false" />
<EmbeddedResource Include="..\Microsoft.AspNetCore.Components.Browser.JS\dist\components.server.js" LogicalName="frameworkFiles\%(Filename)%(Extension)" />
</ItemGroup>
</Project> </Project>

2
src/Components/test/Microsoft.AspNetCore.Components.E2ETest/ServerExecutionTests/ServerSideAppTest.cs
View File

@ -31,7 +31,7 @@ namespace Microsoft.AspNetCore.Components.E2ETest.ServerExecutionTests
[Fact] [Fact]
public void HasTitle() public void HasTitle()
{ {
Assert.Equal("Server Side Blazor", Browser.Title); Assert.Equal("Razor Components", Browser.Title);
} }
[Fact] [Fact]

6
src/Components/test/testapps/BasicTestApp/wwwroot/index.html
View File

@ -18,12 +18,12 @@
} }
(function () { (function () {
// Load either blazor.webassembly.js or blazor.server.js depending // Load either components.webassembly.js or components.server.js depending
// on the hash part of the URL. This is just to give a way for the // on the hash part of the URL. This is just to give a way for the
// test runner to make the selection. // test runner to make the selection.
var src = location.hash === '#server' var src = location.hash === '#server'
? 'blazor.server.js' ? 'components.server.js'
: 'blazor.webassembly.js'; : 'components.webassembly.js';
document.write('<script src="_framework/' + src + '"><' + '/script>'); document.write('<script src="_framework/' + src + '"><' + '/script>');
})(); })();
</script> </script>

2
src/Components/test/testapps/TestServer/Startup.cs
View File

@ -23,7 +23,7 @@ namespace TestServer
{ {
options.AddPolicy("AllowAll", _ => { /* Controlled below */ }); options.AddPolicy("AllowAll", _ => { /* Controlled below */ });
}); });
services.AddServerSideBlazor<BasicTestApp.Startup>(); services.AddRazorComponents<BasicTestApp.Startup>();
} }
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline. // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.