Skip to content

Commit c6fa04c

Browse files
authored
Keep the package list's scroll position when an operation completes (#5512)
1 parent 3fb3d22 commit c6fa04c

3 files changed

Lines changed: 160 additions & 27 deletions

File tree

‎src/UniGetUI.Avalonia/Models/PackageCollections.cs‎

Lines changed: 44 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -929,24 +929,59 @@ public void ClearSelection()
929929
foreach (var w in this) w.IsChecked = false;
930930
}
931931

932+
public void ApplyChanges(IEnumerable<PackageWrapper> removed, IEnumerable<PackageWrapper> added)
933+
=> ApplyChanges(this, removed, added, GetOrderComparer());
934+
935+
internal static void ApplyChanges<T>(IList<T> list, IEnumerable<T> removed, IEnumerable<T> added, IComparer<T> comparer)
936+
{
937+
foreach (var item in removed)
938+
{
939+
int index = IndexOfReference(list, item);
940+
if (index >= 0) list.RemoveAt(index);
941+
}
942+
943+
foreach (var item in added)
944+
{
945+
int low = 0, high = list.Count;
946+
while (low < high)
947+
{
948+
int mid = low + (high - low) / 2;
949+
if (comparer.Compare(list[mid], item) <= 0) low = mid + 1;
950+
else high = mid;
951+
}
952+
list.Insert(low, item);
953+
}
954+
}
955+
956+
private static int IndexOfReference<T>(IList<T> list, T item)
957+
{
958+
for (int i = 0; i < list.Count; i++)
959+
if (ReferenceEquals(list[i], item)) return i;
960+
return -1;
961+
}
962+
932963
public void SortBy(Sorter sorter) => CurrentSorter = sorter;
933964

934965
public void SetSortDirection(bool ascending) => _ascending = ascending;
935966

936967
/// <summary>Returns <paramref name="items"/> in the current sort order.</summary>
937968
public IEnumerable<PackageWrapper> ApplyToList(IEnumerable<PackageWrapper> items)
969+
=> items.OrderBy(w => w, GetOrderComparer());
970+
971+
private IComparer<PackageWrapper> GetOrderComparer()
938972
{
939-
var comparer = Comparer<PackageWrapper>.Create((a, b) => Compare(a, b, CurrentSorter));
973+
Sorter sorter = CurrentSorter;
974+
bool ascending = _ascending;
940975

941-
if (CurrentSorter is Sorter.DownloadSize)
976+
return Comparer<PackageWrapper>.Create((a, b) =>
942977
{
943-
var resolvedFirst = items.OrderBy(w => w.DownloadSizeBytes > 0 ? 0 : 1);
944-
return _ascending
945-
? resolvedFirst.ThenBy(w => w, comparer)
946-
: resolvedFirst.ThenByDescending(w => w, comparer);
947-
}
948-
949-
return _ascending ? items.OrderBy(w => w, comparer) : items.OrderByDescending(w => w, comparer);
978+
if (sorter is Sorter.DownloadSize)
979+
{
980+
int resolved = (a.DownloadSizeBytes > 0 ? 0 : 1).CompareTo(b.DownloadSizeBytes > 0 ? 0 : 1);
981+
if (resolved != 0) return resolved;
982+
}
983+
return ascending ? Compare(a, b, sorter) : Compare(b, a, sorter);
984+
});
950985
}
951986

952987
// Shared by the "Order by" menu (ApplyToList) and the DataGrid's native column sorting

‎src/UniGetUI.Avalonia/ViewModels/SoftwarePages/PackagesPageViewModel.cs‎

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -475,16 +475,23 @@ private void Loader_PackagesChanged(object? sender, PackagesChangedEvent e)
475475

