Files
ScadaBridge/code-reviews
Joseph Doherty 4307c38117 docs(code-review): record SMS-feature review findings + reconcile NotificationService doc
Per-module code review of the SMS notifications feature (reviewed at d6ead8ae) following
code-reviews/REVIEW-PROCESS.md. 19 findings across 7 modules — 1 High, 5 Medium, 13 Low:

- ManagementService-024 (High): provider-config updates Admin-gated to match the UI.
- ConfigurationDatabase-025, CentralUI-034/035, ManagementService-025 (Medium): migration
  data-safety guard, type-aware recipient badge, FromNumber-optional (Messaging-Service-only),
  empty-token-clear guard.
- Remaining Low: secret-encryption + diff + dispatch + factory + contract tests, truncation,
  ctor guard, reserved retry-field docs.
- Won't Fix: Transport-015/016 (shared repo-wide import patterns, not SMS-specific),
  Commons-026 (breaking ergonomics-only change). Deferred: ConfigurationDatabase-027 (live-SQL
  migration test).

All findings closed (0 pending). README.md regenerated; Component-NotificationService.md
updated for the FromNumber-optional + reserved-retry-fields outcomes.
2026-06-19 15:30:32 -04:00
..

Code Reviews

Comprehensive, per-module code reviews of the ScadaBridge codebase. Each module (one buildable project under src/) has its own folder containing a findings.md. This README is the aggregated index — the single place to see all outstanding work.

Generated by regen-readme.py from the per-module findings.md files. Do not edit by hand — edit the findings files and re-run the script.

How it works

  • Reviews are performed one module at a time against a fixed checklist.
  • Every finding is recorded in the module's findings.md with a severity and status.
  • Findings are never deleted — they are closed by changing their status, keeping a full audit trail.
  • This README aggregates every pending finding (Open / In Progress) across all modules.

See REVIEW-PROCESS.md for the full procedure: the review checklist, severity definitions, finding format, and how to mark items resolved.

Layout

code-reviews/
├── README.md            # this file — process overview + pending findings
├── REVIEW-PROCESS.md     # how to perform a review and track findings
├── regen-readme.py       # regenerates this README from the findings files
├── _template/findings.md # copy-this template for a module review
└── <Module>/findings.md  # one folder per src/ project

Baseline review — 2026-05-16

All 19 modules were reviewed at commit 9c60592 (241 findings: 6 Critical, 46 High, 100 Medium, 89 Low). The tables below track what remains open as findings are resolved and re-triaged; findings discovered after the baseline are appended to their module file and counted in Total.

Severity Open findings
Critical 0
High 0
Medium 0
Low 0
Total 0

Module Status

Module Last reviewed Commit Open (C/H/M/L) Open Total
AuditLog 2026-05-28 1eb6e97 0/0/0/0 0 11
CLI 2026-06-19 d6ead8ae 0/0/0/0 0 24
CentralUI 2026-06-19 d6ead8ae 0/0/0/0 0 36
ClusterInfrastructure 2026-05-28 1eb6e97 0/0/0/0 0 14
Commons 2026-06-19 d6ead8ae 0/0/0/0 0 26
Communication 2026-05-28 1eb6e97 0/0/0/0 0 22
ConfigurationDatabase 2026-06-19 d6ead8ae 0/0/0/0 0 27
DataConnectionLayer 2026-05-28 1eb6e97 0/0/0/0 0 22
DeploymentManager 2026-05-28 1eb6e97 0/0/0/0 0 24
ExternalSystemGateway 2026-05-28 1eb6e97 0/0/0/0 0 23
HealthMonitoring 2026-05-28 1eb6e97 0/0/0/0 0 23
Host 2026-05-28 1eb6e97 0/0/0/0 0 22
InboundAPI 2026-05-28 1eb6e97 0/0/0/0 0 25
ManagementService 2026-06-19 d6ead8ae 0/0/0/0 0 26
NotificationOutbox 2026-06-19 d6ead8ae 0/0/0/0 0 13
NotificationService 2026-05-28 1eb6e97 0/0/0/0 0 25
Security 2026-05-28 1eb6e97 0/0/0/0 0 21
SiteCallAudit 2026-05-28 1eb6e97 0/0/0/0 0 6
SiteEventLogging 2026-05-28 1eb6e97 0/0/0/0 0 23
SiteRuntime 2026-05-28 1eb6e97 0/0/0/0 0 26
StoreAndForward 2026-05-28 1eb6e97 0/0/0/0 0 24
TemplateEngine 2026-05-28 1eb6e97 0/0/0/0 0 22
Transport 2026-06-19 d6ead8ae 0/0/0/0 0 15

Pending Findings

Every Open / In Progress finding across all modules, highest severity first. Resolved findings drop off this list but remain recorded in their module's findings.md (see REVIEW-PROCESS.md §4–§5). Full detail — description, location, recommendation — lives in the module's findings.md.

Critical (0)

None open.

High (0)

None open.

Medium (0)

None open.

Low (0)

None open.