github/OpenHands
1
0
Fork 0
mirror of https://github.com/OpenHands/OpenHands.git synced 2026-10-06 14:33:11 +08:00
Code Issues Packages Projects Releases Wiki Activity
7,571 Commits 1,487 Branches 181 Tags
14b1b1e8ad434475dc3677fd6f8351586ca00988
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Rohit Malhotraopenhandschuckbutkus
 		14b1b1e8ad feat: two auth modes — local (auto-key) and public (paste-key) (#790) 
* feat: two auth modes — local (auto-key) and public (paste-key)

Local mode (agent-canvas, no flags):
- Ingress binds to 127.0.0.1 only
- Auto-generates session API key
- Writes /backends.json to static dir so frontend auto-authenticates
- Zero setup for localhost use

Public mode (agent-canvas --public):
- Ingress binds to 0.0.0.0 (all interfaces)
- Requires LOCAL_BACKEND_API_KEY env var
- Does NOT write /backends.json
- Frontend shows API key entry screen on 401

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: reuse BackendForm in public-mode API key entry screen

Replace the bespoke ApiKeyEntryScreen form with BackendForm configured
for the public-auth use case:

- Host field is auto-filled from window.location.origin and read-only
- Name field is hidden (auto-derived from the existing backend)
- Only the API key input is exposed to the user
- Uses the same SettingsInput / BrandButton components as the backend
  connection modals for visual consistency

BackendForm gains three optional props to support this:
- hideName: hides the name input and uses a fallback name
- hostReadOnly: disables the host input
- onSubmitPayload: receives the submitted payload for side-effects
  (the API key screen uses it to persist to agent-server-config and
  reload the page)

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: update AGENTS.md with ApiKeyEntryScreen BackendForm reuse details

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: implement public mode auth flow (--public flag)

- Add --public flag to dev-with-automation.mjs and bin/agent-canvas.mjs
- In public mode: require LOCAL_BACKEND_API_KEY, use as session key,
  don't bake into frontend (no VITE_SESSION_API_KEY / --session-api-key)
- Add isAgentServerAuthError() to detect 401 from /server_info probe
- root.tsx shows ApiKeyEntryScreen when 401 detected (lazy loaded)
- useConfig skips retries on 401 for instant auth screen display
- ApiKeyEntryScreen now has default export for React.lazy compatibility

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use VITE_AUTH_REQUIRED flag instead of 401 detection for public mode

The 401-based approach was unreliable — /server_info may not require
auth on all server versions. Instead:

- dev-with-automation.mjs sets VITE_AUTH_REQUIRED=true in public mode
- isAuthRequiredAndMissing() checks the flag + localStorage for a key
- root.tsx gates on the flag BEFORE the /server_info probe, so the
  auth screen appears instantly with zero network round-trips
- 401 fallback kept as safety net for edge cases

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: handle stale key via 401 detection in public mode

When the server restarts with a new LOCAL_BACKEND_API_KEY, the browser
still has the old key in localStorage. isAuthRequiredAndMissing() returns
false (key exists), so the /server_info probe fires and 401s.

isAgentServerAuthError() now checks VITE_AUTH_REQUIRED=true AND 401
status, so it only triggers in public mode (a 401 in local mode is a
misconfiguration, not a key-rotation event). useConfig skips retries
on 401 to show the auth screen immediately.

Two gates, one screen:
- No key at all → flag check, instant, no network
- Stale key → /server_info 401, one round-trip

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: validate stale keys against GET /api/settings (protected)

/server_info is unprotected — it returns 200 even with a wrong key.
In public mode, after the /server_info probe succeeds, we now hit
GET /api/settings to verify the stored key is still valid. A 401
from that endpoint triggers the auth screen via isAgentServerAuthError().

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: rewrite ApiKeyEntryScreen — validate before save, always empty key, match add-modal UI

Three fixes:

1. Stale key conflict: The form now always starts with an empty API key
   field instead of pre-filling from the backend registry. Stale
   credentials from a previous session never bleed into the input.

2. Wrong key indicator: On submit, the key is validated against
   GET /api/settings (protected endpoint) BEFORE persisting. Wrong
   keys show an inline red status dot + 'Invalid API key' error
   via BackendStatusDot. Only validated keys trigger the reload.

3. UI parity with add-backend modal: Replaced BackendForm wrapper
   with direct SettingsInput fields matching ManualConnectionColumn's
   layout — host (read-only + helper text), API key (password with
   placeholder), status indicator, and Connect button. No cloud
   OAuth column.

New i18n key: AUTH$INVALID_KEY (all 15 languages).

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: match add-backend modal UI + add test coverage

ApiKeyEntryScreen now renders the exact same card chrome as
BackendFormModal add-mode: same title ('Add a Backend'), same
Name/Host/API Key fields, same Connect button styling. Host is
pre-filled and read-only; no cloud OAuth column.

New tests (12 total):
- api-key-entry-screen.test.tsx (7 tests):
  - UI field parity with add-backend modal
  - Stale key wipe (empty API key field despite stale localStorage)
  - Connect disabled until name + key filled
  - Valid key: validates → persists → reloads
  - Invalid key: error indicator, no persist, no reload
  - Retry flow: wrong key → error → correct key → success
  - Stale key isolation: only fresh key persisted
- agent-server-config.test.ts (5 new tests for isAuthRequiredAndMissing):
  - Flag unset → false
  - Flag set, no key → true
  - Flag set, localStorage key → false
  - Flag set, VITE_SESSION_API_KEY → false
  - Flag not 'true' → false

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: distinguish 401 from other errors in ApiKeyEntryScreen

The catch-all was showing 'Invalid API key' for EVERY failure —
including 500s, network errors, and timeouts — even when the key
was correct. Now:

- 401 → 'Invalid API key. Please check the key and try again.'
- Anything else → 'Connection failed: <actual error message>'

This reveals the real problem when a correct key fails for a
non-auth reason (e.g. server misconfiguration, missing OH_SECRET_KEY).

New i18n key: AUTH$CONNECTION_FAILED (all 15 languages).
New test: non-401 errors show 'Connection failed' + detail.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: agent-server receives wrong session key in public mode

startAgentServer() called buildSafeDevConfig() which generated its
own random session key, ignoring config.sessionApiKey (which holds
LOCAL_BACKEND_API_KEY in public mode). The agent-server was started
with a random key while users were told to paste the LOCAL_BACKEND_API_KEY
value — every key was rejected with 401.

Fix: override OH_SESSION_API_KEYS_0 in the agent-server env with
config.sessionApiKey so both the agent-server and the frontend
agree on which key is valid.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: address review comments on ApiKeyEntryScreen

1. Remove dead BackendFormProps (hideName, hostReadOnly, onSubmitPayload)
   — ApiKeyEntryScreen is standalone so no caller used these props.

2. Auto-generate backend name from window.location.hostname instead of
   requiring users to type one. Only the API key field is required now,
   reducing public-mode auth to a single-field flow.

3. Simplify redundant ternary: connectionStatus === 'success' ? true : false
   → connectionStatus === 'success'.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address second round of review comments

1. Use shared isSdkHttpError() helper in ApiKeyEntryScreen instead of
   duplicating the SDK error shape check inline. Exported the helper
   from agent-server-compatibility.ts.

2. Add code comment acknowledging the edge case where a network hiccup
   between /server_info and getSettings() probes lets the app load with
   an unvalidated key. Acceptable since the window is narrow and a page
   refresh recovers.

3. Add --auth-required flag to static-server.mjs so pre-built static
   binaries (npx @openhands/agent-canvas --public) show the API key
   entry screen without needing VITE_AUTH_REQUIRED baked in at build
   time. The flag injects window.__AGENT_CANVAS_AUTH_REQUIRED__=true
   into index.html at runtime. Frontend isAuthRequired() checks both
   the build-time env var and the runtime window flag.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use double cast (unknown) to satisfy strict TS on window flag access

window cannot be cast directly to Record<string, unknown> — TypeScript
requires going through unknown first for unrelated types.

  (window as unknown as Record<string, unknown>).__AGENT_CANVAS_AUTH_REQUIRED__

This fixes the CI typecheck failure introduced in aa76c01a.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address remaining review comments on auth modes PR

- Use isAuthRequired() instead of raw import.meta.env.VITE_AUTH_REQUIRED
  in isAgentServerAuthError() so the runtime window flag injected by
  static-server.mjs in pre-built binaries is also honoured (bug fix).

- Preserve existing backend name during re-authentication flow in
  ApiKeyEntryScreen; only fall back to window.location.hostname for
  the initial entry so users don't lose custom labels on key rotation.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: restore MCP-to-integrations migration from main

A prior merge into this branch incorrectly kept the old
@openhands/extensions/mcps imports instead of the
@openhands/extensions/integrations paths introduced by d41bfe15
on main. Restore all affected files from origin/main so the
extensions package (which no longer exports ./mcps) resolves
correctly.

Files restored from main:
- src/utils/mcp-marketplace-utils.ts
- src/routes/mcp.tsx
- src/components/features/mcp-logo-badge.tsx
- src/components/features/mcp-page/* (6 files)
- src/components/features/automations/* (2 files)
- __tests__/ (4 test files)

Co-authored-by: openhands <openhands@all-hands.dev>

* style: fix prettier formatting and remove unused eslint-disable in api-key-entry-screen

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address remaining PR review comments

- Extract isSdkHttpStatusError() helper in agent-server-compatibility.ts
  to DRY up the SDK error status check (review comment #3321202503).
  Both isAgentServerAuthError() and ApiKeyEntryScreen now use it.

- Use AUTH i18n keys in api-key-entry-screen.tsx:
  • Heading: AUTH$API_KEY_REQUIRED_TITLE ('API Key Required')
  • Description: AUTH$API_KEY_REQUIRED_DESCRIPTION added below heading
  • Button: AUTH$CONNECT ('Connect')
  (review comments #3325478721, #3325478729)

- Fix nested <main> landmark in root.tsx: remove the outer <main>
  wrapper since ApiKeyEntryScreen already provides its own semantic
  container (review comment #3325478704).

- Change ApiKeyEntryScreen root element from <main> to <div> so
  the Layout's own landmarks are not violated.

Co-authored-by: openhands <openhands@all-hands.dev>

* test: add coverage for window.__AGENT_CANVAS_AUTH_REQUIRED__ runtime flag

Add isAuthRequired() test block covering the window flag path used by
pre-built static binaries (static-server.mjs --auth-required). Also add
window-flag variants to isAuthRequiredAndMissing() tests.

Addresses review comment #3325587577.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor!: deduplicate SESSION_API_KEY into LOCAL_BACKEND_API_KEY

BREAKING CHANGE: The user-facing env var for setting the API key is now
`LOCAL_BACKEND_API_KEY` everywhere. The old `SESSION_API_KEY`,
`OH_SESSION_API_KEYS_0`, and `VITE_SESSION_API_KEY` env vars are no
longer read by launchers as user-facing configuration.

Internal plumbing (`config.sessionApiKey`, `VITE_SESSION_API_KEY` build
injection, `OH_SESSION_API_KEYS_0` agent-server env) is unchanged — only
the user-facing surface is unified into a single env var.

Changes:
- scripts/dev-safe.mjs: read LOCAL_BACKEND_API_KEY instead of
  SESSION_API_KEY / OH_SESSION_API_KEYS_0 / VITE_SESSION_API_KEY
- scripts/dev-with-automation.mjs: unify key resolution through
  buildSafeDevConfig for both public and local modes
- bin/agent-canvas.mjs: update CLI help text and examples
- docker/entrypoint.sh: read LOCAL_BACKEND_API_KEY, migrate legacy
  session-api-key.txt → api-key.txt
- scripts/static-server.mjs: add mutual-exclusion guard for
  --session-api-key + --auth-required flags
- playwright configs: pass LOCAL_BACKEND_API_KEY instead of the old trio
- test helpers: prefer LOCAL_BACKEND_API_KEY fallback chain
- Update tests and documentation

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address review comments — narrow settings probe rethrow and use shared client options

- loadAgentServerInfo: narrow getSettings() catch to rethrow only 401
  errors. Other HTTP errors (403, 5xx) and non-HTTP errors (network,
  timeout) are now swallowed with a console.warn, since the server is
  confirmed up (via /server_info) and the probe is best-effort. This
  prevents misconfigured servers from silently falling through to
  <Outlet /> without showing either the auth or unavailable screen.

- ApiKeyEntryScreen: replace hand-rolled SettingsClient options with
  getAgentServerClientOptions() so transport-level settings (e.g.
  VITE_INSECURE_SKIP_VERIFY) are honoured. Uses the sessionApiKey
  override to pass the freshly-entered key.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: rewrite git+ssh to git+https for @openhands/extensions in lockfile

npm normalizes GitHub URLs to git+ssh:// in the lockfile, but machines
without SSH keys for GitHub (or with stale npm caches) can end up
installing a wrong version of the package. This causes the Vite resolve
error:

  "./integrations" is not exported under the conditions [...]

The same pattern was already fixed for @openhands/typescript-client
(see #384). vercel-install.sh already does a blanket sed rewrite, but
the committed lockfile itself should use git+https:// so local npm ci
works without SSH keys.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: align public auth screen with Add Backend form layout

Replace the custom 'API Key Required' screen with the same form
layout used by the 'Add a Backend' left column in BackendFormModal:

- Heading changed from 'API Key Required' to 'Add a Backend'
- Added backend Name field (required, same as ManualConnectionColumn)
- Host field remains pre-filled and disabled (from window.location.origin)
- API Key field unchanged
- Submit button now uses BACKEND$CONNECT label (matching the modal)
- Removed the subtitle description paragraph for cleaner parity
- Name is persisted to the backend registry on submit

Tests updated: fillApiKey → fillRequiredFields (name + apiKey),
assertions cover the new name field and dual-field submit gating.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: remove unused AUTH$ i18n keys from this PR

The UI refactor (02faa0b0) switched ApiKeyEntryScreen to the
BACKEND$* keys. Drop the three AUTH$ entries that were introduced
and then superseded within this same PR:

- AUTH$API_KEY_REQUIRED_TITLE
- AUTH$API_KEY_REQUIRED_DESCRIPTION
- AUTH$CONNECT

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: sync stale session API key on boot when LOCAL_BACKEND_API_KEY changes

When a user restarts the stack with a different LOCAL_BACKEND_API_KEY,
the new VITE_SESSION_API_KEY is baked in correctly, but localStorage
may still hold the old key in two places:

  1. openhands-agent-server-config.sessionApiKey (written by onboarding
     or the Settings page)
  2. openhands-backends[].apiKey (seeded on first load, never re-synced)

The existing syncDefaultLocalBackendAuth() in storage.ts already tries
to fix #2 by comparing against makeDefaultLocalBackend(), but that
function reads through getConfiguredSessionApiKey() which hits #1
(stale localStorage) before falling back to VITE_SESSION_API_KEY.
So a stale #1 defeats the #2 sync.

Fix: add syncBakedSessionApiKey() which runs from readStoredBackends()
before any key resolution. When VITE_SESSION_API_KEY is set and the
stored key in openhands-agent-server-config differs, overwrite it.
This ensures getConfiguredSessionApiKey() and makeDefaultLocalBackend()
both return the correct key, and the downstream backend-registry sync
works as intended.

Also fix the static-server.mjs injection script to always overwrite a
stored key that differs from the runtime key (was guarded by
`if(!_c.sessionApiKey)` which skipped updates when any key existed).

Add mock-LLM E2E tests for:
- Key rotation recovery: seeds stale localStorage, verifies app loads
- Public-mode auth gate: tests auth screen visibility, wrong key
  rejection, and correct key acceptance

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: document key rotation resilience in AGENTS.md

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add syncBakedSessionApiKey to vi.mock stubs and use click-then-fill in E2E

Three test files mock #/api/agent-server-config without exporting
syncBakedSessionApiKey, which storage.ts now calls at import time.
Add the missing vi.fn() stub to all three.

Also fix the public-mode auth E2E test: use the click() → fill()
pattern for React controlled inputs (matching the established
convention in mock-llm-conversation.spec.ts) so the SettingsInput
onChange fires reliably in Playwright.

Co-authored-by: openhands <openhands@all-hands.dev>

* test: add public-mode key rotation E2E test

Simulates a server key rotation: localStorage holds a stale key from
a previous session, the server now has a new key. Verifies the app
detects the 401 from the stale key probe, shows the auth screen, and
accepts the new key.

Flow: stale key in localStorage → probe /server_info → 401 →
isAgentServerAuthError → ApiKeyEntryScreen → user pastes new key →
reload → app loads normally.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(e2e): suppress consent modal in public-mode auth tests

The analytics consent modal overlays the auth screen on first visit
(clean localStorage). Playwright's click() on the form inputs was
intercepted by the modal overlay, causing a 60s timeout loop (121
retries). Add a beforeEach that seeds 'analytics-consent' and
'openhands-telemetry-consent' in localStorage before navigation.

Also deduplicate the consent seeding from the key-rotation test's
addInitScript since the beforeEach now handles it.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: deduplicate readStoredConfig() call in syncBakedSessionApiKey

Capture the first readStoredConfig() result and reuse it in the
spread instead of hitting localStorage twice.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore(docker): remove legacy session-api-key.txt migration

The backwards-compatibility shim that migrated the old
session-api-key.txt to api-key.txt is no longer needed — a breaking
change here is acceptable.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: dedup ApiKeyEntryScreen against BackendForm

ApiKeyEntryScreen now renders BackendForm with three new props instead
of reimplementing the name/host/API-key inputs from scratch:

- hostReadOnly: locks the host field (pre-filled from window.origin)
- requireApiKey: forces a non-empty API key for local backends
- onSubmitOverride: replaces the default sync persist with async
  server-side validation (GET /api/settings) before persisting

The auth-gate-specific chrome (full-screen wrapper, connection status
indicator, validating/error state) stays in ApiKeyEntryScreen via the
existing renderActions slot.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: chuckbutkus <chuck@openhands.dev>
 2026-06-01 12:02:37 -06:00
Rohit Malhotraandopenhands e256bd3b7f test(mock-llm): strengthen E2E coverage for conversation and automation flows (#940) 
* test(mock-llm): strengthen E2E coverage for conversation and automation flows

Conversation test additions (mock-llm-conversation.spec.ts):
- Step 2: verify settings API reflects active profile's llm.model and base_url
- Step 3: intercept POST /api/conversations and assert worktree:true in payload
- Step 3: verify user message is visible in a user-message element
- Step 3: verify conversation appears in sidebar with correct link
- Step 4 (new): resume conversation from sidebar after navigating away,
  verify agent reply and user message are still visible

Automation test additions (mock-llm-automation.spec.ts):
- Step 3: verify active-status-badge-active is visible on detail page
- Step 3: verify cron schedule (or human-readable equivalent) on detail page

Addresses coverage gaps from issue #511 'I can' statements:
- I can start the Agent Canvas (conversation in sidebar)
- worktree flag in conversation creation payload
- I can create conversations, list and resume them
- Activate profile -> settings API reflects model
- I can run automations on a schedule (UI verification)

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address review comments on mock-LLM test coverage PR

1. Tighten URL filter: use exact pathname match (new URL(...).pathname ===
   '/api/conversations') instead of broad .includes() to avoid capturing
   sub-path POSTs like /api/conversations/{id}/messages.

2. Extract hardcoded user message to module-level USER_MESSAGE constant
   so step 3 and step 4 stay in sync automatically.

3. Replace overly broad cron schedule assertion (full-page text scan with
   fallback strings) with a scoped page.getByText(CRON_SCHEDULE) check.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: remove redundant add() in step 4 and clean up request listener

- Remove no-op conversationIds.add(step3ConversationId) in step 4 — the
  ID is already tracked from step 3 and afterAll handles its cleanup.
- Extract page.on('request') handler to a named function and call
  page.off() after the conversation URL is captured.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use test.skip for step 3 guard and native locator for user message check

- Replace expect().toBeTruthy() with test.skip() so step 4 is skipped
  (not failed) when step 3 didn't complete.
- Replace expect.poll + page.evaluate with Playwright-native
  locator().filter({ hasText }).toBeVisible() for the user message
  assertion in step 4.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: correct stale error message to reference page.on listener

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-29 18:49:20 +00:00
Rohit Malhotraandopenhands c1107a3650 Enable video recording for all mock-LLM E2E tests (#937) 
Change video mode from 'retain-on-failure' to 'on' so that .webm
recordings are kept for every test run, not just failures.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-29 16:49:13 +00:00
Rohit Malhotraandopenhands 86f3fcfa8e feat: add mock-LLM e2e test for automation creation and run dispatch (#905) 
* feat: add mock-LLM e2e test for automation creation and run dispatch

Add a new e2e test spec (mock-llm-automation.spec.ts) that exercises the
full automation lifecycle through the UI and mock LLM:

1. Navigates to the Automations page
2. Clicks 'Add Automation' → 'Create Automation' to launch a conversation
3. Mock LLM returns scripted terminal tool calls that:
   - curl POST to create a cron automation (echo hello world at 9am daily)
   - curl POST to dispatch a run using the created automation ID
4. Verifies the automation was created correctly (name, schedule, enabled)
5. Verifies the dispatched run reaches COMPLETED status
6. Verifies the automation appears on the automations page

Supporting changes:

- Mock automation server (mock-automation-server.py): Lightweight Python
  HTTP server implementing automation API endpoints in-memory with
  auto-completing runs (~0.5s PENDING → RUNNING → COMPLETED)

- Mock LLM server admin API: Added /admin/reset, /admin/trajectory/register,
  and /admin/trajectory/activate endpoints so tests can inject custom
  trajectories per test scenario

- Playwright config: Added mock automation server as additional webServer
  (port 18299)

- Test helpers: Added routeAutomationApiToMock() (Playwright page.route
  proxy), ensureMockLLMProfile() (API-based profile setup), trajectory
  registration/activation helpers, and automation verification helpers

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: scope modal button click and reset LLM trajectory between test suites

- Scope 'Create Automation' click to the modal element to avoid strict
  mode violation (empty-state page also renders a button with the same
  testId)
- Reset mock LLM to default trajectory at the start of conversation
  test step 3, preventing failures when the automation test's custom
  trajectory wasn't fully consumed due to earlier test failures

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use home chat launcher instead of modal auto-submit for automation test

The Automations modal's 'Create Automation' button uses
useLaunchSkillInChat which navigates to /conversations and sets
messageToSend in the Zustand store. However, the home page's
ChatInputLogic explicitly nullifies messageToSend when there is no
active conversationId, so the message never auto-submits.

Rewrite step 2 to type the prompt directly into the home chat launcher
and click submit — the same path real users take. This bypasses the
broken modal→store→auto-submit chain and reliably creates a
conversation.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: use real automation backend instead of mock server

Remove the mock automation server and Playwright route interception.
The automation test now hits the real automation backend running inside
the bin/agent-canvas.mjs stack (through the ingress proxy).

Key changes:
- Terminal curl commands use $OPENHANDS_AUTOMATION_API_KEY for auth
  and hit the ingress URL for the automation API
- Verification queries go through the real /api/automation/v1 endpoints
  with X-Session-API-Key auth
- Removed mock-automation-server.py and all mock automation helpers
- Removed MOCK_AUTOMATION_PORT from Playwright config
- Test is fully e2e: mock LLM → real agent-server → real automation
  backend

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add retry logic for automation backend startup delay

The Playwright webServer health check passes once the ingress serves
the static frontend, but the automation backend (started via uvx) may
still be initializing. This caused 502 errors when the test tried to
list automations immediately.

Changes:
- listAutomations retries on 502/503 up to 30 times (60s)
- listAutomationRuns returns empty on non-OK responses (waitForRunStatus
  retries anyway)
- Step 1 waits for the automation backend to be ready before registering
  the trajectory
- Increased timeouts for steps 1 (120s) and 2 (180s)

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: wait for automation backend before starting tests

Change the Playwright webServer URL check from the ingress root (/) to
the automation API endpoint (/api/automation/v1). This ensures Playwright
waits for the full stack — agent-server + automation backend + ingress —
to be ready before running tests.

The automation backend is the last service to start (installed via uvx
from PyPI) and can take 30-60s in CI. The previous root URL check only
verified the ingress served static files, allowing tests to begin while
the automation backend was still initializing (returning 502).

Playwright accepts 2xx, 3xx, and 400-403 as 'ready' responses, so the
401 from an unauthenticated GET to the automation endpoint correctly
signals readiness.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: pre-warm automation backend in CI and fix 0-test reporter

Two fixes for the mock-LLM E2E automation test:

1. CI workflow: pre-install openhands-automation into the uvx cache
   before the Playwright run starts. Without this, the automation
   backend's first-time uvx install (~60-90s for boto3, google-cloud,
   etc.) exceeded the 180s Playwright webServer timeout.

2. Done-marker reporter: treat 0 completed tests as a failure. The
   previous logic defaulted allPassed=true, so a webServer timeout
   (0 tests ran) wrote .all-passed and the CI wrapper reported success.

3. Playwright webServer URL probes the automation endpoint through the
   ingress (/api/automation/v1) instead of the root (/). This ensures
   ALL services are up before tests start — the automation backend is
   the last to start.

Co-authored-by: openhands <openhands@all-hands.dev>

* debug: capture agent-canvas startup logs for CI diagnostics

Tee the agent-canvas binary output to a log file that gets uploaded
as a CI artifact. This exposes the full startup sequence including
agent-server, automation backend, and ingress startup messages that
are currently invisible due to Playwright's single-line ANSI rendering.

Also bumped webServer timeout to 300s and global timeout to 900s.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use absolute path for state dir to fix automation DB crash

Root cause: the automation backend's SQLite DB URL was derived from a
RELATIVE state dir path (.tmp/mock-llm-state). Since the automation
child process also has its cwd set to the state dir, the DB path
resolved to the nested path:
  .tmp/mock-llm-state/.tmp/mock-llm-state/automations.db
which doesn't exist → sqlite3.OperationalError → backend never starts.

Fix: resolve() the state dir to an absolute path so the DB URL works
regardless of the child process cwd.

Also reverts the diagnostic tee/timeout changes from the previous commit
since the root cause is now identified.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use X-Session-API-Key for automation API auth in curl commands

The automation backend authenticates via X-Session-API-Key header (set by
AUTOMATION_LOCAL_API_KEY env var), matching the frontend's automation
service. The previous Authorization: Bearer header was not accepted.

The env var $OPENHANDS_AUTOMATION_API_KEY carries the session API key
value (injected by buildAgentServerAutomationEnv in dev-with-automation.mjs)
and is inherited by the terminal tool's bash subprocess.

Co-authored-by: openhands <openhands@all-hands.dev>

* debug: add verbose curl output to diagnose automation API failures

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: hardcode session API key in curl commands

The agent-server terminal tool may not inherit all parent process env
vars (the SDK sandboxes the execution environment). Hardcoding the
session API key directly in the curl commands ensures authentication
works regardless of the terminal's env setup.

Co-authored-by: openhands <openhands@all-hands.dev>

* debug: dump conversation events to diagnose terminal command output

Add a diagnostic step that fetches all conversation events via the
API and logs terminal command outputs, so we can see what the curl
command actually returned inside the agent-server terminal.

Co-authored-by: openhands <openhands@all-hands.dev>

* debug: dump raw event JSON for diagnostics

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add padding response for internal pre-agent LLM call

The agent-server makes an internal LLM call (likely condenser or
skill analysis) before the agent's main loop starts, which consumes
one scripted response. Add a throwaway empty text response at the
start of the automation trajectory so the agent's first real turn
gets the correct create command.

Also improves diagnostic event dump to show raw JSON.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: accept any run status for dispatched automation verification

The dispatched automation run won't reach COMPLETED in mock LLM mode
because the automation's conversation needs additional LLM responses
that would exhaust the mock server. Verify that a run was dispatched
(exists with any valid status) instead of waiting for COMPLETED.

Also adds waitForAnyRun helper and removes diagnostic event dump.

Key fixes in this commit series:
- Padding response for internal pre-agent LLM call (condenser)
- Hardcoded session API key in curl commands
- X-Session-API-Key auth header (matching frontend convention)
- waitForAnyRun instead of waitForRunStatus COMPLETED

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: move mock LLM reset to afterEach; fix automations page wait

- Move resetMockLLM() from a cleanup test into afterEach so it always
  runs even when preceding serial tests fail. This prevents the
  conversation test suite from getting exhausted mock LLM responses.

- Replace instant page.textContent check with Playwright's auto-retry
  expect(getByText).toBeVisible for the automations page load.

- Remove now-redundant cleanup test.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: defer automation cleanup to step 3 so list page verification works

afterEach was deleting the automation after step 2, so step 3's
navigation to /automations found an empty list. Move automation
deletion into step 3's final cleanup sub-step. Conversations and
mock LLM reset still happen in afterEach.

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: update AGENTS.md with automation e2e learnings

Document the real automation backend approach, padding response
requirement for skill-activated conversations, and afterEach mock
LLM reset pattern.

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: verify run COMPLETED + conversation link click-through

Strengthen the automation e2e test to verify the full lifecycle:

- Add extra mock LLM responses (indices 4-6) for the automation run's
  spawned conversation so it can complete and fire the callback
- Wait for run status COMPLETED (not just any status)
- Assert the completed run has a conversation_id
- Navigate to automation detail page and verify the COMPLETED badge
- Click the run's conversation link and verify it navigates to
  /conversations/{id}

This exercises:
  1. Automation creation via terminal curl → real backend
  2. Run dispatch → real backend starts a new conversation
  3. Run completion → automation script fires callback → COMPLETED
  4. UI list page → detail page → run conversation link click-through

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use data-testid for run status badge, not translated text

RunStatusBadge renders i18n 'Successful' (not 'Completed') for
completed runs. Use the stable data-testid='run-status-icon-completed'
instead of fragile text matching.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: handle multiple conversation link elements in run detail

The automation detail page may render multiple <a> elements with the
same conversation href (e.g. header + activity row). Use .first() to
select and click the first matching link.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address review comments

1. mock-llm-server.py: add explicit 404 for unknown POST paths so
   typos in admin endpoints produce a clear error instead of silently
   falling through to the LLM completion handler.

2. mock-llm-automation.spec.ts: expand the padding response comment
   to document the specific agent-server feature (skill-activation
   pipeline) that triggers it, why the conversation test doesn't need
   it, and how misalignment manifests as a fast timeout failure.

3. mock-llm-automation.spec.ts: add test.afterAll safety net to
   delete leftover automations even if step 3 fails before its
   cleanup sub-step runs.

4. mock-llm-helpers.ts: include active_profile in the PATCH payload
   so ensureMockLLMProfile actually guarantees the named profile is
   activated, not just that settings are applied to whatever profile
   happens to be active.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address second round of review comments

1. Fix stale JSDoc on listAutomations — now correctly notes the
   health check probes /api/automation/v1 and retries are a safety net.

2. listAutomationRuns throws immediately on non-retriable HTTP errors
   (401, 500, etc.) instead of silently returning empty results that
   cause confusing timeouts. Only 502/503 are treated as retriable.

3. Warn on malformed trajectory turns — _parse_trajectory_turns now
   prints a stderr warning when a turn has neither 'tool_call' nor
   'text', making typos like 'tool_calls' visible at registration
   time instead of producing a confusing 'Mock LLM exhausted' error.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: revert active_profile in PATCH — breaks conversation test profile flow

The agent-server's PATCH /api/settings with active_profile created a
profile via API that conflicted with the conversation test's UI-based
profile creation flow. The conversation test's step 2 ('Set as active')
failed because the profile state was inconsistent.

Reverted to the original approach: ensureMockLLMProfile configures LLM
settings on whatever profile is currently active, without creating or
switching profiles. Updated the early-return check to compare model and
base_url instead of profile name, and expanded the JSDoc to clarify
this is NOT a profile management function.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address third round of review comments

1. Confirm probe URL returns 200 without auth — added comment in
   playwright.mock-llm.config.ts explaining the automation list
   endpoint serves 200 unauthenticated (confirmed in CI).

2. _read_body JSON error handling — wrap json.loads in try/except
   and return 400 invalid_json on malformed payloads. Replace
   __import__('threading') with a normal top-level import.

3. Remove unasserted token constants — AUTOMATION_CREATE_TOKEN and
   AUTOMATION_DISPATCH_TOKEN were never asserted; inline the printf
   breadcrumbs and add a comment clarifying AUTOMATION_REPLY_TOKEN
   is the only asserted token.

4. Capture remaining_responses inside the lock — consistent with
   the threaded-safety pattern even though HTTPServer is single-
   threaded. Applied to both /admin/reset and /admin/trajectory/activate.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address fourth round of review comments

1. Add explicit assertion that runConversationId is set before the
   click-through verification in step 3 — prevents silent pass when
   step 2 fails before populating the ID.

2. Fix _read_body double-response on malformed JSON: return None
   instead of {} on parse failure, add guards in both callers
   (/admin/trajectory/register and /admin/trajectory/activate) to
   return early when body is None (error already sent).

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address fifth round of review suggestions

1. /admin/reset now clears _named_trajectories so the server
   returns to full initial state.

2. Malformed trajectory turns raise ValueError immediately at
   registration time instead of silently skipping — caught in
   the register handler and returned as 400 bad_request.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: move resetMockLLM from afterEach to afterAll

The /admin/reset endpoint now clears _named_trajectories (previous
fix), which broke the serial step flow: step 1 registers the
trajectory, afterEach cleared it, step 2 tried to activate it → 404.

Moving the reset to afterAll preserves named trajectories across
the serial steps while still cleaning up after the full suite.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: address PR review feedback (#905)

- Document cumulative wait budget for step 2 timeout (180s) and note
  fallback to 240s if CI proves flaky
- Add clarifying comment for defensive re-activation of trajectory
  at the start of step 2 (belt-and-suspenders pattern)

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-29 16:06:33 +00:00
Rohit Malhotraandopenhands 6d1e793e6e docs: update README version to 1.0.0-alpha.8 and add README step to release skill (#931) 
- Update Docker image tags in README from alpha.6 to alpha.8
- Add step 2c to release skill for updating README version references
- Add README update to PR checklist template

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-29 11:01:02 -04:00
Rohit Malhotra f7005a02af fix: use PAT in create-release.yml so downstream workflows trigger (#921) 2026-05-28 20:28:33 -04:00
Rohit Malhotraandopenhands 7c7d78900e chore: bump version to 1.0.0-alpha.8 (#920) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-28 23:51:57 +00:00
Rohit Malhotraandopenhands b7e5882b76 feat: add release skill and create-release workflow (#900) 
* feat: add release skill and create-release workflow

Add a keyword-triggered skill (.agents/skills/release.md) that guides
agents through the full release process:
1. Create a release PR on a rel-<version> branch bumping package.json
2. Label the PR with e2e-tests to trigger mock-LLM E2E validation
3. Merge — automatic tagging and downstream publishing

Add .github/workflows/create-release.yml (modeled after the SDK's
workflow) that automatically creates a GitHub release with tag
v<version> when a rel-* branch PR is merged into main. The tag push
triggers the existing npm-publish.yml and docker.yml workflows.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: release skill must stop and ask user to confirm version

Rewrite Step 1 so the agent checks the current version, suggests the
next logical bump, and explicitly stops to ask the user which version
they want before proceeding.  Remove the old passive Prerequisites
section.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-28 19:25:46 +00:00
Rohit Malhotraandopenhands caef236c10 mock-llm e2e: use bin/agent-canvas.mjs (production binary path) (#906) 
Switch mock-LLM E2E tests from npm run dev:minimal (Vite dev server +
agent-server only) to the full agent-canvas binary entry point — the same
path real users exercise when they run `npx @openhands/agent-canvas`.

This means tests now launch:
  - Pre-built static frontend (via static-server.mjs)
  - Agent-server via uvx
  - Automation backend via uvx
  - Ingress proxy unifying all routes on a single port

Changes:
- playwright.mock-llm.config.ts: replaced dev-safe.mjs webServer with
  bin/agent-canvas.mjs; single ingress port (18300) serves both the
  browser UI and proxied API calls; conditional build step for build/
- scripts/dev-with-automation.mjs: buildConfig now respects
  OH_CANVAS_SAFE_STATE_DIR from env (needed for test isolation)
- tests/e2e/mock-llm/utils/mock-llm-helpers.ts: BACKEND_URL now
  defaults to the ingress URL (API calls are proxied transparently)
- .github/workflows/mock-llm-e2e.yml: added npm run build:app step
  before tests (pre-build for CI caching)
- AGENTS.md: added Mock-LLM E2E Tests section documenting the new
  production-fidelity test architecture

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-28 19:17:59 +00:00
Rohit Malhotraandopenhands c76d855149 fix: include tools/ in npm package files (#904) 
The tools/ directory containing canvas_ui_tool.py was missing from the
package.json 'files' list, so it was not shipped in the published npm
tarball. Users running the released 'agent-canvas' CLI would get:

  KeyError: "ToolDefinition 'canvas_ui' is not registered"
  Failed to import module 'canvas_ui_tool': No module named 'canvas_ui_tool'

because the agent-server couldn't find the Python module that
dev-safe.mjs exposes via OH_EXTRA_PYTHON_PATH.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-28 19:10:04 +00:00
Rohit Malhotraandopenhands 231367a62b feat(cli): add --info flag to show default stack versions and ports (#902) 
agent-canvas --version only shows the package version. The new --info
flag reads config/defaults.json and prints the full picture: agent-canvas
version, default agent-server/automation/SDK versions, default ports,
and the env vars available to override them.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-28 19:02:26 +00:00
Rohit Malhotraandopenhands bd894b0708 feat: add mock-LLM E2E test infrastructure (#833) 
* feat: add mock-LLM E2E test infrastructure

Add a new category of E2E tests that exercise the full UI → agent-server →
LLM stack using a scripted mock LLM server instead of real LLM credentials.

The mock server uses openhands-sdk's TestLLM to serve deterministic OpenAI-
compatible responses (tool calls and text replies) over HTTP, so these tests
are fully reproducible and need no API keys.

The Playwright test drives the real UI:
  1. Creates an LLM profile via Settings > LLM Profiles
  2. Sets the profile as active (points at the mock server)
  3. Starts a new conversation from the home page
  4. Sends a user message and verifies the agent responds

Verification is three-layered:
  - Events API: polls for a successful terminal observation
  - Chat UI: asserts the bash output token appears in rendered messages
  - Chat UI: asserts the agent's final reply token appears

New files:
  - tests/e2e/mock-llm/scripts/mock-llm-server.py  (TestLLM HTTP server)
  - tests/e2e/mock-llm/utils/mock-llm-helpers.ts    (shared Playwright helpers)
  - tests/e2e/mock-llm/mock-llm-conversation.spec.ts (the test spec)
  - playwright.mock-llm.config.ts                    (dedicated Playwright config)

Run with: npm run test:e2e:mock-llm

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: make mock-LLM E2E assertions real + add CI workflow

Fixes three broken verification checks in the mock-LLM test:

1. User message no longer contains BASH_TOKEN or REPLY_TOKEN.
   The mock LLM ignores the prompt anyway (TestLLM pops scripted
   responses from a deque), so embedding tokens in the prompt just
   caused the UI assertions to pass vacuously from the user's own
   message text.

2. waitForNonUserMessageText now searches only agent/environment
   output containers (agent-message, environment-message,
   model-messages, event-group) instead of the whole document body.
   This is a positive selector strategy — no risk of false positives
   from sidebar text, nav labels, or user input.

3. Error banner assertion no longer swallows failures. The previous
   .catch(() => {}) meant the step could never fail even when an
   error banner was visible.

Also adds .github/workflows/mock-llm-e2e.yml — triggered on PRs
with the 'e2e-tests' label or manual workflow_dispatch. No secrets
needed (the mock LLM server is self-contained).

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: add PR comment with test results to mock-LLM E2E workflow

The CI workflow now:
1. Captures test exit code without failing the step (so later steps run)
2. Renders a markdown report from Playwright's JSON output showing each
   test name with pass/fail/skip status, duration, and retry count
3. Posts (or updates) a PR comment via the existing upsert-pr-comment.mjs
   script, using a dedicated '<!-- mock-llm-e2e-report -->' marker
4. Expands failure details in a collapsible section with the error message
5. Writes the same report to the GitHub Actions step summary
6. Links to the workflow run and uploaded test artifacts
7. Fails the job at the end if the test exit code was non-zero

Also adds the json reporter to playwright.mock-llm.config.ts.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use venv for openhands-sdk in CI to avoid PEP 668 error

Ubuntu 24.04's system Python is externally managed (PEP 668), so
`uv pip install --system` fails. Fix by creating a dedicated venv
for the mock LLM server and passing the venv's python path via
MOCK_LLM_PYTHON env var.

The Playwright config reads `MOCK_LLM_PYTHON` (default: 'python3')
for the webServer command, so local usage is unchanged.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: retry loop for mock LLM server verification in CI

The litellm import takes ~7 seconds on CI, so the fixed 'sleep 3'
was too short. Replace with a 30-second retry loop that polls the
server every second until it responds, then performs the JSON
validation.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add GET / health check to mock LLM server

Playwright's webServer readiness probe sends GET / to the configured
URL. The mock server only handled POST, returning 501 for everything
else. Playwright interpreted this as 'not ready' and timed out after
30 seconds.

Add a do_GET handler that returns 200 with a simple JSON status.

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: post fresh PR comment per run + cache Playwright browsers

- Post PR comment: switch from upsert-pr-comment.mjs (which found and
  updated a single marker-tagged comment) to `gh pr comment` so each
  CI trigger leaves its own comment with full test results history.
  Remove the COMMENT_MARKER from render-mock-llm-report.mjs since it
  was only used for the dedup lookup.

- Cache Playwright: add actions/cache for ~/.cache/ms-playwright keyed
  on package-lock.json hash. On cache hit, only install system deps
  (fast apt layer) instead of re-downloading the full Chromium binary.

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: remove Playwright cache (caused extraction hang)

The actions/cache@v4 step for ~/.cache/ms-playwright reproducibly
caused npx playwright install to hang during Chrome zip extraction
(7+ min with no output, vs 24s without caching). The uncached install
completes in ~24s which is fast enough — remove caching for now.

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: move Playwright install before uv/openhands-sdk setup

Playwright's Chrome zip extraction hangs reproducibly when run after
the uv venv + openhands-sdk install steps (7+ min with no output).
The snapshot-tests workflow, which installs Playwright right after
npm ci, completes in ~21s on the same commit at the same time.

Move Playwright install immediately after npm ci — before uv, SDK,
and mock-server verification — to match the working step order.

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: split Playwright install into deps + browser download

Split 'npx playwright install --with-deps chromium' into two steps:
1. install-deps (apt packages only, no browser download)
2. install (browser download + extraction only)

This isolates which phase is hanging: the combined --with-deps flag
runs both in a single process, and the extraction hangs reproducibly
in this workflow despite identical config to snapshot-tests (which
works in 21s). Splitting may avoid whatever interaction causes the
extraction to stall.

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: pin Node 24.15 to fix Playwright install hang

Node 24.16.0 introduced a zip-extraction regression (nodejs/node#63487)
that causes 'playwright install' to hang indefinitely after download
completes for Playwright < 1.60.0. This repo uses Playwright 1.59.1.

The hang was reproduced 4 times on this workflow — download finishes
in ~3s but extraction never completes (7+ minutes of silence).
Meanwhile snapshot-tests (same config) worked because its runner
resolved to Node 24.15.0.

Pin to 24.15.x until the project upgrades to Playwright >= 1.60.0,
which includes a fix for the extract-zip interaction.

Also revert the split install-deps / install experiment back to the
original single 'npx playwright install --with-deps chromium' command.

Ref: microsoft/playwright#41000, microsoft/playwright#40724

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: tighten mock-LLM test timeouts and remove CI retries

Mock LLM responses are instant, so the generous timeouts were causing
CI to hang for 10+ minutes when a test fails:
- retries: 1→0 in CI (mock tests should be deterministic)
- test timeout: 120s→60s (mock responses are instant)
- polling timeouts: 60s→30s for bash observation and chat text checks

Before: 3 tests × 120s timeout × 2 attempts (retry) = up to 12 min
After:  3 tests × 60s timeout × 1 attempt = up to 3 min on failure

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: step 3 conversation creation + add global timeout

Step 3 was clicking the home-chat-launcher container div (a passive
wrapper) instead of using the chat input to create a conversation.
The div click did nothing, and the test timed out waiting for
navigation to /conversations/<id>.

Fix: type into the home-page chat input and click submit — this is how
real users create conversations from the home page.

Also:
- Add globalTimeout (10 min in CI) to cap the entire Playwright run
  so teardown hangs don't waste CI time
- Reduce job timeout-minutes from 20 to 15

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: teardown hang via exec + add diagnostic logging

1. Prefix webServer command with 'exec env' so the shell is replaced
   by the npm process. Without exec, Playwright's SIGTERM kills the
   shell but npm's children (uvx, agent-server, vite) survive as
   orphans, causing the step to hang for 6+ minutes after tests finish.

2. Add diagnostic logging to waitForSuccessfulBashObservation — on
   timeout, the error message now includes the count and kinds of
   events the API actually returned, so we can tell whether the
   conversation never started vs the observation format changed.

3. Add a pre-flight API check in step 3 that verifies the mock-LLM
   profile's base_url is active in server settings before creating a
   conversation. If steps 1+2 didn't persist correctly, this fails
   fast with a clear message instead of timing out on empty events.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: profile check via /api/profiles + timeout wrapper for teardown

1. The pre-flight check was querying /api/settings which doesn't
   contain profile-based LLM config. Fix: query /api/profiles and
   assert active_profile matches the expected profile name.

2. Wrap the Playwright command in 'timeout --kill-after=30 8m' so
   if webServer teardown hangs (orphaned agent-server/vite processes
   ignoring SIGTERM), the entire process tree gets SIGKILL'd after
   8.5 minutes instead of waiting for the 15-min job timeout.

Co-authored-by: openhands <openhands@all-hands.dev>

* debug: dump first observation's raw structure on failure

The events API is returning events (agent-server logs show the bash
command was executed), but isSuccessfulBashObservation can't find a
match. Dump the first observation's full JSON structure so the next
CI run shows exactly what fields the API returns.

Co-authored-by: openhands <openhands@all-hands.dev>

* debug: dump raw event structures to discover API format

Previous diagnostic showed 8 events all with 'unknown' kind —
meaning the events don't have action.kind or observation.kind
properties. Dump the full JSON of the first 3 events to discover
the actual field structure.

Co-authored-by: openhands <openhands@all-hands.dev>

* debug: dump ALL event kinds + first non-stats event structure

Previous dump only showed first 3 events (all stats/state updates).
The observation events are likely in positions [3]-[7]. New diagnostic
shows all event kinds and dumps the first non-stats event so we can
see the actual action/observation format.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use correct APIs for mock-LLM E2E verification

The agent-server's conversation events API returns MessageEvents (not
nested ActionEvent/ObservationEvent), and tool executions live in the
separate bash events API (/api/bash/bash_events/search).

Changes:
- waitForSuccessfulBashObservation: now queries /api/bash/bash_events/search
  with kind__eq=BashOutput, checks stdout/stderr for BASH_TOKEN
- waitForAgentMessageContaining: new helper that checks conversation
  events API for agent MessageEvents containing a given token
- Step 3 verification now:
  1. Bash tool execution via bash events API
  2. Agent reply via conversation events API
  3. Reply token in chat UI (proves full round-trip)
  (Removed BASH_TOKEN UI check — it may not render in chat)

Co-authored-by: openhands <openhands@all-hands.dev>

* perf: cache Playwright browser binaries in CI

Split 'playwright install --with-deps chromium' into two steps:
1. 'playwright install chromium' (only on cache miss) — downloads ~200MB
   of browser binaries, cached via actions/cache keyed on PW version + OS
2. 'playwright install-deps chromium' (always) — installs apt system
   libraries needed by the browser (fast, mostly pre-installed on runner)

This should save ~30-60s on cache-hit runs since the browser download
is the slowest part of the Playwright setup.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: accept BashOutput with null stdout (exit_code=0 proves execution)

The bash events API returns BashOutput events where stdout can be null
even for successful commands (order:0 event with exit_code:0). Accept
null stdout with exit_code 0 as proof of successful execution.
Also dump all bash events (not just first) for CI diagnostics.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: don't fail CI when tests pass but teardown hangs

The Playwright webServer teardown can hang when the agent-server process
doesn't respond to SIGTERM (a known issue with uvicorn child processes).
The timeout wrapper kills the process tree after 8 min, but this was
incorrectly mapped to test failure.

Now when timeout triggers:
1. Check if test-results-mock-llm/results.json exists (Playwright writes
   this before teardown starts)
2. Parse it: if every spec/test has status 'passed', mark as success
3. Only fail if results.json is missing or has actual test failures

Also includes the Playwright cache and bash events API fix.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: background Playwright so shell survives teardown timeout

The previous 'timeout' wrapper killed the entire process group including
our bash shell, so the results.json check never ran. Now:
1. Run Playwright in background (&)
2. Poll every 2s up to 8 min
3. If still running, SIGTERM then SIGKILL the process group
4. Our shell is still alive → check results.json
5. If all tests passed, mark as success despite teardown hang

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: poll for results.json during run, not after kill

Playwright's JSON reporter writes results.json after all tests complete
but before webServer teardown. Poll for the file appearance during the
run (Phase 1), then only kill the hanging process if tests are done
(Phase 2). This way we catch results.json while Playwright is still
alive but stuck in teardown, and can correctly determine pass/fail.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: parse Playwright stdout for pass/fail (not results.json)

Playwright's JSON reporter only writes results.json on process exit,
which is blocked by the webServer teardown hang. The line reporter
prints test results to stdout in real-time BEFORE teardown starts.

New approach:
- Capture stdout with tee to a log file
- Poll the log for 'N passed' summary line
- After killing the hanging process, check the log:
  if 'N passed' exists and no 'N failed' or 'N timed out', mark success

This lets us correctly report passing tests even when the agent-server
process doesn't respond to SIGTERM during webServer teardown.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: write PW output to file directly, add debug logging

Process substitution >(tee ...) is fragile with background kills —
the tee process might be killed alongside npm, leaving an incomplete
log. Write directly to file and tail separately for CI output.

Added explicit debug logging:
- 'Checking PW_LOG for pass/fail...'
- grep output showing what matched
- Different message for failure vs success

Co-authored-by: openhands <openhands@all-hands.dev>

* debug: add verbose logging to post-kill check

Need to see: does PW_LOG exist? What size is it? What does grep find?
Which branch of the if/else is taken? Where exactly does it stop?

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use marker file written by test to detect pass/fail

Playwright's JSON reporter only flushes on clean process exit, and
stdout redirection is unreliable with backgrounded process trees.
Instead, the test itself writes a .all-passed marker file after all
assertions succeed. The CI wrapper polls for this file to detect test
completion, then safely kills the hanging teardown process.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: clean up debug diagnostics from helpers

Remove per-event JSON dumps and verbose diagnostic logging from
waitForSuccessfulBashObservation. Keep concise error messages.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: detect test completion immediately via custom reporter

Playwright's reporter onEnd() fires AFTER all tests complete but
BEFORE webServer teardown starts. A custom DoneMarkerReporter writes:

  .tests-done  — always (content: 'passed' or 'failed')
  .all-passed  — only when all tests pass

The CI wrapper polls for .tests-done, so it detects completion
immediately on both pass AND fail. Previously it only polled for
.all-passed, meaning test failures wasted the full 5-min polling
timeout before the step could finish.

This also moves the marker logic out of the test spec and into the
reporter, which is cleaner — the test code doesn't need to know
about CI infrastructure.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: write marker files outside Playwright's outputDir

Playwright clears its outputDir at the start of each run. Writing
markers to a separate .mock-llm-markers/ directory avoids interference.

Also wrapped onEnd() in try/catch and resolved paths via import.meta.url
to be robust against working directory changes.

Co-authored-by: openhands <openhands@all-hands.dev>

* debug: add console.log to reporter, use process.cwd()

import.meta.url may not work in Playwright's CJS reporter context.
Use process.cwd() instead. Add console.log in onBegin/onEnd to verify
the reporter is loaded and executing.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: write markers in onTestEnd, not onEnd

Playwright's lifecycle: onBegin → tests → onTestEnd → onEnd → cleanup.
WebServer teardown happens during 'cleanup', which hangs indefinitely.
onEnd() fires AFTER cleanup, so it never executes when teardown hangs.

onTestEnd() fires immediately after each test completes, before any
cleanup begins. Track total/completed test counts and write markers
after the last test finishes. This gives both pass and fail signals
before the teardown hang blocks everything.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: report script falls back to marker files when results.json missing

Playwright's JSON reporter only flushes results.json on clean process
exit. When the webServer teardown hangs and the process is killed,
results.json never gets written, so the report showed 0/0 tests.

The render script now checks .mock-llm-markers/.tests-done (written by
DoneMarkerReporter in onTestEnd, before teardown) as a fallback. This
gives correct pass/fail status in the PR comment even without
results.json.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: proper teardown and accurate test durations in PR comment

Two fixes:

1. **Teardown hang resolved**: The webServer command now bypasses npm
   and `exec`s directly into `node scripts/dev-safe.mjs`. Previously
   `exec ... npm run dev:minimal` was used, but npm does NOT forward
   SIGTERM to its child processes. When Playwright sent SIGTERM during
   teardown, npm died but node/uvx/vite survived as orphans, causing
   the hang. Now SIGTERM goes straight to dev-safe.mjs's signal handler
   which kills children via process groups and exits cleanly.

2. **Accurate durations**: DoneMarkerReporter now writes a `.results.json`
   with per-test title, status, duration, and error data (from
   `TestResult.duration` in onTestEnd). The report script reads this
   instead of showing 0ms. Falls back to `.tests-done` (pass/fail only)
   if the JSON is missing.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: reduce teardown grace period from 10s to 5s

The marker-based detection is immediate (onTestEnd fires before
teardown), so we don't need a long grace period. The remaining hang
is Playwright waiting for the multi-process agent-server tree to
fully exit — expected behavior, not a bug.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-28 14:23:28 -04:00
Rohit Malhotraandopenhands e176cdf9aa ci: cache Playwright browsers and pin Node 24.15 across all workflows (#893) 
Two fixes applied to ci.yml and snapshot-tests.yml:

1. **Cache Playwright browsers**: Playwright browser downloads (~150 MB)
   are now cached via actions/cache keyed by OS + Playwright version.
   `npx playwright install chromium` only runs on cache miss; system
   deps (`install-deps`) always run since OS packages aren't cacheable.

2. **Pin Node to 24.15.x**: Node 24.16.0 has a zip-extraction regression
   (nodejs/node#63487) that hangs `playwright install` for Playwright
   < 1.60.0. The ci.yml build job and live E2E job, plus
   snapshot-tests.yml, are all pinned consistently.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-28 18:00:41 +00:00
Rohit Malhotraandopenhands 5f5311272f fix: use backend registry apiKey for automation auth instead of build-time env var (#830) 
The localAutomationAxios interceptor was reading the session API key from
import.meta.env.VITE_SESSION_API_KEY (baked in at build/publish time),
causing 401 errors for users of the published npm package because their
runtime session key (injected into localStorage by static-server.mjs) was
never included in requests to the automation backend.

The fix reads the API key from getEffectiveLocalBackend().apiKey on every
request, which dynamically resolves the current backend registry entry —
the same source the host/baseURL was already using. This ensures:
- Published npm package users get the runtime-injected key from localStorage
- Users who edit their backend via the Manage Backends UI get their updated key
- No more falling back to Keycloak cookie auth (which always returns 401)

Fixes #829

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-27 14:31:31 -04:00
Rohit Malhotraandopenhands b6380f6e55 chore: bump version to 1.0.0-alpha.7 (#822) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-27 16:53:16 +00:00
Rohit Malhotraandopenhands f2d19c8923 Add GitHub bug report issue template (#813) 
* Add GitHub bug report issue template

- Bug report form with install method dropdown (npm, Docker, source, other)
  and version dropdown listing all pre-release versions (alpha.2–alpha.6)
- Includes optional agent-server version, environment, logs/screenshots fields

Co-authored-by: openhands <openhands@all-hands.dev>

* Remove agent server version field from bug report template

Co-authored-by: openhands <openhands@all-hands.dev>

* Remove environment field from bug report template

Co-authored-by: openhands <openhands@all-hands.dev>

* Add OS dropdown to bug report template

Co-authored-by: openhands <openhands@all-hands.dev>

* Address review feedback on bug report template

- Convert version dropdown to free-text input to avoid maintenance burden
- Fix docker inspect description to include image reference
- Add Actual Behavior field between Steps to Reproduce and Expected Behavior
- Split Logs/Screenshots into separate fields so render:shell doesn't break images

Co-authored-by: openhands <openhands@all-hands.dev>

* Add --version flag to CLI and version label to Docker image

- bin/agent-canvas.mjs: add -v/--version flag that reads version from package.json
- docker/Dockerfile: add AGENT_CANVAS_VERSION build arg and org.opencontainers.image.version label
- .github/workflows/docker.yml: extract version from package.json, pass as build arg
- bug_report.yml: update version field description with the actual commands users can run

Co-authored-by: openhands <openhands@all-hands.dev>

* Update version description: use image tag for Docker (label not yet released)

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-27 12:17:35 -04:00
Rohit Malhotraandopenhands 857f3384b8 docs: add Docker and NPM install instructions to README (#806) 
* docs: add Docker and NPM install instructions to README

Add three clearly labeled installation options to the Quickstart section:
- Option 1: Docker (pull and run the published image)
- Option 2: NPM (global install of the published package)
- Option 3: From Source (existing clone-and-build workflow)

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use 1.0.0-alpha.6 docker tag instead of latest

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: add explicit export PROJECTS_PATH step before commands

Addresses review feedback: move PROJECTS_PATH setup into an explicit
export step above the docker run / agent-canvas commands so copy-pasting
doesn't produce a broken volume mount.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-27 11:34:27 -04:00
Rohit Malhotraandopenhands 907d6bde76 chore: bump version to 1.0.0-alpha.6 (#793) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-26 18:30:16 -04:00
Rohit Malhotraandopenhands e2dd1b5f17 fix: unify session and automation API keys into a single credential with consistent header (#681) 
* fix: unify session and automation API keys into a single credential

Both the agent-server and automation backend now share the same API key
value. The agent-server validates it via `X-Session-API-Key` and the
automation backend validates it via `Authorization: Bearer …` — different
header formats, same credential.

Changes:
- Frontend: automation axios client reads `VITE_SESSION_API_KEY` instead
  of the now-removed `VITE_AUTOMATION_API_KEY`
- Dev launcher: removed separate `AUTOMATION_LOCAL_API_KEY` generation
  and persistence (`automation-api-key.txt`); `localApiKey` is set to
  `sessionApiKey` so both backends receive the same value
- Static build: stopped baking `VITE_AUTOMATION_API_KEY` (the frontend
  reads from `VITE_SESSION_API_KEY`)
- Docker entrypoint: `OPENHANDS_AUTOMATION_API_KEY`,
  `AUTOMATION_LOCAL_API_KEY`, and `AUTOMATION_AGENT_SERVER_API_KEY` all
  default to the session key when not explicitly overridden
- Tests updated to verify unified key behavior

Fixes the 401 on `/api/automation/v1` when the automation backend is
running but no separate `VITE_AUTOMATION_API_KEY` was configured.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use X-Session-API-Key header for automation backend auth (consistent with agent-server)

Switch automation backend requests from `Authorization: Bearer …` to
`X-Session-API-Key` header, matching the agent-server's auth pattern.
Both backends now authenticate using the same header and the same key
value (`VITE_SESSION_API_KEY`).

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address review — remove localApiKey alias, dead constant, add entrypoint guard

- Remove `localApiKey` from config; all call sites now use
  `config.sessionApiKey` directly, making the unified-key intent obvious.
- Delete `DEFAULT_AUTOMATION_API_KEY_PATH` constant and its export
  (no downstream consumers in beta).
- Add fail-fast guard in docker/entrypoint.sh when no session key is
  available, instead of silently exporting empty strings.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: update stale comment on AUTOMATION_LOCAL_API_KEY to reflect unified session key

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-26 22:15:27 +00:00
Rohit Malhotraandopenhands cb831b2860 fix: include config/ in npm package files (#791) 
The `config/` directory (containing `defaults.json`) was missing from the
`files` allowlist in package.json, so it was excluded from the published
npm tarball. The CLI entry point imports `scripts/dev-with-automation.mjs`
which reads `config/defaults.json` at startup, causing an ENOENT crash.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-26 22:02:57 +00:00
Rohit Malhotraandopenhands 603ed9d66d chore: bump version to 1.0.0-alpha.5 (#789) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-26 17:36:18 -04:00
Rohit Malhotraandopenhands 45da5606d6 fix: bump agent-server SDK to 1.23.1 (#782) 
Fixes two bugs in the upstream agent-server SDK v1.23.0 that caused
500 Internal Server Error on POST /api/conversations:

1. LLM registry duplicate usage_id: The condenser and main agent LLMs
   both used usage_id='default', causing ValueError on conversation
   creation. v1.23.1 checks for existing usage IDs before registering.

2. Validation error handler crash: The _validation_exception_handler
   tried to JSON-serialize raw ValueError objects from Pydantic
   validation contexts, turning 422 errors into 500s. v1.23.1 properly
   sanitizes validation errors before serializing.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-26 18:42:17 +00:00
Rohit Malhotraandopenhands 489070029d fix(ci): publish directly with --tag latest to avoid OIDC dist-tag failure (#778) 
* fix(ci): publish directly with --tag latest to avoid OIDC dist-tag failure

The previous workflow published with --tag alpha then ran a separate
npm dist-tag add to set latest. The second call failed with E401
because OIDC trusted publishing tokens don't cover post-publish
registry mutations like dist-tag.

Simplify to a single npm publish --tag latest, which is all we need
until the first stable release (#395).

* docs(ci): note that named prerelease dist-tags are removed under current policy

Add a comment block explaining that alpha/beta/rc dist-tags are intentionally
not published while issue #395's 'everything is latest' policy is active, so
consumers pinning to named prerelease tags are not silently broken without
notice.

Co-authored-by: openhands <openhands@all-hands.dev>

* docs(ci): add OIDC root cause to publish comment per review

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-26 18:16:14 +00:00
Rohit Malhotraandopenhands 5d7f539303 fix(docker): ensure latest tag always points to latest stable release (#780) 
Previously, the merge-manifests job unconditionally aliased main→latest
on every push to the main branch. This meant any commit to main after a
release would overwrite the `latest` multi-arch manifest with unreleased
main-branch code instead of the most recent stable tagged version.

The per-arch build already adds `latest-{arch}` tags exclusively for
stable (non-pre-release) version tags (e.g. v1.2.3), and the manifest
merge loop correctly creates the `latest` multi-arch manifest from
those arch-suffixed images. The extra main→latest alias was redundant
for tag pushes and incorrect for plain main pushes.

Remove the main→latest alias so `latest` is only produced by stable
version tag pushes, ensuring `docker pull …:latest` always gets the
highest stable release.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-26 18:05:00 +00:00
Rohit Malhotraandopenhands 43c10810da fix: switch @openhands/typescript-client from git dep to npm registry (#779) 
* fix: switch @openhands/typescript-client from git dep to npm registry

Replace the git+https dependency with the published npm package
(v1.23.3). Git dependencies break `npm install -g` because npm
clones the repo and runs the prepare script, but devDependencies
like rimraf aren't available during global installs.

Co-authored-by: openhands <openhands@all-hands.dev>

* test: add guard against git dependencies in package.json

Git dependencies break `npm install -g` because npm clones the repo
and runs the prepare script without devDependencies. Add a test that
fails if any dependency uses a git URL, with an allowlist for
@openhands/extensions (not yet published to npm).

Co-authored-by: openhands <openhands@all-hands.dev>

* test: also catch bare owner/repo GitHub shorthand in git dep guard

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-26 17:51:37 +00:00
Rohit Malhotraandopenhands 3e0d915526 chore: bump version to 1.0.0-alpha.4 (#771) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-26 16:45:28 +00:00
Rohit Malhotraandopenhands 89abe93a28 chore: bump automation version to 1.0.0a5 (#774) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-26 16:27:21 +00:00
Rohit Malhotraandopenhands 60bc93f0e9 Add backend management specs and @spec annotations (#727) 
* Add backend management specs and @spec annotations

- Curate specs/backend-management.md with 4 behavioral specs (BM-001–BM-004)
- Add @spec comments to source and test files for traceability
- Add spec file convention note to AGENTS.md

Co-authored-by: openhands <openhands@all-hands.dev>

* Remove duplicate BM-002 test (non-conversation redirect)

The 'stays on settings' case was covered by two tests; keep the one
with the clearer assertion and drop the redundant copy.

Co-authored-by: openhands <openhands@all-hands.dev>

* Parameterize BM-002 tests with it.each

Collapse 3 identical-structure redirect tests into a single
parameterized it.each covering conversation detail, automation detail,
and non-ID routes.

Co-authored-by: openhands <openhands@all-hands.dev>

* Document @spec tagging convention in AGENTS.md

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-21 18:08:53 -04:00
Rohit Malhotraandopenhands e6d12e3fff fix(BM-001): auto-switch active backend on addBackend (#714) 
* spec(BM-001): add spec + failing tests for auto-switch on connect

Adding a backend should automatically switch the active selection to it.
Currently addBackend registers the entry but leaves the user on the
previous backend, forcing a manual switch.

- specs/backend-management.md: BM-001 definition
- Two new test cases (cloud + local) that assert the active backend
  changes after addBackend — both fail against the current implementation.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(BM-001): auto-switch active backend on addBackend

addBackend now calls setActiveSelection after registering the new entry,
so the user lands on the backend they just connected — whether via the
manual host+key form or the cloud OAuth device-flow login.

- src/contexts/active-backend-context.tsx: one-line fix in addBackend
- Updated add-backend-modal test to assert the new active selection
- Updated backend-selector tests that used addBackend purely as setup
  to reset active to the default local backend afterward

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: remove noisy @spec markers from test setup comments

Keep @spec BM-001 only where it marks the implementation or directly
asserts the spec behavior. Setup-only adjustments (resetting active
backend after addBackend) are incidental — plain comments suffice.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: consolidate @spec BM-001 to one test + one implementation site

The spec marker belongs in exactly two places: the line that implements
the behavior and the single test that verifies it. Removed the redundant
local-backend variant (same code path as cloud) and dropped @spec labels
from the modal test (its assertion stays, just without the tag).

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: remove setActive workarounds from backend-selector tests

Instead of manually resetting active state after addBackend, tests now
work with the auto-switch naturally:

- Local backend tests: click the seeded default 'Local' (which is no
  longer active after auto-switch) to trigger the switch.
- Cloud org tests: add a local backend after the cloud one so the last
  auto-switch lands on local, leaving cloud backends unselected and
  their org rows visible in the dropdown.

No ctx.setActive(DEFAULT_LOCAL_BACKEND_ID) calls remain.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: extract shared seed constants in backend-selector tests

SEED_LOCAL_1 and SEED_CLOUD_PRODUCTION replace 12+4 identical inline
config objects. The two remaining inline blocks have different apiKey
values and correctly stay as-is.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-21 18:49:20 +00:00
Rohit Malhotra eee7fe1b7a feat: use async conversations and interrupt endpoint for local mode (#670) 2026-05-20 22:16:20 -04:00
Rohit Malhotraandopenhands ad5c5533a9 fix(tests): fix two flaky CI tests on Windows (#667) 
conversation-panel: createMockConversation() gave all conversations the
same updated_at timestamp (new Date()), making sort order non-deterministic.
Tests that indexed into cards[0] expecting conversation "1" would sometimes
get conversation "2" instead.  Fix: use a monotonic counter so each call
produces a timestamp 1 s older than the previous, guaranteeing array
insertion order matches sort order.

dev-with-automation: the OH_AGENT_SERVER_LOCAL_PATH test created a Unix
shell stub for uvx and joined PATH with ':'.  On Windows the PATH separator
is ';', the stub needs a .cmd extension, and where.exe needs PATHEXT and
SystemRoot to function.  Fix: use path.delimiter, create uvx.cmd on Windows,
and pass through the required Windows env vars.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-20 11:10:48 -04:00
Rohit Malhotraandopenhands db976f2e66 fix: use PostHog prod creds only for tagged Docker releases (#666) 
* fix: set VITE_APP_ENV=production in Docker build for PostHog prod creds

The Docker frontend build stage was not setting VITE_APP_ENV, so all
Docker images (including tagged releases) used the PostHog staging key.
This adds ENV VITE_APP_ENV=production to the frontend-build stage,
matching the build:lib npm path behavior.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use PostHog prod creds only for tagged Docker releases

Make VITE_APP_ENV a Dockerfile build arg (default empty = staging key).
The CI workflow passes VITE_APP_ENV=production only when building from
a tagged release (refs/tags/v*), so PR and main-branch images keep the
staging key while release images get the production key.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-20 14:55:56 +00:00
Rohit Malhotraandopenhands 979e64fe19 feat: add Docker CI to build all-in-one image with agent-server + automation + frontend (#634) 
* feat: add Docker CI to build all-in-one image with agent-server + automation + frontend

Adds a GitHub Actions workflow (.github/workflows/docker.yml) that builds and
publishes ghcr.io/openhands/agent-canvas — a single Docker image combining:

  1. Agent Server (ghcr.io/openhands/agent-server base image from SDK repo)
  2. Automation server (pip-installed from openhands-automation)
  3. agent-canvas frontend (static build from this repo)

The automation server is pip-installed rather than copied from its Docker image
because both services share openhands-sdk, fastapi, uvicorn, pydantic, httpx
etc. — installing into the agent-server's Python 3.13 deduplicates all shared
packages. Only automation-specific deps (asyncpg, sqlalchemy, boto3, …) are
added on top.

An entrypoint script starts all three services and a static-server proxy that
unifies them behind a single port (default 8000):
  /api/automation/* → automation backend (:18001)
  /api/*            → agent-server (:18000)
  /*                → static frontend + SPA fallback

Workflow triggers:
  - Push to main: builds and pushes with branch + SHA tags
  - v* tags (releases): also pushes semver tags (1.2.3, 1.2, 1, latest)
  - PRs: builds, pushes SHA-tagged image, updates PR description with
    pull/run instructions (same pattern as the SDK repo)
  - workflow_dispatch: supports overriding base image and automation version

Files added:
  - docker/Dockerfile (multi-stage: frontend build + agent-server base)
  - docker/entrypoint.sh (process manager for all three services)
  - .dockerignore
  - .github/workflows/docker.yml

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: build multi-arch Docker images (amd64 + arm64)

Adds QEMU setup for cross-compilation and defaults the platform matrix
to linux/amd64,linux/arm64 so the image works on both Intel and Apple
Silicon machines.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: rewrite Docker workflow to match SDK repo structure

Replace the single-job QEMU approach with the same architecture-matrix
pattern used by the SDK repo's server.yml:

  1. build-and-push-image — matrix over {amd64, arm64} with native runners
     (ubuntu-24.04 for amd64, ubuntu-24.04-arm for arm64). Each job pushes
     arch-suffixed tags (e.g. sha-abc1234-amd64) and uploads build-info
     artifacts.

  2. merge-manifests — downloads both arch build-infos, strips the -amd64
     suffix from amd64 tags to derive manifest tags, and creates multi-arch
     manifests via `docker buildx imagetools create`.

  3. consolidate-build-info — aggregates all build-info and manifest-info
     artifacts into a single JSON summary (PR-only).

  4. update-pr-description — renders the summary into the PR body between
     AGENT_CANVAS_DOCKER_START/END markers.

Native runners avoid the 3-5× slowdown of QEMU emulation for arm64
builds.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: sanitize branch names in Docker tags (/ is not allowed)

Branch names like 'feat/docker-ci' produce invalid Docker tags because
'/' is forbidden in tag names. Replace '/' with '-' so the tag becomes
'feat-docker-ci-amd64'.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: default automation to SQLite and fix wait blocking proxy startup

Two bugs:

1. The automation server defaults to PostgreSQL on localhost, which
   doesn't exist in the all-in-one container. Default AUTOMATION_DB_URL
   to sqlite+aiosqlite:// so it works out of the box. Users can override
   with a real Postgres URL for production.

2. The bare 'wait' command waited for ALL background children — including
   the long-running agent-server and automation processes — so the
   static-server/proxy on port 8000 never started. Fix by waiting only
   for the wait_for_port subshell PIDs.

Verified locally: all three services start, endpoints respond correctly,
no more scheduler ConnectionRefusedError.

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: add VOLUME directives for persistence and project mounts

Declare /home/openhands/.openhands (settings, secrets, conversations,
automation SQLite DB) and /projects (user code) as Docker volumes so
data survives container restarts by default. Users should bind-mount
these for durable persistence:

  docker run -v ~/.openhands:/home/openhands/.openhands \
             -v ~/projects:/projects \
             -p 8000:8000 ghcr.io/openhands/agent-canvas

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: set OH_SECRET_KEY default and pre-create persistence dirs

Three issues fixed:

1. OH_SECRET_KEY was not set → agent-server refused to return encrypted
   secrets → conversation creation failed with 503. Set the same static
   default used by dev-safe.mjs / dev-docker.mjs.

2. Persistence dirs (conversations, bash_events, automation DB) were not
   pre-created → the openhands user got PermissionError when the VOLUME
   directive created them as root. Pre-create with correct ownership
   before the USER switch in the Dockerfile.

3. Set OH_PERSISTENCE_DIR, OH_CONVERSATIONS_PATH, OH_BASH_EVENTS_DIR
   defaults in the entrypoint (matching dev-docker.mjs) so data lands
   under the well-known ~/.openhands tree.

Verified locally: all three services start clean, no warnings about
OH_SECRET_KEY, SQLite migrations apply successfully.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: merge main and remove stale dev-docker.mjs references

Main removed scripts/dev-docker.mjs (Docker is no longer a dependency of
the npm package flow). Update comments in docker.yml, entrypoint.sh, and
AGENTS.md that referenced the deleted file.

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: centralize config into config/defaults.json (single source of truth)

All version pins, port defaults, persistence paths, package names, and
the dev secret key now live in config/defaults.json. Consumers read from
it instead of hardcoding values:

- scripts/dev-safe.mjs: reads via JSON.parse(readFileSync(...))
- scripts/dev-with-automation.mjs: same
- scripts/check-sdk-version-sync.mjs: same (no longer regex-parses JS)
- docker/Dockerfile: config-gen build stage converts JSON to
  /opt/agent-canvas/defaults.env (shell-sourceable)
- docker/entrypoint.sh: sources defaults.env at startup; also adds
  session API key auto-generation so the image doesn't run wide-open
- .github/workflows/docker.yml: reads versions from JSON in a setup
  step (no more hardcoded env vars)

To bump a version, edit config/defaults.json only.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address PR review feedback (#634)

- Fix PID tracking bug: move PIDS+=($!) inside if/elif branches so the
  else (automation-not-found) path doesn't add a stale PID
- chmod 600 session API key file to prevent credential leak
- Warn when using insecure default OH_SECRET_KEY in Docker entrypoint
- Add try/catch + field validation for config/defaults.json loading in
  check-sdk-version-sync.mjs
- Fix semver tag parsing: strip pre-release/build metadata, only create
  abbreviated tags (major.minor, major, latest) for stable releases
- Sanitize branch names for Docker tags (tr invalid chars, strip leading
  dot/dash) to handle branches with #, @, spaces, etc.
- Add arch validation before manifest merge (assert both amd64.json and
  arm64.json exist)
- Remove $schema reference to non-existent defaults.schema.json

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: remove hardcoded version defaults from Dockerfile

Replace hardcoded ARG defaults (AGENT_SERVER_IMAGE, AUTOMATION_VERSION)
with empty ARGs. Values are always derived from config/defaults.json:
- CI: reads JSON in the workflow config step, passes --build-arg
- Local: new scripts/docker-build.mjs helper reads JSON and invokes
  docker build with the correct --build-arg values

Added npm run build:docker convenience script.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: stabilize snapshot tests and auto-generate Docker secret key

Two fixes:

1. **Flaky snapshot tests**: The 'Local pagination fixture' mock conversation
   used a fixed absolute timestamp (PAGINATION_BASE_TIME = May 13, 2026) for
   its created_at/updated_at, while 'Errored Project' used a relative
   timestamp (now - 7d). As real time progressed past the crossover point,
   their sort order in the sidebar flipped, causing 30/73 snapshot diffs on
   every PR. Fix: use relative timestamps (now - 6d) for the pagination
   fixture's conversation listing fields. The internal event timestamps
   (used by pagination tests) still use PAGINATION_BASE_TIME — only the
   sidebar ordering is affected.

2. **Docker OH_SECRET_KEY**: The entrypoint used a static insecure default
   for OH_SECRET_KEY and warned about it. Now mirrors the session API key
   pattern: auto-generate a cryptographic random key on first run, persist
   it to ~/.openhands/agent-canvas/secret-key.txt, and reuse on restart.
   Users can still override via the OH_SECRET_KEY env var. Removed the
   now-unused CONFIG_SECRET_KEY from the Docker defaults.env generation.
   Also deduped STATE_DIR computation (was repeated for session key path).

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: update AGENTS.md with mock timestamp and Docker secret key notes

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: include canvas_ui tool in Docker image

The Docker image was missing the tools/ directory and OH_EXTRA_PYTHON_PATH,
so the agent-server couldn't import canvas_ui_tool.py when the frontend
sent canvas_ui in the conversation tools list. This caused:

  HTTP 500: ToolDefinition 'canvas_ui' is not registered

Fix: COPY tools/ into the image and set OH_EXTRA_PYTHON_PATH in the
entrypoint, matching what scripts/dev-safe.mjs already does for local dev.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-20 04:24:45 +00:00
Rohit Malhotraandopenhands edb998220a Remove Docker dependency from dev workflow (#635) 
- Delete scripts/dev-docker.mjs and its test
- Simplify package.json: 'npm run dev' now runs local uvx stack directly
  (agent-server + automation + Vite + ingress), no Docker needed
- Remove dev:docker, dev:docker:dynamic, dev:dangerously-dockerless scripts
- Add dev:static for production-build frontend variant
- Update bin/agent-canvas.mjs CLI to use uvx-based stack
- Rename Docker-specific variables: DOCKER_PROJECTS_PATH → PROJECTS_PATH,
  shouldDefaultToDockerProjects → shouldDefaultToProjectsPath
- Update i18n: HOST_HOME_NOT_MOUNTED_HINT no longer references Docker
- Update all docs (README, DEVELOPMENT, SELF_HOSTING, AGENTS.md, CHANGELOG)
- Rename e2e snapshot: docker-workspace-browser → projects-workspace-browser
- Fix all tests to reflect new script names and remove Docker references

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-19 15:27:25 -04:00
Rohit Malhotraopenhandsallhands-bot
 		c224d24a9b fix: cloud conversation resume + archived/error sandbox states (#500) 
* fix: resume cloud conversations stuck in starting status

Two bugs prevented cloud-backend conversations from resuming properly:

1. useActiveConversation hard-coded a 30 s refetch interval. When a
   cloud sandbox is paused and auto-starts on access, conversation_url
   is null until the sandbox is ready. The WebSocket can't open without
   a URL, so curAgentState stays at LOADING ('starting status') for up
   to 30+ seconds — or forever if the user gave up before the next poll.
   Fix: use the query-state callback form of refetchInterval and drop
   to 3 s whenever conversation_url is null (mirrors the 3 s cadence of
   task polling), falling back to 30 s once the URL is available.

2. updateConversationExecutionStatusInCache called setQueryData with a
   3-element key ["user", "conversation", id] that no longer matches
   the 5-element key stored by useUserConversation
   ["user", "conversation", id, backend.id, orgId] after the
   per-backend cache isolation was added. Optimistic status writes after
   manual pause/resume were silently dropped.
   Fix: switch to setQueriesData with { queryKey: [...] } prefix
   matching so the update hits whichever (backend, org) variant is live.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: auto-resume cloud sandbox when conversation_url is null

Faster polling (prev commit) was not enough. The cloud API returns
conversation_url=null when the sandbox is paused/stopped, and a GET
request alone does not wake it up — you have to POST a new start task
(with sandbox_id to reuse the existing sandbox) and wait for it to
become READY.

Add a useEffect in AppContent that fires once per unique conversation.id
after the initial fetch:
  • skips if not a cloud backend
  • skips if conversation_url is already set (sandbox running)
  • skips if sandbox_id is null (nothing to resume)
  • guards against re-triggering within the same route-mount via a ref

On trigger it calls createConversation(sandbox_id), which POSTs
POST /api/v1/app-conversations with the sandbox_id to the cloud, gets
back a WORKING start task, then navigates to /conversations/task-{id}.
useTaskPolling drives the task to READY and redirects to the real
conversation, now with a conversation_url the WebSocket can connect to.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: navigate back to conversation when resume task fails

When the cloud sandbox fails to start (e.g. 'Sandbox failed to start
within 120s'), the task reaches ERROR status. Previously the user was
left stranded at the task-{id} URL with only a toast to show for it.

Two changes:
1. Pass resumedFromConversationId in React Router navigation state when
   navigating to task-{id} for a cloud resume, so we know where to go
   back if the task fails.
2. In the task-error effect, read that state and navigate back to the
   original conversation (or /conversations if no originator is known).
   The resume effect's ref is still set so it will not re-trigger the
   resume on landing, preventing a retry loop.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use correct sandbox resume endpoint matching OpenHands

Root cause of 'Sandbox failed to start within 120s':
The previous fix called POST /api/v1/app-conversations with sandbox_id,
which is the 'create a new conversation' endpoint. The cloud treats this
as a full sandbox provisioning request with a 120-second cold-start
timeout that can fail on old/stale sandboxes.

The correct endpoint — matching OpenHands' SandboxService.resumeSandbox
and useSandboxRecovery — is POST /api/v1/sandboxes/{id}/resume, which is
a lightweight unpause that simply wakes the existing sandbox without
reprovisioning it.

Three changes:
1. Add SandboxStatus type ('PAUSED'|'RUNNING'|'STARTING'|'MISSING') and
   sandbox_status field to AppConversation, mirroring OpenHands'
   V1SandboxStatus. The cloud API already returns this field; adding the
   type makes it accessible in TypeScript.

2. Add resumeCloudSandbox(sandboxId) to the cloud service, calling
   POST /api/v1/sandboxes/{id}/resume via the cloud proxy — symmetric
   with the existing pauseCloudSandbox.

3. Update the resume effect in conversation.tsx:
   - Detect on sandbox_status === 'PAUSED' (more precise than
     conversation_url === null, which can be null for other reasons).
   - Call resumeCloudSandbox(sandbox_id) instead of createConversation.
   - Stay on the current URL after resume — no task navigation needed.
     The 3-second refetch interval in useActiveConversation polls until
     conversation_url populates, then the WebSocket connects normally.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add ERROR to SandboxStatus to match OpenHands V1SandboxStatus

Complete enum is MISSING|STARTING|RUNNING|PAUSED|ERROR.

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: archived/error sandbox state — read-only view and sidebar indicators

When a cloud conversation's sandbox_status is MISSING or ERROR it can
never be resumed. These two states now have first-class treatment:

Sidebar / conversation list:
- ConversationStatusDot gains an optional sandboxStatus prop.
  MISSING → gray 'paused' dot with tooltip 'Archived'.
  ERROR   → red 'error' dot with tooltip 'Error'.
  (ExecutionStatus visual is used unchanged for all other states.)
- ConversationCardHeader passes sandboxStatus to the dot and sets
  isConversationArchived on the title, which applies opacity-60.
- ConversationCard renders the existing ConversationStatusBadges pill
  ('Archived' or 'Error' pill badge) for MISSING and ERROR sandboxes.
- CompactConversationRow (collapsed sidebar) passes sandboxStatus to
  both the main dot and the tooltip-preview dot.
- conversation-panel.tsx passes sandbox_status from AppConversation to
  both card variants.

Conversation view (read-only):
- ChatInterface reads sandbox_status via useActiveConversation.
- When MISSING or ERROR, the InteractiveChatBox is replaced by a
  localised banner (title + description) explaining the history is
  read-only. The banner uses data-testid='archived-conversation-banner'
  for testing.
- The auto-resume effect in conversation.tsx already skips MISSING and
  ERROR because it only fires on sandbox_status === 'PAUSED'.

i18n:
  CHAT_INTERFACE$ARCHIVED_SANDBOX_TITLE/DESCRIPTION
  CHAT_INTERFACE$ERROR_SANDBOX_TITLE/DESCRIPTION

Co-authored-by: openhands <openhands@all-hands.dev>

* test: snapshot tests for archived/error sandbox conversation states

Three new Playwright visual snapshots in
tests/e2e/snapshots/archived-conversation.snapshot.spec.ts:

1. conversation-panel-with-archived-badges
   Navigates to /conversations; verifies five conversation cards are
   present; asserts archived-badge and error-badge are both visible;
   captures the conversation panel showing:
   - 'Archived Project'  → gray dot + 'Archived' pill + dimmed title
   - 'Errored Project'   → red dot + 'Error' pill + dimmed title

2. conversation-view-archived
   Navigates to /conversations/4 (sandbox_status: 'MISSING'); stubs
   WebSocket; asserts:
   - archived-conversation-banner is visible (read-only notice)
   - interactive-chat-box is absent (count 0)
   Captures the full chat interface.

3. conversation-view-sandbox-error
   Same as above for /conversations/5 (sandbox_status: 'ERROR');
   captures the 'Sandbox error' banner variant.

Supporting changes:
- src/api/agent-server-adapter.ts
  - Add sandbox_status?: string | null to DirectConversationInfo
  - Import SandboxStatus and map info.sandbox_status → AppConversation
    so the field is no longer silently null for all conversations
- src/mocks/conversation-handlers.ts
  - Add mock conversations 4 (MISSING) and 5 (ERROR) with sandbox_status
  - createConversationResponse now includes sandbox_status in the payload
- src/components/features/chat/chat-interface.tsx
  - Suppress ChatSuggestions ("Let's start building!") for archived
    conversations — showing task suggestions alongside a read-only
    banner is confusing and misleading
- src/components/features/conversation-panel/conversation-card/
  conversation-status-badges.tsx
  - Add data-testid="archived-badge" and data-testid="error-badge"
    so Playwright can assert on their presence without relying on text
- tests/e2e/snapshots/sidebar.snapshot.spec.ts
  - Update toHaveCount(3) → toHaveCount(5) to account for the two new
    mock conversations; existing sidebar snapshot baseline needs
    regeneration on main (intentional diff via update-snapshots label)

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: make sandbox_status optional in AppConversation

sandbox_status is a cloud-only field that local agent-server conversations
never carry. Existing test fixtures built AppConversation objects without
this field, causing TypeScript to error once it became required.

Making it optional (sandbox_status?: SandboxStatus | null) is the
semantically correct choice:
- The field is absent / null for every local conversation
- The adapter still explicitly maps it to null when unset
- ChatInterface reads it with ?? null so undefined is handled safely
- Partial<AppConversation> spreads in test factory functions no longer
  widen to SandboxStatus | null | undefined

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: Prettier formatting — multiline SandboxStatus union and ternary

- SandboxStatus type: expand single-line union to multi-line format
- ConversationCard: wrap sandboxStatus ternary in a multiline JSX block

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: preserve sandbox_status through requireDirectConversationInfo

The validation function that normalises raw API responses into
DirectConversationInfo was not copying sandbox_status, so it was silently
dropped every time a conversation came through the search or batch-get
code paths. This caused the conversation panel to never render the
archived/error badge pills, and the ChatInterface to always treat every
conversation as active (missing read-only banner for MISSING/ERROR sandboxes).

Fix: add sandbox_status: stringOrNull(item.sandbox_status) to the
mapping in requireDirectConversationInfo, mirroring the treatment of
execution_status.

The existing E2E tests for conversations 4 (MISSING) and 5 (ERROR)
were already asserting on archived-badge / error-badge presence and
archived-conversation-banner visibility, so they will now pass.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: don't connect WebSocket while cloud sandbox is PAUSED

When a cloud conversation is closed from the UI (pauseCloudSandbox is
called), the conversation's conversation_url is NOT cleared — it still
points to the old sandbox host. On the next navigation into that
conversation the WebSocket provider saw a non-null URL and immediately
tried to open a connection, which failed because the sandbox had not
yet woken up.

Two-part fix:

1. WebSocketProviderWrapper: suppress conversationUrl (treat it as null)
   while sandbox_status === 'PAUSED', so ConversationWebSocketProvider
   cannot compute a valid wsUrl until the sandbox is actually running.

2. useActiveConversation: add sandbox_status === 'PAUSED' as a
   fast-poll trigger alongside !conversation_url. The old check only
   fast-polled when the URL was absent; for paused sandboxes the URL is
   present but stale, so without this the hook would stay on the slow
   30-second interval while waiting for the sandbox to wake up.

Together these changes let the resume sequence complete correctly:
  navigate → sandbox PAUSED detected → resumeCloudSandbox called →
  fast-poll picks up RUNNING state → conversationUrl unblocked →
  WebSocket connects with a live sandbox host.

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: document cloud PAUSED sandbox WebSocket gating in AGENTS.md

Co-authored-by: openhands <openhands@all-hands.dev>

* test: cover PAUSED sandbox gating and sandbox_status preservation

Three test suites covering the cloud conversation resume bug fixes:

1. agent-server-conversation-service.test.ts — three cases asserting
   that requireDirectConversationInfo preserves sandbox_status through
   batchGetAppConversations (PAUSED, RUNNING, absent → null).

2. websocket-provider-wrapper.test.tsx — five cases asserting that
   WebSocketProviderWrapper passes conversationUrl through when the
   sandbox is RUNNING or null (local backend), suppresses it to null
   when sandbox_status === 'PAUSED', and handles not-yet-fetched data.

3. use-active-conversation.test.ts — five cases asserting that the
   refetchInterval callback returns 3000 when sandbox_status is PAUSED
   (even with a non-null conversation_url) or when conversation_url is
   null, and 30000 in all other ready states.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(test): use null for execution_status fixture field

ExecutionStatus is a string enum — assigning the raw string literal
'idle' triggers TS2322. Null satisfies ExecutionStatus | null and is
irrelevant to what these tests actually exercise.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(lint): prettier format + add missing i18n fallbacks for 7 keys

Two issues from lint-staged pre-commit hook:

1. Prettier: the compound refetchInterval condition in use-active-
   conversation.ts was too long for one line — broke across three lines.

2. Translation completeness: CHAT_INTERFACE$ARCHIVED_SANDBOX_TITLE/
   DESCRIPTION, CHAT_INTERFACE$ERROR_SANDBOX_TITLE/DESCRIPTION, and
   BACKEND$NAME_REQUIRED/HOST_REQUIRED/HOST_INVALID were added in earlier
   commits on this branch but only had English values. Added English
   fallbacks for all 14 other supported locales in translation.json and
   regenerated public/locales/ via make-i18n.

Co-authored-by: openhands <openhands@all-hands.dev>

* i18n: add proper translations for 7 new keys across 14 locales

The previous commit used English as a fallback for all non-English
locales. Replace with proper translations for:

  CHAT_INTERFACE$ARCHIVED_SANDBOX_TITLE
  CHAT_INTERFACE$ARCHIVED_SANDBOX_DESCRIPTION
  CHAT_INTERFACE$ERROR_SANDBOX_TITLE
  CHAT_INTERFACE$ERROR_SANDBOX_DESCRIPTION
  BACKEND$NAME_REQUIRED
  BACKEND$HOST_REQUIRED
  BACKEND$HOST_INVALID

Locales covered: ja, zh-CN, zh-TW, ko-KR, no, ar, de, fr, it, pt,
es, ca, tr, uk.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: also write sandbox_status PAUSED to cache on stop-conversation

Bug: clicking 'Stop conversation' called pauseConversation() and then
only wrote execution_status: PAUSED to the React Query cache via
updateConversationExecutionStatusInCache.  sandbox_status was never
touched, so it remained as whatever the server last returned (null or
'RUNNING').

When the user reopened that conversation:
  • WebSocketProviderWrapper checked sandbox_status === 'PAUSED' → false
    → URL passed through → WebSocket fired at the paused sandbox → failed
  • useActiveConversation saw sandbox_status !== 'PAUSED' AND url !== null
    → 30-second poll interval → 30s before discovering the true state

Fix:
  1. Add patchConversationInCache() to conversation-mutation-utils —
     a generic helper that patches any subset of AppConversation fields
     in both the single-item and paginated-list query caches.
     updateConversationExecutionStatusInCache becomes a thin wrapper.
  2. use-unified-stop-conversation.ts uses patchConversationInCache to
     write BOTH execution_status: PAUSED and sandbox_status: 'PAUSED'
     atomically in onSuccess, so the gate in WebSocketProviderWrapper
     fires immediately on the next render.

Tests: __tests__/hooks/mutation/conversation-mutation-utils.test.ts
  • patchConversationInCache patches single-item cache
  • patchConversationInCache patches paginated list cache
  • patchConversationInCache patches multiple fields atomically
  • patchConversationInCache does not modify unrelated conversations
  • patchConversationInCache is a no-op on empty cache
  • updateConversationExecutionStatusInCache wrapper only touches
    execution_status (sandbox_status is left unchanged)

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(ui): archived/error banner — 'above' copy and readable text colors

Two issues with the archived/error sandbox banner that replaces the
chat input:

1. Copy said 'The history below is read-only' but the banner is
   anchored to the bottom of the chat, so the history is above it.
   Changed to 'above' in all 15 locales (en + ja/zh-CN/zh-TW/ko-KR/
   no/ar/de/fr/it/pt/es/ca/tr/uk).

2. Description text used text-[var(--oh-color-tertiary)] which maps to
   cool-grey-800 — nearly indistinguishable from the cool-grey-925
   surface background. Switched to the palette tokens that the rest of
   the UI uses for readable text on dark surfaces:
   • Title:       --oh-foreground  (cool-grey-100, bold label)
   • Description: --oh-muted       (cool-grey-400, secondary body text)

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(snapshots): render echo-hello-world trajectory in archived/error views; fix lint

Three changes in one commit:

1. Prettier lint fix (conversation-mutation-utils.ts line 116):
   The one-line arrow body for updateConversationExecutionStatusInCache
   exceeded Prettier's column limit when written inline; split onto its
   own line. This fixes the 'test-and-build (ubuntu) Lint' CI failure.

2. MSW event fixture (src/mocks/conversation-handlers.ts):
   Add ECHO_HELLO_WORLD_TRAJECTORY — three events in TIMESTAMP_DESC
   order (newest-first, as the hook requests) that represent a minimal
   'echo hello world' session:
     archived-evt-1  user MessageEvent    'echo hello world'
     archived-evt-2  agent ExecuteBashAction  echo hello world
     archived-evt-3  env   ExecuteBashObservation  'hello world'
   Wire CONVERSATION_EVENTS map so GET /api/conversations/4/events/search
   and /5/events/search return these events; other conversations still
   get []. useConversationHistory reverses the DESC list back to
   chronological order before storing events.

3. Snapshot test (archived-conversation.snapshot.spec.ts):
   Wait for chatInterface.getByText('echo hello world') to be visible
   before taking the screenshot so the trajectory is guaranteed to have
   rendered above the read-only archived/error banner.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(snapshots): inject trajectory via Zustand store, not MSW cross-origin fetch

The Service Worker registered at localhost:3001 cannot intercept
cross-origin requests; RemoteEventsList calls GET on the configured
backend host (127.0.0.1:8000), so MSW silently drops the response and
useConversationHistory returns no events.

Fix: pull the injectEvents helper pattern from
collapsible-thinking.snapshot.spec.ts and call it after asserting the
archived/error banner is visible.  The fixture is declared once at the
top of the file alongside a clear comment explaining why it mirrors the
MSW handler rather than importing from it.

Also removes the 10 s timeout from the post-inject getByText check
since injectEvents already polls until the store is populated and then
waits 500 ms for React to flush.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(snapshots): atomic addEvents+DOM poll in injectEvents, no separate getByText

The previous impl had a two-step race window:
  1. expect.poll passed once store.events.length >= N
  2. 500 ms wait (or DOM waitForFunction) ran afterwards

React Strict-Mode's double clearEvents() invocation could fire between
steps 1 and 2, wiping the store before React flushed the render.

Fix: merge addEvents() and the data-testid="user-message" DOM check into
a single page.waitForFunction() poll.  Playwright polls ~100 ms so on
every tick we both re-seed the store AND verify the DOM element is
present.  addEvents() is idempotent (deduplicates by event ID) so
calling it on every tick is safe.  This eliminates the race entirely.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(snapshots): wait for archived-banner as settled-state signal in tests 2/3

The previous approach waited for `chat-interface` (h-full flex div) to become
visible, but that container can be present in the DOM with zero computed height
before useActiveConversation resolves — causing intermittent 20 s timeout
failures in CI.

Following the same pattern as collapsible-thinking.snapshot.spec.ts (which
waits for `"Let's start building!"` as its settled-state signal), tests 2/3
now use a dedicated `navigateToArchivedConversation` helper that waits for
`archived-conversation-banner` to be visible (timeout 30 s).

The banner only renders after useActiveConversation returns data with
sandbox_status MISSING or ERROR, so it is a reliable indicator that:
  - the MSW mock responded to GET /api/conversations?ids=<id>
  - React Query received the data and set isFetched = true
  - ChatInterface evaluated isArchivedConversation = true
  - The banner div is both present and has non-zero dimensions

Also removes the now-redundant in-test banner visibility checks (the helper
already asserts them) and the stale `navigateToConversation` helper that was
no longer used.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(snapshots): MSW ids[] parse bug + inject one event for stable archived-view test

Root cause of snapshot CI failures:

  Axios serializes { ids: ["4"] } as ?ids[]=4 (bracket notation).
  The MSW GET /api/conversations handler read searchParams.getAll("ids"),
  which returns [] when the key is "ids[]". listConversationResponses([])
  then falls back to returning ALL conversations, so results[0] was always
  conversation "1" (first in Map insertion order) regardless of which id
  was requested. Conversation "1" has no sandbox_status, so
  isArchivedConversation was always false and the archived banner never
  rendered — 30 s timeout.

Fix 1 — conversation-handlers.ts:
  Parse both bracket (ids[]) and plain (ids) formats so the mock correctly
  returns only the requested conversation(s).

Fix 2 — archived-conversation.snapshot.spec.ts:
  Rewrite tests 2/3 per user direction:
  • Use seedLocalStorage (same as collapsible-thinking) instead of bespoke
    addInitScript + page.route helpers.
  • Inject ONE minimal ExecuteBashAction event via __OH_EVENT_STORE__ so the
    chat has stable visible content that survives the 3 s polling re-renders
    (conv 4/5 have no conversation_url, so useActiveConversation polls every
    3 s). The injected event stays in the Zustand store across re-renders,
    giving toBeVisible a reliable anchor.
  • Wait for "echo hello" text (event), then wait for the archived banner —
    both are concrete settled-state signals, not the zero-height h-full div.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: trigger CI re-run

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: Update PR QA artifacts

* fix(tests): single injected event for archived-view + useOptionalConversationId mocks

- Remove ECHO_HELLO_WORLD_TRAJECTORY from MSW (was causing 3+1 = 4 events
  in the archived conversation snapshot view). CONVERSATION_EVENTS is now
  empty; the snapshot tests inject exactly one event via __OH_EVENT_STORE__.
- Add useOptionalConversationId to all vi.mock('#/hooks/use-conversation-id')
  calls that were missing it after the main merge refactored that hook.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(snapshots): wait for banner before injecting events to avoid clearEvents race

The archived-conversation snapshot tests were injecting events via
__OH_EVENT_STORE__ immediately after the store became available on the
window object. However, the conversation route's useEffect (which calls
clearEvents()) fires asynchronously after the first paint — creating a
race where the injected events get wiped.

Fix: wait for the archived-conversation-banner to appear before
injecting events. The banner's presence proves that:
1. The route's clearEvents() effect has already fired
2. useActiveConversation has resolved with the correct sandbox_status
3. The chat interface is ready to accept and display events

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(snapshots): pre-seed archived conversation events via MSW instead of runtime store injection

The archived-conversation snapshot tests were injecting events into the
Zustand event store at runtime via __OH_EVENT_STORE__. This raced with
the conversation route's useEffect (clearEvents) and React dev-mode
double-mount behavior, making the injected events disappear before the
chat could render them.

Fix: pre-seed CONVERSATION_EVENTS in the MSW mock handlers for
conversations 4 and 5 with one ExecuteBashAction event. The events now
load through the normal REST history path (useConversationHistory →
addEvents) — no runtime Zustand injection, no race condition.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(snapshots): remove event injection — test banner + hidden input only

The archived-conversation snapshot tests kept crashing because event
injection (both via __OH_EVENT_STORE__ and pre-seeded MSW REST data)
always gets wiped by a React 18 strict mode effect-ordering issue:

In dev mode, strict mode double-fires effects child-before-parent.
ConversationWebSocketProvider (child) calls addEvents() first, then
conversation.tsx (parent) calls clearEvents() second, wiping all events.

Since the feature under test is the read-only banner and hidden chat
input (not event rendering), simplify the tests to verify only those
assertions — no event injection needed.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(snapshots): add WebSocket stub to archived-conversation tests

The conversation-view snapshots showed a red 'Failed to connect to
server' toast because no agent-server runs at :8000 in CI — the Vite
proxy's ECONNREFUSED propagates to the browser and triggers the error
toast. Other conversation-page snapshot tests already stubbed
WebSocket; this test was missing it.

Extract the duplicated WebSocket stub into a shared helper at
tests/e2e/snapshots/support/stub-websocket.ts and use it in all three
conversation-page snapshot test files (archived-conversation,
collapsible-thinking, changes-tab).

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: update conversation card count from 5 to 6 after main merge

Main added pagination-local conversation fixture, bringing the total
mock conversations to 6. The archived-conversation sidebar test was
still asserting 5.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: update backends-extended snapshot tests for two-column add modal

The add-backend modal was refactored from a single form with radio
buttons (local/cloud kind selection) into a two-column layout:
- Left: manual connection (name, host, API key, Connect)
- Right: cloud OAuth login (device flow)

Kind is now inferred from the host URL, so the old radio button
testids (add-backend-kind-local, add-backend-kind-cloud) no longer
exist. Updated all affected flows:
- Flow 1: removed radio clicks, use URL inference for kind
- Flow 2: replaced radio inference tests with two-column layout test
- Flow 3: replaced OAuth button gating with cloud advanced settings
- Flow 7: removed radio click
- Flow 8: use add-backend-close instead of add-backend-cancel

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: update sidebar snapshot test conversation count from 5 to 6

Same pagination-local fixture issue as archived-conversation test.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: allhands-bot <allhands-bot@users.noreply.github.com>
 2026-05-17 13:27:52 -04:00
Rohit Malhotraandopenhands 60e103eec5 fix: route cloud runtime bash/file calls through cloud proxy (#507) 
* fix: route cloud runtime bash/file calls through cloud proxy

useWorkspaceFiles, useLocalGitInfo, useHasGitCommits were all building
RemoteWorkspace with getAgentServerClientOptions({ conversationUrl }),
which resolves the host directly to the cloud runtime URL when a cloud
conversation is active (e.g. *.prod-runtime.all-hands.dev).  This caused
CORS errors because the browser made the fetch from localhost.

useWorkspaceFileContent had the same issue for GET /api/file/download.

The fix centralises these operations in a new
AgentServerRuntimeService (src/api/runtime-service/) that mirrors the
pattern already used by agent-server-git-service and event-service:

  if (active.kind === 'cloud' && conversationUrl)
    -> callCloudProxy({ hostOverride: buildHttpBaseUrl(conversationUrl), authMode: 'session-api-key', ... })
  else
    -> SDK typed clients directly

- executeCommand  routes POST /api/bash/execute_bash_command
- downloadFile    routes GET  /api/file/download

use-local-git-info helper functions (probeGitInfoAtDir,
probeNestedRepoInDir) are refactored from taking a RemoteWorkspace
instance to taking a RunCommand callback, keeping the helpers pure.

Co-authored-by: openhands <openhands@all-hands.dev>

* test: cover AgentServerRuntimeService cloud/local routing

Adds 12 unit tests for AgentServerRuntimeService covering:
- executeCommand local path: RemoteWorkspace constructed with resolved
  options; callCloudProxy never called
- executeCommand cloud path: callCloudProxy invoked with POST to
  /api/bash/execute_bash_command, correct hostOverride, body, session-
  api-key auth, and timeoutSeconds; RemoteWorkspace never created; cwd
  omitted when undefined; null stdout/stderr normalised to empty strings;
  null conversationUrl falls back to local
- downloadFile local path: FileClient constructed with resolved options;
  callCloudProxy never called
- downloadFile cloud path: callCloudProxy invoked with GET to
  /api/file/download with URL-encoded path, blob responseType, session-
  api-key auth; FileClient never created; Blob→ArrayBuffer round-trip
  preserves content; null conversationUrl falls back to local

Also adds a cloud-backend integration test to
use-workspace-file-content.test.tsx confirming the hook routes
downloads through callCloudProxy instead of FileClient when a cloud
backend is active, and that callCloudProxy is called with the correct
path/auth/responseType.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-16 04:40:41 +00:00
Rohit Malhotraandopenhands 43e6db6919 docs: add API access rules to AGENTS.md and code review skill (#506) 
Document the two mandatory API access conventions that are enforced by
the CI test src/api/no-direct-agent-server-calls.test.ts:

1. All agent-server calls must use typed @openhands/typescript-client
   classes (ConversationClient, FileClient, VSCodeClient, ServerClient,
   RemoteWorkspace, RemoteEventsList) instantiated via
   getAgentServerClientOptions() -- never raw axios/fetch.

2. All cloud SaaS and runtime-sandbox calls must go through
   callCloudProxy() in src/api/cloud/proxy.ts to avoid CORS, using
   hostOverride for runtime-sandbox URLs and authMode='session-api-key'
   for those endpoints.

AGENTS.md gets a full '## API Access Rules' section with client
listings, option helper references, CORRECT/WRONG code examples, and
the allowed-exceptions list.

The custom-codereview-guide.md skill gets a '## Frontend API Access
Conventions' section with DO NOT APPROVE triggers, forbidden pattern
lists, correct examples, and a note about the silent hostOverride bug.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-16 04:30:01 +00:00
Rohit Malhotraandopenhands acb04fd9ba perf(snapshots): skip retries on comparison pass, suppress consent modal (#505) 
- Add --retries=0 to test:e2e:snapshots: snapshot pixel-diff failures are
  deterministic — retrying cannot fix them. On a PR that changes 36/60
  snapshots this tripled execution count and added ~2 min to the comparison
  pass.

- Extract seedLocalStorage() helper (tests/e2e/snapshots/support/) that
  seeds openhands-onboarded and openhands-telemetry-consent in a single
  addInitScript call. All 13 snapshot specs now use it instead of
  duplicated inline addInitScript blocks.

- Pre-seeding openhands-telemetry-consent='denied' eliminates the race
  condition where changes-tab timed out at 60 s (x3 retries = 3 min) because
  dismissConsentModal fired before the modal rendered with domcontentloaded.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-16 00:04:29 -04:00
Rohit Malhotraopenhandsgithub-actions[bot]
 		14d2e9454b test(snapshot): changes tab diff viewer + backend management UI (6 tests) (#450) 
* test(snapshot): changes tab diff viewer + backend management UI (6 tests)

Pre-seed MOCK_GIT_CHANGES with M/A/D entries (using AgentServerGitChangeStatus
values: UPDATED/ADDED/DELETED) so changes-tab tests can exercise the file list,
Monaco diff viewer, and deleted-file placeholder without per-test MSW manipulation.

Expose window.__setMockGitChanges__ so the empty-state test can clear the list
after boot and trigger a React Query refetch via __TEST_INVALIDATE_QUERIES__,
avoiding a full page reload that would reinitialise module state.

Backend management tests exercise the selector dropdown, add-backend modal, and
manage-backends modal — all driven by localStorage seeding via addInitScript.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* ci: trigger re-run against CI-generated baselines

* fix(snapshot-tests): mask Monaco editor for stable CI screenshots; fix unit test

- changes-tab spec: mask data-testid=editor-container so Monaco's sub-pixel
  font hinting (which varies per OS) doesn't cause false pixel-diff failures
- mock-conversation-handlers test: update assertion to match the new pre-seeded
  MOCK_GIT_CHANGES (3 M/A/D entries) instead of the previous empty array

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* ci: trigger re-run against CI-regenerated baselines (Monaco mask + unit test fix)

* fix(snapshot-tests): normalize RandomTip height via addStyleTag for stable empty-state screenshot

RandomTip renders a randomly-chosen tip whose line-count varies, causing the
flex-1 container above it to have different heights across runs. Fix by injecting
a CSS rule via page.addStyleTag() that pins .text-m.bg-tertiary.p-4 to 80px
(visibility:hidden so the variable text is invisible) — layout is now deterministic.
Switch back to screenshotting the full files-tab panel since dimensions are stable.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* ci: trigger re-run against baselines (empty-state RandomTip height fix)

* fix(snapshot-tests): use inner content div for empty-state screenshot to avoid left-strip artefact

Screenshot files-tab's last direct div child (the flex-1 content wrapper)
instead of the outer main element.  During CI baseline generation the outer
main's bounding box occasionally captured a ~30px left-panel overlay artefact
that made the baseline permanently diverge from subsequent verification runs.
Targeting the inner wrapper excludes the outer-element overflow while still
showing the full empty-state (icon + 'no changes yet' text + hidden tip area).

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* ci: validate against fresh inner-div empty-state baseline

* test(snapshot): extended backend UI flows — 12 tests, 19 screenshots

Add backends-extended.snapshot.spec.ts covering 8 behaviour flows
with iterative screenshot captures at each state transition:

Flow 1a  Blank add form — Save disabled until name+host filled
Flow 1b  Local backend — Save enabled with name+host, no API key needed
Flow 1c  Cloud backend — Save disabled without API key, enabled with it
Flow 2a  Host auto-infers Local kind; OAuth section disappears
Flow 2b  Cloud-domain URL keeps Cloud kind; OAuth section shows
Flow 2c  Manual kind selection locks type (touchedKind=true) even when
         a cloud URL is later typed into the Host field
Flow 3   OAuth Login button disabled while host is empty; enabled once filled
Flow 4   Remove backend: shows ConfirmationModal → Cancel keeps row →
         Confirm removes it from the list (4 screenshots)
Flow 5   Edit modal pre-populates name/host/key from stored backend
Flow 6   Switch active backend: environment-switch overlay captured via
         page-level screenshot + animation override so the card is
         opaque at frame-0; after-switch state verified via selector label
Flow 7   Whitespace-only host keeps Save disabled; syntactically invalid
         URL is accepted by the frontend (no URL-format validation)
Flow 8   Cancel add form: dismisses modal, Manage Backends confirms no
         phantom entry was saved

Notable decisions:
- Uses body[data-environment-switching="true"] as the early DOM signal
  before React paints the portal div for the switch overlay
- Adds inline style-tag override before the overlay screenshot because
  .environment-switch-overlay > div has opacity:0 at animation frame 0;
  Playwright's animations:"disabled" pauses there, making the card
  invisible without the override
- Backends seeded via page.addInitScript localStorage injection so
  tests are fully self-contained with no MSW state dependency

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* ci: validate extended backend snapshot tests against CI baselines

* ci: always post snapshot PR comment even when test generation step fails

The 'Post snapshot report to PR' step was skipped whenever 'Generate
current PR snapshots' exited non-zero (e.g. a test crash like a hidden
element, not just a snapshot diff). GitHub Actions skips steps without
an always() guard when a prior step fails.

Add always() so the comment is posted regardless — showing diffs or
the test failure output — which was the intended behaviour.

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: fix snapshot comment - remove tracked screenshots, add crash reporting

Three fixes:

1. Remove 28 git-tracked snapshot PNGs from this branch.
   These were committed by the old baseline-in-git workflow before #482
   migrated to artifact storage. Because they stayed tracked (gitignore
   doesn't untrack already-indexed files), every CI checkout put them in
   tests/e2e/__snapshots__/ BEFORE the baseline artifact was downloaded.
   The Save step then copied them into /tmp/main-baselines, making the
   new tests appear as 'Unchanged' instead of 'New' in the PR comment.

2. Add 'Clear snapshot directory before downloading baselines' step.
   Wipes tests/e2e/__snapshots__/ before the artifact download so any
   future accidentally-tracked files can never contaminate the baseline.

3. Surface test crashes in the PR comment.
   - Generate step gets continue-on-error + an id so subsequent steps
     can read its outcome.
   - GENERATE_OUTCOME is passed to the comment script.
   - If outcome == 'failure', a GitHub-flavoured WARNING callout is
     prepended to the comment with a direct link to the CI run logs.
   - A dedicated 'Fail if snapshot generation had test crashes' step
     restores the job failure that continue-on-error absorbed.

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: use PR number in snapshot concurrency group for cleaner cancellation

The previous group used github.ref which resolves to refs/pull/{N}/merge
for PR events — correct but opaque. Using github.event.pull_request.number
makes the grouping explicit and human-readable (snapshot-tests-450), and
falls back to github.ref for main pushes and workflow_dispatch.

cancel-in-progress: true was already set, so new commits already cancelled
prior runs. This just makes the intent clearer.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: syntax error in post-snapshot-comment.mjs (] vs ) in lines.push)

lines.push(...) was accidentally closed with ]; instead of ); after
splitting the original lines = [...] array literal into a push call.
Caused a SyntaxError at startup, preventing any comment from being posted.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: snapshot test disabled states, changes-tab crash, and CI false-failures

Three fixes:

1. BrandButton disabled visual styling (brand-button.tsx)
   disabled:opacity-30 pseudo-class was not applying in Vite dev mode
   (Tailwind v4 + postcss-prefix-selector interaction), making disabled
   and enabled buttons visually identical in snapshot screenshots.
   Fix: add isDisabled conditional class directly ('opacity-30
   cursor-not-allowed pointer-events-none') so the disabled appearance
   is applied regardless of whether :disabled pseudo-class works.

2. changes-tab test crash (changes-tab.snapshot.spec.ts)
   Test waited for data-testid='files-tab' but the right panel always
   starts CLOSED (isRightPanelShown = false is session-only Zustand
   state; sanitizeStoredState strips any persisted rightPanelShown key).
   Fix: click data-testid='right-panel-toggle' after navigation to open
   the panel before waiting for files-tab. Also remove the no-op
   rightPanelShown: true from the localStorage seed.

3. CI false-failures for new snapshot tests (snapshot-tests.yml +
   post-snapshot-comment.mjs)
   The 'Fail if comparison found differences' step fired on
   'missing baseline' failures (expected for new tests in a PR) as
   well as actual pixel-diff failures.
   Fix:
   - post-snapshot-comment.mjs outputs has_changes=true/false to
     GITHUB_OUTPUT (true only when changed.length > 0, i.e. real diffs)
   - 'Fail if' step now checks steps.post-comment.outputs.has_changes
     == 'true' instead of compare.outcome == 'failure', so PRs that
     only add new snapshot tests pass CI cleanly.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: reject invalid host URLs in backend form; use http for local addresses

Two related fixes to backend host validation / normalisation:

1. isValidHostUrl() — reject invalid host strings
   canSubmit previously only checked host.trim().length > 0, so
   garbage like 'not://:::a valid url!!!' passed through and enabled
   the Save button. isValidHostUrl() adds two checks before the URL
   constructor: (a) the trimmed value must be non-empty, (b) it must
   contain no whitespace. This catches the test-case input whose spaces
   are the tell-tale sign of a malformed value.

2. normalizeHost() — http:// for local addresses
   Bare hostnames (no explicit scheme) were unconditionally prepended
   with https://, but local servers almost never have TLS certificates.
   The new isLocalAddress() helper detects localhost, 127.x, RFC-1918
   private ranges (10.x, 192.168.x, 172.16-31.x), .local / mDNS names,
   and single-label hostnames — all get http:// instead of https://.
   Hostnames with dots that are not in those ranges (e.g. app.all-hands.dev)
   still default to https://. Explicit http:// or https:// prefixes are
   always preserved as-is.

Test update: the 'backend-add-invalid-url-accepted' snapshot is renamed
to 'backend-add-invalid-url-disabled' and the assertion flips from
not.toBeDisabled() → toBeDisabled(), reflecting the new behaviour.

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: inline error feedback on Name and Host fields in BackendForm

Three parts:

1. SettingsInput gains error / showRequiredTag / onBlur props
   - error?: string — red border on the input plus a small red alert
     paragraph below it (role=alert, data-testid=${testId}-error, linked
     via aria-describedby).
   - showRequiredTag?: boolean — renders a red * after the label to
     signal that the field is mandatory, consistent with OptionalTag.
   - onBlur?: () => void — forwarded directly to the <input>.
   - aria-invalid is set automatically when error is truthy.

2. BackendForm wires touched state → errors → inputs
   - nameTouched / hostTouched (both false on open, set on blur)
   - nameError: 'Name is required' when touched + empty
   - hostError: 'Host is required' when touched + blank/whitespace;
                'Enter a valid URL (e.g. http://localhost:8080)' when
                touched + non-empty but fails isValidHostUrl()
   - Both name and host SettingsInputs get showRequiredTag, the
     computed error, and onBlur={() => setXTouched(true)}.
   Errors are intentionally suppressed until blur so the form does not
   scold the user before they have had a chance to type anything.

3. Three snapshot tests call .blur() after .fill() to reveal errors
   - backend-add-name-only-disabled: focus+blur empty host → 'Host is
     required' appears below the Host field.
   - backend-add-whitespace-host-disabled: blur after fill('   ') →
     same 'Host is required' (whitespace counts as empty).
   - backend-add-invalid-url-disabled: blur after invalid URL fill →
     'Enter a valid URL...' appears below the Host field.
   The backend-add-blank-disabled snapshot is unchanged (neither field
   touched, no errors yet — correct for the fresh-open state).

New i18n keys: BACKEND$NAME_REQUIRED, BACKEND$HOST_REQUIRED,
BACKEND$HOST_INVALID (English only; other locales fall back to en).

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: prettier formatting on nameError / hostError ternaries

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: disable OAuth Login button until name and host are both valid

Previously the 'Login with OpenHands' button was enabled as soon as
a non-empty host was typed, even when the Name field was still blank.
This let users go through the full OAuth device-flow only to find they
still couldn't save because the name was missing.

Gate isDisabled on !name.trim() || !isValidHostUrl(host) so the button
stays disabled until the form is actually ready to save (modulo the
API key that OAuth itself will provide).

Update Flow 3 snapshot test to fill the name before asserting the
button becomes enabled, and update the test description accordingly.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: address PR review feedback (#450)

IPv6 parsing fixes (normalizeHost / isLocalAddress):
- normalizeHost: handle bracket notation [::1]:8080 (extract ::1),
  bare IPv6 addresses with multiple colons (use whole string as
  hostname), and regular host:port as before — prevents split(':')[0]
  from grabbing only the first segment of a multi-colon IPv6 address
- isLocalAddress: strip brackets before comparison; add :: (any-addr),
  ::ffff:127.x.x.x (IPv4-mapped loopback), fe80::/10 (link-local),
  fc00::/7 (unique local); tighten single-label check to exclude
  addresses that contain colons (bare IPv6 non-local addresses)

Mark fields touched on submit attempt:
- handleSubmit sets nameTouched + hostTouched when !canSubmit so
  inline errors appear for keyboard users who press Enter on an
  incomplete form

Snapshot workflow comparison-crash detection:
- Pass COMPARE_OUTCOME=${{ steps.compare.outcome }} to post-comment
- post-snapshot-comment.mjs reads COMPARE_OUTCOME and prepends a
  '[!WARNING]' block when the comparison step itself crashed
  (timeout/OOM) so the comment accurately reflects the run state
  instead of silently showing an incomplete/empty diff table

Remove unnecessary serial mode from backends-extended snapshot suite:
- Each test calls setupPage() with fresh state on its own Playwright
  page; no shared mutable state exists between tests, so serial is
  unnecessary and slows the suite

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
 2026-05-15 23:14:30 -04:00
Rohit Malhotraandopenhands 9203a72d64 feat(snapshot-ci): group PR comment snapshots by spec file (#499) 
Previously every changed/new snapshot got its own ### heading and table,
making it hard to see which snapshots belong to the same feature or flow
(e.g. the four-step MCP Slack install flow, the five-step secrets
lifecycle, or the skills search/filter sequence).

Group all three sections (🔴 Changed, 🆕 New, ✅ Unchanged) by spec file:

- Replaced formatRelPath() with specFromRelPath() + groupBySpec() helpers.
- Changed / New: one ### heading per spec (with count when > 1 snapshot),
  then **bold name** + the 3-column expected|actual|diff table per snapshot.
- Unchanged: compact grouped bullet list — bold spec heading, then one
  bullet per snapshot name, no superfluous intro sentence.

No workflow changes required; the grouping is purely in the comment script.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-15 22:45:14 +00:00
Rohit Malhotraandopenhands 63704f65e5 test: rename sidebar nav label "New" → "Chats" to verify snapshot CI diff comment (#497) 
* test: rename sidebar nav label New → Chats to trigger snapshot diff

Intentional one-line change to verify that the snapshot CI workflow
correctly posts a PR comment showing the expected/actual/diff images.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(snapshot-ci): save comparison test-results before update step clears them

Root cause: Playwright wipes its output directory (test-results/) at the
start of each new run.  The workflow runs the tests twice:
  1. npm run test:e2e:snapshots        → comparison, writes *-diff.png files
  2. npm run test:e2e:snapshots:update → regenerates baselines, clears
                                         test-results/ first, no diffs written

By the time post-snapshot-comment.mjs runs, all diff files are gone.
diffBySnapshotName is always empty, so every snapshot is classified as
"unchanged" even when Playwright reported 16 failures.

Fix:
- Add a "Save comparison test-results" step immediately after the
  comparison run that copies test-results/ to /tmp/comparison-results
  before the update pass can delete them.
- Pass COMPARISON_RESULTS_DIR=/tmp/comparison-results to the comment script.
- In post-snapshot-comment.mjs, read TEST_RESULTS_DIR from
  COMPARISON_RESULTS_DIR env var (falls back to "test-results" for local use).

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: document snapshot CI comparison-results ordering in AGENTS.md

Co-authored-by: openhands <openhands@all-hands.dev>

* revert: restore sidebar nav label to New

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-15 18:34:00 -04:00
Rohit Malhotraandopenhands c3de18580d ci: increase Playwright CI workers from 1 to 2 (#495) 
ubuntu-24.04 runners have 2 vCPUs. Each Playwright worker runs in its own
browser context so tests are fully isolated (MSW state, localStorage, and
React Query cache are all page-level). Doubling from 1→2 workers should
roughly halve wall-clock test time on CI with no risk of interference.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-15 16:53:27 -04:00
Rohit Malhotraandopenhands d886a68a43 fix: prevent snapshot CI runs from sending PostHog analytics events (#490) 
* fix: separate PostHog keys for production and dev builds

The telemetry service (canvas_install events) was using a single
hardcoded PostHog key as a fallback in every build, so CI snapshot
tests sent events to the same project as real users, inflating the
unique-persons count and making install metrics unreliable.

Changes:

src/services/telemetry.ts
- POSTHOG_API_KEY is now string | null keyed off import.meta.env.PROD:
  - Production: VITE_POSTHOG_API_KEY || 'phc_REPLACE_WITH_PRODUCTION_KEY'
    (placeholder — swap in the real key before deploying)
  - Dev/test: VITE_POSTHOG_API_KEY || null
    PostHog never initialises when the key is null, so no events reach
    any PostHog project from dev servers or CI snapshot runs.
- initializePostHog() now returns null immediately when POSTHOG_API_KEY
  is null, before loading the posthog-js module at all.

src/mocks/analytics-handlers.ts
- Added https://z.openhands.dev/* intercept alongside the existing
  https://us.i.posthog.com/e handler. The library telemetry service
  routes through z.openhands.dev (the OpenHands reverse proxy), which
  MSW previously never saw.

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: hardcode PostHog keys per deployment environment

Select the PostHog key based on hostname rather than a single constant or
env var override:
- app.all-hands.dev  → POSTHOG_PROD_KEY
- staging.app.all-hands.dev → POSTHOG_STAGING_KEY (shares prod key for
  now; swap to a dedicated project key when one is provisioned)
- all other origins   → null (no tracking)

Both the app-level PostHog (option-service / posthog-wrapper) and the
library telemetry service (telemetry.ts) follow the same pattern.
VITE_POSTHOG_API_KEY still works as an escape hatch for library consumers.

Drop VITE_DO_NOT_TRACK=1 from dev:mock: hostname detection already
returns a null key for localhost, so PostHog never initialises there.
Removing the flag also restores the TelemetryConsentBanner in snapshot
tests (the banner can be snapshotted correctly again).

Also adds PRODUCT_URL.STAGING to constants and a null guard in
initializePostHog for the key-null case.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use prod PostHog project for now, drop placeholder staging URL

Remove the speculative staging.app.all-hands.dev hostname that doesn't
exist yet. Both POSTHOG_STAGING_KEY constants now alias POSTHOG_PROD_KEY
so staging events flow to the same project once the staging hostname is
wired up. The TODO comments mark exactly where to add the real staging
hostname and swap in a dedicated key.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: scope telemetry key to prod builds only, revert app-level PostHog changes

telemetry.ts: switch from hostname detection to import.meta.env.PROD as
the gate — this tracks local installs everywhere they are deployed, not
just on a specific hostname. Dev/test builds get null so no events reach
PostHog. Both POSTHOG_PROD_KEY and POSTHOG_STAGING_KEY are named
constants pointing at the same project for now; swap POSTHOG_STAGING_KEY
once a dedicated staging project exists.

option-service.api.ts: revert to posthog_client_key null. The app-level
PostHog wrapper belongs to the SaaS analytics path and is not relevant
for local install tracking.

constants.ts: drop the speculative STAGING URL addition.

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: use VITE_APP_ENV to select staging vs prod PostHog key at bundle time

Both POSTHOG_PROD_KEY and POSTHOG_STAGING_KEY are now referenced in the
assignment. VITE_APP_ENV is a build-time constant: Vite replaces it with
a literal in the static bundle so the correct key is compiled in with no
runtime branching.

  VITE_APP_ENV=staging npm run build  → POSTHOG_STAGING_KEY
  (any other prod build)              → POSTHOG_PROD_KEY
  dev build (PROD=false)              → null

Set VITE_APP_ENV=staging in the staging deployment build config (Vercel
env vars, CI, etc.) to activate the staging key once it is provisioned.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: gate PostHog key on VITE_APP_ENV, not PROD

import.meta.env.PROD is true for any vite build output including
npm run dev (which runs a production static build via dev-docker.mjs),
so local developers would inadvertently compile in POSTHOG_PROD_KEY.

Switch to requiring VITE_APP_ENV to be explicitly set at bundle time:
  VITE_APP_ENV=production → POSTHOG_PROD_KEY
  VITE_APP_ENV=staging    → POSTHOG_STAGING_KEY
  unset (local dev, CI)   → null, PostHog never initialises

Document VITE_APP_ENV in .env.sample so it is visible to developers.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: bake VITE_APP_ENV=production into build:lib for npm releases

Without this, the published library bundle has POSTHOG_API_KEY=null
and library telemetry never fires for any consumer of the package.
A released npm package is a production artifact, so it should always
get POSTHOG_PROD_KEY compiled in.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: simplify PostHog key to staging default, prod only when explicit

Drop the null/three-way branch. The key is now always a string:
- VITE_APP_ENV=production (hardcoded in build:lib and production CI) → POSTHOG_PROD_KEY
- everything else (local dev, CI, staging builds)                    → POSTHOG_STAGING_KEY

Since the key is never null, the null guard in initializePostHog is also removed.

Co-authored-by: openhands <openhands@all-hands.dev>

* Apply suggestions from code review

Co-authored-by: Rohit Malhotra <rohitvinodmalhotra@gmail.com>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-15 16:24:24 -04:00
Rohit Malhotraandopenhands 77b7012993 ci: add resolution guidance to failing snapshot PR comment (#489) 
* ci: add resolution guidance to failing snapshot PR comment

When snapshots differ from the main baseline, the comment now includes
a short blockquote explaining both resolution paths:
- merge the latest main (in case upstream baselines have moved)
- add the update-snapshots label to acknowledge intentional changes

* ci: wait for main baseline workflow before downloading artifact

Before downloading the snapshot-baselines artifact on PR runs, resolve
main's current HEAD SHA and check if the snapshot-tests.yml run for
that exact commit is still in-progress or queued. If so, poll every
10 s (up to 10 min) until it completes, then proceed.

This eliminates the race condition where a PR job starts while main's
baseline upload is still in-flight, causing it to pull the previous
(stale) artifact and produce false snapshot failures.

The wait targets only the run for the current HEAD SHA — not an older
in-progress run from a different commit — so two rapid commits to main
can't trick the check into waiting for the wrong run.

Also bumps job timeout-minutes from 20 → 30 to accommodate the wait.

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-15 19:03:57 +00:00
Rohit Malhotraandopenhands 38121aaf2f fix: normalize path separators in no-direct-agent-server-calls test for Windows (#488) 
On Windows, path.relative() returns backslash-separated paths, but
ALLOWED_AD_HOC_HTTP_FILES uses forward slashes. The Set.has() check
therefore never matches on Windows, causing false positive violations.

Normalize relPath to forward slashes before the check so the test
passes correctly on all platforms.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-15 14:42:45 -04:00
Rohit Malhotraopenhandsgithub-actions[bot]
 		e9b5e07293 ci: store snapshot baselines as GitHub Actions artifacts instead of git (#482) 
* ci: store snapshot baselines as GitHub Actions artifacts, not in git

Move baseline PNG storage from git to a 90-day GitHub Actions artifact
named 'snapshot-baselines', uploaded on every push to main.

- PRs download the latest main-branch artifact and run Playwright
  comparison against it; no more checked-in PNGs causing merge conflicts.
- New 'post-snapshot-comment.mjs' script classifies each snapshot as
  Changed/New/Unchanged, commits images to .pr/snapshots/<run_id>/ and
  posts a PR comment with collapsed <details> sections showing
  side-by-side expected/actual/diff images via raw.githubusercontent.com.
- For fork PRs or if push fails, falls back to a workflow run link for
  downloading the 'snapshot-test-results' artifact.
- Force-refresh baselines any time via workflow_dispatch force_update=true
  (replaces the old update_snapshots=true flow that committed PNGs to git).
- Remove 44 baseline PNGs from git; gitignore tests/e2e/__snapshots__/.
- Update AGENTS.md with the new workflow model.

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: fix bootstrap case — pass CI when no baseline artifact exists yet

When no main-branch 'snapshot-baselines' artifact has been uploaded yet
(e.g. this very first run after merging from an old baseline-in-git flow),
the comparison step fails because Playwright has nothing to compare against.
Gate the 'Fail if differences' step on has_baselines==true so the bootstrap
PR passes with all snapshots shown as new. Once it merges to main the
artifact is created and subsequent PRs compare normally.

Also derive the PR comment status from the classification (changed.length > 0)
rather than from TEST_OUTCOME, which is 'failure' in the bootstrap case
despite zero actual regressions.

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: delete stale comment and re-post on each push; always embed new snapshot images

- Replace PATCH-in-place with DELETE + POST so every push posts a fresh
  comment whose image URLs reference the current run's .pr/snapshots/<run_id>/.
  Editing in-place would leave raw.githubusercontent.com URLs pointing at
  the previous run's images once new images are committed under a new run_id.
- Embed new snapshot images inside the collapsed <details> section when
  commitSha is available; add a fallback artifact-download link when the
  push fails (e.g. fork PRs).
- Handle 204 No Content returned by DELETE in githubFetch.

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: fix find-run to query artifacts API by name, not workflow runs by status

The previous approach (find latest successful run of snapshot-tests.yml on
main) would match old runs that predate the artifact upload step, causing
actions/download-artifact to hard-fail with 'Artifact not found' before the
comparison or comment steps could run.

Fix: query the artifacts REST API directly for name=snapshot-baselines,
filtering to non-expired artifacts from the main branch. This guarantees
we only match runs that actually uploaded the baseline artifact.

Also add continue-on-error: true to the download step as a safety net
against the artifact expiring between the API lookup and the download.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: snapshot images for run 25929925639 [skip ci]

* ci: replace .pr/snapshots on each run instead of accumulating per-run dirs

Previously each CI run committed images under .pr/snapshots/<run_id>/, so
reruns would accumulate multiple directories on the PR branch. The PR comment
always pointed to the current run's images (via SHA in the raw.githubusercontent
URL), but old directories silently piled up.

Fix: use a fixed .pr/snapshots/ path and git rm -rf --ignore-unmatch it before
staging new images. Each run completely replaces the previous images rather than
appending alongside them. Raw URLs still use the commit SHA so they remain stable
per push.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: snapshot images for run 25930435218 [skip ci]

* ci: allow review_requested on draft same-repo PRs to trigger pr-review

GitHub does not fire pull_request events for review_requested on draft PRs —
only pull_request_target fires. The existing if condition rejected
pull_request_target for same-repo PRs via the fork check, so requesting
all-hands-bot or openhands-agent on a draft PR was always silently skipped.

Add a carve-out: pull_request_target is also accepted for same-repo PRs
when draft==true AND action==review_requested. Non-draft same-repo PRs are
unaffected — they continue to be handled by the pull_request event, and the
draft==true guard prevents pull_request_target from also running (no duplicate).

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: add update-snapshots label bypass for intentional snapshot changes

When snapshot diffs are expected (UI redesign, intentional change, etc.) the
author now adds the 'update-snapshots' label to the PR to acknowledge them:

- Fail step gains a !contains(labels, 'update-snapshots') guard so CI passes
  even when Playwright reports differences.
- The PR comment status adjusts: ❌ 'N snapshots differ — add label to
  acknowledge' when unapproved, ✅ 'N snapshots changed — acknowledged via
  label' when approved.
- The snapshot workflow now triggers on labeled/unlabeled events so that adding
  or removing the label immediately re-runs CI with the current label state in
  scope (no manual re-run or empty commit needed).
- New baselines are uploaded automatically when the PR merges to main, so no
  separate 'regenerate on main' step is needed.

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: update snapshot testing section in AGENTS.md

Add details on: artifact lookup by name, delete-then-post comment behavior,
fixed .pr/snapshots/ path (no accumulation), update-snapshots label bypass
for intentional changes, labeled/unlabeled triggers, bootstrap behavior.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: git rm must run before copyFile, not after

On the second CI run the branch already has .pr/snapshots/ tracked from the
previous run. The old order was: copyFile → git rm → git add. git rm removes
tracked files from disk, which deleted the freshly written images, leaving the
directory empty and causing 'fatal: pathspec did not match any files'.

Fix: run git rm --ignore-unmatch before copyFile so the tracked files are
cleared from disk first; then copyFile writes clean new files with nothing
to conflict; then git add finds them as expected.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: snapshot images for run 25931876588 [skip ci]

* fix: push snapshot images to orphan branch, not PR branch

Pushing to the PR branch with [skip ci] caused required checks to never
run on the HEAD commit, permanently blocking the PR.

New approach:
- publishImages() creates a fresh git repo in a temp directory, adds the
  images, and force-pushes to snapshot-artifacts/pr-<N> — a dedicated
  ephemeral branch that no CI workflow watches.
- The PR branch is never touched by CI, so required checks always run on
  the actual code commits.
- [skip ci] is removed; no loop prevention is needed because nothing
  triggers snapshot CI on the artifacts branch.
- Images in the orphan commit live at changed/<relPath>-{actual,expected,diff}.png
  and new/<relPath>.png (no .pr/snapshots/ prefix).
- raw.githubusercontent.com/<owner>/<repo>/<sha>/changed/... URLs are
  stable because they pin the orphan commit SHA.
- pr-artifacts.yml gains a closed trigger + cleanup-snapshot-artifacts job
  that deletes snapshot-artifacts/pr-<N> when the PR merges or is abandoned.
- Stale .pr/snapshots/ files from previous CI runs removed from this branch.

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: update AGENTS.md — orphan branch image storage, branch cleanup

* docs: tighten AGENTS.md snapshot section and pr-artifacts description

- Remove duplicate gitignore mention (already stated in baseline-storage line)
- Update pr-artifacts.yml description to cover both cleanup responsibilities:
  .pr/live-e2e/ (on approval) and snapshot-artifacts/pr-<N> (on close)

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
 2026-05-15 14:12:53 -04:00
Rohit MalhotraopenhandsVasco SchiavoGraham Neubiggithub-actions[bot]
 		c371afec55 feat: LLM profiles route integration (PR C) (#393) 
* feat: integrate LLM profiles into settings route (PR C)

- Add LlmSettingsLocalView component for integrated profile management
- Extend SdkSectionSaveControl to expose form values for custom save flows
- Update LLM settings route to render profile list with create/edit views
- Add i18n keys for profile create/edit UI (CREATE_PROFILE, EDIT_PROFILE,
  PROFILE_CREATED, PROFILE_UPDATED, MODEL_REQUIRED, STATUS, BUTTON)
- Add test coverage for LlmSettingsLocalView

The integrated view shows:
- Profile list with active badge and action menu
- Add Profile button that opens create form
- Edit button that loads profile config and opens edit form
- Back/Cancel buttons to return to list view

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: address PR review feedback (#393)

- Improve mock typing with properly typed helper functions that provide all
  required React Query fields, eliminating incomplete 'as unknown as' casts
- Add integration test that verifies the save flow (fills in profile name,
  clicks save, verifies UI state transitions)
- Add component documentation noting future refactoring opportunity (extract
  useProfileForm, useProfileSave hooks for better testability)
- Document API key preservation behavior: currently preserves existing encrypted
  key in edit mode with no new key; note about potential 'Clear API Key' UX
  enhancement for future
- Document auto-derive name race condition: client-side uniqueness check uses
  render-time state, so concurrent profile creation by another client would
  result in server conflict error (handled gracefully)
- Document default export change in route file: LlmSettingsLocalView is now
  the default export; named export LlmSettingsScreen remains for embedded use

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: update llm-settings test to use named export

The default export of llm-settings.tsx changed to render LlmSettingsLocalView
(the profiles manager). The test needs to import the named export LlmSettingsScreen
to test the form component directly.

Co-authored-by: openhands <openhands@all-hands.dev>

* Fix LLM profile button/badge sizing and update typescript-client to v0.6.0

- BrandButton: Change padding from p-2 to px-3 py-2 for better text display
- ProfileRow: Increase active badge vertical padding from py-0.5 to py-1
- Update @openhands/typescript-client from commit SHA to v0.6.0 tag

Co-authored-by: openhands <openhands@all-hands.dev>

* Fix LLM settings to show regular form in cloud mode and empty form in create mode

- LlmSettingsRoute: Render LlmSettingsScreen (standard form) for cloud backends
  and LlmSettingsLocalView (profile manager) for local backends only
- LlmSettingsLocalView: Pass empty initial values in create mode to ensure
  fresh form fields, add key prop to force form remount between profiles
- Add unit tests for cloud vs local backend rendering
- Add unit tests for create mode empty form initialization

Co-authored-by: openhands <openhands@all-hands.dev>

* Fix edit mode form initialization to display profile values

- Fix initialValueOverrides logic to properly check for edit mode AND
  existing initialValues before using them
- Add prefix to edit mode key for clearer remount semantics
- Add unit tests verifying edit mode populates profile name correctly
- Add unit tests verifying getProfile is called with encrypted mode

Co-authored-by: openhands <openhands@all-hands.dev>

* Add debug logging to trace edit profile data flow

Co-authored-by: openhands <openhands@all-hands.dev>

* Fix edit profile config parsing - read from config directly not config.llm

The API returns profile config with llm settings at the top level
(config.model, config.api_key, config.base_url), not nested under
config.llm. Fixed the parsing to read directly from detail.config.

Co-authored-by: openhands <openhands@all-hands.dev>

* Handle profile rename during edit and update active profile

When editing a profile and changing its name:
1. Rename the profile first using ProfilesService.renameProfile
2. Then save the profile config to the new name
3. If the renamed profile was the active profile, re-activate it
   after the rename (since rename doesn't update active_profile)

This prevents creating duplicate profiles when just changing the name.

Co-authored-by: openhands <openhands@all-hands.dev>

* Fix package-lock.json to use https protocol for typescript-client

The lock file was using git+ssh:// protocol which causes Vercel build
failures since Vercel doesn't have SSH keys configured. Changed to
git+https:// and removed the integrity hash (git deps don't have one).

Co-authored-by: openhands <openhands@all-hands.dev>

* chore(profiles): UI polish, shared validation, onboarding integration (#417)

* fix(profiles): Available Profiles heading translation

* fix(profiles): use brand badge for active profile indicator

* feat(profiles): replace form heading with "Back to LLM profiles list"

* fix(profiles): unify profile-name validation and reject any whitespace

* fix(onboarding): persist onboarding LLM choice as an active profile

* refactor(profiles): drop redundant trim/wrapper after validator change

* Fix LLM profile route mocks and warnings

* chore: update baseline snapshots [skip ci]

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: Vasco Schiavo <115561717+VascoSch92@users.noreply.github.com>
Co-authored-by: Graham Neubig <neubig@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
 2026-05-15 02:46:35 +00:00
Rohit Malhotraopenhandsgithub-actions[bot]
 		e20fd0c105 test(snapshot): onboarding modal steps + sidebar new-conversation popover (#449) 
* test(snapshot): onboarding modal 4 steps + sidebar new-conversation popover

4 onboarding-step snapshots (choose-agent, check-backend, setup-llm,
say-hello) and 1 sidebar new-conversation popover snapshot spec.

The sidebar popover test is marked test.fixme pending re-wiring of
NewConversationButton in sidebar.tsx (temporarily commented out at
lines 241-244 with 'Temporarily hide the dedicated New Conversation
button' comment). The component and its testids exist in
new-conversation-button-local.tsx.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* ci: trigger re-run against CI-generated baselines

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
 2026-05-14 23:18:02 +00:00
Rohit Malhotraopenhandsgithub-actions[bot]
 		863f479f07 test(snapshot): skills page loaded/search/filter states (#447) 
* test(snapshot): skills page loaded / search / filter states

Expose window.__OH_QUERY_CLIENT__ in dev/mock mode so Playwright tests
can seed the React Query cache and bypass MSW's empty skills response.
Adds 4 new tests: loaded grid, search-filtered, no-match, type-filter.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* ci: trigger re-run against CI-generated baselines

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
 2026-05-14 20:30:20 +00:00
Rohit Malhotraopenhandsgithub-actions[bot]
 		0f6bfe7b42 test(snapshot): batch 2 — secrets, verification/condenser, sidebar (12 tests, 12 baselines) (#441) 
* test(snapshot): batch 2 — secrets, verification/condenser, sidebar (12 tests)

Add three new Playwright visual snapshot spec files with 12 tests total,
all passing against local baselines:

**settings-secrets.snapshot.spec.ts** (5 tests)
- secrets list with two pre-seeded rows
- add-new-secret form open (empty)
- add-new-secret form filled with name + value
- after saving — list shows three rows
- delete confirmation modal open

**settings-verification.snapshot.spec.ts** (4 tests)
- verification settings page (confirmation mode OFF, default)
- verification settings with confirmation mode ON — reveals Security
  Analyzer combobox
- verification settings dirty — Save Changes button enabled after toggle
- condenser settings page renders schema-driven form

**sidebar.snapshot.spec.ts** (3 tests)
- conversation panel with three conversations + status dots
- sidebar collapsed to icon rail
- conversations filter menu opened from toggle button

Implementation notes:
- SettingsSwitch renders the checkbox as `<input hidden>`; click the
  enclosing `<label>` via `label:has([data-testid])` selector instead of
  trying to click the hidden input directly.
- HeroUI Autocomplete does not forward `data-testid` to the DOM; use
  `getByRole("combobox", { name: /.../ })` for the Security Analyzer field.
- Added condenser section to MOCK_AGENT_SETTINGS_SCHEMA so
  /settings/condenser renders the schema-driven form (not the
  "SDK settings schema unavailable" fallback).
- Added condenser default values to MOCK_DEFAULT_USER_SETTINGS.agent_settings.
- Local baselines committed; CI must regenerate via the
  "Update baseline snapshots" workflow dispatch before merging.

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: update AGENTS.md with snapshot testing lessons from batch 2

Add three key patterns discovered while implementing batch 2 snapshot tests:
- Hidden checkbox pattern (SettingsSwitch label-click workaround)
- HeroUI Autocomplete testId non-forwarding (use role selector)
- SdkSectionPage early return when schema section is missing

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* ci: trigger re-run against CI-generated baselines

Co-authored-by: openhands <openhands@all-hands.dev>

* test(snapshot): drop redundant verification-settings-dirty test

The dirty test was pixel-for-pixel identical to the ON test: both
navigate to /settings/verification (confirmation_mode defaults to false),
click the toggle ON, then screenshot. There is no visual distinction
between 'form is now ON' and 'form is dirty after being toggled ON' because
clicking the toggle is both the action that makes the form dirty and the
action that reveals the Security Analyzer field.

The 'ON' snapshot already captures the dirty/enabled state implicitly:
  - toggle gold (ON)
  - Security Analyzer dropdown visible
  - Save Changes button bright/enabled (vs. dimmed in the OFF snapshot)

Remove the test and its baseline. The spec now has 3 tests:
  1. verification OFF  — toggle gray, no analyzer, Save dimmed
  2. verification ON   — toggle gold, analyzer visible, Save enabled
  3. condenser         — schema-driven form

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
 2026-05-14 19:34:59 +00:00
Rohit Malhotraopenhandsgithub-actions[bot]
 		15363865b7 test: add snapshot coverage for Automations, MCP, and Skills pages (#436) (#438) 
* test: add snapshot tests for Automations, MCP, and Skills pages

Add 7 new visual regression snapshot tests covering three previously
untested pages:

  automations.snapshot.spec.ts (3 tests)
    - automations-list-active-inactive: full list with active/inactive groups
    - automations-search-no-results: search filter that matches nothing
    - automations-delete-modal: delete confirmation modal overlay

  mcp-page.snapshot.spec.ts (3 tests)
    - mcp-empty-installed: empty installed section + full marketplace
    - mcp-custom-server-editor: "Add custom MCP server" modal form
    - mcp-search-filtered: marketplace filtered by "slack" query

  skills-page.snapshot.spec.ts (1 test)
    - skills-empty: empty skills state (MSW returns { skills: [] })

Supporting changes:
  - src/mocks/automation-handlers.ts: add GET /api/automation/health MSW
    handler (returns { status: "ok" }) so the automations list page can
    render without a real backend in mock mode
  - tests/e2e/snapshots/COVERAGE_PLAN.md: 16-spec snapshot coverage plan
    with TODOs for backend-not-configured and loaded-skills states that
    require exposing window.__MSW_WORKER__ for per-test handler overrides

Key design decisions documented in spec file headers:
  - Automation health/list: MSW intercepts all same-origin requests before
    page.route() (service worker takes precedence); the new MSW health
    handler is required for the list page to load in mock mode
  - MCP "with installed": settings mock cannot be injected via page.route()
    since MSW wins for GET /api/settings; replaced with the custom server
    editor modal which is state-independent
  - Skills loaded/search: POST /api/skills is intercepted by MSW (returns
    []) before page.route() can override; deferred with TODO comment

Co-authored-by: openhands <openhands@all-hands.dev>

* test: add empty-automations + iterative MCP install snapshot tests

Merge latest main (2 commits), then add 3 new snapshot tests:

  automations-no-automations (1 new PNG)
    - Deletes all 5 seed automations via MSW DELETE REST calls, then
      triggers a React Query refetch (without page.reload) to show the
      EmptyState component with the "How to create an automation" cards.
    - Key insight: the MSW automations Map is PAGE-level JS state, not
      service-worker state. page.reload() reinitialises it to 5 items;
      using window.__TEST_INVALIDATE_QUERIES__() avoids this.

  mcp-slack-install-{1-4} (4 new PNGs) – iterative marketplace install
    step 1: marketplace before install (Slack card visible)
    step 2: Slack install modal open (empty SLACK_BOT_TOKEN / SLACK_TEAM_ID)
    step 3: install modal with filled credentials (token masked, T01ABC123)
    step 4: after clicking Install — Slack in Installed section, success
            toast "MCP server saved.", Slack card shows "INSTALLED" badge

  mcp-custom-server-{1-4} (4 new PNGs) – iterative custom SSE server add
    step 1: custom server editor open (SSE type selected, empty URL)
    step 2: URL filled in (https://api.example-mcp.com/sse)
    step 3: API key also filled (optional field)
    step 4: after Add Server — custom SSE card in Installed section
            (toast dismissed, clean installed view)

All flow tests use real simulated clicks + form fills via data-testid
selectors; no page.route() overrides needed because the MSW settings
PATCH/GET cycle persists mcp_config across the refetch.

Supporting changes:
  - src/entry.client.tsx: expose window.__TEST_INVALIDATE_QUERIES__ in
    mock mode so specs can trigger React Query refetches without reload.
    Documented why reload-based approaches fail (MSW handler state is
    PAGE-level JS, reset on every full page load).

All 10 snapshot tests pass (34s).

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: document MSW page-level JS state and __TEST_INVALIDATE_QUERIES__ helper

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* ci: trigger snapshot validation against CI-regenerated baselines [skip ci]

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: validate snapshots against CI-regenerated baselines

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
 2026-05-14 13:51:34 -04:00
Rohit Malhotraopenhandsgithub-actions[bot]
 		4ed58e2379 fix: restore data-testid="chat-interface" removed by #340 (#437) 
* fix: restore data-testid="chat-interface" removed by #340

PR #340 added left padding to the ChatInterface wrapper div but
accidentally dropped the data-testid attribute in the same edit.
This broke both the collapsible-thinking snapshot tests and the live
e2e test, which both use getByTestId('chat-interface') as the load
signal and screenshot target.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* ci: trigger re-run after snapshot baseline update

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
 2026-05-14 16:02:33 +00:00
Rohit Malhotraopenhandsgithub-actions[bot]
 		dd18f8aee0 feat: add Playwright visual snapshot testing infrastructure (#392) 
* feat: add Playwright visual snapshot testing infrastructure

- Add snapshot test file for home and settings pages
- Configure playwright.config.ts with snapshot settings
- Add npm scripts: test:e2e:snapshots and test:e2e:snapshots:update
- Create CI workflow (.github/workflows/snapshot-tests.yml)
- Include baseline snapshots for chromium

Closes #390

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: properly mock analytics consent in snapshot tests

- Add setupMocks helper with showConsentModal parameter
- Set user_consents_to_analytics: false to hide modal by default
- Add dedicated test for analytics consent modal appearance
- Document snapshot testing patterns in AGENTS.md

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add explicit modal absence assertions in snapshot tests

- All non-modal tests now assert consent modal has count 0
- Use rootLayout consistently for all snapshots
- Tests will fail fast if modal incorrectly appears

Note: Snapshots need regeneration - CI will fail until baselines updated

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: dismiss consent modal before taking snapshots

- Add dismissConsentModal helper to click 'Confirm preferences'
- Call dismissConsentModal after page load in all non-modal tests
- Regenerate all baseline snapshots without modal overlay

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: make snapshot tests work in mock mode CI

- Add file API mock to prevent proxy errors
- Make consent modal test skip if modal doesn't appear in mock mode
- Tests now pass in both local and CI environments

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: generate snapshots in CI environment

- Add workflow_dispatch with update_snapshots option
- Remove local snapshots (will be generated in CI)
- CI can now update and commit snapshots automatically
- Update AGENTS.md with snapshot testing details

To generate snapshots: Run workflow manually with 'Update baseline snapshots' checked

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* docs: add CI snapshot update instructions to AGENTS.md

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address review comments

- Use setupMocks(page, true) for consent modal test instead of try-catch
- Align global threshold to 0.01 (1%) matching documented standard

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: update baseline snapshots [skip ci]

* fix: stabilize flaky consent modal test

- Wait for root-layout to be visible before checking modal
- Add networkidle wait for settings query to resolve
- Increase modal visibility timeout to 10s for lazy-load

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: wait for settings API response to stabilize consent modal test

- Use Promise.all to wait for settings response during navigation
- Increase root-layout visibility timeout to 10s
- Ensures settings data is loaded before checking for modal

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: increase timeouts for consent modal test

- Set test timeout to 60s
- Use networkidle for goto
- Increase element visibility timeouts to 15s

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
 2026-05-12 19:07:42 -04:00
Rohit Malhotraandopenhands 9bcfbb6a0f fix: also tag prerelease versions as latest on npm (#394) 
* fix: also tag prerelease versions as latest on npm

Since we don't have stable releases yet, prerelease versions (alpha, beta, rc)
should also be tagged as 'latest' so users running 'npm install @openhands/agent-canvas'
get the most recent version rather than needing to specify @alpha explicitly.

The workflow now:
1. Publishes with the prerelease tag (e.g., 'alpha')
2. Also adds the 'latest' tag to that version

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: note npm dist-tag cleanup issue

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: warn about prerelease npm latest tag

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-12 18:38:44 -04:00
Rohit Malhotraopenhandsallhands-bot
 		8fc9a8b50c feat: LLM profiles UI components, modals, and tests (PR B) (#389) 
* feat: add LLM profiles API layer and React Query hooks

This PR adds the foundational data layer for the LLM profiles feature:

## API Layer
- ProfilesService: Thin wrapper around SDK ProfilesClient with methods
  for list, get, save, delete, rename, and activate profile operations
- Re-exports SDK types for consumer convenience

## React Query Hooks
- useLlmProfiles: Query hook for listing all profiles
- useSaveLlmProfile: Mutation hook for creating/updating profiles
- useDeleteLlmProfile: Mutation hook for deleting profiles
- useRenameLlmProfile: Mutation hook for renaming profiles
- useActivateLlmProfile: Mutation hook for activating a profile

All mutation hooks properly invalidate both profile list and settings
caches on success, and disable global toasts (consumers handle errors).

## Utilities
- deriveProfileNameFromModel: Derives a clean profile name from model
  strings (e.g., 'openai/gpt-4' -> 'gpt-4')
- PROFILE_NAME_PATTERN: Validation regex for profile names

## Tests
- 47 tests covering all new functionality
- API service method tests
- Hook behavior tests (success, error handling, cache invalidation)
- Utility function tests

Part 1 of LLM Profiles feature (PR A from split plan).
No UI changes - this is purely a data layer addition.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address PR review feedback

- Remove client.close() calls for consistency with other services
  (SettingsService, SecretsService don't call close())
- Use SETTINGS_QUERY_KEYS.personal() instead of .all for precision
- Add ActiveBackendProvider wrapper in useLlmProfiles tests
- Add test for query key including backend.id and orgId
- Add test for backend-switch cache isolation
- Fix truncation test to actually exercise trailing-dash removal
- Add test for model names that sanitize to empty string

Addresses review feedback from all-hands-bot.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: Remove PR-only artifacts

* feat: add LLM profiles UI components, modals, and tests

This is part 2 (PR B) of the LLM profiles feature split:

Components added:
- LlmProfilesManager: Main container managing list/edit views
- LlmProfilesListView: List view with profile rows
- ProfileRow/ProfileListRow: Display individual profiles
- ProfileActionsMenu/ProfileListActionsMenu: Dropdown menus
- ProfileNameInput: Editable name field with validation
- RenameProfileModal: Modal for renaming profiles
- DeleteProfileModal: Confirmation modal for deletion
- ProfilesBody: Container for profile list content

Supporting components:
- api-key-modal-base.tsx: Base modal for API key inputs
- brand-button.tsx: Styled button component
- settings-input.tsx: Form input component

Tests: 77 component tests covering all new components

Builds on PR A (API layer + hooks) from feat/llm-profiles-api-hooks

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: add component screenshots for PR B

Screenshots showing:
- Profile name input and profile rows (active/inactive)
- Profiles body list and LlmProfilesListView
- Profile actions dropdown menu (Edit/Rename/Delete)

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: update LLM profiles components to match reference implementation

- Update ProfileRow to accept isActive, onActivate, isActivating props
- Update ProfileActionsMenu with new interface including Set Active option
- Update ProfilesBody to pass active state and callbacks to ProfileRow
- Update LlmProfilesManager with activation functionality
- Add SETTINGS$PROFILE_SET_ACTIVE i18n key
- Remove duplicate components (ProfileListRow, ProfileListActionsMenu, LlmProfilesListView)
- Update all related tests to match new component interfaces
- Active badge now uses primary color (gold) with dark text

Co-authored-by: openhands <openhands@all-hands.dev>

* style: update LLM profiles UI to match reference implementation

- Active badge: use green success color (bg-success) instead of gold primary
- Add LLM Profile button: use secondary variant (border style) instead of primary
- Cancel buttons in modals: add tertiary variant to BrandButton (solid gray bg)
- Update delete and rename modals to use tertiary variant for Cancel buttons

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address PR review feedback for LLM profiles

- Add aria-labelledby to ApiKeyModalBase for dialog accessibility
- Extract MenuItem component in ProfileActionsMenu to reduce duplication
- Add accessible loading state with sr-only text in DeleteProfileModal
- Trim whitespace on input change in RenameProfileModal
- Add ariaLabel and aria-busy props to BrandButton
- Add console.error logging for activation failures
- Add keyboard navigation tests for ProfileActionsMenu
- Add isPending state tests for DeleteProfileModal
- Add boundary condition tests for ProfileNameInput

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: Remove PR-only artifacts

* docs: add component screenshots for PR #389

Screenshots showing:
- Profile list with Active badge (green)
- Profile actions menu (Edit, Rename, Set Active, Delete)
- Rename profile modal with validation
- Delete profile confirmation modal

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: Remove PR-only artifacts

* docs: re-add component screenshots for PR #389

Screenshots showing:
- Profile list with Active badge (green)
- Profile actions menu (Edit, Rename, Set Active, Delete)
- Rename profile modal with validation
- Delete profile confirmation modal

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: remove PR screenshots per user request

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: allhands-bot <allhands-bot@users.noreply.github.com>
 2026-05-12 17:13:28 -04:00
Rohit Malhotraopenhandsallhands-bot
 		0569bd77ec feat: add LLM profiles API layer and React Query hooks (#387) 
* feat: add LLM profiles API layer and React Query hooks

This PR adds the foundational data layer for the LLM profiles feature:

## API Layer
- ProfilesService: Thin wrapper around SDK ProfilesClient with methods
  for list, get, save, delete, rename, and activate profile operations
- Re-exports SDK types for consumer convenience

## React Query Hooks
- useLlmProfiles: Query hook for listing all profiles
- useSaveLlmProfile: Mutation hook for creating/updating profiles
- useDeleteLlmProfile: Mutation hook for deleting profiles
- useRenameLlmProfile: Mutation hook for renaming profiles
- useActivateLlmProfile: Mutation hook for activating a profile

All mutation hooks properly invalidate both profile list and settings
caches on success, and disable global toasts (consumers handle errors).

## Utilities
- deriveProfileNameFromModel: Derives a clean profile name from model
  strings (e.g., 'openai/gpt-4' -> 'gpt-4')
- PROFILE_NAME_PATTERN: Validation regex for profile names

## Tests
- 47 tests covering all new functionality
- API service method tests
- Hook behavior tests (success, error handling, cache invalidation)
- Utility function tests

Part 1 of LLM Profiles feature (PR A from split plan).
No UI changes - this is purely a data layer addition.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address PR review feedback

- Remove client.close() calls for consistency with other services
  (SettingsService, SecretsService don't call close())
- Use SETTINGS_QUERY_KEYS.personal() instead of .all for precision
- Add ActiveBackendProvider wrapper in useLlmProfiles tests
- Add test for query key including backend.id and orgId
- Add test for backend-switch cache isolation
- Fix truncation test to actually exercise trailing-dash removal
- Add test for model names that sanitize to empty string

Addresses review feedback from all-hands-bot.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: Remove PR-only artifacts

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: allhands-bot <allhands-bot@users.noreply.github.com>
 2026-05-12 16:19:28 -04:00
Rohit Malhotraopenhandsallhands-bot
 		2281f20f3e feat: Add OAuth 2.0 Device Flow authentication for OpenHands Cloud backends (#381) 
* feat: Add OAuth 2.0 Device Flow authentication for OpenHands Cloud backends

Implements one-click login for cloud backends using the OAuth 2.0 Device
Authorization Grant (RFC 8628). When adding a cloud backend with a known
OpenHands Cloud host (*.all-hands.dev, *.openhands.dev), users can click
'Login with OpenHands' to authenticate via browser instead of manually
copying their API key.

Changes:
- Add device-flow-client.ts with startDeviceFlow() and pollForToken()
- Add useDeviceFlow React hook for managing auth state in components
- Add DeviceFlowAuth component with auth UI states (idle, starting,
  awaiting_authorization, success, error)
- Update BackendForm to show device flow auth for cloud backends
- Add i18n translations for all device flow UI strings

Closes #379

* feat: Show device flow login for all cloud backends with clearer UI

- Remove restriction to only known OpenHands Cloud hosts - device flow
  is now available for all cloud backends (including self-hosted)
- Add clear 'OR' divider between login button and manual API key entry
- Add link to API key documentation for manual key generation
- Add new i18n keys: LOGIN_OR, KEY_DOCS_HINT, KEY_DOCS_LINK

* feat: Always show login button for cloud backends, disable when no host

- Login button, OR divider, and manual API key input are now always
  visible when cloud backend type is selected
- Login button is disabled until a valid host URL is entered
- Improves UX by showing the full auth options upfront

* fix: Keep login button visible when typing custom cloud host URL

The kind inference was incorrectly downgrading from 'cloud' to 'local'
when typing a host URL that didn't match known OpenHands Cloud patterns.
Now the inference only upgrades to 'cloud' when a known pattern is
detected, but never downgrades - allowing users to type any custom
cloud host URL while keeping the login button visible.

* fix: Use cloud proxy for device flow to avoid CORS issues

For known OpenHands Cloud hosts (*.all-hands.dev, *.openhands.dev),
device flow requests are now routed through the local agent-server's
cloud-proxy endpoint. This avoids CORS errors when the browser tries
to make direct cross-origin requests to the cloud backend.

Self-hosted instances still use direct requests, assuming they have
CORS properly configured.

* fix: Always use proxy for device flow and fix kind inference regression

1. Device flow now always uses proxy for all hosts (not just known cloud
   hosts). This avoids CORS issues for any custom backend that supports
   device flow.

2. Fix regression where typing a local address (e.g., 127.0.0.1) would
   not switch from cloud to local type. The kind inference now:
   - Auto-infers kind from host in add mode (initial behavior)
   - Only prevents downgrade when user explicitly clicked the cloud
     radio button (not when cloud is just the default)
   - Tracks explicit user selection separately from initial default

* fix: Address PR review feedback for device flow security and RFC compliance

Security fixes:
- Fix isOpenHandsCloudHost() to use URL hostname extraction instead of
  substring matching, preventing attacks like all-hands.dev.evil.com
- Add URL validation in handleStartAuth to check for credential injection
- Sanitize error messages to avoid exposing server error details

RFC 8628 compliance:
- Add required grant_type parameter to token requests
- Make verification_uri_complete optional per RFC Section 3.2
- Build verification_uri_complete if not provided by server

Robustness improvements:
- Validate polling interval to at least 1 second
- Cap slow_down interval to MAX_INTERVAL_MS to prevent DoS
- Open popup on user click to avoid popup blockers

Accessibility:
- Add role='status' and aria-live='polite' to status containers
- Add role='alert' to error container

* fix: Pass abort signal to makeProxiedRequest fetch call

Address review feedback: the abort signal is now properly passed through
makeProxiedRequest to the underlying fetch call, allowing in-flight
proxied requests to be cancelled immediately when the user cancels.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: Address comprehensive review feedback for device flow auth

Security fixes:
- Add URL validation to prevent XSS via javascript: URLs
- Validate verification URLs have https: protocol before use in popup and links
- Add type validation for slow_down interval to prevent NaN tight loops

RFC 8628 compliance:
- Fix slow_down to increment by 5 seconds per Section 3.5 (not double)
- Validate interval is number, finite, and positive before using server value

Robustness:
- Network errors now continue polling instead of failing immediately
- Wrap sleep in try-catch for consistent abort handling
- Add cleanup effect to close popup on unmount

Code cleanup:
- Remove dead userSelectedCloud state (was unreachable)
- Add defensive programming comment for cancellation check
- Fix onSuccess effect to include deviceFlow.reset in deps

Tests:
- Add DoS protection test (caps interval at 30s)
- Add type confusion test (rejects non-numeric interval)
- Add RFC 8628 +5s increment test
- Add network error retry test
- Add unmount cleanup test

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: Remove PR-only artifacts

* fix: Remove noopener from popup to maintain window reference

The 'noopener' option causes window.open() to return null, which means
we lose the reference to the popup and can't update its location when
the verification URL becomes available. This was causing a blank page
to appear instead of the device flow auth page.

Removed 'noopener' from the initial popup open call so we can maintain
the reference and update popupRef.current.location.href when the
verification URL arrives from the device flow.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: allhands-bot <allhands-bot@users.noreply.github.com>
 2026-05-12 15:45:52 -04:00
Rohit Malhotraandopenhands b5f01f366f feat: npm publish workflow with OIDC trusted publishing (#358) 
* Add npm publish workflow and release infrastructure

- Add .github/workflows/npm-publish.yml for automated npm publishing on GitHub releases
- Update CI to verify library build (npm run build:lib) and package contents
- Add CHANGELOG.md for version history tracking
- Update README.md with npm installation and usage documentation

Closes #197

Co-authored-by: openhands <openhands@all-hands.dev>

* correct package version

* chore: update npm-publish workflow for trusted publishing

- Remove NODE_AUTH_TOKEN secret dependency
- Keep id-token: write permission for OIDC
- Add provenance flag for npm attestations
- Add comment explaining trusted publisher setup on npmjs.com

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: add CLI entry point for npx execution

- Add bin/agent-canvas.mjs as executable CLI
- Add bin field to package.json for npm bin linking
- Include bin/ and build/ directories in published files
- CLI serves the built application with SPA routing support
- Supports --port, --host, and --help options

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: consolidate npm executable to use dev-docker infrastructure

- bin/agent-canvas.mjs now uses dev-with-automation.mjs main() with
  dev-docker.mjs's Docker-specific agent-server starter
- Added --static and --static-dir support to dev-with-automation.mjs
  so the npm executable serves pre-built static assets instead of Vite
- Added startStaticFrontend() function that uses static-server.mjs
- npm executable runs full stack: Docker agent-server + uvx automation
  backend + static frontend + ingress proxy

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: include scripts/ in npm package files

The bin/agent-canvas.mjs executable imports from scripts/dev-with-automation.mjs
and scripts/dev-docker.mjs, so the scripts directory must be included in the
published package.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address review comments

- Fix CHANGELOG.md version mismatch: 1.6.0 -> 1.0.0-alpha.1 to match package.json
- Add NODE_AUTH_TOKEN env var to npm-publish workflow for authentication
- Add CLI entry point mention to CHANGELOG

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use OIDC trusted publishing (no NPM_TOKEN needed)

npm trusted publishing with OIDC doesn't require NODE_AUTH_TOKEN.
Instead it uses short-lived OIDC tokens generated by GitHub Actions.

Requirements:
- id-token: write permission (already set)
- npm CLI 11.5.1+ (added npm install -g npm@latest step)
- Trusted publisher configured on npmjs.com

See: https://docs.npmjs.com/trusted-publishers/

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: bump version to 1.0.0-alpha.2

Co-authored-by: openhands <openhands@all-hands.dev>

* Build app assets before npm publish

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use Node 24 for npm trusted publishing

Trusted publishing requires Node 22.14.0+ and npm 11.5.1+.
Node 24 ships with npm 11.x which meets the requirement.
Node 22.12.0 (previous) ships with npm 10.x which doesn't support OIDC.

Also removed the manual npm upgrade step since Node 24 includes
a compatible npm version by default.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: align all workflows to Node 24 and regenerate lockfile

- Update ci.yml to use Node 24
- Update sdk-version-sync.yml to use Node 24
- Regenerate package-lock.json with npm 11.12.1

All workflows now use Node 24 which ships with npm 11.x,
required for OIDC trusted publishing (npm 11.5.1+).

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: remove incorrect LLM env vars from CLI help

LLM_MODEL and LLM_API_KEY were listed in the help text but aren't
actually used by the scripts. LLM settings are configured through
the web UI settings page instead.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address PR review feedback

Critical fixes:
- Guard prepare script to only run in dev context (check for ../.git)
- Add missing existsSync import in dev-with-automation.mjs

Workflow improvements:
- Update checkout/setup-node actions to v6 for consistency
- Add npm version validation (must be 11.5.1+ for trusted publishing)
- Add package version validation (must match release tag)

CLI improvements:
- Add try-catch for dynamic imports with helpful error message
- Use console.error directly instead of imported logError/c

Documentation:
- Fix README export names: ChatInterface→ChatPanel, Terminal→TerminalPanel
- Add dist/ to .gitignore

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: trigger npm publish on tag push instead of release

Simpler workflow - just push a tag like v1.0.0-alpha.2 to publish.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: remove tarball and add *.tgz to gitignore

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: npm publish errors

1. Fix bin path - remove './' prefix (npm pkg fix)
2. Add --tag for prerelease versions (alpha/beta/rc)

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add repository field for npm provenance verification

npm provenance requires repository.url to match the GitHub Actions
source. Also added description, homepage, and bugs fields.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add .npmignore to include build/ directory in package

npm respects .gitignore when there's no .npmignore, which was
excluding the build/ directory from the published package.

The .npmignore explicitly lists what to exclude (src/, tests/,
dev configs) while allowing build/ and dist/ to be included.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: correct BUILD_DIR path in CLI entry point

The react-router build outputs to build/ directly (not build/client/)
because react-router.config.ts has unpackClientDirectory that moves
files from build/client/ to build/ and removes the client/ folder.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: bump version to 1.0.0-alpha.3

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-12 02:16:36 -04:00
Rohit Malhotraandopenhands 4738f5b7c6 Add npm publish workflow and release infrastructure (#330) 
* Add npm publish workflow and release infrastructure

- Add .github/workflows/npm-publish.yml for automated npm publishing on GitHub releases
- Update CI to verify library build (npm run build:lib) and package contents
- Add CHANGELOG.md for version history tracking
- Update README.md with npm installation and usage documentation

Closes #197

Co-authored-by: openhands <openhands@all-hands.dev>

* correct package version

* chore: update npm-publish workflow for trusted publishing

- Remove NODE_AUTH_TOKEN secret dependency
- Keep id-token: write permission for OIDC
- Add provenance flag for npm attestations
- Add comment explaining trusted publisher setup on npmjs.com

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: add CLI entry point for npx execution

- Add bin/agent-canvas.mjs as executable CLI
- Add bin field to package.json for npm bin linking
- Include bin/ and build/ directories in published files
- CLI serves the built application with SPA routing support
- Supports --port, --host, and --help options

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: consolidate npm executable to use dev-docker infrastructure

- bin/agent-canvas.mjs now uses dev-with-automation.mjs main() with
  dev-docker.mjs's Docker-specific agent-server starter
- Added --static and --static-dir support to dev-with-automation.mjs
  so the npm executable serves pre-built static assets instead of Vite
- Added startStaticFrontend() function that uses static-server.mjs
- npm executable runs full stack: Docker agent-server + uvx automation
  backend + static frontend + ingress proxy

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: include scripts/ in npm package files

The bin/agent-canvas.mjs executable imports from scripts/dev-with-automation.mjs
and scripts/dev-docker.mjs, so the scripts directory must be included in the
published package.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address review comments

- Fix CHANGELOG.md version mismatch: 1.6.0 -> 1.0.0-alpha.1 to match package.json
- Add NODE_AUTH_TOKEN env var to npm-publish workflow for authentication
- Add CLI entry point mention to CHANGELOG

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use OIDC trusted publishing (no NPM_TOKEN needed)

npm trusted publishing with OIDC doesn't require NODE_AUTH_TOKEN.
Instead it uses short-lived OIDC tokens generated by GitHub Actions.

Requirements:
- id-token: write permission (already set)
- npm CLI 11.5.1+ (added npm install -g npm@latest step)
- Trusted publisher configured on npmjs.com

See: https://docs.npmjs.com/trusted-publishers/

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: bump version to 1.0.0-alpha.2

Co-authored-by: openhands <openhands@all-hands.dev>

* Build app assets before npm publish

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use Node 24 for npm trusted publishing

Trusted publishing requires Node 22.14.0+ and npm 11.5.1+.
Node 24 ships with npm 11.x which meets the requirement.
Node 22.12.0 (previous) ships with npm 10.x which doesn't support OIDC.

Also removed the manual npm upgrade step since Node 24 includes
a compatible npm version by default.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: align all workflows to Node 24 and regenerate lockfile

- Update ci.yml to use Node 24
- Update sdk-version-sync.yml to use Node 24
- Regenerate package-lock.json with npm 11.12.1

All workflows now use Node 24 which ships with npm 11.x,
required for OIDC trusted publishing (npm 11.5.1+).

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: remove incorrect LLM env vars from CLI help

LLM_MODEL and LLM_API_KEY were listed in the help text but aren't
actually used by the scripts. LLM settings are configured through
the web UI settings page instead.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address PR review feedback

Critical fixes:
- Guard prepare script to only run in dev context (check for ../.git)
- Add missing existsSync import in dev-with-automation.mjs

Workflow improvements:
- Update checkout/setup-node actions to v6 for consistency
- Add npm version validation (must be 11.5.1+ for trusted publishing)
- Add package version validation (must match release tag)

CLI improvements:
- Add try-catch for dynamic imports with helpful error message
- Use console.error directly instead of imported logError/c

Documentation:
- Fix README export names: ChatInterface→ChatPanel, Terminal→TerminalPanel
- Add dist/ to .gitignore

Co-authored-by: openhands <openhands@all-hands.dev>

* ci: trigger npm publish on tag push instead of release

Simpler workflow - just push a tag like v1.0.0-alpha.2 to publish.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: remove tarball and add *.tgz to gitignore

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: npm publish errors

1. Fix bin path - remove './' prefix (npm pkg fix)
2. Add --tag for prerelease versions (alpha/beta/rc)

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add repository field for npm provenance verification

npm provenance requires repository.url to match the GitHub Actions
source. Also added description, homepage, and bugs fields.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-12 01:52:32 -04:00
Rohit Malhotraandopenhands a32d621417 Remove OpenHands start and stop hooks (#345) 
Remove .openhands/hooks.json and .openhands/hooks/on_stop.sh which were
blocking subsequent prompts by running quality gate checks (npm run lint
and npm test) before allowing agent completion.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-11 19:07:05 -04:00
Rohit Malhotraandopenhands 05deacbd35 fix(msw): use wildcard URL patterns to match absolute URLs (#344) 
* fix(setup): always run npm ci to ensure hooks have dependencies

The on_stop.sh hook runs npm run lint and npm test, which require
node_modules to be installed. Previously, setup.sh only ran npm ci
if node_modules was missing, which could fail if:
- node_modules existed but was incomplete/corrupt
- setup.sh hadn't completed before hooks ran
- package-lock.json was updated but node_modules was stale

Now npm ci always runs during setup, ensuring dependencies are
consistently installed when OpenHands begins working with the repo.

Co-authored-by: openhands <openhands@all-hands.dev>

* Add session_start hook to run setup.sh automatically

The hooks.json was missing a session_start hook, which meant setup.sh
(which installs npm packages via 'npm ci') was never run automatically
when OpenHands began working with this repository.

This caused the stop hook to fail because npm packages weren't installed.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(msw): use wildcard URL patterns to match absolute URLs

MSW handlers using relative paths (e.g., '/api/settings') only intercept
requests made to the same origin as the test runner. When VITE_BACKEND_BASE_URL
is configured (e.g., in a local .env file), the code makes requests to absolute
URLs like 'http://127.0.0.1:8000/api/settings', which MSW treats as a different
origin and lets pass through, causing ECONNREFUSED errors.

This fix updates MSW handlers to use wildcard patterns (e.g., '*/api/settings')
which match both relative paths AND absolute URLs, ensuring tests pass
regardless of whether VITE_BACKEND_BASE_URL is configured.

Changes:
- Update src/mocks/settings-handlers.ts to use '*/' prefix on all routes
- Update src/mocks/secrets-handlers.ts to use '*/' prefix on all routes
- Update test files that use server.use() with test-specific handlers

This resolves the discrepancy between CI (no .env file) and local development
(with .env file containing VITE_BACKEND_BASE_URL).

Co-authored-by: openhands <openhands@all-hands.dev>

* fix(msw): update all remaining handler files with wildcard URL patterns

Additional handler files updated:
- src/mocks/conversation-handlers.ts
- src/mocks/git-repository-handlers.ts
- src/mocks/api-keys-handlers.ts
- src/mocks/auth-handlers.ts
- src/mocks/automation-handlers.ts
- src/mocks/feedback-handlers.ts
- src/mocks/task-suggestions-handlers.ts

Test files updated:
- __tests__/api/option-service.test.ts
- __tests__/components/modals/settings/model-selector-openhands.test.tsx

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-11 18:50:35 -04:00
Rohit Malhotraandopenhands d281324c67 Add session_start hook to run setup.sh automatically (#343) 
* fix(setup): always run npm ci to ensure hooks have dependencies

The on_stop.sh hook runs npm run lint and npm test, which require
node_modules to be installed. Previously, setup.sh only ran npm ci
if node_modules was missing, which could fail if:
- node_modules existed but was incomplete/corrupt
- setup.sh hadn't completed before hooks ran
- package-lock.json was updated but node_modules was stale

Now npm ci always runs during setup, ensuring dependencies are
consistently installed when OpenHands begins working with the repo.

Co-authored-by: openhands <openhands@all-hands.dev>

* Add session_start hook to run setup.sh automatically

The hooks.json was missing a session_start hook, which meant setup.sh
(which installs npm packages via 'npm ci') was never run automatically
when OpenHands began working with this repository.

This caused the stop hook to fail because npm packages weren't installed.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-11 17:36:34 -04:00
Rohit Malhotraandopenhands 24da834da3 fix: guard against null provider in useUrlSearch hook (#341) 
* fix: guard against null provider in useUrlSearch hook

Prevent unnecessary cloud proxy requests when the provider is null/undefined
(e.g., before providers have loaded from settings).

The useUrlSearch hook was calling GitService.searchGitRepositories()
without validating that the provider was truthy first. When the parent
component passed undefined (from providers[0] when array is empty),
the request would be sent to the cloud proxy with an invalid provider.

Changes:
- Update type signature to accept Provider | null | undefined
- Add early return guard when provider is falsy
- Clear results when provider becomes null

* fix: add defensive guards in GitService for invalid providers

Add a second layer of defense at the GitService level to prevent
cloud proxy requests with invalid providers (null, undefined, empty
string, or stringified 'undefined'/'null').

This fixes the installations search API being called with
'provider=undefined' even when hooks have enabled guards.

Changes:
- Add isInvalidProvider() guard function
- Add guards to all GitService methods that take a provider param
- Return empty results instead of making invalid API requests
- Add comprehensive tests for the guards

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-11 17:14:33 -04:00
Rohit Malhotraandopenhands f4dbfcdf8f fix: correct Docker image tag format (remove v prefix) (#339) 
The SDK build script strips the 'v' prefix from semver release tags when
publishing Docker images. The correct tag format is {version}-python
(e.g., 1.22.0-python), not v{version}-python.

This fixes the 'Unable to find image' error when running npm run dev:docker.

Changes:
- Update DEFAULT_AGENT_SERVER_TAG from v1.22.0-python to 1.22.0-python
- Update documentation in AGENTS.md to reflect correct tag format

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-11 16:27:49 -04:00
Rohit Malhotraandopenhands c0bc27c0ca fix: use versioned release tags for agent-server Docker images (#338) 
Update DEFAULT_AGENT_SERVER_TAG in dev-docker.mjs from commit-based tag
(0924962-python) to versioned release tag (v1.22.0-python) for better
reproducibility and consistency with the PyPI version used in dev-safe.mjs.

Changes:
- Update DEFAULT_AGENT_SERVER_TAG to v1.22.0-python
- Add documentation in AGENTS.md explaining the versioning approach
- Document that Docker and non-Docker dev modes should use matching versions

The software-agent-sdk repository builds Docker images with versioned tags
in the format v{version}-python when release tags are pushed, which makes
them suitable for pinning to specific releases.

Closes #323

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-11 15:49:57 -04:00
Rohit Malhotraandopenhands 773cc72324 feat: update SDK to 1.22.0 and add CI version sync check (#333) 
* feat: update SDK to 1.22.0 and add CI version sync check

- Update DEFAULT_AGENT_SERVER_VERSION from 1.21.1 to 1.22.0 in dev-safe.mjs
- Update SDK version references in AGENTS.md
- Add scripts/check-sdk-version-sync.mjs to verify automation project uses
  matching SDK versions for openhands-sdk, openhands-tools, openhands-workspace,
  and openhands-agent-server
- Add .github/workflows/sdk-version-sync.yml CI workflow with:
  - Path-filtered PR/push triggers for version-related file changes
  - repository_dispatch triggers (sdk-version-check, sdk-release) for
    external repos to notify when SDK deps change
  - workflow_dispatch with optional version override
  - Scheduled runs every 6 hours to catch upstream changes
  - PyPI version checking support (--check-pypi flag)

The check script supports:
- EXPECTED_SDK_VERSION env var override for CI triggers
- --check-pypi flag to also display latest PyPI versions
- --help for usage documentation

To trigger from external repos (e.g., OpenHands/automation or SDK repo):
  curl -X POST -H "Authorization: token \$GITHUB_TOKEN" \\
    https://api.github.com/repos/OpenHands/agent-canvas/dispatches \\
    -d '{"event_type": "sdk-version-check"}'

* fix: check released PyPI version instead of GitHub main branch

The SDK version sync check now fetches dependencies from the released
openhands-automation package on PyPI (version specified by
DEFAULT_AUTOMATION_VERSION in dev-with-automation.mjs) rather than
fetching pyproject.toml from the GitHub main branch.

This ensures we're checking the actual released version that users
would install, not the development version on main.

* fix: address review feedback for SDK version sync check

- Add env var overrides for automation package name and version
- Add retry logic with exponential backoff for PyPI API failures
- Add semantic version normalization for comparing versions
- Fix repository_dispatch to use client_payload.version
- Improve regex to handle parenthesized dependency formats
- Add comprehensive test coverage for helper functions

* fix: add type casts for dynamic module import in tests

* chore: update automation version to 1.0.0a2

- Update DEFAULT_AUTOMATION_VERSION in dev-with-automation.mjs
- Update AGENTS.md documentation
- Update test expectation

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-11 15:39:17 -04:00
Rohit Malhotraandopenhands 7d9e6ab6ba fix: improve right panel UX when unpinning active tab (#328) 
* fix: improve right panel UX when unpinning active tab

- Add RightPanelToggle button in chat header for persistent panel visibility control
- When unpinning the active tab, switch to another pinned tab instead of hiding the panel
- Add i18n keys for show/hide panel tooltips
- Update tests to reflect new behavior

Fixes #326

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address review feedback

- Fix fragile test pattern using unmount/remount instead of double render
- Show panel toggle on mobile devices as well (remove lg:block restriction)

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-11 13:32:18 -04:00
Rohit Malhotraandopenhands 3207d90e72 feat: add dynamic port allocation with preferred port fallback (#223) 
* feat: add dynamic port allocation with preferred port fallback

Implement dynamic port allocation for dev entrypoint scripts to gracefully
handle port conflicts. When a preferred port is busy, the system automatically
finds an alternative available port.

Changes:
- Add findFreePort() and findFreePorts() utilities to dev-safe.mjs
- Add buildSafeDevConfigAsync() for async config with dynamic allocation
- Update dev-with-automation.mjs to use async buildConfig with dynamic ports
- Update dev-static.mjs to use async buildConfig
- Add strictPort: true to vite.config.ts to fail-fast on conflicts
- Update tests for async buildConfig

The utilities try the preferred/default ports first, falling back to
OS-assigned ports only when needed. This preserves predictable defaults
while gracefully handling port conflicts.

Closes #222

* fix: address review feedback - add max retry, document race condition, improve tests

- Add max retry count (100 attempts) to port allocation loop to prevent
  infinite loops
- Fix findFreePort to handle preferredPort=0 correctly by skipping the
  port check and going straight to OS assignment
- Document race condition limitation in findFreePort JSDoc (accepted
  limitation with guidance on handling EADDRINUSE)
- Clarify JSDoc for buildSafeDevConfig vs buildSafeDevConfigAsync with
  clear guidance on when to use each
- Remove misleading 'must be after prereq check' comment
- Add comprehensive tests for findFreePort, findFreePorts, and
  buildSafeDevConfigAsync using actual port blocking
- Improve buildConfig tests with port uniqueness verification and
  fallback tests using high ports
- Use high ports (19xxx range) in tests to avoid conflicts with
  system services

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-09 14:46:10 -04:00
Rohit Malhotraandopenhands 0fd9800e74 feat: add VITE_LOAD_PUBLIC_SKILLS config to optionally disable public skills (#204) 
* feat: add VITE_LOAD_PUBLIC_SKILLS config to optionally disable public skills

Add a new environment variable VITE_LOAD_PUBLIC_SKILLS that controls whether
skills from the OpenHands extensions marketplace (https://github.com/OpenHands/extensions)
are loaded. Defaults to true (enabled).

Changes:
- Add shouldLoadPublicSkills() function in agent-server-config.ts
- Update skills-service.ts to use the new config function
- Update agent-server-adapter.ts loadSkillsForConversation to use the config
- Document the new env var in .env.sample and AGENTS.md

Set VITE_LOAD_PUBLIC_SKILLS=false to disable loading public skills.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: pass VITE_SESSION_API_KEY to Vite dev server when SESSION_API_KEY is set

When running in environments with SESSION_API_KEY set (like OpenHands sandbox),
the agent-server requires authentication. This fix passes the session API key
to the Vite dev server so the frontend can authenticate API requests.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: pass load_public_skills and load_user_skills in agent_context when starting conversations

This is the critical fix - the agent_context.load_public_skills flag must be
passed in the start conversation request for the SDK to load skills from
https://github.com/OpenHands/extensions at runtime.

Previously we were only passing load_public=true to the /api/skills endpoint
which is used for UI display, but NOT passing it to the conversation start
payload which controls what skills are actually available during agent execution.

Changes:
- Add agent_context with load_public_skills and load_user_skills to the agent
  configuration in createAgentFromSettings()
- Uses shouldLoadPublicSkills() which respects VITE_LOAD_PUBLIC_SKILLS env var

Co-authored-by: openhands <openhands@all-hands.dev>

* test: add shouldLoadPublicSkills mock to all tests that mock agent-server-config

Fix failing tests by adding the new shouldLoadPublicSkills function to the
mock definition for #/api/agent-server-config.

Also add test assertion to verify agent_context is included in the start
conversation payload with load_public_skills and load_user_skills flags.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-09 00:27:35 -04:00
Rohit Malhotra 9098d9e6df feat: auto-generate random API keys for dev server authentication (#203) 2026-05-08 22:48:58 -04:00
Rohit Malhotraandopenhands 0b45d8c879 chore: default to released PyPI versions instead of git branches (#194) 
- Change agent-server SDK default from git main to PyPI 1.21.1
- Change automation default from git main to PyPI 1.0.0a1
- Pin all SDK packages (agent-server, tools, workspace) to same version
- Keep ability to override with OH_AGENT_SERVER_GIT_REF/OH_AUTOMATION_GIT_REF
- Update tests and AGENTS.md documentation

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-08 15:08:01 -04:00
Rohit Malhotraandopenhands 7ebb116475 chore: update automation entrypoint to openhands.automation namespace (#191) 
The automation package has been restructured to use the openhands.automation
namespace instead of the root automation namespace. This change updates the
uvicorn entrypoint from 'automation.app:app' to 'openhands.automation.app:app'.

Related: OpenHands/automation#101

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-08 14:23:50 -04:00
Rohit Malhotraandopenhands d173041f8a i18n: add translations for automations backend health check (#190) 
Add translations for the following languages:
- Japanese (ja)
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- Korean (ko-KR)
- Norwegian (no)
- Italian (it)
- Portuguese (pt)
- Spanish (es)
- Arabic (ar)
- French (fr)
- Turkish (tr)
- German (de)
- Ukrainian (uk)
- Catalan (ca)

Addresses review comment from PR #185 requesting multi-language support.

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-08 13:15:06 -04:00
Rohit Malhotraandopenhands 4e6eee71fa feat(automations): add backend health check before loading automations UI (#185) 
* feat(automations): add backend health check before loading automations UI

- Add checkHealth() method to AutomationService that calls /api/automation/health
- Create useAutomationHealth hook for React Query integration
- Create BackendNotConfigured component to display when backend is unavailable
- Update automations-list.tsx and automation-detail.tsx routes to check health
- Show 'Automations Backend Not Configured' UI with host URL and retry button
- Add i18n translations for new UI strings
- Add tests for hook and component

* fix: perform health check for cloud backends too, update message

- Remove assumption that cloud backends are always healthy
- Call /api/automation/health via cloud proxy for cloud backends
- Update message to generic 'Automations Unavailable' / 'not available right now'
- Remove host URL display (not needed for generic message)
- Rename component to BackendUnavailable (keep BackendNotConfigured as alias)

* fix: disable automation API calls when health check fails

- Add enabled option to useAutomations, useAutomationDetail, and useAutomationRuns hooks
- Only fetch automations data when the backend health check passes
- Update hook call sites to pass enabled flag based on isBackendHealthy
- Update tests to use new options-based API

* test: add checkHealth mock to automation-detail test

The test was failing because the health check now gates automation API calls.
Added checkHealth mock returning { status: 'ok' } so the test can proceed.

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-08 13:00:59 -04:00
Rohit Malhotraandopenhands e6721dcf23 feat(sidebar): always show automations icon in sidebar (#184) 
- Remove ENABLE_AUTOMATIONS feature flag condition from sidebar
- Remove unused ENABLE_AUTOMATIONS export from feature-flags.ts
- The automations icon (gear with play symbol) now always appears in the sidebar

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-08 11:21:17 -04:00
Rohit Malhotraandopenhands 6d1f0a74d9 feat: seed automation API key into agent-server secrets (#160) 
* feat: seed automation API key into agent-server secrets

- Add seedAutomationSecret() that calls PUT /api/settings/secrets after
  agent-server is ready, storing the automation API key as
  OPENHANDS_AUTOMATION_API_KEY
- This makes the key available to agents during conversations so they can
  authenticate with the automation backend
- Add sessionApiKey to config for optional auth header
- Update help text and documentation

Co-authored-by: openhands <openhands@all-hands.dev>

* test: add tests for seed automation secret and fix CI failure

- Add tests for localApiKey and sessionApiKey config in buildConfig
- Add tests for secrets documentation in help output
- Fix root-layout-refetch.test.tsx unhandled rejection from framer-motion
  by adding async cleanup with microtask flush

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: detect SESSION_API_KEY when seeding automation secret

The seedAutomationSecret() function was failing with 401 Unauthorized
because it wasn't detecting the SESSION_API_KEY environment variable
that the agent-server uses by default (V0 config).

The agent-server checks these env vars for session API keys:
- SESSION_API_KEY (V0 config, picked up by default factory)
- OH_SESSION_API_KEYS_0 (V1 config)

The original code only checked OH_SESSION_API_KEY and VITE_SESSION_API_KEY,
missing the actual env vars the server reads. In OpenHands Cloud
environments, SESSION_API_KEY is set automatically, causing the 401.

This fix adds SESSION_API_KEY and OH_SESSION_API_KEYS_0 to the
fallback chain, with SESSION_API_KEY taking highest precedence
since it matches the agent-server's default behavior.

Adds tests verifying:
- SESSION_API_KEY detection
- OH_SESSION_API_KEYS_0 detection
- Precedence order (SESSION_API_KEY > OH_SESSION_API_KEYS_0 > others)

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add retry logic and longer timeout for secret seeding

On slower systems, the agent-server may take longer to start up,
causing the secret seeding to fail with 'fetch failed' errors.

This fix adds:
1. Increased initial wait timeout from 30s to 60s for agent-server startup
2. Retry logic in seedAutomationSecret (5 retries with 2s delay)
3. Better error logging showing elapsed time and last error
4. AbortSignal.timeout on fetch requests to avoid hanging
5. Skip seeding if server fails to start (with warning message)

The retry logic handles transient failures during server warmup
but immediately fails on 401/403 auth errors (no point retrying).

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-07 17:29:46 -04:00
Rohit Malhotraopenhandshieptl
 		6ebe7b4e7e feat: add automations frontend on /automations subpath (#141) 
* feat: add automations frontend on /automations subpath

Port automations frontend from automation-repo to agent-canvas.

## Changes

### New Routes
- /automations - List view of all automations
- /automations/:automationId - Automation detail view

### New Components
- Automation list components: card, card-skeleton, group, empty-state, error-state
- Automation detail components: header, sections (config, prompt, plugins, activity)
- Shared UI components: toggle-switch, metadata-chip, status-badge, kebab-menu, search-input

### API Integration
- automation-service.api.ts - API client for automation CRUD operations
- Uses existing openHands axios client (shared base URL with agent server)

### MSW Mock Server Handlers
- automation-handlers.ts - Mock handlers for testing
- automations.mock.ts - Sample automation data
- automation-runs.mock.ts - Sample automation run data

### Tests
- API tests: automation-service.test.ts, automation-handlers.test.ts
- Component tests: toggle-switch, metadata-chip, search-input, error-state
- Detail component tests: section-card, run-status-badge, not-found-state

### Hooks
- use-automations.ts - React Query hook for fetching automations list
- use-automation-detail.ts - React Query hook for fetching single automation
- use-has-permission.ts - Permission checking utility hook

### Types
- automation.ts - TypeScript types for automation entities

### Icons
- Added SVG icons: activity, bell, calendar, check-circle, chevron-down,
  chevron-left, clock, cog, database, exclamation-circle, git-branch,
  kebab-vertical, power, puzzle, search, sparkle, target, trash, x-circle, x-mark

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: add local API key auth for automation backend

- Use VITE_AUTOMATION_API_KEY env var for frontend to authenticate
- Pass AUTOMATION_LOCAL_API_KEY to automation backend in dev mode
- Use dedicated axios instance with Bearer auth interceptor
- Add --refresh to uvx to ensure latest git commits are fetched
- URL-encode automation IDs in API paths

The default local API key is 'openhands-local-api-key' which matches
between the frontend and backend for local development.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: automation service tests and ingress port conflicts

- Fix automation-service.test.ts to mock axios instance correctly
  (was mocking openHands but service uses automationAxios)
- Use vi.hoisted() for mock functions available during vi.mock hoisting
- Change ingress test ports from 19000-19003 to 29000-29003 to avoid
  conflict with VS Code server on port 19000

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: add CORS origins for automation backend in dev mode

The automation backend defaults CORS origins to app.all-hands.dev,
which blocks localhost requests. Add localhost origins for the
ingress port and Vite dev server port.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: update create-instructions styling and add missing i18n keys

- Use semantic color tokens (text-content, text-basic, bg-base-secondary,
  bg-base, border-default) instead of hardcoded neutral-* colors
- Add all AUTOMATIONS$ i18n keys for the automations frontend

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: hieptl <hieptl.developer@gmail.com>
 2026-05-08 01:49:13 +07:00
Rohit Malhotraandopenhands 48b275a94f feat: track install immediately and use reverse proxy for ad blocker bypass (#155) 
* feat: track install immediately without consent, add proxy support

BREAKING CHANGE: Install event (canvas_install) is now sent immediately
on first use, regardless of consent status. Users can still opt out via
VITE_DO_NOT_TRACK=1 or browser's Do Not Track setting.

Changes:
- trackInstall() sends the install event immediately without waiting for consent
- trackFirstUse() is now deprecated, calls trackInstall() for backward compat
- Session/custom events still require user consent
- Add VITE_POSTHOG_UI_HOST env var for reverse proxy support
- PostHog initialization now includes ui_host configuration

This change allows tracking library adoption even if users haven't made
a consent choice yet, while still respecting hard opt-outs.

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: default PostHog host to z.openhands.dev proxy

Use OpenHands' managed reverse proxy by default to bypass ad blockers.
The proxy at z.openhands.dev routes telemetry to PostHog's US region.

Library consumers can still override with VITE_POSTHOG_HOST if needed.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: remove deprecated trackFirstUse function

Only trackInstall() is now exported. No backwards compatibility shim needed.

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: add privacy/GDPR compliance notes to install tracking

Address review feedback by documenting the privacy implications and
GDPR legal basis (legitimate interest under Article 6(1)(f)) for
sending the anonymous install event before consent.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: wait for translations before showing consent modal

- Use useTranslation's 'ready' state to wait for translations to load
- Add small delay (50ms) to ensure DOM is fully hydrated
- Prevents translation keys from flashing on first appearance

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-07 14:29:32 -04:00
Rohit Malhotraandopenhands e2615344df feat: add first-use telemetry tracking with consent (#138) 
* feat: add first-use telemetry tracking with consent

- Add telemetry service with consent management (src/services/telemetry.ts)
- Add useTelemetry React hook for easy integration (src/hooks/use-telemetry.ts)
- Add TelemetryConsentBanner component with i18n support
- Add local development server for testing (scripts/telemetry-dev-server.mjs)
- Add comprehensive tests for telemetry service and hook
- Export telemetry utilities from library index
- Respect DO_NOT_TRACK environment variable for privacy
- Uses localhost:8080 endpoint for development

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address PR review feedback

- Make TELEMETRY_ENDPOINT configurable via VITE_TELEMETRY_ENDPOINT env var
- Make POSTHOG_API_KEY configurable via VITE_POSTHOG_API_KEY env var
- Add validation to skip telemetry if API key not configured (except localhost)
- Fix DO_NOT_TRACK to work in browser environments using VITE_DO_NOT_TRACK
- Also respect browser's navigator.doNotTrack standard
- Update consent banner hint text to reference correct env var
- Add documentation comments for all configuration options

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: hardcode PostHog credentials for centralized telemetry

- Use OpenHands PostHog project API key for all library users
- Use PostHog US Cloud endpoint (https://us.i.posthog.com/capture)
- Remove environment variable configuration for endpoint/API key
- Telemetry now automatically sends to centralized project when consent granted
- Users can still opt out via UI, VITE_DO_NOT_TRACK, or browser DNT setting

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: use separate PostHog API keys for dev and production

- Dev environment: phc_kBtz5nKmxVRRQ7HtPwr2QX9eMC5j65zE86QKocVNwb4U
- Production: phc_BgzfxKdgsYMLFTmJqt424ZoyVHvKFfrwttLimzdYTKFK
- Automatically selects key based on import.meta.env.DEV

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: use single production PostHog API key everywhere

Simplify by using the same API key for all environments.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: rename telemetry events

- library_first_use → canvas_install
- library_session_start → canvas_new_session

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: migrate telemetry to PostHog SDK

Replace raw HTTP requests with PostHog SDK for:
- Automatic event batching
- Built-in retry logic with exponential backoff
- Offline support (queues events, sends when back online)
- Automatic session tracking
- Better device/browser info enrichment

Benefits:
- More reliable event delivery
- Reduced network requests
- Cleaner code with less manual state management
- Future-proof for feature flags, session replay, etc.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: remove redundant hasTrackedFirstUse state in hook

The trackFirstUse() function already has built-in deduplication via
localStorage, so the local React state was unnecessary. Simplified
the hook and added a comment explaining the deduplication mechanism.

Co-authored-by: openhands <openhands@all-hands.dev>

* chore: remove obsolete telemetry dev server

The local dev server was used when telemetry used raw HTTP requests
to a configurable endpoint. Now that we use the PostHog SDK with
the real PostHog endpoint, this is no longer needed.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: remove trailing comma in package.json

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address PR review feedback

- Make POSTHOG_API_KEY configurable via VITE_POSTHOG_API_KEY env var
- Make POSTHOG_HOST configurable via VITE_POSTHOG_HOST env var
- Add session deduplication using sessionStorage to prevent duplicate
  canvas_new_session events from multiple hook instances
- Clear sessionStorage in clearTelemetryData()

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use dynamic imports for PostHog SSR compatibility

- Convert top-level posthog-js import to dynamic import for SSR safety
- Add getPostHog() lazy loader that only imports in browser context
- Make setTelemetryConsent, clearTelemetryData, getPostHogInstance async
- Update documentation to clarify default telemetry destination
- Update tests for async function signatures

This ensures the library works correctly in SSR frameworks (Next.js, Remix,
etc.) that might import this module server-side.

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: add telemetry consent banner to app layout

The consent banner now appears on all pages until the user explicitly
accepts or declines telemetry. This ensures users are always prompted
for consent on their first visit regardless of which page they land on.

Co-authored-by: openhands <openhands@all-hands.dev>

* refactor: update telemetry consent banner to modal style

- Changed from bottom banner to centered modal overlay (matching OpenHands)
- Uses ModalBackdrop, ModalBody, BaseModalTitle, BaseModalDescription
- Single checkbox with 'Confirm preferences' button pattern
- Full-screen overlay blocks interaction until user makes a choice
- Added i18n keys: TELEMETRY$SEND_ANONYMOUS_DATA, TELEMETRY$CONFIRM_PREFERENCES

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: ensure PostHog is initialized before tracking events

- Made grantConsent/denyConsent in useTelemetry hook async to ensure
  PostHog initialization completes before state update triggers tracking
- Updated tests for async consent functions
- This fixes a race condition where trackFirstUse() could be called before
  PostHog's opt_in_capturing() had been executed

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-07 13:18:01 -04:00
Rohit Malhotraopenhandshieptl
 		988cfed5c6 feat: add automation backend integration with standalone ingress proxy (#127) 
* feat: add automation backend integration with standalone ingress proxy

- Add scripts/ingress.mjs: standalone HTTP reverse proxy for routing traffic
  to multiple backends based on URL path prefix
- Add scripts/dev-with-automation.mjs: orchestrates full stack with
  agent-server, automation backend (both via uvx), Vite, and ingress
- Make 'npm run dev' run full stack by default (was dev:safe, now dev:automation)
- Rename 'npm run dev:safe' to 'npm run dev:minimal' for agent-server + Vite only
- Update README with new quickstart showing full stack as default
- Update AGENTS.md with architecture documentation

Architecture:
  http://localhost:8000 (Ingress)
  ├── /api/automation/* → Automation Backend (:18001)
  ├── /api/*, /sockets  → Agent Server (:18000)
  └── /* (default)      → Vite Dev Server (:3001)

* test: add tests for ingress and dev-with-automation scripts

- Add __tests__/scripts/ingress.test.ts with 14 tests covering:
  - CLI argument parsing (--help, --port, --route, --default)
  - Route matching (exact, prefix, longest-match-first)
  - Proxy functionality (forwarding, query params, error handling)
  - 502 response when backend unavailable
  - 503 response for unmatched routes with no default

- Add __tests__/scripts/dev-with-automation.test.ts with 19 tests covering:
  - buildAutomationCommand() with various git refs/repos
  - buildConfig() port and path configuration
  - CLI --help output
  - Graceful exit when uvx is missing

- Export testable functions from dev-with-automation.mjs

* fix: prevent dev-with-automation from auto-executing when imported

The script was calling main() unconditionally, which caused test failures
when vitest imported the module. Now check if the module is the main entry
point before executing.

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: hieptl <hieptl.developer@gmail.com>
 2026-05-07 12:02:15 -04:00
Rohit Malhotraandopenhands cccecf1100 Fix uvx command to use --from syntax for PyPI packages (#122) 
The openhands-agent-server package exposes an executable named
'agent-server', not 'openhands-agent-server'. When using PyPI versions
(either specific or latest), we need to use the --from syntax:
  uvx --from openhands-agent-server agent-server

This fixes the error:
  An executable named 'openhands-agent-server' is not provided by
  package 'openhands-agent-server'.
  Use 'uvx --from openhands-agent-server agent-server' instead.

Fixes #117

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-06 12:07:41 -04:00
Rohit Malhotraandopenhands 179192ca01 feat: export buildAgentServerEnv helper for downstream consumers (#119) 
Add a new exported function that builds the environment variables object
for spawning the agent-server process. This allows downstream consumers
(e.g., the automation service) to use the same env vars without
duplicating the mapping logic.

When new env vars are added or existing ones are renamed, downstream
consumers will automatically inherit the changes by using this helper.

Refactored main() to use the new helper internally.

Closes #118

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-05 22:02:44 -04:00
Rohit Malhotraandopenhands f9006b4bf0 feat: use agent server APIs for settings persistence (#98) 
* feat: use agent server APIs for settings persistence

- Replace localStorage with HTTP API for settings storage
- Use `X-Expose-Secrets: encrypted` header for GET /api/settings
  to receive encrypted secrets (not exposing raw values)
- Use `secrets_encrypted: true` in start conversation payload
- Add `getSettingsForConversation()` to build encrypted settings
  payload for conversation start endpoint
- Update secrets service to use /api/settings/secrets endpoints
- Add mock handlers for settings and secrets API endpoints
- Update tests for new API-based settings flow

This integrates with software-agent-sdk PR #3060
(feat/encrypted-secrets-in-transit) which adds server-side
encryption support for secrets in transit.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: update test mocks for encrypted settings API and add OH_SECRET_KEY support

- Update use-create-conversation-metadata.test.ts to mock getSettingsForConversation()
  which is now called by buildStartConversationRequestWithEncryptedSettings
- Skip flaky onOpen websocket test that times out intermittently in CI
- Add OH_SECRET_KEY environment variable support in dev-safe.mjs:
  - Uses default key for local development
  - Can be overridden via OH_SECRET_KEY environment variable
  - Logs secret key source at startup

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: update AGENTS.md for settings API and OH_SECRET_KEY

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: update secrets service to use agent-server API routes

Changes:
- Update SecretsService to use /api/settings/secrets endpoints instead of /api/v1/secrets
- Simplify secrets-service.types.ts to remove unused pagination types
- Update use-get-secrets hook to do client-side filtering (agent-server doesn't support pagination)
- Update mock handlers to only use agent-server API routes
- Update secrets-settings test to mock getSecrets instead of searchSecrets
- Remove pageSize option from useSearchSecrets since agent-server doesn't paginate

The agent-server API routes (per SDK PR #3060):
- GET /api/settings/secrets - List secrets (names/descriptions only)
- GET /api/settings/secrets/{name} - Get secret value
- PUT /api/settings/secrets - Upsert secret
- DELETE /api/settings/secrets/{name} - Delete secret

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: update AGENTS.md for secrets API routes

- Document the agent-server secrets CRUD routes in MSW handlers list
- Update git provider token persistence note to reflect server-side storage

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: update secret name validation to match agent-server requirements

- Change pattern from '^\S*$' (no whitespace) to '^[a-zA-Z][a-zA-Z0-9_]{0,63}$'
- Add title prop to SettingsInput component for validation error messages
- Secret names must: start with letter, contain only letters/numbers/underscores, be 1-64 chars

Co-authored-by: openhands <openhands@all-hands.dev>

* feat: include custom secrets in conversation requests via LookupSecret

Custom secrets configured in Settings > Secrets are now automatically
included in conversation start requests. Instead of exposing secret values
to the frontend, we use LookupSecret entries that point to the agent-server
endpoint /api/settings/secrets/{name}. The agent-server fetches the actual
values at runtime.

Changes:
- Add LookupSecret interface to agent-server-adapter.ts
- Add customSecrets option to StartConversationOptions
- Build LookupSecret entries for each custom secret in buildStartConversationRequest
- Update buildStartConversationRequestWithEncryptedSettings to fetch and include
  custom secrets list from SecretsService.getSecrets()
- Include X-Session-API-Key header in LookupSecret when configured

This ensures secrets never touch the frontend in plaintext while still
making them available to conversations.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: address review comments - no localStorage fallback, retry logic, SDK docs

Review feedback addressed:
1. secrets-service.ts: Server storage MUST succeed before updating localStorage
   - addGitProvider now stores to server FIRST, only updates localStorage on success
   - createSecret/updateSecret/deleteSecret now throw on failure (no silent returns)
   - Added retry logic with exponential backoff for all API calls

2. settings-service.api.ts: No silent fallback for encrypted settings
   - getSettingsForConversation now throws if encrypted fetch fails
   - Conversations should not start with broken/redacted credentials
   - Added retry logic with exponential backoff

3. AGENTS.md: Document SDK dependency
   - Settings persistence APIs require SDK PR #3060
   - Until released, npm run dev defaults to main branch
   - Documented git provider storage design (server + localStorage)

4. dev-safe.mjs: Default to SDK main branch
   - Added DEFAULT_GIT_REF='main' constant
   - npm run dev now uses main until settings APIs are released
   - TODO comment to update once released

Note: Git provider tokens still use localStorage for frontend git API calls
(repo search, branches), but MUST succeed on server first.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: update server secret when only host changes

When updating just the host (empty token), the server secret's description
must also be updated to keep metadata in sync. Previously, only localStorage
was updated, violating the 'server storage must succeed first' principle.

Now the host-only update path also calls createSecret() to update the
server secret's description before updating localStorage.

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-05 20:39:46 -04:00
Rohit Malhotraandopenhands 6fa219cf25 feat: use uvx for temporary agent-server installation in dev mode (#99) 
* feat: use uvx for temporary agent-server installation in dev mode

- Replace direct agent-server CLI invocation with uvx temporary install
- Add OH_AGENT_SERVER_VERSION env var for specific PyPI versions
- Add OH_AGENT_SERVER_GIT_REF env var for git commits/branches
- Auto-install uv in .openhands/setup.sh if not present
- Update documentation (README, DEVELOPMENT.md, AGENTS.md)
- Add comprehensive tests for buildAgentServerCommand()

This removes the requirement to permanently install agent-server via
'uv tool install'. Users only need uv installed, and npm run dev will
automatically download and run the appropriate agent-server version.

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: use subdirectory syntax for git ref in uvx monorepo

The software-agent-sdk is a uv workspace monorepo with packages in
subdirectories (openhands-agent-server/, openhands-tools/, etc.).

When installing from git, uvx requires the #subdirectory= fragment to
specify which package to install from the workspace.

Tested with: OH_AGENT_SERVER_GIT_REF=main npm run dev

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
 2026-05-05 13:14:14 -04:00
Rohit Malhotraandopenhands ee9e78b7de fix: filter automation event forwarding by requested types (#15388) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-07-25 16:43:21 -04:00
Rohit Malhotraandopenhands e39d94e5db feat: Expose app and SDK versions in server info (#15345) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-07-21 13:59:35 -04:00
Rohit Malhotraandopenhands 93c0871951 fix: treat Integrations Hub as a cross-app route (#15324) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-07-19 14:02:51 -04:00
Rohit Malhotraopenhandshieptl
 		11d4ecf21f feat: protect Agent Canvas behind SaaS auth (#15286) 
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: hieptl <hieptl.developer@gmail.com>
 2026-07-17 17:28:20 +00:00
Rohit Malhotraandopenhands fadab3a54a fix: Avoid logout on transient provider get_user errors (#15305) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-07-17 12:13:02 -04:00
Rohit Malhotraopenhandshieptl
 		6b670a7352 fix: restore automations login redirects (#15295) 
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: hieptl <hieptl.developer@gmail.com>
 2026-07-16 13:14:43 -04:00
Rohit Malhotraandopenhands 36cf22b780 feat: Use interrupt endpoint for agent pause UI (#14972) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-06-24 18:02:31 -04:00
Rohit Malhotraandopenhands ceef693a9f feat: Add full Git history user setting (#14950) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-06-24 13:29:06 -04:00
Rohit Malhotraandopenhands 8f28477d46 feat: Support Slack attachments in agent context (#14934) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-06-22 23:13:12 -04:00
Rohit Malhotraandopenhands dd40cb1b36 fix: revert conversation limit enforcement from #14168 (#14877) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-06-17 15:15:34 -04:00
Rohit Malhotraandopenhands c5afe0ef47 fix: duplicate Slack no-repository selections (#14833) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-06-15 19:08:29 -04:00
Rohit Malhotraandopenhands 19471ba1d1 fix: Ignore OpenHands bot GitHub resolver events (#14832) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-06-15 18:04:20 -04:00
Rohit Malhotraandopenhands 7107ab8891 fix: Use final response endpoint for resolver callbacks (#14828) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-06-15 21:20:43 +00:00
Rohit Malhotraandopenhands f941ba5f4a fix: Add SaaS migration for sandbox pause state (#14829) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-06-15 15:19:34 -04:00
Rohit Malhotraandopenhands a66712b1d3 feat: Auto-generate OPENHANDS_API_KEY as system secret for all users (#14224) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-04-29 23:36:00 -04:00
Rohit Malhotraandopenhands e5c1ebcff9 fix: update deprecated FastMCP API usage in mcp_patch.py (#14219) 
Co-authored-by: openhands <openhands@all-hands.dev>
 2026-04-29 15:40:54 -04:00