From 8e964d1dcee950bf37276c613680b06b2a183345 Mon Sep 17 00:00:00 2001
From: tom-englert <mail@tom-englert.de>
Date: Thu, 19 Oct 2023 16:01:07 +0200
Subject: [PATCH] Improve dependency tree UX: quick search not only highlights,
 but also filters

---
 src/FodyWeavers.xml                           |  1 +
 src/NuGetMonitor.csproj                       |  1 +
 .../DependencyTree/DependencyTreeControl.xaml | 36 +++++++++++-----
 .../DependencyTree/DependencyTreeViewModel.cs | 43 ++++++++++++++++---
 4 files changed, 66 insertions(+), 15 deletions(-)

diff --git a/src/FodyWeavers.xml b/src/FodyWeavers.xml
index c371fb7..4408623 100644
--- a/src/FodyWeavers.xml
+++ b/src/FodyWeavers.xml
@@ -1,4 +1,5 @@
 <Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
+  <Throttle />
   <PropertyChanged />
   <ConfigureAwait ContinueOnCapturedContext="false" />
 </Weavers>
\ No newline at end of file
diff --git a/src/NuGetMonitor.csproj b/src/NuGetMonitor.csproj
index e35cdaa..db7dabc 100644
--- a/src/NuGetMonitor.csproj
+++ b/src/NuGetMonitor.csproj
@@ -24,6 +24,7 @@
     <PackageReference Include="Microsoft.VSSDK.BuildTools" Version="17.7.2196" PrivateAssets="all" />
     <PackageReference Include="NuGet.Protocol" Version="6.7.0" />
     <PackageReference Include="PropertyChanged.Fody" Version="4.1.0" PrivateAssets="all" />
+    <PackageReference Include="Throttle.Fody" Version="1.7.0" PrivateAssets="all" />
     <PackageReference Include="TomsToolbox.Wpf.Styles" Version="2.9.0" />
     <PackageReference Include="VSIX-SdkProjectAdapter" Version="3.0.0" PrivateAssets="all" />
   </ItemGroup>
diff --git a/src/View/DependencyTree/DependencyTreeControl.xaml b/src/View/DependencyTree/DependencyTreeControl.xaml
index 66d66dd..b79622a 100644
--- a/src/View/DependencyTree/DependencyTreeControl.xaml
+++ b/src/View/DependencyTree/DependencyTreeControl.xaml
@@ -8,9 +8,9 @@
              xmlns:styles="urn:TomsToolbox.Wpf.Styles"
              xmlns:imaging="clr-namespace:Microsoft.VisualStudio.Imaging;assembly=Microsoft.VisualStudio.Imaging"
              xmlns:imageCatalog="clr-namespace:Microsoft.VisualStudio.Imaging;assembly=Microsoft.VisualStudio.ImageCatalog"
-             xmlns:view="clr-namespace:NuGetMonitor.View"
              mc:Ignorable="d"
-             d:DesignHeight="450" d:DesignWidth="800">
+             d:DesignHeight="450" d:DesignWidth="800"
+             TextOptions.TextFormattingMode="Display">
   <UserControl.DataContext>
     <local:DependencyTreeViewModel />
   </UserControl.DataContext>
@@ -29,10 +29,7 @@
           </Style>
         </HierarchicalDataTemplate.ItemContainerStyle>
         <StackPanel Orientation="Horizontal" Margin="{StaticResource NodeMargin}">
-          <toms:HighlightingTextBlock x:Name="Identity"
-                                      Text="{Binding PackageIdentity}"
-                                      SearchText="{Binding ElementName=SearchText, Path=Text}"
-                                      HighLightBrush="{DynamicResource {x:Static SystemColors.HighlightBrushKey}}"/>
+          <TextBlock x:Name="Identity" Text="{Binding PackageIdentity}" />
           <TextBlock Text="{Binding Issues}" Foreground="{DynamicResource {x:Static SystemColors.ControlDarkDarkBrushKey}}" />
         </StackPanel>
         <HierarchicalDataTemplate.Triggers>
@@ -41,6 +38,23 @@
           </DataTrigger>
         </HierarchicalDataTemplate.Triggers>
       </HierarchicalDataTemplate>
+      <HierarchicalDataTemplate x:Key="FirstLevelNodeTemplate"
+                                DataType="{x:Type local:ChildNode}"
+                                ItemsSource="{Binding Children}"
+                                ItemTemplate="{StaticResource NodeTemplate}">
+        <HierarchicalDataTemplate.ItemContainerStyle>
+          <Style TargetType="TreeViewItem">
+            <Setter Property="IsExpanded" Value="True" />
+          </Style>
+        </HierarchicalDataTemplate.ItemContainerStyle>
+        <StackPanel Orientation="Horizontal" Margin="{StaticResource NodeMargin}">
+          <toms:HighlightingTextBlock x:Name="Identity"
+                                      Text="{Binding PackageIdentity}"
+                                      SearchText="{Binding ElementName=SearchText, Path=Text}"
+                                      HighLightBrush="{DynamicResource {x:Static SystemColors.HighlightBrushKey}}"/>
+          <TextBlock Text="{Binding Issues}" Foreground="{DynamicResource {x:Static SystemColors.ControlDarkDarkBrushKey}}" />
+        </StackPanel>
+      </HierarchicalDataTemplate>
     </ResourceDictionary>
   </UserControl.Resources>
   <Grid FocusManager.FocusedElement="{Binding ElementName=TreeView}">
@@ -53,12 +67,14 @@
         <Separator />
         <StackPanel Orientation="Horizontal">
           <imaging:CrispImage Width="16" Height="16" Moniker="{x:Static imageCatalog:KnownMonikers.QuickFind}" Margin="4,0" />
