[codex] Expose web service host port by michaelmwu · Pull Request #277 · 508-dev/508-workflows

michaelmwu · 2026-05-14T07:46:57Z

Summary

Rename the Compose backend service from api to web and update internal Docker URLs to http://web:8090.
Publish the web/API service port from the base Compose file so host-side Cloudflare Tunnel can target it.
Replace webhook-specific port naming with WEB_* names while keeping WEBHOOK_INGEST_* as deprecated fallbacks.

Validation

uv run pytest tests/unit/test_worktree_env.py tests/unit/test_shared_settings.py tests/unit/test_jobcli.py
uv run ruff check packages/shared/src/five08/settings.py apps/api/src/five08/backend/api.py scripts/dev_mux.py tests/unit/test_worktree_env.py tests/unit/test_shared_settings.py apps/worker/src/five08/jobcli.py tests/unit/test_jobcli.py
docker compose -f compose.yaml config --services
docker compose -f compose.yaml -f compose.local.yaml config --services
git diff --check

Summary by CodeRabbit

Documentation
- Updated architecture, README and run guides to use the service name "web" (replacing "api") and reflect dashboard/API routing and scaling; examples and diagrams updated accordingly.
Chores
- Standardized environment variables to WEB_HOST/WEB_PORT/WEB_HOST_BIND with legacy WEBHOOK_INGEST_* kept as deprecated fallbacks; local compose/dev port binding and host-published port behavior documented and aligned across scripts.

coderabbitai · 2026-05-14T07:47:12Z

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: abcc4533-91da-4301-8b30-a8043c5bcc61

📥 Commits

Reviewing files that changed from the base of the PR and between 0d3590b and 51d9597.

📒 Files selected for processing (16)

.env.example
README.md
apps/api/src/five08/backend/api.py
apps/worker/README.md
apps/worker/src/five08/jobcli.py
compose.local.yaml
compose.yaml
packages/shared/src/five08/settings.py
scripts/dev.sh
scripts/dev_mux.py
scripts/docker-compose.sh
scripts/worktree-env.sh
tests/unit/test_dev_mux.py
tests/unit/test_jobcli.py
tests/unit/test_shared_settings.py
tests/unit/test_worktree_env.py

💤 Files with no reviewable changes (1)

compose.local.yaml

✅ Files skipped from review due to trivial changes (1)

README.md

🚧 Files skipped from review as they are similar to previous changes (10)

apps/worker/src/five08/jobcli.py
tests/unit/test_jobcli.py
scripts/dev.sh
apps/api/src/five08/backend/api.py
compose.yaml
packages/shared/src/five08/settings.py
tests/unit/test_shared_settings.py
scripts/docker-compose.sh
scripts/dev_mux.py
tests/unit/test_worktree_env.py

📝 Walkthrough

Walkthrough

This PR renames the api service to web, replaces WEBHOOK_INGEST_* env vars with WEB_* names across code/docs/scripts, and preserves legacy names via Pydantic aliasing and shell fallbacks; compose mappings, startup bindings, and tests were updated accordingly.

Changes

Service Rename and Environment Variable Migration

Layer / File(s)	Summary
Environment variables and settings aliasing `.env.example`, `packages/shared/src/five08/settings.py`, `tests/unit/test_shared_settings.py`	`.env.example` introduces `WEB_HOST`, `WEB_PORT`, and `WEB_HOST_BIND`. `SharedSettings` adds `web_host`/`web_port` with `AliasChoices` aliases for legacy names and updates model_config. Unit tests verify new and legacy env-name population.
Compose service definition and port mapping & docs `compose.yaml`, `compose.local.yaml`, `README.md`	Compose service `api` → `web`; inter-service URLs and depends_on updated to `web:8090`. `web` service uses container-fixed port 8090 with host publish variables (`WEB_HOST_BIND`/`WEB_HOST_PORT`) and legacy fallbacks. README updated to reference `web` and `WEB_*` vars.
Development startup & runtime scripts `scripts/dev.sh`, `scripts/dev_mux.py`, `scripts/docker-compose.sh`, `scripts/worktree-env.sh`	Dev scripts now use `WEB_HOST`/`WEB_PORT` (with `WEBHOOK_INGEST_*` fallbacks) for Uvicorn binds and printed/exported ports. `worktree-env.sh` adds preferred/legacy port resolution helpers; docker-compose helper exports `WEB_HOST_PORT` and unsets `WEB_PORT` to avoid interpolation leaks.
API service startup `apps/api/src/five08/backend/api.py`	Uvicorn binding updated to `settings.web_host` / `settings.web_port`.
Worker and internal service references `apps/worker/src/five08/jobcli.py`, `apps/worker/README.md`, `tests/unit/test_jobcli.py`	`DEFAULT_DOCKER_API_URL` and docs/examples switched from `http://api:8090` to `http://web:8090`; jobcli tests updated to assert requests against `web:8090`.
Worktree/compose tests `tests/unit/test_worktree_env.py`, `tests/unit/test_dev_mux.py`	Tests updated to inject/expect `WEB_HOST_PORT`/`WEB_PORT` behavior, assert legacy `WEBHOOK_INGEST_*` fallbacks are accepted, and adjust host-mode output expectations.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

508-dev/508-workflows#140: Updates jobcli.py's DEFAULT_DOCKER_API_URL and worker backend wiring to target a different service hostname/port.
508-dev/508-workflows#238: Changes local dev host/port wiring and dev script/compose port-allocation logic that this PR extends with WEB_* variables and fallbacks.

