fix(objects): add sidebar locate actions to table and view context menus

Closes #10949
This commit is contained in:
t8y2 committed 2026-10-02 23:00:28 +00:00
1 parent 9338e69fb7
commit 1b5bf5066b
8 files changed
+452 -5

No files matched your search

@@ -1141,6 +1141,22 @@ function onHandleClickTable(target: SqlObjectNavigationTarget) {
emit("clickTable", props.activeTab.id, target);
}
function onLocateObjectTable(target: ContentAreaSurfaceEmits["openObjectTable"][1]) {
const isMongo = props.activeConnection?.db_type === "mongodb";
emit("locate-tab", {
id: props.activeTab.id,
title: target.tableName,
connectionId: props.activeTab.connectionId,
database: props.activeTab.database,
schema: target.schema,
catalog: target.catalog,
mode: isMongo ? "mongo" : "data",
sql: isMongo ? target.tableName : "",
isExecuting: false,
tableMeta: { ...target, columns: [], primaryKeys: [] },
});
}
function onHandleViewTableData(target: SqlObjectNavigationTarget) {
emit("viewTableData", props.activeTab.id, target);
}
@@ -3221,6 +3237,7 @@ defineExpose({
:initial-search-query="activeTab.objectBrowser?.searchQuery"
:viewport="activeTab.objectBrowser?.viewport"
@open-table="emit('openObjectTable', activeTab.id, $event)"
@locate-table="onLocateObjectTable"
@schema-change="emit('objectSchemaChange', activeTab.id, $event)"
@viewport-change="emit('objectBrowserViewportChange', activeTab.id, $event)"
@search-change="emit('objectBrowserSearchChange', activeTab.id, $event)"
@@ -43,7 +43,6 @@ const emit = defineEmits<
ContentAreaSurfaceEmits & {
"focus-group": [groupId: string];
"activate-tab": [tabId: string];
"locate-tab": [tab: QueryTab];
"toggle-zen-mode": [];
"start-resize": [event: PointerEvent];
"toggle-collapse": [];
@@ -34,7 +34,6 @@ const props = defineProps<
>();
const emit = defineEmits<
ContentAreaSurfaceEmits & {
"locate-tab": [tab: QueryTab];
"toggle-zen-mode": [];
"start-resize": [event: PointerEvent];
"toggle-collapse": [];
@@ -323,7 +322,6 @@ function handleFocusErrorOffset(tabId: string, offset: number): boolean {
v-bind="editorGroupBindings"
@focus-group="queryStore.focusGroup($event)"
@activate-tab="queryStore.activateTabInGroup(group.id, $event)"
@locate-tab="emit('locate-tab', $event)"
@toggle-zen-mode="emit('toggle-zen-mode')"
@start-resize="emit('start-resize', $event)"
@toggle-collapse="emit('toggle-collapse')"
@@ -356,7 +354,6 @@ function handleFocusErrorOffset(tabId: string, offset: number): boolean {
v-bind="editorGroupBindings"
@focus-group="queryStore.focusGroup($event)"
@activate-tab="queryStore.activateTabInGroup(group.id, $event)"
@locate-tab="emit('locate-tab', $event)"
@toggle-zen-mode="emit('toggle-zen-mode')"
@start-resize="emit('start-resize', $event)"
@toggle-collapse="emit('toggle-collapse')"
@@ -0,0 +1,161 @@
// @vitest-environment happy-dom
import { createApp, defineComponent, h, nextTick, type App, type PropType } from "vue";
import { createPinia, setActivePinia } from "pinia";
import { createI18n } from "vue-i18n";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import type { ConnectionConfig, QueryTab } from "@/types/database";
const mocks = vi.hoisted(() => ({
target: { tableName: "orders.with.dots", tableType: "VIEW", schema: "row_schema", catalog: "external_catalog" } as { tableName: string; tableType: string; schema?: string; catalog?: string },
}));
vi.mock("splitpanes", () => ({
Splitpanes: { template: "<div><slot /></div>" },
Pane: { template: "<div><slot /></div>" },
}));
vi.mock("@/components/editor/QueryEditor.vue", () => ({ default: { render: () => null } }));
vi.mock("@/components/grid/DataGrid.vue", () => ({ default: { render: () => null } }));
vi.mock("@/components/layout/EditorToolbar.vue", () => ({ default: { render: () => null } }));
vi.mock("@/components/layout/QueryResultSurface.vue", () => ({ default: { render: () => null } }));
vi.mock("@/components/layout/EditorGroupTabBar.vue", () => ({
default: defineComponent({
props: { tabs: { type: Array as PropType<QueryTab[]>, required: true } },
emits: ["locate-tab"],
setup(props, { emit }) {
return () => h("button", { "data-test": "locate-active-tab", onClick: () => emit("locate-tab", props.tabs[0]) }, "Locate tab");
},
}),
}));
vi.mock("@/components/objects/ObjectBrowser.vue", () => ({
__esModule: true,
default: defineComponent({
emits: ["locateTable", "openTable"],
setup(_, { emit }) {
return () => h("button", { "data-test": "locate-object-row", onClick: () => emit("locateTable", mocks.target) }, "Locate row");
},
}),
}));
import SqlEditorWorkspace from "@/components/layout/SqlEditorWorkspace.vue";
import { useConnectionStore } from "@/stores/connectionStore";
import { useQueryStore } from "@/stores/queryStore";
import { activeTabSidebarTarget } from "@/lib/sidebar/sidebarActiveTabTarget";
const mountedApps: Array<{ app: App; host: HTMLElement }> = [];
beforeEach(() => {
mocks.target = { tableName: "orders.with.dots", tableType: "VIEW", schema: "row_schema", catalog: "external_catalog" };
});
afterEach(() => {
for (const { app, host } of mountedApps.splice(0)) {
app.unmount();
host.remove();
}
window.localStorage?.clear();
});
async function mountWorkspace(options: { dbType?: "postgres" | "mongodb"; contentSuppressed?: boolean } = {}) {
const pinia = createPinia();
setActivePinia(pinia);
const connection = { id: "browser-connection", name: "Browser connection", db_type: options.dbType ?? "postgres" } as ConnectionConfig;
useConnectionStore().connections = [connection];
const queryStore = useQueryStore();
const tab: QueryTab = {
id: "objects-tab",
title: "Database objects",
connectionId: connection.id,
database: "browser_database",
mode: "objects",
schema: "stale_schema",
catalog: "stale_catalog",
sql: "",
isExecuting: false,
objectBrowser: { schema: "browser_schema", catalog: "external_catalog" },
};
queryStore.tabs = [tab];
queryStore.activeTabId = tab.id;
queryStore.groups = [{ id: "g1", tabIds: [tab.id], activeTabId: tab.id }];
queryStore.focusedGroupId = "g1";
queryStore.sizes = [100];
const host = document.createElement("div");
document.body.append(host);
const onLocateTab = vi.fn();
const onOpenObjectTable = vi.fn();
const app = createApp(SqlEditorWorkspace, {
activeTab: tab,
activeConnection: connection,
activeOutputView: "result",
executableSql: "",
formatSqlRequest: null,
compressSqlRequest: null,
selectedSql: "",
cursorPos: 0,
blockDangerousRedisCommands: false,
showTabNavigation: true,
contentSuppressed: options.contentSuppressed,
onLocateTab,
onOpenObjectTable,
});
app.use(pinia);
app.use(createI18n({ legacy: false, locale: "en", messages: { en: {} }, missingWarn: false, fallbackWarn: false }));
mountedApps.push({ app, host });
app.mount(host);
await vi.waitFor(() => expect(host.querySelector(options.contentSuppressed ? '[data-test="locate-active-tab"]' : '[data-test="locate-object-row"]')).not.toBeNull());
return { host, queryStore, tab, onLocateTab, onOpenObjectTable };
}
describe("Object browser locate event through ContentArea and the workspace", () => {
it.each(["TABLE", "VIEW", "MATERIALIZED_VIEW"])("forwards the full %s identity once without changing tabs", async (tableType) => {
mocks.target.tableType = tableType;
const { host, queryStore, tab, onLocateTab, onOpenObjectTable } = await mountWorkspace();
host.querySelector<HTMLButtonElement>('[data-test="locate-object-row"]')!.click();
await nextTick();
expect(onLocateTab).toHaveBeenCalledExactlyOnceWith({
id: tab.id,
title: "orders.with.dots",
connectionId: "browser-connection",
database: "browser_database",
schema: "row_schema",
catalog: "external_catalog",
mode: "data",
sql: "",
isExecuting: false,
tableMeta: { ...mocks.target, columns: [], primaryKeys: [] },
});
expect(activeTabSidebarTarget(onLocateTab.mock.calls[0]![0])).toEqual({ type: "table", connectionId: "browser-connection", database: "browser_database", schema: "row_schema", tableName: "orders.with.dots" });
expect(onOpenObjectTable).not.toHaveBeenCalled();
expect(queryStore.tabs).toEqual([tab]);
expect(queryStore.activeTabId).toBe(tab.id);
expect(tab.mode).toBe("objects");
expect(tab.schema).toBe("stale_schema");
});
it("does not inherit a stale schema or catalog when the row has neither", async () => {
mocks.target = { tableName: "orders", tableType: "TABLE" };
const { host, onLocateTab } = await mountWorkspace();
host.querySelector<HTMLButtonElement>('[data-test="locate-object-row"]')!.click();
expect(onLocateTab).toHaveBeenCalledOnce();
expect(onLocateTab.mock.calls[0]![0]).toMatchObject({ schema: undefined, catalog: undefined, tableMeta: { tableName: "orders", tableType: "TABLE" } });
});
it("uses the existing MongoDB collection target for collection and view rows", async () => {
const { host, onLocateTab, onOpenObjectTable } = await mountWorkspace({ dbType: "mongodb" });
host.querySelector<HTMLButtonElement>('[data-test="locate-object-row"]')!.click();
expect(onLocateTab).toHaveBeenCalledOnce();
expect(activeTabSidebarTarget(onLocateTab.mock.calls[0]![0])).toEqual({ type: "mongo-collection", connectionId: "browser-connection", database: "browser_database", collectionName: "orders.with.dots" });
expect(onOpenObjectTable).not.toHaveBeenCalled();
});
it.each([false, true])("preserves active-tab locate exactly once with suppressed content = %s", async (contentSuppressed) => {
const { host, queryStore, onLocateTab, onOpenObjectTable } = await mountWorkspace({ contentSuppressed });
host.querySelector<HTMLButtonElement>('[data-test="locate-active-tab"]')!.click();
expect(onLocateTab).toHaveBeenCalledExactlyOnceWith(queryStore.tabs[0]);
expect(onOpenObjectTable).not.toHaveBeenCalled();
});
});
@@ -76,6 +76,7 @@ export interface ContentAreaSurfaceProps {
*/
export interface ContentAreaSurfaceEmits {
closeTab: [tabId: string];
"locate-tab": [tab: QueryTab];
"update:activeOutputView": [tabId: string, value: TabOutputView];
fixWithAi: [tabId: string, errorMessage: string];
sendSelectionToAi: [tabId: string, sql: string];
@@ -175,6 +175,7 @@ import { invalidateObjectMetadataCache } from "@/lib/metadata/objectMetadataCach
import { invalidateObjectDdl } from "@/lib/metadata/objectDdlCache";
import { invalidateObjectBrowserRowsCache } from "@/lib/table/objectBrowserRowsCache";
import { eventEditorInstanceKey, resolveInitialEventEditorRequest } from "@/lib/table/eventEditorRequest";
import { createLocateTabMenuItem } from "@/lib/tabs/tabMenu";
type ObjectFilter = ObjectBrowserFilter;
type ObjectBrowserColumnKey = "select" | "name" | "type" | "estimatedRows" | "totalBytes" | "created_at" | "updated_at" | "comment";
@@ -197,6 +198,7 @@ const props = defineProps<{
const emit = defineEmits<{
openTable: [target: { tableName: string; schema?: string; tableType?: string; catalog?: string; comment?: string | null }];
locateTable: [target: { tableName: string; schema?: string; tableType?: string; catalog?: string }];
schemaChange: [schema: string | undefined];
viewportChange: [viewport: ObjectBrowserViewport];
searchChange: [query: string];
@@ -3640,7 +3642,7 @@ function getTypeMenuItems(item: ObjectBrowserRow): ContextMenuItem[] {
return items;
}
function getObjectBrowserMenuItems(item: ObjectBrowserRow): ContextMenuItem[] {
function getObjectBrowserActionMenuItems(item: ObjectBrowserRow): ContextMenuItem[] {
if (isMongodb.value) {
return [
{ label: t("contextMenu.viewData"), action: () => openViewData(item), icon: Table2 },
@@ -3655,6 +3657,21 @@ function getObjectBrowserMenuItems(item: ObjectBrowserRow): ContextMenuItem[] {
if (isSourceOnlyObjectBrowserRow(item)) return getPackageMenuItems(item);
return getProcFuncMenuItems(item);
}
function getObjectBrowserMenuItems(item: ObjectBrowserRow): ContextMenuItem[] {
const items = getObjectBrowserActionMenuItems(item);
if (item.type === "TABLE" || item.type === "VIEW" || item.type === "MATERIALIZED_VIEW") {
items.push(
{ label: "", separator: true },
createLocateTabMenuItem({
t,
visible: true,
onLocate: () => emit("locateTable", { tableName: item.name, schema: item.schema, tableType: objectBrowserOpenTableType(item), catalog: props.catalog }),
}),
);
}
return items;
}
</script>
<template>
@@ -0,0 +1,254 @@
// @vitest-environment happy-dom
import { createApp, defineComponent, h, nextTick, ref, type App } from "vue";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import ObjectBrowser from "@/components/objects/ObjectBrowser.vue";
import { invalidateObjectBrowserRowsCache } from "@/lib/table/objectBrowserRowsCache";
import type { ConnectionConfig, ObjectBrowserViewMode } from "@/types/database";
const mocks = vi.hoisted(() => ({
listObjects: vi.fn(),
listSchemas: vi.fn(),
mongoListCollections: vi.fn(),
ensureConnected: vi.fn(),
openTable: vi.fn(),
locateTable: vi.fn(),
viewMode: "list" as ObjectBrowserViewMode,
}));
vi.mock("@/lib/backend/api", () => ({
listObjects: (...args: unknown[]) => mocks.listObjects(...args),
listSchemas: (...args: unknown[]) => mocks.listSchemas(...args),
mongoListCollections: (...args: unknown[]) => mocks.mongoListCollections(...args),
listObjectStatistics: vi.fn().mockResolvedValue([]),
}));
vi.mock("@/stores/connectionStore", () => ({
useConnectionStore: () => ({
getConfig: () => connection,
ensureConnected: mocks.ensureConnected,
orderByPinnedTreeNodes: (rows: unknown[]) => rows,
}),
}));
vi.mock("@/stores/queryStore", () => ({ useQueryStore: () => ({}) }));
vi.mock("@/stores/settingsStore", () => ({
useSettingsStore: () => ({
editorSettings: {
shortcuts: { refreshData: "F5" },
objectBrowserViewMode: mocks.viewMode,
objectBrowserShowCheckbox: false,
sidebarActivation: "double",
},
}),
}));
vi.mock("vue-i18n", () => ({ useI18n: () => ({ t: (key: string) => (key === "sidebar.locateActiveTab" ? "Locate in sidebar" : key), locale: ref("en-US") }) }));
vi.mock("@/i18n", () => ({ default: { install: () => undefined } }));
vi.mock("@/composables/useSqlHighlighter", () => ({ useSqlHighlighter: () => ({ highlight: (sql: string) => sql }) }));
vi.mock("@/composables/useToast", () => ({ useToast: () => ({ toast: vi.fn() }) }));
vi.mock("vue-virtual-scroller", () => ({
RecycleScroller: defineComponent({
props: { items: { type: Array, default: () => [] } },
setup(props, { slots }) {
return () =>
h(
"div",
props.items.map((item) => slots.default?.({ item })),
);
},
}),
}));
vi.mock("@/components/ui/searchable-select", () => ({ SearchableSelect: { render: () => null } }));
vi.mock("@/components/ui/ToolbarOverflowMenu.vue", () => ({ default: { render: () => null } }));
vi.mock("@/components/editor/QueryEditor.vue", () => ({ default: { render: () => null } }));
vi.mock("@/components/editor/DangerConfirmDialog.vue", () => ({ default: { render: () => null } }));
vi.mock("@/components/objects/ProcedureExecutionDialog.vue", () => ({ default: { render: () => null } }));
vi.mock("@/components/objects/CustomTypeInfoPanel.vue", () => ({ default: { render: () => null } }));
vi.mock("@/components/export/XlsxHeaderDialog.vue", () => ({ default: { render: () => null } }));
const connection = {
id: "locate-connection",
name: "PostgreSQL",
db_type: "postgres",
database: "connection_default",
driver_profile: null,
url_params: null,
transport_layers: [],
} as unknown as ConnectionConfig;
const mountedApps: Array<{ app: App; host: HTMLElement }> = [];
const gridStyle = document.createElement("style");
gridStyle.textContent = ".object-browser-grid-wrapper { padding: 8px; }";
beforeEach(() => {
document.head.append(gridStyle);
vi.clearAllMocks();
mocks.viewMode = "list";
connection.db_type = "postgres";
mocks.listObjects.mockResolvedValue([
{ name: "orders", object_type: "TABLE", schema: "row_schema" },
{ name: "customers", object_type: "TABLE", schema: "row_schema" },
{ name: "recent_orders", object_type: "VIEW", schema: "row_schema" },
{ name: "order_totals", object_type: "MATERIALIZED_VIEW", schema: "row_schema" },
{ name: "refresh_orders", object_type: "PROCEDURE", schema: "row_schema" },
]);
mocks.listSchemas.mockResolvedValue(["browser_schema", "row_schema"]);
mocks.mongoListCollections.mockResolvedValue([
{ name: "orders", kind: "collection" },
{ name: "recent_orders", kind: "view" },
]);
mocks.ensureConnected.mockResolvedValue(undefined);
invalidateObjectBrowserRowsCache({});
});
afterEach(() => {
for (const { app, host } of mountedApps.splice(0)) {
app.unmount();
host.remove();
}
invalidateObjectBrowserRowsCache({});
gridStyle.remove();
});
async function mountBrowser(options: { schema?: string; catalog?: string } = { schema: "browser_schema", catalog: "external_catalog" }) {
const host = document.createElement("div");
document.body.append(host);
const app = createApp({
setup: () => () => h(ObjectBrowser, { connection, database: "browser_database", selectedObjectFilter: "all", ...options, onOpenTable: mocks.openTable, onLocateTable: mocks.locateTable }),
});
mountedApps.push({ app, host });
app.mount(host);
await vi.waitFor(() => expect(host.querySelector('[title="orders"]')).not.toBeNull());
return host;
}
function rowFor(host: HTMLElement, name: string): HTMLElement {
const row = host.querySelector(`[title="${name}"]`)?.closest<HTMLElement>(".cursor-default");
expect(row, name).toBeTruthy();
return row!;
}
async function openMenu(host: HTMLElement, name: string) {
rowFor(host, name).dispatchEvent(new MouseEvent("contextmenu", { bubbles: true, cancelable: true }));
await nextTick();
}
function menuButton(label: string): HTMLButtonElement {
const buttons = [...document.querySelectorAll<HTMLButtonElement>("[data-dbx-context-menu] button")].filter((button) => button.textContent?.trim() === label);
expect(buttons, label).toHaveLength(1);
expect(buttons[0]!.disabled).toBe(false);
return buttons[0]!;
}
describe.each(["list", "grid"] as const)("ObjectBrowser locate in sidebar (%s)", (viewMode) => {
beforeEach(() => {
mocks.viewMode = viewMode;
});
it.each([
["orders", "TABLE"],
["recent_orders", "VIEW"],
["order_totals", "MATERIALIZED_VIEW"],
])("locates %s with the exact row identity without opening a tab", async (tableName, tableType) => {
const host = await mountBrowser();
expect(host.querySelector(viewMode === "grid" ? ".object-browser-grid-scroller" : ".object-browser-scroller")).not.toBeNull();
await openMenu(host, tableName);
expect(mocks.locateTable).not.toHaveBeenCalled();
mocks.ensureConnected.mockClear();
menuButton("Locate in sidebar").click();
await nextTick();
expect(mocks.locateTable).toHaveBeenCalledExactlyOnceWith({ tableName, tableType, schema: "row_schema", catalog: "external_catalog" });
expect(mocks.openTable).not.toHaveBeenCalled();
expect(mocks.ensureConnected).not.toHaveBeenCalled();
expect(document.querySelector("[data-dbx-context-menu]")).toBeNull();
});
it("keeps the default schema and catalog unspecified", async () => {
connection.db_type = "mysql";
mocks.listObjects.mockResolvedValue([{ name: "orders", object_type: "TABLE" }]);
const host = await mountBrowser({});
await openMenu(host, "orders");
menuButton("Locate in sidebar").click();
expect(mocks.locateTable).toHaveBeenCalledExactlyOnceWith({ tableName: "orders", tableType: "TABLE", schema: undefined, catalog: undefined });
expect(mocks.openTable).not.toHaveBeenCalled();
});
it("uses the browser schema when the object metadata omits it", async () => {
mocks.listObjects.mockResolvedValue([{ name: "orders", object_type: "TABLE" }]);
const host = await mountBrowser();
await openMenu(host, "orders");
menuButton("Locate in sidebar").click();
expect(mocks.locateTable).toHaveBeenCalledExactlyOnceWith({ tableName: "orders", tableType: "TABLE", schema: "browser_schema", catalog: "external_catalog" });
});
it.each([
["nebula", "orders"],
["nebula", "recent_orders"],
["victoriametrics", "orders"],
] as const)("also exposes locate in the specialized %s menu for %s", async (dbType, name) => {
connection.db_type = dbType;
const host = await mountBrowser();
await openMenu(host, name);
menuButton("contextMenu.viewData");
menuButton("Locate in sidebar").click();
expect(mocks.locateTable).toHaveBeenCalledOnce();
expect(mocks.locateTable.mock.calls[0]![0].tableName).toBe(name);
expect(mocks.openTable).not.toHaveBeenCalled();
});
it.each([
["orders", "TABLE"],
["recent_orders", "VIEW"],
])("preserves the MongoDB row type when locating %s", async (tableName, tableType) => {
connection.db_type = "mongodb";
const host = await mountBrowser({});
await openMenu(host, tableName);
menuButton("Locate in sidebar").click();
expect(mocks.locateTable).toHaveBeenCalledExactlyOnceWith({ tableName, tableType, schema: undefined, catalog: undefined });
expect(mocks.openTable).not.toHaveBeenCalled();
});
it("locates only the context row while preserving the batch selection", async () => {
const host = await mountBrowser();
for (const name of ["orders", "customers"]) rowFor(host, name).dispatchEvent(new MouseEvent("click", { bubbles: true, ctrlKey: true }));
await nextTick();
await openMenu(host, "orders");
menuButton("Locate in sidebar").click();
await nextTick();
expect(mocks.locateTable).toHaveBeenCalledExactlyOnceWith({ tableName: "orders", tableType: "TABLE", schema: "row_schema", catalog: "external_catalog" });
for (const name of ["orders", "customers"]) expect(rowFor(host, name).classList.contains("bg-accent")).toBe(true);
await openMenu(host, "orders");
menuButton("common.more").dispatchEvent(new MouseEvent("mouseenter"));
await nextTick();
menuButton("contextMenu.batchDrop");
menuButton("contextMenu.batchEmpty");
expect(mocks.openTable).not.toHaveBeenCalled();
});
it.each([
["orders", "TABLE"],
["recent_orders", "VIEW"],
])("preserves the view-data menu and double-click action for %s", async (tableName, tableType) => {
const host = await mountBrowser();
await openMenu(host, tableName);
menuButton("contextMenu.viewData").click();
await nextTick();
rowFor(host, tableName).dispatchEvent(new MouseEvent("click", { bubbles: true, detail: 2 }));
expect(mocks.openTable).toHaveBeenCalledTimes(2);
for (const [target] of mocks.openTable.mock.calls) expect(target).toEqual({ tableName, tableType, schema: "row_schema", catalog: "external_catalog", comment: undefined });
expect(mocks.locateTable).not.toHaveBeenCalled();
});
it("keeps non-table object menus unchanged", async () => {
const host = await mountBrowser();
await openMenu(host, "refresh_orders");
expect(document.querySelector("[data-dbx-context-menu]")?.textContent).not.toContain("Locate in sidebar");
menuButton("contextMenu.viewSource");
menuButton("contextMenu.executeProcedure");
});
});