Skip to content

Add trusted-server-adapter-cloudflare crate (PR 17)#644

Open
prk-Jr wants to merge 20 commits into
feature/edgezero-pr16-axum-dev-serverfrom
feature/edgezero-pr17-cloudflare-adapter
Open

Add trusted-server-adapter-cloudflare crate (PR 17)#644
prk-Jr wants to merge 20 commits into
feature/edgezero-pr16-axum-dev-serverfrom
feature/edgezero-pr17-cloudflare-adapter

Conversation

@prk-Jr
Copy link
Copy Markdown
Collaborator

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

Summary

  • Add `trusted-server-adapter-cloudflare` crate — a Cloudflare Workers entry point using `#[event(fetch)]` and `edgezero_adapter_cloudflare::run_app`. Implements `Hooks` with full route parity to the Fastly and Axum adapters including admin key routes, auction, first-party proxy, and publisher fallback.
  • Add `CloudflareHttpClient` (wasm32 only) backed by `worker::Fetch` so outbound proxy requests actually reach the origin on the Workers runtime. Strips `content-encoding`/`transfer-encoding` headers since the Workers runtime auto-decompresses responses, preventing a double-decompress error in the proxy layer.
  • Wire real Cloudflare store implementations in `platform.rs` via edgezero handles injected by `run_app` — reducing `#[cfg(target_arch = "wasm32")]` blocks from 5 to 2:
    • Config: `ConfigStoreHandleAdapter` bridges `ctx.config_store()` to `PlatformConfigStore` — reuses the already-parsed `TRUSTED_SERVER_CONFIG` JSON handle.
    • KV: `KvHandleAdapter` bridges `ctx.kv_handle()` to `PlatformKvStore` — reuses the `env.kv()` handle opened by `run_app`.
    • Secrets: `CloudflareSecretStoreAdapter` calls `env.secret()` synchronously (still `#[cfg]` — `SecretHandle::get_bytes` is async while `PlatformSecretStore::get_bytes` is sync).
    • Geo: `CloudflareGeo` reads `cf-ipcountry`, `cf-ipcity`, `cf-ipcontinent`, `cf-iplatitude`, `cf-iplongitude` — no `#[cfg]` needed, degrades gracefully on native.
  • Replace `std::time::Instant` with `web_time::Instant` in the auction orchestrator and audit remaining `std::time::SystemTime` usages in `proxy.rs` and `signing.rs` — `std::time` panics on `wasm32-unknown-unknown` (Cloudflare), while `web_time` works on all three targets.

Changes

