diff --git a/docs/Breaking API Changes.md b/docs/Breaking API Changes.md index 150b4269e55af..4b2782b0c79f3 100644 --- a/docs/Breaking API Changes.md +++ b/docs/Breaking API Changes.md @@ -87,12 +87,4 @@ All `SymbolDisplayFormat`s (predefined and user-created) now include parameter n `IncrementalGeneratorRunStep.Outputs` previously contained `IncrementalStepRunReason.Modified` as `Reason` when the input to the step was modified in a way that produced a new output. -Now the reason will be reported more accurately as `IncrementalStepRunReason.New`. - -# Version 4.8.0 - -### Changed `Assembly.Location` behavior in non-Windows - -The value of `Assembly.Location` previously held the location on disk where an analyzer or source generator was loaded from. This could be either the original location or the shadow copy location. In 4.8 this will be `""` in certain cases when running on non Windows platforms. This is due the compiler server loading assemblies using `AssemblyLoadContext.LoadFromStream` instead of loading from disk. - -This could already happen in other load scenarios but this change moves it into mainline build scenarios. +Now the reason will be reported more accurately as `IncrementalStepRunReason.New`. \ No newline at end of file diff --git a/src/Compilers/Core/CodeAnalysisTest/AnalyzerAssemblyLoaderTests.cs b/src/Compilers/Core/CodeAnalysisTest/AnalyzerAssemblyLoaderTests.cs index 11b5eb2688a0a..4834a205d698e 100644 --- a/src/Compilers/Core/CodeAnalysisTest/AnalyzerAssemblyLoaderTests.cs +++ b/src/Compilers/Core/CodeAnalysisTest/AnalyzerAssemblyLoaderTests.cs @@ -30,15 +30,6 @@ namespace Microsoft.CodeAnalysis.UnitTests { - public enum AnalyzerTestKind - { - LoadDirect, - ShadowLoad, -#if NETCOREAPP - LoadStream, -#endif - } - /// /// Contains the bulk of our analyzer / generator loading tests. /// @@ -96,15 +87,15 @@ public AnalyzerAssemblyLoaderTests(ITestOutputHelper testOutputHelper, AssemblyL #if NETCOREAPP - private void Run(AnalyzerTestKind kind, Action testAction, [CallerMemberName] string? memberName = null) => + private void Run(bool shadowLoad, Action testAction, [CallerMemberName] string? memberName = null) => Run( - kind, + shadowLoad, static (_, _) => { }, testAction, memberName); private void Run( - AnalyzerTestKind kind, + bool shadowLoad, Action prepLoadContextAction, Action testAction, [CallerMemberName] string? memberName = null) @@ -114,7 +105,7 @@ private void Run( { prepLoadContextAction(alc, TestFixture); var util = new InvokeUtil(); - util.Exec(TestOutputHelper, alc, TestFixture, kind, testAction.Method.DeclaringType!.FullName!, testAction.Method.Name); + util.Exec(TestOutputHelper, alc, TestFixture, shadowLoad, testAction.Method.DeclaringType!.FullName!, testAction.Method.Name); } finally { @@ -125,7 +116,7 @@ private void Run( #else private void Run( - AnalyzerTestKind kind, + bool shadowLoad, Action testAction, [CallerMemberName] string? memberName = null) { @@ -136,7 +127,7 @@ private void Run( var testOutputHelper = new AppDomainTestOutputHelper(TestOutputHelper); var type = typeof(InvokeUtil); var util = (InvokeUtil)appDomain.CreateInstanceAndUnwrap(type.Assembly.FullName, type.FullName); - util.Exec(testOutputHelper, TestFixture, kind, testAction.Method.DeclaringType.FullName, testAction.Method.Name); + util.Exec(testOutputHelper, TestFixture, shadowLoad, testAction.Method.DeclaringType.FullName, testAction.Method.Name); } finally { @@ -168,9 +159,9 @@ internal static void InvokeTestCode(AnalyzerAssemblyLoader loader, AssemblyLoadT [Theory] [CombinatorialData] [WorkItem(32226, "https://github.com/dotnet/roslyn/issues/32226")] - public void LoadWithDependency(AnalyzerTestKind kind) + public void LoadWithDependency(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { var analyzerDependencyFile = testFixture.AnalyzerDependency; var analyzerMainFile = testFixture.AnalyzerWithDependency; @@ -193,9 +184,9 @@ public void LoadWithDependency(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AddDependencyLocationThrowsOnNull(AnalyzerTestKind kind) + public void AddDependencyLocationThrowsOnNull(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { Assert.Throws("fullPath", () => loader.AddDependencyLocation(null!)); Assert.Throws("fullPath", () => loader.AddDependencyLocation("a")); @@ -204,9 +195,9 @@ public void AddDependencyLocationThrowsOnNull(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void ThrowsForMissingFile(AnalyzerTestKind kind) + public void ThrowsForMissingFile(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { var path = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName() + ".dll"); Assert.ThrowsAny(() => loader.LoadFromPath(path)); @@ -215,9 +206,9 @@ public void ThrowsForMissingFile(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void BasicLoad(AnalyzerTestKind kind) + public void BasicLoad(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { loader.AddDependencyLocation(testFixture.Alpha); Assembly alpha = loader.LoadFromPath(testFixture.Alpha); @@ -228,9 +219,9 @@ public void BasicLoad(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoading_Multiple(AnalyzerTestKind kind) + public void AssemblyLoading_Multiple(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -267,9 +258,9 @@ public void AssemblyLoading_Multiple(AnalyzerTestKind kind) /// [Theory] [CombinatorialData] - public void AssemblyLoading_OverwriteBeforeLoad(AnalyzerTestKind kind) + public void AssemblyLoading_OverwriteBeforeLoad(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { using var temp = new TempRoot(); var tempDir = temp.CreateDirectory(); @@ -289,9 +280,9 @@ public void AssemblyLoading_OverwriteBeforeLoad(AnalyzerTestKind kind) [ConditionalTheory(typeof(WindowsOnly), Reason = "https://github.com/dotnet/roslyn/issues/66621")] [CombinatorialData] - public void AssemblyLoading_AssemblyLocationNotAdded(AnalyzerTestKind kind) + public void AssemblyLoading_AssemblyLocationNotAdded(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { loader.AddDependencyLocation(testFixture.Gamma); loader.AddDependencyLocation(testFixture.Delta1); @@ -301,9 +292,9 @@ public void AssemblyLoading_AssemblyLocationNotAdded(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoading_DependencyLocationNotAdded(AnalyzerTestKind kind) + public void AssemblyLoading_DependencyLocationNotAdded(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -341,10 +332,12 @@ private static void VerifyAssemblies(AnalyzerAssemblyLoader loader, IEnumerable< private static void VerifyAssemblies(AnalyzerAssemblyLoader loader, IEnumerable assemblies, int? expectedCopyCount, params (string simpleName, string version, string path)[] expected) { + expected = expected + .Select(x => (x.simpleName, x.version, loader.GetRealLoadPath(x.path))) + .ToArray(); + Assert.Equal( - expected - .Select(x => (x.simpleName, x.version, getExpectedLoadPath(x.path))) - .ToArray(), + expected, assemblies.Select(assembly => (assembly.GetName().Name!, assembly.GetName().Version!.ToString(), assembly.Location)) .OrderBy(static x => x) .ToArray()); @@ -354,19 +347,6 @@ private static void VerifyAssemblies(AnalyzerAssemblyLoader loader, IEnumerable< Assert.All(assemblies, x => x.Location.StartsWith(shadowLoader.BaseDirectory, StringComparison.Ordinal)); Assert.Equal(expectedCopyCount ?? expected.Length, shadowLoader.CopyCount); } - - string getExpectedLoadPath(string path) - { -#if NETCOREAPP - if (loader is AnalyzerAssemblyLoader { AnalyzerLoadOption: AnalyzerLoadOption.LoadFromStream }) - { - return ""; - } -#endif - - return loader.GetRealLoadPath(path ?? ""); - } - } private static void VerifyAssemblies(AnalyzerAssemblyLoader loader, IEnumerable assemblies, int? copyCount, params string[] assemblyPaths) @@ -437,9 +417,9 @@ static bool isInLoadFromContext(AnalyzerAssemblyLoader loader, Assembly assembly [Theory] [CombinatorialData] - public void AssemblyLoading_Simple(AnalyzerTestKind kind) + public void AssemblyLoading_Simple(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { using var temp = new TempRoot(); StringBuilder sb = new StringBuilder(); @@ -465,9 +445,9 @@ public void AssemblyLoading_Simple(AnalyzerTestKind kind) [ConditionalTheory(typeof(WindowsOnly), Reason = "https://github.com/dotnet/runtime/issues/81108")] [CombinatorialData] - public void AssemblyLoading_DependencyInDifferentDirectory(AnalyzerTestKind kind) + public void AssemblyLoading_DependencyInDifferentDirectory(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { using var temp = new TempRoot(); var tempDir = temp.CreateDirectory(); @@ -501,9 +481,9 @@ public void AssemblyLoading_DependencyInDifferentDirectory(AnalyzerTestKind kind /// [Theory] [CombinatorialData] - public void AssemblyLoading_DependencyInDifferentDirectory2(AnalyzerTestKind kind) + public void AssemblyLoading_DependencyInDifferentDirectory2(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { using var temp = new TempRoot(); var tempDir = temp.CreateDirectory(); @@ -556,9 +536,9 @@ public void AssemblyLoading_DependencyInDifferentDirectory2(AnalyzerTestKind kin /// [Theory] [CombinatorialData] - public void AssemblyLoading_DependencyInDifferentDirectory3(AnalyzerTestKind kind) + public void AssemblyLoading_DependencyInDifferentDirectory3(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { using var temp = new TempRoot(); var tempDir = temp.CreateDirectory(); @@ -589,9 +569,9 @@ public void AssemblyLoading_DependencyInDifferentDirectory3(AnalyzerTestKind kin [ConditionalTheory(typeof(WindowsOnly), Reason = "https://github.com/dotnet/roslyn/issues/66626")] [CombinatorialData] [WorkItem(32226, "https://github.com/dotnet/roslyn/issues/32226")] - public void AssemblyLoading_DependencyInDifferentDirectory4(AnalyzerTestKind kind) + public void AssemblyLoading_DependencyInDifferentDirectory4(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { var analyzerDependencyFile = testFixture.AnalyzerDependency; var analyzerMainFile = testFixture.AnalyzerWithDependency; @@ -619,9 +599,9 @@ public void AssemblyLoading_DependencyInDifferentDirectory4(AnalyzerTestKind kin [Theory] [CombinatorialData] - public void AssemblyLoading_MultipleVersions(AnalyzerTestKind kind) + public void AssemblyLoading_MultipleVersions(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -676,9 +656,9 @@ public void AssemblyLoading_MultipleVersions(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoading_MultipleVersions_NoExactMatch(AnalyzerTestKind kind) + public void AssemblyLoading_MultipleVersions_NoExactMatch(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -735,9 +715,9 @@ public void AssemblyLoading_MultipleVersions_NoExactMatch(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoading_MultipleVersions_MultipleEqualMatches(AnalyzerTestKind kind) + public void AssemblyLoading_MultipleVersions_MultipleEqualMatches(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -785,9 +765,9 @@ public void AssemblyLoading_MultipleVersions_MultipleEqualMatches(AnalyzerTestKi [Theory] [CombinatorialData] - public void AssemblyLoading_MultipleVersions_MultipleVersionsOfSameAnalyzerItself(AnalyzerTestKind kind) + public void AssemblyLoading_MultipleVersions_MultipleVersionsOfSameAnalyzerItself(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -802,12 +782,9 @@ public void AssemblyLoading_MultipleVersions_MultipleVersionsOfSameAnalyzerItsel #if NETCOREAPP // On Core, we're able to load both of these into separate AssemblyLoadContexts. - if (loader.AnalyzerLoadOption == AnalyzerLoadOption.LoadFromDisk) - { - Assert.NotEqual(delta2B.Location, delta2.Location); - Assert.Equal(loader.GetRealLoadPath(testFixture.Delta2), delta2.Location); - Assert.Equal(loader.GetRealLoadPath(testFixture.Delta2B), delta2B.Location); - } + Assert.NotEqual(delta2B.Location, delta2.Location); + Assert.Equal(loader.GetRealLoadPath(testFixture.Delta2), delta2.Location); + Assert.Equal(loader.GetRealLoadPath(testFixture.Delta2B), delta2B.Location); #else @@ -822,9 +799,9 @@ public void AssemblyLoading_MultipleVersions_MultipleVersionsOfSameAnalyzerItsel [Theory] [CombinatorialData] - public void AssemblyLoading_MultipleVersions_ExactAndGreaterMatch(AnalyzerTestKind kind) + public void AssemblyLoading_MultipleVersions_ExactAndGreaterMatch(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -874,9 +851,9 @@ public void AssemblyLoading_MultipleVersions_ExactAndGreaterMatch(AnalyzerTestKi [Theory] [CombinatorialData] - public void AssemblyLoading_MultipleVersions_WorseMatchInSameDirectory(AnalyzerTestKind kind) + public void AssemblyLoading_MultipleVersions_WorseMatchInSameDirectory(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { using var temp = new TempRoot(); StringBuilder sb = new StringBuilder(); @@ -933,9 +910,9 @@ public void AssemblyLoading_MultipleVersions_WorseMatchInSameDirectory(AnalyzerT [Theory] [CombinatorialData] - public void AssemblyLoading_MultipleVersions_MultipleLoaders(AnalyzerTestKind kind) + public void AssemblyLoading_MultipleVersions_MultipleLoaders(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader1, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader1, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -996,9 +973,9 @@ public void AssemblyLoading_MultipleVersions_MultipleLoaders(AnalyzerTestKind ki [Theory] [CombinatorialData] - public void AssemblyLoading_MultipleVersions_MissingVersion(AnalyzerTestKind kind) + public void AssemblyLoading_MultipleVersions_MissingVersion(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -1025,9 +1002,9 @@ public void AssemblyLoading_MultipleVersions_MissingVersion(AnalyzerTestKind kin [Theory] [CombinatorialData] - public void AssemblyLoading_UnifyToHighest(AnalyzerTestKind kind) + public void AssemblyLoading_UnifyToHighest(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { var sb = new StringBuilder(); @@ -1060,9 +1037,9 @@ public void AssemblyLoading_UnifyToHighest(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoading_CanLoadDifferentVersionsDirectly(AnalyzerTestKind kind) + public void AssemblyLoading_CanLoadDifferentVersionsDirectly(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { var sb = new StringBuilder(); @@ -1090,9 +1067,9 @@ public void AssemblyLoading_CanLoadDifferentVersionsDirectly(AnalyzerTestKind ki [Theory] [CombinatorialData] - public void AssemblyLoading_AnalyzerReferencesSystemCollectionsImmutable_01(AnalyzerTestKind kind) + public void AssemblyLoading_AnalyzerReferencesSystemCollectionsImmutable_01(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -1117,9 +1094,9 @@ public void AssemblyLoading_AnalyzerReferencesSystemCollectionsImmutable_01(Anal [Theory] [CombinatorialData] - public void AssemblyLoading_AnalyzerReferencesSystemCollectionsImmutable_02(AnalyzerTestKind kind) + public void AssemblyLoading_AnalyzerReferencesSystemCollectionsImmutable_02(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { StringBuilder sb = new StringBuilder(); @@ -1135,9 +1112,9 @@ public void AssemblyLoading_AnalyzerReferencesSystemCollectionsImmutable_02(Anal [Theory] [CombinatorialData] - public void AssemblyLoading_CompilerDependencyDuplicated(AnalyzerTestKind kind) + public void AssemblyLoading_CompilerDependencyDuplicated(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { var assembly = typeof(ImmutableArray).Assembly; @@ -1156,9 +1133,9 @@ public void AssemblyLoading_CompilerDependencyDuplicated(AnalyzerTestKind kind) [ConditionalTheory(typeof(WindowsOnly))] [CombinatorialData] - public void AssemblyLoading_NativeDependency(AnalyzerTestKind kind) + public void AssemblyLoading_NativeDependency(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { const int INVALID_FILE_ATTRIBUTES = -1; loader.AddDependencyLocation(testFixture.AnalyzerWithNativeDependency); @@ -1173,9 +1150,9 @@ public void AssemblyLoading_NativeDependency(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoading_DeleteAfterLoad1(AnalyzerTestKind kind) + public void AssemblyLoading_DeleteAfterLoad1(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { using var temp = new TempRoot(); var tempDir = temp.CreateDirectory(); @@ -1196,9 +1173,9 @@ public void AssemblyLoading_DeleteAfterLoad1(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoading_DeleteAfterLoad2(AnalyzerTestKind kind) + public void AssemblyLoading_DeleteAfterLoad2(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { using var temp = new TempRoot(); StringBuilder sb = new StringBuilder(); @@ -1227,9 +1204,9 @@ public void AssemblyLoading_DeleteAfterLoad2(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoading_DeleteAfterLoad3(AnalyzerTestKind kind) + public void AssemblyLoading_DeleteAfterLoad3(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { using var temp = new TempRoot(); var tempDir = temp.CreateDirectory(); @@ -1267,9 +1244,9 @@ public void AssemblyLoading_DeleteAfterLoad3(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoading_RepeatedLoads1(AnalyzerTestKind kind) + public void AssemblyLoading_RepeatedLoads1(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { var path = testFixture.Delta1; loader.AddDependencyLocation(path); @@ -1288,9 +1265,9 @@ public void AssemblyLoading_RepeatedLoads1(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoading_RepeatedLoads2(AnalyzerTestKind kind) + public void AssemblyLoading_RepeatedLoads2(bool shadowLoad) { - Run(kind, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => + Run(shadowLoad, static (AnalyzerAssemblyLoader loader, AssemblyLoadTestFixture testFixture) => { using var temp = new TempRoot(); var tempDir = temp.CreateDirectory(); @@ -1325,9 +1302,9 @@ public void AssemblyLoading_RepeatedLoads2(AnalyzerTestKind kind) [Theory] [CombinatorialData] - public void AssemblyLoadingInNonDefaultContext_AnalyzerReferencesSystemCollectionsImmutable(AnalyzerTestKind kind) + public void AssemblyLoadingInNonDefaultContext_AnalyzerReferencesSystemCollectionsImmutable(bool shadowLoad) { - Run(kind, + Run(shadowLoad, static (AssemblyLoadContext compilerContext, AssemblyLoadTestFixture testFixture) => { // Load the compiler assembly and a modified version of S.C.I into the compiler load context. We diff --git a/src/Compilers/Core/CodeAnalysisTest/InvokeUtil.cs b/src/Compilers/Core/CodeAnalysisTest/InvokeUtil.cs index 3dc9fec60ed45..3fdc9a58c0257 100644 --- a/src/Compilers/Core/CodeAnalysisTest/InvokeUtil.cs +++ b/src/Compilers/Core/CodeAnalysisTest/InvokeUtil.cs @@ -35,7 +35,7 @@ namespace Microsoft.CodeAnalysis.UnitTests public sealed class InvokeUtil { - public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadContext compilerContext, AssemblyLoadTestFixture fixture, AnalyzerTestKind kind, string typeName, string methodName) + public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadContext compilerContext, AssemblyLoadTestFixture fixture, bool shadowLoad, string typeName, string methodName) { // Ensure that the test did not load any of the test fixture assemblies into // the default load context. That should never happen. Assemblies should either @@ -46,14 +46,9 @@ public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadContext compile var compilerContextCount = compilerContext.Assemblies.Count(); using var tempRoot = new TempRoot(); - AnalyzerAssemblyLoader loader = kind switch - { - AnalyzerTestKind.LoadDirect => new DefaultAnalyzerAssemblyLoader(compilerContext, AnalyzerLoadOption.LoadFromDisk), - AnalyzerTestKind.LoadStream => new DefaultAnalyzerAssemblyLoader(compilerContext, AnalyzerLoadOption.LoadFromStream), - AnalyzerTestKind.ShadowLoad => new ShadowCopyAnalyzerAssemblyLoader(compilerContext, tempRoot.CreateDirectory().Path), - _ => throw ExceptionUtilities.Unreachable() - }; - + AnalyzerAssemblyLoader loader = shadowLoad + ? new ShadowCopyAnalyzerAssemblyLoader(compilerContext, tempRoot.CreateDirectory().Path) + : new DefaultAnalyzerAssemblyLoader(compilerContext); try { AnalyzerAssemblyLoaderTests.InvokeTestCode(loader, fixture, typeName, methodName); @@ -93,15 +88,12 @@ public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadContext compile public sealed class InvokeUtil : MarshalByRefObject { - public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadTestFixture fixture, AnalyzerTestKind kind, string typeName, string methodName) + public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadTestFixture fixture, bool shadowLoad, string typeName, string methodName) { using var tempRoot = new TempRoot(); - AnalyzerAssemblyLoader loader = kind switch - { - AnalyzerTestKind.LoadDirect => new DefaultAnalyzerAssemblyLoader(), - AnalyzerTestKind.ShadowLoad => new ShadowCopyAnalyzerAssemblyLoader(tempRoot.CreateDirectory().Path), - _ => throw ExceptionUtilities.Unreachable() - }; + AnalyzerAssemblyLoader loader = shadowLoad + ? new ShadowCopyAnalyzerAssemblyLoader(tempRoot.CreateDirectory().Path) + : new DefaultAnalyzerAssemblyLoader(); try { diff --git a/src/Compilers/Core/Portable/DiagnosticAnalyzer/AnalyzerAssemblyLoader.Core.cs b/src/Compilers/Core/Portable/DiagnosticAnalyzer/AnalyzerAssemblyLoader.Core.cs index d5fd00ce05024..ef4bb64ea4193 100644 --- a/src/Compilers/Core/Portable/DiagnosticAnalyzer/AnalyzerAssemblyLoader.Core.cs +++ b/src/Compilers/Core/Portable/DiagnosticAnalyzer/AnalyzerAssemblyLoader.Core.cs @@ -1,4 +1,4 @@ -// Licensed to the .NET Foundation under one or more agreements. +// 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. @@ -11,46 +11,19 @@ using System.IO; using System.Linq; using System.Reflection; -using System.Runtime.InteropServices; using System.Runtime.Loader; namespace Microsoft.CodeAnalysis { - internal enum AnalyzerLoadOption - { - /// - /// Once the assembly path is chosen, load it directly from disk at that location - /// - LoadFromDisk, - - /// - /// Once the assembly path is chosen, read the contents of disk and load from memory - /// - /// - /// While Windows supports this option it comes with a significant performance penalty due - /// to anti virus scans. It can have a load time of 300-500ms while loading from disk - /// is generally 1-2ms. Use this with caution on Windows. - /// - LoadFromStream - } - internal partial class AnalyzerAssemblyLoader { private readonly AssemblyLoadContext _compilerLoadContext; private readonly Dictionary _loadContextByDirectory = new Dictionary(StringComparer.Ordinal); - private readonly AnalyzerLoadOption _loadOption; internal AssemblyLoadContext CompilerLoadContext => _compilerLoadContext; - internal AnalyzerLoadOption AnalyzerLoadOption => _loadOption; - internal AnalyzerAssemblyLoader() - : this(null, AnalyzerLoadOption.LoadFromDisk) + internal AnalyzerAssemblyLoader(AssemblyLoadContext? compilerLoadContext = null) { - } - - internal AnalyzerAssemblyLoader(AssemblyLoadContext? compilerLoadContext, AnalyzerLoadOption loadOption) - { - _loadOption = loadOption; _compilerLoadContext = compilerLoadContext ?? AssemblyLoadContext.GetLoadContext(typeof(AnalyzerAssemblyLoader).GetTypeInfo().Assembly)!; } @@ -132,7 +105,7 @@ public DirectoryLoadContext(string directory, AnalyzerAssemblyLoader loader, Ass if (_loader.IsAnalyzerDependencyPath(assemblyPath)) { (_, var loadPath) = _loader.GetAssemblyInfoForPath(assemblyPath); - return loadCore(loadPath); + return LoadFromAssemblyPath(loadPath); } // Next prefer registered dependencies from other directories. Ideally this would not @@ -141,24 +114,11 @@ public DirectoryLoadContext(string directory, AnalyzerAssemblyLoader loader, Ass // https://github.com/dotnet/roslyn/issues/56442 if (_loader.GetBestPath(assemblyName) is string bestRealPath) { - return loadCore(bestRealPath); + return LoadFromAssemblyPath(bestRealPath); } // No analyzer registered this dependency. Time to fail return null; - - Assembly loadCore(string assemblyPath) - { - if (_loader.AnalyzerLoadOption == AnalyzerLoadOption.LoadFromDisk) - { - return LoadFromAssemblyPath(assemblyPath); - } - else - { - using var stream = File.Open(assemblyPath, FileMode.Open, FileAccess.Read, FileShare.Read); - return LoadFromStream(stream); - } - } } protected override IntPtr LoadUnmanagedDll(string unmanagedDllName) diff --git a/src/Compilers/Core/Portable/DiagnosticAnalyzer/DefaultAnalyzerAssemblyLoader.cs b/src/Compilers/Core/Portable/DiagnosticAnalyzer/DefaultAnalyzerAssemblyLoader.cs index 7e3a95ce87050..f059cf6dda665 100644 --- a/src/Compilers/Core/Portable/DiagnosticAnalyzer/DefaultAnalyzerAssemblyLoader.cs +++ b/src/Compilers/Core/Portable/DiagnosticAnalyzer/DefaultAnalyzerAssemblyLoader.cs @@ -9,7 +9,6 @@ using System.IO; using System.Linq; using System.Reflection; -using System.Runtime.InteropServices; using Roslyn.Utilities; namespace Microsoft.CodeAnalysis @@ -18,18 +17,14 @@ internal sealed class DefaultAnalyzerAssemblyLoader : AnalyzerAssemblyLoader { #if NETCOREAPP + // Called from a netstandard2.0 project, so need to ensure a parameterless constructor is available. internal DefaultAnalyzerAssemblyLoader() + : this(null) { } - internal DefaultAnalyzerAssemblyLoader(System.Runtime.Loader.AssemblyLoadContext? compilerLoadContext = null, AnalyzerLoadOption loadOption = AnalyzerLoadOption.LoadFromDisk) - : base(compilerLoadContext, loadOption) - { - } - -#else - - internal DefaultAnalyzerAssemblyLoader() + internal DefaultAnalyzerAssemblyLoader(System.Runtime.Loader.AssemblyLoadContext? compilerLoadContext = null) + : base(compilerLoadContext) { } @@ -41,42 +36,5 @@ internal DefaultAnalyzerAssemblyLoader() /// /// protected override string PreparePathToLoad(string fullPath) => fullPath; - - /// - /// Return an which does not lock assemblies on disk that is - /// most appropriate for the current platform. - /// - /// A shadow copy path will be created on Windows and this value - /// will be the base directory where shadow copy assemblies are stored. - internal static IAnalyzerAssemblyLoader CreateNonLockingLoader(string windowsShadowPath) - { -#if NETCOREAPP - if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) - { - // The cost of doing stream based loading on Windows is too expensive and we must continue to - // use the shadow copy loader. - return createShadowLoaderWindows(); - } - else - { - return new DefaultAnalyzerAssemblyLoader(loadOption: AnalyzerLoadOption.LoadFromStream); - } -#else - return createShadowLoaderWindows(); -#endif - - ShadowCopyAnalyzerAssemblyLoader createShadowLoaderWindows() - { - // The shadow copy analyzer should only be created on Windows. To create on Linux we cannot use - // GetTempPath as it's not per-user. Generally there is no need as LoadFromStream achieves the same - // effect - if (!Path.IsPathRooted(windowsShadowPath)) - { - throw new ArgumentException("Must be a full path.", nameof(windowsShadowPath)); - } - - return new ShadowCopyAnalyzerAssemblyLoader(windowsShadowPath); - } - } } } diff --git a/src/Compilers/Core/Portable/DiagnosticAnalyzer/ShadowCopyAnalyzerAssemblyLoader.cs b/src/Compilers/Core/Portable/DiagnosticAnalyzer/ShadowCopyAnalyzerAssemblyLoader.cs index eae0e67a96a6b..b05ff2b4b2aa5 100644 --- a/src/Compilers/Core/Portable/DiagnosticAnalyzer/ShadowCopyAnalyzerAssemblyLoader.cs +++ b/src/Compilers/Core/Portable/DiagnosticAnalyzer/ShadowCopyAnalyzerAssemblyLoader.cs @@ -44,23 +44,30 @@ internal sealed class ShadowCopyAnalyzerAssemblyLoader : AnalyzerAssemblyLoader internal int CopyCount => _assemblyDirectoryId; #if NETCOREAPP - public ShadowCopyAnalyzerAssemblyLoader(string baseDirectory) + public ShadowCopyAnalyzerAssemblyLoader(string? baseDirectory = null) : this(null, baseDirectory) { } - public ShadowCopyAnalyzerAssemblyLoader(AssemblyLoadContext? compilerLoadContext, string baseDirectory) - : base(compilerLoadContext, AnalyzerLoadOption.LoadFromDisk) + public ShadowCopyAnalyzerAssemblyLoader(AssemblyLoadContext? compilerLoadContext, string? baseDirectory = null) + : base(compilerLoadContext) #else - public ShadowCopyAnalyzerAssemblyLoader(string baseDirectory) + public ShadowCopyAnalyzerAssemblyLoader(string? baseDirectory = null) #endif { - if (baseDirectory is null) + if (baseDirectory != null) { - throw new ArgumentNullException(nameof(baseDirectory)); + _baseDirectory = baseDirectory; + } + else + { + // https://github.com/dotnet/roslyn/issues/65415 + // Fixing that issue will involve removing this GetTempPath call +#pragma warning disable RS0030 + _baseDirectory = Path.Combine(Path.GetTempPath(), "CodeAnalysis", "AnalyzerShadowCopies"); +#pragma warning restore RS0030 } - _baseDirectory = baseDirectory; _shadowCopyDirectoryAndMutex = new Lazy<(string directory, Mutex)>( () => CreateUniqueDirectoryForProcess(), LazyThreadSafetyMode.ExecutionAndPublication); diff --git a/src/Compilers/Server/VBCSCompiler/CompilerRequestHandler.cs b/src/Compilers/Server/VBCSCompiler/CompilerRequestHandler.cs index 7c15c6697578f..d5da3d8306c6e 100644 --- a/src/Compilers/Server/VBCSCompiler/CompilerRequestHandler.cs +++ b/src/Compilers/Server/VBCSCompiler/CompilerRequestHandler.cs @@ -41,7 +41,7 @@ public RunRequest(Guid requestId, string language, string? workingDirectory, str internal sealed class CompilerServerHost : ICompilerServerHost { - public IAnalyzerAssemblyLoader AnalyzerAssemblyLoader { get; } + public IAnalyzerAssemblyLoader AnalyzerAssemblyLoader { get; } = new ShadowCopyAnalyzerAssemblyLoader(baseDirectory: Path.Combine(Path.GetTempPath(), "VBCSCompiler", "AnalyzerAssemblyLoader")); public static Func SharedAssemblyReferenceProvider { get; } = (path, properties) => new CachingMetadataReference(path, properties); @@ -72,7 +72,6 @@ internal CompilerServerHost(string clientDirectory, string? sdkDirectory, ICompi ClientDirectory = clientDirectory; SdkDirectory = sdkDirectory; Logger = logger; - AnalyzerAssemblyLoader = DefaultAnalyzerAssemblyLoader.CreateNonLockingLoader(Path.Combine(Path.GetTempPath(), "VBCSCompiler", "AnalyzerAssemblyLoader")); } public bool TryCreateCompiler(in RunRequest request, BuildPaths buildPaths, [NotNullWhen(true)] out CommonCompiler? compiler) diff --git a/src/Compilers/Shared/BuildServerConnection.cs b/src/Compilers/Shared/BuildServerConnection.cs index 8e2c993d3e6a7..990f2a11986ca 100644 --- a/src/Compilers/Shared/BuildServerConnection.cs +++ b/src/Compilers/Shared/BuildServerConnection.cs @@ -34,6 +34,16 @@ internal sealed class BuildServerConnection /// /// Create a build request for processing on the server. /// + /// + /// Even though compilation itself does not specifically require a temporary directory to be successful + /// this API deliberately requires to have a value. The reason for this is + /// that the server itself requires a temporary directory to startup and it uses the same logic as the client + /// to calculate it. + /// + /// That means if the client can't calculate the temporary directory the server won't be able to either and + /// hence won't be able to start. So creating instances isn't useful cause it's + /// wasting time trying to start a server that won't be able to start. + /// internal static BuildRequest CreateBuildRequest( Guid requestId, RequestLanguage language, diff --git a/src/Tools/ExternalAccess/OmniSharp/Analyzers/OmnisharpAnalyzerLoaderFactory.cs b/src/Tools/ExternalAccess/OmniSharp/Analyzers/OmnisharpAnalyzerLoaderFactory.cs index e876349f28962..899a27f9768cb 100644 --- a/src/Tools/ExternalAccess/OmniSharp/Analyzers/OmnisharpAnalyzerLoaderFactory.cs +++ b/src/Tools/ExternalAccess/OmniSharp/Analyzers/OmnisharpAnalyzerLoaderFactory.cs @@ -3,7 +3,6 @@ // See the LICENSE file in the project root for more information. using Microsoft.CodeAnalysis.Diagnostics; -using System.IO; namespace Microsoft.CodeAnalysis.ExternalAccess.OmniSharp.Analyzers { @@ -11,8 +10,7 @@ internal static class OmnisharpAnalyzerAssemblyLoaderFactory { public static IAnalyzerAssemblyLoader CreateShadowCopyAnalyzerAssemblyLoader(string? baseDirectory = null) { - baseDirectory ??= Path.Combine(Path.GetTempPath(), "CodeAnalysis", "OmnisharpAnalyzerShadowCopies"); - return DefaultAnalyzerAssemblyLoader.CreateNonLockingLoader(baseDirectory); + return new ShadowCopyAnalyzerAssemblyLoader(baseDirectory); } } } diff --git a/src/Workspaces/Core/Portable/Diagnostics/DefaultAnalyzerAssemblyLoaderService.cs b/src/Workspaces/Core/Portable/Diagnostics/DefaultAnalyzerAssemblyLoaderService.cs index 75f287f223404..b6580eae4708f 100644 --- a/src/Workspaces/Core/Portable/Diagnostics/DefaultAnalyzerAssemblyLoaderService.cs +++ b/src/Workspaces/Core/Portable/Diagnostics/DefaultAnalyzerAssemblyLoaderService.cs @@ -4,7 +4,6 @@ using System; using System.Composition; -using System.IO; using Microsoft.CodeAnalysis.Host.Mef; namespace Microsoft.CodeAnalysis.Host @@ -13,9 +12,8 @@ namespace Microsoft.CodeAnalysis.Host [ExportWorkspaceService(typeof(IAnalyzerAssemblyLoaderProvider))] internal sealed class DefaultAnalyzerAssemblyLoaderService : IAnalyzerAssemblyLoaderProvider { - private readonly IAnalyzerAssemblyLoader _loader = new DefaultAnalyzerAssemblyLoader(); - private readonly IAnalyzerAssemblyLoader _shadowCopyLoader = DefaultAnalyzerAssemblyLoader.CreateNonLockingLoader( - Path.Combine(Path.GetTempPath(), "CodeAnalysis", "WorkspacesAnalyzerShadowCopies")); + private readonly DefaultAnalyzerAssemblyLoader _loader = new(); + private readonly ShadowCopyAnalyzerAssemblyLoader _shadowCopyLoader = new(); [ImportingConstructor] [Obsolete(MefConstruction.ImportingConstructorMessage, error: true)] diff --git a/src/Workspaces/Remote/ServiceHub/Host/RemoteAnalyzerAssemblyLoader.cs b/src/Workspaces/Remote/ServiceHub/Host/RemoteAnalyzerAssemblyLoader.cs index 3046e9f3fa886..1fc17bbbefd05 100644 --- a/src/Workspaces/Remote/ServiceHub/Host/RemoteAnalyzerAssemblyLoader.cs +++ b/src/Workspaces/Remote/ServiceHub/Host/RemoteAnalyzerAssemblyLoader.cs @@ -18,7 +18,6 @@ internal sealed class RemoteAnalyzerAssemblyLoader : AnalyzerAssemblyLoader public RemoteAnalyzerAssemblyLoader(string baseDirectory) { - // jason should we load from stream here on Linux or is this VS only? _baseDirectory = baseDirectory; }