Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix: join local Canvas Extension source and path for install (#17072)

lorenzozaned3ec5d9ad938
diff --git a/src/api/canvas-extensions-service.test.ts b/src/api/canvas-extensions-service.test.ts
index 014c541d03..9b61b1d754 100644
--- a/src/api/canvas-extensions-service.test.ts
+++ b/src/api/canvas-extensions-service.test.ts
@@ -101,6 +101,41 @@ describe("CanvasExtensionsService", () => {
});
});
+ it.each([
+ {
+ source: "/repository-name/",
+ repoPath: "/demo-extension",
+ expectedSource: "/repository-name/demo-extension",
+ },
+ {
+ source: "/repository-name",
+ repoPath: "demo-extension",
+ expectedSource: "/repository-name/demo-extension",
+ },
+ {
+ source: "/repository-name/demo-extension",
+ repoPath: null,
+ expectedSource: "/repository-name/demo-extension",
+ },
+ ])(
+ "resolves a local extension from source $source and path $repoPath",
+ async ({ source, repoPath, expectedSource }) => {
+ post.mockResolvedValue(extension);
+
+ await CanvasExtensionsService.install({
+ source,
+ ref: null,
+ repo_path: repoPath,
+ });
+
+ expect(post).toHaveBeenCalledWith("/api/canvas-extensions/install", {
+ source: expectedSource,
+ ref: null,
+ repo_path: null,
+ });
+ },
+ );
+
it("maps a missing router to an explicit unsupported-backend error", async () => {
get.mockRejectedValue(
Object.assign(new Error("Not Found"), {
diff --git a/src/api/canvas-extensions-service.ts b/src/api/canvas-extensions-service.ts
index b409a4c294..39b4545981 100644
--- a/src/api/canvas-extensions-service.ts
+++ b/src/api/canvas-extensions-service.ts
@@ -13,6 +13,8 @@ import type {
} from "#/types/canvas-extension";
const CANVAS_EXTENSIONS_BASE_PATH = "/api/canvas-extensions";
+const REMOTE_EXTENSION_SOURCE_PATTERN =
+ /^(?:github:|https?:\/\/|git:\/\/|file:\/\/|[\w.-]+@[\w.-]+:)/i;
export type CanvasExtensionsUnsupportedReason =
| "no-backend"
@@ -91,6 +93,31 @@ function installedExtensionPath(name: string): string {
return `${CANVAS_EXTENSIONS_BASE_PATH}/installed/${encodeURIComponent(name)}`;
}
+function joinLocalExtensionPath(source: string, repoPath: string): string {
+ const separator = source.includes("\\") && !source.includes("/") ? "\\" : "/";
+ const basePath = source.replace(/[\\/]+$/, "");
+ const childPath = repoPath.replace(/^[\\/]+/, "");
+
+ if (!childPath) return source;
+ if (!basePath) return `${separator}${childPath}`;
+ return `${basePath}${separator}${childPath}`;
+}
+
+function normalizeInstallRequest(
+ request: InstallCanvasExtensionRequest,
+): InstallCanvasExtensionRequest {
+ const repoPath = request.repo_path?.trim();
+ if (!repoPath || REMOTE_EXTENSION_SOURCE_PATTERN.test(request.source)) {
+ return request;
+ }
+
+ return {
+ ...request,
+ source: joinLocalExtensionPath(request.source, repoPath),
+ repo_path: null,
+ };
+}
+
class CanvasExtensionsService {
static async listInstalled(): Promise<InstalledCanvasExtensionInfo[]> {
const client = getClient();
@@ -109,7 +136,7 @@ class CanvasExtensionsService {
return mapUnsupported(() =>
client.post<InstalledCanvasExtensionInfo>(
`${CANVAS_EXTENSIONS_BASE_PATH}/install`,
- request,
+ normalizeInstallRequest(request),
),
);
}