From db6fb33c9686fc2ab7d4a7af632c9082a5fdbfec Mon Sep 17 00:00:00 2001
From: Robert <mail@rbeekman.nl>
Date: Sun, 5 May 2024 16:27:08 +0200
Subject: [PATCH 1/2] Data model picker - Implemented search

---
 .../DataModelPicker/DataModelPicker.cs        | 91 ++++++++++++++++---
 .../Shared/DataModelEventViewModel.cs         | 11 ++-
 .../Shared/DataModelListItemViewModel.cs      |  7 ++
 .../Shared/DataModelListViewModel.cs          | 12 +++
 .../Shared/DataModelPropertiesViewModel.cs    | 14 ++-
 .../Shared/DataModelPropertyViewModel.cs      | 12 +++
 .../Shared/DataModelUpdateConfiguration.cs    | 13 ++-
 .../Shared/DataModelVisualizationViewModel.cs |  9 +-
 .../Styles/Controls/DataModelPicker.axaml     | 86 +++++++++++++-----
 .../Tabs/DataModel/DataModelDebugViewModel.cs |  2 +-
 10 files changed, 215 insertions(+), 42 deletions(-)

diff --git a/src/Artemis.UI.Shared/Controls/DataModelPicker/DataModelPicker.cs b/src/Artemis.UI.Shared/Controls/DataModelPicker/DataModelPicker.cs
index e3168eaba..996dc842c 100644
--- a/src/Artemis.UI.Shared/Controls/DataModelPicker/DataModelPicker.cs
+++ b/src/Artemis.UI.Shared/Controls/DataModelPicker/DataModelPicker.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Linq;
@@ -69,12 +70,19 @@ public class DataModelPicker : TemplatedControl
     public static readonly StyledProperty<bool> IsEventPickerProperty =
         AvaloniaProperty.Register<DataModelPicker, bool>(nameof(IsEventPicker));
 
+    private readonly ObservableCollection<DataModelVisualizationViewModel> _searchResults = [];
     private TextBlock? _currentPathDescription;
     private TextBlock? _currentPathDisplay;
 
     private MaterialIcon? _currentPathIcon;
     private TreeView? _dataModelTreeView;
+    private ListBox? _searchListBox;
+    private TextBox? _searchBox;
+    private Panel? _searchContainer;
+    private StackPanel? _searchEmpty;
     private DispatcherTimer? _updateTimer;
+    private string? _lastSearch;
+    private bool _firstUpdate;
 
     static DataModelPicker()
     {
@@ -200,7 +208,14 @@ private void Update(object? sender, EventArgs e)
         if (DataModelUIService == null)
             return;
 
-        DataModelViewModel?.Update(DataModelUIService, new DataModelUpdateConfiguration(!IsEventPicker));
+        DataModelViewModel?.Update(DataModelUIService, new DataModelUpdateConfiguration(!IsEventPicker, !string.IsNullOrEmpty(_searchBox?.Text)));
+        ApplySearch();
+
+        if (_firstUpdate)
+        {
+            _firstUpdate = false;
+            UpdateCurrentPath(true);
+        }
     }
 
     private void GetDataModel()
@@ -229,14 +244,15 @@ private void DataModelOnUpdateRequested(object? sender, EventArgs e)
         if (DataModelUIService == null || DataModelViewModel == null)
             return;
 
-        DataModelViewModel.Update(DataModelUIService, new DataModelUpdateConfiguration(IsEventPicker));
+        DataModelViewModel.Update(DataModelUIService, new DataModelUpdateConfiguration(!IsEventPicker, !string.IsNullOrEmpty(_searchBox?.Text)));
         DataModelViewModel.ApplyTypeFilter(true, FilterTypes?.ToArray() ?? Type.EmptyTypes);
+        ApplySearch();
     }
 
-    private void DataModelTreeViewOnSelectionChanged(object? sender, SelectionChangedEventArgs e)
+    private void TreeViewOnSelectionChanged(object? sender, SelectionChangedEventArgs e)
     {
-        // Multi-select isn't a think so grab the first one
-        object? selected = _dataModelTreeView?.SelectedItems[0];
+        // Multi-select isn't a thing so grab the first one
+        object? selected = e.AddedItems[0];
         if (selected == null)
             return;
 
@@ -255,12 +271,48 @@ private void DataModelTreeViewOnDoubleTapped(object? sender, RoutedEventArgs e)
             treeViewItem.IsExpanded = !treeViewItem.IsExpanded;
     }
 