Poem

🐰 The api hops to web, so spry and fleet,
With WEB_* names, the config's now complete,
Aliases keep the old friends close nearby,
Ports resolve, containers listen, tests comply,
A tiny rabbit clap—migration done, hi!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 22.22% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title '[codex] Expose web service host port' clearly summarizes the primary change: exposing/publishing the web service's host port for external access via Cloudflare Tunnel, which aligns with the core objective across all modified files.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch michaelmwu/web-host-port

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull request overview

This PR renames the containerized backend service from api to web, updates internal service URLs, and exposes the web/API port from the base Compose stack for host-side tunnel access.

Changes:

Renames Compose service references and Docker-internal URLs from api to web.
Introduces WEB_* host/port settings with deprecated WEBHOOK_INGEST_* fallbacks.
Updates scripts, settings, docs, and tests to use the new web/API naming.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
`compose.yaml`	Renames `api` service to `web`, updates internal URLs, and publishes port `8090`.
`compose.local.yaml`	Removes the now-duplicated local web/API port override.
`.env.example`	Documents new `WEB_*` variables and legacy fallbacks.
`packages/shared/src/five08/settings.py`	Adds `web_host` / `web_port` settings with alias choices.
`apps/api/src/five08/backend/api.py`	Uses renamed web settings for uvicorn startup.
`apps/worker/src/five08/jobcli.py`	Updates Docker default API URL to `http://web:8090`.
`scripts/worktree-env.sh`	Resolves preferred `WEB_*` ports while preserving legacy exports.
`scripts/docker-compose.sh`	Exports the new Compose host port variable and avoids leaking host-run app ports.
`scripts/dev.sh`	Uses `WEB_PORT` / `WEB_HOST` for host-run development.
`scripts/dev_mux.py`	Launches the web service using the new env names.
`README.md`	Updates service naming and environment documentation.
`apps/worker/README.md`	Updates worker documentation examples for the `web` service.
`tests/unit/test_worktree_env.py`	Updates and expands worktree env tests for new and legacy port names.
`tests/unit/test_shared_settings.py`	Adds settings coverage for new and legacy env names.
`tests/unit/test_jobcli.py`	Updates Docker default URL expectation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@scripts/dev_mux.py`:
- Around line 36-38: The startup argument construction in scripts/dev_mux.py
currently uses env["WEB_PORT"] which raises KeyError in legacy-only
environments; change that to fall back to WEBHOOK_INGEST_PORT like the host line
does. Update the port argument creation (the block that builds the CLI args
where env.get("WEB_HOST", env.get("WEBHOOK_INGEST_HOST", "0.0.0.0")) is used) to
use env.get("WEB_PORT", env.get("WEBHOOK_INGEST_PORT")) (or equivalent env.get
chain) instead of env["WEB_PORT"] so legacy envs without WEB_PORT do not crash.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d6a4e6b5-49db-4042-8204-64f3fa3739a1

📥 Commits

Reviewing files that changed from the base of the PR and between a459d25 and 0d3590b.

📒 Files selected for processing (15)

.env.example
README.md
apps/api/src/five08/backend/api.py
apps/worker/README.md
apps/worker/src/five08/jobcli.py
compose.local.yaml
compose.yaml
packages/shared/src/five08/settings.py
scripts/dev.sh
scripts/dev_mux.py
scripts/docker-compose.sh
scripts/worktree-env.sh
tests/unit/test_jobcli.py
tests/unit/test_shared_settings.py
tests/unit/test_worktree_env.py

💤 Files with no reviewable changes (1)

compose.local.yaml

CopilotAI review requested due to automatic review settings May 14, 2026 07:46

michaelmwu temporarily deployed to test May 14, 2026 07:47 — with GitHub Actions Inactive

Copilotstarted reviewing on behalf of michaelmwu May 14, 2026 07:47 View session

CopilotAI reviewed May 14, 2026
View reviewed changes

coderabbitaiBot reviewed May 14, 2026
View reviewed changes

Comment threadscripts/dev_mux.py Outdated

Expose web service host port
51d9597

michaelmwu force-pushed the michaelmwu/web-host-port branch from 0d3590b to 51d9597Compare May 14, 2026 09:50

michaelmwu temporarily deployed to test May 14, 2026 09:50 — with GitHub Actions Inactive

michaelmwu merged commit bf167ff into mainMay 14, 2026
6 of 7 checks passed

michaelmwu deleted the michaelmwu/web-host-port branch May 14, 2026 09:53

coderabbitaiBot mentioned this pull request May 20, 2026
[codex] Use Conductor port range for worktree defaults #294
Merged

Navigation Menu

Uh oh!

Uh oh!

[codex] Expose web service host port - #277

[codex] Expose web service host port#277
michaelmwu merged 1 commit into
mainfrom
michaelmwu/web-host-port

michaelmwu commented May 14, 2026•
edited by coderabbitai Bot
Loading

Uh oh!

coderabbitaiBot commented May 14, 2026•
edited
Loading

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

❌ Failed checks (1 warning)

Uh oh!

CopilotAI left a comment

Uh oh!

coderabbitaiBot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

michaelmwu commented May 14, 2026• edited by coderabbitai BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Validation

Summary by CodeRabbit

Uh oh!

coderabbitaiBot commented May 14, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

❌ Failed checks (1 warning)

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

coderabbitaiBot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

michaelmwu commented May 14, 2026•
edited by coderabbitai Bot
Loading

coderabbitaiBot commented May 14, 2026•
edited
Loading