Modify Razor components to use RazorViewEngineOptions.FileSystem

Fixes #1302

Author: pranavkm

src/Microsoft.AspNet.Mvc.Razor.Host/MvcRazorHost.cs

@@ -11,10 +11,6 @@
 using Microsoft.AspNet.Razor.Parser;
 using Microsoft.AspNet.Razor.Runtime.TagHelpers;
 
-#if ASPNET50 || ASPNETCORE50
-using Microsoft.Framework.Runtime;
-#endif
-
 namespace Microsoft.AspNet.Mvc.Razor
 {
     public class MvcRazorHost : RazorEngineHost, IMvcRazorHost
@@ -41,17 +37,7 @@ public class MvcRazorHost : RazorEngineHost, IMvcRazorHost
         // This field holds the type name without the generic decoration (MyBaseType)
         private readonly string _baseType;
 
-#if ASPNET50 || ASPNETCORE50
-        /// <summary>
-        /// Initializes a new instance of <see cref="MvcRazorHost"/> with the specified
-        /// <param name="appEnvironment"/>.
-        /// </summary>
-        /// <param name="appEnvironment">Contains information about the executing application.</param>
-        public MvcRazorHost(IApplicationEnvironment appEnvironment)
-            : this(new PhysicalFileSystem(appEnvironment.ApplicationBasePath))
-        {
-        }
-#elif NET45
+#if NET45
         /// <summary>
         /// Initializes a new instance of <see cref="MvcRazorHost"/> with the specified
         /// <param name="root"/>.
@@ -62,12 +48,11 @@ public MvcRazorHost(string root) :
         {
         }
 #endif
-
         /// <summary>
         /// Initializes a new instance of <see cref="MvcRazorHost"/> using the specified <paramref name="fileSystem"/>.
         /// </summary>
         /// <param name="fileSystem">A <see cref="IFileSystem"/> rooted at the application base path.</param>
-        protected internal MvcRazorHost([NotNull] IFileSystem fileSystem)
+        public MvcRazorHost([NotNull] IFileSystem fileSystem)
             : base(new CSharpRazorCodeLanguage())
         {
             _fileSystem = fileSystem;

src/Microsoft.AspNet.Mvc.Razor/Compilation/ExpiringFileInfoCache.cs

@@ -5,7 +5,6 @@
 using System.Collections.Concurrent;
 using Microsoft.AspNet.FileSystems;
 using Microsoft.Framework.OptionsModel;
-using Microsoft.Framework.Runtime;
 
 namespace Microsoft.AspNet.Mvc.Razor
 {
@@ -17,15 +16,13 @@ public class ExpiringFileInfoCache : IFileInfoCache
         private readonly ConcurrentDictionary<string, ExpiringFileInfo> _fileInfoCache =
             new ConcurrentDictionary<string, ExpiringFileInfo>(StringComparer.Ordinal);
 
-        private readonly PhysicalFileSystem _fileSystem;
+        private readonly IFileSystem _fileSystem;
         private readonly TimeSpan _offset;
 
-        protected virtual IFileSystem FileSystem
+        public ExpiringFileInfoCache(IOptionsAccessor<RazorViewEngineOptions> optionsAccessor)
         {
-            get
-            {
-                return _fileSystem;
-            }
+            _fileSystem = optionsAccessor.Options.FileSystem;
+            _offset = optionsAccessor.Options.ExpirationBeforeCheckingFilesOnDisk;
         }
 
         protected virtual DateTime UtcNow
@@ -36,14 +33,6 @@ protected virtual DateTime UtcNow
             }
         }
 
-        public ExpiringFileInfoCache(IApplicationEnvironment env,
-                                     IOptionsAccessor<RazorViewEngineOptions> optionsAccessor)
-        {
-            // TODO: Inject the IFileSystem but only when we get it from the host
-            _fileSystem = new PhysicalFileSystem(env.ApplicationBasePath);
-            _offset = optionsAccessor.Options.ExpirationBeforeCheckingFilesOnDisk;
-        }
-
         /// <inheritdoc />
         public IFileInfo GetFileInfo([NotNull] string virtualPath)
         {
@@ -59,7 +48,7 @@ public IFileInfo GetFileInfo([NotNull] string virtualPath)
             }
             else
             {
-                FileSystem.TryGetFileInfo(virtualPath, out fileInfo);
+                _fileSystem.TryGetFileInfo(virtualPath, out fileInfo);
 
                 expiringFileInfo = new ExpiringFileInfo()
                 {

src/Microsoft.AspNet.Mvc.Razor/Compilation/IExpiringFileInfoCache.cs renamed to src/Microsoft.AspNet.Mvc.Razor/Compilation/IFileInfoCache.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using Microsoft.AspNet.FileSystems;
 using Microsoft.AspNet.Mvc.Razor.OptionDescriptors;
 
 namespace Microsoft.AspNet.Mvc.Razor
@@ -13,6 +14,7 @@ namespace Microsoft.AspNet.Mvc.Razor
     public class RazorViewEngineOptions
     {
         private TimeSpan _expirationBeforeCheckingFilesOnDisk = TimeSpan.FromSeconds(2);
+        private IFileSystem _fileSystem;
 
         /// <summary>
         /// Controls the <see cref="ExpiringFileInfoCache" /> caching behavior.
@@ -47,5 +49,28 @@ public TimeSpan ExpirationBeforeCheckingFilesOnDisk
         /// </summary>
         public IList<ViewLocationExpanderDescriptor> ViewLocationExpanders { get; }
             = new List<ViewLocationExpanderDescriptor>();
+
+        /// <summary>
+        /// Gets or sets the <see cref="IFileSystem" /> used by <see cref="RazorViewEngine"/> to locate Razor files on
+        /// disk.
+        /// </summary>
+        /// <remarks>
+        /// At startup, this is initialized to an instance of <see cref="PhysicalFileSystem"/> that is rooted at the
+        /// application root.
+        /// </remarks>
+        public IFileSystem FileSystem
+        {
+            get { return _fileSystem; }
+
+            set
+            {
+                if (value == null)
+                {
+                    throw new ArgumentNullException(nameof(value));
+                }
+
+                _fileSystem = value;
+            }
+        }
     }
 }

src/Microsoft.AspNet.Mvc.Razor/OptionDescriptors/RazorViewEngineOptions.cs

@@ -5,7 +5,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.AspNet.FileSystems;
-using Microsoft.Framework.Runtime;
+using Microsoft.Framework.OptionsModel;
 
 namespace Microsoft.AspNet.Mvc.Razor
 {
@@ -15,10 +15,10 @@ public class ViewStartProvider : IViewStartProvider
         private readonly IFileSystem _fileSystem;
         private readonly IRazorPageFactory _pageFactory;
 
-        public ViewStartProvider(IApplicationEnvironment appEnv,
-                                 IRazorPageFactory pageFactory)
+        public ViewStartProvider(IRazorPageFactory pageFactory,
+                                 IOptionsAccessor<RazorViewEngineOptions> optionsAccessor)
         {
-            _fileSystem = new PhysicalFileSystem(appEnv.ApplicationBasePath);
+            _fileSystem = optionsAccessor.Options.FileSystem;
             _pageFactory = pageFactory;
         }
 

src/Microsoft.AspNet.Mvc.Razor/ViewStartProvider.cs

@@ -2,7 +2,6 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
-using Microsoft.AspNet.Mvc.Core;
 using Microsoft.Framework.DependencyInjection;
 
 namespace Microsoft.AspNet.Mvc.Razor

src/Microsoft.AspNet.Mvc.Razor/VirtualPathRazorPageFactory.cs

@@ -32,6 +32,7 @@ public static IEnumerable<IServiceDescriptor> GetDefaultServices(IConfiguration
             var describe = new ServiceDescriber(configuration);
 
             yield return describe.Transient<IOptionsAction<MvcOptions>, MvcOptionsSetup>();
+            yield return describe.Transient<IOptionsAction<RazorViewEngineOptions>, RazorViewEngineOptionsSetup>();
 
             // Only want one ITagHelperActivator so it can cache Type activation information. Types won't conflict.
             yield return describe.Singleton<ITagHelperActivator, DefaultTagHelperActivator>();
@@ -52,7 +53,11 @@ public static IEnumerable<IServiceDescriptor> GetDefaultServices(IConfiguration
             yield return describe.Transient<IActionDiscoveryConventions, DefaultActionDiscoveryConventions>();
 
             // The host is designed to be discarded after consumption and is very inexpensive to initialize.
-            yield return describe.Transient<IMvcRazorHost, MvcRazorHost>();
+            yield return describe.Transient<IMvcRazorHost>(serviceProvider =>
+            {
+                var optionsAccessor = serviceProvider.GetService<IOptionsAccessor<RazorViewEngineOptions>>();
+                return new MvcRazorHost(optionsAccessor.Options.FileSystem);
+            });
 
             yield return describe.Singleton<ICompilationService, RoslynCompilationService>();
             yield return describe.Singleton<IRazorCompilationService, RazorCompilationService>();

src/Microsoft.AspNet.Mvc/MvcServices.cs

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using Microsoft.AspNet.FileSystems;
+using Microsoft.AspNet.Mvc.Razor;
+using Microsoft.Framework.OptionsModel;
+using Microsoft.Framework.Runtime;
+
+namespace Microsoft.AspNet.Mvc
+{
+    /// <summary>
+    /// Sets up default options for <see cref="RazorViewEngineOptions"/>.
+    /// </summary>
+    public class RazorViewEngineOptionsSetup : OptionsAction<RazorViewEngineOptions>
+    {
+        public RazorViewEngineOptionsSetup(IApplicationEnvironment applicationEnvironment)
+            : base(options => ConfigureRazor(options, applicationEnvironment))
+        {
+            Order = -1;
+        }
+
+        private static void ConfigureRazor(RazorViewEngineOptions razorOptions,
+                                           IApplicationEnvironment applicationEnvironment)
+        {
+            razorOptions.FileSystem = new PhysicalFileSystem(applicationEnvironment.ApplicationBasePath);
+        }
+    }
+}