Roslyn: Adding a reference to Microsoft.CodeAnalysis.CSharp.Scripting to an ASP.NET Core Web Application breaks Razor views.

Created on 14 Jul 2017 · 20Comments · Source: dotnet/roslyn

Version Used:
.NETCore.App 1.1.2 and 2.0 Preview 2

Steps to Reproduce:
Add reference Microsoft.CodeAnalysis.CSharp.Scripting (any 2.0 version) to an ASP.NET Core Web Application

Expected Behavior: Razor views still render correctly

Actual Behavior: System.ArgumentException: Must include private members unless emitting a ref assembly.

Parameter name: IncludePrivateMembers
   at Microsoft.CodeAnalysis.Compilation.Emit(Stream peStream, Stream pdbStream, Stream xmlDocumentationStream, Stream win32Resources, IEnumerable`1 manifestResources, EmitOptions options, IMethodSymbol debugEntryPoint, Stream sourceLinkStream, IEnumerable`1 embeddedTexts, Stream metadataPEStream, CancellationToken cancellationToken)
   at Microsoft.AspNetCore.Mvc.Razor.Internal.DefaultRoslynCompilationService.Compile(RelativeFileInfo fileInfo, String compilationContent)
   at Microsoft.AspNetCore.Mvc.Razor.Internal.RazorCompilationService.Compile(RelativeFileInfo file)
   at Microsoft.AspNetCore.Mvc.Razor.Internal.CompilerCache.CreateCacheEntry(String relativePath, String normalizedPath, Func`2 compile)
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at Microsoft.AspNetCore.Mvc.Razor.Internal.CompilerCache.GetOrAdd(String relativePath, Func`2 compile)
   at Microsoft.AspNetCore.Mvc.Razor.Internal.DefaultRazorPageFactoryProvider.CreateFactory(String relativePath)
   at Microsoft.AspNetCore.Mvc.Razor.RazorViewEngine.CreateCacheResult(HashSet`1 expirationTokens, String relativePath, Boolean isMainPage)
   at Microsoft.AspNetCore.Mvc.Razor.RazorViewEngine.OnCacheMiss(ViewLocationExpanderContext expanderContext, ViewLocationCacheKey cacheKey)
   at Microsoft.AspNetCore.Mvc.Razor.RazorViewEngine.LocatePageFromViewLocations(ActionContext actionContext, String pageName, Boolean isMainPage)
   at Microsoft.AspNetCore.Mvc.Razor.RazorViewEngine.FindView(ActionContext context, String viewName, Boolean isMainPage)
   at Microsoft.AspNetCore.Mvc.ViewEngines.CompositeViewEngine.FindView(ActionContext context, String viewName, Boolean isMainPage)
   at Microsoft.AspNetCore.Mvc.ViewFeatures.Internal.ViewResultExecutor.FindView(ActionContext actionContext, ViewResult viewResult)
   at Microsoft.AspNetCore.Mvc.ViewResult.<ExecuteResultAsync>d__26.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.<InvokeResultAsync>d__30.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.<InvokeNextResultFilterAsync>d__28.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.Rethrow(ResultExecutedContext context)
   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)
   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.<InvokeNextResourceFilter>d__22.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.Rethrow(ResourceExecutedContext context)
   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)
   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.<InvokeAsync>d__20.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at Microsoft.AspNetCore.Builder.RouterMiddleware.<Invoke>d__4.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.<Invoke>d__7.MoveNext()

Area-Compilers Bug Resolution-Fixed Tenet-Compatibility

Source

DAlumbaugh

👍5

Most helpful comment

I had the same problem with Microsoft.CodeAnalysis.CSharp v2.3.1. Rolling back to v2.2.0 worked.

danielcrabtree on 22 Jul 2017

👍3

All 20 comments

Tagging @tmat

Pilchie on 14 Jul 2017

I'm seeing this issue specifically when I update

Microsoft.CodeAnalysis.CSharp to version 2.3.0

Version 2.2.0 works fine for me

PureWeen on 14 Jul 2017

👍3

Interesting. The difference between 2.2.0 and 2.3.0 is that the latter is pure netstandard 1.3 package with no fallback. Not sure why would that be significant though.

tmat on 15 Jul 2017

I see the same issue as @PureWeen.
Looking at the deps.json after upgrading to Microsoft.CodeAnalysis.CSharp 2.3.0 it also updates Microsoft.CodeAnalysis.Common to 2.3.0. These two are the only packages that are different

If I make both of these 2.2.0 then the issue goes away.

bcrobinson on 17 Jul 2017

Same problem. Rolled back, and all was good.

kieronlanning on 18 Jul 2017

Have the same problem with TargetFramework=net462

codeape2 on 21 Jul 2017

I had the same problem with Microsoft.CodeAnalysis.CSharp v2.3.1. Rolling back to v2.2.0 worked.

danielcrabtree on 22 Jul 2017

👍3

I have the same problem targeting .NET Core 1.1 (no other targets) and .NET Core 2.0 Preview 2 (final).

This issue is in v2.3.0 and v2.3.1.

kieronlanning on 23 Jul 2017

Same problem. And same solving - going back to 2.2.0

ignatandrei on 2 Aug 2017

I have just tried with VS 15.3.0 Preview 7.0, Microsoft.CodeAnalysis.Scripting package v2.3.1 and Web App targeting netcoreapp2.0: adding a package reference, evaluating a script in .cs.html file and printing out the result works well.

<p>@Microsoft.CodeAnalysis.CSharp.Scripting.CSharpScript.RunAsync("1+1").Result.ReturnValue</p>

Can anyone who can reproduce the issue share a project where it's broken?

tmat on 2 Aug 2017

RoslynExceptionCodeAnalysisScripting.zip

I'm running VS 15.2 and don't have any netcore 2.0 bits installed so it's hard to say if your preview bits are what's making it better

but the attached project is giving me the exception
All I did with this was add a site from the "Add new site" template and then added the packages.

It compiles but just crashes on startup for me

System.ArgumentException: Must include private members unless emitting a ref assembly.

Parameter name: IncludePrivateMembers

   at Microsoft.CodeAnalysis.Compilation.Emit(Stream peStream, Stream pdbStream, Stream xmlDocumentationStream, Stream win32Resources, IEnumerable`1 manifestResources, EmitOptions options, IMethodSymbol debugEntryPoint, Stream sourceLinkStream, IEnumerable`1 embeddedTexts, Stream metadataPEStream, CancellationToken cancellationToken)

   at Microsoft.AspNetCore.Mvc.Razor.Internal.DefaultRoslynCompilationService.Compile(RelativeFileInfo fileInfo, String compilationContent)

   at Microsoft.AspNetCore.Mvc.Razor.Internal.RazorCompilationService.Compile(RelativeFileInfo file)

   at Microsoft.AspNetCore.Mvc.Razor.Internal.CompilerCache.CreateCacheEntry(String relativePath, String normalizedPath, Func`2 compile)