+    private void ApplySearch()
+    {
+        if (DataModelViewModel == null || string.IsNullOrWhiteSpace(_searchBox?.Text))
+        {
+            if (_dataModelTreeView != null)
+                _dataModelTreeView.IsVisible = true;
+            if (_searchContainer != null)
+                _searchContainer.IsVisible = false;
+            return;
+        }
+
+        if (_dataModelTreeView != null)
+            _dataModelTreeView.IsVisible = false;
+        if (_searchContainer != null)
+            _searchContainer.IsVisible = true;
+
+        if (_searchBox.Text != _lastSearch)
+        {
+            _searchResults.Clear();
+            foreach (DataModelVisualizationViewModel searchResult in DataModelViewModel.GetSearchResults(_searchBox.Text).DistinctBy(r => r.Path).Take(20))
+                _searchResults.Add(searchResult);
+            _lastSearch = _searchBox.Text;
+        }
+
+        if (_searchListBox != null)
+        {
+            _searchListBox.IsVisible = _searchResults.Count > 0;
+            _searchListBox.SelectedItem = _searchResults.FirstOrDefault(r => r.DataModelPath?.Path == DataModelPath?.Path);
+        }
+
+        if (_searchEmpty != null)
+            _searchEmpty.IsVisible = _searchResults.Count == 0;
+        
+       
+    }
+
     private void UpdateCurrentPath(bool selectCurrentPath)
     {
-        if (DataModelPath == null)
+        if (DataModelPath == null || _dataModelTreeView == null)
             return;
 
-        if (_dataModelTreeView != null && selectCurrentPath)
+        if (selectCurrentPath)
         {
             // Expand the path
             DataModel? start = DataModelPath.Target;
@@ -286,7 +338,7 @@ private void UpdateCurrentPath(bool selectCurrentPath)
     protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
     {
         if (_dataModelTreeView != null)
-            _dataModelTreeView.SelectionChanged -= DataModelTreeViewOnSelectionChanged;
+            _dataModelTreeView.SelectionChanged -= TreeViewOnSelectionChanged;
         if (_dataModelTreeView != null)
             _dataModelTreeView.DoubleTapped -= DataModelTreeViewOnDoubleTapped;
 
@@ -294,11 +346,22 @@ protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
         _currentPathDisplay = e.NameScope.Find<TextBlock>("CurrentPathDisplay");
         _currentPathDescription = e.NameScope.Find<TextBlock>("CurrentPathDescription");
         _dataModelTreeView = e.NameScope.Find<TreeView>("DataModelTreeView");
+        _searchBox = e.NameScope.Find<TextBox>("SearchBox");
+        _searchContainer = e.NameScope.Find<Panel>("SearchContainer");
+        _searchListBox = e.NameScope.Find<ListBox>("SearchListBox");
+        _searchEmpty = e.NameScope.Find<StackPanel>("SearchEmpty");
 
         if (_dataModelTreeView != null)
-            _dataModelTreeView.SelectionChanged += DataModelTreeViewOnSelectionChanged;
-        if (_dataModelTreeView != null)
+        {
+            _dataModelTreeView.SelectionChanged += TreeViewOnSelectionChanged;
             _dataModelTreeView.DoubleTapped += DataModelTreeViewOnDoubleTapped;
+        }
+
+        if (_searchListBox != null)
+        {
+            _searchListBox.ItemsSource = _searchResults;
+            _searchListBox.SelectionChanged += TreeViewOnSelectionChanged;
+        }
     }
 
     #region Overrides of Visual
@@ -307,17 +370,23 @@ protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
     protected override void OnAttachedToVisualTree(VisualTreeAttachmentEventArgs e)
     {
         GetDataModel();
-        UpdateCurrentPath(true);
+        
         _updateTimer = new DispatcherTimer(TimeSpan.FromMilliseconds(200), DispatcherPriority.Background, Update);
         _updateTimer.Start();
+        _firstUpdate = true;
     }
 
     /// <inheritdoc />
     protected override void OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs e)
     {
         DataModelViewModel?.Dispose();
+
         _updateTimer?.Stop();
         _updateTimer = null;
+
+        _lastSearch = null;
+        if (_searchBox != null)
+            _searchBox.Text = null;
     }
 
     #endregion
diff --git a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelEventViewModel.cs b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelEventViewModel.cs
index b3c16c860..312d95a36 100644
--- a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelEventViewModel.cs
+++ b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelEventViewModel.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using Artemis.Core;
 using Artemis.Core.Modules;
@@ -41,13 +42,21 @@ public override void Update(IDataModelUIService dataModelUIService, DataModelUpd
         }
 
         // Only update children if the parent is expanded
-        if (Parent != null && !Parent.IsRootViewModel && !Parent.IsVisualizationExpanded)
+        if (Parent != null && !Parent.IsRootViewModel && !Parent.IsVisualizationExpanded && (configuration == null || !configuration.UpdateAllChildren))
             return;
 
         foreach (DataModelVisualizationViewModel dataModelVisualizationViewModel in Children)
             dataModelVisualizationViewModel.Update(dataModelUIService, configuration);
     }
 
+    /// <inheritdoc />
+    public override IEnumerable<DataModelVisualizationViewModel> GetSearchResults(string search)
+    {
+        if (PropertyDescription?.Name != null && PropertyDescription.Name.Contains(search, StringComparison.OrdinalIgnoreCase))
+            return [this];
+        return [];
+    }
+
     /// <summary>
     ///     Always returns <see langword="null" /> for data model events
     /// </summary>
diff --git a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelListItemViewModel.cs b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelListItemViewModel.cs
index 0a553339c..fd7a7a74f 100644
--- a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelListItemViewModel.cs
+++ b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelListItemViewModel.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using Artemis.UI.Shared.Services;
 using ReactiveUI;
 
@@ -62,6 +63,12 @@ public object? DisplayValue
         internal set => this.RaiseAndSetIfChanged(ref _displayValue, value);
     }
 
