C#: Choose between .NET framework or core DLLs in standalone #14368
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,9 +47,12 @@ public DependencyManager(string srcDir, IDependencyOptions options, ILogger logg | |
| this.progressMonitor = new ProgressMonitor(logger); | ||
| this.sourceDir = new DirectoryInfo(srcDir); | ||
|
|
||
| packageDirectory = new TemporaryDirectory(ComputeTempDirectory(sourceDir.FullName)); | ||
| tempWorkingDirectory = new TemporaryDirectory(FileUtils.GetTemporaryWorkingDirectory(out cleanupTempWorkingDirectory)); | ||
|
|
||
| try | ||
| { | ||
| this.dotnet = DotNet.Make(options, progressMonitor, tempWorkingDirectory); | ||
| } | ||
| catch | ||
| { | ||
|
|
@@ -59,8 +62,6 @@ public DependencyManager(string srcDir, IDependencyOptions options, ILogger logg | |
|
|
||
| this.progressMonitor.FindingFiles(srcDir); | ||
|
|
||
|
|
||
| var allFiles = GetAllFiles(); | ||
| var binaryFileExtensions = new HashSet<string>(new[] { ".dll", ".exe" }); // TODO: add more binary file extensions. | ||
|
|
@@ -77,21 +78,6 @@ public DependencyManager(string srcDir, IDependencyOptions options, ILogger logg | |
| ? allFiles.SelectFileNamesByExtension(".dll").ToList() | ||
| : options.DllDirs.Select(Path.GetFullPath).ToList(); | ||
|
|
||
| if (options.UseNuGet) | ||
| { | ||
| dllDirNames.Add(packageDirectory.DirInfo.FullName); | ||
|
|
@@ -111,6 +97,26 @@ public DependencyManager(string srcDir, IDependencyOptions options, ILogger logg | |
| DownloadMissingPackages(allNonBinaryFiles); | ||
| } | ||
|
|
||
| var existsNetCoreRefNugetPackage = false; | ||
| var existsNetFrameworkRefNugetPackage = false; | ||
|
|
||
| // Find DLLs in the .Net / Asp.Net Framework | ||
| // This block needs to come after the nuget restore, because the nuget restore might fetch the .NET Core/Framework reference assemblies. | ||
| if (options.ScanNetFrameworkDlls) | ||
| { | ||
| existsNetCoreRefNugetPackage = IsNugetPackageAvailable("microsoft.netcore.app.ref"); | ||
| existsNetFrameworkRefNugetPackage = IsNugetPackageAvailable("microsoft.netframework.referenceassemblies"); | ||
|
|
||
| if (existsNetCoreRefNugetPackage || existsNetFrameworkRefNugetPackage) | ||
|
There was a problem hiding this comment. The DCA changes show that this logic is not working great. If dotnet core 6 is installed, and there are net6.0 and net5.0 targets, then the reference assemblies of net5.0 are downloaded and preferred over the installed dotnet 6 DLLs. And this causes an issue if there are other references which are compiled against dotnet 6.0. We could probably force the download of the ref assemblies for all target platforms, and we should choose the latest one from those. |
||
| { | ||
| progressMonitor.LogInfo("Found .NET Core/Framework DLLs in NuGet packages. Not adding installation directory."); | ||
| } | ||
| else | ||
| { | ||
| AddNetFrameworkDlls(dllDirNames); | ||
| } | ||
| } | ||
|
|
||
| assemblyCache = new AssemblyCache(dllDirNames, progressMonitor); | ||
| AnalyseSolutions(solutions); | ||
|
|
||
|
|
@@ -119,7 +125,7 @@ public DependencyManager(string srcDir, IDependencyOptions options, ILogger logg | |
| UseReference(filename); | ||
| } | ||
|
|
||
| RemoveUnnecessaryNugetPackages(existsNetCoreRefNugetPackage, existsNetFrameworkRefNugetPackage); | ||
| ResolveConflicts(); | ||
|
|
||
| // Output the findings | ||
|
|
@@ -154,38 +160,158 @@ public DependencyManager(string srcDir, IDependencyOptions options, ILogger logg | |
| DateTime.Now - startTime); | ||
| } | ||
|
|
||
| private void RemoveUnnecessaryNugetPackages(bool existsNetCoreRefNugetPackage, bool existsNetFrameworkRefNugetPackage) | ||
| { | ||
| RemoveNugetAnalyzerReferences(); | ||
| RemoveRuntimeNugetPackageReferences(); | ||
|
|
||
| if (fileContent.IsNewProjectStructureUsed | ||
| && !fileContent.UseAspNetCoreDlls) | ||
| { | ||
| // This might have been restored by the CLI even though the project isn't an asp.net core one. | ||
| RemoveNugetPackageReference("microsoft.aspnetcore.app.ref"); | ||
| } | ||
|
|
||
| if (existsNetCoreRefNugetPackage && existsNetFrameworkRefNugetPackage) | ||
| { | ||
| // Multiple packages are available, we keep only one: | ||
| RemoveNugetPackageReference("microsoft.netframework.referenceassemblies."); | ||
| } | ||
|
|
||
| // TODO: There could be multiple `microsoft.netframework.referenceassemblies` packages, | ||
| // we could keep the newest one, but this is covered by the conflict resolution logic | ||
| // (if the file names match) | ||
| } | ||
|
|
||
| private void RemoveNugetAnalyzerReferences() | ||
| { | ||
| if (!options.UseNuGet) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var packageFolder = packageDirectory.DirInfo.FullName.ToLowerInvariant(); | ||
| if (packageFolder == null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| foreach (var filename in usedReferences.Keys) | ||
| { | ||
| var lowerFilename = filename.ToLowerInvariant(); | ||
|
|
||
| if (lowerFilename.StartsWith(packageFolder)) | ||
| { | ||
| var firstDirectorySeparatorCharIndex = lowerFilename.IndexOf(Path.DirectorySeparatorChar, packageFolder.Length + 1); | ||
| if (firstDirectorySeparatorCharIndex == -1) | ||
| { | ||
| continue; | ||
| } | ||
| var secondDirectorySeparatorCharIndex = lowerFilename.IndexOf(Path.DirectorySeparatorChar, firstDirectorySeparatorCharIndex + 1); | ||
| if (secondDirectorySeparatorCharIndex == -1) | ||
| { | ||
| continue; | ||
| } | ||
| var subFolderIndex = secondDirectorySeparatorCharIndex + 1; | ||
| var isInAnalyzersFolder = lowerFilename.IndexOf("analyzers", subFolderIndex) == subFolderIndex; | ||
| if (isInAnalyzersFolder) | ||
|
There was a problem hiding this comment. Nuget packages can ship analyzers, code fixes, and source generators in the analyzers folder. These DLLs need to be passed in the |
||
| { | ||
| usedReferences.Remove(filename); | ||
| progressMonitor.RemovedReference(filename); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| private void AddNetFrameworkDlls(List<string> dllDirNames) | ||
| { | ||
| var runtime = new Runtime(dotnet); | ||
| string? runtimeLocation = null; | ||
|
|
||
| if (options.UseSelfContainedDotnet) | ||
| { | ||
| runtimeLocation = runtime.ExecutingRuntime; | ||
| } | ||
| else if (fileContent.IsNewProjectStructureUsed) | ||
| { | ||
| runtimeLocation = runtime.NetCoreRuntime; | ||
| } | ||
| else if (fileContent.IsLegacyProjectStructureUsed) | ||
| { | ||
| runtimeLocation = runtime.DesktopRuntime; | ||
| } | ||
|
|
||
| runtimeLocation ??= runtime.ExecutingRuntime; | ||
|
|
||
| progressMonitor.LogInfo($".NET runtime location selected: {runtimeLocation}"); | ||
| dllDirNames.Add(runtimeLocation); | ||
|
|
||
| if (fileContent.IsNewProjectStructureUsed | ||
| && fileContent.UseAspNetCoreDlls | ||
| && runtime.AspNetCoreRuntime is string aspRuntime) | ||
| { | ||
| progressMonitor.LogInfo($"ASP.NET runtime location selected: {aspRuntime}"); | ||
| dllDirNames.Add(aspRuntime); | ||
| } | ||
| } | ||
|
|
||
| private void RemoveRuntimeNugetPackageReferences() | ||
| { | ||
| var runtimePackagePrefixes = new[] | ||
| { | ||
| "microsoft.netcore.app.runtime", | ||
| "microsoft.aspnetcore.app.runtime", | ||
| "microsoft.windowsdesktop.app.runtime", | ||
|
|
||
| // legacy runtime packages: | ||
| "runtime.linux-x64.microsoft.netcore.app", | ||
| "runtime.osx-x64.microsoft.netcore.app", | ||
| "runtime.win-x64.microsoft.netcore.app", | ||
|
|
||
| // Internal implementation packages not meant for direct consumption: | ||
| "runtime." | ||
| }; | ||
| RemoveNugetPackageReference(runtimePackagePrefixes); | ||
| } | ||
|
|
||
| private void RemoveNugetPackageReference(params string[] packagePrefixes) | ||
| { | ||
| if (!options.UseNuGet) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var packageFolder = packageDirectory.DirInfo.FullName.ToLowerInvariant(); | ||
| if (packageFolder == null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var packagePathPrefixes = packagePrefixes.Select(p => Path.Combine(packageFolder, p.ToLowerInvariant())); | ||
|
|
||
| foreach (var filename in usedReferences.Keys) | ||
| { | ||
| var lowerFilename = filename.ToLowerInvariant(); | ||
|
|
||
| if (packagePathPrefixes.Any(prefix => lowerFilename.StartsWith(prefix))) | ||
| { | ||
| usedReferences.Remove(filename); | ||
| progressMonitor.RemovedReference(filename); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private bool IsNugetPackageAvailable(string packagePrefix) | ||
| { | ||
| if (!options.UseNuGet) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| return new DirectoryInfo(packageDirectory.DirInfo.FullName) | ||
| .EnumerateDirectories(packagePrefix + "*", new EnumerationOptions { MatchCasing = MatchCasing.CaseInsensitive, RecurseSubdirectories = false }) | ||
| .Any(); | ||
| } | ||
|
|
||
| private void GenerateSourceFileFromImplicitUsings() | ||
| { | ||
| var usings = new HashSet<string>(); | ||
|
|
@@ -198,7 +324,7 @@ private void GenerateSourceFileFromImplicitUsings() | |
| usings.UnionWith(new[] { "System", "System.Collections.Generic", "System.IO", "System.Linq", "System.Net.Http", "System.Threading", | ||
| "System.Threading.Tasks" }); | ||
|
|
||
| if (fileContent.UseAspNetCoreDlls) | ||
| { | ||
| usings.UnionWith(new[] { "System.Net.Http.Json", "Microsoft.AspNetCore.Builder", "Microsoft.AspNetCore.Hosting", | ||
| "Microsoft.AspNetCore.Http", "Microsoft.AspNetCore.Routing", "Microsoft.Extensions.Configuration", | ||
|
|
@@ -461,11 +587,11 @@ private void AnalyseProject(FileInfo project) | |
|
|
||
| } | ||
|
|
||
| private bool RestoreProject(string project, bool forceDotnetRefAssemblyFetching, string? pathToNugetConfig = null) => | ||
| dotnet.RestoreProjectToDirectory(project, packageDirectory.DirInfo.FullName, forceDotnetRefAssemblyFetching, pathToNugetConfig); | ||
|
|
||
| private bool RestoreSolution(string solution, out IEnumerable<string> projects) => | ||
| dotnet.RestoreSolutionToDirectory(solution, packageDirectory.DirInfo.FullName, forceDotnetRefAssemblyFetching: true, out projects); | ||
|
|
||
| /// <summary> | ||
| /// Executes `dotnet restore` on all solution files in solutions. | ||
|
|
@@ -491,7 +617,7 @@ private void RestoreProjects(IEnumerable<string> projects) | |
| { | ||
| Parallel.ForEach(projects, new ParallelOptions { MaxDegreeOfParallelism = options.Threads }, project => | ||
| { | ||
| RestoreProject(project, forceDotnetRefAssemblyFetching: true); | ||
| }); | ||
| } | ||
|
|
||
|
|
@@ -536,7 +662,7 @@ private void DownloadMissingPackages(List<FileInfo> allFiles) | |
| return; | ||
| } | ||
|
|
||
| success = RestoreProject(tempDir.DirInfo.FullName, forceDotnetRefAssemblyFetching: false, pathToNugetConfig: nugetConfig); | ||
| // TODO: the restore might fail, we could retry with a prerelease (*-* instead of *) version of the package. | ||
| if (!success) | ||
| { | ||
|
|
@@ -564,9 +690,25 @@ private void AnalyseSolutions(IEnumerable<string> solutions) | |
|
|
||
| public void Dispose() | ||
| { | ||
| try | ||
| { | ||
| packageDirectory?.Dispose(); | ||
| } | ||
| catch (Exception exc) | ||
| { | ||
| progressMonitor.LogInfo("Couldn't delete package directory: " + exc.Message); | ||
|
There was a problem hiding this comment. This logs The DLL is coming from the |
||
| } | ||
|
Comment on lines
+697
to
+700
Check noticeCode scanning / CodeQL Generic catch clause |
||
| if (cleanupTempWorkingDirectory) | ||
| { | ||
| try | ||
| { | ||
| tempWorkingDirectory?.Dispose(); | ||
| } | ||
| catch (Exception exc) | ||
| { | ||
| progressMonitor.LogInfo("Couldn't delete temporary working directory: " + exc.Message); | ||
| } | ||
|
Comment on lines
+707
to
+710
Check noticeCode scanning / CodeQL Generic catch clause |
||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.