feat(search): open standalone plugin workbenches from quick open

This commit is contained in:
t8y2 committed 2026-09-20 18:46:15 +08:00
1 parent 4d150fc909
commit f89759e744
14 files changed
+154 -16

No files matched your search

@@ -17,6 +17,7 @@ vi.mock("@/stores/savedSqlStore", () => ({
vi.mock("@/lib/backend/api", () => ({
listSqlFilesInFolder: vi.fn(),
readExternalSqlFile: vi.fn(),
listPlugins: vi.fn(),
}));
vi.mock("@/lib/sqlFile/sqlFileFolders", async () => {
@@ -532,6 +533,65 @@ describe("useQuickOpen", () => {
});
});
describe("plugin workbenches", () => {
function installedPluginFixture(id: string, name: string, contributions: any[]) {
return {
manifest: { id, name, version: "1.0.0", contributions },
compatibility: { compatible: true },
} as any;
}
it("lists standalone workbenches and skips ones bound to a connection provider", async () => {
vi.mocked(useConnectionStore).mockReturnValue({ connections: [], treeNodes: [] } as any);
vi.mocked(api.listPlugins).mockResolvedValue([
installedPluginFixture("io.leetcode", "LeetCode", [{ type: "workbench", id: "main", label: "LeetCode" }]),
installedPluginFixture("io.kafka", "Kafka", [
{ type: "connection-provider", id: "kafka", label: "Kafka", database_type: "kafka", fields: [], workbench: "browser" },
{ type: "workbench", id: "browser", label: "Kafka Browser" },
]),
installedPluginFixture("io.terminal", "Terminal", [
{ type: "connection-provider", id: "ssh", label: "SSH", database_type: "ssh", fields: [] },
{ type: "workbench", id: "shell", label: "Terminal" },
]),
installedPluginFixture("io.mixed", "Mixed", [
{ type: "connection-provider", id: "cp", label: "Mixed", database_type: "mixed", fields: [], workbench: "bound" },
{ type: "workbench", id: "bound", label: "Bound Panel" },
{ type: "workbench", id: "free", label: "Free Panel" },
]),
]);
const { filteredItems, loadPluginWorkbenches } = useQuickOpen();
await loadPluginWorkbenches();
const labels = filteredItems.value.map((item) => item.label);
expect(labels).toContain("LeetCode");
// A provider without a workbench pointer leaves its sibling workbench standalone.
expect(labels).toContain("Terminal");
// Only the unbound workbench of a mixed plugin is listed.
expect(labels).toContain("Free Panel");
expect(labels).not.toContain("Kafka Browser");
expect(labels).not.toContain("Bound Panel");
});
it("finds workbenches by plugin name and carries the dispatch fields", async () => {
vi.mocked(useConnectionStore).mockReturnValue({ connections: [], treeNodes: [] } as any);
vi.mocked(api.listPlugins).mockResolvedValue([installedPluginFixture("io.leetcode", "LeetCode", [{ type: "workbench", id: "main", label: "刷题面板", icon: "assets/icon.png" }])]);
const { filteredItems, loadPluginWorkbenches, setQuery } = useQuickOpen();
await loadPluginWorkbenches();
setQuery("leetcode");
expect(filteredItems.value.length).toBe(1);
const item = filteredItems.value[0];
expect(item.type).toBe("plugin_workbench");
expect(item.pluginId).toBe("io.leetcode");
expect(item.contributionId).toBe("main");
expect(item.description).toBe("LeetCode");
expect(item.pluginIcon).toBe("assets/icon.png");
expect(item.connectionId).toBe("");
});
});
describe("item selection navigation", () => {
it("should initialize with selectedIndex at 0", () => {
const mockStore = {
+71 -15
View File
@@ -9,7 +9,8 @@ import type { SqlFileEntry } from "@/lib/backend/api";
import { getSqlFileFilter, getSqlFileFolderPaths, sqlFileFoldersVersion } from "@/lib/sqlFile/sqlFileFolders";
import { composeGlobalSearchRoots, getGlobalSearchExtensions, globalSearchSettingsVersion } from "@/lib/globalSearch/globalSearchSettings";
import { containsHan, pinyinFirstLetters } from "@/lib/common/pinyin";
import i18n from "@/i18n";
import { createFrontendPluginRegistry } from "@/lib/plugins/frontendPlugin";
import i18n, { currentLocale } from "@/i18n";
const REMOTE_SEARCH_DEBOUNCE_MS = 180;
const REMOTE_SEARCH_MIN_QUERY_LENGTH = 2;
@@ -28,7 +29,7 @@ const REMOTE_SEARCH_UNSUPPORTED_TYPES = new Set<ConnectionConfig["db_type"]>(["r
export interface QuickOpenItem {
id: string;
type: "connection" | "database" | "schema" | "table" | "view" | "materialized_view" | "procedure" | "function" | "sequence" | "package" | "package-body" | "sql_file" | "sql_library_file" | "content_match";
type: "connection" | "plugin_workbench" | "database" | "schema" | "table" | "view" | "materialized_view" | "procedure" | "function" | "sequence" | "package" | "package-body" | "sql_file" | "sql_library_file" | "content_match";
label: string;
description?: string;
connectionId: string;
@@ -46,6 +47,9 @@ export interface QuickOpenItem {
matchText?: string; // For content matches: matched slice
lineText?: string; // For content matches: full matching line
highlightIndices?: [number, number]; // For content matches: [start, end) chars into lineText to highlight
pluginId?: string; // For plugin workbenches: plugin manifest id
contributionId?: string; // For plugin workbenches: workbench contribution id
pluginIcon?: string; // For plugin workbenches: contribution icon path, falling back to the manifest icon
}
export type QuickOpenMatchKind = "exact" | "initials" | "prefix" | "word-prefix" | "substring" | "fuzzy";
@@ -282,6 +286,8 @@ export function useQuickOpen() {
let sqlFilesLoaded = false;
let sqlFilesLoadingPromise: Promise<void> | null = null;
let sqlFilesLoadGeneration = 0;
const pluginWorkbenchItems = ref<QuickOpenItem[]>([]);
let pluginWorkbenchesLoading = false;
// --- Content search mode (global search of local SQL/text file contents) ---
const contentMode = ref(false);
@@ -477,6 +483,47 @@ export function useQuickOpen() {
return sqlFileItems.value.slice(0, INITIAL_SQL_FILE_LIMIT);
});
/**
* Refresh quick-open entries for plugin workbenches that no connection
* provider claims. A workbench bound via a provider's `workbench` pointer is
* opened through its connection (which quick open already lists as a
* connection item with full context), so listing it here would only offer a
* contextless dead end. Unclaimed workbenches otherwise have no entry point
* outside the Plugin Center's Installed tab.
* Re-runs on every dialog open so installs/uninstalls show up without a restart.
*/
async function loadPluginWorkbenches(): Promise<void> {
if (pluginWorkbenchesLoading) return;
pluginWorkbenchesLoading = true;
try {
const registry = createFrontendPluginRegistry(await api.listPlugins(), currentLocale());
const connectionBound = new Set(
registry
.listConnectionProviders()
.filter((entry) => entry.contribution.workbench)
.map((entry) => `${entry.plugin.manifest.id}/${entry.contribution.workbench}`),
);
pluginWorkbenchItems.value = registry
.listWorkbenches()
.filter((entry) => !connectionBound.has(`${entry.plugin.manifest.id}/${entry.contribution.id}`))
.map((entry) => ({
id: `pluginwb-${entry.plugin.manifest.id}-${entry.contribution.id}`,
type: "plugin_workbench" as const,
label: entry.contribution.label,
description: entry.plugin.manifest.name,
connectionId: "",
pluginId: entry.plugin.manifest.id,
contributionId: entry.contribution.id,
pluginIcon: entry.contribution.icon || entry.plugin.manifest.icon,
searchText: `${entry.plugin.manifest.name} ${entry.contribution.label} ${entry.contribution.id}`,
}));
} catch {
// Plugin listings are best-effort; quick open keeps working without them.
} finally {
pluginWorkbenchesLoading = false;
}
}
const allItems = computed((): QuickOpenItem[] => {
const items: QuickOpenItem[] = [];
const connections = connectionStore.connections;
@@ -494,6 +541,10 @@ export function useQuickOpen() {
});
}
// Standalone plugin workbenches sit right after connections so they stay
// reachable in the no-query list before the (much longer) tree items.
items.push(...pluginWorkbenchItems.value);
// Add databases and tables from tree nodes
// Filter tree nodes by connection
for (const conn of connections) {
@@ -851,6 +902,9 @@ export function useQuickOpen() {
if (normalizedQuery.length > 0 && !sqlFilesLoaded && !sqlFilesLoadingPromise) {
void loadExternalSqlFiles();
}
if (normalizedQuery.length > 0) {
void loadPluginWorkbenches();
}
if (normalizedQuery.length < REMOTE_SEARCH_MIN_QUERY_LENGTH) return;
const contexts = remoteSearchContexts();
@@ -902,19 +956,20 @@ export function useQuickOpen() {
const typeOrder = {
connection: 0,
database: 1,
schema: 2,
table: 3,
view: 4,
materialized_view: 5,
procedure: 6,
function: 7,
sequence: 8,
package: 9,
"package-body": 10,
sql_library_file: 11,
sql_file: 12,
content_match: 13,
plugin_workbench: 1,
database: 2,
schema: 3,
table: 4,
view: 5,
materialized_view: 6,
procedure: 7,
function: 8,
sequence: 9,
package: 10,
"package-body": 11,
sql_library_file: 12,
sql_file: 13,
content_match: 14,
};
const typeDifference = typeOrder[a.type] - typeOrder[b.type];
if (typeDifference !== 0) return typeDifference;
@@ -1016,5 +1071,6 @@ export function useQuickOpen() {
resetSelection,
setQuery,
loadExternalSqlFiles,
loadPluginWorkbenches,
};
}