RazorLight not working in single-file bundle #429

afucher · 2021-02-11T01:37:37Z

Describe the bug
I'm trying to use this package but when I publish using -p:PublishSingleFile=true, my application throws an error when the code touch this library.

To Reproduce
Steps to reproduce the behavior:

Build a project using RazorLight
Publish the project using the argument -p:PublishSingleFile=true, for example: dotnet publish . -c Release -r win-x64 -p:PublishSingleFile=true
Run the project, and make the application run the specific part that use RazorLight

Expected behavior
I expected that my application works.

fail: Microsoft.AspNetCore.Server.Kestrel[13]
      Connection id "0HM6E5ELP1500", Request id "0HM6E5ELP1500:00000002": An unhandled exception was thrown by the application.
      System.NotSupportedException: CodeBase is not supported on assemblies loaded from a single-file bundle.
         at System.Reflection.RuntimeAssembly.get_CodeBase()
         at Microsoft.Extensions.DependencyModel.DependencyContextLoader.GetNormalizedCodeBasePath(Assembly assembly)
         at Microsoft.Extensions.DependencyModel.DependencyContextLoader.GetDepsJsonPath(Assembly assembly)
         at Microsoft.Extensions.DependencyModel.DependencyContextLoader.LoadAssemblyContext(Assembly assembly, IDependencyContextReader reader)
         at Microsoft.Extensions.DependencyModel.DependencyContextLoader.Load(Assembly assembly)
         at Microsoft.Extensions.DependencyModel.DependencyContext.Load(Assembly assembly)
         at RazorLight.Compilation.RoslynCompilationService.GetDependencyContextCompilationOptions()
         at RazorLight.Compilation.RoslynCompilationService.EnsureOptions()
         at RazorLight.Compilation.RoslynCompilationService.get_ParseOptions()
         at RazorLight.Compilation.RoslynCompilationService.CreateSyntaxTree(SourceText sourceText)
         at RazorLight.Compilation.RoslynCompilationService.CreateCompilation(String compilationContent, String assemblyName)
         at RazorLight.Compilation.RoslynCompilationService.CompileAndEmit(IGeneratedRazorTemplate razorTemplate)
         at RazorLight.Compilation.RazorTemplateCompiler.CompileAndEmit(RazorLightProjectItem projectItem)
         at RazorLight.Compilation.RazorTemplateCompiler.OnCacheMissAsync(String templateKey)
      --- End of stack trace from previous location ---
         at RazorLight.EngineHandler.CompileTemplateAsync(String key)
         at RazorLight.EngineHandler.CompileRenderAsync[T](String key, T model, ExpandoObject viewBag)
         at aera_core.Controllers.DownloadController.geraLista(Int32 id)
         at Microsoft.AspNetCore.Mvc.Infrastructure.ActionMethodExecutor.TaskOfIActionResultExecutor.Execute(IActionResultTypeMapper mapper, ObjectMethodExecutor executor, Object controller, Object[] arguments)
         at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.<InvokeActionMethodAsync>g__Awaited|12_0(ControllerActionInvoker invoker, ValueTask`1 actionResultValueTask)
         at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.<InvokeNextActionFilterAsync>g__Awaited|10_0(ControllerActionInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)

Information (please complete the following information):

OS: Windows 10
Platform .NET 5.0.100
RazorLight version 2.0.0-rc.3
Are you using the OFFICIAL RazorLight package? Yes
Visual Studio version: N/A, I'm using Rider.

Additional context

The text was updated successfully, but these errors were encountered:

marcosdimitrio · 2021-03-04T21:34:47Z

I experienced the same problem but with a different error message.

Everything works fine locally, but when I publish it I get:

RazorLight: Can't load metadata reference from the entry assembly. Make sure 
PreserveCompilationContext is set to true in *.csproj file

Stack trace:
at RazorLight.Compilation.DefaultMetadataReferenceManager.Resolve(Assembly assembly, DependencyContext dependencyContext)
at RazorLight.Compilation.DefaultMetadataReferenceManager.Resolve(Assembly assembly)
at RazorLight.Compilation.RoslynCompilationService.EnsureOptions()
at RazorLight.Compilation.RoslynCompilationService.get_ParseOptions()
at RazorLight.Compilation.RoslynCompilationService.CreateSyntaxTree(SourceText sourceText)
at RazorLight.Compilation.RoslynCompilationService.CreateCompilation(String compilationContent, String assemblyName)
at RazorLight.Compilation.RoslynCompilationService.CompileAndEmit(IGeneratedRazorTemplate razorTemplate)
at RazorLight.Compilation.RazorTemplateCompiler.CompileAndEmit(RazorLightProjectItem projectItem)
at RazorLight.Compilation.RazorTemplateCompiler.OnCacheMissAsync(String templateKey)
--- End of stack trace from previous location ---
at RazorLight.EngineHandler.CompileTemplateAsync(String key)
at RazorLight.EngineHandler.CompileRenderAsync[T](String key, T model, ExpandoObject viewBag)
at MyApplication.MyTemplateParser.CompileAsync(TemplateDto templateDto)
...

If I set PublishSingleFile to False in the Publish Profile, then the error disappears:

<?xml version="1.0" encoding="utf-8"?>
<!--
https://go.microsoft.com/fwlink/?LinkID=208121. 
-->
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    ...
    <PublishSingleFile>False</PublishSingleFile>
    ...
  </PropertyGroup>
</Project>

Additional information

OS: Windows Server 2012, IIS version 8.5
Platform .NET 5.0
RazorLight version 2.0.0-rc.3
Are you using the OFFICIAL RazorLight package? Yes
Visual Studio version: Professional 2019 version 16.8.1.

b0wter · 2021-03-17T12:09:08Z

This also happens to me on linux (Ubuntu 20.04).

b0wter · 2021-03-17T12:12:11Z

I experienced the same problem but with a different error message.

Everything works fine locally, but when I publish it I get:

RazorLight: Can't load metadata reference from the entry assembly. Make sure 
PreserveCompilationContext is set to true in *.csproj file

Stack trace:
at RazorLight.Compilation.DefaultMetadataReferenceManager.Resolve(Assembly assembly, DependencyContext dependencyContext)
at RazorLight.Compilation.DefaultMetadataReferenceManager.Resolve(Assembly assembly)
at RazorLight.Compilation.RoslynCompilationService.EnsureOptions()
at RazorLight.Compilation.RoslynCompilationService.get_ParseOptions()
at RazorLight.Compilation.RoslynCompilationService.CreateSyntaxTree(SourceText sourceText)
at RazorLight.Compilation.RoslynCompilationService.CreateCompilation(String compilationContent, String assemblyName)
at RazorLight.Compilation.RoslynCompilationService.CompileAndEmit(IGeneratedRazorTemplate razorTemplate)
at RazorLight.Compilation.RazorTemplateCompiler.CompileAndEmit(RazorLightProjectItem projectItem)
at RazorLight.Compilation.RazorTemplateCompiler.OnCacheMissAsync(String templateKey)
--- End of stack trace from previous location ---
at RazorLight.EngineHandler.CompileTemplateAsync(String key)
at RazorLight.EngineHandler.CompileRenderAsync[T](String key, T model, ExpandoObject viewBag)
at MyApplication.MyTemplateParser.CompileAsync(TemplateDto templateDto)
...

If I set PublishSingleFile to False in the Publish Profile, then the error disappears:

<?xml version="1.0" encoding="utf-8"?>
<!--
https://go.microsoft.com/fwlink/?LinkID=208121. 
-->
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    ...
    <PublishSingleFile>False</PublishSingleFile>
    ...
  </PropertyGroup>
</Project>

Additional information

* OS: Windows Server 2012, IIS version 8.5

* Platform .NET 5.0

* RazorLight version 2.0.0-rc.3

* Are you using the OFFICIAL RazorLight package? Yes

* Visual Studio version: Professional 2019 version 16.8.1.

@marcosdimitrio :
You need to add the following into a <PropertyGroup> your csproj-file:

<PreserveCompilationContext>true</PreserveCompilationContext>

Unfortunately that will not help you fix all errors but the one you're currently encountering.
See this for details.

b0wter · 2021-03-17T19:55:40Z

I've done some more digging an am not sure that there is anything this project can do.

RazorLight.Compilation.RoslynCompilationService.GetDependencyContextCompilationOptions

calls

Microsoft.Extensions.DependencyModel.DependencyContext.Load

which calls

Microsoft.Extensions.DependencyModel.DependencyContextLoader.GetDepsJsonPath

That method calls

string assemblyLocation = assembly.Location;

which will always set null because there is no meaningful value to set in a single-file bundle as it can no longer point to a filename.
(See the file here)
Since no valid value is set the code falls back to calling assembly.CodeBase which suffers the same problem but will raise an exception instead of returning null.

marcosdimitrio · 2021-03-28T20:55:27Z

@marcosdimitrio :
You need to add the following into a <PropertyGroup> your csproj-file:
<PreserveCompilationContext>true</PreserveCompilationContext>
Unfortunately that will not help you fix all errors but the one you're currently encountering.
See this for details.

I did include it in both projects (webapi and razorlight project), it only worked when PublishSingleFile is set to false. When I set PublishSingleFile to true it stops working.

toddams · 2021-04-06T08:47:22Z

RazorLight indeed does not work in a single-file bundle yet.
This is relatively new feature and nobody did any work to support that. But it should be supported, imo

toddams · 2021-04-06T08:49:36Z

dotnet/runtime#35493

FLAMESpl · 2021-11-12T17:57:43Z

Hi @toddams, is there any work going on in the matter of supporting single-file bundles?

akhanalcs · 2023-09-07T15:20:58Z

Any update on this? I'm affected by this issue.

iray1024 · 2024-09-03T05:33:22Z

Any update on this? I'm affected by this issue.

brodrigz · 2024-10-23T22:19:03Z

Does this makes unfeasible to use this package in a dotnet cli tool?

jzabroski · 2024-10-24T13:37:36Z

@brodrigz Why would you use this package in a dotnet cli tool? dotnet cli is NOT for production use - even Microsoft says so. Using the package in a dotnet cli tool requires installing the SDK, vs. only the runtime. You should NOT install an SDK on a production machine.

brodrigz · 2024-10-24T16:57:37Z

@brodrigz Why would you use this package in a dotnet cli tool? dotnet cli is NOT for production use - even Microsoft says so. Using the package in a dotnet cli tool requires installing the SDK, vs. only the runtime. You should NOT install an SDK on a production machine.

I wouldn't, I want to use this for development only, but packaged as a .nugget package

brodrigz · 2024-10-28T00:19:48Z

@brodrigz Why would you use this package in a dotnet cli tool? dotnet cli is NOT for production use - even Microsoft says so. Using the package in a dotnet cli tool requires installing the SDK, vs. only the runtime. You should NOT install an SDK on a production machine.

I wouldn't, I want to use this for development only, but packaged as a .nugget package

I had previously thought that dotnet tools always got packed as a single file, they don't. Currently using this package on a dotnet tool and it works perfectly.

toddams added the feature-proposal label Apr 6, 2021

LoopedBard3 mentioned this issue Aug 17, 2023

Daily Perf Index is not updating dotnet/performance#3278

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RazorLight not working in single-file bundle #429

RazorLight not working in single-file bundle #429

afucher commented Feb 11, 2021

marcosdimitrio commented Mar 4, 2021

b0wter commented Mar 17, 2021

b0wter commented Mar 17, 2021

b0wter commented Mar 17, 2021

marcosdimitrio commented Mar 28, 2021

toddams commented Apr 6, 2021

toddams commented Apr 6, 2021

FLAMESpl commented Nov 12, 2021

akhanalcs commented Sep 7, 2023

iray1024 commented Sep 3, 2024

brodrigz commented Oct 23, 2024

jzabroski commented Oct 24, 2024

brodrigz commented Oct 24, 2024

brodrigz commented Oct 28, 2024

RazorLight not working in single-file bundle #429

RazorLight not working in single-file bundle #429

Comments

afucher commented Feb 11, 2021

marcosdimitrio commented Mar 4, 2021

b0wter commented Mar 17, 2021

b0wter commented Mar 17, 2021

b0wter commented Mar 17, 2021

marcosdimitrio commented Mar 28, 2021

toddams commented Apr 6, 2021

toddams commented Apr 6, 2021

FLAMESpl commented Nov 12, 2021

akhanalcs commented Sep 7, 2023

iray1024 commented Sep 3, 2024

brodrigz commented Oct 23, 2024

jzabroski commented Oct 24, 2024

brodrigz commented Oct 24, 2024

brodrigz commented Oct 28, 2024