feat(grid): persist column layouts and improve drag-to-reorder
This commit is contained in:
1 parent
f5c29f08f1
commit
44f748d3a1
24 files changed
+1532
-276
No files matched your search
+65
-1
@@ -1,5 +1,17 @@
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { loadTableDataGridColumnOrder, notifyTableDataGridColumnOrderChanged, removeTableDataGridColumnOrder, saveTableDataGridColumnOrder, TABLE_DATA_GRID_COLUMN_ORDER_CHANGED_EVENT, tableDataGridColumnOrderScopeKey } from "@/lib/dataGrid/dataGridColumnLayoutStorage";
|
||||
import {
|
||||
documentDataGridColumnLayoutScopeKey,
|
||||
loadDataGridColumnLayout,
|
||||
loadDataGridColumnOrder,
|
||||
loadTableDataGridColumnOrder,
|
||||
notifyTableDataGridColumnOrderChanged,
|
||||
removeDataGridColumnOrder,
|
||||
removeTableDataGridColumnOrder,
|
||||
saveDataGridColumnLayout,
|
||||
saveTableDataGridColumnOrder,
|
||||
TABLE_DATA_GRID_COLUMN_ORDER_CHANGED_EVENT,
|
||||
tableDataGridColumnOrderScopeKey,
|
||||
} from "@/lib/dataGrid/dataGridColumnLayoutStorage";
|
||||
|
||||
function installLocalStorage() {
|
||||
const data = new Map<string, string>();
|
||||
@@ -57,3 +69,55 @@ describe("table data grid column order storage", () => {
|
||||
expect(event.detail).toEqual({ scopeKey: "table-scope" });
|
||||
});
|
||||
});
|
||||
|
||||
describe("data grid column layout storage", () => {
|
||||
beforeEach(installLocalStorage);
|
||||
afterEach(() => vi.unstubAllGlobals());
|
||||
|
||||
it("uses a stable document scope without query or result column signatures", () => {
|
||||
expect(
|
||||
documentDataGridColumnLayoutScopeKey({
|
||||
databaseType: "elasticsearch",
|
||||
connectionId: "connection-1",
|
||||
database: "database-name",
|
||||
collection: "order_index_v1",
|
||||
}),
|
||||
).toBe(["document", "elasticsearch", "connection-1", "database-name", "order_index_v1"].join("\u0001"));
|
||||
});
|
||||
|
||||
it("stores order and hidden keys without dropping fields absent from the current page", () => {
|
||||
const layout = {
|
||||
orderKeys: ["_id", "status", "orderNo", "goodsList"],
|
||||
hiddenKeys: ["goodsList"],
|
||||
};
|
||||
|
||||
saveDataGridColumnLayout("document-layout", layout);
|
||||
|
||||
expect(loadDataGridColumnLayout("document-layout", ["_id", "orderNo", "status", "createTime"])).toEqual(layout);
|
||||
});
|
||||
|
||||
it("keeps hidden keys when only the saved order is reset", () => {
|
||||
saveDataGridColumnLayout("combined-layout", { orderKeys: ["status", "_id"], hiddenKeys: ["goodsList"] });
|
||||
|
||||
removeDataGridColumnOrder("combined-layout");
|
||||
|
||||
expect(loadDataGridColumnOrder("combined-layout", [])).toEqual([]);
|
||||
expect(loadDataGridColumnLayout("combined-layout")).toEqual({ orderKeys: [], hiddenKeys: ["goodsList"] });
|
||||
});
|
||||
|
||||
it("loads the previous order-only payload format", () => {
|
||||
localStorage.setItem(
|
||||
"dbx-data-grid-column-layout:legacy-layout",
|
||||
JSON.stringify({
|
||||
version: 1,
|
||||
columnSignature: "id\0name",
|
||||
order: ["name", "id"],
|
||||
}),
|
||||
);
|
||||
|
||||
expect(loadDataGridColumnLayout("legacy-layout", ["id", "name"])).toEqual({
|
||||
orderKeys: ["name", "id"],
|
||||
hiddenKeys: [],
|
||||
});
|
||||
});
|
||||
});
|
||||
+83
@@ -0,0 +1,83 @@
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { loadDataGridColumnLayout } from "@/lib/dataGrid/dataGridColumnLayoutStorage";
|
||||
import { documentGridColumnVisibilityScopeKey, loadDocumentGridHiddenColumnKeys, migrateDocumentGridColumnVisibilityToLayout, saveDocumentGridHiddenColumnKeys } from "@/lib/document/documentGridColumnVisibilityStorage";
|
||||
|
||||
const STORAGE_PREFIX = "dbx-document-grid-column-visibility:v1:";
|
||||
let storedValues: Map<string, string>;
|
||||
|
||||
function installLocalStorage() {
|
||||
storedValues = new Map<string, string>();
|
||||
vi.stubGlobal("localStorage", {
|
||||
getItem: (key: string) => storedValues.get(key) ?? null,
|
||||
setItem: (key: string, value: string) => storedValues.set(key, value),
|
||||
removeItem: (key: string) => storedValues.delete(key),
|
||||
});
|
||||
}
|
||||
|
||||
function scopeKey(collection: string) {
|
||||
return documentGridColumnVisibilityScopeKey({
|
||||
databaseType: "elasticsearch",
|
||||
connectionId: "connection-1",
|
||||
database: "",
|
||||
collection,
|
||||
});
|
||||
}
|
||||
|
||||
describe("document grid column visibility storage", () => {
|
||||
beforeEach(installLocalStorage);
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
vi.unstubAllGlobals();
|
||||
});
|
||||
|
||||
it("stores normalized hidden field names", () => {
|
||||
const ordersScope = scopeKey("orders");
|
||||
|
||||
saveDocumentGridHiddenColumnKeys(ordersScope, ["goodsList", "logisticsInfo", "goodsList"]);
|
||||
|
||||
expect(loadDocumentGridHiddenColumnKeys(ordersScope)).toEqual(["goodsList", "logisticsInfo"]);
|
||||
});
|
||||
|
||||
it("isolates indexes and removes the persisted selection when all fields are shown", () => {
|
||||
const ordersScope = scopeKey("orders");
|
||||
const productsScope = scopeKey("products");
|
||||
saveDocumentGridHiddenColumnKeys(ordersScope, ["goodsList"]);
|
||||
|
||||
expect(loadDocumentGridHiddenColumnKeys(productsScope)).toEqual([]);
|
||||
|
||||
saveDocumentGridHiddenColumnKeys(ordersScope, []);
|
||||
|
||||
expect(storedValues.has(`${STORAGE_PREFIX}${ordersScope}`)).toBe(false);
|
||||
expect(loadDocumentGridHiddenColumnKeys(ordersScope)).toEqual([]);
|
||||
});
|
||||
|
||||
it("ignores invalid persisted values without hiding unrelated fields", () => {
|
||||
const ordersScope = scopeKey("orders");
|
||||
storedValues.set(`${STORAGE_PREFIX}${ordersScope}`, JSON.stringify(["goodsList", 42, "goodsList", null]));
|
||||
|
||||
expect(loadDocumentGridHiddenColumnKeys(ordersScope)).toEqual(["goodsList"]);
|
||||
});
|
||||
|
||||
it("reports malformed persisted JSON and falls back to all fields visible", () => {
|
||||
const warn = vi.spyOn(console, "warn").mockImplementation(() => undefined);
|
||||
const ordersScope = scopeKey("orders");
|
||||
storedValues.set(`${STORAGE_PREFIX}${ordersScope}`, "{");
|
||||
|
||||
expect(loadDocumentGridHiddenColumnKeys(ordersScope)).toEqual([]);
|
||||
expect(warn).toHaveBeenCalledWith(expect.stringContaining("[DBX][document-grid-column-visibility:parse]"), expect.any(SyntaxError));
|
||||
});
|
||||
|
||||
it("migrates legacy hidden fields into the unified layout once", () => {
|
||||
const ordersScope = scopeKey("orders");
|
||||
saveDocumentGridHiddenColumnKeys(ordersScope, ["goodsList"]);
|
||||
|
||||
migrateDocumentGridColumnVisibilityToLayout(ordersScope, "document-layout");
|
||||
migrateDocumentGridColumnVisibilityToLayout(ordersScope, "document-layout");
|
||||
|
||||
expect(loadDataGridColumnLayout("document-layout")).toEqual({
|
||||
orderKeys: [],
|
||||
hiddenKeys: ["goodsList"],
|
||||
});
|
||||
expect(storedValues.has(`${STORAGE_PREFIX}${ordersScope}`)).toBe(false);
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user