+    /// <inheritdoc />
+    public override IEnumerable<DataModelVisualizationViewModel> GetSearchResults(string search)
+    {
+        return [];
+    }
+
     /// <inheritdoc />
     public override object? GetCurrentValue()
     {
diff --git a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelListViewModel.cs b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelListViewModel.cs
index 0d0ca66dd..b04d61d2b 100644
--- a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelListViewModel.cs
+++ b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelListViewModel.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections;
+using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using Artemis.Core;
 using Artemis.Core.Modules;
@@ -119,6 +120,17 @@ public override void Update(IDataModelUIService dataModelUIService, DataModelUpd
         CountDisplay = $"{ListChildren.Count} {(ListChildren.Count == 1 ? "item" : "items")}";
     }
 
+    /// <inheritdoc />
+    public override IEnumerable<DataModelVisualizationViewModel> GetSearchResults(string search)
+    {
+        if (PropertyDescription?.Name != null && PropertyDescription.Name.Contains(search, StringComparison.OrdinalIgnoreCase))
+            return [this];
+        if (PropertyDescription?.Description != null && PropertyDescription.Description.Contains(search, StringComparison.OrdinalIgnoreCase))
+            return [this];
+        
+        return [];
+    }
+
     /// <inheritdoc />
     public override string ToString()
     {
diff --git a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelPropertiesViewModel.cs b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelPropertiesViewModel.cs
index fe1d226c4..ca03c5c26 100644
--- a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelPropertiesViewModel.cs
+++ b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelPropertiesViewModel.cs
@@ -1,4 +1,6 @@
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using Artemis.Core;
 using Artemis.Core.Modules;
 using Artemis.UI.Shared.Services;
@@ -52,14 +54,20 @@ public override void Update(IDataModelUIService dataModelUIService, DataModelUpd
         // Always populate properties   
         PopulateProperties(dataModelUIService, configuration);
 
-        // Only update children if the parent is expanded
-        if (Parent != null && !Parent.IsRootViewModel && !Parent.IsVisualizationExpanded)
+        // Only update children if the parent is expanded or when searching
+        if (Parent != null && !Parent.IsRootViewModel && !Parent.IsVisualizationExpanded && (configuration == null || !configuration.UpdateAllChildren))
             return;
-
+        
         foreach (DataModelVisualizationViewModel dataModelVisualizationViewModel in Children)
             dataModelVisualizationViewModel.Update(dataModelUIService, configuration);
     }
 
+    /// <inheritdoc />
+    public override IEnumerable<DataModelVisualizationViewModel> GetSearchResults(string search)
+    {
+        return Children.SelectMany(c => c.GetSearchResults(search));
+    }
+
     /// <inheritdoc />
     public override object? GetCurrentValue()
     {
diff --git a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelPropertyViewModel.cs b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelPropertyViewModel.cs
index a68ee78a2..69e60578d 100644
--- a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelPropertyViewModel.cs
+++ b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelPropertyViewModel.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using Artemis.Core;
 using Artemis.Core.Modules;
 using Artemis.UI.Shared.Services;
@@ -71,6 +72,17 @@ public override void Update(IDataModelUIService dataModelUIService, DataModelUpd
         DisplayViewModel?.UpdateValue(DisplayValue);
     }
 
+    /// <inheritdoc />
+    public override IEnumerable<DataModelVisualizationViewModel> GetSearchResults(string search)
+    {
+        if (PropertyDescription?.Name != null && PropertyDescription.Name.Contains(search, StringComparison.OrdinalIgnoreCase))
+            return [this];
+        if (DisplayValue != null && DisplayValue.ToString()?.Contains(search, StringComparison.OrdinalIgnoreCase) == true)
+            return [this];
+
+        return [];
+    }
+
     /// <inheritdoc />
     public override string ToString()
     {
diff --git a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelUpdateConfiguration.cs b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelUpdateConfiguration.cs
index 1cf9dcce7..f4f30e082 100644
--- a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelUpdateConfiguration.cs
+++ b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelUpdateConfiguration.cs
@@ -8,14 +8,21 @@ public class DataModelUpdateConfiguration
     /// <summary>
     ///     Creates a new instance of the <see cref="DataModelUpdateConfiguration" /> class
     /// </summary>
-    /// <param name="createEventChildren">A boolean indicating whether or not event children should be created</param>
-    public DataModelUpdateConfiguration(bool createEventChildren)
+    /// <param name="createEventChildren">A boolean indicating whether event children should be created</param>
+    /// <param name="updateAllChildren">A boolean indicating whether all children should be updated</param>
+    public DataModelUpdateConfiguration(bool createEventChildren, bool updateAllChildren)
     {
         CreateEventChildren = createEventChildren;
+        UpdateAllChildren = updateAllChildren;
     }
 
     /// <summary>
-    ///     Gets a boolean indicating whether or not event children should be created
+    ///     Gets a boolean indicating whether event children should be created
     /// </summary>
     public bool CreateEventChildren { get; }
+
+    /// <summary>
+    ///     Gets a boolean indicating whether all children should be updated
+    /// </summary>
+    public bool UpdateAllChildren { get; }
 }
\ No newline at end of file
diff --git a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelVisualizationViewModel.cs b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelVisualizationViewModel.cs
index 77f429408..95d07a35b 100644
--- a/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelVisualizationViewModel.cs
+++ b/src/Artemis.UI.Shared/DataModelVisualization/Shared/DataModelVisualizationViewModel.cs
@@ -144,6 +144,13 @@ public bool IsVisualizationExpanded
     /// <param name="configuration">The configuration to apply while updating</param>
     public abstract void Update(IDataModelUIService dataModelUIService, DataModelUpdateConfiguration? configuration);
 
+    /// <summary>
+    ///   Gets the search results for the provided search string
+    /// </summary>
+    /// <param name="search">The search string</param>
+    /// <returns>The search results</returns>
+    public abstract IEnumerable<DataModelVisualizationViewModel> GetSearchResults(string search);
+
     /// <summary>
     ///     Gets the current value of the property being visualized
     /// </summary>
@@ -281,7 +288,7 @@ internal void PopulateProperties(IDataModelUIService dataModelUIService, DataMod
             foreach (PropertyInfo propertyInfo in modelType.GetProperties(BindingFlags.Public | BindingFlags.Instance).OrderBy(t => t.MetadataToken))
             {
                 string childPath = AppendToPath(propertyInfo.Name);
-                
+
                 if (!ShouldIncludePath(childPath, propertyInfo))
                     continue;
 
diff --git a/src/Artemis.UI.Shared/Styles/Controls/DataModelPicker.axaml b/src/Artemis.UI.Shared/Styles/Controls/DataModelPicker.axaml
index 0175ae880..18df7201a 100644
--- a/src/Artemis.UI.Shared/Styles/Controls/DataModelPicker.axaml
+++ b/src/Artemis.UI.Shared/Styles/Controls/DataModelPicker.axaml
@@ -11,38 +11,43 @@
     <Style Selector="dataModelPicker|DataModelPicker">
         <Setter Property="Template">
             <ControlTemplate>
-                <Grid RowDefinitions="Auto,Auto,*" Width="600" Height="400" Margin="10">
-                    <TextBox Grid.Row="0" Watermark="Search - not yet implemented 😱" Name="SearchBox" IsEnabled="False" />
+                <Grid RowDefinitions="Auto,Auto,*" MinWidth="600" MaxHeight="1200" Height="400" Margin="10">
+                    <TextBox Grid.Row="0" Watermark="Search" Name="SearchBox" Classes="search-box" />
 
                     <Border Grid.Row="1" Classes="card card-condensed" Margin="0 10">
                         <Panel>
                             <Grid ColumnDefinitions="Auto,*"
                                   RowDefinitions="*"
                                   MinHeight="38"
-                                  IsVisible="{CompiledBinding DataModelPath, RelativeSource={RelativeSource TemplatedParent}, Converter={x:Static ObjectConverters.IsNotNull}}">
+                                  IsVisible="{CompiledBinding ElementName=CurrentPathDisplay, Path=Text, Converter={x:Static StringConverters.IsNotNullOrEmpty}}">
                                 <avalonia:MaterialIcon Grid.Column="0"
-													   Grid.Row="0" 
-                                                       Name="CurrentPathIcon" 
-                                                       Kind="QuestionMarkCircle" 
+                                                       Grid.Row="0"
+                                                       Name="CurrentPathIcon"
+                                                       Kind="QuestionMarkCircle"
                                                        Height="22"
                                                        Width="22"
-                                                       Margin="5 0 15 0" 
-                                                       IsVisible="{CompiledBinding !IsEventPicker, RelativeSource={RelativeSource TemplatedParent}}"/>
+                                                       Margin="5 0 15 0"
+                                                       IsVisible="{CompiledBinding !IsEventPicker, RelativeSource={RelativeSource TemplatedParent}}" />
                                 <avalonia:MaterialIcon Grid.Column="0"
-                                                       Grid.Row="0" 
+                                                       Grid.Row="0"
                                                        Name="EventIcon"
                                                        Kind="LightningBolt"
                                                        Height="22"
-                                                       Width="22" 
+                                                       Width="22"
                                                        Margin="5 0 15 0"
-                                                       IsVisible="{CompiledBinding IsEventPicker, RelativeSource={RelativeSource TemplatedParent}}"/>
+                                                       IsVisible="{CompiledBinding IsEventPicker, RelativeSource={RelativeSource TemplatedParent}}" />
                                 <StackPanel Grid.Column="1" Grid.Row="0" VerticalAlignment="Center">
                                     <TextBlock Name="CurrentPathDisplay" Classes="BodyStrongTextBlockStyle" MaxHeight="50" />
-                                    <TextBlock Name="CurrentPathDescription" Classes="BodyTextBlockStyle" Foreground="{DynamicResource TextFillColorSecondary}" MaxHeight="50" />
+                                    <TextBlock Name="CurrentPathDescription"
+                                               IsVisible="{CompiledBinding ElementName=CurrentPathDescription, Path=Text, Converter={x:Static StringConverters.IsNotNullOrEmpty}}"
+                                               Classes="BodyTextBlockStyle"
+                                               Foreground="{DynamicResource TextFillColorSecondary}"
+                                               MaxHeight="50" />
                                 </StackPanel>
                             </Grid>
                             <Grid MinHeight="38"
-                                  IsVisible="{CompiledBinding DataModelPath, RelativeSource={RelativeSource TemplatedParent}, Converter={x:Static ObjectConverters.IsNull}}" ColumnDefinitions="*,Auto"
+                                  IsVisible="{CompiledBinding ElementName=CurrentPathDisplay, Path=Text, Converter={x:Static StringConverters.IsNullOrEmpty}}"
+                                  ColumnDefinitions="*,Auto"
                                   RowDefinitions="*,*">
                                 <TextBlock Grid.Column="0" Grid.Row="0" Classes="BodyStrongTextBlockStyle">Welcome to the data model picker</TextBlock>
                                 <TextBlock Grid.Column="0" Grid.Row="1" Foreground="{DynamicResource TextFillColorSecondary}">Select a value from the data model below</TextBlock>
@@ -53,7 +58,8 @@
 
                     <TreeView Grid.Row="2"
                               Name="DataModelTreeView"
-                              ItemsSource="{CompiledBinding DataModelViewModel.Children, RelativeSource={RelativeSource TemplatedParent}}">
+                              ItemsSource="{CompiledBinding DataModelViewModel.Children, RelativeSource={RelativeSource TemplatedParent}}"
+                              IsVisible="False">
                         <TreeView.Styles>
                             <Style Selector="TreeViewItem">
                                 <Setter Property="IsExpanded" Value="{CompiledBinding IsVisualizationExpanded, Mode=TwoWay, DataType=dataModel:DataModelVisualizationViewModel}" />
@@ -69,7 +75,7 @@
                                                FontFamily="{StaticResource RobotoMono}"
                                                FontSize="13"
                                                HorizontalAlignment="Right"
-                                               Margin="0 0 10 0" />
+                                               Margin="10 0"/>
                                 </Grid>
                             </TreeDataTemplate>
 
@@ -79,10 +85,10 @@
                                         <TextBlock Text="{CompiledBinding PropertyDescription.Name}" ToolTip.Tip="{CompiledBinding PropertyDescription.Description}" />
                                         <TextBlock Text=" changed"
                                                    ToolTip.Tip="{CompiledBinding PropertyDescription.Description}"
-                                                   IsVisible="{CompiledBinding IsEventPicker, RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type dataModelPicker:DataModelPicker}}}"/>
+                                                   IsVisible="{CompiledBinding IsEventPicker, RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type dataModelPicker:DataModelPicker}}}" />
                                     </StackPanel>
 
-                                    <ContentControl Grid.Column="1" Content="{CompiledBinding DisplayViewModel}" FontFamily="{StaticResource RobotoMono}" FontSize="13" Margin="0 0 10 0" />
+                                    <ContentControl Grid.Column="1" Content="{CompiledBinding DisplayViewModel}" FontFamily="{StaticResource RobotoMono}" FontSize="13" Margin="10 0" />
                                 </Grid>
                             </TreeDataTemplate>
 
@@ -94,7 +100,7 @@
                                                FontFamily="{StaticResource RobotoMono}"
                                                FontSize="13"
                                                HorizontalAlignment="Right"
-                                               Margin="0 0 10 0" />
+                                               Margin="10 0" />
                                 </Grid>
                             </TreeDataTemplate>
 
@@ -103,10 +109,46 @@
                             </TreeDataTemplate>
                         </TreeView.DataTemplates>
                     </TreeView>
-                    <StackPanel Grid.Row="2" VerticalAlignment="Center" Spacing="20" IsVisible="False">
-                        <avalonia:MaterialIcon Kind="CloseCircle" Width="64" Height="64"></avalonia:MaterialIcon>
-                        <TextBlock Classes="h4" TextAlignment="Center">No parts of the data model match your search</TextBlock>
-                    </StackPanel>
+
+                    <Panel Name="SearchContainer" Grid.Row="2">
+                        <ListBox Name="SearchListBox">
+                            <ListBox.DataTemplates>
+                                <DataTemplate DataType="{x:Type dataModel:DataModelPropertyViewModel}">
+                                    <Grid ColumnDefinitions="Auto,*">
+                                        <StackPanel Grid.Column="0" Orientation="Horizontal">
+                                            <TextBlock Text="{CompiledBinding DisplayPath}" ToolTip.Tip="{CompiledBinding PropertyDescription.Description}" />
+                                            <TextBlock Text=" changed"
+                                                       ToolTip.Tip="{CompiledBinding PropertyDescription.Description}"
+                                                       IsVisible="{CompiledBinding IsEventPicker, RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type dataModelPicker:DataModelPicker}}}" />
+                                        </StackPanel>
+
+                                        <ContentControl Grid.Column="1" Content="{CompiledBinding DisplayViewModel}" FontFamily="{StaticResource RobotoMono}" FontSize="13" Margin="10 0"/>
+                                    </Grid>
+                                </DataTemplate>
+
+                                <DataTemplate DataType="{x:Type dataModel:DataModelListViewModel}">
+                                    <Grid ColumnDefinitions="Auto,*">
+                                        <TextBlock Grid.Column="0" Text="{CompiledBinding DisplayPath}" ToolTip.Tip="{CompiledBinding PropertyDescription.Description}" />
+                                        <TextBlock Grid.Column="1"
+                                                   Text="{CompiledBinding CountDisplay, Mode=OneWay}"
+                                                   FontFamily="{StaticResource RobotoMono}"
+                                                   FontSize="13"
+                                                   HorizontalAlignment="Right"
+                                                   Margin="10 0"/>
+                                    </Grid>
+                                </DataTemplate>
+                                
+                                <TreeDataTemplate DataType="{x:Type dataModel:DataModelEventViewModel}" ItemsSource="{CompiledBinding Children}">
+                                    <TextBlock Text="{CompiledBinding DisplayPath}" ToolTip.Tip="{CompiledBinding PropertyDescription.Description}" />
+                                </TreeDataTemplate>
+                            </ListBox.DataTemplates>
+                        </ListBox>
+
+                        <StackPanel Name="SearchEmpty" VerticalAlignment="Center" Spacing="20" IsVisible="False">
+                            <avalonia:MaterialIcon Kind="CloseCircle" Width="64" Height="64"></avalonia:MaterialIcon>
+                            <TextBlock Classes="h4" TextAlignment="Center">No parts of the data model match your search</TextBlock>
+                        </StackPanel>
+                    </Panel>
                 </Grid>
 
             </ControlTemplate>
diff --git a/src/Artemis.UI/Screens/Debugger/Tabs/DataModel/DataModelDebugViewModel.cs b/src/Artemis.UI/Screens/Debugger/Tabs/DataModel/DataModelDebugViewModel.cs
index 09ceb0a70..88c40497b 100644
--- a/src/Artemis.UI/Screens/Debugger/Tabs/DataModel/DataModelDebugViewModel.cs
+++ b/src/Artemis.UI/Screens/Debugger/Tabs/DataModel/DataModelDebugViewModel.cs
@@ -100,7 +100,7 @@ private void Update()
 
         lock (MainDataModel)
         {
-            MainDataModel.Update(_dataModelUIService, new DataModelUpdateConfiguration(true));
+            MainDataModel.Update(_dataModelUIService, new DataModelUpdateConfiguration(true, false));
         }
     }
 

From 3022c7df651cfa2afb7095f2462610dfe697165d Mon Sep 17 00:00:00 2001
From: RobertBeekman <mail@rbeekman.nl>
Date: Thu, 16 May 2024 20:40:45 +0200
Subject: [PATCH 2/2] Core - Add device provider suspension system

---
 .../Plugins/DeviceProviders/DeviceProvider.cs | 16 +++-
 src/Artemis.Core/Services/DeviceService.cs    | 91 +++++++++++++++++--
 .../Services/Interfaces/IDeviceService.cs     | 11 +++
 src/Artemis.UI.Windows/App.axaml.cs           | 17 ++--
 .../Artemis.UI.Windows.csproj                 |  1 +
 src/Artemis.UI.Windows/SuspensionManager.cs   | 67 ++++++++++++++
 .../Services/AuthenticationService.cs         |  2 +-
 src/Directory.Packages.props                  |  1 +
 8 files changed, 192 insertions(+), 14 deletions(-)
 create mode 100644 src/Artemis.UI.Windows/SuspensionManager.cs

diff --git a/src/Artemis.Core/Plugins/DeviceProviders/DeviceProvider.cs b/src/Artemis.Core/Plugins/DeviceProviders/DeviceProvider.cs
index ee9f256a9..263748f0d 100644
--- a/src/Artemis.Core/Plugins/DeviceProviders/DeviceProvider.cs
+++ b/src/Artemis.Core/Plugins/DeviceProviders/DeviceProvider.cs
@@ -1,6 +1,7 @@
 using System;
 using System.IO;
 using System.Linq;
+using System.Threading.Tasks;
 using RGB.NET.Core;
 
 namespace Artemis.Core.DeviceProviders;
@@ -15,7 +16,7 @@ public abstract class DeviceProvider : PluginFeature
     ///     The RGB.NET device provider backing this Artemis device provider
     /// </summary>
     public abstract IRGBDeviceProvider RgbDeviceProvider { get; }
-    
+
     /// <summary>
     ///     A boolean indicating whether this device provider detects the physical layout of connected keyboards.
     ///     <para>
@@ -48,6 +49,11 @@ public abstract class DeviceProvider : PluginFeature
     /// </summary>
     public bool RemoveExcessiveLedsSupported { get; protected set; } = true;
 
+    /// <summary>
+    ///     Gets or sets a boolean indicating whether suspending the device provider is supported
+    /// </summary>
+    public bool SuspendSupported { get; protected set; }
+
     /// <summary>
     ///     Loads a layout for the specified device and wraps it in an <see cref="ArtemisLayout" />
     /// </summary>
@@ -109,4 +115,12 @@ public virtual string GetDeviceLayoutName(ArtemisDevice device)
 
         return fileName + ".xml";
     }
+
+    /// <summary>
+    /// Called when the device provider is being suspended, like when the system is going to sleep.
+    /// Note: This will be called while the plugin is disabled.
+    /// </summary>
+    public virtual void Suspend()
+    {
+    }
 }
\ No newline at end of file
diff --git a/src/Artemis.Core/Services/DeviceService.cs b/src/Artemis.Core/Services/DeviceService.cs
index 111594c4a..5d2da4db4 100644
--- a/src/Artemis.Core/Services/DeviceService.cs
+++ b/src/Artemis.Core/Services/DeviceService.cs
@@ -2,13 +2,13 @@
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using Artemis.Core.DeviceProviders;
 using Artemis.Core.Providers;
 using Artemis.Core.Services.Models;
 using Artemis.Storage.Entities.Surface;
 using Artemis.Storage.Repositories.Interfaces;
-using DryIoc;
 using RGB.NET.Core;
 using Serilog;
 
@@ -21,8 +21,10 @@ internal class DeviceService : IDeviceService
     private readonly IDeviceRepository _deviceRepository;
     private readonly Lazy<IRenderService> _renderService;
     private readonly Func<List<ILayoutProvider>> _getLayoutProviders;
-    private readonly List<ArtemisDevice> _enabledDevices = new();
-    private readonly List<ArtemisDevice> _devices = new();
+    private readonly List<ArtemisDevice> _enabledDevices = [];
+    private readonly List<ArtemisDevice> _devices = [];
+    private readonly List<DeviceProvider> _suspendedDeviceProviders = [];
+    private readonly object _suspensionLock = new();
 
     public DeviceService(ILogger logger,
         IPluginManagementService pluginManagementService,
@@ -69,7 +71,7 @@ public void AddDeviceProvider(DeviceProvider deviceProvider)
                 OnDeviceRemoved(new DeviceEventArgs(device));
             }
 
-            List<Exception> providerExceptions = new();
+            List<Exception> providerExceptions = [];
 
             void DeviceProviderOnException(object? sender, ExceptionEventArgs e)
             {
@@ -95,7 +97,7 @@ void DeviceProviderOnException(object? sender, ExceptionEventArgs e)
                 return;
             }
 
-            List<ArtemisDevice> addedDevices = new();
+            List<ArtemisDevice> addedDevices = [];
             foreach (IRGBDevice rgbDevice in rgbDeviceProvider.Devices)
             {
                 ArtemisDevice artemisDevice = GetArtemisDevice(rgbDevice);
@@ -184,7 +186,7 @@ public void LoadDeviceLayout(ArtemisDevice device)
                 device.ApplyLayout(null, false, false);
             else
                 provider?.ApplyLayout(device, layout);
-            
+
             UpdateLeds();
         }
         catch (Exception e)
@@ -241,6 +243,83 @@ public void SaveDevices()
         UpdateLeds();
     }
 
+    /// <inheritdoc />
+    public void SuspendDeviceProviders()
+    {
+        lock (_suspensionLock)
+        {
+            _logger.Information("Suspending all device providers");
+
+            bool wasPaused = _renderService.Value.IsPaused;
+            try
+            {
+                _renderService.Value.IsPaused = true;
+                foreach (DeviceProvider deviceProvider in _pluginManagementService.GetFeaturesOfType<DeviceProvider>().Where(d => d.SuspendSupported))
+                    SuspendDeviceProvider(deviceProvider);
+            }
+            finally
+            {
+                _renderService.Value.IsPaused = wasPaused;
+            }
+        }
+    }
+
+    /// <inheritdoc />
+    public void ResumeDeviceProviders()
+    {
+        lock (_suspensionLock)
+        {
+            _logger.Information("Resuming all device providers");
+
+            bool wasPaused = _renderService.Value.IsPaused;
+            try
+            {
+                _renderService.Value.IsPaused = true;
+                foreach (DeviceProvider deviceProvider in _suspendedDeviceProviders.ToList())
+                    ResumeDeviceProvider(deviceProvider);
+            }
+            finally
+            {
+                _renderService.Value.IsPaused = wasPaused;
+            }
+        }
+    }
+
+    private void SuspendDeviceProvider(DeviceProvider deviceProvider)
+    {
+        if (_suspendedDeviceProviders.Contains(deviceProvider))
+        {
+            _logger.Warning("Device provider {DeviceProvider} is already suspended", deviceProvider.Info.Name);
+            return;
+        }
+
+        try
+        {
+            _pluginManagementService.DisablePluginFeature(deviceProvider, false);
+            deviceProvider.Suspend();
+            _suspendedDeviceProviders.Add(deviceProvider);
+            _logger.Information("Device provider {DeviceProvider} suspended", deviceProvider.Info.Name);
+        }
+        catch (Exception e)
+        {
+            _logger.Error(e, "Device provider {DeviceProvider} failed to suspend", deviceProvider.Info.Name);
+        }
+    }
+
+    private void ResumeDeviceProvider(DeviceProvider deviceProvider)
+    {
+        try
+        {
+            _pluginManagementService.EnablePluginFeature(deviceProvider, false, true);
+            _suspendedDeviceProviders.Remove(deviceProvider);
+            _logger.Information("Device provider {DeviceProvider} resumed", deviceProvider.Info.Name);
+        }
+        catch (Exception e)
+        {
+            _logger.Error(e, "Device provider {DeviceProvider} failed to resume", deviceProvider.Info.Name);
+        }
+    }
+
     private ArtemisDevice GetArtemisDevice(IRGBDevice rgbDevice)
     {
         string deviceIdentifier = rgbDevice.GetDeviceIdentifier();
diff --git a/src/Artemis.Core/Services/Interfaces/IDeviceService.cs b/src/Artemis.Core/Services/Interfaces/IDeviceService.cs
index 51b19d937..5c5c60ad7 100644
--- a/src/Artemis.Core/Services/Interfaces/IDeviceService.cs
+++ b/src/Artemis.Core/Services/Interfaces/IDeviceService.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Threading.Tasks;
 using Artemis.Core.DeviceProviders;
 
 namespace Artemis.Core.Services;
@@ -71,6 +72,16 @@ public interface IDeviceService : IArtemisService
     /// </summary>
     void SaveDevices();
 
+    /// <summary>
+    ///     Suspends all active device providers
+    /// </summary>
+    void SuspendDeviceProviders();
+
+    /// <summary>
+    ///     Resumes all previously active device providers
+    /// </summary>
+    void ResumeDeviceProviders();
+
     /// <summary>
     ///     Occurs when a single device was added.
     /// </summary>
diff --git a/src/Artemis.UI.Windows/App.axaml.cs b/src/Artemis.UI.Windows/App.axaml.cs
index 66d5aac1b..593a9ea2a 100644
--- a/src/Artemis.UI.Windows/App.axaml.cs
+++ b/src/Artemis.UI.Windows/App.axaml.cs
@@ -35,10 +35,10 @@ public override void Initialize()
         }
 
         _container = ArtemisBootstrapper.Bootstrap(this, c => c.RegisterProviders());
-        
+
         Program.CreateLogger(_container);
         LegacyMigrationService.MigrateToSqlite(_container);
-        
+
         RxApp.MainThreadScheduler = AvaloniaScheduler.Instance;
         AvaloniaXamlLoader.Load(this);
     }
