Joseph Doherty
ad4744a295
Flip DataConnectionLayer-029, InboundAPI-031, SiteRuntime-032/033, StoreAndForward-028, AuditLog-017, CentralUI-037, ScriptAnalysis-009 from Open to Resolved with the fixing commit + a one-line resolution each; regen README (0 pending / 576 total across 25 modules).
4.7 KiB
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.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 | 0 |
| Low | 0 |
| Total | 0 |
Module Status
| Module | Last reviewed | Commit | Open (C/H/M/L) | Open | Total |
|---|---|---|---|---|---|
| AuditLog | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 17 |
| CLI | 2026-06-19 | d6ead8ae |
0/0/0/0 | 0 | 24 |
| CentralUI | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 37 |
| ClusterInfrastructure | 2026-06-20 | 4307c381 |
0/0/0/0 | 0 | 15 |
| Commons | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 26 |
| Communication | 2026-06-20 | 4307c381 |
0/0/0/0 | 0 | 24 |
| ConfigurationDatabase | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 27 |
| DataConnectionLayer | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 27 |
| DeploymentManager | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 27 |
| ExternalSystemGateway | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 26 |
| HealthMonitoring | 2026-06-20 | 4307c381 |
0/0/0/0 | 0 | 25 |
| Host | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 26 |
| InboundAPI | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 31 |
| KpiHistory | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 6 |
| ManagementService | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 26 |
| NotificationOutbox | 2026-06-19 | d6ead8ae |
0/0/0/0 | 0 | 13 |
| NotificationService | 2026-06-20 | 4307c381 |
0/0/0/0 | 0 | 28 |
| ScriptAnalysis | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 9 |
| Security | 2026-06-20 | 4307c381 |
0/0/0/0 | 0 | 25 |
| SiteCallAudit | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 9 |
| SiteEventLogging | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 27 |
| SiteRuntime | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 33 |
| StoreAndForward | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 28 |
| TemplateEngine | 2026-06-24 | 1f9de8a2 |
0/0/0/0 | 0 | 25 |
| 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.