toddams/RazorLight

System.UriFormatException: Invalid URI: The hostname could not be parsed

SerhiyBalan opened this issue · 26 comments

Describe the bug
RazorLight works perfectly on my laptop (Windows).
It also works perfectly at Azure Functions (Windows) (service functions to do various tasks)

However I have issues at Azure Application Service (Linux): (main application backend)

  • Versions 2.0.0-rc.1 - 2.0.0-rc.3 works well without issues!
  • Versions 2.0.0-rc.4, 2.0.0-rc.6 and 2.0.0 raise following exception:

Invalid URI: The hostname could not be parsed.

Stack Trace:

   at System.Uri.CreateThis(String uri, Boolean dontEscape, UriKind uriKind)
   at System.Uri..ctor(String uriString)
   at System.UriBuilder..ctor(String uri)
   at RazorLight.Compilation.DefaultAssemblyDirectoryFormatter.GetAssemblyDirectory(Assembly assembly)
   at RazorLight.Compilation.DefaultMetadataReferenceManager.<Resolve>b__12_2(Assembly p)
   at System.Linq.Enumerable.SelectArrayIterator`2.ToList()
   at System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source)
   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.CompileAndEmitAsync(RazorLightProjectItem projectItem)
   at RazorLight.Compilation.RazorTemplateCompiler.OnCacheMissAsync(String templateKey)
   at RazorLight.EngineHandler.CompileTemplateAsync(String key)
   at RazorLight.EngineHandler.CompileRenderAsync[T](String key, T model, ExpandoObject viewBag)
   at ... RazorEngineService.cs:line 90

To Reproduce
Create an account at Azure (perhaps it allows to do that using a free tier)
Create a new Application Service and select Linux as OS:

зображення

I use following source codes (cleaned from logging stuff and unnecessary methods)

public class RazorEngineService : IHtmlTemplateRendererService
{
	private static readonly IRazorLightEngine EngineService;

	static RazorEngineService()
	{
		EngineService = new RazorLightEngineBuilder()
			.UseEmbeddedResourcesProject(typeof(RazorEngineService))
			.SetOperatingAssembly(typeof(RazorEngineService).Assembly)
			.UseMemoryCachingProvider()
			.Build();
	}
	
	public async Task<string> GenerateCodeAsync<T>(string path, T model, string key)
	{
		var cacheResult = EngineService.Handler.Cache.RetrieveTemplate(key);
		if (cacheResult.Success)
		{
			// report is already compiled, render using a cache
			var templatePage = cacheResult.Template.TemplatePageFactory();
			return await EngineService.RenderTemplateAsync(templatePage, model);
		}

		return await EngineService.CompileRenderAsync(path, model);
	}
}

...

services.AddScoped<IHtmlTemplateRendererService, RazorEngineService>();

Expected behavior
It shouldn't fail :)
It works well on 2.0.0-rc.3 and earlier. It doesn't work after that

Information (please complete the following information):

  • OS: Unix 4/5
  • Platform: .NET Core 3.1
  • RazorLight version: 2.0.0 (final)
  • Are you using the OFFICIAL RazorLight package? Yes
  • Rider 2022.1.1

Production environment (gathered from Azure Kudu):

OS version: Unix 5.4.0.1063
64 bit system: True
64 bit process: True
CLR version: 3.1.22

Development environment (gathered from Azure Kudu):

OS version: Unix 4.15.0.162
64 bit system: True
64 bit process: True
CLR version: 3.1.22

Additional context
For now, I have to use 2.0.0-rc.3 until this issue is resolved in the latest RazorLight package
I can test any internal builds at the Azure development environment - just let me know :)

According to the suggestion from the separate issue, I've tried to replace a formatter with custom one

        public class PassthroughAssemblyDirectoryFormatter : IAssemblyDirectoryFormatter
        {
            public string GetAssemblyDirectory(Assembly assembly)
            {
                return assembly.Location;
            }
        }

.... 
        services.Replace(ServiceDescriptor.Transient<IAssemblyDirectoryFormatter, PassthroughAssemblyDirectoryFormatter>());`

It didn't help. I still receive the same error

I also faced the same issue these days. My environment is Linux VM on Azure, and the application is launching inside a Docker container.

This can be reproduced locally just by running in a web api that runs in a docker container running linux - standard ms asp.net 6 image. We had to roll back versions for now.