476476
if (e.ProceduralChange)
477477
{
478+
var added = new List<PackageWrapper>();
478479
foreach (var pkg in e.AddedPackages)
479480
{
480481
if (_wrappedPackages.Any(w => w.Package.GetVersionedHash() == pkg.GetVersionedHash())) continue;
481-
_wrappedPackages.Add(new PackageWrapper(pkg, this));
482+
var wrapper = new PackageWrapper(pkg, this);
483+
_wrappedPackages.Add(wrapper);
484+
added.Add(wrapper);
482485
AddPackageToSourcesList(pkg);
483486
}
484487
var toRemove = _wrappedPackages
485488
.Where(w => e.RemovedPackages.Any(r => r.GetVersionedHash() == w.Package.GetVersionedHash()))
486489
.ToList();
487490
foreach (var wrapper in toRemove) { wrapper.Dispose(); _wrappedPackages.Remove(wrapper); }
491+
492+
var filter = BuildPackageFilter(out string query);
493+
FilteredPackages.ApplyChanges(toRemove, added.Where(filter));
494+
UpdateFilteredState(query);
488495
}
489496
else
490497
{
@@ -496,8 +503,8 @@ private void Loader_PackagesChanged(object? sender, PackagesChangedEvent e)
496503
_wrappedPackages.Add(new PackageWrapper(pkg, this));
497504
AddPackageToSourcesList(pkg);
498505
}
506+
FilterPackages();
499507
}
500-
FilterPackages();
501508
}
502509

503510
private void Loader_FinishedLoading(object? sender, EventArgs e)
@@ -644,26 +651,38 @@ public void SubmitSearch()
644651
}
645652
else
646653
{
647-
FilterPackages(fromQuery: true);
654+
FilterPackages();
648655
}
649656
}
650657

651-
public void FilterPackages(bool fromQuery = false)
658+
public void FilterPackages()
659+
{
660+
var filter = BuildPackageFilter(out string query);
661+
var results = FilteredPackages.ApplyToList(_wrappedPackages.Where(filter)).ToList();
662+
663+
FilteredPackages.Clear();
664+
foreach (var w in results) FilteredPackages.Add(w);
665+
666+
UpdateFilteredState(query);
667+
}
668+
669+
private Func<PackageWrapper, bool> BuildPackageFilter(out string query)
652670
{
653671
var filters = new List<Func<string, string>>();
654672
if (!UpperLowerCase) filters.Add(FilterHelpers.NormalizeCase);
655673
if (IgnoreSpecialChars) filters.Add(FilterHelpers.NormalizeSpecialCharacters);
656674

657-
string query = _searchQuery;
658-
foreach (var f in filters) query = f(query);
675+
string normalizedQuery = _searchQuery;
676+
foreach (var f in filters) normalizedQuery = f(normalizedQuery);
677+
query = normalizedQuery;
659678

660679
Func<IPackage, bool> matchFunc = SearchMode switch
661680
{
662-
SearchMode.Name => pkg => FilterHelpers.NameContains(pkg, query, filters),
663-
SearchMode.Id => pkg => FilterHelpers.IdContains(pkg, query, filters),
664-
SearchMode.Exact => pkg => FilterHelpers.NameOrIdExactMatch(pkg, query, filters),
681+
SearchMode.Name => pkg => FilterHelpers.NameContains(pkg, normalizedQuery, filters),
682+
SearchMode.Id => pkg => FilterHelpers.IdContains(pkg, normalizedQuery, filters),
683+
SearchMode.Exact => pkg => FilterHelpers.NameOrIdExactMatch(pkg, normalizedQuery, filters),
665684
SearchMode.Similar => _ => true,
666-
_ => pkg => FilterHelpers.NameOrIdContains(pkg, query, filters),
685+
_ => pkg => FilterHelpers.NameOrIdContains(pkg, normalizedQuery, filters),
667686
};
668687

669688
var (visibleSources, visibleManagers) = GetSelectedSourceFilters();
@@ -678,13 +697,11 @@ public void FilterPackages(bool fromQuery = false)
678697
&& visibleManagers.Contains(pkg.Manager)
679698
);
680699

681-
var results = FilteredPackages.ApplyToList(
682-
_wrappedPackages.Where(w => matchFunc(w.Package) && sourceFilter(w.Package))
683-
).ToList();
684-
685-
FilteredPackages.Clear();
686-
foreach (var w in results) FilteredPackages.Add(w);
700+
return w => matchFunc(w.Package) && sourceFilter(w.Package);
701+
}
687702

