Obsolete RazorRuntimeCompilation (#62793)

Author: BrennanConroy

src/Mvc/Mvc.Razor.RuntimeCompilation/src/AssemblyPartExtensions.cs

@@ -9,6 +9,7 @@ namespace Microsoft.AspNetCore.Mvc.ApplicationParts;
 /// <summary>
 /// Static class that adds methods to <see cref="AssemblyPart"/>.
 /// </summary>
+[Obsolete("Razor runtime compilation is obsolete and is not recommended for production scenarios. For production scenarios, use the default build time compilation. For development scenarios, use Hot Reload instead. For more information, visit https://aka.ms/aspnet/deprecate/003.", DiagnosticId = "ASPDEPR003")]
 public static class AssemblyPartExtensions
 {
     /// <inheritdoc />

src/Mvc/Mvc.Razor.RuntimeCompilation/src/DependencyInjection/MvcRazorRuntimeCompilationOptionsSetup.cs

@@ -6,7 +6,9 @@
 
 namespace Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation;
 
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
 internal sealed class MvcRazorRuntimeCompilationOptionsSetup : IConfigureOptions<MvcRazorRuntimeCompilationOptions>
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
 {
     private readonly IWebHostEnvironment _hostingEnvironment;
 
@@ -15,7 +17,9 @@ public MvcRazorRuntimeCompilationOptionsSetup(IWebHostEnvironment hostingEnviron
         _hostingEnvironment = hostingEnvironment ?? throw new ArgumentNullException(nameof(hostingEnvironment));
     }
 
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
     public void Configure(MvcRazorRuntimeCompilationOptions options)
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
     {
         ArgumentNullException.ThrowIfNull(options);
 

src/Mvc/Mvc.Razor.RuntimeCompilation/src/DependencyInjection/RazorRuntimeCompilationMvcBuilderExtensions.cs

@@ -8,6 +8,7 @@ namespace Microsoft.Extensions.DependencyInjection;
 /// <summary>
 /// Static class that adds razor compilation extension methods.
 /// </summary>
+[Obsolete("Razor runtime compilation is obsolete and is not recommended for production scenarios. For production scenarios, use the default build time compilation. For development scenarios, use Hot Reload instead. For more information, visit https://aka.ms/aspnet/deprecate/003.", DiagnosticId = "ASPDEPR003")]
 public static class RazorRuntimeCompilationMvcBuilderExtensions
 {
     /// <summary>

src/Mvc/Mvc.Razor.RuntimeCompilation/src/DependencyInjection/RazorRuntimeCompilationMvcCoreBuilderExtensions.cs

@@ -20,6 +20,7 @@ namespace Microsoft.Extensions.DependencyInjection;
 /// <summary>
 /// Static class that adds razor runtime compilation extension methods.
 /// </summary>
+[Obsolete("Razor runtime compilation is obsolete and is not recommended for production scenarios. For production scenarios, use the default build time compilation. For development scenarios, use Hot Reload instead. For more information, visit https://aka.ms/aspnet/deprecate/003.", DiagnosticId = "ASPDEPR003")]
 public static class RazorRuntimeCompilationMvcCoreBuilderExtensions
 {
     /// <summary>

src/Mvc/Mvc.Razor.RuntimeCompilation/src/FileProviderRazorProjectFileSystem.cs

@@ -34,7 +34,9 @@ public override RazorProjectItem GetItem(string path, string? fileKind)
         path = NormalizeAndEnsureValidPath(path);
         var fileInfo = FileProvider.GetFileInfo(path);
 
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
         return new FileProviderRazorProjectItem(fileInfo, basePath: string.Empty, filePath: path, root: _hostingEnvironment.ContentRootPath, fileKind);
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
     }
 
     public override IEnumerable<RazorProjectItem> EnumerateItems(string path)
@@ -63,7 +65,9 @@ private IEnumerable<RazorProjectItem> EnumerateFiles(IDirectoryContents director
                 {
                     var filePath = prefix + "/" + fileInfo.Name;
 
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
                     yield return new FileProviderRazorProjectItem(fileInfo, basePath, filePath: filePath, root: _hostingEnvironment.ContentRootPath);
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
                 }
             }
         }

src/Mvc/Mvc.Razor.RuntimeCompilation/src/FileProviderRazorProjectItem.cs

@@ -9,6 +9,7 @@ namespace Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation;
 /// <summary>
 /// A file provider <see cref="RazorProjectItem"/>.
 /// </summary>
+[Obsolete("Razor runtime compilation is obsolete and is not recommended for production scenarios. For production scenarios, use the default build time compilation. For development scenarios, use Hot Reload instead. For more information, visit https://aka.ms/aspnet/deprecate/003.", DiagnosticId = "ASPDEPR003")]
 public class FileProviderRazorProjectItem : RazorProjectItem
 {
     private readonly string _root;

src/Mvc/Mvc.Razor.RuntimeCompilation/src/MvcRazorRuntimeCompilationOptions.cs

@@ -10,6 +10,7 @@ namespace Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation;
 /// <summary>
 /// Used to configure razor compilation.
 /// </summary>
+[Obsolete("Razor runtime compilation is obsolete and is not recommended for production scenarios. For production scenarios, use the default build time compilation. For development scenarios, use Hot Reload instead. For more information, visit https://aka.ms/aspnet/deprecate/003.", DiagnosticId = "ASPDEPR003")]
 public class MvcRazorRuntimeCompilationOptions
 {
     /// <summary>

src/Mvc/Mvc.Razor.RuntimeCompilation/src/RazorReferenceManager.cs

@@ -14,14 +14,18 @@ internal class RazorReferenceManager
 #pragma warning restore CA1852 // Seal internal types
 {
     private readonly ApplicationPartManager _partManager;
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
     private readonly MvcRazorRuntimeCompilationOptions _options;
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
     private object _compilationReferencesLock = new object();
     private bool _compilationReferencesInitialized;
     private IReadOnlyList<MetadataReference>? _compilationReferences;
 
     public RazorReferenceManager(
         ApplicationPartManager partManager,
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
         IOptions<MvcRazorRuntimeCompilationOptions> options)
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
     {
         _partManager = partManager;
         _options = options.Value;

src/Mvc/Mvc.Razor.RuntimeCompilation/src/RazorRuntimeCompilationHostingStartup.cs

@@ -11,6 +11,8 @@ internal sealed class RazorRuntimeCompilationHostingStartup : IHostingStartup
     public void Configure(IWebHostBuilder builder)
     {
         // Add Razor services
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
         builder.ConfigureServices(RazorRuntimeCompilationMvcCoreBuilderExtensions.AddServices);
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
     }
 }

src/Mvc/Mvc.Razor.RuntimeCompilation/src/RuntimeCompilationFileProvider.cs

@@ -8,10 +8,14 @@ namespace Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation;
 
 internal sealed class RuntimeCompilationFileProvider
 {
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
     private readonly MvcRazorRuntimeCompilationOptions _options;
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
     private IFileProvider? _compositeFileProvider;
 
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
     public RuntimeCompilationFileProvider(IOptions<MvcRazorRuntimeCompilationOptions> options)
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
     {
         ArgumentNullException.ThrowIfNull(options);
 
@@ -31,15 +35,19 @@ public IFileProvider FileProvider
         }
     }
 
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
     private static IFileProvider GetCompositeFileProvider(MvcRazorRuntimeCompilationOptions options)
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
     {
         var fileProviders = options.FileProviders;
         if (fileProviders.Count == 0)
         {
+#pragma warning disable ASPDEPR003 // Type or member is obsolete
             var message = Resources.FormatFileProvidersAreRequired(
                 typeof(MvcRazorRuntimeCompilationOptions).FullName,
                 nameof(MvcRazorRuntimeCompilationOptions.FileProviders),
                 typeof(IFileProvider).FullName);
+#pragma warning restore ASPDEPR003 // Type or member is obsolete
             throw new InvalidOperationException(message);
         }
         else if (fileProviders.Count == 1)