Add `dotnet nuget why` command #5761

advay26 · 2024-04-23T01:16:17Z

Bug

Fixes: NuGet/Home#11943

Regression? Last working version:

Description

Adds a new dotnet nuget why command to the Dotnet CLI, allowing users to see the dependency graph for a given package. They can use this to easily identify the top-level packages that are bringing in a given transitive dependency.

dotnet nuget why -h

dotnet nuget why C:\TestProject.sln System.Text.Json

This was built on the proof-of-concept made by Pragnya and Kartheek: pragnya17-dotnet-nuget-why

PR Checklist

PR has a meaningful title
PR has a linked issue.
Described changes
Tests
- Automated tests added
- OR
- Test exception
- OR
- N/A
Documentation
- Documentation PR or issue filled: Add docs for dotnet nuget why Home#13499
- OR
- N/A

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandRunner.cs

donnie-msft

Really cool seeing this come together. Nice work!

test/NuGet.Core.FuncTests/NuGet.XPlat.FuncTest/XPlatWhyTests.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/IWhyCommandRunner.cs

test/NuGet.Core.FuncTests/NuGet.XPlat.FuncTest/XPlatWhyTests.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/Strings.resx

donnie-msft · 2024-04-26T21:09:23Z

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandRunner.cs

+            string targetPackage = whyCommandArgs.Package;
+
+            IEnumerable<string> projectPaths = Path.GetExtension(whyCommandArgs.Path).Equals(".sln")
+                                                    ? MSBuildAPIUtility.GetProjectsFromSolution(whyCommandArgs.Path).Where(f => File.Exists(f))


I'm guessing that MSBuild only returns project files which exist. @jeffkl would know for sure.

donnie-msft · 2024-04-26T21:14:13Z

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandRunner.cs

