179 lines
6.8 KiB
TypeScript
Vendored
179 lines
6.8 KiB
TypeScript
Vendored
// @vitest-environment happy-dom
|
|
import { createApp, defineComponent, h, nextTick, ref, type App } from "vue";
|
|
import { createPinia, setActivePinia } from "pinia";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import i18n from "@/i18n";
|
|
import type { ContextMenuItem } from "@/components/ui/CustomContextMenu.vue";
|
|
import type { InstalledPlugin, TreeNode } from "@/types/database";
|
|
|
|
const { listPlugins } = vi.hoisted(() => ({ listPlugins: vi.fn() }));
|
|
|
|
vi.mock("@/lib/backend/api", async (importOriginal) => {
|
|
const actual = await importOriginal<typeof import("@/lib/backend/api")>();
|
|
return { ...actual, listPlugins };
|
|
});
|
|
|
|
import SidebarTreeRuntimeHost from "@/components/sidebar/SidebarTreeRuntimeHost.vue";
|
|
import { useConnectionStore } from "@/stores/connectionStore";
|
|
|
|
const connection = {
|
|
id: "conn-1",
|
|
name: "Test MySQL",
|
|
db_type: "mysql",
|
|
driver_profile: "mysql",
|
|
host: "localhost",
|
|
port: 3306,
|
|
username: "",
|
|
password: "",
|
|
};
|
|
|
|
function contextMenuPlugin(id: string, menu: "connection" | "table", label: string): InstalledPlugin {
|
|
return {
|
|
compatibility: { compatible: true },
|
|
manifest: {
|
|
id,
|
|
name: id,
|
|
version: "1.0.0",
|
|
drivers: [],
|
|
contributions: [{ type: "context-menu", id: "example.generate", label, menu, action: { type: "open-workbench", workbench: `${id}.workbench` } }],
|
|
},
|
|
};
|
|
}
|
|
|
|
function connectionNode(): TreeNode {
|
|
return { id: "conn-1", label: connection.name, type: "connection", connectionId: connection.id };
|
|
}
|
|
|
|
function tableNode(): TreeNode {
|
|
return { id: "conn-1:app:users", label: "users", type: "table", connectionId: connection.id, database: "app", tableName: "users" };
|
|
}
|
|
|
|
const mountedApps: App<Element>[] = [];
|
|
|
|
async function flush(): Promise<void> {
|
|
await nextTick();
|
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
await nextTick();
|
|
}
|
|
|
|
async function mountHost() {
|
|
const pinia = createPinia();
|
|
setActivePinia(pinia);
|
|
const connectionStore = useConnectionStore();
|
|
connectionStore.connections = [connection];
|
|
|
|
const host = ref<InstanceType<typeof SidebarTreeRuntimeHost> | null>(null);
|
|
const root = defineComponent({ setup: () => () => h(SidebarTreeRuntimeHost, { ref: host, node: connectionNode(), depth: 0 }) });
|
|
const container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
const app = createApp(root);
|
|
app.use(pinia);
|
|
app.use(i18n);
|
|
app.mount(container);
|
|
mountedApps.push(app);
|
|
await flush();
|
|
expect(host.value).not.toBeNull();
|
|
return { host: host as unknown as { value: { buildContextMenu(node: TreeNode): ContextMenuItem[] } }, container };
|
|
}
|
|
|
|
function menuLabels(items: ContextMenuItem[]): string[] {
|
|
return items.flatMap((item) => [...(item.label ? [item.label] : []), ...(item.children ? menuLabels(item.children) : [])]);
|
|
}
|
|
|
|
describe("SidebarTreeRuntimeHost plugin context-menu refresh", () => {
|
|
beforeEach(() => {
|
|
listPlugins.mockReset();
|
|
listPlugins.mockResolvedValue([]);
|
|
});
|
|
|
|
afterEach(() => {
|
|
for (const app of mountedApps.splice(0)) app.unmount();
|
|
document.body.innerHTML = "";
|
|
});
|
|
|
|
it("adds a table context-menu contribution installed after mount without remounting the host", async () => {
|
|
const { host } = await mountHost();
|
|
expect(menuLabels(host.value.buildContextMenu(tableNode()))).not.toContain("Generate test data");
|
|
|
|
listPlugins.mockResolvedValue([contextMenuPlugin("com.example.schema-seed", "table", "Generate test data")]);
|
|
window.dispatchEvent(new CustomEvent("dbx:plugins-changed"));
|
|
await flush();
|
|
|
|
expect(menuLabels(host.value.buildContextMenu(tableNode()))).toContain("Generate test data");
|
|
});
|
|
|
|
it("adds a connection context-menu contribution installed after mount without remounting the host", async () => {
|
|
const { host } = await mountHost();
|
|
expect(menuLabels(host.value.buildContextMenu(connectionNode()))).not.toContain("Inspect connection");
|
|
|
|
listPlugins.mockResolvedValue([contextMenuPlugin("com.example.inspector", "connection", "Inspect connection")]);
|
|
window.dispatchEvent(new CustomEvent("dbx:plugins-changed"));
|
|
await flush();
|
|
|
|
expect(menuLabels(host.value.buildContextMenu(connectionNode()))).toContain("Inspect connection");
|
|
});
|
|
|
|
it("keeps each contribution on its own menu surface", async () => {
|
|
listPlugins.mockResolvedValue([contextMenuPlugin("com.example.schema-seed", "table", "Generate test data")]);
|
|
const { host } = await mountHost();
|
|
|
|
expect(menuLabels(host.value.buildContextMenu(tableNode()))).toContain("Generate test data");
|
|
expect(menuLabels(host.value.buildContextMenu(connectionNode()))).not.toContain("Generate test data");
|
|
});
|
|
|
|
it("drops the contribution after the plugin set becomes empty again", async () => {
|
|
listPlugins.mockResolvedValue([contextMenuPlugin("com.example.schema-seed", "table", "Generate test data")]);
|
|
const { host } = await mountHost();
|
|
expect(menuLabels(host.value.buildContextMenu(tableNode()))).toContain("Generate test data");
|
|
|
|
listPlugins.mockResolvedValue([]);
|
|
window.dispatchEvent(new CustomEvent("dbx:plugins-changed"));
|
|
await flush();
|
|
|
|
expect(menuLabels(host.value.buildContextMenu(tableNode()))).not.toContain("Generate test data");
|
|
});
|
|
|
|
it("ignores plugins that are not compatible with the current host", async () => {
|
|
const incompatible: InstalledPlugin = { ...contextMenuPlugin("com.example.legacy", "table", "Legacy action"), compatibility: { compatible: false } };
|
|
listPlugins.mockResolvedValue([incompatible]);
|
|
const { host } = await mountHost();
|
|
|
|
expect(menuLabels(host.value.buildContextMenu(tableNode()))).not.toContain("Legacy action");
|
|
});
|
|
|
|
it("keeps the previous contributions when a refresh fails", async () => {
|
|
listPlugins.mockResolvedValue([contextMenuPlugin("com.example.schema-seed", "table", "Generate test data")]);
|
|
const { host } = await mountHost();
|
|
|
|
listPlugins.mockRejectedValue(new Error("backend unavailable"));
|
|
window.dispatchEvent(new CustomEvent("dbx:plugins-changed"));
|
|
await flush();
|
|
|
|
expect(menuLabels(host.value.buildContextMenu(tableNode()))).toContain("Generate test data");
|
|
});
|
|
|
|
it("stops refreshing after the host is unmounted", async () => {
|
|
await mountHost();
|
|
expect(listPlugins).toHaveBeenCalledTimes(1);
|
|
|
|
mountedApps.splice(0).forEach((app) => app.unmount());
|
|
window.dispatchEvent(new CustomEvent("dbx:plugins-changed"));
|
|
await flush();
|
|
|
|
expect(listPlugins).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it("does not stack listeners when the host remounts", async () => {
|
|
await mountHost();
|
|
mountedApps.splice(0).forEach((app) => app.unmount());
|
|
|
|
await mountHost();
|
|
const callsAfterMount = listPlugins.mock.calls.length;
|
|
|
|
window.dispatchEvent(new CustomEvent("dbx:plugins-changed"));
|
|
await flush();
|
|
|
|
expect(listPlugins).toHaveBeenCalledTimes(callsAfterMount + 1);
|
|
});
|
|
});
|