Skip to content

docs(env): say that the URL variables do not move a server - #506

Merged
hyperpolymath merged 2 commits into
mainfrom
marina/cool-noether-i2rc8g
Nov 15, 2026
Merged

hyperpolymath merged 2 commits into
mainfrom
marina/cool-noether-i2rc8g

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Summary

Follow-up to echidna#505. The review on #505 found one imprecise sentence in the new row, and #505 merged before it was corrected.

The row said to set one of the two URL variables when the coprocessor router and the ML sidecar both run. That is not enough. Each variable sets only the address that the Rust client calls. It does not change the port that a server binds.

Changes

  • docs/ENV-VARS.adoc: the row for ECHIDNA_JULIA_COPROC_URL now says to start one server on another port (start_coprocessor_server(port), or the second argument of src/julia/run_server.jl), then set its variable to match.

Testing

Documentation only. Checked against src/julia/run_server.jl (the port is the second argument) and src/julia/coprocessor.jl (start_coprocessor_server takes the port). asciidoctor --failure-level=WARN on the file: clean.


Generated by Claude Code

The row for ECHIDNA_JULIA_COPROC_URL said to set one of the two URL variables when the coprocessor router and the ML sidecar both run. That is not enough: each variable sets only the address that the Rust client calls. The row now says to start one server on another port and then set its variable to match. Raised in review on the first pull request.

Checked against src/julia/run_server.jl (port is the second argument) and src/julia/coprocessor.jl (start_coprocessor_server takes the port).

Co-Authored-By: Claude <[email protected]>
Claude-Session: https://claude.ai/code/session_0136P7Zmp1i8PGVHkq3u2iNz
@hyperpolymath
hyperpolymath marked this pull request as ready for review November 15, 2026 10:41
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-15T11:44:00.451959Z 00b1e52 New commits
🔒 Security Review ✅ Completed 2026-11-15T11:44:36.358662Z 00b1e52 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@hyperpolymath
hyperpolymath enabled auto-merge (squash) November 15, 2026 10:43
Repository owner deleted a comment from coderabbitai Bot Nov 15, 2026

Copy link
Copy Markdown
Owner Author

Status of the red checks on head 4a72b14:

  • Dependency audit and rust-ci / Cargo audit (security) fail with Cargo.lock: FAILED (vulnerabilities found) and fuzz/Cargo.lock: FAILED (vulnerabilities found).
  • This PR changes one file, docs/ENV-VARS.adoc. It does not touch either lock file.
  • The same two checks failed in the same way on docs(env): document ECHIDNA_JULIA_COPROC_URL and its port clash #505 (head 9a35448), which also changed only that document. So the cause is an advisory against a dependency that is already locked on main, not this change.

I did not change a dependency here. A dependency bump in this workspace is a separate change with its own review, and a security finding stays open for the owner to decide. The merge of this PR is blocked until those two checks pass or the owner rules on them.


Generated by Claude Code

hyperpolymath added a commit that referenced this pull request Nov 15, 2026
## Summary