File Change
`crates/trusted-server-adapter-cloudflare/src/lib.rs` New — `#[event(fetch)]` entry point, cfg-gated for wasm32
`crates/trusted-server-adapter-cloudflare/src/app.rs` New — `TrustedServerApp` implementing `Hooks`, full route table
`crates/trusted-server-adapter-cloudflare/src/platform.rs` New — real store adapters (`ConfigStoreHandleAdapter`, `KvHandleAdapter`, `CloudflareSecretStoreAdapter`, `CloudflareGeo`), `CloudflareHttpClient` (wasm32), `extract_client_ip` + 7 unit tests
`crates/trusted-server-adapter-cloudflare/build.sh` New — NVM + `.env` sourcing, `cd SCRIPT_DIR` guard, worker-build 0.7
`crates/trusted-server-adapter-cloudflare/Cargo.toml` New — crate manifest with wasm32 target deps
`crates/trusted-server-adapter-cloudflare/wrangler.toml` New — wrangler config; uses `--cwd` DX so `wrangler dev` runs from workspace root
`crates/trusted-server-adapter-cloudflare/cloudflare.toml` New — edgezero manifest declaring `TRUSTED_SERVER_CONFIG`, `TRUSTED_SERVER_KV`, secrets bindings
`crates/trusted-server-adapter-cloudflare/.gitignore` Add `build/` and `.dev.vars` (wrangler convention for local secrets)
`crates/trusted-server-adapter-cloudflare/tests/routes.rs` New — host-target smoke test: `routes()` builds without panic
`crates/trusted-server-core/src/auction/orchestrator.rs` `std::time::Instant` → `web_time::Instant`
`crates/trusted-server-core/src/proxy.rs` `std::time::SystemTime` → `web_time::SystemTime` (import + test)
`crates/trusted-server-core/src/request_signing/signing.rs` `std::time::SystemTime` → `web_time::SystemTime` (production + test)
`crates/trusted-server-core/src/consent/mod.rs` `std::time::SystemTime` → `web_time::SystemTime`
`crates/trusted-server-core/src/platform/http.rs` Add `UnavailableHttpClient` (shared stub for platforms without outbound HTTP)
`Cargo.toml` Add `web-time`, `js-sys`, `bytes` to workspace deps
`.github/workflows/test.yml` Add CI jobs: native check + wasm32-unknown-unknown check for Cloudflare adapter
`crates/integration-tests/tests/environments/cloudflare.rs` New — `CloudflareWorkers` integration test environment
`crates/integration-tests/tests/environments/mod.rs` Export `cloudflare` environment module
`crates/integration-tests/tests/integration.rs` Add Cloudflare integration test cases (ignored pending wrangler dev)
`.vscode/tasks.json` Add "cloudflare dev server" task using `wrangler dev --cwd` from workspace root
`CLAUDE.md` Document Cloudflare adapter build/check/test commands

Closes

Closes #498

Test plan

  • `cargo test --workspace` (excluding Fastly adapter — Fastly WASM ABI not linkable on native host, pre-existing)
  • `cargo clippy --workspace --all-targets --all-features -- -D warnings`
  • `cargo fmt --all -- --check`
  • JS tests: `cd crates/js/lib && npx vitest run`
  • JS format: `cd crates/js/lib && npm run format`
  • Docs format: `cd docs && npm run format`
  • WASM build: `cargo check -p trusted-server-adapter-cloudflare --target wasm32-unknown-unknown`
  • Manual testing via `wrangler dev` — proxy reaches origin, JS static routes serve correctly, no double-decompress errors
  • Native host-target tests: `cargo test -p trusted-server-adapter-cloudflare` (7 unit + 1 smoke test pass)

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

Known deferred items

  • Secret store writes (`create`/`delete`) are not supported on Cloudflare Workers — `/admin/keys/rotate` and `/admin/keys/deactivate` read and write keys via `PlatformConfigStore`/`PlatformSecretStore`. Reads work via `CloudflareSecretStoreAdapter`; write-back would require a Cloudflare management API call outside the Workers runtime.

prk-Jr added 5 commits April 17, 2026 13:58
…ator

wasm32-unknown-unknown (Cloudflare Workers) does not support
std::time::Instant — it panics at runtime. web_time::Instant is a
zero-cost drop-in on native and JS-backed on WASM.
Implements the Cloudflare Workers adapter following the same pattern as
trusted-server-adapter-axum: TrustedServerApp implements the Hooks trait,
platform services use noop stubs on native (CI-compilable), and the
#[event(fetch)] entry point delegates to edgezero_adapter_cloudflare::run_app.

Also adds UnavailableHttpClient to trusted-server-core platform module,
parallel to the existing UnavailableKvStore.
CI: test-cloudflare job checks native host compile, wasm32-unknown-unknown
compile (with cloudflare feature), and runs host-target unit tests.
CLAUDE.md: add cloudflare crate to workspace layout and build commands.
…un_app

The rev (38198f9) of edgezero used in this workspace requires worker 0.7
(not 0.6) and run_app() takes a manifest_src: &str as first argument.
Updated Cargo.toml and lib.rs accordingly.
- Implement CloudflareHttpClient (wasm32 only) using worker::Fetch for real
  outbound proxy requests; strip content-encoding/transfer-encoding headers
  since the Workers runtime auto-decompresses responses
