File size: 17,465 Bytes
9b906ea | 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 | import React from "react";
import { useTranslation } from "react-i18next";
import { useMatch, useNavigate } from "react-router";
import { Plus, Settings } from "lucide-react";
import { Dropdown } from "#/ui/dropdown/dropdown";
import { DropdownOption } from "#/ui/dropdown/types";
import { getLockedCloudHost } from "#/api/agent-server-config";
import { isNoBackend } from "#/api/backend-registry/active-store";
import { useActiveBackendContext } from "#/contexts/active-backend-context";
import { useAllCloudOrganizations } from "#/hooks/query/use-cloud-organizations";
import { useCloudCurrentUserId } from "#/hooks/query/use-cloud-current-user-id";
import {
useBackendsHealth,
type BackendHealth,
} from "#/hooks/query/use-backends-health";
import { I18nKey } from "#/i18n/declaration";
import type { Backend } from "#/api/backend-registry/types";
// Import the trigger helpers from the lightweight store, not the overlay
// component, so the eagerly-mounted sidebar/backend-selector graph does not
// pull in the overlay's render code (the overlay is lazy-loaded from
// `routes/root-layout.tsx`).
import {
ENVIRONMENT_SWITCH_SETACTIVE_DELAY_MS,
triggerEnvironmentSwitch,
} from "#/components/features/backends/environment-switch-store";
import { NavigationLink } from "#/components/shared/navigation-link";
import { StyledTooltip } from "#/components/shared/buttons/styled-tooltip";
import { useConversationStore } from "#/stores/conversation-store";
import { AddBackendModal } from "./add-backend-modal";
import { BackendStatusDot } from "./backend-status-dot";
import { ManageBackendsModal } from "./manage-backends-modal";
import { cn } from "#/utils/utils";
import { formControlTransitionClassName } from "#/utils/form-control-classes";
import {
dropdownFooterActionClassName,
dropdownMenuListClassName,
dropdownMenuRowIconWrapperClassName,
} from "#/utils/dropdown-classes";
const VALUE_SEPARATOR = "::";
function makeOptionValue(backendId: string, orgId: string | null): string {
return orgId ? `${backendId}${VALUE_SEPARATOR}${orgId}` : backendId;
}
function parseOptionValue(value: string): {
backendId: string;
orgId: string | null;
} {
const [backendId, orgId] = value.split(VALUE_SEPARATOR);
return { backendId, orgId: orgId ?? null };
}
function buildStatusPrefix(health: BackendHealth | undefined) {
return <BackendStatusDot isConnected={health?.isConnected ?? null} />;
}
function buildNoBackendPrefix() {
return <BackendStatusDot isConnected="unavailable" />;
}
function buildOptions(
registered: Backend[],
personalWorkspaceLabel: string,
cloudOrgs: ReturnType<typeof useAllCloudOrganizations>,
currentUserIds: ReturnType<typeof useCloudCurrentUserId>,
healthByBackendId: Record<string, BackendHealth>,
): DropdownOption[] {
const options: DropdownOption[] = [];
const locals = registered.filter((b) => b.kind === "local");
const clouds = registered.filter((b) => b.kind === "cloud");
for (const b of locals) {
options.push({
value: makeOptionValue(b.id, null),
label: b.name,
prefix: buildStatusPrefix(healthByBackendId[b.id]),
});
}
for (const b of clouds) {
const entry = cloudOrgs[b.id];
const prefix = buildStatusPrefix(healthByBackendId[b.id]);
if (!entry || entry.orgs.length === 0) {
options.push({
value: makeOptionValue(b.id, null),
label: b.name,
prefix,
});
} else {
// Personal-workspace rule (per the cloud contract): the org whose
// id matches the calling user's id is the user's personal
// workspace. We resolve `user_id` once per backend (via /me on any
// one org) and apply it across all orgs of that backend.
const userIdForBackend = currentUserIds[b.id]?.userId ?? null;
for (const org of entry.orgs) {
const isPersonal = !!userIdForBackend && userIdForBackend === org.id;
const orgLabel = isPersonal ? personalWorkspaceLabel : org.name;
options.push({
value: makeOptionValue(b.id, org.id),
label: `${b.name} – ${orgLabel}`,
// All org rows for the same cloud backend share that backend's
// single connectivity verdict — there is no per-org probe.
prefix,
});
}
}
}
return options;
}
interface BackendSelectorProps {
/** Render the menu above the trigger (e.g. when pinned to bottom of sidebar). */
openUpward?: boolean;
/** Hide the selector input trigger and only render the dropdown menu. */
hideTrigger?: boolean;
/** Whether the dropdown menu should start open on mount. */
defaultOpen?: boolean;
/** Callback fired after selecting a backend/org option. */
onSelectOption?: () => void;
/**
* Override the internal Add Backend modal handling. When provided,
* clicking "Add Backend" calls this instead of opening BackendSelector's
* own modal. Useful when the selector is mounted inside an ephemeral
* container (e.g. the collapsed-sidebar popover) and the modal must
* survive the parent unmounting.
*/
onOpenAddBackend?: () => void;
/** Same as onOpenAddBackend but for the Manage Backends modal. */
onOpenManageBackends?: () => void;
/**
* Whether the surrounding sidebar rail is in its collapsed variant. Passed
* down from `SidebarRailBody` so the mobile drawer (which always renders
* the expanded rail) can override the persisted desktop value.
*/
sidebarCollapsed?: boolean;
}
export function BackendSelector({
openUpward = false,
hideTrigger = false,
defaultOpen = false,
onSelectOption,
onOpenAddBackend,
onOpenManageBackends,
sidebarCollapsed = false,
}: BackendSelectorProps = {}) {
const { t } = useTranslation("openhands");
const { backends, active, setActive } = useActiveBackendContext();
const cloudOrgs = useAllCloudOrganizations();
const currentUserIds = useCloudCurrentUserId();
// Probe each registered backend every 10s.
const healthByBackendId = useBackendsHealth(backends);
const navigate = useNavigate();
const settingsMatch = useMatch("/settings");
const settingsSubrouteMatch = useMatch("/settings/*");
const conversationMatch = useMatch("/conversations/:conversationId");
const automationDetailMatch = useMatch("/automations/:automationId");
const [addBackendModalOpen, setAddBackendModalOpen] = React.useState(false);
const [manageBackendsModalOpen, setManageBackendsModalOpen] =
React.useState(false);
const personalWorkspaceLabel = t(I18nKey.BACKEND$PERSONAL_WORKSPACE);
const options = React.useMemo(
() =>
buildOptions(
backends,
personalWorkspaceLabel,
cloudOrgs,
currentUserIds,
healthByBackendId,
),
[
backends,
personalWorkspaceLabel,
cloudOrgs,
currentUserIds,
healthByBackendId,
],
);
const noBackendSelected = isNoBackend(active.backend);
const noBackendLabel = t(I18nKey.BACKEND$NO_BACKEND_AVAILABLE);
const activeValue = makeOptionValue(active.backend.id, active.orgId);
const activeOption = noBackendSelected
? undefined
: options.find((o) => o.value === activeValue);
const isSettingsActive = Boolean(settingsMatch || settingsSubrouteMatch);
const settingsLabel = t(I18nKey.SIDEBAR$SETTINGS);
// `org` is consumed by the cloud settings loader so the page opens on the
// org that is active here instead of the cloud's last-used org.
const cloudSettingsOrgQuery = active.orgId
? `?org=${encodeURIComponent(active.orgId)}`
: "";
const isRightPanelShown = useConversationStore(
(state) => state.isRightPanelShown,
);
// When the sidebar rail is expanded, `placement="left"` hugs the main
// canvas and reads awkwardly; prefer above the control. When the rail is
// collapsed, keep left except on active conversation + open right drawer.
const settingsTooltipPlacement =
!sidebarCollapsed || (conversationMatch && isRightPanelShown)
? "top"
: "left";
const someCloudLoading = Object.values(cloudOrgs).some((c) => c.isLoading);
// Self-heal a malformed `(cloudBackendId, null)` selection.
//
// Once a cloud backend's orgs resolve, the dropdown only renders
// per-org rows for it — the `(backendId, null)` row disappears, so
// selecting that shape would drift from what the dropdown can render
// (UI says "Local", APIs hit cloud). When we detect the drift, snap
// the selection onto Cloud's current org first, then fall back to the
// personal workspace (or, lacking a /me result, the first org). The
// selection is recorded locally only; the cloud request scope follows
// from the X-Org-Id header sent by `callCloudProxy`, so the cloud UI's
// org choice is never mutated as a side effect.
React.useEffect(() => {
if (noBackendSelected || active.backend.kind !== "cloud" || active.orgId)
return;
const { backend } = active;
const entry = cloudOrgs[backend.id];
if (!entry || entry.orgs.length === 0) return;
const currentOrg = entry.currentOrgId
? entry.orgs.find((o) => o.id === entry.currentOrgId)
: undefined;
const userId = currentUserIds[backend.id]?.userId ?? null;
const personal = userId
? entry.orgs.find((o) => o.id === userId)
: undefined;
const target = currentOrg ?? personal ?? entry.orgs[0];
if (target) {
setActive(backend.id, target.id);
}
}, [active, cloudOrgs, currentUserIds, setActive, noBackendSelected]);
const openAddBackendModal = React.useCallback(() => {
if (onOpenAddBackend) {
onOpenAddBackend();
onSelectOption?.();
return;
}
setAddBackendModalOpen(true);
}, [onOpenAddBackend, onSelectOption]);
const openManageBackendsModal = React.useCallback(() => {
if (onOpenManageBackends) {
onOpenManageBackends();
onSelectOption?.();
return;
}
setManageBackendsModalOpen(true);
}, [onOpenManageBackends, onSelectOption]);
const isLockedToCloud = getLockedCloudHost() !== null;
// A cookie-auth (OHE-hosted) Canvas has nothing to add, manage, or
// reconnect — its single locked backend is owned by the main-app session.
const hideBackendFooter =
isLockedToCloud && active.backend.authMode === "cookie";
const preventDropdownMenuClose = React.useCallback(
(event: React.SyntheticEvent<HTMLButtonElement>) => {
event.preventDefault();
event.stopPropagation();
},
[],
);
const handleAddBackendClick = React.useCallback(
(event: React.MouseEvent<HTMLButtonElement>) => {
preventDropdownMenuClose(event);
openAddBackendModal();
},
[openAddBackendModal, preventDropdownMenuClose],
);
const handleAddBackendTouchEnd = React.useCallback(
(event: React.TouchEvent<HTMLButtonElement>) => {
preventDropdownMenuClose(event);
openAddBackendModal();
},
[openAddBackendModal, preventDropdownMenuClose],
);
const handleManageBackendsClick = React.useCallback(
(event: React.MouseEvent<HTMLButtonElement>) => {
preventDropdownMenuClose(event);
openManageBackendsModal();
},
[openManageBackendsModal, preventDropdownMenuClose],
);
const handleManageBackendsTouchEnd = React.useCallback(
(event: React.TouchEvent<HTMLButtonElement>) => {
preventDropdownMenuClose(event);
openManageBackendsModal();
},
[openManageBackendsModal, preventDropdownMenuClose],
);
const addBackendFooter = hideBackendFooter ? undefined : (
<div className={dropdownMenuListClassName}>
{isLockedToCloud ? null : (
<button
type="button"
data-testid="add-backend-menu-item"
onMouseDown={preventDropdownMenuClose}
onTouchStart={preventDropdownMenuClose}
onTouchEnd={handleAddBackendTouchEnd}
onClick={handleAddBackendClick}
className={cn(
dropdownFooterActionClassName,
"cursor-pointer rounded-md",
)}
>
<span className={dropdownMenuRowIconWrapperClassName} aria-hidden>
<Plus width={16} height={16} />
</span>
{t(I18nKey.BACKEND$ADD)}
</button>
)}
<button
type="button"
data-testid="manage-backends-menu-item"
onMouseDown={preventDropdownMenuClose}
onTouchStart={preventDropdownMenuClose}
onTouchEnd={handleManageBackendsTouchEnd}
onClick={handleManageBackendsClick}
className={cn(
dropdownFooterActionClassName,
"cursor-pointer rounded-md",
)}
>
<span className={dropdownMenuRowIconWrapperClassName} aria-hidden>
<Settings width={16} height={16} />
</span>
{t(
isLockedToCloud
? I18nKey.BACKEND$RECONNECT_CLOUD
: I18nKey.BACKEND$MANAGE,
)}
</button>
</div>
);
const handleSelectBackend = React.useCallback(
async (value: string) => {
if (value === activeValue) return;
const { backendId, orgId } = parseOptionValue(value);
const target = backends.find((b) => b.id === backendId);
if (!target) return;
triggerEnvironmentSwitch(
options.find((option) => option.value === value)?.label ?? target.name,
);
await new Promise<void>((resolve) => {
setTimeout(resolve, ENVIRONMENT_SWITCH_SETACTIVE_DELAY_MS);
});
// @spec BM-002 — Switching backends keeps the user on the same page
if (conversationMatch) navigate("/conversations");
else if (automationDetailMatch) navigate("/automations");
setActive(target.id, orgId);
onSelectOption?.();
},
[
activeValue,
backends,
conversationMatch,
automationDetailMatch,
navigate,
options,
setActive,
t,
onSelectOption,
],
);
return (
<>
<div className="flex items-center gap-2 w-full">
<div className="flex-1 min-w-0">
<Dropdown
testId="backend-selector"
key={`${activeValue}-${activeOption?.label ?? ""}`}
defaultValue={
activeOption ?? {
value: activeValue,
label: noBackendSelected ? noBackendLabel : active.backend.name,
prefix: noBackendSelected
? buildNoBackendPrefix()
: buildStatusPrefix(healthByBackendId[active.backend.id]),
}
}
footer={addBackendFooter}
openUpward={openUpward}
hideTrigger={hideTrigger}
defaultOpen={defaultOpen}
openOnHover={!hideTrigger}
onChange={(item) => {
if (!item) return;
void handleSelectBackend(item.value);
}}
placeholder={
noBackendSelected ? noBackendLabel : active.backend.name
}
loading={someCloudLoading}
options={options}
className="h-10 px-2 py-0 bg-transparent border-transparent hover:bg-[var(--oh-surface-raised)] focus-within:bg-[var(--oh-surface-raised)] focus-within:border-transparent focus-within:ring-0"
/>
</div>
{!hideTrigger ? (
<StyledTooltip
content={settingsLabel}
placement={settingsTooltipPlacement}
offset={10}
>
{active.backend.kind === "cloud" ? (
<a
href={`${active.backend.host.replace(/\/+$/, "")}/settings${cloudSettingsOrgQuery}`}
target={isLockedToCloud ? undefined : "_blank"}
rel={isLockedToCloud ? undefined : "noopener noreferrer"}
data-testid="backend-selector-settings-link"
aria-label={settingsLabel}
className={cn(
"inline-flex items-center justify-center shrink-0 w-9 h-9 rounded-md text-[var(--oh-muted)] hover:text-white hover:bg-[var(--oh-surface-raised)] cursor-pointer",
formControlTransitionClassName,
)}
>
<Settings width={16} height={16} />
</a>
) : (
<NavigationLink
to="/settings"
data-testid="backend-selector-settings-link"
data-active={isSettingsActive}
aria-label={settingsLabel}
className={
isSettingsActive
? cn(
"inline-flex items-center justify-center shrink-0 w-9 h-9 rounded-md bg-tertiary text-white font-normal cursor-pointer",
formControlTransitionClassName,
)
: cn(
"inline-flex items-center justify-center shrink-0 w-9 h-9 rounded-md text-[var(--oh-muted)] hover:text-white hover:bg-[var(--oh-surface-raised)] cursor-pointer",
formControlTransitionClassName,
)
}
>
<Settings width={16} height={16} />
</NavigationLink>
)}
</StyledTooltip>
) : null}
</div>
{addBackendModalOpen ? (
<AddBackendModal onClose={() => setAddBackendModalOpen(false)} />
) : null}
{manageBackendsModalOpen ? (
<ManageBackendsModal
onClose={() => setManageBackendsModalOpen(false)}
/>
) : null}
</>
);
}
|