wwtools

dohertj2/wwtools

Fork 0

Commit Graph

Author	SHA1	Message	Date
Joseph Doherty	b222362ce0	mbproxy: remediate the 2026-05-16 code-review findings Fixes every finding from the codereviews/2026-05-16 multi-agent review (2 Critical, 20 Major, 38 Minor) and adds that review to the repo. Highlights: dashboard XSS escape; response cache invalidated on the write request (not just the response); ReloadValidator now runs at startup so port collisions / duplicate names / malformed Resilience profiles fail fast; AdminPort 0 genuinely disables the admin endpoint; PlcListener accept-loop faults propagate to the supervisor's faulted path; reconciler Restart builds before removing; Resilience pipelines are restart-only from a frozen snapshot; multiplexer connect-race leak, watchdog party-list snapshot, backend-response and FC16 framing validation; frontend reconnect retry and util.js load guard; plus the log-event/doc drift sweep and test-port hygiene. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>	2026-05-16 18:08:06 -04:00
Joseph Doherty	7466a46aa7	mbproxy/docs: retire superseded design/plan docs and dissolve DL260/ The standalone design.md, kpi.md, operations.md, and the docs/plan/ phase tree were point-in-time planning artefacts now superseded by the topic-organized docs/ tree (Architecture/, Features/, Operations/, Reference/, Testing/). The DL260/ folder mixed a device-reference doc, a test fixture, a sample test, and a screenshot; its contents now live in their natural homes (dl205.md + mbtcp_settings.JPG under docs/Reference/, dl205.json next to its launcher in tests/sim/, sample test dropped). All cross-references in the surviving docs, README, CLAUDE.md, the config template, and source comments are repointed to the new locations. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>	2026-05-15 07:37:48 -04:00
Joseph Doherty	f49e27e316	mbproxy/docs: split deep docs into focused PascalCase files per StyleGuide Adds 11 topic-focused docs under docs/{Architecture,Features,Operations,Reference,Testing}/ and links them from README.md's new "Detailed documentation" section. Existing top-level docs (design.md, kpi.md, operations.md) remain as canonical landings. Architecture/ - Overview.md (150 lines) — listener topology, request flow, per-PLC isolation - ConnectionModel.md (247 lines) — TxId multiplexer, watchdog, disconnect cascade - ReadCoalescing.md (243 lines) — in-flight FC03/04 dedup via InFlightByKeyMap - ResponseCache.md (398 lines) — opt-in per-tag TTL cache + range-overlap invalidation Features/ - BcdRewriting.md (252 lines) — codec, CDAB, FC scope, partial-overlap policy - HotReload.md (189 lines) — IOptionsMonitor + per-change-kind reconcile rules Operations/ - Configuration.md (422 lines) — every Mbproxy:* option + validation rules - StatusPage.md (334 lines) — admin endpoint surface, every JSON field - Troubleshooting.md (364 lines) — diagnosis playbook keyed to log events Reference/ - LogEvents.md (499 lines) — 28 events across 7 categories, grep-verified Testing/ - Simulator.md (235 lines) — pymodbus fixture, skip policy, 3.13 framer quirk Each doc was written by a dedicated agent against the StyleGuide.md rules with a per-doc phase gate (PascalCase filename, H1 Title Case, code-fence language tags, Related Documentation section with >=3 relative links, real type names verified against src/). Cross-references between docs use relative paths; all 18 README->docs links and all sibling links resolve. Known follow-up: docs/design.md lines 215-251 are stale on two log-event property templates (config.reload.applied and config.reload.rejected) and mention LogContext.PushProperty scoping that isn't actually used. Reference/ LogEvents.md is now the authoritative event catalog and source-of-truth. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>	2026-05-14 03:44:34 -04:00

Author

SHA1

Message

Date

Joseph Doherty

b222362ce0

mbproxy: remediate the 2026-05-16 code-review findings

Fixes every finding from the codereviews/2026-05-16 multi-agent review
(2 Critical, 20 Major, 38 Minor) and adds that review to the repo.

Highlights: dashboard XSS escape; response cache invalidated on the
write request (not just the response); ReloadValidator now runs at
startup so port collisions / duplicate names / malformed Resilience
profiles fail fast; AdminPort 0 genuinely disables the admin endpoint;
PlcListener accept-loop faults propagate to the supervisor's faulted
path; reconciler Restart builds before removing; Resilience pipelines
are restart-only from a frozen snapshot; multiplexer connect-race leak,
watchdog party-list snapshot, backend-response and FC16 framing
validation; frontend reconnect retry and util.js load guard; plus the
log-event/doc drift sweep and test-port hygiene.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-16 18:08:06 -04:00

Joseph Doherty

7466a46aa7

mbproxy/docs: retire superseded design/plan docs and dissolve DL260/

The standalone design.md, kpi.md, operations.md, and the docs/plan/
phase tree were point-in-time planning artefacts now superseded by the
topic-organized docs/ tree (Architecture/, Features/, Operations/,
Reference/, Testing/). The DL260/ folder mixed a device-reference doc, a
test fixture, a sample test, and a screenshot; its contents now live in
their natural homes (dl205.md + mbtcp_settings.JPG under docs/Reference/,
dl205.json next to its launcher in tests/sim/, sample test dropped).

All cross-references in the surviving docs, README, CLAUDE.md, the config
template, and source comments are repointed to the new locations.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-15 07:37:48 -04:00

Joseph Doherty

f49e27e316

mbproxy/docs: split deep docs into focused PascalCase files per StyleGuide

Adds 11 topic-focused docs under docs/{Architecture,Features,Operations,Reference,Testing}/
and links them from README.md's new "Detailed documentation" section. Existing
top-level docs (design.md, kpi.md, operations.md) remain as canonical landings.

Architecture/
  - Overview.md         (150 lines) — listener topology, request flow, per-PLC isolation
  - ConnectionModel.md  (247 lines) — TxId multiplexer, watchdog, disconnect cascade
  - ReadCoalescing.md   (243 lines) — in-flight FC03/04 dedup via InFlightByKeyMap
  - ResponseCache.md    (398 lines) — opt-in per-tag TTL cache + range-overlap invalidation

Features/
  - BcdRewriting.md     (252 lines) — codec, CDAB, FC scope, partial-overlap policy
  - HotReload.md        (189 lines) — IOptionsMonitor + per-change-kind reconcile rules

Operations/
  - Configuration.md    (422 lines) — every Mbproxy:* option + validation rules
  - StatusPage.md       (334 lines) — admin endpoint surface, every JSON field
  - Troubleshooting.md  (364 lines) — diagnosis playbook keyed to log events

Reference/
  - LogEvents.md        (499 lines) — 28 events across 7 categories, grep-verified

Testing/
  - Simulator.md        (235 lines) — pymodbus fixture, skip policy, 3.13 framer quirk

Each doc was written by a dedicated agent against the StyleGuide.md rules with
a per-doc phase gate (PascalCase filename, H1 Title Case, code-fence language
tags, Related Documentation section with >=3 relative links, real type names
verified against src/). Cross-references between docs use relative paths;
all 18 README->docs links and all sibling links resolve.

Known follow-up: docs/design.md lines 215-251 are stale on two log-event
property templates (config.reload.applied and config.reload.rejected) and
mention LogContext.PushProperty scoping that isn't actually used. Reference/
LogEvents.md is now the authoritative event catalog and source-of-truth.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-14 03:44:34 -04:00

3 Commits