Skip to content

Add trusted-server-adapter-axum native dev server (PR 16)#643

Open
prk-Jr wants to merge 19 commits intofeature/edgezero-pr15-remove-fastly-corefrom
feature/edgezero-pr16-axum-dev-server
Open

Add trusted-server-adapter-axum native dev server (PR 16)#643
prk-Jr wants to merge 19 commits intofeature/edgezero-pr15-remove-fastly-corefrom
feature/edgezero-pr16-axum-dev-server

Conversation

@prk-Jr
Copy link
Copy Markdown
Collaborator

@prk-Jr prk-Jr commented Apr 17, 2026

Summary

  • Adds trusted-server-adapter-axum as a native (non-WASM) dev server so the full trusted-server pipeline can be run and tested locally without Fastly Compute or Viceroy
  • Promotes the axum adapter to a first-class workspace member by removing the global target = "wasm32-wasip1" override from .cargo/config.toml; Fastly-specific commands now pass --target wasm32-wasip1 explicitly
  • Extends the integration test matrix so WordPress and Next.js scenarios run against both Fastly (Viceroy) and Axum, verifying identical behaviour across platforms

Changes

File Change
crates/trusted-server-adapter-axum/src/platform.rs PlatformConfigStore, PlatformSecretStore, PlatformBackend, PlatformGeo, PlatformHttpClient — env-var-backed implementations
crates/trusted-server-adapter-axum/src/middleware.rs FinalizeResponseMiddleware + AuthMiddleware — mirrors Fastly adapter, always emits X-Geo-Info-Available: false
crates/trusted-server-adapter-axum/src/app.rs TrustedServerApp implementing Hooks with all 11 routes wired
crates/trusted-server-adapter-axum/src/main.rs + axum.toml Binary entry point; config drives port (default 8787)
crates/trusted-server-adapter-axum/tests/routes.rs 8 integration tests via EdgeZeroAxumService (no live TCP server)
crates/integration-tests/tests/environments/axum.rs AxumDevServer runtime environment added to the matrix
crates/integration-tests/tests/environments/mod.rs Register AxumDevServer alongside FastlyViceroy
crates/integration-tests/tests/integration.rs test_wordpress_axum + test_nextjs_axum individual test functions
scripts/integration-tests.sh Also builds the Axum native binary with test-specific env vars
.cargo/config.toml Remove global target = "wasm32-wasip1"; keep only the viceroy runner
Cargo.toml Move trusted-server-adapter-axum from [exclude] to [members]
crates/trusted-server-adapter-axum/Cargo.toml Adopt workspace deps + lints
.github/workflows/test.yml Add test-axum CI job; test-rust now passes --target wasm32-wasip1 explicitly
CLAUDE.md Document axum adapter in workspace layout + build commands
.gitignore (root + adapter) Ignore .edgezero/ (local KV store created by dev server)

Closes

Closes #497

Test plan

  • cargo test --workspace (Fastly/WASM crates via Viceroy)
  • cargo test -p trusted-server-adapter-axum (8 route + middleware tests)
  • cargo clippy --workspace --all-targets --all-features -- -D warnings
  • cargo fmt --all -- --check
  • JS tests: cd crates/js/lib && npx vitest run (282 tests)
  • Integration tests: test_wordpress_fastly, test_nextjs_fastly, test_wordpress_axum, test_nextjs_axum all pass
  • Manual testing: cargo run -p trusted-server-adapter-axum starts on port 8787

Checklist

  • Changes follow CLAUDE.md conventions
  • No unwrap() in production code — use expect("should ...")
  • Uses log macros (not println!)
  • New code has tests
  • No secrets or credentials committed

prk-Jr added 12 commits April 17, 2026 11:13
Move trusted-server-adapter-axum from workspace exclude to members list.
Remove the global `target = "wasm32-wasip1"` build override from
.cargo/config.toml (which forced the axum crate out of the workspace)
and pass --target wasm32-wasip1 explicitly only for Fastly CI commands.
Delete the now-redundant crate-local .cargo/config.toml.

Update CI test-rust job to exclude the axum crate and pass the explicit
target; test-axum job runs from the workspace root with -p flag.
Add .edgezero/ to .gitignore to exclude the local KV store file.
Register AxumDevServer alongside FastlyViceroy in RUNTIME_ENVIRONMENTS so
the full framework x runtime scenario matrix (WordPress, Next.js) runs
against both platforms.

AxumDevServer spawns the native trusted-server-axum binary (no WASM or
Viceroy), binds to the fixed port 8787 (baked into axum.toml at compile
time), and polls for any HTTP response as readiness (root returns 403 in
test env). Binary path defaults to target/debug/trusted-server-axum,
overridable via AXUM_BINARY_PATH.

Settings are baked in at build time via TRUSTED_SERVER__* env vars, same
as Fastly. The integration-tests.sh script now builds both the WASM and
the native Axum binary with test-specific overrides (origin=127.0.0.1:8888).

