From 1b5bf5066b39652120f26c83c96f8b81f64e8ddf Mon Sep 17 00:00:00 2001 From: t8y2 <1156263951@qq.com> Date: Fri, 2 Oct 2026 22:32:30 +0000 Subject: [PATCH] fix(objects): add sidebar locate actions to table and view context menus Closes #10949 --- .../src/components/layout/ContentArea.vue | 17 ++ .../src/components/layout/EditorGroup.vue | 1 - .../components/layout/SqlEditorWorkspace.vue | 3 - ...ontentArea.locateSidebar.component.spec.ts | 161 +++++++++++ .../src/components/layout/querySurfaces.ts | 1 + .../src/components/objects/ObjectBrowser.vue | 19 +- ...ectBrowser.locateSidebar.component.spec.ts | 254 ++++++++++++++++++ .../src/lib/tabs/contentSurfaceEvents.ts | 1 + 8 files changed, 452 insertions(+), 5 deletions(-) create mode 100644 apps/desktop/src/components/layout/__tests__/ContentArea.locateSidebar.component.spec.ts create mode 100644 apps/desktop/src/components/objects/__tests__/ObjectBrowser.locateSidebar.component.spec.ts diff --git a/apps/desktop/src/components/layout/ContentArea.vue b/apps/desktop/src/components/layout/ContentArea.vue index 07f8bc986e..437f396b54 100644 --- a/apps/desktop/src/components/layout/ContentArea.vue +++ b/apps/desktop/src/components/layout/ContentArea.vue @@ -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)" diff --git a/apps/desktop/src/components/layout/EditorGroup.vue b/apps/desktop/src/components/layout/EditorGroup.vue index 3a51b066a9..8d823afa65 100644 --- a/apps/desktop/src/components/layout/EditorGroup.vue +++ b/apps/desktop/src/components/layout/EditorGroup.vue @@ -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": []; diff --git a/apps/desktop/src/components/layout/SqlEditorWorkspace.vue b/apps/desktop/src/components/layout/SqlEditorWorkspace.vue index a5e852c2a1..d2c42b674e 100644 --- a/apps/desktop/src/components/layout/SqlEditorWorkspace.vue +++ b/apps/desktop/src/components/layout/SqlEditorWorkspace.vue @@ -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')" diff --git a/apps/desktop/src/components/layout/__tests__/ContentArea.locateSidebar.component.spec.ts b/apps/desktop/src/components/layout/__tests__/ContentArea.locateSidebar.component.spec.ts new file mode 100644 index 0000000000..9d5b0c87d4 --- /dev/null +++ b/apps/desktop/src/components/layout/__tests__/ContentArea.locateSidebar.component.spec.ts @@ -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: "
" }, + Pane: { template: "
" }, +})); +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, 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('[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('[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('[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('[data-test="locate-active-tab"]')!.click(); + + expect(onLocateTab).toHaveBeenCalledExactlyOnceWith(queryStore.tabs[0]); + expect(onOpenObjectTable).not.toHaveBeenCalled(); + }); +}); diff --git a/apps/desktop/src/components/layout/querySurfaces.ts b/apps/desktop/src/components/layout/querySurfaces.ts index d9bbdc022d..24c1f3f80c 100644 --- a/apps/desktop/src/components/layout/querySurfaces.ts +++ b/apps/desktop/src/components/layout/querySurfaces.ts @@ -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]; diff --git a/apps/desktop/src/components/objects/ObjectBrowser.vue b/apps/desktop/src/components/objects/ObjectBrowser.vue index b4c859bf7c..2b78d43f88 100644 --- a/apps/desktop/src/components/objects/ObjectBrowser.vue +++ b/apps/desktop/src/components/objects/ObjectBrowser.vue @@ -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; +}