703+
private void UpdateFilteredState(string query)
704+
{
688705
UpdateSubtitle();
689706
PackageCountUpdated?.Invoke();
690707

@@ -1078,7 +1095,7 @@ private void SubmitMegaQuery(string query)
10781095
{
10791096
MegaQueryVisible = false;
10801097
_searchQuery = query?.Trim() ?? "";
1081-
FilterPackages(fromQuery: true);
1098+
FilterPackages();
10821099
}
10831100

10841101
// ─── Keyboard / search-box actions (called by the View's interface impls) ──
@@ -1109,7 +1126,7 @@ public void ToggleSelectAll()
11091126
public void HandleSearchSubmitted()
11101127
{
11111128
if (MegaQueryBoxEnabled) SubmitSearch();
1112-
else FilterPackages(fromQuery: true);
1129+
else FilterPackages();
11131130
}
11141131

11151132
// ─── Operation launchers ─────────────────────────────────────────────────
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
using Avalonia.Collections;
2+
using UniGetUI.PackageEngine.PackageClasses;
3+
4+
namespace UniGetUI.Tests;
5+
6+
public sealed class ObservablePackageCollectionTests
7+
{
8+
private sealed class Row(int key, string name)
9+
{
10+
public int Key { get; } = key;
11+
public string Name { get; } = name;
12+
}
13+
14+
private static readonly IComparer<Row> ByKey = Comparer<Row>.Create((a, b) => a.Key.CompareTo(b.Key));
15+
16+
[Fact]
17+
public void ApplyChanges_RemovesOnlyTheGivenInstance()
18+
{
19+
var first = new Row(1, "first");
20+
var twin = new Row(1, "twin");
21+
var list = new AvaloniaList<Row> { first, twin, new Row(2, "other") };
22+
23+
ObservablePackageCollection.ApplyChanges(list, [twin], [], ByKey);
24+
25+
Assert.Equal(["first", "other"], list.Select(r => r.Name));
26+
}
27+
28+
[Fact]
29+
public void ApplyChanges_IgnoresRemovalsThatAreNotListed()
30+
{
31+
var list = new AvaloniaList<Row> { new Row(1, "a"), new Row(2, "b") };
32+
33+
ObservablePackageCollection.ApplyChanges(list, [new Row(1, "a")], [], ByKey);
34+
35+
Assert.Equal(["a", "b"], list.Select(r => r.Name));
36+
}
37+
38+
[Fact]
39+
public void ApplyChanges_InsertsAfterEqualKeys()
40+
{
41+
var list = new AvaloniaList<Row> { new Row(1, "a"), new Row(2, "b1"), new Row(2, "b2"), new Row(3, "c") };
42+
43+
ObservablePackageCollection.ApplyChanges(list, [], [new Row(2, "new"), new Row(0, "head"), new Row(9, "tail")], ByKey);
44+
45+
Assert.Equal(["head", "a", "b1", "b2", "new", "c", "tail"], list.Select(r => r.Name));
46+
}
47+
48+
[Fact]
49+
public void ApplyChanges_RaisesOneNotificationPerChangeAndNoReset()
50+
{
51+
var removed = new Row(2, "b");
52+
var list = new AvaloniaList<Row> { new Row(1, "a"), removed, new Row(3, "c") };
53+
var actions = new List<System.Collections.Specialized.NotifyCollectionChangedAction>();
54+
list.CollectionChanged += (_, e) => actions.Add(e.Action);
55+
56+
ObservablePackageCollection.ApplyChanges(list, [removed], [new Row(2, "b2")], ByKey);
57+
58+
Assert.Equal(
59+
[System.Collections.Specialized.NotifyCollectionChangedAction.Remove, System.Collections.Specialized.NotifyCollectionChangedAction.Add],
60+
actions);
61+
}
62+
63+
[Fact]
64+
public void ApplyChanges_MatchesAFullStableSort()
65+
{
66+
var random = new Random(5505);
67+
for (int iteration = 0; iteration < 500; iteration++)
68+
{
69+
var source = Enumerable.Range(0, random.Next(0, 40)).Select(i => new Row(random.Next(0, 8), $"s{i}")).ToList();
70+
var list = new AvaloniaList<Row>(source.OrderBy(r => r, ByKey));
71+
72+
var removed = source.Where(_ => random.Next(4) == 0).ToList();
73+
var added = Enumerable.Range(0, random.Next(0, 6)).Select(i => new Row(random.Next(0, 8), $"n{i}")).ToList();
74+
75+
ObservablePackageCollection.ApplyChanges(list, removed, added, ByKey);
76+
77+
var expected = source.Except(removed).Concat(added).OrderBy(r => r, ByKey);
78+
Assert.Equal(expected.Select(r => r.Name), list.Select(r => r.Name));
79+
}
80+
}
81+
}

0 commit comments

Comments
 (0)