5.2 KiB
Code Reviews
Comprehensive, per-module code reviews of the ScadaLink 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.pyfrom the per-modulefindings.mdfiles. 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.mdwith 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 | 4 |
| Low | 4 |
| Total | 8 |
Module Status
| Module | Last reviewed | Commit | Open (C/H/M/L) | Open | Total |
|---|---|---|---|---|---|
| CLI | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 13 |
| CentralUI | 2026-05-16 | 9c60592 |
0/0/2/0 | 2 | 19 |
| ClusterInfrastructure | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 8 |
| Commons | 2026-05-16 | 9c60592 |
0/0/0/1 | 1 | 12 |
| Communication | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 11 |
| ConfigurationDatabase | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 11 |
| DataConnectionLayer | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 13 |
| DeploymentManager | 2026-05-16 | 9c60592 |
0/0/0/1 | 1 | 14 |
| ExternalSystemGateway | 2026-05-16 | 9c60592 |
0/0/0/1 | 1 | 14 |
| HealthMonitoring | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 12 |
| Host | 2026-05-16 | 9c60592 |
0/0/1/0 | 1 | 11 |
| InboundAPI | 2026-05-16 | 9c60592 |
0/0/1/1 | 2 | 13 |
| ManagementService | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 13 |
| NotificationService | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 13 |
| Security | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 11 |
| SiteEventLogging | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 11 |
| SiteRuntime | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 16 |
| StoreAndForward | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 14 |
| TemplateEngine | 2026-05-16 | 9c60592 |
0/0/0/0 | 0 | 14 |
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 (4)
| ID | Module | Title |
|---|---|---|
| CentralUI-005 | CentralUI | Session expiry implementation diverges from the documented policy |
| CentralUI-006 | CentralUI | Deployment status page polls every 10s despite the documented SignalR-push design |
| Host-002 | Host | Akka.Persistence required by REQ-HOST-6 is not configured and not used |
| InboundAPI-007 | InboundAPI | Database.Connection() script API from the design doc is not implemented |
Low (4)
| ID | Module | Title |
|---|---|---|
| Commons-008 | Commons | SetConnectionBindingsCommand uses ValueTuple in a wire message contract |
| DeploymentManager-013 | DeploymentManager | SMTP credentials serialized and broadcast to all sites |
| ExternalSystemGateway-011 | ExternalSystemGateway | Every call performs a full repository scan of all systems and methods |
| InboundAPI-012 | InboundAPI | ParameterDefinition POCO declared in the component project, not Commons |