@@ -47,10 +47,13 @@ public override void OnFrameworkInitializationCompleted()
     {
         if (ApplicationLifetime is not IClassicDesktopStyleApplicationLifetime desktop || Design.IsDesignMode || _shutDown)
             return;
-
-        _applicationStateManager = new ApplicationStateManager(_container!, desktop.Args ?? Array.Empty<string>());
+        if (_container == null)
+            throw new InvalidOperationException("Container is null");
+        
+        _applicationStateManager = new ApplicationStateManager(_container, desktop.Args ?? Array.Empty<string>());
+        _suspensionManager = new SuspensionManager(_container);
         ArtemisBootstrapper.Initialize();
-        RegisterProviders(_container!);
+        RegisterProviders(_container);
     }
 
     private void RegisterProviders(IContainer container)
@@ -117,8 +120,10 @@ private void KillOtherInstances()
     }
 
     // ReSharper disable NotAccessedField.Local
-    private ApplicationStateManager? _applicationStateManager;
 
+    private ApplicationStateManager? _applicationStateManager;
+    private SuspensionManager? _suspensionManager;
     private Mutex? _artemisMutex;
+
     // ReSharper restore NotAccessedField.Local
 }
\ No newline at end of file
diff --git a/src/Artemis.UI.Windows/Artemis.UI.Windows.csproj b/src/Artemis.UI.Windows/Artemis.UI.Windows.csproj
index f74f2bd4b..0547102a2 100644
--- a/src/Artemis.UI.Windows/Artemis.UI.Windows.csproj
+++ b/src/Artemis.UI.Windows/Artemis.UI.Windows.csproj
@@ -24,6 +24,7 @@
         <PackageReference Include="Avalonia.Win32" />
         <PackageReference Include="Microsoft.Toolkit.Uwp.Notifications" />
         <PackageReference Include="Microsoft.Win32" />
