improve nuget package detection with SDK-managed packages #11127
Conversation
This file contains 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
brettfo
force-pushed
the
dev/brettfo/nuget-sdk-package-detection
branch
2 times, most recently
from
24720e9 to
9521d2f
Compare
brettfo
force-pushed
the
dev/brettfo/nuget-sdk-package-detection
branch
from
9521d2f to
0095890
Compare
ryanbrandenburg
approved these changes
Dec 21, 2024
nuget/helpers/lib/NuGetUpdater/DotNetPackageCorrelation.Test/EndToEndTests.cs
Show resolved
Hide resolved
| } | ||
|
|
||
| var releasesJson = await File.ReadAllTextAsync(releasesJsonPath); | ||
| var releasesFile = JsonSerializer.Deserialize<ReleasesFile>(releasesJson, SerializerOptions)!; |
There was a problem hiding this comment.
Nitpick:
Suggested change
| var releasesFile = JsonSerializer.Deserialize<ReleasesFile>(releasesJson, SerializerOptions)!; | |
| var releasesFile = await JsonSerializer.DeserializeAsync<ReleasesFile>(releasesJson, SerializerOptions)!; |
| private static partial Regex StandardLineWithFileExtensions(); | ||
|
|
||
| [GeneratedRegex(@"^(?<PackageName>[^|\s]+)\s*\|\s*(?<PackageVersion>[^|\s]+)$", RegexOptions.Compiled)] | ||
| // Some.Package | 1.2.3 |
There was a problem hiding this comment.
Great to use examples here.
nuget/helpers/lib/NuGetUpdater/DotNetPackageCorrelation/Model/PackageMapper.cs
Show resolved
Hide resolved
| @@ -388,6 +388,17 @@ public static MockNuGetPackage WellKnownReferencePackage(string packageName, str | |||
| return WellKnownPackages[key]; | |||
| } | |||
|
|
|||
| public static MockNuGetPackage GetMicrosoftNETCoreAppRefPackage(int majorRuntimeVersion) | |||
| { | ||
| var removedPackageName = GetChildMetadataValue(removedAssembly, "NuGetPackageId"); | ||
| var removedFileName = Path.GetFileName(removedAssembly.Name); | ||
| if (removedPackageName is not null && removedFileName is not null) |
There was a problem hiding this comment.
Can we maybe flip a couple of these conditions and have them continue; to reduce nesting?
nuget/helpers/lib/NuGetUpdater/NuGetUpdater.Core/EnsureDotNetPackageCorrelation.targets
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Consider the following example:
A repo contains a
global.jsonfile requiring the .NET SDK version8.0.303. A project in that repo has a dependency onSystem.Text.Json/8.0.0(either transitively or directly, it doesn't matter.)When we detect dependencies, we run a
restoreoperation, but the SDK takes special steps. During that operation, it sees the reference toSystem.Text.Jsonand realizes it has a newer copy, so it removes the reference.The end result is that we don't report
System.Text.Jsonas a reference because:(Doing some manual checking, the version of
System.Text.Jsonthat the8.0.303SDK is using as a replacement is8.0.4. This is important for later.)If we then try to perform an update on
System.Text.Json/8.0.4=>8.0.5we'll fail because that dependency wasn't reported.This PR fixes that behavior.
When the special package is removed, we detect that then perform a lookup to see that the version of
System.Text.Jsonthat ships with the SDK8.0.303just so happens to match exactly with the NuGet packageSystem.Text.Json/8.0.4. We then re-insert that dependency back into our reporting, because that's the equivalent package.This way when we try to update
System.Text.Jsonto version8.0.5, we can correctly see that the dependency does exist as version8.0.4so the update then to8.0.5succeeds.This was accomplished by adding a submodule to the
dotnet/corerepo and parsing and correlating severalreleases.jsonfiles with markdown files that list the relevant packages. The end result is a 3MB JSON file that contains all of the NuGet packages that shipped with a given runtime so we can map thatSystem.Text.Json.dllwas pulled out of the restore graph and it was replaced with one fromMicrosoft.NETCore.App.Ref/8.0.7and that the corresponding version ofSystem.Text.Jsonfor that same runtime release was8.0.4. This large mapping file is generated on build, so no manual steps need to be performed (and no huge file was added).