fix(plugins): invalidate icon cache on updates outside plugin center

This commit is contained in:
弈秋 authored and GitHub committed 2026-09-26 00:03:21 +08:00
1 parent 7255a194cb
commit 4baec21fb7
2 files changed
+71

No files matched your search

@@ -0,0 +1,59 @@
// @vitest-environment happy-dom
import { beforeEach, describe, expect, it, vi } from "vitest";
import * as api from "@/lib/backend/api";
import type { InstalledPlugin } from "@/types/database";
import { COMPONENT_PLUGINS_UPDATED_EVENT } from "@/lib/updates/componentUpdateEvents";
import { clearPluginIconCache, resolvePluginIcon } from "@/lib/plugins/pluginIconResolver";
vi.mock("@/lib/backend/api", () => ({ listPlugins: vi.fn() }));
function plugin(id: string, icon: string): InstalledPlugin {
return {
manifest: { id, name: id, version: "1.0.0", icon, contributions: [] },
compatibility: { compatible: true, errors: [], warnings: [] },
} as unknown as InstalledPlugin;
}
describe("pluginIconResolver cache", () => {
beforeEach(() => {
clearPluginIconCache();
vi.mocked(api.listPlugins).mockReset();
});
it("memoizes the installed-plugin list across resolves", async () => {
vi.mocked(api.listPlugins).mockResolvedValue([plugin("a", "assets/a.svg")]);
expect(await resolvePluginIcon("a")).toBe("assets/a.svg");
expect(await resolvePluginIcon("a")).toBe("assets/a.svg");
expect(api.listPlugins).toHaveBeenCalledTimes(1);
});
it("drops the stale cache when plugins change outside the plugin center", async () => {
// First resolve caches an empty list (the new plugin is not installed yet).
vi.mocked(api.listPlugins).mockResolvedValueOnce([]);
expect(await resolvePluginIcon("new")).toBeUndefined();
expect(api.listPlugins).toHaveBeenCalledTimes(1);
// The plugin is installed and the update center broadcasts the global event while the
// plugin center is closed. Without global invalidation the cached empty list would persist.
vi.mocked(api.listPlugins).mockResolvedValueOnce([plugin("new", "assets/new.svg")]);
window.dispatchEvent(new Event(COMPONENT_PLUGINS_UPDATED_EVENT));
expect(await resolvePluginIcon("new")).toBe("assets/new.svg");
expect(api.listPlugins).toHaveBeenCalledTimes(2);
});
it("drops the stale cache on dbx:plugins-changed (batch uninstall path)", async () => {
vi.mocked(api.listPlugins).mockResolvedValueOnce([plugin("old", "assets/old.svg")]);
expect(await resolvePluginIcon("old")).toBe("assets/old.svg");
expect(api.listPlugins).toHaveBeenCalledTimes(1);
// Batch uninstall refreshes via dbx:plugins-changed only; the removed plugin must not
// resolve from the cached list anymore.
vi.mocked(api.listPlugins).mockResolvedValueOnce([]);
window.dispatchEvent(new Event("dbx:plugins-changed"));
expect(await resolvePluginIcon("old")).toBeUndefined();
expect(api.listPlugins).toHaveBeenCalledTimes(2);
});
});
@@ -1,5 +1,6 @@
import * as api from "@/lib/backend/api";
import type { InstalledPlugin } from "@/types/database";
import { COMPONENT_PLUGINS_UPDATED_EVENT } from "@/lib/updates/componentUpdateEvents";
let installedPluginsPromise: Promise<InstalledPlugin[]> | null = null;
@@ -15,6 +16,17 @@ export function clearPluginIconCache() {
installedPluginsPromise = null;
}
// This cache is global, but the plugin set can change from entry points other than the plugin
// center (e.g. the update center dispatches COMPONENT_PLUGINS_UPDATED_EVENT from App.vue while the
// center is closed; batch uninstall dispatches only dbx:plugins-changed). Invalidate on both
// events here, at the cache owner, so freshly installed or updated plugins don't keep a stale
// (missing) icon in the sidebar, tabs and connection tree until the plugin center happens to
// mount.
if (typeof window !== "undefined") {
window.addEventListener(COMPONENT_PLUGINS_UPDATED_EVENT, clearPluginIconCache);
window.addEventListener("dbx:plugins-changed", clearPluginIconCache);
}
export async function resolvePluginIcon(pluginId: string, contributionId?: string): Promise<string | undefined> {
const plugin = (await installedPlugins()).find((entry) => entry.manifest.id === pluginId);
if (!plugin) return undefined;