fix(grid): use table-open page size for documents

Closes #6903
This commit is contained in:
t8y2 committed 2026-08-21 17:32:32 +00:00
1 parent f57cd3960b
commit 3bec5091df
5 files changed
+85 -13

No files matched your search

@@ -134,7 +134,7 @@ const documentLoadExecutionId = ref("");
const documentLoadCancelling = ref(false); const documentLoadCancelling = ref(false);
const documentLoadingElapsedSeconds = ref("0.0"); const documentLoadingElapsedSeconds = ref("0.0");
const page = ref(0); const page = ref(0);
const pageSize = ref(normalizeResultPageSize(settingsStore.editorSettings.pageSize)); const pageSize = ref(normalizeResultPageSize(settingsStore.editorSettings.tableOpenPageSize));
const selectedIdx = ref<number | null>(null); const selectedIdx = ref<number | null>(null);
const editJson = ref(""); const editJson = ref("");
const isEditing = ref(false); const isEditing = ref(false);
@@ -2300,6 +2300,7 @@ defineExpose({ focusSearch });
:table-meta="props.tableMeta" :table-meta="props.tableMeta"
:column-layout-scope-key="documentColumnLayoutScopeKey" :column-layout-scope-key="documentColumnLayoutScopeKey"
context="results" context="results"
page-size-preference="table-open"
:database-type="props.databaseType" :database-type="props.databaseType"
:mongo-update-target="mongoUpdateTarget" :mongo-update-target="mongoUpdateTarget"
:editable="documentStoreEditable" :editable="documentStoreEditable"
@@ -25,6 +25,7 @@ const dataGrid = vi.hoisted(() => ({
appendedFromRowCount: undefined as number | undefined, appendedFromRowCount: undefined as number | undefined,
pageOffset: undefined as number | undefined, pageOffset: undefined as number | undefined,
pageLimit: undefined as number | undefined, pageLimit: undefined as number | undefined,
pageSizePreference: undefined as string | undefined,
selectionActive: false, selectionActive: false,
editActive: false, editActive: false,
fullReplaceCount: 0, fullReplaceCount: 0,
@@ -33,6 +34,7 @@ const dataGrid = vi.hoisted(() => ({
const settings = vi.hoisted(() => ({ const settings = vi.hoisted(() => ({
editorSettings: { editorSettings: {
pageSize: 2, pageSize: 2,
tableOpenPageSize: 5,
infiniteScroll: true, infiniteScroll: true,
mongoViewMode: "table" as "document" | "table", mongoViewMode: "table" as "document" | "table",
columnWidthDensity: "standard" as "compact" | "standard" | "comfortable", columnWidthDensity: "standard" as "compact" | "standard" | "comfortable",
@@ -87,6 +89,7 @@ vi.mock("@/components/grid/DataGrid.vue", async () => {
customSaveHandler: { type: Object, required: false }, customSaveHandler: { type: Object, required: false },
pageOffset: { type: Number, required: false }, pageOffset: { type: Number, required: false },
pageLimit: { type: Number, required: false }, pageLimit: { type: Number, required: false },
pageSizePreference: { type: String, required: false },
}, },
setup(props, { attrs, expose }) { setup(props, { attrs, expose }) {
dataGrid.paginate = attrs.onPaginate as typeof dataGrid.paginate; dataGrid.paginate = attrs.onPaginate as typeof dataGrid.paginate;
@@ -127,6 +130,7 @@ vi.mock("@/components/grid/DataGrid.vue", async () => {
dataGrid.appendedFromRowCount = result.appended_from_row_count; dataGrid.appendedFromRowCount = result.appended_from_row_count;
dataGrid.pageOffset = props.pageOffset; dataGrid.pageOffset = props.pageOffset;
dataGrid.pageLimit = props.pageLimit; dataGrid.pageLimit = props.pageLimit;
dataGrid.pageSizePreference = props.pageSizePreference;
return h("div", { "data-testid": "data-grid" }); return h("div", { "data-testid": "data-grid" });
}; };
}, },
@@ -182,12 +186,12 @@ async function flushUi() {
} }
} }
async function mountBrowser() { async function mountBrowser(databaseType: "mongodb" | "elasticsearch" = "mongodb") {
app = createApp(DocumentBrowser, { app = createApp(DocumentBrowser, {
connectionId: "mongo-1", connectionId: "mongo-1",
database: "test", database: "test",
collection: "docs", collection: "docs",
databaseType: "mongodb", databaseType,
}); });
app.mount(root!); app.mount(root!);
await flushUi(); await flushUi();
@@ -230,10 +234,12 @@ beforeEach(async () => {
dataGrid.appendedFromRowCount = undefined; dataGrid.appendedFromRowCount = undefined;
dataGrid.pageOffset = undefined; dataGrid.pageOffset = undefined;
dataGrid.pageLimit = undefined; dataGrid.pageLimit = undefined;
dataGrid.pageSizePreference = undefined;
dataGrid.selectionActive = false; dataGrid.selectionActive = false;
dataGrid.editActive = false; dataGrid.editActive = false;
dataGrid.fullReplaceCount = 0; dataGrid.fullReplaceCount = 0;
settings.editorSettings.pageSize = 2; settings.editorSettings.pageSize = 2;
settings.editorSettings.tableOpenPageSize = 5;
settings.editorSettings.infiniteScroll = true; settings.editorSettings.infiniteScroll = true;
root = document.createElement("div"); root = document.createElement("div");
@@ -249,6 +255,16 @@ afterEach(() => {
}); });
describe("DocumentBrowser infinite scroll (issue #6455)", () => { describe("DocumentBrowser infinite scroll (issue #6455)", () => {
it.each(["mongodb", "elasticsearch"] as const)("uses the table-open page-size preference for %s", async (databaseType) => {
backend.documentFindDocuments.mockResolvedValueOnce(documentResult(1, 5, 5));
await mountBrowser(databaseType);
expect(backend.documentFindDocuments.mock.calls[0]!.slice(0, 5)).toEqual(["mongo-1", "test", "docs", 0, 5]);
expect(dataGrid.pageLimit).toBe(5);
expect(dataGrid.pageSizePreference).toBe("table-open");
});
it("preserves existing row identity and DataGrid selection/edit state for same-column appends", async () => { it("preserves existing row identity and DataGrid selection/edit state for same-column appends", async () => {
backend.documentFindDocuments.mockResolvedValueOnce(documentResult(1, 2, 4)).mockResolvedValueOnce(documentResult(3, 2, 4)); backend.documentFindDocuments.mockResolvedValueOnce(documentResult(1, 2, 4)).mockResolvedValueOnce(documentResult(3, 2, 4));
@@ -310,11 +326,11 @@ describe("DocumentBrowser infinite scroll (issue #6455)", () => {
await dataGrid.reload!(); await dataGrid.reload!();
await flushUi(); await flushUi();
expect(backend.documentFindDocuments.mock.calls[3]!.slice(0, 5)).toEqual(["mongo-1", "test", "docs", 0, 2]); expect(backend.documentFindDocuments.mock.calls[3]!.slice(0, 5)).toEqual(["mongo-1", "test", "docs", 0, 5]);
expect(dataGrid.rows).toHaveLength(2); expect(dataGrid.rows).toHaveLength(2);
expect(dataGrid.appendedFromRowCount).toBeUndefined(); expect(dataGrid.appendedFromRowCount).toBeUndefined();
expect(dataGrid.pageOffset).toBe(0); expect(dataGrid.pageOffset).toBe(0);
expect(dataGrid.pageLimit).toBe(2); expect(dataGrid.pageLimit).toBe(5);
expect(dataGrid.resetInfiniteScrollState).toHaveBeenCalledTimes(1); expect(dataGrid.resetInfiniteScrollState).toHaveBeenCalledTimes(1);
}); });
@@ -341,16 +357,16 @@ describe("DocumentBrowser infinite scroll (issue #6455)", () => {
await flushUi(); await flushUi();
expect(backend.documentUpdateDocument).toHaveBeenCalledTimes(1); expect(backend.documentUpdateDocument).toHaveBeenCalledTimes(1);
expect(backend.documentFindDocuments.mock.calls[3]!.slice(0, 5)).toEqual(["mongo-1", "test", "docs", 0, 2]); expect(backend.documentFindDocuments.mock.calls[3]!.slice(0, 5)).toEqual(["mongo-1", "test", "docs", 0, 5]);
expect(dataGrid.rows).toHaveLength(2); expect(dataGrid.rows).toHaveLength(2);
expect(dataGrid.appendedFromRowCount).toBeUndefined(); expect(dataGrid.appendedFromRowCount).toBeUndefined();
expect(dataGrid.pageOffset).toBe(0); expect(dataGrid.pageOffset).toBe(0);
expect(dataGrid.pageLimit).toBe(2); expect(dataGrid.pageLimit).toBe(5);
expect(dataGrid.resetInfiniteScrollState).toHaveBeenCalledTimes(1); expect(dataGrid.resetInfiniteScrollState).toHaveBeenCalledTimes(1);
}); });
it("keeps the configured page size when the final capped segment has a smaller limit", async () => { it("keeps the configured page size when the final capped segment has a smaller limit", async () => {
settings.editorSettings.pageSize = 3; settings.editorSettings.tableOpenPageSize = 3;
backend.documentFindDocuments backend.documentFindDocuments
.mockResolvedValueOnce(documentResult(1, 3, 11)) .mockResolvedValueOnce(documentResult(1, 3, 11))
.mockResolvedValueOnce(documentResult(4, 3, 11)) .mockResolvedValueOnce(documentResult(4, 3, 11))
@@ -84,7 +84,6 @@ import { dataGridCellDisplayText, dataGridCellEditorText } from "@/lib/dataGrid/
import { createColumnDrafts } from "@/lib/table/tableStructureEditorState"; import { createColumnDrafts } from "@/lib/table/tableStructureEditorState";
import type { BuildSingleColumnAlterSqlOptions } from "@/lib/table/tableStructureEditorSql"; import type { BuildSingleColumnAlterSqlOptions } from "@/lib/table/tableStructureEditorSql";
import { buildTableSelectSql, quoteTableDataIdentifier } from "@/lib/table/tableSelectSql"; import { buildTableSelectSql, quoteTableDataIdentifier } from "@/lib/table/tableSelectSql";
import { tableOpenPageLimit } from "@/lib/table/tableOpenPageLimit";
import { uuid } from "@/lib/common/utils"; import { uuid } from "@/lib/common/utils";
import { generateCellValues, type CellValueGenerationKind } from "@/lib/dataGrid/cellValueGeneration"; import { generateCellValues, type CellValueGenerationKind } from "@/lib/dataGrid/cellValueGeneration";
import { compactHeaderColumnType, isNumericColumnType, resolveDataGridTypeVisualKind, resolveHeaderColumnType, resolveResultColumnType } from "@/lib/dataGrid/dataGridColumnType"; import { compactHeaderColumnType, isNumericColumnType, resolveDataGridTypeVisualKind, resolveHeaderColumnType, resolveResultColumnType } from "@/lib/dataGrid/dataGridColumnType";
@@ -219,6 +218,7 @@ import {
replaceColumnValueFilterCondition, replaceColumnValueFilterCondition,
} from "@/lib/dataGrid/dataGridColumnFilter"; } from "@/lib/dataGrid/dataGridColumnFilter";
import { normalizeResultPageSize, resultPageSizeMenuOptions } from "@/lib/dataGrid/paginationPageSize"; import { normalizeResultPageSize, resultPageSizeMenuOptions } from "@/lib/dataGrid/paginationPageSize";
import { dataGridPageSizeSettingsPatch, preferredDataGridPageSize, resolveDataGridPageSizePreference, type DataGridPageSizePreference } from "@/lib/dataGrid/dataGridPageSizePreference";
import { continuousQueryResultMaxRows, effectiveQueryResultMaxRows } from "@/lib/dataGrid/queryResultRowLimit"; import { continuousQueryResultMaxRows, effectiveQueryResultMaxRows } from "@/lib/dataGrid/queryResultRowLimit";
import { allNullColumnIndexes } from "@/lib/dataGrid/dataGridColumnVisibility"; import { allNullColumnIndexes } from "@/lib/dataGrid/dataGridColumnVisibility";
import { buildDataGridColumnLookupItems, dataGridColumnCommentFor, filterDataGridColumnLookupItems } from "@/lib/dataGrid/dataGridColumnLookup"; import { buildDataGridColumnLookupItems, dataGridColumnCommentFor, filterDataGridColumnLookupItems } from "@/lib/dataGrid/dataGridColumnLookup";
@@ -385,6 +385,7 @@ interface DataGridProps {
schema?: string; schema?: string;
columnLayoutScopeKey?: string; columnLayoutScopeKey?: string;
context?: "results" | "table-data"; context?: "results" | "table-data";
pageSizePreference?: DataGridPageSizePreference;
autoTransposeSingleRow?: boolean; autoTransposeSingleRow?: boolean;
sourceColumns?: Array<string | undefined>; sourceColumns?: Array<string | undefined>;
readonlyColumnIndexes?: number[]; readonlyColumnIndexes?: number[];
@@ -3076,7 +3077,8 @@ watch(
); );
// --- Pagination --- // --- Pagination ---
const pageSize = ref(normalizeResultPageSize(props.context === "table-data" ? (props.pageLimit ?? tableOpenPageLimit(settingsStore.editorSettings.tableOpenPageSize)) : settingsStore.editorSettings.pageSize)); const pageSizePreference = computed(() => resolveDataGridPageSizePreference(props.context, props.pageSizePreference));
const pageSize = ref(preferredDataGridPageSize(settingsStore.editorSettings, pageSizePreference.value, props.pageLimit));
const currentPage = ref(1); const currentPage = ref(1);
const pageSizeOptions = computed(() => resultPageSizeMenuOptions(pageSize.value)); const pageSizeOptions = computed(() => resultPageSizeMenuOptions(pageSize.value));
const customPageSizeInput = ref(String(pageSize.value)); const customPageSizeInput = ref(String(pageSize.value));
@@ -3097,8 +3099,8 @@ watch(pageSize, (value) => {
watch( watch(
() => settingsStore.editorSettings.pageSize, () => settingsStore.editorSettings.pageSize,
(value) => { (value) => {
// Table-data segments keep their own pagination state instead of following SQL result settings. // Table-open grids keep their own pagination state instead of following SQL result settings.
if (props.context === "table-data") return; if (pageSizePreference.value !== "results") return;
pageSize.value = normalizeResultPageSize(value, pageSize.value); pageSize.value = normalizeResultPageSize(value, pageSize.value);
}, },
); );
@@ -3440,7 +3442,7 @@ function checkInfiniteScroll(scroller: HTMLElement) {
function changePageSize(size: number) { function changePageSize(size: number) {
const normalizedSize = normalizeResultPageSize(size); const normalizedSize = normalizeResultPageSize(size);
pageSize.value = normalizedSize; pageSize.value = normalizedSize;
settingsStore.updateEditorSettings(props.context === "table-data" ? { tableOpenPageSize: normalizedSize } : { pageSize: normalizedSize }); settingsStore.updateEditorSettings(dataGridPageSizeSettingsPatch(pageSizePreference.value, normalizedSize));
currentPage.value = 1; currentPage.value = 1;
lastInfiniteScrollPage = 0; lastInfiniteScrollPage = 0;
infiniteScrollAllLoaded = false; infiniteScrollAllLoaded = false;
@@ -0,0 +1,30 @@
import { describe, expect, it } from "vitest";
import { dataGridPageSizeSettingsPatch, preferredDataGridPageSize, resolveDataGridPageSizePreference } from "@/lib/dataGrid/dataGridPageSizePreference";
describe("DataGrid page-size preference", () => {
it("keeps the context-derived defaults for regular result and table-data grids", () => {
expect(resolveDataGridPageSizePreference("results")).toBe("results");
expect(resolveDataGridPageSizePreference(undefined)).toBe("results");
expect(resolveDataGridPageSizePreference("table-data")).toBe("table-open");
});
it("allows a result-context grid to explicitly use the table-open preference", () => {
expect(resolveDataGridPageSizePreference("results", "table-open")).toBe("table-open");
});
it("reads the selected preference and preserves an explicit table-data page limit", () => {
const settings = { pageSize: 25, tableOpenPageSize: 500 };
expect(preferredDataGridPageSize(settings, "results")).toBe(25);
expect(preferredDataGridPageSize(settings, "table-open")).toBe(500);
expect(preferredDataGridPageSize(settings, "table-open", 75)).toBe(75);
expect(preferredDataGridPageSize({ pageSize: 0, tableOpenPageSize: Number.NaN }, "results")).toBe(100);
expect(preferredDataGridPageSize({ pageSize: 0, tableOpenPageSize: Number.NaN }, "table-open")).toBe(100);
});
it("writes only the selected normalized setting", () => {
expect(dataGridPageSizeSettingsPatch("results", 250.9)).toEqual({ pageSize: 250 });
expect(dataGridPageSizeSettingsPatch("table-open", 750.9)).toEqual({ tableOpenPageSize: 750 });
expect(dataGridPageSizeSettingsPatch("table-open", 0)).toEqual({ tableOpenPageSize: 100 });
});
});
@@ -0,0 +1,23 @@
import { normalizeResultPageSize } from "@/lib/dataGrid/paginationPageSize";
import { tableOpenPageLimit } from "@/lib/table/tableOpenPageLimit";
export type DataGridPageSizePreference = "results" | "table-open";
type DataGridContext = "results" | "table-data" | undefined;
type DataGridPageSizeSettings = {
pageSize: unknown;
tableOpenPageSize: unknown;
};
export function resolveDataGridPageSizePreference(context: DataGridContext, preference?: DataGridPageSizePreference): DataGridPageSizePreference {
return preference ?? (context === "table-data" ? "table-open" : "results");
}
export function preferredDataGridPageSize(settings: DataGridPageSizeSettings, preference: DataGridPageSizePreference, pageLimit?: number): number {
return preference === "table-open" ? normalizeResultPageSize(pageLimit ?? tableOpenPageLimit(settings.tableOpenPageSize)) : normalizeResultPageSize(settings.pageSize);
}
export function dataGridPageSizeSettingsPatch(preference: DataGridPageSizePreference, value: unknown): { pageSize: number } | { tableOpenPageSize: number } {
const normalized = normalizeResultPageSize(value);
return preference === "table-open" ? { tableOpenPageSize: normalized } : { pageSize: normalized };
}