Skip to content

test(relay): say host, not burrow, where config means a hostname - #596

Draft
dormouse-bot wants to merge 1 commit into
mainfrom
docs/relay-config-test-host-wording
Draft

test(relay): say host, not burrow, where config means a hostname#596
dormouse-bot wants to merge 1 commit into
mainfrom
docs/relay-config-test-host-wording

Conversation

@dormouse-bot

Copy link
Copy Markdown
Collaborator

Two spots in relay/test/config.test.mjs say "burrow" where they mean a hostname, which reads as fallout from the Host→Burrow rename applying to prose it should not have. AGENTS.md reserves the two words in opposite directions — "Host is reserved for the platform host, the Host header, hostnames, and self-hosting" — so the current text says the wrong one of the pair.

  • The test named a blank DORMOUSE_BIND_HOST is treated as unset, not as an empty burrow is about the listen interface. A blank value is not "an empty burrow"; it is an empty host.
  • The comment on DORMOUSE_ORIGIN is normalized to a bare origin says "a trailing slash, a path, or a capitalized burrow" about the case that lowercases https://Dor.Example.TS.NET/. That is the origin's hostname, not a Burrow.

Both are one-word edits; no assertion, input, or expectation changes. The surrounding uses of "Burrow" in the same file are correct and are left alone (the /#pair?… QR a Burrow composes).

No regression test: this changes only a test name and a comment, so there is nothing behavioural to pin. node --check passes on the file and the two assertions it labels are untouched.

Why this is worth fixing rather than leaving

docs/specs/security-remote.md → "Credentials at rest" carries a FAIL IF about "a credential the Host→Burrow rename retired", so the rename is recent enough that its over-applications are still findable. The test name in particular is what a reader sees in failure output, and "an empty burrow" points at the wrong subsystem entirely — DORMOUSE_BIND_HOST is the Relay's listen interface and has nothing to do with a Burrow.

I searched the rest of the tree for the same shape (empty|capitalized|bare|local|target|upstream burrow, burrowname, burrow header, localburrow) and these two are the only hits; every other "Burrow" reads correctly as the role.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 8, 2026

Copy link
Copy Markdown

Deploying mouseterm with  Cloudflare Pages  Cloudflare Pages

Latest commit: dde48fa
Status: ✅  Deploy successful!
Preview URL: https://ad4bbb5e.mouseterm.pages.dev
Branch Preview URL: https://docs-relay-config-test-host.mouseterm.pages.dev

View logs

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.

1 participant