diff --git a/apps/desktop/src/components/grid/DataGrid.vue b/apps/desktop/src/components/grid/DataGrid.vue index 713fcd3f28..2abe978388 100644 --- a/apps/desktop/src/components/grid/DataGrid.vue +++ b/apps/desktop/src/components/grid/DataGrid.vue @@ -349,6 +349,7 @@ const emit = defineEmits<{ "update:whereInput": [value: string]; "update:orderByInput": [value: string]; "local-column-filters-change": [value: Record]; + "hidden-column-keys-change": [value: string[]]; }>(); const autoRefresh = useDataGridAutoRefresh({ canRefresh: computed(() => !isSaving.value && !props.loading), refresh: onToolbarRefresh }); @@ -1711,6 +1712,7 @@ const { toggleColumnVisibility, showAllColumns, invertColumnVisibility, + showColumn, persistColumnOrder, resetColumnOrder, toggleAllNullColumns, @@ -1729,7 +1731,9 @@ const { columnOrderKeys, layoutScopeKey: columnLayoutScopeKey, tableScopeKey: tableColumnOrderScopeKey, + initialHiddenColumnKeys: computed(() => props.result.local_hidden_column_keys), hideNullColumns, + onHiddenColumnKeysChange: (keys) => emit("hidden-column-keys-change", keys), onHideNullColumnsChange: (value) => settingsStore.updateEditorSettings({ dataGridHideNullColumns: value }), onRefreshMetrics: refreshGridScrollerMetrics, }); @@ -1818,8 +1822,7 @@ function scrollToColumnIndex(columnIndex: number) { if (columnIndex < 0 || !displayableColumnIndexes.value.includes(columnIndex)) return; if (hiddenColumnIndexes.value.has(columnIndex)) { - hiddenColumnIndexes.value.delete(columnIndex); - hiddenColumnIndexes.value = new Set(hiddenColumnIndexes.value); + showColumn(columnIndex); } highlightedColumnIndex.value = columnIndex; @@ -2324,7 +2327,7 @@ watch( () => localFilterScopeKey.value, () => { localColumnFilters.value = {}; - resetColumnVisibility(); + resetColumnVisibility(props.result.local_hidden_column_keys); closeLocalFilter(); }, ); diff --git a/apps/desktop/src/components/layout/ContentArea.vue b/apps/desktop/src/components/layout/ContentArea.vue index 5d624e3940..5609195b7d 100644 --- a/apps/desktop/src/components/layout/ContentArea.vue +++ b/apps/desktop/src/components/layout/ContentArea.vue @@ -1358,6 +1358,7 @@ defineExpose({ focusSearch, refreshData, refreshQueryEditorCompletionCache, hand :export-file-base-name="activeTab.title" @update:order-by-input="(v: string) => (activeTab.orderByInput = v)" @local-column-filters-change="(filters: Record) => queryStore.updateDataGridLocalColumnFilters(activeTab.id, filters)" + @hidden-column-keys-change="(keys: string[]) => queryStore.updateDataGridHiddenColumnKeys(activeTab.id, keys)" @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)" @sort="(column: string, columnIndex: number, direction: 'asc' | 'desc' | null, whereInput?: string, mode?: DataGridSortMode) => emit('sort', column, columnIndex, direction, whereInput, mode)" @@ -1722,6 +1723,7 @@ defineExpose({ focusSearch, refreshData, refreshQueryEditorCompletionCache, hand @update:where-input="(v: string) => (activeTab.whereInput = v)" @update:order-by-input="(v: string) => (activeTab.orderByInput = v)" @local-column-filters-change="(filters: Record) => queryStore.updateDataGridLocalColumnFilters(activeTab.id, filters)" + @hidden-column-keys-change="(keys: string[]) => queryStore.updateDataGridHiddenColumnKeys(activeTab.id, keys)" @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)" @sort="(column: string, columnIndex: number, direction: 'asc' | 'desc' | null, whereInput?: string, mode?: DataGridSortMode) => emit('sort', column, columnIndex, direction, whereInput, mode)" diff --git a/apps/desktop/src/composables/__tests__/useDataGridColumnLayout.spec.ts b/apps/desktop/src/composables/__tests__/useDataGridColumnLayout.spec.ts index 579fcce301..197cbee26d 100644 --- a/apps/desktop/src/composables/__tests__/useDataGridColumnLayout.spec.ts +++ b/apps/desktop/src/composables/__tests__/useDataGridColumnLayout.spec.ts @@ -100,6 +100,63 @@ describe("useDataGridColumnLayout", () => { scope.stop(); }); + it("restores manually hidden columns after the grid scope is recreated", () => { + const hiddenColumnKeys = ref([]); + const options = { + columns: ref(["id", "name", "email"]), + sourceColumns: ref(undefined), + commentByColumn: ref(new Map()), + displayableColumnIndexes: ref([0, 1, 2]), + allNullColumnIndexes: ref([]), + columnOrderKeys: ref(["id\0\0", "name\0\0", "email\0\0"]), + layoutScopeKey: ref("visibility-recreated-layout"), + tableScopeKey: ref(""), + initialHiddenColumnKeys: hiddenColumnKeys, + onHiddenColumnKeysChange: (keys: string[]) => { + hiddenColumnKeys.value = keys; + }, + }; + const firstScope = effectScope(); + const firstState = firstScope.run(() => useDataGridColumnLayoutState(options))!; + + firstState.toggleColumnVisibility(1); + expect(hiddenColumnKeys.value).toEqual(["name\0\0"]); + firstScope.stop(); + + const recreatedScope = effectScope(); + const recreatedState = recreatedScope.run(() => useDataGridColumnLayoutState(options))!; + expect(recreatedState.visibleColumnIndexes.value).toEqual([0, 2]); + recreatedState.showAllColumns(); + expect(hiddenColumnKeys.value).toEqual([]); + recreatedScope.stop(); + }); + + it("persists a null column when it is manually hidden after showing all columns", () => { + const onHiddenColumnKeysChange = vi.fn(); + const scope = effectScope(); + const state = scope.run(() => + useDataGridColumnLayoutState({ + columns: ref(["id", "empty"]), + sourceColumns: ref(undefined), + commentByColumn: ref(new Map()), + displayableColumnIndexes: ref([0, 1]), + allNullColumnIndexes: ref([1]), + columnOrderKeys: ref(["id\0\0", "empty\0\0"]), + layoutScopeKey: ref("visibility-null-column-layout"), + tableScopeKey: ref(""), + hideNullColumns: ref(true), + onHiddenColumnKeysChange, + }), + )!; + + expect(state.visibleColumnIndexes.value).toEqual([0]); + state.showAllColumns(); + state.toggleColumnVisibility(1); + + expect(onHiddenColumnKeysChange).toHaveBeenLastCalledWith(["empty\0\0"]); + scope.stop(); + }); + it("keeps a new resize active when the previous resize completion frame is pending", () => { const frames = new Map(); let nextFrame = 1; diff --git a/apps/desktop/src/composables/useDataGridColumnLayout.ts b/apps/desktop/src/composables/useDataGridColumnLayout.ts index dcb876e171..8fecb94dce 100644 --- a/apps/desktop/src/composables/useDataGridColumnLayout.ts +++ b/apps/desktop/src/composables/useDataGridColumnLayout.ts @@ -14,7 +14,7 @@ import { saveTableDataGridColumnOrder, type TableDataGridColumnOrderChangedDetail, } from "@/lib/dataGrid/dataGridColumnLayoutStorage"; -import { filterColumnVisibilityOptions, hiddenColumnIndexesWithAllNullColumns, invertedHiddenColumnIndexes, nextHiddenColumnIndexes, removeAutoHiddenColumnIndexes, visibleColumnIndexesForFilter } from "@/lib/dataGrid/dataGridColumnVisibility"; +import { filterColumnVisibilityOptions, hiddenColumnIndexesForKeys, hiddenColumnIndexesWithAllNullColumns, hiddenColumnKeysForIndexes, invertedHiddenColumnIndexes, nextHiddenColumnIndexes, removeAutoHiddenColumnIndexes, visibleColumnIndexesForFilter } from "@/lib/dataGrid/dataGridColumnVisibility"; export type RenderedDataGridColumn = { visibleColIdx: number; @@ -76,11 +76,13 @@ export function useDataGridColumnLayoutState(options: { columnOrderKeys: MaybeRefOrGetter; layoutScopeKey: MaybeRefOrGetter; tableScopeKey: MaybeRefOrGetter; + initialHiddenColumnKeys?: MaybeRefOrGetter; hideNullColumns?: MaybeRefOrGetter; + onHiddenColumnKeysChange?: (keys: string[]) => void; onHideNullColumnsChange?: (value: boolean) => void; onRefreshMetrics?: () => void; }) { - const hiddenColumnIndexes = ref>(new Set()); + const hiddenColumnIndexes = ref>(hiddenColumnIndexesForKeys(toValue(options.initialHiddenColumnKeys), toValue(options.columnOrderKeys), toValue(options.displayableColumnIndexes))); const localNullColumnsHidden = ref(false); const nullColumnsHidden = computed(() => (options.hideNullColumns === undefined ? localNullColumnsHidden.value : toValue(options.hideNullColumns))); const autoHiddenNullColumnIndexes = ref>(new Set()); @@ -103,14 +105,33 @@ export function useDataGridColumnLayoutState(options: { function isColumnVisible(columnIndex: number) { return !hiddenColumnIndexes.value.has(columnIndex); } + function persistHiddenColumnKeys() { + options.onHiddenColumnKeysChange?.(hiddenColumnKeysForIndexes(hiddenColumnIndexes.value, autoHiddenNullColumnIndexes.value, toValue(options.columnOrderKeys), toValue(options.displayableColumnIndexes))); + } function toggleColumnVisibility(columnIndex: number) { hiddenColumnIndexes.value = nextHiddenColumnIndexes({ columnIndex, hiddenIndexes: hiddenColumnIndexes.value, totalColumns: displayableColumnCount.value }); + if (!hiddenColumnIndexes.value.has(columnIndex) && autoHiddenNullColumnIndexes.value.delete(columnIndex)) { + autoHiddenNullColumnIndexes.value = new Set(autoHiddenNullColumnIndexes.value); + } + persistHiddenColumnKeys(); } function showAllColumns() { hiddenColumnIndexes.value = new Set(); + autoHiddenNullColumnIndexes.value = new Set(); + persistHiddenColumnKeys(); } function invertColumnVisibility() { hiddenColumnIndexes.value = invertedHiddenColumnIndexes([...toValue(options.displayableColumnIndexes)], hiddenColumnIndexes.value); + autoHiddenNullColumnIndexes.value = new Set(); + persistHiddenColumnKeys(); + } + function showColumn(columnIndex: number) { + if (!hiddenColumnIndexes.value.has(columnIndex)) return; + hiddenColumnIndexes.value.delete(columnIndex); + hiddenColumnIndexes.value = new Set(hiddenColumnIndexes.value); + autoHiddenNullColumnIndexes.value.delete(columnIndex); + autoHiddenNullColumnIndexes.value = new Set(autoHiddenNullColumnIndexes.value); + persistHiddenColumnKeys(); } function loadColumnOrder() { const tableScopeKey = toValue(options.tableScopeKey); @@ -233,8 +254,8 @@ export function useDataGridColumnLayoutState(options: { if (options.onRefreshMetrics) nextTick(options.onRefreshMetrics); } - function resetColumnVisibility() { - hiddenColumnIndexes.value = new Set(); + function resetColumnVisibility(hiddenColumnKeys: readonly string[] = []) { + hiddenColumnIndexes.value = hiddenColumnIndexesForKeys(hiddenColumnKeys, toValue(options.columnOrderKeys), toValue(options.displayableColumnIndexes)); autoHiddenNullColumnIndexes.value = new Set(); applyNullColumnVisibility(nullColumnsHidden.value); } @@ -271,6 +292,7 @@ export function useDataGridColumnLayoutState(options: { toggleColumnVisibility, showAllColumns, invertColumnVisibility, + showColumn, persistColumnOrder, resetColumnOrder, toggleAllNullColumns, diff --git a/apps/desktop/src/lib/dataGrid/dataGridColumnVisibility.ts b/apps/desktop/src/lib/dataGrid/dataGridColumnVisibility.ts index d69a1a1d41..e31fc44b3e 100644 --- a/apps/desktop/src/lib/dataGrid/dataGridColumnVisibility.ts +++ b/apps/desktop/src/lib/dataGrid/dataGridColumnVisibility.ts @@ -31,6 +31,28 @@ export function visibleColumnIndexesForFilter(availableIndexes: number[], hidden return visibleIndexes.length > 0 ? visibleIndexes : availableIndexes; } +export function hiddenColumnIndexesForKeys(hiddenKeys: readonly string[] | undefined, columnKeys: readonly string[], availableIndexes: readonly number[]): Set { + const available = new Set(availableIndexes); + const hiddenKeySet = new Set((hiddenKeys ?? []).filter((key): key is string => typeof key === "string")); + const hiddenIndexes = new Set(); + + for (let index = 0; index < columnKeys.length; index++) { + if (available.has(index) && hiddenKeySet.has(columnKeys[index]!)) hiddenIndexes.add(index); + } + + if (availableIndexes.length > 0 && hiddenIndexes.size === availableIndexes.length) { + hiddenIndexes.delete(availableIndexes[0]!); + } + return hiddenIndexes; +} + +export function hiddenColumnKeysForIndexes(hiddenIndexes: ReadonlySet, autoHiddenIndexes: ReadonlySet, columnKeys: readonly string[], availableIndexes: readonly number[]): string[] { + return availableIndexes.flatMap((index) => { + const key = columnKeys[index]; + return hiddenIndexes.has(index) && !autoHiddenIndexes.has(index) && key ? [key] : []; + }); +} + export function nextHiddenColumnIndexes(options: { columnIndex: number; hiddenIndexes: ReadonlySet; totalColumns: number }): Set { const next = new Set(options.hiddenIndexes); if (next.has(options.columnIndex)) { diff --git a/apps/desktop/src/stores/__tests__/queryStore.switchTab.spec.ts b/apps/desktop/src/stores/__tests__/queryStore.switchTab.spec.ts index 79577a1779..4e128a9db1 100644 --- a/apps/desktop/src/stores/__tests__/queryStore.switchTab.spec.ts +++ b/apps/desktop/src/stores/__tests__/queryStore.switchTab.spec.ts @@ -93,6 +93,25 @@ describe("queryStore switchTab", () => { expect(tab.result.local_column_filters).toBeUndefined(); }); + it("stores hidden data-grid column keys 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.updateDataGridHiddenColumnKeys(tabId, ["status\0\0"]); + expect(tab.result.local_hidden_column_keys).toEqual(["status\0\0"]); + + queryStore.updateDataGridHiddenColumnKeys(tabId, []); + expect(tab.result.local_hidden_column_keys).toBeUndefined(); + }); + it("opens one reusable Nacos dashboard tab per connection", async () => { const { useQueryStore } = await import("@/stores/queryStore"); const queryStore = useQueryStore(); diff --git a/apps/desktop/src/stores/queryStore.ts b/apps/desktop/src/stores/queryStore.ts index fb3b9e519f..dcf2cdc7f3 100644 --- a/apps/desktop/src/stores/queryStore.ts +++ b/apps/desktop/src/stores/queryStore.ts @@ -2163,6 +2163,16 @@ export const useQueryStore = defineStore("query", () => { } } + function updateDataGridHiddenColumnKeys(id: string, keys: string[]) { + const tab = tabs.value.find((item) => item.id === id); + if (!tab?.result) return; + if (keys.length === 0) { + delete tab.result.local_hidden_column_keys; + } else { + tab.result.local_hidden_column_keys = [...keys]; + } + } + function setAutoCommit(id: string, autoCommit: boolean) { const tab = tabs.value.find((t) => t.id === id); if (tab) { @@ -4746,6 +4756,7 @@ export const useQueryStore = defineStore("query", () => { rollbackDatabaseTransactions, updateSql, updateDataGridLocalColumnFilters, + updateDataGridHiddenColumnKeys, updateEditorViewport, updateEditorSelection, updateObjectBrowserViewport, diff --git a/apps/desktop/src/types/database.ts b/apps/desktop/src/types/database.ts index 2bd3c962f7..9a0b2e5a5c 100644 --- a/apps/desktop/src/types/database.ts +++ b/apps/desktop/src/types/database.ts @@ -558,6 +558,8 @@ export interface QueryResult { hidden_column_indexes?: number[]; /** Local value filters survive DataGrid component eviction when switching tabs. */ local_column_filters?: Record; + /** Manually hidden columns survive DataGrid component eviction when switching tabs. */ + local_hidden_column_keys?: string[]; /** * Database type name for each column, parallel to `columns`. Optional and may * be shorter/empty when a driver cannot supply types (schemaless stores, diff --git a/packages/app-tests/dataGridColumnVisibility.test.ts b/packages/app-tests/dataGridColumnVisibility.test.ts index 704b581bd0..41b475e4b8 100644 --- a/packages/app-tests/dataGridColumnVisibility.test.ts +++ b/packages/app-tests/dataGridColumnVisibility.test.ts @@ -1,7 +1,7 @@ import { strict as assert } from "node:assert"; import { test } from "vitest"; import { buildDataGridColumnLookupItems, filterDataGridColumnLookupItems } from "../../apps/desktop/src/lib/dataGrid/dataGridColumnLookup.ts"; -import { allNullColumnIndexes, filterColumnVisibilityOptions, hiddenColumnIndexesWithAllNullColumns, invertedHiddenColumnIndexes, nextHiddenColumnIndexes, removeAutoHiddenColumnIndexes, visibleColumnIndexesForFilter } from "../../apps/desktop/src/lib/dataGrid/dataGridColumnVisibility.ts"; +import { allNullColumnIndexes, filterColumnVisibilityOptions, hiddenColumnIndexesForKeys, hiddenColumnIndexesWithAllNullColumns, hiddenColumnKeysForIndexes, invertedHiddenColumnIndexes, nextHiddenColumnIndexes, removeAutoHiddenColumnIndexes, visibleColumnIndexesForFilter } from "../../apps/desktop/src/lib/dataGrid/dataGridColumnVisibility.ts"; test("filters column visibility options by trimmed case-insensitive text", () => { const options = filterColumnVisibilityOptions(["id", "created_at", "CustomerName"], " NAME "); @@ -53,6 +53,20 @@ test("removes hidden indexes from visible columns", () => { assert.deepEqual(indexes, [0, 2]); }); +test("round-trips manually hidden columns by stable column key", () => { + const columnKeys = ["id\0\0", "name\0\0", "email\0\0"]; + const serialized = hiddenColumnKeysForIndexes(new Set([1, 2]), new Set([2]), columnKeys, [0, 1, 2]); + + assert.deepEqual(serialized, ["name\0\0"]); + assert.deepEqual([...hiddenColumnIndexesForKeys(serialized, columnKeys, [0, 1, 2])], [1]); +}); + +test("ignores stale hidden keys and keeps one column visible", () => { + const columnKeys = ["id\0\0", "name\0\0"]; + + assert.deepEqual([...hiddenColumnIndexesForKeys(["missing\0\0", ...columnKeys], columnKeys, [0, 1])], [1]); +}); + test("keeps the last visible column when toggling visibility", () => { const hidden = nextHiddenColumnIndexes({ columnIndex: 0,