- Add build.sh with cd-to-SCRIPT_DIR guard so worker-build always runs from
  the correct crate root regardless of invocation directory
- Switch wrangler dev task to use --cwd from workspace root (same DX as Fastly)
- Add js-sys to workspace dependencies; reference it via { workspace = true }
- Fix #[ignore] messages on Cloudflare integration tests
- Replace std::time::{SystemTime,UNIX_EPOCH} with web_time in test code for
  signing.rs and proxy.rs (consistency with production paths)
- Add NoopConfigStore/NoopSecretStore TODO comment tracking the gap
- Add extract_client_ip unit tests (parses cf-connecting-ip, absent, invalid)
- Remove empty crate_compiles_on_host_target test
- Add CloudflareHttpClient timeout doc noting Workers CPU-budget tradeoff
@prk-Jr prk-Jr self-assigned this Apr 18, 2026
@prk-Jr prk-Jr marked this pull request as draft April 18, 2026 13:08
prk-Jr added 3 commits April 18, 2026 19:25
Replace direct worker::Env store construction with edgezero handles
already injected by run_app, reducing #[cfg(target_arch = "wasm32")]
blocks from 5 to 2.

- ConfigStoreHandleAdapter: bridges ctx.config_store() to
  PlatformConfigStore — reuses the already-parsed TRUSTED_SERVER_CONFIG
  JSON handle rather than re-parsing it on every request
- KvHandleAdapter: bridges ctx.kv_handle() to PlatformKvStore — reuses
  the env.kv() handle opened by run_app rather than opening a new one
- CloudflareGeo: moved outside #[cfg]; reads cf-ipcountry and related
  headers via ctx.request().headers() which needs no platform import
- CloudflareSecretStoreAdapter: kept under #[cfg] — env.secret() is
  synchronous at the JS level but PlatformSecretStore::get_bytes is sync
  while SecretHandle::get_bytes is async; direct env access is required
- Add .dev.vars to .gitignore (wrangler convention for local secrets)
- Add bytes workspace dep for KvStore impl
- Implement CloudflareWorkers::spawn() to start wrangler dev; in CI uses
  wrangler.ci.toml (no build step, uses pre-built bundle); locally uses
  wrangler.toml (triggers build.sh rebuild)
- Add wrangler.ci.toml: no [build] section so wrangler dev skips the
  worker-build step when the bundle is pre-built as a CI artifact
- Add build-cloudflare input to setup-integration-test-env: adds
  wasm32-unknown-unknown target and runs build.sh with integration test env vars
- In prepare-artifacts: enable build-cloudflare and upload build/ dir as artifact
- In integration-tests: restore CF build dir, install wrangler, set
  CLOUDFLARE_WRANGLER_DIR, and remove --skip flags for cloudflare tests
@prk-Jr prk-Jr linked an issue Apr 20, 2026 that may be closed by this pull request
@prk-Jr prk-Jr marked this pull request as ready for review April 20, 2026 12:01
- Add GeoInfo happy-path test: build_geo_lookup_returns_some_with_populated_country
  verifies country, city, continent, latitude, and longitude are correctly
  populated when Cloudflare headers are present
- Simplify CloudflareSecretStoreAdapter::get_bytes: collapse brittle JsError
  string-matching guards into a single error arm with contextual message
- Document sequential fan-out latency in CloudflareHttpClient: explain
  sum(DSP_i) vs max(DSP_i) implication and why true parallelism is blocked
  by the ?Send bound on PlatformHttpClient
- Fix stale wrangler.toml comment: update to reflect ConfigStoreHandleAdapter
  wiring rather than the now-fallback NoopConfigStore