The daily `Cargo Audit` on `main` has failed since the 14 Nov 06:06 UTC
scan, and with it every PR's `rust-ci / Cargo audit (security)` and
`Dependency audit` jobs (for example #506, a
docs-only change). The cause is a new advisory, not any PR:
`RUSTSEC-2026-0538` (`GHSA-6pp4-4cxf-xf88`, "Receive loop can spin after
a truncated datagram") affects `quinn-udp 0.5.14`, which is pinned in
both `Cargo.lock` and `fuzz/Cargo.lock`. It is fixed in `>=0.5.16,
<0.6.0`.

## Changes

- `Cargo.lock`, `fuzz/Cargo.lock`: `cargo update -p quinn-udp --precise
0.5.16`. No other crate changes version. `windows-sys 0.60` and its
`windows_*` target crates drop out, because `quinn-udp 0.5.16` no longer
depends on them.

Not changed: `RUSTSEC-2026-0486` (`rustix 1.1.4`, unsound) is still
reported, but only as a warning, so it does not fail the gate.

## RSR Quality Checklist

### Required

- [ ] Tests pass: left to CI (see Testing)
- [x] Code is formatted: no source change
- [x] Linter is clean: no source change
- [x] No banned language patterns
- [x] No `unsafe` blocks without `// SAFETY:` comments
- [x] No banned functions
- [x] SPDX license headers present on all new/modified source files (no
source files changed)
- [x] No secrets, credentials, or `.env` files included

## Testing

- `bash scripts/ci/audit-dependencies.sh`, with `cargo-audit 0.22.2`
installed by `scripts/ci/install-cargo-audit.sh` (checksum OK):
`Cargo.lock: PASSED`, `fuzz/Cargo.lock: PASSED`, exit 0. Before the
change, both said `FAILED (vulnerabilities found)` with
`RUSTSEC-2026-0538`.
- `cargo check --locked --workspace --all-targets` could not complete in
my cloud container. The only errors are two build scripts that need
system tools the container lacks: `echidna-wire` (`capnpc build failed:
Failed to execute capnp --version: No such file or directory`) and
`echidna-grpc` (its custom build command). Neither crate is touched by
this change, and no Rust compile error was reported. The `rust-ci` build
jobs on this PR are the real build test.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

https://claude.ai/code/session_0136P7ZoZwvZCfM387TZQ5kY

Co-authored-by: Claude <[email protected]>
@coderabbitai

coderabbitai Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Clarified that the default ports for the coprocess and ML API servers match, so both servers cannot use the default port at the same time.
    • Explained that each environment variable sets the destination used by its corresponding client, rather than the server’s listening port.
    • Added guidance for running both servers: configure one to use a different port and set the matching environment variable accordingly.

The ECHIDNA_JULIA_COPROC_URL documentation now explains that the URL variables configure Rust client destinations, not server listening ports. It describes how to run both servers on different ports and configure the matching variable.

Changes: Environment variable documentation

Layer / File(s) Summary
Client destinations and port configuration
docs/ENV-VARS.adoc
The documentation distinguishes client destination URLs from server listening ports. It explains how to run one server on a different port and set the matching variable. It retains the notes about the bridge and router.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Possibly related PRs

Merge Risk: Minimal · up to 00b1e

This is a documentation-only clarification of how the URL variables relate to server ports. It has no runtime impact and is ready to merge, subject to the owner's decision on the unrelated dependency audit failures.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title describes the main change: the docs for the URL variables now state that they do not move a server. It matches the summary, which says the variables set only the Rust client's destination an…
Description check Passed The description has a clear summary that explains the imprecise sentence it corrects and links the follow-up to echidna#505. The Changes section names the file and the new guidance. The Testing sectio…
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.
Full details: Title check

Explanation

The title describes the main change: the docs for the URL variables now state that they do not move a server. It matches the summary, which says the variables set only the Rust client's destination and do not change the port a server binds. It uses the docs(env) convention and is specific.

Full details: Description check

Explanation

The description has a clear summary that explains the imprecise sentence it corrects and links the follow-up to echidna#505. The Changes section names the file and the new guidance. The Testing section describes the checks against the Julia source files and the asciidoctor run. The template's RSR Quality Checklist and Screenshots sections are absent. The Required checklist items are not ticked, and the Summary does not state a closing reference. The description is mostly complete, so the check passes. The author should tick applicable checklist items or note why they do not apply, and should confirm that the SPDX and documentation items are satisfied.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: e946a6d8-48df-43cb-a97a-43f4f5fc560c
Commits

Reviewing files that changed from the base of the PR and between a41ed06 and 00b1e52.

Files selected for processing: 1

  • docs/ENV-VARS.adoc

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Recent review details

Context from checks skipped due to timeout: 20

  • GitHub Check: governance / Validate Hypatia Baseline
  • GitHub Check: CodeRabbit
  • GitHub Check: rust-ci / Cargo check + clippy + fmt
  • GitHub Check: rust-ci / llvm-cov line coverage
  • GitHub Check: governance / JS runtimes — environment provisions Bun first
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: T1 / cvc5
  • GitHub Check: T1 / alt-ergo
  • GitHub Check: T1 / z3
  • GitHub Check: T1 / glpk
  • GitHub Check: T1 / vampire
  • GitHub Check: T1 / chuffed
  • GitHub Check: T1 / spass
  • GitHub Check: T1 / minizinc
  • GitHub Check: T1 / eprover
  • GitHub Check: MVP Smoke
  • GitHub Check: Proof safety regressions
  • GitHub Check: PR (address)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: panic-attack assail
Additional context used

Code guidelines: 1

CLAUDE.md — auto-discovered
Path-based instructions: 1

Source excerpt: **Version + release history**: [`CHANGELOG.adoc`](CHANGELOG.adoc) (single source of truth; do not duplicate version strings elsewhere)

CodeRabbit inference engine (CLAUDE.md)

Files:

  • docs/ENV-VARS.adoc
Additional comments: 1

docs/ENV-VARS.adoc: 1

37-38: Functional Correctness

The concern depends on a recipe that starts start_coprocessor_server. Repository-wide search finds no such recipe. The only router-start definition is src/julia/coprocessor.jl:144, and no recipe or other inspected file calls it. The statement that no recipe starts the router is therefore not contradicted by the inspected source. The comment identifies no defect, and no concrete consequence follows from the documentation.

@sonarqubecloud

Copy link
Copy Markdown

@hyperpolymath
hyperpolymath merged commit 478b751 into main Nov 15, 2026
71 checks passed
@hyperpolymath
hyperpolymath deleted the marina/cool-noether-i2rc8g branch November 15, 2026 11:47
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.

3 participants