Fix multiple requests for ItemsProvider when changing the TotalItemCount (#64661)

Author: dariatiurina

src/Components/QuickGrid/Microsoft.AspNetCore.Components.QuickGrid/src/QuickGrid.razor.cs

@@ -340,7 +340,6 @@ private async Task RefreshDataCoreAsync()
         else
         {
             // If we're not using Virtualize, we build and execute a request against the items provider directly
-            _lastRefreshedPaginationStateHash = Pagination?.GetHashCode();
             var startIndex = Pagination is null ? 0 : (Pagination.CurrentPageIndex * Pagination.ItemsPerPage);
             var request = new GridItemsProviderRequest<TGridItem>(
                 startIndex, Pagination?.ItemsPerPage, _sortByColumn, _sortByAscending, thisLoadCts.Token);
@@ -350,6 +349,7 @@ private async Task RefreshDataCoreAsync()
                 _currentNonVirtualizedViewItems = result.Items;
                 _ariaBodyRowCount = _currentNonVirtualizedViewItems.Count;
                 Pagination?.SetTotalItemCountAsync(result.TotalItemCount);
+                _lastRefreshedPaginationStateHash = Pagination?.GetHashCode();
                 _pendingDataLoadCancellationTokenSource = null;
             }
         }

src/Components/test/E2ETest/Tests/QuickGridTest.cs

@@ -216,6 +216,36 @@ public void ItemsProviderCalledOnceWithVirtualize()
         Browser.Equal("1", () => app.FindElement(By.Id("items-provider-call-count")).Text);
     }
 
+    [Fact]
+    public void FilterUsingSetCurrentPageDoesNotCauseExtraRefresh()
+    {
+        app = Browser.MountTestComponent<QuickGridFilterComponent>();
+
+        Browser.Equal("1", () => app.FindElement(By.Id("items-provider-calls")).Text);
+
+        var filterInput = app.FindElement(By.Id("filter-input"));
+        filterInput.Clear();
+        filterInput.SendKeys("Item 1");
+        app.FindElement(By.Id("apply-filter-reset-pagination-btn")).Click();
+
+        Browser.Equal("2", () => app.FindElement(By.Id("items-provider-calls")).Text);
+    }
+
+    [Fact]
+    public void FilterUsingRefreshDataDoesNotCauseExtraRefresh()
+    {
+        app = Browser.MountTestComponent<QuickGridFilterComponent>();
+
+        Browser.Equal("1", () => app.FindElement(By.Id("items-provider-calls")).Text);
+
+        var filterInput = app.FindElement(By.Id("filter-input"));
+        filterInput.Clear();
+        filterInput.SendKeys("Item 1");
+        app.FindElement(By.Id("apply-filter-refresh-data-btn")).Click();
+
+        Browser.Equal("2", () => app.FindElement(By.Id("items-provider-calls")).Text);
+    }
+    
     [Fact]
     public void OnRowClickTriggersCallback()
     {

src/Components/test/testassets/BasicTestApp/Index.razor

@@ -97,6 +97,7 @@
         <option value="@GetTestServerProjectComponent("Components.TestServer.ProtectedBrowserStorageInjectionComponent")">Protected browser storage injection</option>
         <option value="BasicTestApp.QuickGridTest.SampleQuickGridComponent">QuickGrid Example</option>
         <option value="BasicTestApp.QuickGridTest.QuickGridVirtualizeComponent">QuickGrid with Virtualize Example</option>
+        <option value="BasicTestApp.QuickGridTest.QuickGridFilterComponent">QuickGrid Filter ItemsProvider Calls Test</option>
         <option value="BasicTestApp.RazorTemplates">Razor Templates</option>
         <option value="BasicTestApp.Reconnection.ReconnectionComponent">Reconnection server-side blazor</option>
         <option value="BasicTestApp.RedTextComponent">Red text</option>

src/Components/test/testassets/BasicTestApp/QuickGridTest/QuickGridFilterComponent.razor

@@ -0,0 +1,68 @@
+@using Microsoft.AspNetCore.Components.QuickGrid
+
+<div>
+    <input id="filter-input" type="text" @bind="filter" />
+    <button id="apply-filter-reset-pagination-btn" @onclick="ApplyFilterResetPagination">Apply Filter</button>
+    <button id="apply-filter-refresh-data-btn" @onclick="ApplyFilterRefreshData">Apply Filter</button>
+</div>
+
+<div class="grid">
+    <QuickGrid ItemsProvider="itemsProvider" Pagination="@pagination" @ref="gridRef">
+        <PropertyColumn Property="@(c => c.Id)" />
+        <PropertyColumn Property="@(c => c.Name)" />
+    </QuickGrid>
+</div>
+<Paginator State="@pagination" />
+
+<p id="items-provider-calls">@itemsProviderCalls</p>
+
+@code {
+    PaginationState pagination = new PaginationState { ItemsPerPage = 5 };
+    int itemsProviderCalls = 0;
+    GridItemsProvider<Item> itemsProvider = default!;
+    QuickGrid<Item> gridRef;
+    string filter = string.Empty;
+
+    private readonly List<Item> allItems = Enumerable.Range(1, 25)
+        .Select(i => new Item { Id = i, Name = $"Item {i}" })
+        .ToList();
+
+    protected override void OnInitialized()
+    {
+        itemsProvider = async request =>
+        {
+            await Task.CompletedTask;
+
+            Interlocked.Increment(ref itemsProviderCalls);
+            StateHasChanged();
+
+            var filteredItems = string.IsNullOrEmpty(filter)
+                ? allItems
+                : allItems.Where(i => i.Name.Contains(filter, StringComparison.OrdinalIgnoreCase)).ToList();
+
+            var totalCount = filteredItems.Count;
+            var pagedItems = filteredItems
+                .Skip(request.StartIndex)
+                .Take(request.Count ?? 5)
+                .ToList();
+
+            return GridItemsProviderResult.From(pagedItems, totalCount);
+        };
+    }
+
+    protected async Task ApplyFilterResetPagination()
+    {
+        await pagination.SetCurrentPageIndexAsync(0);
+    }
+
+    protected async Task ApplyFilterRefreshData()
+    {
+        await gridRef.RefreshDataAsync();
+    }
+
+    class Item
+    {
+        public int Id { get; set; }
+        public string Name { get; set; } = string.Empty;
+    }
+}