I'm also facing the same issue.

I'll add a direct unit test for this class.

Ok, got it to reproduce :D

It failed on netcoreapp3.1, net5.0, net6.0, so I think the issue is rather systemic with Linux, and not tied to a particular Linux OS or .NET Core version.

https://github.com/toddams/RazorLight/runs/6516867018?check_suite_focus=true#step:9:472

It didn't help. I still receive the same error

@SerhiyBalan ...That doesn't make a lot of sense! How can it produce the same error when the stack trace isn't calling the same code path? It definitely has to fail at a different place.

        public class PassthroughAssemblyDirectoryFormatter : IAssemblyDirectoryFormatter
        {
            public string GetAssemblyDirectory(Assembly assembly)
            {
                return assembly.Location;
            }
        }

I think I had a typo in my proposed solution - it should be:

         public class PassthroughAssemblyDirectoryFormatter : IAssemblyDirectoryFormatter
         {
            public string GetAssemblyDirectory(Assembly assembly)
            {
                return Path.GetDirectoryName(assembly.Location);
            }
         }

@SerhiyBalan I think we almost had the right fix last week. See my latest checkin in master branch (same as code above).

I think the reason you had the same exception is because you modified the ServiceCollection after you built the service provider. The moment you build a service provider, you've taken a snapshot of the universe of types. I recommend reading Microsoft's dependency injection guidelines, in particular https://docs.microsoft.com/en-us/dotnet/core/extensions/dependency-injection-guidelines#recommendations

@jzabroski Thank you John for keeping assisting!

For some unknown reason, both PassthroughAssemblyDirectoryFormatters do not work for me.
I've tried to register them in Startup.cs, so the place should be the correct one

I've opened RazorLight sources (master branch), my Rider IDE doesn't show usages of a constructor with IAssemblyDirectoryFormatter
зображення

My application never goes to that constructor, it ignores my customized formatter. A debugger stops in an original formatter implementation

Well, on Monday I will try to deploy customized builds of RazorLight to the Azure environment and try to find some workarounds

@jzabroski I've tried to deploy several builds - referencing original RazorLight source codes (actual version of master branch, comit

Build 1: DefaultAssemblyDirectoryFormatter with UriBuilder
UriBuilder uri = new UriBuilder(assembly.Location);

it fails with "Invalid URI: The hostname could not be parsed."

Build 2 (DefaultAssemblyDirectoryFormatter with Path.GetDirectoryName):
Path.GetDirectoryName(assembly.Location)

DefaultAssemblyDirectoryFormatter returns "/usr/share/dotnet/shared/Microsoft.NETCore.App/3.1.23"

After that it fails in DefaultMetadataReferenceManager with an exception

Access to the path '/usr/share/dotnet/shared/Microsoft.NETCore.App/3.1.23' is denied.

   at Microsoft.Win32.SafeHandles.SafeFileHandle.Open(String path, OpenFlags flags, Int32 mode)
   at System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share, Int32 bufferSize, FileOptions options)
   at System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share)
   at System.IO.File.OpenRead(String path)
   at RazorLight.Compilation.DefaultMetadataReferenceManager.Resolve(Assembly assembly, DependencyContext dependencyContext) in D:\SourceCodes\Temp\RazorLight\src\RazorLight\Compilation\DefaultMetadataReferenceManager.cs:line 76
   at RazorLight.Compilation.DefaultMetadataReferenceManager.Resolve(Assembly assembly) in D:\SourceCodes\Temp\RazorLight\src\RazorLight\Compilation\DefaultMetadataReferenceManager.cs:line 46
   at RazorLight.Compilation.RoslynCompilationService.EnsureOptions() in D:\SourceCodes\Temp\RazorLight\src\RazorLight\Compilation\RoslynCompilationService.cs:line 84 
   at RazorLight.Compilation.RoslynCompilationService.get_ParseOptions() in D:\SourceCodes\Temp\RazorLight\src\RazorLight\Compilation\RoslynCompilationService.cs:line 61
   at RazorLight.Compilation.RoslynCompilationService.CreateSyntaxTree(SourceText sourceText) in D:\SourceCodes\Temp\RazorLight\src\RazorLight\Compilation\RoslynCompilationService.cs:line 184
   at RazorLight.Compilation.RoslynCompilationService.CreateCompilation(String compilationContent, String assemblyName) in D:\SourceCodes\Temp\RazorLight\src\RazorLight\Compilation\RoslynCompilationService.cs:line 162
   at RazorLight.Compilation.RoslynCompilationService.CompileAndEmit(IGeneratedRazorTemplate razorTemplate) in D:\SourceCodes\Temp\RazorLight\src\RazorLight\Compilation\RoslynCompilationService.cs:line 100
   at RazorLight.Compilation.RazorTemplateCompiler.CompileAndEmitAsync(RazorLightProjectItem projectItem) in D:\SourceCodes\Temp\RazorLight\src\RazorLight\Compilation\RazorTemplateCompiler.cs:line 223
   at RazorLight.Compilation.RazorTemplateCompiler.OnCacheMissAsync(String templateKey) in D:\SourceCodes\Temp\RazorLight\src\RazorLight\Compilation\RazorTemplateCompiler.cs:line 177
   at RazorLight.Compilation.RazorTemplateCompiler.OnCacheMissAsync(String templateKey) in D:\SourceCodes\Temp\RazorLight\src\RazorLight\Compilation\RazorTemplateCompiler.cs:line 187
   at RazorLight.EngineHandler.CompileTemplateAsync(String key) in D:\SourceCodes\Temp\RazorLight\src\RazorLight\EngineHandler.cs:line 64
   at RazorLight.EngineHandler.CompileRenderAsync[T](String key, T model, ExpandoObject viewBag) in D:\SourceCodes\Temp\RazorLight\src\RazorLight\EngineHandler.cs:line 140
   at (my service)

