Move to Minimal Hosting Model in a backwards compatible way #14656
Conversation
…fore configuring middleware
There was a problem hiding this comment.
@bergmania I've added some comments to give additional context and ensured UIseStaticWebAssets() is not called when using production runtime mode.
I've tested this by adding breakpoints to CoreRuntime.StartAsync() and CoreRuntime.StopAsync() and can verify they are only called once when using the Minimal Hosting model and also after copying the Program/Startup files from v12 👍🏻
| @@ -152,12 +152,6 @@ private async Task StartAsync(CancellationToken cancellationToken, bool isRestar | |||
| // Store token, so we can re-use this during restart | |||
| _cancellationToken = cancellationToken; | |||
|
|
|||
| // Just in-case HostBuilder.ConfigureUmbracoDefaults() isn't used (e.g. upgrade from 9 and ignored advice). | |||
| if (StaticServiceProvider.Instance == null!) | |||
There was a problem hiding this comment.
This is now set when BootUmbracoAsync() is called or when using the Program/Startup approach when the decorated IHostBuilder (returned by ConfigureUmbracoDefaults()) is built, and validated when calling UseUmbraco(), so that's why this fallback can be safely removed.
| if (addRuntimeHostedService) | ||
| { | ||
| // Add the Umbraco IRuntime as hosted service | ||
| builder.ConfigureServices(services => services.AddHostedService(factory => factory.GetRequiredService<IRuntime>())); | ||
| } |
There was a problem hiding this comment.
Although the Umbraco IRuntime still inherits from IHostedService, it's only added as hosted service when using the Program/Startup approach. This ensures the StartAsync() and StopAsync() methods are called only once and at the right time, regardless of whether the Minimal Hosting model is used or not.
| @@ -15,6 +17,9 @@ public static class HostBuilderExtensions | |||
| /// Configures an existing <see cref="IHostBuilder" /> with defaults for an Umbraco application. | |||
| /// </summary> | |||
| public static IHostBuilder ConfigureUmbracoDefaults(this IHostBuilder builder) | |||
| => builder.ConfigureUmbracoDefaults(true); | |||
|
|
|||
| internal static IHostBuilder ConfigureUmbracoDefaults(this IHostBuilder builder, bool addRuntimeHostedService) | |||
| { | |||
| #if DEBUG | |||
There was a problem hiding this comment.
We should remove this conditional code, since it's only used when running a debug build from the source code. Released assemblies won't have this code, so debug builds of sites using the NuGet packages also won't have this optional appsettings JSON file added anyway.
We could add it to the Program.cs file again, although it will then be shipped in the default template:
#if DEBUG
builder.Configuration.AddJsonFile("appsettings.Local.json", optional: true, reloadOnChange: true);
#endif
| // Do not enable static web assets on production environments, | ||
| // because the files are already copied to the publish output folder. | ||
| if (builder.Configuration.GetRuntimeMode() != RuntimeMode.Production) | ||
| { | ||
| builder.WebHost.UseStaticWebAssets(); | ||
| } |
There was a problem hiding this comment.
The static web assets should only be enabled when developing locally, since it will configure the WebRootFileProvider to get referenced files from the shared NuGet cache folder. Production environments should only serve files from the project (for security) and because the static web assets (from Razor Class Libraries) are already automatically copied to the publish output, this also removes some overhead in file lookups.
There was a problem hiding this comment.
Although I don't expect a lot of users will be running a non-Development environment using the Production runtime mode from source (non-published output), but if they do, the files from RCLs won't be available anymore and return 404s now.
This can be easily fixed by manually calling builder.WebHost.UseStaticWebAssets(); yourself. We could add this to the documentation, but I guess it's really an edge-case and could potentially result in users adding this without knowing/fully understanding the implications and not removing/disabling it on production again...
Description
This PR introduces the minimal hosting model.
It have been made in a backward compatible way. It throws friendly error messages, if the
await app.BootUmbracoAsync();have not been called early enough, when using minimal hosting model.Tests
Program.csandStartup.cs