--- End of stack trace from previous location where exception was thrown ---

   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()

   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)

   at Microsoft.AspNetCore.Mvc.Razor.Internal.CompilerCache.GetOrAdd(String relativePath, Func`2 compile)

   at Microsoft.AspNetCore.Mvc.Razor.Internal.DefaultRazorPageFactoryProvider.CreateFactory(String relativePath)

   at Microsoft.AspNetCore.Mvc.Razor.RazorViewEngine.CreateCacheResult(HashSet`1 expirationTokens, String relativePath, Boolean isMainPage)

   at Microsoft.AspNetCore.Mvc.Razor.RazorViewEngine.OnCacheMiss(ViewLocationExpanderContext expanderContext, ViewLocationCacheKey cacheKey)

   at Microsoft.AspNetCore.Mvc.Razor.RazorViewEngine.LocatePageFromViewLocations(ActionContext actionContext, String pageName, Boolean isMainPage)

   at Microsoft.AspNetCore.Mvc.Razor.RazorViewEngine.FindView(ActionContext context, String viewName, Boolean isMainPage)

   at Microsoft.AspNetCore.Mvc.ViewEngines.CompositeViewEngine.FindView(ActionContext context, String viewName, Boolean isMainPage)

   at Microsoft.AspNetCore.Mvc.ViewFeatures.Internal.ViewResultExecutor.FindView(ActionContext actionContext, ViewResult viewResult)

   at Microsoft.AspNetCore.Mvc.ViewResult.<ExecuteResultAsync>d__26.MoveNext()

--- End of stack trace from previous location where exception was thrown ---

   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()

   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)

   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.<InvokeResultAsync>d__30.MoveNext()

--- End of stack trace from previous location where exception was thrown ---

   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()

   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)

   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.<InvokeNextResultFilterAsync>d__28.MoveNext()

--- End of stack trace from previous location where exception was thrown ---

   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()

   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.Rethrow(ResultExecutedContext context)

   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)

   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.<InvokeNextResourceFilter>d__22.MoveNext()

--- End of stack trace from previous location where exception was thrown ---

   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()

   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.Rethrow(ResourceExecutedContext context)

   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)

   at Microsoft.AspNetCore.Mvc.Internal.ControllerActionInvoker.<InvokeAsync>d__20.MoveNext()

--- End of stack trace from previous location where exception was thrown ---

   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()

   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)

   at Microsoft.AspNetCore.Builder.RouterMiddleware.<Invoke>d__4.MoveNext()

--- End of stack trace from previous location where exception was thrown ---

   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()

   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)

   at Microsoft.VisualStudio.Web.BrowserLink.BrowserLinkMiddleware.<ExecuteWithFilter>d__7.MoveNext()

--- End of stack trace from previous location where exception was thrown ---

   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()

   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)

   at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.<Invoke>d__7.MoveNext()

PureWeen on 2 Aug 2017

@tmat looks like this is caused by this PR https://github.com/dotnet/roslyn/pull/19478/files#diff-9ab09861519e8dfab2c0787cad46ab15R2089 and a stricter validation added there

I bet it would work if the problematic type Microsoft.AspNetCore.Mvc.Razor.Internal.DefaultRoslynCompilationService did something like var emitOptions = new EmitOptions().WithEmitMetadataOnly(false).WithIncludePrivateMembers(true)

FWIW, if you want a repro, get the ScriptingInWebAppDemo project from https://github.com/filipw/csharp-scripting-demos/tree/master/ScriptingInWebAppDemo, start the server and navigate to root.

filipw on 7 Aug 2017

👍1

@filipw Thanks, I can reproduce now.

tmat on 7 Aug 2017

@jaredpar @jcouv This is caused by the breaking change in the default parameter value in EmitOptions ctor: bool includePrivateMembers = false.

tmat on 7 Aug 2017

Thanks for the ping @tmat. I think I let one of your emails on this slip by when I came back from trip.
I'll stop by to discuss.

jcouv on 7 Aug 2017

Assigned the issue (and the ask-mode PR) to @jaredpar for follow-up while I'm away. Thanks!

jcouv on 9 Aug 2017

Microsoft.CodeAnalysis.CSharp 2.2.0 is not compatible with EF Core 2.0 ? Any solution

ntgnst on 10 Aug 2017

Mitigation checked into 15.4 preview 3.

jcouv on 1 Sep 2017

👍2

I just hit this. I see a fix was included in the tooling for 15.4, but will a new set of packages also go out to NuGet soon? I'm consuming Razor and Roslyn as libraries.