This repository was archived by the owner on Dec 14, 2018. It is now read-only.
Add dotnet-razor-precompile tool #5087
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| // 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.Collections.Generic; | ||
| using Microsoft.AspNetCore.Mvc.ApplicationParts; | ||
|
|
||
| namespace Microsoft.AspNetCore.Mvc.Core.ApplicationParts | ||
|
|
||
| { | ||
| /// <summary> | ||
| /// Exposes a sequence of precompiled views associated with an <see cref="ApplicationPart"/> . | ||
| /// </summary> | ||
| public interface IPrecompiledViewsProvider | ||
|
There was a problem hiding this comment. Can we drop the term |
||
| { | ||
| /// <summary> | ||
| /// Gets the sequence of <see cref="PrecompiledViewInfo"/>. | ||
| /// </summary> | ||
| IReadOnlyCollection<PrecompiledViewInfo> PrecompiledViews { get; } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| // 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; | ||
|
|
||
| namespace Microsoft.AspNetCore.Mvc.Core.ApplicationParts | ||
|
|
||
| { | ||
| /// <summary> | ||
| /// Provides information for precompiled views. | ||
| /// </summary> | ||
| public class PrecompiledViewInfo | ||
|
There was a problem hiding this comment. Just a note, not sure if there's anything that can be done but this is darn close to the |
||
| { | ||
| /// <summary> | ||
| /// Creates a new instance of <see cref="PrecompiledViewInfo" />. | ||
| /// </summary> | ||
| /// <param name="path">The path of the view.</param> | ||
| /// <param name="type">The view <see cref="System.Type"/>.</param> | ||
| public PrecompiledViewInfo(string path, Type type) | ||
| { | ||
| Path = path; | ||
|
There was a problem hiding this comment. This comment probably applies everywhere in this PR |
||
| Type = type; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// The path of the view. | ||
| /// </summary> | ||
| public string Path { get; } | ||
|
|
||
| /// <summary> | ||
| /// The view <see cref="System.Type"/>. | ||
| /// </summary> | ||
| public Type Type { get; } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| // 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.Collections.Generic; | ||
|
|
||
| namespace Microsoft.AspNetCore.Mvc.Core.ApplicationParts | ||
|
|
||
| { | ||
| /// <summary> | ||
| /// A container for <see cref="PrecompiledViewInfo"/> instances. | ||
| /// </summary> | ||
| public abstract class PrecompiledViews | ||
|
There was a problem hiding this comment. Naming seems bad. should this be something |
||
| { | ||
| /// <summary> | ||
| /// Initializes a new instance of <see cref="ViewInfos"/>. | ||
| /// </summary> | ||
| /// <param name="precompiledViews">The sequence of <see cref="PrecompiledViewInfo"/>.</param> | ||
| protected PrecompiledViews(IReadOnlyCollection<PrecompiledViewInfo> precompiledViews) | ||
| { | ||
| ViewInfos = precompiledViews; | ||
| } | ||
|
|
||
| public IReadOnlyCollection<PrecompiledViewInfo> ViewInfos { get; } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| // 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.Extensions.DependencyInjection; | ||
|
|
||
| namespace Microsoft.AspNetCore.Mvc.DesignTime | ||
|
There was a problem hiding this comment. I'm not sure another namespace is justified. There was a problem hiding this comment. Should we name the type |
||
| { | ||
| /// <summary> | ||
| /// Configures the <see cref="IMvcBuilder"/>. Implement this interface to enable design-time configuration | ||
| /// (for instance during pre-compilation of views) of <see cref="IMvcBuilder"/>. | ||
| /// </summary> | ||
| public interface IMvcBuilderConfiguration | ||
|
There was a problem hiding this comment. Do we need the equivalent for There was a problem hiding this comment. It might not be entirely too difficult. We could prefer types implementing |
||
| { | ||
| /// <summary> | ||
| /// Configures the <see cref="IMvcBuilder"/>. | ||
| /// </summary> | ||
| /// <param name="builder"></param> | ||
| void ConfigureMvc(IMvcBuilder builder); | ||
|
There was a problem hiding this comment. since this is an interface method, is the idea that you'd put this on your startup class? Or do you do another class? Thinking about code sharing between designtime and runtime There was a problem hiding this comment. Yeah, in my sample, I added it to Startup. It made it more natural to take the code you had in There was a problem hiding this comment. |
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // 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.Extensions.CommandLineUtils; | ||
|
|
||
| namespace Microsoft.AspNetCore.Mvc.Razor.Precompilation.Design.Internal | ||
|
There was a problem hiding this comment. I'm largely ignoring the stuff to do with the command line application - just FYI |
||
| { | ||
| public class CommonOptions | ||
| { | ||
| public static readonly string ConfigureCompilationTypeTemplate = "--configure-compilation-type"; | ||
| public static readonly string ContentRootTemplate = "--content-root"; | ||
|
|
||
| public CommandArgument ProjectArgument { get; private set; } | ||
|
|
||
| public CommandOption ConfigureCompilationType { get; private set; } | ||
|
|
||
| public CommandOption ContentRootOption { get; private set; } | ||
|
|
||
| public void Configure(CommandLineApplication app) | ||
| { | ||
| app.Description = "Precompiles an application."; | ||
| app.HelpOption("-?|-h|--help"); | ||
|
|
||
| ProjectArgument = app.Argument( | ||
| "project", | ||
| "The path to the project (project folder or project.json) with precompilation."); | ||
|
|
||
| ConfigureCompilationType = app.Option( | ||
| ConfigureCompilationTypeTemplate, | ||
| "Type with Configure method", | ||
| CommandOptionType.SingleValue); | ||
|
|
||
| ContentRootOption = app.Option( | ||
| ContentRootTemplate, | ||
| "The application's content root.", | ||
| CommandOptionType.SingleValue); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| // 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. | ||
|
|
||
| #if DEBUG | ||
| using System; | ||
| using System.Diagnostics; | ||
| using System.Linq; | ||
|
|
||
| namespace Microsoft.AspNetCore.Mvc.Razor.Precompilation.Design.Internal | ||
| { | ||
| public static class DebugHelper | ||
|
There was a problem hiding this comment. I kept expecting it play... |
||
| { | ||
| public static void HandleDebugSwitch(ref string[] args) | ||
| { | ||
| if (args.Length > 0 && string.Equals("--debug", args[0], StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| args = args.Skip(1).ToArray(); | ||
| Console.WriteLine("Waiting for debugger to attach. Press ENTER to continue"); | ||
| Console.WriteLine($"Process ID: {Process.GetCurrentProcess().Id}"); | ||
| Console.ReadLine(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| #endif | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| // 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.Diagnostics; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using System.Reflection; | ||
| using Microsoft.AspNetCore.Hosting; | ||
| using Microsoft.AspNetCore.Hosting.Internal; | ||
| using Microsoft.AspNetCore.Mvc.DesignTime; | ||
| using Microsoft.AspNetCore.Mvc.Internal; | ||
| using Microsoft.AspNetCore.Mvc.Razor.Internal; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
| using Microsoft.Extensions.FileProviders; | ||
| using Microsoft.Extensions.ObjectPool; | ||
|
|
||
| namespace Microsoft.AspNetCore.Mvc.Razor.Precompilation.Design.Internal | ||
| { | ||
| public class MvcServicesProvider | ||
| { | ||
| private readonly string _projectPath; | ||
| private readonly string _contentRoot; | ||
| private readonly string _applicationName; | ||
|
|
||
| public MvcServicesProvider( | ||
| string projectPath, | ||
| string applicationName, | ||
| string contentRoot, | ||
| string configureCompilationType) | ||
| { | ||
| _projectPath = projectPath; | ||
| _contentRoot = contentRoot; | ||
| _applicationName = applicationName; | ||
|
|
||
| var mvcBuilderConfiguration = GetConfigureCompilationAction(configureCompilationType); | ||
| var serviceProvider = GetProvider(mvcBuilderConfiguration); | ||
|
|
||
| Host = serviceProvider.GetRequiredService<IMvcRazorHost>(); | ||
| Compiler = serviceProvider.GetRequiredService<CSharpCompiler>(); | ||
|
|
||
| FileProvider = serviceProvider.GetRequiredService<IRazorViewEngineFileProviderAccessor>().FileProvider; | ||
| } | ||
|
|
||
| public IMvcRazorHost Host { get; } | ||
|
|
||
| public CSharpCompiler Compiler { get; } | ||
|
|
||
| public IFileProvider FileProvider { get; } | ||
|
|
||
| private IMvcBuilderConfiguration GetConfigureCompilationAction(string configureCompilationType) | ||
| { | ||
| Type type; | ||
| if (!string.IsNullOrEmpty(configureCompilationType)) | ||
|
There was a problem hiding this comment. if (string.IsNullOrEmpty(configureCompilationType))
{
return null;
}There was a problem hiding this comment. We need to fill in the else eventually. |
||
| { | ||
| type = Type.GetType(configureCompilationType); | ||
| if (type == null) | ||
| { | ||
| throw new InvalidOperationException($"Unable to find type '{type}."); | ||
| } | ||
| } | ||
| else | ||
| { | ||
| var assemblyName = new AssemblyName(_applicationName); | ||
| var assembly = Assembly.Load(assemblyName); | ||
| type = assembly | ||
| .GetExportedTypes() | ||
| .FirstOrDefault(typeof(IMvcBuilderConfiguration).IsAssignableFrom); | ||
| } | ||
|
|
||
| if (type == null) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| var instance = Activator.CreateInstance(type) as IMvcBuilderConfiguration; | ||
| if (instance == null) | ||
| { | ||
| throw new InvalidOperationException($"Type {configureCompilationType} does not implement " + | ||
| $"{typeof(IMvcBuilderConfiguration)}."); | ||
| } | ||
|
|
||
| return instance; | ||
| } | ||
|
|
||
| private IServiceProvider GetProvider(IMvcBuilderConfiguration mvcBuilderConfiguration) | ||
| { | ||
| var services = new ServiceCollection(); | ||
|
|
||
| var hostingEnvironment = new HostingEnvironment | ||
| { | ||
| ApplicationName = _applicationName, | ||
| WebRootFileProvider = new PhysicalFileProvider(_projectPath), | ||
| ContentRootFileProvider = new PhysicalFileProvider(_contentRoot), | ||
| ContentRootPath = _contentRoot, | ||
| }; | ||
| var diagnosticSource = new DiagnosticListener("Microsoft.AspNetCore"); | ||
|
|
||
| services | ||
| .AddSingleton<IHostingEnvironment>(hostingEnvironment) | ||
| .AddSingleton<DiagnosticSource>(diagnosticSource) | ||
| .AddLogging() | ||
| .AddSingleton<ObjectPoolProvider, DefaultObjectPoolProvider>(); | ||
|
|
||
| var mvcCoreBuilder = services | ||
| .AddMvcCore() | ||
| .AddRazorViewEngine(); | ||
|
|
||
| var mvcBuilder = new MvcBuilder(mvcCoreBuilder.Services, mvcCoreBuilder.PartManager); | ||
| mvcBuilderConfiguration?.ConfigureMvc(mvcBuilder); | ||
|
|
||
| return mvcBuilder.Services.BuildServiceProvider(); | ||
|
There was a problem hiding this comment. /cc @davidfowl - this is what we discussed a while ago about our |
||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason not to just make these two properties this a single string?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I use these in codegen, so they have to separated.