-          <TextBox x:Name="SearchText" Width="200" Style="{DynamicResource {x:Static ToolBar.TextBoxStyleKey}}" />
+          <TextBox x:Name="SearchText" Width="200" Style="{DynamicResource {x:Static ToolBar.TextBoxStyleKey}}" Text="{Binding SearchText, UpdateSourceTrigger=PropertyChanged}" />
         </StackPanel>
       </ToolBar>
       <TreeView x:Name="TreeView"
                 BorderThickness="0 1 0 0"
-                ItemsSource="{Binding TransitivePackages}">
+                ItemsSource="{Binding TransitivePackages}"
+                VirtualizingStackPanel.IsVirtualizing="True"
+                VirtualizingStackPanel.VirtualizationMode="Recycling">
         <TreeView.ItemContainerStyle>
           <Style TargetType="TreeViewItem">
             <Setter Property="IsExpanded" Value="True" />
@@ -67,13 +83,13 @@
         <TreeView.ItemTemplate>
           <HierarchicalDataTemplate DataType="{x:Type local:RootNode}"
                                     ItemsSource="{Binding Children}"
-                                    ItemTemplate="{StaticResource NodeTemplate}">
+                                    ItemTemplate="{StaticResource FirstLevelNodeTemplate}">
             <HierarchicalDataTemplate.ItemContainerStyle>
               <Style TargetType="TreeViewItem">
                 <Setter Property="IsExpanded" Value="False" />
               </Style>
             </HierarchicalDataTemplate.ItemContainerStyle>
-            <TextBlock Margin="{StaticResource NodeMargin}" FontSize="14">
+            <TextBlock Margin="{StaticResource NodeMargin}" FontWeight="Bold">
               <TextBlock.Text>
                 <MultiBinding StringFormat="{}{0} [{1}]">
                   <MultiBinding.Bindings>
diff --git a/src/View/DependencyTree/DependencyTreeViewModel.cs b/src/View/DependencyTree/DependencyTreeViewModel.cs
index 76fe1ef..d1a33f6 100644
--- a/src/View/DependencyTree/DependencyTreeViewModel.cs
+++ b/src/View/DependencyTree/DependencyTreeViewModel.cs
@@ -1,12 +1,16 @@
 using Community.VisualStudio.Toolkit;
 using NuGetMonitor.Services;
 using System.ComponentModel;
+using System.Windows.Data;
 using System.Windows.Input;
 using Microsoft.VisualStudio.Shell;
 using NuGet.Frameworks;
 using NuGetMonitor.Models;
 using TomsToolbox.Wpf;
 using NuGet.Packaging.Core;
+using PropertyChanged;
+using Throttle;
+using TomsToolbox.Essentials;
 
 namespace NuGetMonitor.View.DependencyTree;
 
@@ -59,19 +63,36 @@ private IEnumerable<string> GetIssueItems()
 internal sealed partial class RootNode : INotifyPropertyChanged
 {
     private readonly TransitiveDependencies _transitiveDependencies;
+    private readonly ListCollectionView _children;
 
     public RootNode(TransitiveDependencies transitiveDependencies)
     {
         _transitiveDependencies = transitiveDependencies;
+
+        var children = _transitiveDependencies.ParentsByChild
+            .OrderBy(item => item.Key.PackageIdentity)
+            .Select(item => new ChildNode(item.Key, _transitiveDependencies.ParentsByChild))
+            .ToArray();
+
+        _children = new ListCollectionView(children);
     }
 
     public string ProjectName => _transitiveDependencies.ProjectName;
 
     public NuGetFramework TargetFramework => _transitiveDependencies.TargetFramework;
 
-    public IEnumerable<ChildNode> Children => _transitiveDependencies.ParentsByChild
-        .OrderBy(item => item.Key.PackageIdentity)
-        .Select(item => new ChildNode(item.Key, _transitiveDependencies.ParentsByChild));
+    public ICollectionView Children => _children;
+
+    public void SetFilter(string? searchText)
+    {
+        if (searchText.IsNullOrWhiteSpace())
+        {
+            _children.Filter = null;
+            return;
+        }
+
+        _children.Filter = item => ((ChildNode)item).PackageIdentity.ToString().IndexOf(searchText, StringComparison.OrdinalIgnoreCase) >= 0;
+    }
 }
 
 #pragma warning disable CA1812 // Avoid uninstantiated internal classes => used in xaml!
@@ -90,6 +111,15 @@ public DependencyTreeViewModel()
 
     public ICommand RefreshCommand => new DelegateCommand(Refresh);
 
+    [OnChangedMethod(nameof(OnSearchTextChanged))]
+    public string? SearchText { get; set; }
+
+    [Throttled(typeof(TomsToolbox.Wpf.Throttle), 200)]
+    private void OnSearchTextChanged()
+    {
+        TransitivePackages?.ForEach(item => item.SetFilter(SearchText));
+    }
+
     private void Refresh()
     {
         ProjectService.ClearCache();
@@ -97,7 +127,7 @@ private void Refresh()
         Load().FireAndForget();
     }
 
-    public async Task Load()
+    private async Task Load()
     {
         try
         {
@@ -115,7 +145,10 @@ public async Task Load()
             TransitivePackages = transitivePackages
                 .OrderBy(item => item.ProjectName)
                 .ThenBy(item => item.TargetFramework.ToString())
-                .Select(item => new RootNode(item)).ToArray();
+                .Select(item => new RootNode(item))
+                .ToArray();
+
+            OnSearchTextChanged();
         }
         finally
         {