docs(SIMULATION): the never-read list names five fields the engine reads #1804

Merged
jaylouisw merged 1 commit from docs/1117-0645 into main 2026-11-17 07:02:03 +00:00
Owner

docs/SIMULATION.md �9 closes with a list of values that exist on the model and are never read. Five of the seven lines were false, and the first one was the damaging one: a reader was told that a pulled cable still carries every frame.

Claim What the engine does
Link.state is "serialised and never consulted" _deliver() resolves the crossing link and drops the frame with reason: \"link down\" and the link id (engine/simulator.js:3099); segment.js portLive() refuses to switch over a down cable. test/link-state.test.js makes 69 assertions about this, and docs/LINK-STATE.md documents it � the two pages disagreed
LAG mode is "validated, then ignored" negotiationVerdict() through memberSuspension() decides bundling: two passive ends never form one (test/lacp-passive-both-ends.test.js, 22 assertions)
voiceVlan is unread classifyEgress()/classifyIngress() carry it on a trunk outside the allowed list (engine/vlan.js:361, #1368)
iface.dhcp is unread Simulator.computeDhcp() collects every port carrying the flag as a client and applies the lease (engine/simulator.js:1172)
RA valid/preferred lifetimes are unread written into the prefix information option (engine/ra.js:210) and read back on arrival
capability dhcp-server is unread read by _capabilityRefusal() (engine/cli.js:1222) and the listener table (engine/flow.js:84)

minLinks, firewall, wireless and dhcp-client are still read by nothing, so they stay on the list; their citations now point at engine/lag.js:90 and engine/device.js:127, where the code actually is.

Docs-only: no engine change. Guards before and after: syntax-check 377 files OK, control bytes clean, docs-cli-transcript 4, docs-show-commands 7, help-completeness 8, no-form-help-key 81, help-key-works-in-every-prompt 10 � all passing; check-doc-citations still reports the same four pre-existing suspects (three of them in docs pinned to older commits) and no new one.

`docs/SIMULATION.md` �9 closes with a list of values that exist on the model and are **never read**. Five of the seven lines were false, and the first one was the damaging one: a reader was told that a pulled cable still carries every frame. | Claim | What the engine does | |---|---| | `Link.state` is "serialised and never consulted" | `_deliver()` resolves the crossing link and drops the frame with `reason: \"link down\"` and the link id (`engine/simulator.js:3099`); `segment.js` `portLive()` refuses to switch over a down cable. `test/link-state.test.js` makes 69 assertions about this, and `docs/LINK-STATE.md` documents it � the two pages disagreed | | LAG `mode` is "validated, then ignored" | `negotiationVerdict()` through `memberSuspension()` decides bundling: two `passive` ends never form one (`test/lacp-passive-both-ends.test.js`, 22 assertions) | | `voiceVlan` is unread | `classifyEgress()`/`classifyIngress()` carry it on a trunk outside the allowed list (`engine/vlan.js:361`, #1368) | | `iface.dhcp` is unread | `Simulator.computeDhcp()` collects every port carrying the flag as a client and applies the lease (`engine/simulator.js:1172`) | | RA valid/preferred lifetimes are unread | written into the prefix information option (`engine/ra.js:210`) and read back on arrival | | capability `dhcp-server` is unread | read by `_capabilityRefusal()` (`engine/cli.js:1222`) and the listener table (`engine/flow.js:84`) | `minLinks`, `firewall`, `wireless` and `dhcp-client` are still read by nothing, so they stay on the list; their citations now point at `engine/lag.js:90` and `engine/device.js:127`, where the code actually is. Docs-only: no engine change. Guards before and after: syntax-check 377 files OK, control bytes clean, docs-cli-transcript 4, docs-show-commands 7, help-completeness 8, no-form-help-key 81, help-key-works-in-every-prompt 10 � all passing; `check-doc-citations` still reports the same four pre-existing suspects (three of them in docs pinned to older commits) and no new one.
docs(SIMULATION): the never-read list names five fields the engine reads
All checks were successful
CI / Classify the change (pull_request) Successful in 11s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 14s
CI / Server smoke test (pull_request) Successful in 8s
CI / Docker build (pull_request) Successful in 24s
CI / Test (Node 20) (pull_request) Successful in 50s
CI / Test (Node 18) (pull_request) Successful in 58s
CI / Test (Node 22) (pull_request) Successful in 55s
CI / Arm auto-merge (pull_request) Successful in 5s
40083766b3
Section 9 ended with a list of values that exist on the model and are read by
nothing. Five of the seven lines were false:

* Link.state - _deliver() drops a frame crossing a down cable with
  reason 'link down' and the link id (engine/simulator.js:3099), and
  segment.js's portLive() refuses to switch across one. test/link-state.test.js
  makes 69 assertions about it, and docs/LINK-STATE.md says so in its own words.
* LAG mode - negotiationVerdict() through memberSuspension() bundles or
  suspends on it: two passive ends never form a bundle
  (test/lacp-passive-both-ends.test.js, 22 assertions).
* voiceVlan - classifyEgress()/classifyIngress() carry it on a trunk even
  outside the allowed list (engine/vlan.js:361, #1368).
* iface.dhcp - Simulator.computeDhcp() collects every port carrying the flag
  as a client and applies the lease (engine/simulator.js:1172).
* RA valid/preferred lifetimes - written into the prefix information option
  (engine/ra.js:210) and read back on arrival.

The capability line was half false too: dhcp-server is read through
_capabilityRefusal() and the listener table. minLinks, firewall, wireless and
dhcp-client remain unread, so they stay; the citation moves to the lines that
are there today.
jaylouisw force-pushed docs/1117-0645 from 40083766b3
All checks were successful
CI / Classify the change (pull_request) Successful in 11s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 14s
CI / Server smoke test (pull_request) Successful in 8s
CI / Docker build (pull_request) Successful in 24s
CI / Test (Node 20) (pull_request) Successful in 50s
CI / Test (Node 18) (pull_request) Successful in 58s
CI / Test (Node 22) (pull_request) Successful in 55s
CI / Arm auto-merge (pull_request) Successful in 5s
to e88bcc143c
All checks were successful
CI / Classify the change (pull_request) Successful in 9s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 7s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Successful in 49s
CI / Test (Node 18) (pull_request) Successful in 56s
CI / Test (Node 22) (pull_request) Successful in 53s
CI / Arm auto-merge (pull_request) Successful in 6s
2026-11-17 06:56:37 +00:00
Compare
jaylouisw force-pushed docs/1117-0645 from e88bcc143c
All checks were successful
CI / Classify the change (pull_request) Successful in 9s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 7s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Successful in 49s
CI / Test (Node 18) (pull_request) Successful in 56s
CI / Test (Node 22) (pull_request) Successful in 53s
CI / Arm auto-merge (pull_request) Successful in 6s
to e73807b985
All checks were successful
CI / Classify the change (pull_request) Successful in 8s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 6s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Successful in 44s
CI / Test (Node 18) (pull_request) Successful in 50s
CI / Test (Node 22) (pull_request) Successful in 53s
CI / Arm auto-merge (pull_request) Successful in 14s
2026-11-17 06:59:26 +00:00
Compare
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge!1804
No description provided.