+        <PackageReference Include="Microsoft.Win32.SystemEvents" />
         <PackageReference Include="Microsoft.Windows.Compatibility" />
         <PackageReference Include="RawInput.Sharp" />
         <PackageReference Include="SkiaSharp.Vulkan.SharpVk" />
diff --git a/src/Artemis.UI.Windows/SuspensionManager.cs b/src/Artemis.UI.Windows/SuspensionManager.cs
new file mode 100644
index 000000000..18da8db80
--- /dev/null
+++ b/src/Artemis.UI.Windows/SuspensionManager.cs
@@ -0,0 +1,67 @@
+using System;
+using System.Threading.Tasks;
+using Artemis.Core.Services;
+using DryIoc;
+using Microsoft.Win32;
+using Serilog;
+
+namespace Artemis.UI.Windows;
+
+public class SuspensionManager
+{
+    private readonly ILogger _logger;
+    private readonly IDeviceService _deviceService;
+
+    public SuspensionManager(IContainer container)
+    {
+        _logger = container.Resolve<ILogger>();
+        _deviceService = container.Resolve<IDeviceService>();
+
+        try
+        {
+            SystemEvents.PowerModeChanged += SystemEventsOnPowerModeChanged;
+            SystemEvents.SessionSwitch += SystemEventsOnSessionSwitch;
+        }
+        catch (Exception e)
+        {
+            _logger.Warning(e, "Could not subscribe to system events");
+        }
+    }
+
+    private void SystemEventsOnPowerModeChanged(object sender, PowerModeChangedEventArgs e)
+    {
+        if (e.Mode == PowerModes.Suspend)
+            Task.Run(() => SetDeviceSuspension(true));
+        else if (e.Mode == PowerModes.Resume)
+            Task.Run(() => SetDeviceSuspension(false));
+    }
+
+    private void SystemEventsOnSessionSwitch(object sender, SessionSwitchEventArgs e)
+    {
+        if (e.Reason is SessionSwitchReason.SessionLock or SessionSwitchReason.SessionLogoff)
+            Task.Run(() => SetDeviceSuspension(true));
+        else if (e.Reason is SessionSwitchReason.SessionUnlock or SessionSwitchReason.SessionLogon)
+            Task.Run(() => SetDeviceSuspension(false));
+    }
+
+    private async Task SetDeviceSuspension(bool suspend)
+    {
+        try
+        {
+            if (suspend)
+            {
+                // Suspend instantly, system is going into sleep at any moment
+                _deviceService.SuspendDeviceProviders();
+            }
+            else
+            {
+                await Task.Delay(TimeSpan.FromSeconds(2));
+                _deviceService.ResumeDeviceProviders();
+            }
+        }
+        catch (Exception e)
+        {
+            _logger.Error(e, "An error occurred while setting provider suspension to {Suspension}", suspend);
+        }
+    }
+}
\ No newline at end of file
diff --git a/src/Artemis.WebClient.Workshop/Services/AuthenticationService.cs b/src/Artemis.WebClient.Workshop/Services/AuthenticationService.cs
index c8727c361..9c0dc6d7b 100644
--- a/src/Artemis.WebClient.Workshop/Services/AuthenticationService.cs
+++ b/src/Artemis.WebClient.Workshop/Services/AuthenticationService.cs
@@ -21,7 +21,7 @@ internal class AuthenticationService : CorePropertyChanged, IAuthenticationServi
 {
     private const string CLIENT_ID = "artemis.desktop";
     private readonly IAuthenticationRepository _authenticationRepository;
-    private readonly SemaphoreSlim _authLock = new(1);
+    private readonly SemaphoreSlim _authLock = new(1, 1);
     private readonly SourceList<Claim> _claims;
 
     private readonly IDiscoveryCache _discoveryCache;
diff --git a/src/Directory.Packages.props b/src/Directory.Packages.props
index e85192de6..3eb203ff3 100644
--- a/src/Directory.Packages.props
+++ b/src/Directory.Packages.props
@@ -14,6 +14,7 @@
     <PackageVersion Include="Avalonia.ReactiveUI" Version="11.0.9" />
     <PackageVersion Include="Avalonia.Skia.Lottie" Version="11.0.0" />
     <PackageVersion Include="Avalonia.Win32" Version="11.0.9" />
+    <PackageVersion Include="Microsoft.Win32.SystemEvents" Version="8.0.0" />
     <PackageVersion Include="Avalonia.Xaml.Behaviors" Version="11.0.6" />
     <PackageVersion Include="AvaloniaEdit.TextMate" Version="11.0.6" />
     <PackageVersion Include="DryIoc.Microsoft.DependencyInjection" Version="6.2.0" />