fix(grid): preserve data tab scroll and search across switches
This commit is contained in:
1 parent
ed29ef9eed
commit
451e50b2fb
11 files changed
+652
-15
No files matched your search
+83
@@ -0,0 +1,83 @@
|
||||
import { beforeEach, describe, expect, it } from "vitest";
|
||||
import { clearDataGridSearchStates, clearDataGridSearchStatesForTab, createDataGridSearchScopeKey, dataGridSearchStateCount, loadDataGridSearchState, saveDataGridSearchState, type DataGridSearchCacheState } from "@/lib/dataGrid/dataGridSearchStatePersistence";
|
||||
|
||||
const SCOPE = createDataGridSearchScopeKey(["id", "name"]);
|
||||
|
||||
function state(overrides: Partial<DataGridSearchCacheState> = {}): DataGridSearchCacheState {
|
||||
return {
|
||||
scopeKey: SCOPE,
|
||||
searchText: "ada",
|
||||
deferredSearchText: "ada",
|
||||
overlayVisible: true,
|
||||
currentMatchIndex: 3,
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
describe("dataGridSearchStatePersistence", () => {
|
||||
beforeEach(() => clearDataGridSearchStates());
|
||||
|
||||
it("round-trips a saved state as a copy", () => {
|
||||
saveDataGridSearchState("tab-1", state());
|
||||
const loaded = loadDataGridSearchState("tab-1", SCOPE);
|
||||
expect(loaded).toEqual(state());
|
||||
loaded!.searchText = "mutated";
|
||||
expect(loadDataGridSearchState("tab-1", SCOPE)?.searchText).toBe("ada");
|
||||
});
|
||||
|
||||
it("ignores a blank cache key", () => {
|
||||
saveDataGridSearchState(undefined, state());
|
||||
saveDataGridSearchState(" ", state());
|
||||
expect(dataGridSearchStateCount()).toBe(0);
|
||||
expect(loadDataGridSearchState(undefined, SCOPE)).toBeUndefined();
|
||||
});
|
||||
|
||||
it("drops the entry when the column signature changed", () => {
|
||||
saveDataGridSearchState("tab-1", state());
|
||||
expect(loadDataGridSearchState("tab-1", createDataGridSearchScopeKey(["id", "renamed"]))).toBeUndefined();
|
||||
// The stale entry is evicted, not merely skipped.
|
||||
expect(loadDataGridSearchState("tab-1", SCOPE)).toBeUndefined();
|
||||
expect(dataGridSearchStateCount()).toBe(0);
|
||||
});
|
||||
|
||||
it("does not store an empty closed search bar", () => {
|
||||
saveDataGridSearchState("tab-1", state({ searchText: "", deferredSearchText: "", overlayVisible: false }));
|
||||
expect(dataGridSearchStateCount()).toBe(0);
|
||||
});
|
||||
|
||||
it("keeps an empty query while the bar is still open", () => {
|
||||
saveDataGridSearchState("tab-1", state({ searchText: "", deferredSearchText: "", overlayVisible: true }));
|
||||
expect(loadDataGridSearchState("tab-1", SCOPE)?.overlayVisible).toBe(true);
|
||||
});
|
||||
|
||||
it("clears the entry when a later save empties the search", () => {
|
||||
saveDataGridSearchState("tab-1", state());
|
||||
saveDataGridSearchState("tab-1", state({ searchText: "", deferredSearchText: "", overlayVisible: false }));
|
||||
expect(loadDataGridSearchState("tab-1", SCOPE)).toBeUndefined();
|
||||
});
|
||||
|
||||
it("evicts the least recently used entry past the cap", () => {
|
||||
for (let index = 0; index < 130; index += 1) saveDataGridSearchState(`tab-${index}`, state());
|
||||
expect(dataGridSearchStateCount()).toBe(128);
|
||||
expect(loadDataGridSearchState("tab-0", SCOPE)).toBeUndefined();
|
||||
expect(loadDataGridSearchState("tab-129", SCOPE)).toBeDefined();
|
||||
});
|
||||
|
||||
it("treats a load as a recency touch", () => {
|
||||
saveDataGridSearchState("tab-keep", state());
|
||||
for (let index = 0; index < 127; index += 1) saveDataGridSearchState(`tab-${index}`, state());
|
||||
loadDataGridSearchState("tab-keep", SCOPE);
|
||||
saveDataGridSearchState("tab-overflow", state());
|
||||
expect(loadDataGridSearchState("tab-keep", SCOPE)).toBeDefined();
|
||||
});
|
||||
|
||||
it("clears every cache key belonging to a closed tab", () => {
|
||||
saveDataGridSearchState("tab-1", state());
|
||||
saveDataGridSearchState("tab-1-run-1-0-rev-2", state());
|
||||
saveDataGridSearchState("tab-2", state());
|
||||
clearDataGridSearchStatesForTab("tab-1");
|
||||
expect(loadDataGridSearchState("tab-1", SCOPE)).toBeUndefined();
|
||||
expect(loadDataGridSearchState("tab-1-run-1-0-rev-2", SCOPE)).toBeUndefined();
|
||||
expect(loadDataGridSearchState("tab-2", SCOPE)).toBeDefined();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,61 @@
|
||||
export type DataGridSearchCacheState = {
|
||||
scopeKey: string;
|
||||
searchText: string;
|
||||
deferredSearchText: string;
|
||||
overlayVisible: boolean;
|
||||
currentMatchIndex: number;
|
||||
};
|
||||
|
||||
const SEARCH_STATE_CACHE_MAX_ENTRIES = 128;
|
||||
const searchStateCache = new Map<string, DataGridSearchCacheState>();
|
||||
|
||||
/** 列集合定义了匹配空间;行数刻意不参与,翻页/追加行不应丢弃用户的搜索词。 */
|
||||
export function createDataGridSearchScopeKey(columns: readonly string[]): string {
|
||||
return JSON.stringify(columns);
|
||||
}
|
||||
|
||||
export function loadDataGridSearchState(cacheKey: string | undefined, scopeKey: string): DataGridSearchCacheState | undefined {
|
||||
const key = cacheKey?.trim();
|
||||
if (!key) return undefined;
|
||||
const cached = searchStateCache.get(key);
|
||||
if (!cached) return undefined;
|
||||
if (cached.scopeKey !== scopeKey) {
|
||||
searchStateCache.delete(key);
|
||||
return undefined;
|
||||
}
|
||||
searchStateCache.delete(key);
|
||||
searchStateCache.set(key, cached);
|
||||
return { ...cached };
|
||||
}
|
||||
|
||||
export function saveDataGridSearchState(cacheKey: string | undefined, state: DataGridSearchCacheState) {
|
||||
const key = cacheKey?.trim();
|
||||
if (!key) return;
|
||||
searchStateCache.delete(key);
|
||||
// An empty, closed search bar is the default state; storing it would only pin a
|
||||
// dead entry and defeat the reset that close() performs.
|
||||
if (!state.searchText && !state.overlayVisible) return;
|
||||
searchStateCache.set(key, { ...state });
|
||||
// Query result keys are session-scoped, so bound the in-memory cache instead of
|
||||
// relying on store cleanup paths.
|
||||
while (searchStateCache.size > SEARCH_STATE_CACHE_MAX_ENTRIES) {
|
||||
const oldest = searchStateCache.keys().next().value;
|
||||
if (oldest === undefined) break;
|
||||
searchStateCache.delete(oldest);
|
||||
}
|
||||
}
|
||||
|
||||
export function clearDataGridSearchStatesForTab(tabId: string) {
|
||||
searchStateCache.delete(tabId);
|
||||
for (const cacheKey of searchStateCache.keys()) {
|
||||
if (cacheKey.startsWith(`${tabId}-`)) searchStateCache.delete(cacheKey);
|
||||
}
|
||||
}
|
||||
|
||||
export function clearDataGridSearchStates() {
|
||||
searchStateCache.clear();
|
||||
}
|
||||
|
||||
export function dataGridSearchStateCount(): number {
|
||||
return searchStateCache.size;
|
||||
}
|
||||
Reference in new issue
Block a user