Support navigating to Object Browser from the Dependencies tree #9602

drewnoakes · 2024-11-27T12:22:52Z

Fixes #4867
Fixes #5643
Preparation for #1256 (needs change in NuGet.Client once this merges).

This change enables the "View in Object Browser" in some new places:

On assembly references
On project references
On framework reference assemblies

It also sets up changes needed for a future change in NuGet.Client that'll add support for the command on NuGet package assemblies.

Microsoft Reviewers: Open in CodeFlow

This allows down-level support for several .NET features. In particular I wanted list patterns, but it offers other features too. The package uses a source generator to add to the project.

This commit adds support for the context menu item "Open in Object Browser", which is added to context menus in the dependencies tree. The previous command handler only suppressed the menu item in nearly all cases. This new code adds support for nodes to advertise their support for this feature, and to provide a path to the DLL to browse. New groups/items are added to the relevant context menus in the VSCT file. A follow-up change will be made to NuGet, to allow browsing to package DLLs using the new `IObjectBrowserItem` interface added here.

External code that adds `IObjectBrowserItem` items to the dependencies tree needs to use an `IContextMenuController` provided by `RelatableItemBase.CreateContextMenuController`, as this implementation will track the selected item. This commit adds public API for external code to use.

zewditu · 2024-12-04T22:06:26Z

eng/imports/HostAgnostic.props

@@ -60,7 +60,7 @@

    <!-- 3rd party -->
    <PackageReference Include="Newtonsoft.Json" />
-    <PackageReference Include="IsExternalInit" PrivateAssets="all" />
+    <PackageReference Include="PolySharp" PrivateAssets="all" IncludeAssets="runtime; build; native; contentfiles; analyzers" />


I wish to learn more if there is a document I can refer about such kind setting more properties or constraint in package reference.

I think this document should cover that info: https://learn.microsoft.com/en-us/nuget/consume-packages/package-references-in-project-files

Let me know if there are specific questions that doc doesn't answer for you.

Note that the change here is based on the recommendation from NuGet.org: https://www.nuget.org/packages/PolySharp/

zewditu · 2024-12-05T00:24:22Z

LGTM!
QQ: If the goal is to make "Object Browser" more discoverable, are we able to have an option to get at the solution level for an equivalent of View -> Object browser in main tool bar?
I assumed the view menu object browser show all abject inside the solution.

src/Microsoft.VisualStudio.ProjectSystem.Managed.VS/Menus.vsct

melytc · 2024-12-05T01:10:52Z

...em/VS/Tree/Dependencies/AttachedCollections/Implementation/FrameworkReferenceAssemblyItem.cs


+        private string? GetAssemblyPath() => Path is not null
+            ? System.IO.Path.GetFullPath(System.IO.Path.Combine(Framework.Path, Path))


just curious, how does this path look like? are any of the paths rooted?

It ultimately ends up as an absolute path to the assembly, so that we can use it in the object browser and show it in the "Properties" view. The Framework.Path is something like C:\Program Files\dotnet\packs\Microsoft.NETCore.App.Ref\6.0.36 and the Path is something like ref\net6.0\Microsoft.CSharp.dll. The GetFullPath just makes the path look normal (i.e. consistent / vs \ characters).

...ProjectSystem.Managed.VS/ProjectSystem/VS/Tree/Dependencies/Commands/ObjectBrowserCommand.cs

melytc · 2024-12-05T01:19:54Z

...ProjectSystem.Managed.VS/ProjectSystem/VS/Tree/Dependencies/Commands/ObjectBrowserCommand.cs

