Skip to content

πŸ™Œ OpenHands: AI-Driven Development

feat(canvas): render a canvas extension's manifest-declared SVG icon (#17877)

Vasco Schiavo3b22f29a4d94
diff --git a/src/api/canvas-extensions-service.ts b/src/api/canvas-extensions-service.ts
index 39b4545981..3350ef8dc1 100644
--- a/src/api/canvas-extensions-service.ts
+++ b/src/api/canvas-extensions-service.ts
@@ -170,6 +170,15 @@ class CanvasExtensionsService {
);
}
+ static async fetchIcon(name: string): Promise<Blob> {
+ const client = getClient();
+ return mapUnsupported(() =>
+ client.get<Blob>(`${installedExtensionPath(name)}/icon`, {
+ responseType: "blob",
+ }),
+ );
+ }
+
static async requestAgentServer<T = unknown>(
request: CanvasExtensionAgentServerRequest,
backend?: Backend,
diff --git a/src/components/features/canvas-extensions/canvas-extension-card.tsx b/src/components/features/canvas-extensions/canvas-extension-card.tsx
index 4112c2d962..a7ef6e1ca0 100644
--- a/src/components/features/canvas-extensions/canvas-extension-card.tsx
+++ b/src/components/features/canvas-extensions/canvas-extension-card.tsx
@@ -3,6 +3,7 @@ import { BrandButton } from "#/components/features/settings/brand-button";
import { ToggleSwitch } from "#/ui/toggle-switch";
import { I18nKey } from "#/i18n/declaration";
import type { InstalledCanvasExtensionInfo } from "#/types/canvas-extension";
+import { CanvasExtensionIcon } from "./canvas-extension-icon";
import {
extensionModuleCardPillClassName,
extensionModuleCardSurfaceClassName,
@@ -33,6 +34,11 @@ export function CanvasExtensionCard({
className={`flex min-w-0 flex-col gap-4 p-4 ${extensionModuleCardSurfaceClassName}`}
>
<header className="flex items-start justify-between gap-4">
+ <CanvasExtensionIcon
+ extension={extension}
+ size={20}
+ className="mt-0.5 shrink-0"
+ />
<div className="min-w-0 flex-1">
<h3 className="truncate text-sm font-semibold text-contrast">
{displayName}
diff --git a/src/components/features/canvas-extensions/canvas-extension-icon.test.tsx b/src/components/features/canvas-extensions/canvas-extension-icon.test.tsx
new file mode 100644
index 0000000000..f708cb622b
--- /dev/null
+++ b/src/components/features/canvas-extensions/canvas-extension-icon.test.tsx
@@ -0,0 +1,89 @@
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+import { render, screen } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import CanvasExtensionsService from "#/api/canvas-extensions-service";
+import type { InstalledCanvasExtensionInfo } from "#/types/canvas-extension";
+import { CanvasExtensionIcon } from "./canvas-extension-icon";
+
+function makeExtension(icon?: string): InstalledCanvasExtensionInfo {
+ return {
+ name: "demo-extension",
+ version: "0.1.0",
+ enabled: true,
+ source: "github:example/demo",
+ installed_at: "2026-08-01T00:00:00Z",
+ install_path: "/tmp/demo-extension",
+ manifest: {
+ schema_version: 1,
+ name: "demo-extension",
+ version: "0.1.0",
+ entrypoint: "dist/extension.js",
+ icon,
+ },
+ };
+}
+
+function renderIcon(icon?: string) {
+ const queryClient = new QueryClient();
+ return render(
+ <QueryClientProvider client={queryClient}>
+ <CanvasExtensionIcon extension={makeExtension(icon)} size={18} />
+ </QueryClientProvider>,
+ );
+}
+
+describe("CanvasExtensionIcon", () => {
+ beforeEach(() => {
+ URL.createObjectURL = vi.fn(() => "blob:icon");
+ URL.revokeObjectURL = vi.fn();
+ });
+
+ afterEach(() => {
+ vi.restoreAllMocks();
+ });
+
+ it("renders the default icon without fetching when no icon is declared", () => {
+ const fetchIcon = vi.spyOn(CanvasExtensionsService, "fetchIcon");
+
+ renderIcon();
+
+ expect(
+ screen.getByTestId("canvas-extension-default-icon"),
+ ).toBeInTheDocument();
+ expect(fetchIcon).not.toHaveBeenCalled();
+ });
+
+ it("renders the fetched icon and revokes its object URL on unmount", async () => {
+ vi.spyOn(CanvasExtensionsService, "fetchIcon").mockResolvedValue(
+ new Blob(["<svg/>"], { type: "image/svg+xml" }),
+ );
+
+ const { unmount } = renderIcon("assets/icon.svg");
+
+ expect(await screen.findByTestId("canvas-extension-icon")).toHaveAttribute(
+ "src",
+ "blob:icon",
+ );
+ expect(CanvasExtensionsService.fetchIcon).toHaveBeenCalledWith(
+ "demo-extension",
+ );
+ unmount();
+ expect(URL.revokeObjectURL).toHaveBeenCalledWith("blob:icon");
+ });
+
+ it("keeps the default icon when the backend cannot serve the icon", async () => {
+ vi.spyOn(CanvasExtensionsService, "fetchIcon").mockRejectedValue(
+ new Error("404"),
+ );
+
+ renderIcon("assets/icon.svg");
+
+ await vi.waitFor(() =>
+ expect(CanvasExtensionsService.fetchIcon).toHaveBeenCalled(),
+ );
+ expect(
+ screen.getByTestId("canvas-extension-default-icon"),
+ ).toBeInTheDocument();
+ expect(screen.queryByTestId("canvas-extension-icon")).toBeNull();
+ });
+});
diff --git a/src/components/features/canvas-extensions/canvas-extension-icon.tsx b/src/components/features/canvas-extensions/canvas-extension-icon.tsx
new file mode 100644
index 0000000000..6a9656828e
--- /dev/null
+++ b/src/components/features/canvas-extensions/canvas-extension-icon.tsx
@@ -0,0 +1,58 @@
+import React from "react";
+import { PanelsTopLeft } from "lucide-react";
+import { useCanvasExtensionIcon } from "#/hooks/query/use-canvas-extension-icon";
+import type { InstalledCanvasExtensionInfo } from "#/types/canvas-extension";
+
+interface CanvasExtensionIconProps {
+ extension: InstalledCanvasExtensionInfo;
+ size: number;
+ className?: string;
+}
+
+// Rendered via <img> (never inlined) so the SVG cannot run scripts.
+export function CanvasExtensionIcon({
+ extension,
+ size,
+ className,
+}: CanvasExtensionIconProps) {
+ const { data: icon } = useCanvasExtensionIcon(
+ extension.name,
+ Boolean(extension.manifest?.icon),
+ );
+ const [src, setSrc] = React.useState<string | null>(null);
+
+ React.useEffect(() => {
+ if (!icon) return undefined;
+ const url = URL.createObjectURL(icon);
+ setSrc(url);
+ return () => {
+ URL.revokeObjectURL(url);
+ setSrc(null);
+ };
+ }, [icon]);
+
+ if (!src) {
+ return (
+ <PanelsTopLeft
+ width={size}
+ height={size}
+ className={className}
+ aria-hidden
+ data-testid="canvas-extension-default-icon"
+ />
+ );
+ }
+
+ return (
+ <img
+ src={src}
+ width={size}
+ height={size}
+ alt=""
+ aria-hidden
+ className={className}
+ data-testid="canvas-extension-icon"
+ onError={() => setSrc(null)}
+ />
+ );
+}
diff --git a/src/components/features/sidebar/sidebar-rail-body.tsx b/src/components/features/sidebar/sidebar-rail-body.tsx
index 0b68b70d4b..821b542e5b 100644
--- a/src/components/features/sidebar/sidebar-rail-body.tsx
+++ b/src/components/features/sidebar/sidebar-rail-body.tsx
@@ -6,7 +6,6 @@ import {
Plus,
Server,
Settings,
- PanelsTopLeft,
} from "lucide-react";
import { OpenHandsLogoButton } from "#/components/shared/buttons/openhands-logo-button";
import { NavigationLink } from "#/components/shared/navigation-link";
@@ -43,6 +42,7 @@ import {
sidebarNavRowClassName,
} from "./sidebar-layout";
import { useCanvasExtensionsRuntime } from "#/components/features/canvas-extensions/canvas-extensions-runtime";
+import { CanvasExtensionIcon } from "#/components/features/canvas-extensions/canvas-extension-icon";
import type { Backend } from "#/api/backend-registry/types";
const ICON_SIZE = 18;
@@ -271,7 +271,12 @@ export function SidebarRailBody({
label={page.contribution.nav_label || page.contribution.title}
testId={`sidebar-canvas-extension-${page.extension.name}-${page.contribution.id}`}
collapsed={collapsed}
- icon={<PanelsTopLeft width={ICON_SIZE} height={ICON_SIZE} />}
+ icon={
+ <CanvasExtensionIcon
+ extension={page.extension}
+ size={ICON_SIZE}
+ />
+ }
/>
))}
</nav>
diff --git a/src/hooks/query/query-keys.ts b/src/hooks/query/query-keys.ts
index 6ddba7e78e..631ab84a0a 100644
--- a/src/hooks/query/query-keys.ts
+++ b/src/hooks/query/query-keys.ts
@@ -75,6 +75,20 @@ export const CANVAS_EXTENSIONS_QUERY_KEYS = {
orgId,
connectionRevision,
] as const,
+ icon: (
+ backendId: string,
+ orgId: string | null,
+ connectionRevision: number,
+ name: string,
+ ) =>
+ [
+ "canvas-extensions",
+ "icon",
+ backendId,
+ orgId,
+ connectionRevision,
+ name,
+ ] as const,
} as const;
export const SETUP_QUERY_KEYS = {
diff --git a/src/hooks/query/use-canvas-extension-icon.ts b/src/hooks/query/use-canvas-extension-icon.ts
new file mode 100644
index 0000000000..85e023bb86
--- /dev/null
+++ b/src/hooks/query/use-canvas-extension-icon.ts
@@ -0,0 +1,21 @@
+import { useQuery } from "@tanstack/react-query";
+import CanvasExtensionsService from "#/api/canvas-extensions-service";
+import { useActiveBackend } from "#/contexts/active-backend-context";
+import { CANVAS_EXTENSIONS_QUERY_KEYS } from "#/hooks/query/query-keys";
+
+export function useCanvasExtensionIcon(name: string, enabled: boolean) {
+ const active = useActiveBackend();
+
+ return useQuery({
+ queryKey: CANVAS_EXTENSIONS_QUERY_KEYS.icon(
+ active.backend.id,
+ active.orgId,
+ active.backend.connectionRevision ?? 0,
+ name,
+ ),
+ queryFn: () => CanvasExtensionsService.fetchIcon(name),
+ enabled,
+ retry: false,
+ meta: { disableToast: true },
+ });
+}
diff --git a/src/types/canvas-extension.ts b/src/types/canvas-extension.ts
index 7f4453c253..5a47b00ad8 100644
--- a/src/types/canvas-extension.ts
+++ b/src/types/canvas-extension.ts
@@ -22,6 +22,8 @@ export interface CanvasExtensionManifest {
description?: string | null;
entrypoint: string;
contributes?: CanvasExtensionContributions | null;
+ /** Package-relative SVG path; served by the Agent Server at `/installed/{name}/icon`. */
+ icon?: string | null;
}
export interface InstalledCanvasExtensionInfo {