Serve bundled agent-canvas frontend from agent-server#3675
Draft
enyst wants to merge 1 commit into
Draft
Conversation
Co-authored-by: openhands <openhands@all-hands.dev>
Contributor
Python API breakage checks — ✅ PASSEDResult: ✅ PASSED |
Contributor
REST API breakage checks (OpenAPI) — ✅ PASSEDResult: ✅ PASSED |
Contributor
Coverage Report •
|
||||||||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
HUMAN:
AGENT:
Why
Fixes #3658. Python-only users should be able to start
agent-serverand get the agent-canvas UI from the same process/port when the prebuilt frontend is packaged withopenhands-agent-server.Summary
OH_FRONTEND_FILES_PATH-configurable frontend build path.index.html.@openhands/agent-canvasbuild before PyPI package builds.Issue Number
Fixes #3658
How to Test
uv run pytest tests/agent_server/test_api.py -q— 44 passed.uv run pre-commit run --files .gitignore openhands-agent-server/openhands/agent_server/api.py openhands-agent-server/openhands/agent_server/config.py openhands-agent-server/openhands/agent_server/frontend.py openhands-agent-server/openhands/agent_server/agent-server.spec openhands-agent-server/pyproject.toml tests/agent_server/test_api.py .github/scripts/fetch_agent_canvas_frontend.py .github/workflows/pypi-release.yml— passed.openhands-agent-server/openhands/agent_server/frontend/build, ranuv build --package openhands-agent-server --wheel --out-dir /tmp/agent-server-build-test, and verified the wheel containedopenhands/agent_server/frontend/index.htmlandopenhands/agent_server/frontend/assets/app.js.python .github/scripts/fetch_agent_canvas_frontend.py --target /tmp/agent-canvas-frontend-testand verified the fetched package produced/tmp/agent-canvas-frontend-test/index.htmland anassets/directory.Video/Screenshots
No screenshot was captured. The FastAPI route behavior was exercised with
TestClient:/servesindex.html,/assets/app.jsserves a real root-relative asset, SPA routes fall back toindex.html, missing assets return 404, and missing/api/*paths return JSON 404s instead of frontend HTML.Type
Notes
The generated frontend asset directory is intentionally git-ignored; the PyPI release workflow fetches the published agent-canvas build before building distributions so the files are included by package data without committing thousands of generated frontend files.
This PR was created by an AI agent (OpenHands) on behalf of the requester.
@enyst can click here to continue refining the PR
Agent Server images for this PR
• GHCR package: https://github.com/OpenHands/agent-sdk/pkgs/container/agent-server
Variants & Base Images
eclipse-temurin:17-jdknikolaik/python-nodejs:python3.13-nodejs22-slimgolang:1.21-bookwormPull (multi-arch manifest)
# Each variant is a multi-arch manifest supporting both amd64 and arm64 docker pull ghcr.io/openhands/agent-server:172bc34-pythonRun
All tags pushed for this build
About Multi-Architecture Support
172bc34-python) is a multi-arch manifest supporting both amd64 and arm64172bc34-python-amd64) are also available if needed