Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix(backends): open on the org the cloud web app hands back (#18228)

Hiep Leb4af3cb099c3
diff --git a/__tests__/api/backend-registry/active-store.test.ts b/__tests__/api/backend-registry/active-store.test.ts
index 5c8e06db69..a19d9b3bba 100644
--- a/__tests__/api/backend-registry/active-store.test.ts
+++ b/__tests__/api/backend-registry/active-store.test.ts
@@ -8,7 +8,10 @@ import {
setRegisteredBackends,
subscribeActiveBackend,
} from "#/api/backend-registry/active-store";
-import { SEEDED_DEFAULT_BACKEND_ID } from "#/api/backend-registry/default-backend";
+import {
+ LOCKED_CLOUD_BACKEND_ID,
+ SEEDED_DEFAULT_BACKEND_ID,
+} from "#/api/backend-registry/default-backend";
import { MAX_CONSECUTIVE_FAILURES } from "#/api/backend-registry/health-storage";
import {
__resetHealthStoreForTests,
@@ -261,3 +264,65 @@ describe("backend pinned in the URL", () => {
expect(getActiveBackend().backend).toEqual(secondLocalBackend);
});
});
+
+describe("org handed back by the cloud's web app", () => {
+ function lockToThisOrigin() {
+ (
+ window as unknown as Record<string, unknown>
+ ).__AGENT_CANVAS_LOCK_TO_CLOUD__ = window.location.origin;
+ }
+
+ function bootAt(search: string) {
+ window.history.replaceState({}, "", `/${search}`);
+ __resetActiveStoreForTests();
+ }
+
+ afterEach(() => {
+ delete (window as unknown as Record<string, unknown>)
+ .__AGENT_CANVAS_LOCK_TO_CLOUD__;
+ window.history.replaceState({}, "", "/");
+ });
+
+ it("opens on the org named in ?org= instead of the one Canvas remembered", () => {
+ lockToThisOrigin();
+ window.sessionStorage.setItem(
+ ACTIVE_BACKEND_STORAGE_KEY,
+ JSON.stringify({ backendId: LOCKED_CLOUD_BACKEND_ID, orgId: "org-test" }),
+ );
+
+ bootAt(`?${ORG_QUERY_PARAM}=org-personal`);
+
+ const { backend, orgId } = getActiveBackend();
+ expect(backend.id).toBe(LOCKED_CLOUD_BACKEND_ID);
+ expect(orgId).toBe("org-personal");
+ expect(
+ JSON.parse(
+ window.sessionStorage.getItem(ACTIVE_BACKEND_STORAGE_KEY) ?? "null",
+ ),
+ ).toEqual({ backendId: LOCKED_CLOUD_BACKEND_ID, orgId: "org-personal" });
+ });
+
+ it("drops ?org= from the address bar once it is honoured", () => {
+ lockToThisOrigin();
+
+ bootAt(`?tab=files&${ORG_QUERY_PARAM}=org-personal`);
+
+ expect(window.location.search).toBe("?tab=files");
+ });
+
+ it("ignores ?org= alone when Canvas is not locked to a cloud host", () => {
+ window.localStorage.setItem(
+ BACKENDS_STORAGE_KEY,
+ JSON.stringify([localBackend, cloudBackend]),
+ );
+ window.localStorage.setItem(
+ ACTIVE_BACKEND_STORAGE_KEY,
+ JSON.stringify({ backendId: cloudBackend.id, orgId: "org-test" }),
+ );
+
+ bootAt(`?${ORG_QUERY_PARAM}=org-personal`);
+
+ expect(getActiveBackend().orgId).toBe("org-test");
+ expect(window.location.search).toBe(`?${ORG_QUERY_PARAM}=org-personal`);
+ });
+});
diff --git a/__tests__/api/backend-registry/url-selection.test.ts b/__tests__/api/backend-registry/url-selection.test.ts
index 40e6cc53da..52ea49177a 100644
--- a/__tests__/api/backend-registry/url-selection.test.ts
+++ b/__tests__/api/backend-registry/url-selection.test.ts
@@ -1,8 +1,10 @@
import { describe, expect, it } from "vitest";
+import { LOCKED_CLOUD_BACKEND_ID } from "#/api/backend-registry/default-backend";
import {
BACKEND_QUERY_PARAM,
ORG_QUERY_PARAM,
readBackendSelectionFromUrl,
+ readLockedCloudOrgFromUrl,
withBackendSelectionParams,
} from "#/api/backend-registry/url-selection";
import type { Backend } from "#/api/backend-registry/types";
@@ -164,3 +166,46 @@ describe("readBackendSelectionFromUrl", () => {
).toBeNull();
});
});
+
+describe("readLockedCloudOrgFromUrl", () => {
+ const lockedCloud: Backend = {
+ id: LOCKED_CLOUD_BACKEND_ID,
+ name: "OpenHands Cloud",
+ host: "https://app.all-hands.dev",
+ apiKey: "",
+ kind: "cloud",
+ authMode: "cookie",
+ };
+
+ it("reads the org the cloud's web app hands back", () => {
+ expect(
+ readLockedCloudOrgFromUrl([lockedCloud], `?${ORG_QUERY_PARAM}=org-7`),
+ ).toEqual({ backendId: LOCKED_CLOUD_BACKEND_ID, orgId: "org-7" });
+ });
+
+ it("leaves a URL that also names a backend to readBackendSelectionFromUrl", () => {
+ expect(
+ readLockedCloudOrgFromUrl(
+ [lockedCloud],
+ `?${BACKEND_QUERY_PARAM}=${LOCKED_CLOUD_BACKEND_ID}&${ORG_QUERY_PARAM}=org-7`,
+ ),
+ ).toBeNull();
+ });
+
+ it("ignores the org when Canvas is not locked to a cloud host", () => {
+ expect(
+ readLockedCloudOrgFromUrl(
+ [localBackend, cloudBackend],
+ `?${ORG_QUERY_PARAM}=org-7`,
+ ),
+ ).toBeNull();
+ });
+
+ it("ignores an empty or absent org", () => {
+ expect(readLockedCloudOrgFromUrl([lockedCloud], "")).toBeNull();
+ expect(readLockedCloudOrgFromUrl([lockedCloud], "?tab=files")).toBeNull();
+ expect(
+ readLockedCloudOrgFromUrl([lockedCloud], `?${ORG_QUERY_PARAM}=`),
+ ).toBeNull();
+ });
+});
diff --git a/src/api/backend-registry/active-store.ts b/src/api/backend-registry/active-store.ts
index 8373cbdb87..3957b8b1da 100644
--- a/src/api/backend-registry/active-store.ts
+++ b/src/api/backend-registry/active-store.ts
@@ -9,6 +9,8 @@ import type { Backend, BackendSelection, ResolvedActiveBackend } from "./types";
import {
currentLocationSearch,
readBackendSelectionFromUrl,
+ readLockedCloudOrgFromUrl,
+ removeOrgFromCurrentUrl,
} from "./url-selection";
type Listener = () => void;
@@ -102,14 +104,20 @@ function computeSnapshot(
* parameters β€” keeps the same backend.
*/
function readInitialSelection(backends: Backend[]): BackendSelection | null {
- const fromUrl = readBackendSelectionFromUrl(
- backends,
- currentLocationSearch(),
- );
+ const search = currentLocationSearch();
+ const fromUrl = readBackendSelectionFromUrl(backends, search);
if (fromUrl) {
writeStoredActiveBackend(fromUrl);
return fromUrl;
}
+ // The cloud's web app names the org it had selected. Honour it once, then
+ // drop it so a reload keeps any org picked here afterwards.
+ const handedBack = readLockedCloudOrgFromUrl(backends, search);
+ if (handedBack) {
+ writeStoredActiveBackend(handedBack);
+ removeOrgFromCurrentUrl();
+ return handedBack;
+ }
return readStoredActiveBackend();
}
diff --git a/src/api/backend-registry/url-selection.ts b/src/api/backend-registry/url-selection.ts
index c6d4d20233..0461dcaac5 100644
--- a/src/api/backend-registry/url-selection.ts
+++ b/src/api/backend-registry/url-selection.ts
@@ -1,3 +1,4 @@
+import { LOCKED_CLOUD_BACKEND_ID } from "./default-backend";
import type { Backend, BackendSelection, ResolvedActiveBackend } from "./types";
/**
@@ -76,6 +77,46 @@ export function readBackendSelectionFromUrl(
return { backendId, orgId: orgId || null };
}
+/**
+ * Read the org the cloud's own web app hands back when it links here. Its
+ * "Back to App" link carries only `?org=<id>` β€” the parameter Canvas puts on
+ * its links into the cloud's Settings β€” because Canvas locked to that cloud
+ * host has a single backend. Anything else (no org, a backend named too, or
+ * no locked cloud backend) is left to the other readers.
+ */
+export function readLockedCloudOrgFromUrl(
+ backends: Backend[],
+ search: string,
+): BackendSelection | null {
+ if (!search) return null;
+ let params: URLSearchParams;
+ try {
+ params = new URLSearchParams(search);
+ } catch {
+ return null;
+ }
+ if (params.has(BACKEND_QUERY_PARAM)) return null;
+ const orgId = params.get(ORG_QUERY_PARAM);
+ if (!orgId) return null;
+ if (!backends.some((backend) => backend.id === LOCKED_CLOUD_BACKEND_ID)) {
+ return null;
+ }
+ return { backendId: LOCKED_CLOUD_BACKEND_ID, orgId };
+}
+
+/** Drop `?org=` from the address bar, keeping every other part of the URL. */
+export function removeOrgFromCurrentUrl(): void {
+ if (typeof window === "undefined") return;
+ const url = new URL(window.location.href);
+ if (!url.searchParams.has(ORG_QUERY_PARAM)) return;
+ url.searchParams.delete(ORG_QUERY_PARAM);
+ window.history.replaceState(
+ window.history.state,
+ "",
+ `${url.pathname}${url.search}${url.hash}`,
+ );
+}
+
/** The current tab's query string, or "" outside a browser. */
export function currentLocationSearch(): string {
if (typeof window === "undefined") return "";