- Extend CI triggers to feature branches: format.yml and test.yml now run
  fmt/clippy/tests on PRs targeting feature/** so stacking PRs are gated
- Fix fmt violations caught during pre-review verification: platform.rs
  two-line Err wrapping and plan doc Prettier formatting
@prk-Jr prk-Jr marked this pull request as draft April 20, 2026 15:37
The adapter's tokio dev-dependency uses rt-multi-thread which is not
supported on wasm32. It is already tested in the dedicated test-cloudflare
job; exclude it from the workspace wasm test to avoid the compile error.
@prk-Jr prk-Jr marked this pull request as ready for review April 20, 2026 16:07
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

Adds the Cloudflare adapter, runtime wiring, and CI coverage. CI is green, but I found two correctness issues that should be addressed before merge, plus two smaller follow-ups.

Comment thread crates/trusted-server-adapter-cloudflare/src/app.rs
Comment thread crates/trusted-server-adapter-cloudflare/src/platform.rs
Comment thread crates/trusted-server-adapter-cloudflare/src/platform.rs Outdated
Comment thread crates/integration-tests/tests/integration.rs Outdated
prk-Jr added 6 commits April 28, 2026 17:31
Resolved conflicts:
- .cargo/config.toml: extend test-fastly alias to also exclude trusted-server-adapter-cloudflare
- .github/workflows/test.yml: use cargo test-fastly alias in CI (from PR16) and keep test-cloudflare job (from PR17)
- CLAUDE.md: keep Cloudflare workspace entry and cargo test-axum alias; merge both adapters' commands
- crates/trusted-server-core/src/proxy.rs: use #[tokio::test] + std::time pattern (consistent with PR16 tests)
- Cargo.lock: regenerated to reflect merged workspace state
Brings in the default-members fix: restricts workspace default-members
to `trusted-server-adapter-fastly` so Viceroy can locate the binary
via `cargo run --bin` during `cargo test-fastly`.
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

Adds the Cloudflare Workers adapter, with web_time migration in core and a new CI job. The middleware-bypass and backend-naming concerns from the prior review are addressed and have regression tests, but the second prior 🔧 (sequential fan-out + missing per-request deadline) is mitigated only by documentation and a noisy log warning — the underlying behavior is unchanged. CI has three required gates failing.

Blocking

🔧 wrench

  • CI is red on three required gatescargo fmt --all -- --check, format-docs, and integration tests are failing on the latest run. The integration-tests failure is especially concerning because this PR is the one adding the CloudflareWorkers runtime to that matrix and the new env-var/wrangler wiring (integration-tests.yml:74-105). Either the new Cloudflare integration test broke, or it isn't actually running and another regression slipped in. Run cargo fmt --all, cd docs && npm run format, and reproduce the integration-tests failure locally with CLOUDFLARE_WRANGLER_DIR set; address whatever surfaces. Don't merge with red required checks.
  • Per-provider auction timeout is silently dropped on Cloudflare (crates/trusted-server-adapter-cloudflare/src/platform.rs:289-315) — see inline.
  • select() warning fires n-1 times per auction → log noise on every multi-provider request (crates/trusted-server-adapter-cloudflare/src/platform.rs:329-337) — see inline.

Non-blocking

🤔 thinking

  • send_async always materializes the body, then re-serializes it for select (platform.rs:289-315) — see inline.
  • Body::Stream silently dropped in outbound request body (platform.rs:228-235) — see inline.

♻️ refactor

  • get_fallback / post_fallback near-duplicates (app.rs:307-363) — see inline.
  • auth_middleware_rejects_with_401_when_credentials_required doesn't actually test 401 (tests/routes.rs:43-75) — see inline.

📌 out of scope

  • wrangler.toml ships a placeholder KV id (wrangler.toml:11) — id = "REPLACE_WITH_YOUR_KV_NAMESPACE_ID" is fine for wrangler dev --local but will fail at deploy. Either call this out in getting-started.md next to the deploy instructions, or use a kv_namespaces[].preview_id so dev still works while the prod id stays empty/required. Follow-up issue is fine.

📝 note

  • worker::Env::clone() per request (platform.rs:444-451) — see inline.

Prior-review status

  • ✅ Cloudflare routes skip middleware → fixed (new src/middleware.rs + regression tests in tests/routes.rs:23-75).
  • ⚠️ send_async serializes / no deadline → only documentation added; the underlying serialization and missing per-request timeout remain (see blocking findings above).
  • ✅ Backend names too coarse → fixed (platform.rs:62-77 includes scheme, host, port, timeout_ms, cert flag).
  • ✅ Stale ignore message → fixed (integration.rs:139,147).

CI Status

  • cargo fmt: FAIL
  • format-docs: FAIL
  • integration tests: FAIL
  • cargo check (cloudflare native + wasm32-unknown-unknown): PASS
  • cargo test: PASS
  • cargo test (axum native): PASS
  • vitest: PASS
  • format-typescript: PASS
  • browser integration tests: PASS

Comment thread crates/trusted-server-adapter-cloudflare/src/platform.rs
Comment thread crates/trusted-server-adapter-cloudflare/src/platform.rs Outdated
Comment thread crates/trusted-server-adapter-cloudflare/src/platform.rs
Comment thread crates/trusted-server-adapter-cloudflare/src/platform.rs Outdated
Comment thread crates/trusted-server-adapter-cloudflare/src/app.rs
Comment thread crates/trusted-server-adapter-cloudflare/tests/routes.rs Outdated
Comment thread crates/trusted-server-adapter-cloudflare/src/platform.rs
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

Adds the trusted-server-adapter-cloudflare crate (edgezero handle adapters for Config/KV/secrets, CloudflareHttpClient, geo extraction from cf-* headers), an integration test environment, and a web_time migration in core. Crate scaffolding and middleware wiring are sound after the prior two review rounds, but CI is red on three jobs (one introduced by this PR) and several correctness/quality concerns from the earlier reviews remain open.

Note: the PR base is feature/edgezero-pr16-axum-dev-server, not main. Two of the four CI failures listed below are inherited from the base — but they still block merge to main.

Blocking

🔧 wrench

  • cargo fmt fails on crates/integration-tests/tests/environments/cloudflare.rs — introduced by this PR. The integration-tests crate is in the workspace exclude list, so cargo fmt --all from the repo root passes; the CI rustfmt action checks every Rust file. See inline comment.
  • use worker::*; violates CLAUDE.mdcrates/trusted-server-adapter-cloudflare/src/lib.rs:7. See inline.
  • Integration tests fail with orphaned workerd processescrates/integration-tests/tests/environments/cloudflare.rs:104-109 only kills the wrangler parent; workerd grandchildren leak. Likely root cause of the test_all_combinations / test_nextjs_axum failures observed in CI. See inline.
  • Per-provider auction timeout silently dropped on Cloudflare (still open from prior review) — platform.rs:277. See inline.
  • select() warning logs n-1 times per multi-provider auction (still open from prior review) — platform.rs:337. See inline.
  • CI: clippy::type_complexity failurecrates/trusted-server-adapter-axum/src/platform.rs:194. Inherited from PR-16 base; cannot merge to main until fixed in the base chain. Suggested: type ResponseTriplet = (u16, Vec<(String, Vec<u8>)>, Vec<u8>);.
  • CI: format-docs failuredocs/guide/architecture.md and docs/guide/getting-started.md. Inherited from PR-15 (6d1184d6). Same merge-to-main concern.

Non-blocking

🤔 thinking

  • send_async eagerly awaits → multi-provider auctions degrade to sum(latencies) — see inline at platform.rs:315.
  • Body::Stream silently dropped on outbound — see inline at platform.rs:235.
  • Top-level worker dispatch error: {e} may leak internals to clients — see inline at lib.rs:20.
  • Eager full-response buffering with no cap — see inline at app.rs:96.
  • Confirm worker::Error::Display does not leak the secret value — see inline at platform.rs:391.
  • Hardcoded port 8787 conflicts with local wrangler dev — see inline at cloudflare.rs:23.

♻️ refactor

  • get_fallback and post_fallback are near-duplicates — see inline at app.rs:363.
  • auth_middleware_rejects_with_401_when_credentials_required doesn't actually test 401 — see inline at tests/routes.rs:75.

📝 note

  • Stale #[ignore] reason on Cloudflare integration tests — see inline at integration.rs:139.
  • The PR base also has red CI (format-docs, clippy::type_complexity). Recommend rebasing on the merged base before re-requesting review so CI status reflects only this PR's deltas.

⛏ nitpick

  • Method::from(... .to_ascii_uppercase()) — see inline at platform.rs:216.
  • wrangler.toml ships id = "REPLACE_WITH_YOUR_KV_NAMESPACE_ID"wrangler dev refuses to start until edited. Worth a one-line note in CLAUDE.md or atop build.sh.
  • The cloudflare feature in this crate's Cargo.toml is effectively redundant — [target.'cfg(target_arch = "wasm32")'.dependencies] already pulls worker and the adapter feature unconditionally on wasm32, so --features cloudflare only matters for cargo check on native. The doc comment names the use case but a one-line "why it isn't default" note would help future readers.

CI Status

  • cargo fmt: FAIL (introduced by this PR — crates/integration-tests/tests/environments/cloudflare.rs)
  • clippy: FAIL (inherited from base — axum type_complexity)
  • rust tests (fastly, axum, cloudflare): PASS
  • vitest: PASS
  • format-docs: FAIL (inherited from base)
  • format-typescript: PASS
  • integration tests: FAIL (test_all_combinations, test_nextjs_axum — likely the workerd cleanup issue)
  • browser integration tests: PASS
  • cargo check (cloudflare native + wasm32-unknown-unknown): PASS

Comment thread crates/integration-tests/tests/environments/cloudflare.rs Outdated
Comment thread crates/integration-tests/tests/environments/cloudflare.rs Outdated
Comment thread crates/integration-tests/tests/environments/cloudflare.rs
Comment thread crates/integration-tests/tests/integration.rs Outdated
Comment thread crates/trusted-server-adapter-cloudflare/src/lib.rs Outdated
Comment thread crates/trusted-server-adapter-cloudflare/src/platform.rs
Comment thread crates/trusted-server-adapter-cloudflare/src/platform.rs
Comment thread crates/trusted-server-adapter-cloudflare/src/app.rs
Comment thread crates/trusted-server-adapter-cloudflare/src/app.rs
Comment thread crates/trusted-server-adapter-cloudflare/tests/routes.rs Outdated
prk-Jr added 3 commits May 13, 2026 16:18
Blocking:
- Fix cargo fmt failure in integration-tests cloudflare.rs (long import, struct init)
- Replace `use worker::*` with explicit imports in adapter lib.rs
- Return generic 500 body from top-level dispatch error; log detail server-side
- Fix workerd process-group leak: spawn wrangler as group leader, killpg on drop
- Use find_available_port() for wrangler dev instead of hardcoded 8787
- Reject multi-provider fan-out in select() with PlatformError::HttpClient
  instead of a noisy warn; per-provider timeout is now enforced by failing
  loudly rather than silently degrading to sum(latencies)
- Fix clippy::type_complexity in axum platform.rs with ResponseTriplet alias
- Fix docs prettier formatting

Non-blocking:
- Return Err from execute() on Body::Stream outbound instead of silent empty body
- Assert unreachable! on Body::Stream in send_async (execute always returns Once)
- Extract shared dispatch() helper from get_fallback/post_fallback duplicates
- Rename auth test to auth_middleware_runs_in_chain_for_protected_routes
- Update stale #[ignore] reasons for Cloudflare integration tests
- Merge latest PR16 base (bff1adc, 314575b): removes unused backend.rs
  and fixes .gitignore comment
- Use SpawnedRequestResult type alias from PR16 (includes Result wrapper)
- Add check-cloudflare alias for wasm32-unknown-unknown target check
- Add clippy-cloudflare alias to complete the per-adapter clippy pattern
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.

Cloudflare Workers entry point

3 participants