+
+        void ShowAssemblyInObjectBrowser()
+        {
+            // We're opening a file as a container (DLL).


just curious, what does it mean to open a file as a container specifically? what other ways are supported?

"Container" is terminology from the Object Browser APIs. It basically means DLL, in that it contains types etc. You can also open at a specific symbol (method, property, type, etc), but we just want the DLL.

melytc · 2024-12-05T01:23:37Z

...lStudio.ProjectSystem.Managed/ProjectSystem/Rules/Dependencies/ResolvedProjectReference.xaml

@@ -30,9 +30,7 @@
                  ReadOnly="True"
                  Visible="False">
    <StringProperty.DataSource>
-      <DataSource ItemType="ProjectReference"
-                  PersistedName="Identity"


why were these two properties removed, ItemType and Persistence?

From memory this change makes the returned path be absolute rather than relative. Previously it returned the value of the <ProjectReference Include="../OtherProject/OtherProject.csproj"/> rather than the computed resolved path. We want the resolved path for the Object Browser.

drewnoakes · 2024-12-05T03:46:55Z

LGTM! QQ: If the goal is to make "Object Browser" more discoverable, are we able to have an option to get at the solution level for an equivalent of View -> Object browser in main tollbar? I assumed the view menu object browser show all abject inside the solution.

Do you mean whether we could have "View in Object Explorer" for the whole solution? I guess so, though it'd probably have to add multiple items to a "component set". I wondered the same thing for a NuGet package, where it would show all assemblies in the package (and possibly those brought in transitively too). Possibly something for a future improvement.

zewditu · 2024-12-05T04:51:03Z

LGTM! QQ: If the goal is to make "Object Browser" more discoverable, are we able to have an option to get at the solution level for an equivalent of View -> Object browser in main tollbar? I assumed the view menu object browser show all abject inside the solution.

Do you mean whether we could have "View in Object Explorer" for the whole solution? I guess so, though it'd probably have to add multiple items to a "component set". I wondered the same thing for a NuGet package, where it would show all assemblies in the package (and possibly those brought in transitively too). Possibly something for a future improvement.

Yes!

drewnoakes added 8 commits November 27, 2024 13:32

VSCT formatting

9d06bb5

Formatting and comment updates

df2ef42

Fix compile warning about multiple blank lines

434d2e0

Add PolySharp to the solution

38a5703

This allows down-level support for several .NET features. In particular I wanted list patterns, but it offers other features too. The package uses a source generator to add to the project.

Support showing project references in the object browser

0cc24dd

Support showing COM references in the object browser

32b7a4f

drewnoakes added Parity-Legacy-Feature Missing features from the legacy project system. Feature-Dependency-Node "Dependencies" node in Solution Explorer that display project, binary & package references labels Nov 27, 2024

drewnoakes requested a review from a team as a code owner November 27, 2024 12:22

zewditu reviewed Dec 4, 2024

View reviewed changes

melytc reviewed Dec 5, 2024

View reviewed changes

src/Microsoft.VisualStudio.ProjectSystem.Managed.VS/Menus.vsct Show resolved Hide resolved

melytc reviewed Dec 5, 2024

View reviewed changes

...ProjectSystem.Managed.VS/ProjectSystem/VS/Tree/Dependencies/Commands/ObjectBrowserCommand.cs Outdated Show resolved Hide resolved

melytc reviewed Dec 5, 2024

View reviewed changes

melytc approved these changes Dec 5, 2024

View reviewed changes

Remove extra white space

d2feb6e

zewditu approved these changes Dec 5, 2024

View reviewed changes

drewnoakes merged commit cd57e22 into dotnet:main Dec 5, 2024
5 checks passed

drewnoakes deleted the dep-tree-object-browser branch December 5, 2024 04:54

dotnet-policy-service bot added this to the 17.12 milestone Dec 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support navigating to Object Browser from the Dependencies tree #9602

Support navigating to Object Browser from the Dependencies tree #9602

drewnoakes commented Nov 27, 2024 •

edited by dotnet-policy-service bot

Loading

zewditu Dec 4, 2024 •

edited

Loading

drewnoakes Dec 5, 2024

zewditu commented Dec 5, 2024 •

edited

Loading

melytc Dec 5, 2024

drewnoakes Dec 5, 2024

melytc Dec 5, 2024

drewnoakes Dec 5, 2024

melytc Dec 5, 2024

drewnoakes Dec 5, 2024

drewnoakes commented Dec 5, 2024

zewditu commented Dec 5, 2024


		private string? GetAssemblyPath() => Path is not null
		? System.IO.Path.GetFullPath(System.IO.Path.Combine(Framework.Path, Path))

Support navigating to Object Browser from the Dependencies tree #9602

Support navigating to Object Browser from the Dependencies tree #9602

Conversation

drewnoakes commented Nov 27, 2024 • edited by dotnet-policy-service bot Loading

Microsoft Reviewers: Open in CodeFlow

zewditu Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

drewnoakes Dec 5, 2024

Choose a reason for hiding this comment

zewditu commented Dec 5, 2024 • edited Loading

melytc Dec 5, 2024

Choose a reason for hiding this comment

drewnoakes Dec 5, 2024

Choose a reason for hiding this comment

melytc Dec 5, 2024

Choose a reason for hiding this comment

drewnoakes Dec 5, 2024

Choose a reason for hiding this comment

melytc Dec 5, 2024

Choose a reason for hiding this comment

drewnoakes Dec 5, 2024

Choose a reason for hiding this comment

drewnoakes commented Dec 5, 2024

zewditu commented Dec 5, 2024

drewnoakes commented Nov 27, 2024 •

edited by dotnet-policy-service bot

Loading

zewditu Dec 4, 2024 •

edited

Loading

zewditu commented Dec 5, 2024 •

edited

Loading