π OpenHands: AI-Driven Development
/**
* Whether *this browser origin* can serve the editor, and whether a given
* editor URL is one it will actually route.
*
* Editor availability is not a property of the agent-server process alone. The
* agent-server answers `/api/vscode/status` for whatever conversation you ask
* about, and builds `/api/vscode/url` from the `base_url` the caller sends β
* which is always `window.location.origin`. So a server can truthfully report
* an editor that the page's own origin has no route to. Two supported layouts
* hit that:
*
* - **Public mode** (`docker/entrypoint.sh`, `--auth-required`): a second
* static server on its own port, sharing the same agent-server but
* deliberately without the editor route, because the editor's connection
* token is the session API key (OpenHands/software-agent-sdk#4317) and that
* origin exists to test the *unauthenticated* case.
* - **Extra backends** (`scripts/dev-extra-backend.mjs`): a second
* agent-server registered from a browser whose origin belongs to another
* stack. That origin's editor route, if any, points at the *bundled*
* stack's editor β a different container's workspace.
*
* In both cases a control gated only on the server probe renders and then
* resolves to the canvas SPA or, worse, someone else's workspace. So the
* frontend has to intersect the server's capability with the origin's route
* table, and this module is the origin half of that.
*/
const VSCODE_BASE_PATH_WINDOW_KEY = "__AGENT_CANVAS_VSCODE_BASE_PATH__";
/**
* The path prefix this origin serves the editor under, or `null` if it serves
* no editor at all.
*
* Two sources, in order β mirroring `getRawRuntimeServicesInfo` in
* `agent-server-adapter.ts`:
* 1. `VITE_VSCODE_BASE_PATH` β baked in at build time by the dev launchers
* that proxy the editor (`npm run dev`, dev:static).
* 2. `window.__AGENT_CANVAS_VSCODE_BASE_PATH__` β injected into index.html at
* serve time by `scripts/static-server.mjs --vscode-base-path <path>`,
* which refuses to start unless a matching `--route` exists. That is the
* path used by static builds (the Docker image, the published binary),
* where the env var is empty in the prebuilt bundle.
*
* Absent from both means "this origin does not serve the editor" and the
* control is hidden. That is the pre-existing behavior for every local backend,
* so a deployment this cannot detect is no worse off than before.
*/
export function getOriginVSCodeBasePath(): string | null {
const envRaw = import.meta.env.VITE_VSCODE_BASE_PATH?.trim();
if (envRaw) return normalizePrefix(envRaw);
if (typeof window !== "undefined") {
const injected = (window as unknown as Record<string, unknown>)[
VSCODE_BASE_PATH_WINDOW_KEY
];
if (typeof injected === "string" && injected.trim()) {
return normalizePrefix(injected.trim());
}
}
return null;
}
function normalizePrefix(value: string): string {
const withLeadingSlash = value.startsWith("/") ? value : `/${value}`;
return withLeadingSlash.length > 1
? withLeadingSlash.replace(/\/+$/, "")
: withLeadingSlash;
}
/**
* Whether `url` is an editor URL this origin will actually route.
*
* The agent-server appends its own `vscode_base_path` to the origin we send it,
* so the returned URL carries the prefix of the server that answered β not
* necessarily the prefix this origin routes. An extra backend that configures
* no prefix yields `<origin>/?tkn=β¦`, which is the canvas root: same origin,
* wrong destination. Comparing paths is what separates the two.
*/
export function isVSCodeUrlServedByOrigin(
url: string | null | undefined,
basePath: string | null,
): boolean {
if (!url || !basePath) return false;
let parsed: URL;
try {
parsed = new URL(
url,
typeof window !== "undefined" ? window.location.href : undefined,
);
} catch {
return false;
}
// A cross-origin URL is somebody else's problem to route, not ours to vouch
// for. The local path always builds on `window.location.origin`, so this only
// fires on a value we did not construct.
if (
typeof window !== "undefined" &&
parsed.origin !== window.location.origin
) {
return false;
}
return (
parsed.pathname === basePath || parsed.pathname.startsWith(`${basePath}/`)
);
}