fix(grid): preserve column filters across tab eviction
This commit is contained in:
7 files changed
+87
-1
No files matched your search
@@ -211,6 +211,7 @@ import { filterObjectBrowserTableColumns } from "@/lib/table/objectBrowserTableI
|
|||||||
import { reserveDataGridHeaderLine } from "@/lib/dataGrid/dataGridHeaderLayout";
|
import { reserveDataGridHeaderLine } from "@/lib/dataGrid/dataGridHeaderLayout";
|
||||||
import { supportsTableStructureEditing } from "@/lib/database/databaseCapabilities";
|
import { supportsTableStructureEditing } from "@/lib/database/databaseCapabilities";
|
||||||
import { rememberDataGridConditionHistory } from "@/lib/dataGrid/dataGridConditionHistory";
|
import { rememberDataGridConditionHistory } from "@/lib/dataGrid/dataGridConditionHistory";
|
||||||
|
import { restoreDataGridLocalColumnFilters, serializeDataGridLocalColumnFilters } from "@/lib/dataGrid/dataGridLocalColumnFilterState";
|
||||||
import { effectiveDatabaseTypeForConnection } from "@/lib/database/jdbcDialect";
|
import { effectiveDatabaseTypeForConnection } from "@/lib/database/jdbcDialect";
|
||||||
import { dataGridConditionColumnOptions } from "@/lib/dataGrid/dataGridConditionCompletion";
|
import { dataGridConditionColumnOptions } from "@/lib/dataGrid/dataGridConditionCompletion";
|
||||||
import { isMacOS } from "@/lib/backend/platform";
|
import { isMacOS } from "@/lib/backend/platform";
|
||||||
@@ -344,6 +345,7 @@ const emit = defineEmits<{
|
|||||||
sort: [column: string, columnIndex: number, direction: "asc" | "desc" | null, whereInput?: string, mode?: DataGridSortMode];
|
sort: [column: string, columnIndex: number, direction: "asc" | "desc" | null, whereInput?: string, mode?: DataGridSortMode];
|
||||||
"update:whereInput": [value: string];
|
"update:whereInput": [value: string];
|
||||||
"update:orderByInput": [value: string];
|
"update:orderByInput": [value: string];
|
||||||
|
"local-column-filters-change": [value: Record<string, string[]>];
|
||||||
}>();
|
}>();
|
||||||
|
|
||||||
const autoRefresh = useDataGridAutoRefresh({ canRefresh: computed(() => !isSaving.value && !props.loading), refresh: onToolbarRefresh });
|
const autoRefresh = useDataGridAutoRefresh({ canRefresh: computed(() => !isSaving.value && !props.loading), refresh: onToolbarRefresh });
|
||||||
@@ -624,7 +626,7 @@ type FilterMode = DataGridContextFilterMode;
|
|||||||
|
|
||||||
type StructuredFilterRule = DataGridStructuredFilterRule;
|
type StructuredFilterRule = DataGridStructuredFilterRule;
|
||||||
|
|
||||||
const localColumnFilters = ref<Record<number, Set<string>>>({});
|
const localColumnFilters = ref<Record<number, Set<string>>>(restoreDataGridLocalColumnFilters(props.result.local_column_filters, props.result.columns.length));
|
||||||
const localFilterOpenColumn = ref<number | null>(null);
|
const localFilterOpenColumn = ref<number | null>(null);
|
||||||
const headerActionMenuOpenColumn = ref<number | null>(null);
|
const headerActionMenuOpenColumn = ref<number | null>(null);
|
||||||
const headerSortMenuOpenColumn = ref<number | null>(null);
|
const headerSortMenuOpenColumn = ref<number | null>(null);
|
||||||
@@ -641,6 +643,8 @@ const serverFilterValueByKey = ref<Map<string, CellValue>>(new Map());
|
|||||||
const serverColumnFilters = ref<Record<number, DataGridCachedServerColumnFilter>>({});
|
const serverColumnFilters = ref<Record<number, DataGridCachedServerColumnFilter>>({});
|
||||||
let serverFilterRequestId = 0;
|
let serverFilterRequestId = 0;
|
||||||
let serverFilterSearchTimer: ReturnType<typeof window.setTimeout> | undefined;
|
let serverFilterSearchTimer: ReturnType<typeof window.setTimeout> | undefined;
|
||||||
|
|
||||||
|
watch(localColumnFilters, (filters) => emit("local-column-filters-change", serializeDataGridLocalColumnFilters(filters)), { deep: true });
|
||||||
const allFilterModeOptions: Array<{ value: FilterMode; labelKey: string }> = [
|
const allFilterModeOptions: Array<{ value: FilterMode; labelKey: string }> = [
|
||||||
{ value: "equals", labelKey: "grid.filterBuilderEquals" },
|
{ value: "equals", labelKey: "grid.filterBuilderEquals" },
|
||||||
{ value: "not-equals", labelKey: "grid.filterBuilderNotEquals" },
|
{ value: "not-equals", labelKey: "grid.filterBuilderNotEquals" },
|
||||||
|
|||||||
@@ -1198,6 +1198,7 @@ defineExpose({ focusSearch, refreshData, refreshQueryEditorCompletionCache, hand
|
|||||||
:all-export-results="allResultExportSheets"
|
:all-export-results="allResultExportSheets"
|
||||||
:export-file-base-name="activeTab.title"
|
:export-file-base-name="activeTab.title"
|
||||||
@update:order-by-input="(v: string) => (activeTab.orderByInput = v)"
|
@update:order-by-input="(v: string) => (activeTab.orderByInput = v)"
|
||||||
|
@local-column-filters-change="(filters: Record<string, string[]>) => queryStore.updateDataGridLocalColumnFilters(activeTab.id, filters)"
|
||||||
@reload="(sql?: string, searchText?: string, whereInput?: string, orderBy?: string, limit?: number, offset?: number, intent?: DataGridReloadIntent) => emit('reload', sql, searchText, whereInput, orderBy, limit, offset, intent)"
|
@reload="(sql?: string, searchText?: string, whereInput?: string, orderBy?: string, limit?: number, offset?: number, intent?: DataGridReloadIntent) => emit('reload', sql, searchText, whereInput, orderBy, limit, offset, intent)"
|
||||||
@paginate="(offset: number, limit: number, whereInput?: string, orderBy?: string) => emit('paginate', offset, limit, whereInput, orderBy)"
|
@paginate="(offset: number, limit: number, whereInput?: string, orderBy?: string) => emit('paginate', offset, limit, whereInput, orderBy)"
|
||||||
@sort="(column: string, columnIndex: number, direction: 'asc' | 'desc' | null, whereInput?: string, mode?: DataGridSortMode) => emit('sort', column, columnIndex, direction, whereInput, mode)"
|
@sort="(column: string, columnIndex: number, direction: 'asc' | 'desc' | null, whereInput?: string, mode?: DataGridSortMode) => emit('sort', column, columnIndex, direction, whereInput, mode)"
|
||||||
@@ -1525,6 +1526,7 @@ defineExpose({ focusSearch, refreshData, refreshQueryEditorCompletionCache, hand
|
|||||||
:export-file-base-name="activeTab.title"
|
:export-file-base-name="activeTab.title"
|
||||||
@update:where-input="(v: string) => (activeTab.whereInput = v)"
|
@update:where-input="(v: string) => (activeTab.whereInput = v)"
|
||||||
@update:order-by-input="(v: string) => (activeTab.orderByInput = v)"
|
@update:order-by-input="(v: string) => (activeTab.orderByInput = v)"
|
||||||
|
@local-column-filters-change="(filters: Record<string, string[]>) => queryStore.updateDataGridLocalColumnFilters(activeTab.id, filters)"
|
||||||
@reload="(sql?: string, searchText?: string, whereInput?: string, orderBy?: string, limit?: number, offset?: number, intent?: DataGridReloadIntent) => emit('reload', sql, searchText, whereInput, orderBy, limit, offset, intent)"
|
@reload="(sql?: string, searchText?: string, whereInput?: string, orderBy?: string, limit?: number, offset?: number, intent?: DataGridReloadIntent) => emit('reload', sql, searchText, whereInput, orderBy, limit, offset, intent)"
|
||||||
@paginate="(offset: number, limit: number, whereInput?: string, orderBy?: string) => emit('paginate', offset, limit, whereInput, orderBy)"
|
@paginate="(offset: number, limit: number, whereInput?: string, orderBy?: string) => emit('paginate', offset, limit, whereInput, orderBy)"
|
||||||
@sort="(column: string, columnIndex: number, direction: 'asc' | 'desc' | null, whereInput?: string, mode?: DataGridSortMode) => emit('sort', column, columnIndex, direction, whereInput, mode)"
|
@sort="(column: string, columnIndex: number, direction: 'asc' | 'desc' | null, whereInput?: string, mode?: DataGridSortMode) => emit('sort', column, columnIndex, direction, whereInput, mode)"
|
||||||
|
|||||||
+30
@@ -0,0 +1,30 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import { restoreDataGridLocalColumnFilters, serializeDataGridLocalColumnFilters } from "@/lib/dataGrid/dataGridLocalColumnFilterState";
|
||||||
|
|
||||||
|
describe("data grid local column filter state", () => {
|
||||||
|
it("round-trips selected values so a remounted grid restores its filters", () => {
|
||||||
|
const serialized = serializeDataGridLocalColumnFilters({
|
||||||
|
0: new Set(["str:active", "__dbx_null__"]),
|
||||||
|
2: new Set(["num:42"]),
|
||||||
|
});
|
||||||
|
|
||||||
|
const restored = restoreDataGridLocalColumnFilters(serialized, 3);
|
||||||
|
|
||||||
|
expect(restored[0]).toEqual(new Set(["str:active", "__dbx_null__"]));
|
||||||
|
expect(restored[2]).toEqual(new Set(["num:42"]));
|
||||||
|
});
|
||||||
|
|
||||||
|
it("drops invalid columns and empty filters before restoring state", () => {
|
||||||
|
const restored = restoreDataGridLocalColumnFilters(
|
||||||
|
{
|
||||||
|
"-1": ["str:invalid"],
|
||||||
|
"1": [],
|
||||||
|
"4": ["str:out-of-range"],
|
||||||
|
nope: ["str:invalid"],
|
||||||
|
},
|
||||||
|
3,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(restored).toEqual({});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
export type SerializedDataGridLocalColumnFilters = Record<string, string[]>;
|
||||||
|
|
||||||
|
export function restoreDataGridLocalColumnFilters(serialized: SerializedDataGridLocalColumnFilters | undefined, columnCount: number): Record<number, Set<string>> {
|
||||||
|
if (!serialized || typeof serialized !== "object") return {};
|
||||||
|
|
||||||
|
const restored: Record<number, Set<string>> = {};
|
||||||
|
for (const [columnIndexText, values] of Object.entries(serialized)) {
|
||||||
|
const columnIndex = Number(columnIndexText);
|
||||||
|
if (!Number.isInteger(columnIndex) || columnIndex < 0 || columnIndex >= columnCount || !Array.isArray(values)) continue;
|
||||||
|
const filteredValues = values.filter((value): value is string => typeof value === "string");
|
||||||
|
if (filteredValues.length > 0) restored[columnIndex] = new Set(filteredValues);
|
||||||
|
}
|
||||||
|
return restored;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function serializeDataGridLocalColumnFilters(filters: Record<number, Set<string>>): SerializedDataGridLocalColumnFilters {
|
||||||
|
return Object.fromEntries(Object.entries(filters).flatMap(([columnIndex, values]) => (values.size > 0 ? [[columnIndex, [...values]]] : [])));
|
||||||
|
}
|
||||||
@@ -68,4 +68,23 @@ describe("queryStore switchTab", () => {
|
|||||||
expect(queryStore.activeTabId).toBe(tabId);
|
expect(queryStore.activeTabId).toBe(tabId);
|
||||||
expect(settingsStore.settingsPageActive).toBe(false);
|
expect(settingsStore.settingsPageActive).toBe(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("stores local data-grid column filters on the tab result", async () => {
|
||||||
|
const { useQueryStore } = await import("@/stores/queryStore");
|
||||||
|
const queryStore = useQueryStore();
|
||||||
|
const tabId = queryStore.createTab("pg-1", "app", "users", "data", "public");
|
||||||
|
const tab = queryStore.tabs.find((item) => item.id === tabId)!;
|
||||||
|
tab.result = {
|
||||||
|
columns: ["id", "status"],
|
||||||
|
rows: [[1, "active"]],
|
||||||
|
affected_rows: 0,
|
||||||
|
execution_time_ms: 1,
|
||||||
|
};
|
||||||
|
|
||||||
|
queryStore.updateDataGridLocalColumnFilters(tabId, { "1": ["str:active"] });
|
||||||
|
expect(tab.result.local_column_filters).toEqual({ "1": ["str:active"] });
|
||||||
|
|
||||||
|
queryStore.updateDataGridLocalColumnFilters(tabId, {});
|
||||||
|
expect(tab.result.local_column_filters).toBeUndefined();
|
||||||
|
});
|
||||||
});
|
});
|
||||||
@@ -2089,6 +2089,16 @@ export const useQueryStore = defineStore("query", () => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function updateDataGridLocalColumnFilters(id: string, filters: Record<string, string[]>) {
|
||||||
|
const tab = tabs.value.find((item) => item.id === id);
|
||||||
|
if (!tab?.result) return;
|
||||||
|
if (Object.keys(filters).length === 0) {
|
||||||
|
delete tab.result.local_column_filters;
|
||||||
|
} else {
|
||||||
|
tab.result.local_column_filters = Object.fromEntries(Object.entries(filters).map(([columnIndex, values]) => [columnIndex, [...values]]));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
function setAutoCommit(id: string, autoCommit: boolean) {
|
function setAutoCommit(id: string, autoCommit: boolean) {
|
||||||
const tab = tabs.value.find((t) => t.id === id);
|
const tab = tabs.value.find((t) => t.id === id);
|
||||||
if (tab) {
|
if (tab) {
|
||||||
@@ -4584,6 +4594,7 @@ export const useQueryStore = defineStore("query", () => {
|
|||||||
rollbackConnectionTransactions,
|
rollbackConnectionTransactions,
|
||||||
rollbackDatabaseTransactions,
|
rollbackDatabaseTransactions,
|
||||||
updateSql,
|
updateSql,
|
||||||
|
updateDataGridLocalColumnFilters,
|
||||||
updateEditorViewport,
|
updateEditorViewport,
|
||||||
updateEditorSelection,
|
updateEditorSelection,
|
||||||
updateObjectBrowserViewport,
|
updateObjectBrowserViewport,
|
||||||
|
|||||||
@@ -552,6 +552,8 @@ export interface QueryResult {
|
|||||||
statement_index?: number;
|
statement_index?: number;
|
||||||
/** Internal row identifiers appended to editable query results. */
|
/** Internal row identifiers appended to editable query results. */
|
||||||
hidden_column_indexes?: number[];
|
hidden_column_indexes?: number[];
|
||||||
|
/** Local value filters survive DataGrid component eviction when switching tabs. */
|
||||||
|
local_column_filters?: Record<string, string[]>;
|
||||||
/**
|
/**
|
||||||
* Database type name for each column, parallel to `columns`. Optional and may
|
* Database type name for each column, parallel to `columns`. Optional and may
|
||||||
* be shorter/empty when a driver cannot supply types (schemaless stores,
|
* be shorter/empty when a driver cannot supply types (schemaless stores,
|
||||||
|
|||||||
Reference in new issue
Block a user