Inner exception: System.IO.IOException: Permission denied

P.S., as a reminder, 2.0.0-rc.3 works perfectly :/

P.S., as a reminder, 2.0.0-rc.3 works perfectly :/

It appears that my change here broke some of this: #407

Ultimately, we need better docs and FAQ support for what this code path is trying to accomplish. There is no general way to solve this problem for any arbitrary .NET deployment, as it requires knowledge of how the assembly is transformed into a .dll

I would still call this an undocumented regression and take ownership of it, though. It should have been documented.

DefaultMetadataReferenceManager should probably allow all ctors to take the IAssemblyDirectoryFormatter

Same issue here. Getting an error during rendering a view (that doesn't use URI just string and one property named Url).

It happens on docker build on top of mcr.microsoft.com/dotnet/aspnet:3.1

at 05/31/2022 14:57:26 error: System.UriFormatException: Invalid URI: The hostname could not be parsed.
at System.Uri.CreateThis(String uri, Boolean dontEscape, UriKind uriKind)
at System.Uri..ctor(String uriString)
at System.UriBuilder..ctor(String uri)
at RazorLight.Compilation.DefaultAssemblyDirectoryFormatter.GetAssemblyDirectory(Assembly assembly)
at RazorLight.Compilation.DefaultMetadataReferenceManager.b__12_2(Assembly p)
at System.Linq.Enumerable.SelectArrayIterator2.ToList() at System.Linq.Enumerable.ToList[TSource](IEnumerable1 source)
at RazorLight.Compilation.DefaultMetadataReferenceManager.Resolve(Assembly assembly, DependencyContext dependencyC ontext)
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 assemblyNam e)
at RazorLight.Compilation.RoslynCompilationService.CompileAndEmit(IGeneratedRazorTemplate razorTemplate)
at RazorLight.Compilation.RazorTemplateCompiler.CompileAndEmitAsync(RazorLightProjectItem projectItem)
at RazorLight.Compilation.RazorTemplateCompiler.OnCacheMissAsync(String templateKey)
at RazorLight.Compilation.RazorTemplateCompiler.OnCacheMissAsync(String templateKey)
at RazorLight.EngineHandler.CompileTemplateAsync(String key)
at RazorLight.EngineHandler.CompileRenderAsync[T](String key, T model, ExpandoObject viewBag)

I will fix this today

Update - I had to do an emergency hotfix at my day job yesterday, so promise to fix this yesterday was broken. I have not forgotten about it.

Any update on this one? We are experiencing the same issue, and are trying to get a fix to a client as soon as possible.

I face the same issue with NET6.0 on a Linux Docker container. Any idea if/when this will be fixed, or if there's a workaround for it in the meanwhile?

Related: #411

Anyone found a workaround to this issue ?

Yes, use 2.0.0-rc.3, as mentioned in #481 (comment)