+
+            foreach (var projectPath in projectPaths)
+            {
+                Project project = MSBuildAPIUtility.GetProject(projectPath);


Maybe we can enhance the MSBuildAPIUtility to just return the ProjectAndSolution type instead of selecting only the paths in GetProjectsFromSolution. That way, you wouldn't need convert the paths back to projects, here.

I'm not familiar with these types, so let's see if @jeffkl has opinions on this.

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandRunner.cs

kartheekp-ms

I am still reviewing this PR but left couple of comments to begin with.

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandRunner.cs

test/NuGet.Core.FuncTests/NuGet.XPlat.FuncTest/XPlatWhyTests.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandRunner.cs

....Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandUtility/DependencyGraphFinder.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/DependencyNode.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandRunner.cs

....Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandUtility/DependencyGraphFinder.cs

zivkan

I forgot to submit these comments last week! Maybe some of them are no longer relevant due to updates made since I wrote the comments locally.

zivkan · 2024-05-16T22:51:46Z

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandRunner.cs

+using NuGet.CommandLine.XPlat.WhyCommandUtility;
+using NuGet.ProjectModel;
+
+namespace NuGet.CommandLine.XPlat


nitpick: Just wondering why the namespace is different to the project's default namespace + directory structure?

All commands and files in this project fall in the NuGet.CommandLine.XPlat namespace, so I've removed other namespaces like NuGet.CommandLine.XPlat.WhyCommandUtility and moved everything under NuGet.CommandLine.XPlat to keep things consistent. Let me know if you think this needs changes or can be improved upon

IMO the reasons to organize code on the filesystem is identical to the reasons to organize code in namespaces. Therefore, I consider it bad when they're out of sync. But I recognise that NuGet's existing code does this. I just think it's a bad pattern that we should stop copying. But I'm not going to hold up this PR because of this, and I don't know if anyone else in the team share my opinion. But for what it's worth, since this file's class is internal, there's no public API risk of moving it to a "more appropriate" namespace.

....Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommandUtility/DependencyGraphFinder.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/Strings.resx

advay26 requested a review from a team as a code owner April 23, 2024 01:16

Nigusu-Allehu reviewed Apr 23, 2024

View reviewed changes

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand.cs Outdated Show resolved Hide resolved

nkolev92 reviewed Apr 25, 2024

View reviewed changes

donnie-msft reviewed Apr 26, 2024

View reviewed changes

kartheekp-ms reviewed Apr 26, 2024

View reviewed changes

jebriede reviewed Apr 27, 2024

View reviewed changes

test/NuGet.Core.FuncTests/NuGet.XPlat.FuncTest/XPlatWhyTests.cs Outdated Show resolved Hide resolved

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand.cs Outdated Show resolved Hide resolved

kartheekp-ms mentioned this pull request May 2, 2024

[Feature]: Identify and report the package(s) with a transitive dependency upon a vulnerable package NuGet/Home#13422

Closed

advay26 added 23 commits May 3, 2024 12:26

applied changes from pragnya17-dotnet-nuget-why

708f4e2

cleaning up some old code

10245f8

wipping

2098b79

fixed duplicate paths bug

3d428bc

trees are beautiful

db9a7ce

rip my sleep schedule

ef25ca2

everything works now

9170c26

refactoring

b1b74f5

cleaning up strings

067430a

fixed redundant traversal bug

08e95fc

minor string stuff

ae50998

remove (*) deduplication, fix project reference bug

3f153f9

wip: recursion -> stack

8a750f1

recursion -> stack is working now

25804a8

wipping

a44299b

removed TODOs to clean up

073e9b5

added basic test; failed to run basic test;

7ed373a

test stubs - commented out

aaee328

cleanup + removed debugging code

ebc4732

Moved files to diff folder

4a42f3e

experimenting with tests

d9a6482

started addressing feedback, but wow it's a lot of work

904740e

adjusted tests to static class

69bfb3b

advay26 requested review from nkolev92, zivkan, jebriede and kartheekp-ms May 16, 2024 23:10

nkolev92 reviewed May 17, 2024

View reviewed changes

jebriede reviewed May 24, 2024

View reviewed changes

advay26 added 4 commits May 28, 2024 17:43

address feedback, try to fix unit tests path issue

d9c8890

fixed whitespace issue

6074b25

fixed unit test path issue for remaining file paths

7aceac8

trying to fix integration tests

8aff030

zivkan reviewed May 29, 2024

View reviewed changes

advay26 added 3 commits May 29, 2024 15:29

removed WhyCommandUtility sub directory

ee68859

oops

118735d

please work

7b9a2e9

advay26 requested review from nkolev92, zivkan, jebriede, jeffkl, martinrrm, donnie-msft and Nigusu-Allehu May 30, 2024 21:09

skip non-sdk stype projects + some more null dereference handling

4a60b13

zivkan approved these changes May 31, 2024

View reviewed changes

nkolev92 approved these changes Jun 1, 2024

View reviewed changes

advay26 merged commit 709d913 into dev Jun 4, 2024
28 of 31 checks passed

advay26 deleted the dev-advay26-dotnet-nuget-why branch June 4, 2024 03:41

advay26 mentioned this pull request Jun 6, 2024

Add tab completion for 'dotnet nuget why' command dotnet/sdk#41430

Merged

advay26 restored the dev-advay26-dotnet-nuget-why branch June 11, 2024 01:53

advay26 deleted the dev-advay26-dotnet-nuget-why branch June 18, 2024 04:49

advay26 mentioned this pull request Jun 19, 2024

Add docs for the 'dotnet nuget why' command dotnet/docs#41472

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `dotnet nuget why` command #5761

Add `dotnet nuget why` command #5761

advay26 commented Apr 23, 2024 •

edited

Loading

donnie-msft left a comment

donnie-msft Apr 26, 2024

donnie-msft Apr 26, 2024

kartheekp-ms left a comment

zivkan left a comment

zivkan May 16, 2024

advay26 May 29, 2024

zivkan May 31, 2024

Add dotnet nuget why command #5761

Add dotnet nuget why command #5761

Conversation

advay26 commented Apr 23, 2024 • edited Loading

Bug

Description

PR Checklist

donnie-msft left a comment

Choose a reason for hiding this comment

donnie-msft Apr 26, 2024

Choose a reason for hiding this comment

donnie-msft Apr 26, 2024

Choose a reason for hiding this comment

kartheekp-ms left a comment

Choose a reason for hiding this comment

zivkan left a comment

Choose a reason for hiding this comment

zivkan May 16, 2024

Choose a reason for hiding this comment

advay26 May 29, 2024

Choose a reason for hiding this comment

zivkan May 31, 2024

Choose a reason for hiding this comment

Add `dotnet nuget why` command #5761

Add `dotnet nuget why` command #5761

advay26 commented Apr 23, 2024 •

edited

Loading