File size: 32,319 Bytes
c0af099 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 | import { fireEvent, render, screen, waitFor } from "@testing-library/react";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { createRoutesStub } from "react-router";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { http, HttpResponse } from "msw";
import App, { links } from "#/root";
import { server } from "#/mocks/node";
import { __resetActiveStoreForTests } from "#/api/backend-registry/active-store";
import { LOCKED_CLOUD_BACKEND_ID } from "#/api/backend-registry/default-backend";
import { __resetHealthStoreForTests } from "#/api/backend-registry/health-store";
import {
BACKEND_HEALTH_STORAGE_KEY,
MAX_CONSECUTIVE_FAILURES,
} from "#/api/backend-registry/health-storage";
import { CLOUD_BACKEND_LOGGED_OUT_ERROR } from "#/hooks/query/use-backends-health";
import { ActiveBackendProvider } from "#/contexts/active-backend-context";
import { ONBOARDING_COMPLETED_STORAGE_KEY } from "#/components/features/onboarding/use-onboarding-completion";
const TRANSLATIONS: Record<string, string> = {
BACKEND$MANAGE_TITLE: "Manage backends",
BACKEND$RECONNECT_CLOUD_TITLE: "Reconnect to Cloud",
BACKEND$RECONNECT_CLOUD: "Reconnect to Cloud",
BACKEND$MANAGE_EMPTY: "No backends yet.",
BACKEND$ADD: "+ Add Backend",
BACKEND$LOG_BACK_IN: "Log back in",
BACKEND$LOGGED_OUT: "Logged out",
BACKEND$KIND_LOCAL: "Local",
BACKEND$KIND_CLOUD: "Cloud",
BACKEND$EDIT: "Edit",
BACKEND$REMOVE: "Remove",
HOME$DONE: "Done",
};
vi.mock("react-i18next", () => ({
useTranslation: () => ({
t: (key: string, options?: Record<string, string | number>) => {
let value = TRANSLATIONS[key] ?? key;
for (const [optionKey, optionValue] of Object.entries(options ?? {})) {
value = value.replaceAll(`{{${optionKey}}}`, String(optionValue));
}
return value;
},
}),
}));
vi.mock("#/components/features/onboarding/onboarding-modal", async () => {
const React = await import("react");
const { useNavigation } = await import("#/context/navigation-context");
return {
OnboardingModal: ({ onClose }: { onClose: () => void }) => {
const { navigate } = useNavigation();
return React.createElement(
"div",
{ "data-testid": "onboarding-modal" },
React.createElement("div", {
"data-testid": "onboarding-step-check-backend",
}),
React.createElement(
"button",
{
type: "button",
"data-testid": "mock-onboarding-launch",
onClick: () => {
navigate("/conversations/mock-conversation");
onClose();
},
},
"Launch conversation",
),
);
},
};
});
const ORIGINAL_LOCATION = window.location;
const RouterStub = createRoutesStub([
{
Component: App,
path: "/",
children: [
{
Component: () => <div data-testid="app-outlet">app outlet</div>,
path: "/",
},
{
Component: () => (
<div data-testid="conversation-outlet">conversation outlet</div>
),
path: "/conversations/:conversationId",
},
],
},
]);
const renderApp = (initialEntries: string[] = ["/"]) =>
render(<RouterStub initialEntries={initialEntries} />, {
wrapper: ({ children }) => (
<QueryClientProvider
client={
new QueryClient({
defaultOptions: { queries: { retry: false } },
})
}
>
<ActiveBackendProvider>{children}</ActiveBackendProvider>
</QueryClientProvider>
),
});
const COOKIE_DEPLOYMENT_ORIGIN = "https://pr-254.staging.openhands.dev";
/**
* Simulate an OHE-hosted Canvas: served from the locked Cloud host itself, so
* the single locked backend authenticates with the main-app session cookie.
* Returns the `window.location.assign` spy that observes login redirects.
*/
function mockLockedCookieDeployment() {
const assign = vi.fn();
Object.defineProperty(window, "location", {
configurable: true,
value: {
...ORIGINAL_LOCATION,
origin: COOKIE_DEPLOYMENT_ORIGIN,
hostname: "pr-254.staging.openhands.dev",
pathname: "/canvas",
search: "",
hash: "",
assign,
},
});
vi.stubEnv("VITE_LOCK_TO_CLOUD", COOKIE_DEPLOYMENT_ORIGIN);
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
__resetActiveStoreForTests();
return assign;
}
describe("App root agent-server availability guard", () => {
beforeEach(() => {
window.localStorage.clear();
__resetHealthStoreForTests();
vi.unstubAllEnvs();
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_AUTH_REQUIRED__;
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_LOCK_TO_CLOUD__;
(
window as unknown as Record<string, unknown>
).__AGENT_CANVAS_SESSION_API_KEY__ = "test-session-key";
__resetActiveStoreForTests();
});
afterEach(() => {
Object.defineProperty(window, "location", {
configurable: true,
value: ORIGINAL_LOCATION,
});
});
it("shows first-run onboarding before the auth gate when public mode has no backend key", async () => {
vi.stubEnv("VITE_AUTH_REQUIRED", "true");
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
window.localStorage.clear();
__resetActiveStoreForTests();
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("first-run-onboarding-screen"),
).toBeInTheDocument();
});
expect(await screen.findByTestId("onboarding-modal")).toBeInTheDocument();
expect(
await screen.findByTestId("onboarding-step-check-backend"),
).toBeInTheDocument();
expect(
screen.queryByTestId("api-key-entry-screen"),
).not.toBeInTheDocument();
});
it("shows first-run onboarding before the recovery modal when no backend is configured", async () => {
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
window.localStorage.clear();
__resetActiveStoreForTests();
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("first-run-onboarding-screen"),
).toBeInTheDocument();
});
expect(await screen.findByTestId("onboarding-modal")).toBeInTheDocument();
expect(
screen.queryByTestId("agent-server-onboarding-screen"),
).not.toBeInTheDocument();
expect(
screen.queryByTestId("manage-backends-modal"),
).not.toBeInTheDocument();
});
it("lets root-level onboarding navigate to the launched conversation before closing", async () => {
server.use(
http.get("*/server_info", () =>
HttpResponse.json({ uptime: 0, idle_time: 0, version: "1.28.1" }),
),
);
renderApp(["/"]);
fireEvent.click(await screen.findByTestId("mock-onboarding-launch"));
await waitFor(() => {
expect(screen.getByTestId("conversation-outlet")).toBeInTheDocument();
});
expect(window.localStorage.getItem(ONBOARDING_COMPLETED_STORAGE_KEY)).toBe(
"1",
);
expect(
screen.queryByTestId("first-run-onboarding-screen"),
).not.toBeInTheDocument();
});
it("shows first-run onboarding before the recovery modal when locked to Cloud with no backend", async () => {
vi.stubEnv("VITE_LOCK_TO_CLOUD", "https://app.all-hands.dev");
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
window.localStorage.clear();
__resetActiveStoreForTests();
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("first-run-onboarding-screen"),
).toBeInTheDocument();
});
expect(await screen.findByTestId("onboarding-modal")).toBeInTheDocument();
expect(
screen.queryByTestId("agent-server-onboarding-screen"),
).not.toBeInTheDocument();
expect(
screen.queryByTestId("manage-backends-modal"),
).not.toBeInTheDocument();
});
it("shows first-run onboarding when locked to Cloud even if a session API key is baked in", async () => {
// Reproduces Hiep's report on PR #1389: a pre-built bundle with a baked-in
// VITE_SESSION_API_KEY plus --lock-to-cloud used to seed a disconnected
// Local backend, which skipped onboarding and landed on the Manage Backends
// recovery modal. Locked mode must not seed a Local backend, so onboarding
// still owns the first-run Cloud login.
vi.stubEnv("VITE_LOCK_TO_CLOUD", "https://app.all-hands.dev");
vi.stubEnv("VITE_SESSION_API_KEY", "baked-session-key");
(
window as unknown as Record<string, unknown>
).__AGENT_CANVAS_SESSION_API_KEY__ = "baked-session-key";
window.localStorage.clear();
__resetActiveStoreForTests();
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("first-run-onboarding-screen"),
).toBeInTheDocument();
});
expect(await screen.findByTestId("onboarding-modal")).toBeInTheDocument();
expect(
screen.queryByTestId("agent-server-onboarding-screen"),
).not.toBeInTheDocument();
expect(
screen.queryByTestId("manage-backends-modal"),
).not.toBeInTheDocument();
// No Local backend should have been seeded into the registry.
expect(window.localStorage.getItem("openhands-backends")).toBeNull();
});
it("shows first-run onboarding when locked to Cloud with a stale persisted Local backend", async () => {
// A Local backend persisted from a previous non-locked session must not
// bypass onboarding once the deployment is locked to Cloud.
vi.stubEnv("VITE_LOCK_TO_CLOUD", "https://app.all-hands.dev");
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
window.localStorage.setItem(
"openhands-backends",
JSON.stringify([
{
id: "default-local",
name: "Local",
host: "http://127.0.0.1:8000",
apiKey: "stale-key",
kind: "local",
},
]),
);
window.localStorage.setItem(
"openhands-active-backend",
JSON.stringify({ backendId: "default-local", orgId: null }),
);
__resetActiveStoreForTests();
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("first-run-onboarding-screen"),
).toBeInTheDocument();
});
expect(await screen.findByTestId("onboarding-modal")).toBeInTheDocument();
expect(
screen.queryByTestId("manage-backends-modal"),
).not.toBeInTheDocument();
});
it("forces first-run onboarding in locked mode even when a stale Local backend reports a configured LLM", async () => {
// Critical regression for PR #1389 review: in locked-to-Cloud mode the
// stale Local backend must not bypass onboarding, even when it happens
// to report a configured LLM. The user must be routed through the Cloud
// login / replacement flow instead.
vi.stubEnv("VITE_LOCK_TO_CLOUD", "https://app.all-hands.dev");
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
window.localStorage.setItem(
"openhands-backends",
JSON.stringify([
{
id: "user-added-local",
name: "My agent-server",
host: "http://127.0.0.1:8000",
apiKey: "stale-key",
kind: "local",
},
]),
);
window.localStorage.setItem(
"openhands-active-backend",
JSON.stringify({ backendId: "user-added-local", orgId: null }),
);
__resetActiveStoreForTests();
server.use(
http.get("*/api/settings", () =>
HttpResponse.json({
llm_api_key_is_set: true,
agent_settings: {
llm: { model: "openai/gpt-5.5", api_key: "stored" },
},
}),
),
http.get("*/server_info", () =>
HttpResponse.json({ uptime: 0, idle_time: 0, version: "1.28.1" }),
),
);
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("first-run-onboarding-screen"),
).toBeInTheDocument();
});
expect(await screen.findByTestId("onboarding-modal")).toBeInTheDocument();
expect(
screen.queryByTestId("manage-backends-modal"),
).not.toBeInTheDocument();
// Backend readiness must NOT persist onboarding completion.
expect(
window.localStorage.getItem(ONBOARDING_COMPLETED_STORAGE_KEY),
).toBeNull();
});
it("forces first-run onboarding in locked mode when a Cloud backend points at a different host with a configured LLM", async () => {
// Companion to the stale-Local test: a Cloud backend on a *different*
// host than the locked Cloud host must also be forced through
// onboarding, even if it reports a configured LLM. `kind === "cloud"`
// alone is not enough — the host must match the locked host.
vi.stubEnv("VITE_LOCK_TO_CLOUD", "https://app.all-hands.dev");
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
const otherCloud = {
id: "other-cloud",
name: "Other Cloud",
host: "https://other-cloud.example.com",
apiKey: "other-token",
kind: "cloud",
};
window.localStorage.setItem(
"openhands-backends",
JSON.stringify([otherCloud]),
);
window.localStorage.setItem(
"openhands-active-backend",
JSON.stringify({ backendId: otherCloud.id, orgId: null }),
);
__resetActiveStoreForTests();
server.use(
http.get("*/api/settings", () =>
HttpResponse.json({
llm_api_key_set: true,
agent_settings: {
llm: { model: "openai/gpt-5.5" },
},
}),
),
http.get("*/server_info", () =>
HttpResponse.json({ uptime: 0, idle_time: 0, version: "1.28.1" }),
),
);
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("first-run-onboarding-screen"),
).toBeInTheDocument();
});
expect(await screen.findByTestId("onboarding-modal")).toBeInTheDocument();
expect(
window.localStorage.getItem(ONBOARDING_COMPLETED_STORAGE_KEY),
).toBeNull();
});
it("shows first-run onboarding when locked to Cloud even if onboarding was previously completed", async () => {
// Reproduces hieptl's report on PR #1389: the user had previously
// completed onboarding in a non-locked session (so the
// `openhands-onboarded` localStorage flag is set), then relaunched the
// static server with --lock-to-cloud. The stale completion flag used to
// suppress first-run onboarding, so the app fell through to the Manage
// Backends recovery modal ("Add Backend") instead of going straight to
// Cloud login. In locked-to-Cloud mode the completion flag must not
// bypass onboarding when the active backend is not a connected Cloud
// backend.
vi.stubEnv("VITE_LOCK_TO_CLOUD", "https://app.all-hands.dev");
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
window.localStorage.clear();
window.localStorage.setItem(ONBOARDING_COMPLETED_STORAGE_KEY, "1");
__resetActiveStoreForTests();
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("first-run-onboarding-screen"),
).toBeInTheDocument();
});
expect(await screen.findByTestId("onboarding-modal")).toBeInTheDocument();
expect(
screen.queryByTestId("agent-server-onboarding-screen"),
).not.toBeInTheDocument();
expect(
screen.queryByTestId("manage-backends-modal"),
).not.toBeInTheDocument();
});
it("shows the auth gate after onboarding was already completed", async () => {
vi.stubEnv("VITE_AUTH_REQUIRED", "true");
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
window.localStorage.clear();
window.localStorage.setItem(ONBOARDING_COMPLETED_STORAGE_KEY, "1");
__resetActiveStoreForTests();
renderApp(["/"]);
await waitFor(() => {
expect(screen.getByTestId("api-key-entry-screen")).toBeInTheDocument();
});
expect(screen.queryByTestId("onboarding-modal")).not.toBeInTheDocument();
});
it("shows the manage-backends modal when the connected server reports an old version", async () => {
window.localStorage.setItem(ONBOARDING_COMPLETED_STORAGE_KEY, "1");
server.use(
http.get("*/server_info", () =>
HttpResponse.json({ uptime: 0, idle_time: 0, version: "1.27.1" }),
),
);
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("agent-server-onboarding-screen"),
).toBeInTheDocument();
});
await waitFor(() => {
expect(screen.getByTestId("manage-backends-modal")).toBeInTheDocument();
});
expect(screen.queryByTestId("app-outlet")).not.toBeInTheDocument();
});
it("shows the manage-backends modal when the server omits a version field", async () => {
window.localStorage.setItem(ONBOARDING_COMPLETED_STORAGE_KEY, "1");
server.use(
http.get("*/server_info", () =>
HttpResponse.json({ uptime: 0, idle_time: 0 }),
),
);
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("agent-server-onboarding-screen"),
).toBeInTheDocument();
});
expect(screen.queryByTestId("app-outlet")).not.toBeInTheDocument();
});
it("shows the manage-backends modal when the backend is unreachable", async () => {
let serverInfoRequests = 0;
window.localStorage.setItem(ONBOARDING_COMPLETED_STORAGE_KEY, "1");
// Use "*" prefix to match both relative paths and absolute URLs (e.g.,
// http://127.0.0.1:8000/server_info) when VITE_BACKEND_BASE_URL is configured.
server.use(
http.get("*/server_info", () => {
serverInfoRequests += 1;
return HttpResponse.error();
}),
);
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("agent-server-onboarding-screen"),
).toBeInTheDocument();
});
// The onboarding placeholder now hosts the Manage Backends modal
// directly so the user can edit/add a backend immediately. The
// modal additionally probes /server_info per registered backend
// for its status dot + version label, so the request count is
// bounded but greater than the single config probe.
await waitFor(() => {
expect(screen.getByTestId("manage-backends-modal")).toBeInTheDocument();
});
expect(serverInfoRequests).toBeGreaterThanOrEqual(1);
expect(screen.queryByTestId("app-outlet")).not.toBeInTheDocument();
});
it("shows the manage-backends recovery modal when the active cloud backend is logged out", async () => {
const cloudBackend = {
id: "cloud-expired",
name: "OpenHands Cloud",
host: "https://app.all-hands.dev",
apiKey: "expired-token",
kind: "cloud",
};
window.localStorage.setItem(
"openhands-backends",
JSON.stringify([cloudBackend]),
);
window.localStorage.setItem(
"openhands-active-backend",
JSON.stringify({ backendId: cloudBackend.id, orgId: null }),
);
window.sessionStorage.setItem(
"openhands-active-backend",
JSON.stringify({ backendId: cloudBackend.id, orgId: null }),
);
window.localStorage.setItem(ONBOARDING_COMPLETED_STORAGE_KEY, "1");
__resetActiveStoreForTests();
server.use(
http.get("https://app.all-hands.dev/api/keys/current", () =>
HttpResponse.json({ detail: "NoCredentialsError" }, { status: 401 }),
),
);
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("agent-server-onboarding-screen"),
).toBeInTheDocument();
});
expect(screen.getByTestId("manage-backends-modal")).toBeInTheDocument();
expect(screen.getByText("Logged out")).toBeInTheDocument();
expect(
screen.getByRole("button", { name: "Log back in" }),
).toBeInTheDocument();
expect(screen.queryByTestId("app-outlet")).not.toBeInTheDocument();
});
it("shows locked Cloud reconnect recovery without add-backend controls", async () => {
vi.stubEnv("VITE_LOCK_TO_CLOUD", "https://app.all-hands.dev");
const cloudBackend = {
id: "cloud-expired",
name: "OpenHands Cloud",
host: "https://app.all-hands.dev",
apiKey: "expired-token",
kind: "cloud",
};
window.localStorage.setItem(
"openhands-backends",
JSON.stringify([cloudBackend]),
);
window.localStorage.setItem(
"openhands-active-backend",
JSON.stringify({ backendId: cloudBackend.id, orgId: null }),
);
window.sessionStorage.setItem(
"openhands-active-backend",
JSON.stringify({ backendId: cloudBackend.id, orgId: null }),
);
window.localStorage.setItem(ONBOARDING_COMPLETED_STORAGE_KEY, "1");
__resetActiveStoreForTests();
server.use(
http.get("https://app.all-hands.dev/api/keys/current", () =>
HttpResponse.json({ detail: "NoCredentialsError" }, { status: 401 }),
),
);
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByRole("heading", { name: "Reconnect to Cloud" }),
).toBeInTheDocument();
});
expect(screen.queryByTestId("manage-backends-add")).not.toBeInTheDocument();
expect(
screen.getByTestId("manage-backends-reconnect-cloud-login-button"),
).toHaveTextContent("Reconnect to Cloud");
expect(screen.queryByTestId("app-outlet")).not.toBeInTheDocument();
});
it("renders the routed page when the agent server is reachable", async () => {
window.localStorage.setItem(ONBOARDING_COMPLETED_STORAGE_KEY, "1");
renderApp(["/"]);
await waitFor(() => {
expect(screen.getByTestId("app-outlet")).toBeInTheDocument();
});
expect(
screen.queryByTestId("agent-server-onboarding-screen"),
).not.toBeInTheDocument();
});
it("shows first-run onboarding for the launcher-seeded default-local backend even when the agent-server reports a configured LLM", async () => {
// Regression for mock-llm-onboarding-regressions.spec.ts:16
// ("keeps the modal open on backdrop click and Escape") and
// mock-llm-auth-modes.spec.ts:57 ("reaches the onboarding modal
// without pre-seeded localStorage"). The shared mock-LLM
// agent-server retains a previously-configured LLM across browser
// sessions, so a genuinely fresh browser install (launcher-seeded
// default-local backend, no `openhands-onboarded` flag) must NOT
// have onboarding auto-marked complete by backend readiness.
vi.stubEnv("VITE_BACKEND_BASE_URL", "http://127.0.0.1:8000");
vi.stubEnv("VITE_SESSION_API_KEY", "test-session-key");
// The launcher-seeded default-local backend (id
// SEEDED_DEFAULT_BACKEND_ID) is created from these env stubs by
// readStoredBackends().
__resetActiveStoreForTests();
server.use(
http.get("*/api/settings", () =>
HttpResponse.json({
llm_api_key_is_set: true,
agent_settings: {
llm: { model: "openai/gpt-5.5", api_key: "stored" },
},
}),
),
http.get("*/server_info", () =>
HttpResponse.json({ uptime: 0, idle_time: 0, version: "1.28.1" }),
),
);
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("first-run-onboarding-screen"),
).toBeInTheDocument();
});
expect(screen.queryByTestId("app-outlet")).not.toBeInTheDocument();
expect(
window.localStorage.getItem(ONBOARDING_COMPLETED_STORAGE_KEY),
).toBeNull();
});
it("renders Cloud login directly for a fresh locked-to-Cloud first run", async () => {
vi.stubEnv("VITE_LOCK_TO_CLOUD", "https://app.all-hands.dev");
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
__resetActiveStoreForTests();
renderApp(["/"]);
await waitFor(() => {
expect(
screen.getByTestId("first-run-onboarding-screen"),
).toBeInTheDocument();
});
expect(await screen.findByTestId("onboarding-modal")).toBeInTheDocument();
expect(screen.getByTestId("add-backend-cloud-title")).toBeVisible();
expect(screen.getByTestId("add-backend-login-button")).toBeVisible();
expect(
screen.queryByTestId("onboarding-step-check-backend"),
).not.toBeInTheDocument();
expect(
screen.queryByTestId("onboarding-progress-bar"),
).not.toBeInTheDocument();
expect(screen.queryByTestId("add-backend-close")).not.toBeInTheDocument();
expect(
screen.queryByTestId("add-backend-advanced-toggle"),
).not.toBeInTheDocument();
expect(screen.queryByTestId("app-outlet")).not.toBeInTheDocument();
});
it("redirects unauthenticated locked-cookie deployments to main app login", async () => {
const assign = vi.fn();
Object.defineProperty(window, "location", {
configurable: true,
value: {
...ORIGINAL_LOCATION,
origin: "https://pr-254.staging.openhands.dev",
hostname: "pr-254.staging.openhands.dev",
pathname: "/canvas",
search: "?tab=home",
hash: "#top",
assign,
},
});
vi.stubEnv("VITE_LOCK_TO_CLOUD", "https://pr-254.staging.all-hands.dev");
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
server.use(
http.post("*/api/authenticate", () =>
HttpResponse.json({ error: "unauthenticated" }, { status: 401 }),
),
);
__resetActiveStoreForTests();
renderApp(["/"]);
await waitFor(() => {
expect(assign).toHaveBeenCalledWith(
"/login?returnTo=%2Fcanvas%3Ftab%3Dhome%23top",
);
});
expect(screen.queryByTestId("app-outlet")).not.toBeInTheDocument();
});
it("redirects to main app login when the cookie session expires after the Canvas loaded", async () => {
// Arrange: the session is valid at load, then expires — the Cloud probe
// starts returning 401 and the next main-app auth check confirms it.
const assign = mockLockedCookieDeployment();
let sessionExpired = false;
server.use(
http.post("*/api/authenticate", () =>
sessionExpired
? HttpResponse.json({ error: "unauthenticated" }, { status: 401 })
: HttpResponse.json({ ok: true }),
),
http.get(`${COOKIE_DEPLOYMENT_ORIGIN}/api/organizations`, () => {
sessionExpired = true;
return HttpResponse.json(
{ detail: "Not authenticated" },
{ status: 401 },
);
}),
);
// Act
renderApp(["/"]);
// Assert: main-app login, not the device-flow recovery modal.
await waitFor(() => {
expect(assign).toHaveBeenCalledWith("/login?returnTo=%2Fcanvas");
});
expect(
screen.queryByTestId("manage-backends-modal"),
).not.toBeInTheDocument();
expect(screen.queryByTestId("app-outlet")).not.toBeInTheDocument();
});
it("keeps a valid cookie session on the app when a stale logged-out health entry is persisted", async () => {
// Arrange: a previous visit left the locked backend persisted as disabled
// and "Logged out", but the user has since logged back in on the main app.
const assign = mockLockedCookieDeployment();
window.localStorage.setItem(
BACKEND_HEALTH_STORAGE_KEY,
JSON.stringify({
[LOCKED_CLOUD_BACKEND_ID]: {
consecutiveFailures: MAX_CONSECUTIVE_FAILURES,
lastError: CLOUD_BACKEND_LOGGED_OUT_ERROR,
lastFailureAt: 1,
disabled: true,
},
}),
);
__resetHealthStoreForTests();
server.use(
http.get(`${COOKIE_DEPLOYMENT_ORIGIN}/api/organizations`, () =>
HttpResponse.json({ items: [], current_org_id: null }),
),
);
// Act
renderApp(["/"]);
// Assert: the stale health verdict must not bounce a valid session to
// /login (which would loop back via returnTo); the app renders instead.
await waitFor(() => {
expect(screen.getByTestId("app-outlet")).toBeInTheDocument();
});
expect(assign).not.toHaveBeenCalled();
});
it("hides first-run onboarding immediately after Cloud login completes in locked-to-Cloud mode (no flicker)", async () => {
// Regression for hieptl's flicker report on PR #1389: after Cloud
// login succeeds in locked-to-Cloud mode, the onboarding modal's
// onClose marks onboarding complete. The root first-run gate must
// honor that completion IMMEDIATELY — without waiting for the Cloud
// settings probe to confirm a configured LLM — so the first-run
// screen disappears and the routed app renders, rather than the
// modal flickering back via OnboardingHost. This test simulates the
// post-login state (active locked Cloud backend + completion flag
// set by the modal's onClose) with the Cloud settings probe
// reporting NO configured LLM, which is exactly the window where
// the old LLM-readiness gate kept the first-run screen mounted and
// caused the reopen.
vi.stubEnv("VITE_LOCK_TO_CLOUD", "https://app.all-hands.dev");
vi.stubEnv("VITE_SESSION_API_KEY", "");
delete (window as unknown as Record<string, unknown>)
.__AGENT_CANVAS_SESSION_API_KEY__;
const lockedCloud = {
id: "locked-cloud",
name: "OpenHands Cloud",
host: "https://app.all-hands.dev",
apiKey: "cloud-session-key",
kind: "cloud",
};
window.localStorage.setItem(
"openhands-backends",
JSON.stringify([lockedCloud]),
);
window.localStorage.setItem(
"openhands-active-backend",
JSON.stringify({ backendId: lockedCloud.id, orgId: null }),
);
// The onboarding modal's onClose (markCompleted) sets this right
// after Cloud login succeeds — before the Cloud settings probe
// resolves. Seed it to reproduce the post-login moment.
window.localStorage.setItem(ONBOARDING_COMPLETED_STORAGE_KEY, "1");
__resetActiveStoreForTests();
// Cloud settings probe reports no configured LLM. The completed
// onboarding flag should still hide first-run onboarding once the
// locked Cloud backend is active.
server.use(
http.get("https://app.all-hands.dev/api/v1/settings", () =>
HttpResponse.json({ llm_api_key_set: false }),
),
http.get("https://app.all-hands.dev/api/keys/current", () =>
HttpResponse.json({ org_id: "org-1" }),
),
);
renderApp(["/"]);
// The first-run onboarding screen must NOT be mounted (no reopen),
// and the routed app must render instead.
await waitFor(() => {
expect(screen.getByTestId("app-outlet")).toBeInTheDocument();
});
expect(
screen.queryByTestId("first-run-onboarding-screen"),
).not.toBeInTheDocument();
expect(screen.queryByTestId("onboarding-modal")).not.toBeInTheDocument();
});
});
describe("App root document links", () => {
it("declares the SVG favicon used by the browser tab", () => {
// Act
const documentLinks = links();
// Assert
expect(documentLinks).toContainEqual({
rel: "icon",
type: "image/svg+xml",
href: "/favicon.svg",
});
});
it("prefixes document links when Canvas is mounted under a base path", () => {
// Arrange
vi.stubEnv("VITE_BASE_PATH", "/canvas");
// Act
const documentLinks = links();
// Assert
expect(documentLinks).toContainEqual({
rel: "icon",
type: "image/svg+xml",
href: "/canvas/favicon.svg",
});
vi.unstubAllEnvs();
});
});
|