feat(data-grid): add configurable default sorting
This commit is contained in:
24 files changed
+720
-17
No files matched your search
@@ -8,6 +8,7 @@ const mocks = vi.hoisted(() => ({
|
||||
executeMulti: vi.fn(),
|
||||
getConnectionConfig: vi.fn(),
|
||||
saveOpenTabsState: vi.fn(),
|
||||
openTableDefaultSortMode: "none" as "none" | "primary-key-asc" | "primary-key-desc",
|
||||
}));
|
||||
|
||||
vi.mock("@/lib/backend/api", () => ({
|
||||
@@ -22,13 +23,14 @@ vi.mock("@/stores/connectionStore", () => ({
|
||||
useConnectionStore: () => ({
|
||||
ensureConnected: vi.fn().mockResolvedValue(undefined),
|
||||
getConfig: mocks.getConnectionConfig,
|
||||
connectionIdentifierQuote: () => undefined,
|
||||
recordConnectionLostError: vi.fn(),
|
||||
}),
|
||||
}));
|
||||
|
||||
vi.mock("@/stores/settingsStore", () => ({
|
||||
useSettingsStore: () => ({
|
||||
editorSettings: { pageSize: 1000 },
|
||||
editorSettings: { pageSize: 1000, tableOpenPageSize: 100, openTableDefaultSortMode: mocks.openTableDefaultSortMode },
|
||||
}),
|
||||
}));
|
||||
|
||||
@@ -47,6 +49,7 @@ describe("queryStore table data refresh", () => {
|
||||
vi.unstubAllGlobals();
|
||||
installLocalStorage();
|
||||
setActivePinia(createPinia());
|
||||
mocks.openTableDefaultSortMode = "none";
|
||||
mocks.getConnectionConfig.mockReturnValue({
|
||||
id: "pg-1",
|
||||
name: "Postgres",
|
||||
@@ -291,4 +294,35 @@ describe("queryStore table data refresh", () => {
|
||||
expect(tab.result?.execution_error).toBe(true);
|
||||
expect(mocks.executeMulti).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("rebuilds persisted default sorting with every composite primary-key column", async () => {
|
||||
mocks.openTableDefaultSortMode = "primary-key-desc";
|
||||
const { useQueryStore } = await import("@/stores/queryStore");
|
||||
const store = useQueryStore();
|
||||
const tabId = store.createTab("pg-1", "app", "orders", "data", "public");
|
||||
store.setTableMeta(tabId, {
|
||||
schema: "public",
|
||||
tableName: "orders",
|
||||
tableType: "TABLE",
|
||||
columns: [
|
||||
{ name: "Tenant", data_type: "text", is_nullable: false, column_default: null, is_primary_key: true, extra: null },
|
||||
{ name: "Order", data_type: "bigint", is_nullable: false, column_default: null, is_primary_key: true, extra: null },
|
||||
],
|
||||
primaryKeys: ["Tenant", "Order"],
|
||||
});
|
||||
const tab = store.tabs.find((candidate) => candidate.id === tabId)!;
|
||||
tab.openTableDefaultSortApplied = true;
|
||||
tab.openTableDefaultSortOrderBy = '"Tenant" ASC, "Order" ASC';
|
||||
tab.orderByInput = tab.openTableDefaultSortOrderBy;
|
||||
|
||||
await expect(store.refreshDataTab(tabId)).resolves.toBe(true);
|
||||
|
||||
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
primaryKeys: ["Tenant", "Order"],
|
||||
orderBy: '"Tenant" DESC, "Order" DESC',
|
||||
}),
|
||||
);
|
||||
expect(tab.orderByInput).toBe('"Tenant" DESC, "Order" DESC');
|
||||
});
|
||||
});
|
||||
@@ -5,6 +5,31 @@ import { isProxy } from "vue";
|
||||
import type { AiConfigItem } from "@/types/ai";
|
||||
|
||||
describe("normalizeEditorSettings", () => {
|
||||
it("keeps quick sorting disabled unless current or legacy settings explicitly enable it", () => {
|
||||
const missing = normalizeEditorSettings({});
|
||||
expect(missing.dataGridQuickSortEnabled).toBe(false);
|
||||
expect(missing.dataGridQuickSortMode).toBe("local");
|
||||
expect(missing.dataGridQuickSortDirection).toBe("asc");
|
||||
|
||||
const legacyEnabled = normalizeEditorSettings({
|
||||
defaultDataGridSortEnabled: true,
|
||||
defaultDataGridSortMode: "database",
|
||||
defaultDataGridSortDirection: "desc",
|
||||
} as any);
|
||||
expect(legacyEnabled.dataGridQuickSortEnabled).toBe(true);
|
||||
expect(legacyEnabled.dataGridQuickSortMode).toBe("database");
|
||||
expect(legacyEnabled.dataGridQuickSortDirection).toBe("desc");
|
||||
|
||||
const legacyDisabled = normalizeEditorSettings({
|
||||
defaultDataGridSortEnabled: false,
|
||||
defaultDataGridSortMode: "database",
|
||||
defaultDataGridSortDirection: "desc",
|
||||
} as any);
|
||||
expect(legacyDisabled.dataGridQuickSortEnabled).toBe(false);
|
||||
expect(legacyDisabled.dataGridQuickSortMode).toBe("database");
|
||||
expect(legacyDisabled.dataGridQuickSortDirection).toBe("desc");
|
||||
});
|
||||
|
||||
it("uses aligned comments by default and preserves legacy comment visibility", () => {
|
||||
expect(normalizeEditorSettings({}).sidebarObjectInfoMode).toBe("comment-aligned");
|
||||
expect(normalizeEditorSettings({ sidebarObjectInfoMode: "comment-aligned" }).sidebarObjectInfoMode).toBe("comment-aligned");
|
||||
|
||||
@@ -41,6 +41,7 @@ import { dataTabExecutionDatabase } from "@/lib/table/dataTabExecutionDatabase";
|
||||
import { tableOpenPageLimit } from "@/lib/table/tableOpenPageLimit";
|
||||
import { getCachedTableMetadata, loadTableIndexes, loadTableMetadata, type TableMetadataRequest } from "@/lib/metadata/tableMetadataCache";
|
||||
import { buildTableSelectSql, quoteTableDataIdentifier } from "@/lib/table/tableSelectSql";
|
||||
import { applyOpenTableDefaultSortState, buildOpenTableDefaultSort } from "@/lib/table/tableDefaultSort";
|
||||
import { connectionQueryExecutionSchema, connectionUsesDatabaseObjectTreeMode, effectiveDatabaseTypeForConnection, metadataSchemaForConnection } from "@/lib/database/jdbcDialect";
|
||||
import { frontendQueryTimeoutSecsForSql, queryTimeoutSecsForConnection } from "@/lib/sql/queryTimeout";
|
||||
import { queryResultNameFromPreamble, queryResultSourceLabel } from "@/lib/sql/queryResultSource";
|
||||
@@ -1103,6 +1104,8 @@ export const useQueryStore = defineStore("query", () => {
|
||||
resultSortDirection: t.resultSortDirection,
|
||||
resultSortMode: t.resultSortMode,
|
||||
orderByInput: t.orderByInput,
|
||||
openTableDefaultSortApplied: t.openTableDefaultSortApplied,
|
||||
openTableDefaultSortOrderBy: t.openTableDefaultSortOrderBy,
|
||||
resultPageLimit: t.resultPageLimit,
|
||||
resultPageOffset: t.resultPageOffset,
|
||||
whereInput: t.whereInput,
|
||||
@@ -1950,6 +1953,8 @@ export const useQueryStore = defineStore("query", () => {
|
||||
resultLocalSortOriginalMongoDocuments: undefined,
|
||||
resultLocalSortOriginalMongoCopyDocuments: undefined,
|
||||
orderByInput: undefined,
|
||||
openTableDefaultSortApplied: undefined,
|
||||
openTableDefaultSortOrderBy: undefined,
|
||||
resultPageSql: undefined,
|
||||
resultPageLimit: undefined,
|
||||
resultPageOffset: undefined,
|
||||
@@ -2078,8 +2083,18 @@ export const useQueryStore = defineStore("query", () => {
|
||||
const effectiveDbType = effectiveDatabaseTypeForConnection(conn);
|
||||
const identifierQuote = connStore.connectionIdentifierQuote?.(tab.connectionId);
|
||||
const primaryKeys = tab.tableMeta ? tab.tableMeta.primaryKeys : tableMeta.primaryKeys;
|
||||
const openTableDefaultSort = tab.openTableDefaultSortApplied
|
||||
? buildOpenTableDefaultSort({
|
||||
mode: settingsStore.editorSettings.openTableDefaultSortMode,
|
||||
databaseType: effectiveDbType,
|
||||
identifierQuote,
|
||||
primaryKeys,
|
||||
columns: tableMeta.columns.map((column) => column.name),
|
||||
})
|
||||
: undefined;
|
||||
if (tab.openTableDefaultSortApplied) applyOpenTableDefaultSortState(tab, openTableDefaultSort);
|
||||
const sortOrder = tab.resultSortColumn && tab.resultSortDirection ? `${quoteTableDataIdentifier(effectiveDbType, tab.resultSortColumn, identifierQuote)} ${tab.resultSortDirection.toUpperCase()}` : undefined;
|
||||
const orderBy = tab.orderByInput?.trim() || sortOrder;
|
||||
const orderBy = openTableDefaultSort?.orderBy ?? (tab.orderByInput?.trim() || sortOrder);
|
||||
const limit = tab.resultPageLimit ?? tableOpenPageLimit(settingsStore.editorSettings.tableOpenPageSize);
|
||||
const offset = tab.resultPageOffset ?? 0;
|
||||
const refreshPreparationId = uuid();
|
||||
@@ -4616,8 +4631,18 @@ export const useQueryStore = defineStore("query", () => {
|
||||
const effectiveDbType = effectiveDatabaseTypeForConnection(conn);
|
||||
const identifierQuote = connStore.connectionIdentifierQuote?.(tab.connectionId);
|
||||
const primaryKeys = tab.tableMeta ? tab.tableMeta.primaryKeys : tableMeta.primaryKeys;
|
||||
const openTableDefaultSort = tab.openTableDefaultSortApplied
|
||||
? buildOpenTableDefaultSort({
|
||||
mode: settingsStore.editorSettings.openTableDefaultSortMode,
|
||||
databaseType: effectiveDbType,
|
||||
identifierQuote,
|
||||
primaryKeys,
|
||||
columns: tableMeta.columns.map((column) => column.name),
|
||||
})
|
||||
: undefined;
|
||||
if (tab.openTableDefaultSortApplied) applyOpenTableDefaultSortState(tab, openTableDefaultSort);
|
||||
const sortOrder = tab.resultSortColumn && tab.resultSortDirection ? `${quoteTableDataIdentifier(effectiveDbType, tab.resultSortColumn, identifierQuote)} ${tab.resultSortDirection.toUpperCase()}` : undefined;
|
||||
const orderBy = tab.orderByInput?.trim() || sortOrder;
|
||||
const orderBy = openTableDefaultSort?.orderBy ?? (tab.orderByInput?.trim() || sortOrder);
|
||||
const queryTimeoutSecs = queryTimeoutSecsForConnection(conn);
|
||||
const executionDatabase = dataTabExecutionDatabase(conn, tab.database, tableMeta.catalog);
|
||||
const rows: QueryResult["rows"] = [];
|
||||
|
||||
@@ -49,6 +49,9 @@ export type InterfaceLayout = "separated" | "classic";
|
||||
|
||||
export type UpdateDownloadSource = "official" | "cnb";
|
||||
export type SqlSemanticDiagnosticsMode = "auto" | "enabled" | "disabled";
|
||||
export type OpenTableDefaultSortMode = "none" | "primary-key-asc" | "primary-key-desc";
|
||||
export type DataGridQuickSortMode = "database" | "local";
|
||||
export type DataGridQuickSortDirection = "asc" | "desc";
|
||||
export type OpenTabsRestoreMode = "all" | "pinned" | "none";
|
||||
|
||||
export const DEFAULT_SIDEBAR_TABLE_PAGE_SIZE = 1000;
|
||||
@@ -434,6 +437,10 @@ export interface EditorSettings {
|
||||
showColumnTypesInHeader: boolean;
|
||||
compactColumnHeaderActions: boolean;
|
||||
columnWidthDensity: ColumnWidthDensity;
|
||||
openTableDefaultSortMode: OpenTableDefaultSortMode;
|
||||
dataGridQuickSortEnabled: boolean;
|
||||
dataGridQuickSortMode: DataGridQuickSortMode;
|
||||
dataGridQuickSortDirection: DataGridQuickSortDirection;
|
||||
dataGridQuickEntry: boolean;
|
||||
dataGridRenderMode: DataGridRenderMode;
|
||||
dataGridSearchMode: DataGridSearchMode;
|
||||
@@ -602,6 +609,10 @@ export const DEFAULT_EDITOR_SETTINGS: EditorSettings = {
|
||||
showColumnTypesInHeader: true,
|
||||
compactColumnHeaderActions: true,
|
||||
columnWidthDensity: "standard",
|
||||
openTableDefaultSortMode: "none",
|
||||
dataGridQuickSortEnabled: false,
|
||||
dataGridQuickSortMode: "local",
|
||||
dataGridQuickSortDirection: "asc",
|
||||
dataGridQuickEntry: false,
|
||||
dataGridRenderMode: "canvas",
|
||||
dataGridSearchMode: "filter",
|
||||
@@ -697,6 +708,18 @@ function normalizeDataGridRenderMode(value: unknown): DataGridRenderMode {
|
||||
return DATA_GRID_RENDER_MODES.includes(value as DataGridRenderMode) ? (value as DataGridRenderMode) : DEFAULT_EDITOR_SETTINGS.dataGridRenderMode;
|
||||
}
|
||||
|
||||
function normalizeOpenTableDefaultSortMode(value: unknown): OpenTableDefaultSortMode {
|
||||
return value === "primary-key-asc" || value === "primary-key-desc" || value === "none" ? value : DEFAULT_EDITOR_SETTINGS.openTableDefaultSortMode;
|
||||
}
|
||||
|
||||
function normalizeDataGridQuickSortMode(value: unknown): DataGridQuickSortMode {
|
||||
return value === "database" || value === "local" ? value : DEFAULT_EDITOR_SETTINGS.dataGridQuickSortMode;
|
||||
}
|
||||
|
||||
function normalizeDataGridQuickSortDirection(value: unknown): DataGridQuickSortDirection {
|
||||
return value === "desc" ? "desc" : DEFAULT_EDITOR_SETTINGS.dataGridQuickSortDirection;
|
||||
}
|
||||
|
||||
function normalizeDataGridSearchMode(value: unknown): DataGridSearchMode {
|
||||
return DATA_GRID_SEARCH_MODES.includes(value as DataGridSearchMode) ? (value as DataGridSearchMode) : DEFAULT_EDITOR_SETTINGS.dataGridSearchMode;
|
||||
}
|
||||
@@ -824,6 +847,11 @@ function normalizeTableInfoTab(value: unknown): TableInfoTab {
|
||||
}
|
||||
|
||||
export function normalizeEditorSettings(settings: Partial<EditorSettings>, existing?: EditorSettings): EditorSettings {
|
||||
const legacyDefaultSort = settings as Partial<EditorSettings> & {
|
||||
defaultDataGridSortEnabled?: boolean;
|
||||
defaultDataGridSortMode?: DataGridQuickSortMode;
|
||||
defaultDataGridSortDirection?: DataGridQuickSortDirection;
|
||||
};
|
||||
const sqlSemanticDiagnosticsMode = normalizeSqlSemanticDiagnosticsMode(settings.sqlSemanticDiagnosticsMode, settings.sqlSemanticDiagnosticsEnabled);
|
||||
const savedExecuteModeDefaultVersion = settings.executeModeDefaultVersion;
|
||||
const executeModeDefaultVersion = typeof savedExecuteModeDefaultVersion === "number" && savedExecuteModeDefaultVersion >= EXECUTE_MODE_CURRENT_DEFAULT_VERSION ? savedExecuteModeDefaultVersion : EXECUTE_MODE_CURRENT_DEFAULT_VERSION;
|
||||
@@ -889,6 +917,10 @@ export function normalizeEditorSettings(settings: Partial<EditorSettings>, exist
|
||||
showColumnTypesInHeader: settings.showColumnTypesInHeader ?? DEFAULT_EDITOR_SETTINGS.showColumnTypesInHeader,
|
||||
compactColumnHeaderActions: settings.compactColumnHeaderActions ?? DEFAULT_EDITOR_SETTINGS.compactColumnHeaderActions,
|
||||
columnWidthDensity: normalizeColumnWidthDensity(settings.columnWidthDensity),
|
||||
openTableDefaultSortMode: normalizeOpenTableDefaultSortMode(settings.openTableDefaultSortMode),
|
||||
dataGridQuickSortEnabled: typeof settings.dataGridQuickSortEnabled === "boolean" ? settings.dataGridQuickSortEnabled : legacyDefaultSort.defaultDataGridSortEnabled === true,
|
||||
dataGridQuickSortMode: normalizeDataGridQuickSortMode(settings.dataGridQuickSortMode ?? legacyDefaultSort.defaultDataGridSortMode),
|
||||
dataGridQuickSortDirection: normalizeDataGridQuickSortDirection(settings.dataGridQuickSortDirection ?? legacyDefaultSort.defaultDataGridSortDirection),
|
||||
dataGridQuickEntry: settings.dataGridQuickEntry ?? DEFAULT_EDITOR_SETTINGS.dataGridQuickEntry,
|
||||
dataGridRenderMode: normalizeDataGridRenderMode(settings.dataGridRenderMode),
|
||||
dataGridSearchMode: normalizeDataGridSearchMode(settings.dataGridSearchMode),
|
||||
@@ -1330,6 +1362,10 @@ export const useSettingsStore = defineStore("settings", () => {
|
||||
if (partial.showColumnTypesInHeader !== undefined) editorSettings.value.showColumnTypesInHeader = partial.showColumnTypesInHeader;
|
||||
if (partial.compactColumnHeaderActions !== undefined) editorSettings.value.compactColumnHeaderActions = partial.compactColumnHeaderActions;
|
||||
if (partial.columnWidthDensity !== undefined) editorSettings.value.columnWidthDensity = normalizeColumnWidthDensity(partial.columnWidthDensity);
|
||||
if (partial.openTableDefaultSortMode !== undefined) editorSettings.value.openTableDefaultSortMode = normalizeOpenTableDefaultSortMode(partial.openTableDefaultSortMode);
|
||||
if (partial.dataGridQuickSortEnabled !== undefined) editorSettings.value.dataGridQuickSortEnabled = partial.dataGridQuickSortEnabled === true;
|
||||
if (partial.dataGridQuickSortMode !== undefined) editorSettings.value.dataGridQuickSortMode = normalizeDataGridQuickSortMode(partial.dataGridQuickSortMode);
|
||||
if (partial.dataGridQuickSortDirection !== undefined) editorSettings.value.dataGridQuickSortDirection = normalizeDataGridQuickSortDirection(partial.dataGridQuickSortDirection);
|
||||
if (partial.dataGridQuickEntry !== undefined) editorSettings.value.dataGridQuickEntry = partial.dataGridQuickEntry;
|
||||
if (partial.dataGridRenderMode !== undefined) editorSettings.value.dataGridRenderMode = normalizeDataGridRenderMode(partial.dataGridRenderMode);
|
||||
if (partial.dataGridSearchMode !== undefined) editorSettings.value.dataGridSearchMode = normalizeDataGridSearchMode(partial.dataGridSearchMode);
|
||||
|
||||
Reference in new issue
Block a user