When Targeting .NET Framework TFM ASP.NET Core Module gets added needlessly to Web.config.

AraHaan commented 1 year ago

Describe the bug

Let's say for example you have a project that is the following:

Non-SDK Style
Targets .NET Framework
References ASP.NET and uses Razor pages
Uses roslyn and on publish copies static content files to bin\publish, build outputs to bin\publish\bin and roslyn to bin\publish\bin\roslyn Along with the Web.config and other important files transformed to the bin\publish.

Now when you do an in place migration to SDK Style (without changing framework) and carefully made the needed changes to make the project compile (the migration tool sets output to Exe and nukes some important properties so reverting those will fix it) you will notice the following:

in Web.config:
- The aspNetCore handler is added when it should not be when targeting ASP.NET Framework from Sdk.Web (this should be patched in the needed transform file in that SDK to condition to exclude .NET Framework.
- that handler is then used in the resulting transformed file (again that should be conditioned out for when targeting .NET Framework in that SDK)
That SDK wrongfully copies the build outputs to bin\publish and not bin\publish\bin for .NET Framework targets. Also even when referencing the nuget package "Microsoft.CodeDom.Providers.DotNetCompilerPlatform" it still refuses to copy roslyn into the bin\roslyn folder within the publish directory and instead outputs .NET SDK warnings about RoslynCompilerFiles being recursively called.
setting TransformWebConfigEnabled to false does not affect it at all either.

Things I had to do after migration:

Add back the following to the csproj:

<OutputType>Library</OutputType>
<AppDesignerFolder>Properties</AppDesignerFolder>
<MvcBuildViews>false</MvcBuildViews>
<UseIISExpress>true</UseIISExpress>
<Use64BitIISExpress />
<IISExpressSSLPort>44372</IISExpressSSLPort> <!-- Any port will do. -->
<IISExpressAnonymousAuthentication />
<IISExpressWindowsAuthentication />
<IISExpressUseClassicPipelineMode />
<UseGlobalApplicationHostFile />

Ensure these are the nuget packages in the csproj:

<PackageReference Include="Antlr" Version="3.5.0.2" />
<PackageReference Include="EntityFramework" Version="6.4.4" />
<PackageReference Include="Microsoft.AspNet.Identity.Core" Version="2.2.4" />
<PackageReference Include="Microsoft.AspNet.Identity.EntityFramework" Version="2.2.4" />
<PackageReference Include="Microsoft.AspNet.Identity.Owin" Version="2.2.4" />
<PackageReference Include="Microsoft.AspNet.Mvc" Version="5.2.9" />
<PackageReference Include="Microsoft.AspNet.Razor" Version="3.2.9" />
<PackageReference Include="Microsoft.AspNet.Web.Optimization" Version="1.1.3" />
<PackageReference Include="Microsoft.AspNet.WebApi" Version="5.2.9" />
<PackageReference Include="Microsoft.AspNet.WebApi.Client" Version="5.2.9" />
<PackageReference Include="Microsoft.AspNet.WebApi.Core" Version="5.2.9" />
<PackageReference Include="Microsoft.AspNet.WebApi.WebHost" Version="5.2.9" />
<PackageReference Include="Microsoft.AspNet.WebPages" Version="3.2.9" />
<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="7.0.0" />
<PackageReference Include="Microsoft.CodeDom.Providers.DotNetCompilerPlatform" Version="4.1.0" />
<PackageReference Include="Microsoft.Owin" Version="4.2.2" />
<PackageReference Include="Microsoft.Owin.Host.SystemWeb" Version="4.2.2" />
<PackageReference Include="Microsoft.Owin.Security" Version="4.2.2" />
<PackageReference Include="Microsoft.Owin.Security.Cookies" Version="4.2.2" />
<PackageReference Include="Microsoft.Owin.Security.Facebook" Version="4.2.2" />
<PackageReference Include="Microsoft.Owin.Security.Google" Version="4.2.2" />
<PackageReference Include="Microsoft.Owin.Security.MicrosoftAccount" Version="4.2.2" />
<PackageReference Include="Microsoft.Owin.Security.OAuth" Version="4.2.2" />
<PackageReference Include="Microsoft.Owin.Security.Twitter" Version="4.2.2" />
<PackageReference Include="Microsoft.Web.Infrastructure" Version="2.0.1" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
<PackageReference Include="Owin" Version="1.0" />
<PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
<PackageReference Include="System.Runtime.InteropServices.RuntimeInformation" Version="4.3.0" />
<PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.4" />
<PackageReference Include="WebGrease" Version="1.6.0" />

The diff between the Web.config files (yellow means added from the .NET SDK's Sdk.Web):

To Reproduce

create a non-SDK style .NET Framework project (.NET Framework 4.7.2) that is for Web (MFC with Razor and Identity with EF6)
Do the above as described in the bug section.
Notice the problems I am facing.

Exceptions (if any)

No exceptions, just that I expect the publish directory to match for a project with no difference in framework, just the style of csproj (SDK vs non-SDK style for an important reason which is IIS which probably show exceptions when trying to use any of the razor pages (they are all razor pages cshtml files) with it not being able to find roslyn).

Further technical details

dotnet --info:


.NET SDK:
Version:   8.0.100-preview.7.23376.3
Commit:    daebeea8ea

Runtime Environment: OS Name: Windows OS Version: 10.0.22631 OS Platform: Windows RID: win10-x64 Base Path: C:\Program Files\dotnet\sdk\8.0.100-preview.7.23376.3\

.NET workloads installed: There are no installed workloads to display.

Host: Version: 8.0.0-preview.7.23375.6 Architecture: x64 Commit: 65b696cf5e RID: win-x64

.NET SDKs installed: 6.0.413 [C:\Program Files\dotnet\sdk] 7.0.100-rc.2.22477.23 [C:\Program Files\dotnet\sdk] 7.0.110 [C:\Program Files\dotnet\sdk] 8.0.100-preview.7.23376.3 [C:\Program Files\dotnet\sdk]

.NET runtimes installed: Microsoft.AspNetCore.App 6.0.20 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 6.0.21 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 7.0.0-rc.2.22476.2 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 7.0.9 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 7.0.10 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 8.0.0-preview.7.23375.9 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.NETCore.App 6.0.20 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 6.0.21 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 7.0.0-rc.2.22472.3 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 7.0.9 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 7.0.10 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 8.0.0-preview.7.23375.6 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.WindowsDesktop.App 6.0.20 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 6.0.21 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 7.0.0-rc.2.22472.13 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 7.0.9 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 7.0.10 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 8.0.0-preview.7.23376.1 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

Other architectures found: x86 [C:\Program Files (x86)\dotnet] registered at [HKLM\SOFTWARE\dotnet\Setup\InstalledVersions\x86\InstallLocation]

Environment variables: Not set

global.json file: Not found

Learn more: https://aka.ms/dotnet/info

Download .NET: https://aka.ms/dotnet/download


- The IDE: Visual Studio Enterprise 2022 v17.8 Preview 1

AraHaan commented 1 year ago

While this is similar to https://github.com/dotnet/sdk/issues/462, I need the handlers from before the Web.Sdk inserted the additional handler which is rather problematic.

AraHaan commented 1 year ago

Looks like the real problem is the task assembly itself, disabling that entirely does not run transforms for Web.Debug.config and Web.Release.config when needed.

https://github.com/dotnet/sdk/blob/9c2f7f17ca4e9592d7418279ea3079ebc3f573f8/src/WebSdk/Publish/Tasks/WebConfigTransform.cs

AraHaan commented 1 year ago

Hmm to me it looks like all that file is doing is setting up the 2 aspNetCore elements in the xml and then adding them to the web.config before finally adding the project guid at the bottom. Now to find where it would transform Web.Debug.config and Web.Release.config.

dotnet / sdk