Improve analyzer consistency check message (#73329)

dotnet · May 6, 2024 · e674c91 · e674c91
1 parent 062ad3d
commit e674c91
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/src/Compilers/Core/CodeAnalysisTest/Analyzers/AnalyzerFileReferenceTests.cs b/src/Compilers/Core/CodeAnalysisTest/Analyzers/AnalyzerFileReferenceTests.cs
@@ -749,5 +749,6 @@ public class TestSourceAndIncrementalGenerator : IIncrementalGenerator, ISourceG
         public void AddDependencyLocation(string fullPath) { }
         public bool IsHostAssembly(Assembly assembly) => false;
         public Assembly LoadFromPath(string fullPath) => throw new Exception();
+        public string? GetOriginalDependencyLocation(AssemblyName assembly) => throw new Exception();
     }
 }
diff --git a/src/Compilers/Core/Portable/DiagnosticAnalyzer/AnalyzerAssemblyLoader.cs b/src/Compilers/Core/Portable/DiagnosticAnalyzer/AnalyzerAssemblyLoader.cs
@@ -20,6 +20,13 @@ internal interface IAnalyzerAssemblyLoaderInternal : IAnalyzerAssemblyLoader
         /// process. Either part of the compiler itself or the process hosting the compiler.
         /// </summary>
         bool IsHostAssembly(Assembly assembly);
+
+        /// <summary>
+        /// For a given <see cref="AssemblyName"/> return the location it was originally added 
+        /// from. This will return null for any value that was not directly added through the 
+        /// loader.
+        /// </summary>
+        string? GetOriginalDependencyLocation(AssemblyName assembly);
     }
 
     /// <summary>
@@ -235,6 +242,9 @@ public Assembly LoadFromPath(string originalAnalyzerPath)
             }
         }
 
+        public string? GetOriginalDependencyLocation(AssemblyName assemblyName) =>
+            GetBestPath(assemblyName).BestOriginalPath;
+
         /// <summary>
         /// Return the best (original, real) path information for loading an assembly with the specified <see cref="AssemblyName"/>.
         /// </summary>

diff --git a/src/Compilers/Server/VBCSCompiler/AnalyzerConsistencyChecker.cs b/src/Compilers/Server/VBCSCompiler/AnalyzerConsistencyChecker.cs
@@ -128,7 +128,8 @@ private static bool CheckCore(
                 var loadedAssemblyMvid = loadedAssembly.ManifestModule.ModuleVersionId;
                 if (resolvedPathMvid != loadedAssemblyMvid)
                 {
-                    var message = $"analyzer assembly '{resolvedPath}' has MVID '{resolvedPathMvid}' but loaded assembly '{loadedAssembly.Location}' has MVID '{loadedAssemblyMvid}'";
+                    var loadedAssemblyLocation = loader.GetOriginalDependencyLocation(loadedAssembly.GetName()) ?? loadedAssembly.Location;
+                    var message = $"analyzer assembly '{resolvedPath}' has MVID '{resolvedPathMvid}' but loaded assembly '{loadedAssemblyLocation}' has MVID '{loadedAssemblyMvid}'";
                     errorMessages ??= new List<string>();
                     errorMessages.Add(message);
                     logger.LogError(message);

diff --git a/src/Compilers/Server/VBCSCompilerTests/AnalyzerConsistencyCheckerTests.cs b/src/Compilers/Server/VBCSCompilerTests/AnalyzerConsistencyCheckerTests.cs
@@ -154,8 +154,16 @@ public void DifferingMvidsSameDirectory()
                 directory.Path,
                 ImmutableArray.Create(new CommandLineAnalyzerReference(mvidAlpha2.Path)),
                 assemblyLoader,
-                Logger);
+                Logger,
+                out List<string>? errorMessages);
             Assert.False(result);
+            Assert.NotNull(errorMessages);
+
+            // Both the original and failed paths need to appear in the message, not the shadow copy 
+            // paths
+            var errorMessage = errorMessages!.Single();
+            Assert.Contains(mvidAlpha1.Path, errorMessage);
+            Assert.Contains(mvidAlpha2.Path, errorMessage);
         }
 
         /// <summary>
@@ -242,5 +250,6 @@ public void LoadingSimpleLibrary()
         public void AddDependencyLocation(string fullPath) { }
         public bool IsHostAssembly(Assembly assembly) => false;
         public Assembly LoadFromPath(string fullPath) => throw new Exception();
+        public string? GetOriginalDependencyLocation(AssemblyName assembly) => throw new Exception();
     }
 }