Fix packages.config to project mapping in NuGet.exe #5818
Merged
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
nkolev92
force-pushed
the
dev-nkolev92-fixPCtoProjectMapping
branch
from
da3905f
to
1c21d27
Compare
nkolev92
commented
May 28, 2024
| Dictionary<PackageReference, List<string>> packageReferenceToProjects = new(PackageReferenceComparer.Instance); | ||
|
|
||
| foreach (string configFile in packageRestoreInputs.PackagesConfigFiles) | ||
| foreach (string configFile in packageRestoreInputs.PackagesConfigFiles.Distinct()) |
There was a problem hiding this comment.
Ensure we don't process the same config twice.
There's more performant ways of doing but:
- It's NuGet.exe, so this cost is not everywhere and very minor.
- More code = more risk, potentially more challenges getting approval.
nkolev92
force-pushed
the
dev-nkolev92-fixPCtoProjectMapping
branch
from
834f1b8
to
0b08ee6
Compare
nkolev92
changed the title
nkolev92
changed the title
nkolev92
commented
May 28, 2024
| @@ -276,24 +276,24 @@ private async Task<IReadOnlyList<RestoreSummary>> PerformNuGetV2RestoreAsync(Pac | |||
|
|
|||
| if (packageRestoreInputs.RestoringWithSolutionFile) | |||
| { | |||
| Dictionary<string, string> configToProjectPath = GetPackagesConfigToProjectPath(packageRestoreInputs); | |||
| Dictionary<string, HashSet<string>> configToProjectPath = GetPackagesConfigToProjectsPath(packageRestoreInputs); | |||
There was a problem hiding this comment.
While multiple projects to 1 packages.config is not recommended, it is obviously something that does happen, and I don't want to rock the boat in a patch release, so the fix is to just handle that scenario.
https://github.com/NuGet/Client.Engineering/issues/2851 covers more.
martinrrm
previously approved these changes
May 28, 2024
zivkan
previously approved these changes
May 29, 2024
test/NuGet.Clients.Tests/NuGet.CommandLine.Test/NuGetRestoreCommandTest.cs
Show resolved
Hide resolved
test/NuGet.Core.FuncTests/Msbuild.Integration.Test/MsbuildRestoreTaskTests.cs
Show resolved
Hide resolved
nkolev92
force-pushed
the
dev-nkolev92-fixPCtoProjectMapping
branch
from
395167e
to
0ffdb5a
Compare
|
Blocked by some restore issues. |
nkolev92
force-pushed
the
dev-nkolev92-fixPCtoProjectMapping
branch
from
e35086b
to
547267d
Compare
zivkan
approved these changes
May 30, 2024
nkolev92
added a commit
that referenced
this pull request
May 30, 2024
8 tasks
nkolev92
added a commit
that referenced
this pull request
May 31, 2024
martinrrm
pushed a commit
that referenced
this pull request
Jun 4, 2024
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.
Bug
Fixes: NuGet/Home#13456
Regression? Last working version:
Description
The implementation for PC vulnerability checking did not account for the fact that multiple projects might be in the same folder and lead to duplicate packages.config to project mapping.
This fixes that and adds test cases in both nuget.exe restore and msbuild -t:restore.
I've add some in line comments to aid with reviewing.
Please note that this will be patched in 6.10, so take that into consideration when reviewing (ie. focus on correctness, extra clean-up can be done as follow-up and review the tests for correctness).
PR Checklist
PR has a meaningful title
PR has a linked issue.
Described changes
Tests
Documentation