Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix(vercel): force HTTPS for typescript-client git dep on Vercel (#391)

Robert Brennan8b7ed9de2fa7
diff --git a/AGENTS.md b/AGENTS.md
index f76c1b5147..fccd7afeab 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -54,6 +54,7 @@
- `__tests__/i18n/library-namespace.test.ts` imports the full library entry and can exceed Vitest's default 5s timeout under full-suite load; keep an explicit higher timeout on that case unless the test is substantially narrowed.
- `@openhands/typescript-client` is currently pinned to commit `ef62e82fc3dfb03991a1c8025429caf354427263` because the package metadata needed by this PR has not been published as a consistent npm/tagged release yet. That commit ships the needed typed clients plus subpath exports for `client/http-client`, `events/remote-events-list`, and `workspace/remote-workspace`. `RemoteWorkspace.gitChanges`/`gitDiff` accept an optional `{ ref }` option; agent-canvas passes `'HEAD'` so the changes panel reflects working-tree + index versus the latest commit (i.e. staged + unstaged) instead of a diff against the upstream/default branch.
+- The `@openhands/typescript-client` git dep must be expressed as a `git+https://github.com/...` URL in both `package.json` and the top-level dep entry of `package-lock.json`; the `github:OpenHands/...` shorthand normalizes to `git+ssh://` inside the lockfile, and Vercel's build environment has no GitHub SSH key, so an ssh-pinned lockfile makes Vercel fall back to a stale cached tarball and the bundler then fails with `[MISSING_EXPORT] ConversationClient/FileClient/SharedClient is not exported by .../dist/clients.js`. `scripts/vercel-install.sh` (wired up via `vercel.json`'s `installCommand`) defensively rewrites any leftover `git+ssh://[email protected]/` resolved URLs to `git+https://github.com/` and adds matching `git config --global url..insteadOf` aliases before invoking `npm ci`, so a future regression that re-introduces an ssh-pinned lockfile entry still builds on Vercel. See GitHub issue #384 for the original failure and PR #382 for the prior single-shot lockfile fix that this generalizes.
- Use `@openhands/typescript-client` classes directly for agent-server-backed REST/workspace/event/VS Code calls. Centralize host/session API key/working-directory option assembly through `src/api/agent-server-client-options.ts`; the backend fallback policy itself lives in `src/api/backend-registry/active-store.ts`.
- Local verification/build gotchas:
- `npm run typecheck` assumes generated translation types exist; run `npm run make-i18n` first if `src/i18n/declaration.ts` is missing.
diff --git a/package-lock.json b/package-lock.json
index e00a521579..9ccf2c69db 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -12,7 +12,7 @@
"@heroui/react": "2.8.10",
"@microlink/react-json-view": "1.31.20",
"@monaco-editor/react": "4.7.0",
- "@openhands/typescript-client": "github:OpenHands/typescript-client#ef62e82fc3dfb03991a1c8025429caf354427263",
+ "@openhands/typescript-client": "git+https://github.com/OpenHands/typescript-client.git#ef62e82fc3dfb03991a1c8025429caf354427263",
"@react-router/node": "7.14.2",
"@react-router/serve": "7.14.2",
"@tailwindcss/vite": "4.2.4",
diff --git a/package.json b/package.json
index 5be19b08f7..5742877212 100644
--- a/package.json
+++ b/package.json
@@ -23,7 +23,7 @@
"@heroui/react": "2.8.10",
"@microlink/react-json-view": "1.31.20",
"@monaco-editor/react": "4.7.0",
- "@openhands/typescript-client": "github:OpenHands/typescript-client#ef62e82fc3dfb03991a1c8025429caf354427263",
+ "@openhands/typescript-client": "git+https://github.com/OpenHands/typescript-client.git#ef62e82fc3dfb03991a1c8025429caf354427263",
"@react-router/node": "7.14.2",
"@react-router/serve": "7.14.2",
"@tailwindcss/vite": "4.2.4",
diff --git a/scripts/vercel-install.sh b/scripts/vercel-install.sh
new file mode 100755
index 0000000000..a12ad2249b
--- /dev/null
+++ b/scripts/vercel-install.sh
@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+# Custom Vercel install command.
+#
+# npm normalizes any GitHub URL it finds in package.json (including
+# `git+https://github.com/...` and the `github:owner/repo` shorthand) to
+# `git+ssh://[email protected]/...` when it writes package-lock.json. Vercel's
+# build environment has no SSH key for GitHub, so npm cannot clone the
+# `@openhands/typescript-client` git dependency and silently falls back to a
+# stale cached copy β€” producing the dreaded
+# `[MISSING_EXPORT] ConversationClient is not exported by
+# node_modules/@openhands/typescript-client/dist/clients.js` at bundle time.
+#
+# Two defensive measures here:
+# 1. Rewrite any `git+ssh://[email protected]/` URLs in package-lock.json
+# to `git+https://github.com/` before invoking npm so the lockfile
+# Vercel actually consumes is HTTPS-only, regardless of which lockfile
+# shape happened to be committed.
+# 2. Configure git globally to translate the matching ssh forms into
+# https β€” this catches anything npm has already cached as an ssh URL
+# and any future git deps that hit the same bug.
+#
+# See https://github.com/OpenHands/agent-canvas/issues/384 for the original
+# bug report.
+set -euo pipefail
+
+if [ -f package-lock.json ]; then
+ sed -i 's|git+ssh://[email protected]/|git+https://github.com/|g' package-lock.json
+fi
+
+git config --global url."https://github.com/".insteadOf "ssh://[email protected]/"
+git config --global url."https://github.com/".insteadOf "[email protected]:"
+
+npm ci
diff --git a/vercel.json b/vercel.json
new file mode 100644
index 0000000000..d2d9091511
--- /dev/null
+++ b/vercel.json
@@ -0,0 +1,4 @@
+{
+ "$schema": "https://openapi.vercel.sh/vercel.json",
+ "installCommand": "bash scripts/vercel-install.sh"
+}