Add test_wordpress_axum and test_nextjs_axum individual test functions.
Ignore .edgezero/ at workspace root (local KV store from the dev server).
@prk-Jr prk-Jr self-assigned this Apr 17, 2026
@prk-Jr prk-Jr linked an issue Apr 17, 2026 that may be closed by this pull request
prk-Jr added 3 commits April 17, 2026 13:42
- README: update Quick Start and Development commands for both runtimes
- getting-started: add Axum as Option A (no Fastly CLI needed)
- architecture: add trusted-server-adapter-axum to Core Components;
  add Runtime Targets table
- testing: fix cargo test commands; add Axum adapter section; split
  Local Server Testing into Axum vs Fastly; restore clippy step in
  CI/CD workflow example alongside new test-axum job
The integration test matrix includes AxumDevServer which requires the
native trusted-server-axum binary. Add build-axum step to the shared
setup action, package the binary alongside the WASM artifact, and pass
AXUM_BINARY_PATH to the integration test run step.
@prk-Jr prk-Jr marked this pull request as draft April 17, 2026 08:27
@prk-Jr prk-Jr marked this pull request as ready for review April 18, 2026 14:14
@prk-Jr prk-Jr requested review from ChristianPavilonis and aram356 and removed request for aram356 April 18, 2026 14:14
Copy link
Copy Markdown
Collaborator

@aram356 aram356 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary

Introduces a native Axum dev-server adapter that runs the full trusted-server pipeline locally without Fastly Compute or Viceroy, promotes the crate to a workspace member, and extends the integration-test matrix to cover both runtimes. Requesting changes for a handful of small but concrete issues: unused deps, stale lockfile, doc/code drift, and a middleware bypass on the startup-error path.

Blocking

🔧 wrench

  • Unused direct dependencies: serde_json and trusted-server-js declared in crates/trusted-server-adapter-axum/Cargo.toml but never referenced in src/ or tests/. See inline.
  • Stale crate-local Cargo.lock: ~100 KB file that cargo now silently ignores (crate is a workspace member). Delete it to avoid lockfile drift.
  • CLAUDE.md comment contradicts the PR: says "excluded from workspace" at line 14 while the PR makes it a workspace member. See inline.
  • Log text references a non-existent NoopKvStore: the code uses UnavailableKvStore (src/platform.rs:367 vs :379). See inline.
  • Startup-error router bypasses middleware: startup_error_router() has no FinalizeResponseMiddleware / AuthMiddleware, breaking the "every response has X-Geo-Info-Available" invariant and bypassing operator headers + basic auth on startup-failure responses. See inline on src/app.rs:134.

Non-blocking

🤔 thinking

  • send_async/select diverges from Fastly (eager execution changes error-surface timing and ordering). Trade-off is documented, but consider a breadcrumb log or real tokio::spawn fan-out. See inline.
  • Body::Stream outbound body silently truncated to empty on axum. See inline.
  • Env-var namespace collisions possible due to -/./ _ normalization. See inline.
  • Fixed port 8787 baked at compile time can TIME_WAIT-flake across sequential integration tests. See inline.

♻️ refactor

  • reqwest::Client rebuilt per request — defeats connection pool. Move to shared Arc<AxumPlatformHttpClient> in AppState. See inline.
  • Env-var tests not isolated — use temp-env (already a workspace dep). See inline.
  • bytes::BytesVec<u8> round-trip on request/response bodies is wasted allocation. See inline.
  • tests/routes.rs uses .unwrap() instead of .expect("should ...") — CLAUDE.md applies to test code. See inline.

🌱 seedling

  • No /health endpoint — AxumDevServer::health_check_path() returns /health but the app never registers it; tests work around with wait_for_any_response. See inline.

⛏ nitpick

  • Crate-local .gitignore is redundant with the workspace .gitignore. See inline.
  • build_per_request_services is a no-op wrapper around build_runtime_services. See inline.

📝 note

  • test-axum CI job runs without TRUSTED_SERVER__* env vars — every request goes through the startup-error path. Smoke tests still pass, but not a great signal. See inline.

CI Status

  • fmt: PASS (verified locally, cargo fmt --all -- --check)
  • clippy (axum crate, host target): PASS with zero warnings
  • cargo test -p trusted-server-adapter-axum: 18 tests PASS
  • GitHub CI on 75fe0d01: prepare artifacts + integration tests + browser tests all PASS

Comment thread crates/trusted-server-adapter-axum/Cargo.toml Outdated
Comment thread crates/trusted-server-adapter-axum/Cargo.lock Outdated
Comment thread CLAUDE.md Outdated
Comment thread crates/trusted-server-adapter-axum/src/platform.rs Outdated
Comment thread crates/trusted-server-adapter-axum/src/app.rs
Comment thread crates/integration-tests/tests/environments/axum.rs Outdated
Comment thread crates/integration-tests/tests/environments/axum.rs
Comment thread crates/trusted-server-adapter-axum/.gitignore Outdated
Comment thread crates/trusted-server-adapter-axum/src/app.rs Outdated
Comment thread .github/workflows/test.yml
prk-Jr added 3 commits April 21, 2026 12:48
… bypass, refactors