Just to add some extra context onto this, the reason 2.0.0-rc.3 is working perfectly for people even though in theory it contains this commit 71383e4 which changes from Assembly.CodeBase to Assembly.Location, Is that 2.0.0-rc.3 contains the same version of the assemblies as 2.0.0-rc.2.

Using a script like this:

#!/usr/bin/env bash

set -e

versions=( 2.0.0-rc.1 2.0.0-rc.2 2.0.0-rc.3 2.0.0-rc.4 2.0.0-rc.6 2.0.0 )
for ver in "${versions[@]}"
do
    echo "${ver}"
    curl -SsL -o "${ver}.nupkg" "https://www.nuget.org/api/v2/package/RazorLight/${ver}"
    unzip -v "./${ver}.nupkg" | grep "RazorLight.dll"
done

Outputs the following, note the same checksums for rc.2 and rc.3:

2.0.0-rc.1
  124928  Defl:N    55590  56% 2020-11-17 14:55 ef20aac6  lib/net5.0/RazorLight.dll
  124928  Defl:N    55672  55% 2020-11-17 14:55 0458dac1  lib/netcoreapp3.1/RazorLight.dll
  124416  Defl:N    55396  56% 2020-11-17 14:55 9bcb50b7  lib/netstandard2.0/RazorLight.dll
2.0.0-rc.2
  124928  Defl:N    55654  56% 2020-11-18 16:15 50e395af  lib/net5.0/RazorLight.dll
  124928  Defl:N    55715  55% 2020-11-18 16:15 be42e02e  lib/netcoreapp3.1/RazorLight.dll
  124416  Defl:N    55451  55% 2020-11-18 16:15 dcf6bd62  lib/netstandard2.0/RazorLight.dll
2.0.0-rc.3
  124928  Defl:N    55654  56% 2020-11-18 16:15 50e395af  lib/net5.0/RazorLight.dll
  124928  Defl:N    55715  55% 2020-11-18 16:15 be42e02e  lib/netcoreapp3.1/RazorLight.dll
  124416  Defl:N    55451  55% 2020-11-18 16:15 dcf6bd62  lib/netstandard2.0/RazorLight.dll
2.0.0-rc.4
  133632  Defl:N    58810  56% 2021-12-08 02:16 d500f4dd  lib/net5.0/RazorLight.dll
  134144  Defl:N    58875  56% 2021-12-08 02:16 24e0b303  lib/netcoreapp3.1/RazorLight.dll
  133120  Defl:N    58623  56% 2021-12-08 02:16 d49e4aa3  lib/netstandard2.0/RazorLight.dll
2.0.0-rc.6
  134656  Defl:N    59196  56% 2022-02-17 00:39 104c7d3e  lib/net5.0/RazorLight.dll
  135168  Defl:N    59355  56% 2022-02-17 00:39 18a37c9d  lib/net6.0/RazorLight.dll
  134144  Defl:N    58878  56% 2022-02-17 00:39 4d59ee87  lib/netcoreapp3.1/RazorLight.dll
  133120  Defl:N    58611  56% 2022-02-17 00:39 e8674d98  lib/netstandard2.0/RazorLight.dll
2.0.0
  134656  Defl:N    59193  56% 2022-03-18 22:55 f707ce47  lib/net5.0/RazorLight.dll
  135168  Defl:N    59338  56% 2022-03-18 22:55 8fc8f9df  lib/net6.0/RazorLight.dll
  134144  Defl:N    58862  56% 2022-03-18 22:55 355e69b3  lib/netcoreapp3.1/RazorLight.dll
  133120  Defl:N    58606  56% 2022-03-18 22:55 b6c9f9af  lib/netstandard2.0/RazorLight.dll

And downloading/extracting the rc.3 package and looking at the assembly in dotpeek:
image

I thought I delisted rc.3

@Xtansia Thanks for pointing out RazorLight rc.3 was still listed. I just delisted it. It might take an hour to circulate through nuget.org package cache, and longer for any nuget replicas.

New 2.1.0 release with this change is now on nuget.org

@SerhiyBalan Can you let me know how you make out

@jzabroski Thank you very much

Verified at the following platforms:

Azure Web Service: .NET 6 + Unix
Azure Web Service: .NET Core 3.1 + Unix
Azure Functions: .NET 6 + Windows

Works like a charm!

Thank @Xtansia not me. I just am the messenger of his good deeds.