Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix exception case in compiler resolver #75000

Merged
merged 2 commits into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#if NET
using System.Runtime.Loader;
using System.Reflection;
using Xunit;

namespace Microsoft.CodeAnalysis.UnitTests;

public sealed class CompilerAnalyzerAssemblyResolverTests
{
[Fact]
public void ExceptionReturnsNull()
{
var context = new AssemblyLoadContext(nameof(ExceptionReturnsNull), isCollectible: true);
var resolver = new AnalyzerAssemblyLoader.CompilerAnalyzerAssemblyResolver(context);
var name = new AssemblyName("NotARealAssembly");
Assert.Null(resolver.ResolveAssembly(name));
context.Unload();
}
}
#endif
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,19 @@ internal sealed class CompilerAnalyzerAssemblyResolver(AssemblyLoadContext compi
{
private readonly AssemblyLoadContext _compilerAlc = compilerContext;

public Assembly? ResolveAssembly(AssemblyName assemblyName) => _compilerAlc.LoadFromAssemblyName(assemblyName);
public Assembly? ResolveAssembly(AssemblyName assemblyName)
{
try
{
return _compilerAlc.LoadFromAssemblyName(assemblyName);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering what was happening previously, where was the exception propagated (did it crash the whole process)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code which consumes IAnalyzerAssemblyResolver guards against unexpected exceptions. Basically, that is an extension point and the compiler generally guards against unexpected exceptions coming from extensions. So this scenario was worknig overall but this specific component wasn't meeting its contract.

}
catch
{
// The LoadFromAssemblyName method will throw if the assembly cannot be found. Need
// to catch this exception and return null to satisfy the interface contract.
return null;
}
}
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using System.IO;
using System.Linq;
using System.Reflection;
using Microsoft.CodeAnalysis.ErrorReporting;
using Roslyn.Utilities;

namespace Microsoft.CodeAnalysis
Expand Down Expand Up @@ -415,7 +416,7 @@ internal string GetRealAnalyzerLoadPath(string originalFullPath)
return resolvedAssembly;
}
}
catch
catch (Exception ex) when (FatalError.ReportAndCatch(ex, ErrorSeverity.Diagnostic))
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jjonescz your comment reminded me that we're essentially silently swallowing the exceptions from plugins. Changed that to be non-silent. It's not a fatal error but definitely something that should at least raise an alert if it happens. This would've caught the issue that I fixed with this PR.

{
// Ignore if the external resolver throws
}
Expand Down
Loading