Blocking:
- Remove unused serde_json and trusted-server-js from Cargo.toml
- Delete crate-local Cargo.lock (now silently ignored as workspace member)
- Fix CLAUDE.md workspace layout comment (drop "excluded from workspace")
- Fix log message naming NoopKvStore → UnavailableKvStore in build_runtime_services
- Wrap startup_error_router with FinalizeResponseMiddleware(Settings::default()) so
  startup-error responses carry X-Geo-Info-Available and operator response_headers

Refactor:
- Move AxumPlatformHttpClient to AppState; share Arc across requests via
  build_runtime_services(ctx, Arc::clone(&state.http_client)) to preserve
  the reqwest connection pool
- Remove build_per_request_services no-op wrapper; inline at call sites
- Use temp_env::with_var in config/secret store tests for proper isolation
- Replace .unwrap() with .expect("should ...") throughout test code per CLAUDE.md

Nitpick:
- Delete redundant crate-local .gitignore (covered by workspace .gitignore)
…ce breadcrumbs

Port fix:
- main.rs reads PORT env var at startup; when set, uses AxumDevServer::with_config
  with a dynamic SocketAddr instead of the run_app default (hardcoded 8787)
- Integration test spawner (axum.rs) now calls find_available_port() and passes
  PORT=<port> to the child process, matching the Fastly env's dynamic-port pattern
- Fallback to AXUM_DEFAULT_PORT=8787 if find_available_port fails (offline runner)

Divergence breadcrumbs:
- send_async: debug log noting that execution is eager and errors surface immediately,
  not at select() time as they do on Fastly
- select: debug log noting that index 0 is popped unconditionally (sequential, not
  first-to-complete) — any fan-out ordering tests should use the Fastly runtime
Copy link
Copy Markdown
Collaborator

@ChristianPavilonis ChristianPavilonis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary

Nice addition overall — the Axum adapter is headed in a useful direction. I found a few correctness gaps in the platform shim plus a couple of documentation mismatches around what the Axum runtime can currently support.

self.execute(request).await
}

async fn send_async(
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auction fan-out becomes serial on Axum. send_async() awaits self.execute(), and execute() fully buffers the upstream response before returning. The auction orchestrator in trusted-server-core assumes send_async() only launches the request and that select() yields whichever backend finishes first, so this changes response ordering, deadline enforcement, and response_time_ms accounting for multi-provider auctions.

Could we keep a real in-flight handle here (for example by storing spawned futures/joins and polling them from select()), or gate /auction off on Axum until the platform layer can preserve Fastly's concurrency semantics?

builder = builder.body(bytes);
}
}
edgezero_core::body::Body::Stream(_) => {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Streaming outbound bodies are dropped. On the Axum path, non-JSON inbound bodies are intentionally preserved as Body::Stream by edgezero_adapter_axum::into_core_request(). handle_publisher_request() then forwards the original request through services.http_client().send(...), but this match arm only logs and sends an empty body. That means proxied POSTs/uploads can reach the publisher origin with no payload.

Please either stream/buffer the body into reqwest here, or fail the request explicitly instead of silently truncating it.

.middleware(AuthMiddleware::new(Arc::clone(&state.settings)))
.get("/.well-known/trusted-server.json", discovery_handler)
.post("/verify-signature", verify_handler)
.post("/admin/keys/rotate", rotate_handler)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These admin routes are wired up even though Axum can't persist the requested writes. AxumPlatformConfigStore::{put,delete} and AxumPlatformSecretStore::{create,delete} always return "not supported", but /admin/keys/rotate and /admin/keys/deactivate are still exposed here. With request signing enabled and valid admin auth, /admin/keys/rotate currently returns 500 as soon as the first store write happens.

I think we should either hide these routes on Axum or convert the unsupported-operation path into a clear 501/4xx response instead of advertising working admin endpoints.


```bash
cargo test
# Copy and edit the environment file
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Axum quick-start implies .env is auto-loaded, but the adapter never does that. The new dev-server path reads process environment variables directly (plus axum.toml); nothing in the adapter sources .env. As written, cp .env.dev .env looks sufficient when users actually need to export/source those variables into their shell.

Can we update this section to show how to load the variables into the environment and mention the TRUSTED_SERVER_CONFIG_* / TRUSTED_SERVER_SECRET_* conventions the Axum platform store uses?


Native Axum dev server adapter (native binary):

- Runs the full trusted-server pipeline locally without Fastly or Viceroy
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This overstates Axum parity with Fastly. The new adapter still has several important limitations (no KV store, no geo lookup, no config/secret-store writes, and send_async() does not preserve Fastly-style fan-out semantics). Calling it "the full trusted-server pipeline" and useful for "non-Fastly deployments" sets the wrong expectation for readers.

I'd reframe this as a local development / integration-test adapter and call out the current limitations explicitly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Axum dev server entry point

3 participants