From e00eae112917caa92a1de3c740dcc873aee83aff Mon Sep 17 00:00:00 2001 From: John Colvin Date: Wed, 5 Oct 2022 00:43:19 -0400 Subject: [PATCH] refactor (ui): Enable auto-refresh in column-text filters feat (mview): Enable auto-refresh in security filter This behavior is (more) consistent with other modern search uis --- .../Filters/DataGridFilterHelper.cs | 1 + .../DataGridEx/Filters/VM/RegexFilterVM.cs | 63 +++++++++++++++++-- .../Filters/Views/FilterTemplates.xaml | 49 ++++++--------- src/client/spark_core/Swap.cs | 18 ++++++ 4 files changed, 97 insertions(+), 34 deletions(-) create mode 100644 src/client/spark_core/Swap.cs diff --git a/src/client/spark/view/Controls/DataGridEx/Filters/DataGridFilterHelper.cs b/src/client/spark/view/Controls/DataGridEx/Filters/DataGridFilterHelper.cs index 8ee869350..791972e70 100644 --- a/src/client/spark/view/Controls/DataGridEx/Filters/DataGridFilterHelper.cs +++ b/src/client/spark/view/Controls/DataGridEx/Filters/DataGridFilterHelper.cs @@ -67,6 +67,7 @@ DiscreteValuesCollectionView = "DiscreteValuesCollectionViewTemplate", EnumValues = "EnumValuesTemplate", Regex = "RegexTemplate", + RegexAutoRefresh = "RegexAutoRefreshTemplate", YesNo = "YesNoTemplate"; public const string ExpirationDate = "ExpirationDate"; } diff --git a/src/client/spark/view/Controls/DataGridEx/Filters/VM/RegexFilterVM.cs b/src/client/spark/view/Controls/DataGridEx/Filters/VM/RegexFilterVM.cs index 01a4b3a0e..9029ded87 100644 --- a/src/client/spark/view/Controls/DataGridEx/Filters/VM/RegexFilterVM.cs +++ b/src/client/spark/view/Controls/DataGridEx/Filters/VM/RegexFilterVM.cs @@ -1,5 +1,8 @@ -using System; +using Spark.Core; + +using System; using System.Text.RegularExpressions; +using System.Threading.Tasks; namespace mbts.spark.filters { static class RegexFilterUtils { @@ -13,16 +16,45 @@ namespace mbts.spark.filters { } } class RegexFilterVM : FilterVMBase { + readonly DeferrableAction _deferrable_refresh; + string _text = string.Empty; Regex _regex; + TimeSpan? _refresh_interval; - public RegexFilterVM(Func get_row_val, string prop_name = null) : base(get_row_val, prop_name) { } + public RegexFilterVM(Func get_row_val, string prop_name = null) + : base(get_row_val, prop_name) { + _deferrable_refresh = new(invoke_deferred_refresh); + refresh_interval = TimeSpan.FromSeconds(0.4); + + void invoke_deferred_refresh() { + _raise_filter_changed(); + } + } public string text { get => _text; - set => _regex = RegexFilterUtils.build_regex(_text = (value ?? string.Empty)); + set => _on_text_input(value); } + public TimeSpan? refresh_interval { + get => _refresh_interval; + set { + var had_value = _refresh_interval.HasValue; + if (!Swap.toggle_to(ref _refresh_interval, value)) { + return; + } + if (value.HasValue && !had_value && _deferrable_refresh.is_execution_deferred) { + // Flush deferred (delayed) refreshes immediately + _deferrable_refresh.cancel(); + _raise_filter_changed(); + } + } + } + + public IDisposable supress_auto_refresh() => + _deferrable_refresh.supress(); + public override string get_state() => _text ?? string.Empty; protected override bool _get_active() => _regex != null; @@ -31,7 +63,11 @@ namespace mbts.spark.filters { _regex.IsMatch(value) || (!string.IsNullOrEmpty(value) && _regex.IsMatch(value.Replace(" ", "")))); - protected override void _load_state_internal(string state) => text = state; + protected override void _load_state_internal(string state) { + _text = state ?? string.Empty; + _regex = RegexFilterUtils.build_regex(_text); + } + protected override void _clear() { _close(); _text = string.Empty; @@ -39,5 +75,24 @@ namespace mbts.spark.filters { RaisePropertyChanged(nameof(text)); _raise_filter_changed(); } + + void _on_text_input(string value) { + if (_text == value) { + return; + } + _load_state_internal(value); + if (!_refresh_interval.HasValue) { + return; + } + delay_refresh(); + + async void delay_refresh() { + using var _ = _deferrable_refresh.defer(); + /// Invoke the refresh before the delay, so the fact that a refresh is scheduled can be + /// seen via + _deferrable_refresh.Invoke(); + await Task.Delay(_refresh_interval.Value); + } + } } } diff --git a/src/client/spark/view/Controls/DataGridEx/Filters/Views/FilterTemplates.xaml b/src/client/spark/view/Controls/DataGridEx/Filters/Views/FilterTemplates.xaml index 8b370f143..262b93f86 100644 --- a/src/client/spark/view/Controls/DataGridEx/Filters/Views/FilterTemplates.xaml +++ b/src/client/spark/view/Controls/DataGridEx/Filters/Views/FilterTemplates.xaml @@ -250,36 +250,25 @@ - - - - - - - - - - - - - - - - - - + + + + + + + + + + + diff --git a/src/client/spark_core/Swap.cs b/src/client/spark_core/Swap.cs new file mode 100644 index 000000000..a9ba7a91c --- /dev/null +++ b/src/client/spark_core/Swap.cs @@ -0,0 +1,18 @@ +#nullable enable + +namespace Spark.Core { + using System.Collections.Generic; + + public class Swap { + public static bool toggle_to(ref T target, T value) => + toggle_to(ref target, value, EqualityComparer.Default); + + public static bool toggle_to(ref T target, T value, IEqualityComparer comparer) { + if (comparer.Equals(target, value)) { + return false; + } + target = value; + return true; + } + } +}