# 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.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](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 └── /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 | 2 | | Medium | 5 | | Low | 10 | | **Total** | **17** | ## Module Status | Module | Last reviewed | Commit | Open (C/H/M/L) | Open | Total | |--------|---------------|--------|----------------|------|-------| | [CLI](CLI/findings.md) | 2026-05-16 | `9c60592` | 0/0/1/2 | 3 | 16 | | [CentralUI](CentralUI/findings.md) | 2026-05-16 | `9c60592` | 0/1/2/3 | 6 | 25 | | [ClusterInfrastructure](ClusterInfrastructure/findings.md) | 2026-05-16 | `9c60592` | 0/0/1/1 | 2 | 10 | | [Commons](Commons/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/2 | 2 | 14 | | [Communication](Communication/findings.md) | 2026-05-16 | `9c60592` | 0/1/1/2 | 4 | 15 | | [ConfigurationDatabase](ConfigurationDatabase/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 11 | | [DataConnectionLayer](DataConnectionLayer/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 13 | | [DeploymentManager](DeploymentManager/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 14 | | [ExternalSystemGateway](ExternalSystemGateway/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 14 | | [HealthMonitoring](HealthMonitoring/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 12 | | [Host](Host/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 11 | | [InboundAPI](InboundAPI/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 13 | | [ManagementService](ManagementService/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 13 | | [NotificationService](NotificationService/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 13 | | [Security](Security/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 11 | | [SiteEventLogging](SiteEventLogging/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 11 | | [SiteRuntime](SiteRuntime/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 16 | | [StoreAndForward](StoreAndForward/findings.md) | 2026-05-16 | `9c60592` | 0/0/0/0 | 0 | 14 | | [TemplateEngine](TemplateEngine/findings.md) | 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](REVIEW-PROCESS.md) §4–§5). Full detail — description, location, recommendation — lives in the module's `findings.md`. ### Critical (0) _None open._ ### High (2) | ID | Module | Title | |----|--------|-------| | CentralUI-020 | [CentralUI](CentralUI/findings.md) | Idle-session redirect never fires: `SessionExpiry` polls a frozen auth-state snapshot | | Communication-012 | [Communication](Communication/findings.md) | gRPC client factory ignores the endpoint on a cache hit, breaking NodeA→NodeB stream failover | ### Medium (5) | ID | Module | Title | |----|--------|-------| | CLI-014 | [CLI](CLI/findings.md) | `update` commands require "core" fields, making partial updates impossible | | CentralUI-021 | [CentralUI](CentralUI/findings.md) | `DebugView` stream callback mutates `Dictionary` off the render thread | | CentralUI-022 | [CentralUI](CentralUI/findings.md) | `Deployments` push handler fires `InvokeAsync` with no disposal guard | | ClusterInfrastructure-009 | [ClusterInfrastructure](ClusterInfrastructure/findings.md) | `DownIfAlone` is an inert configuration knob — never consumed by the HOCON builder | | Communication-013 | [Communication](Communication/findings.md) | Site gRPC address changes are never applied; `RemoveSiteAsync` has no production caller | ### Low (10) | ID | Module | Title | |----|--------|-------| | CLI-015 | [CLI](CLI/findings.md) | `Component-CLI.md` command surface has drifted again in two places | | CLI-016 | [CLI](CLI/findings.md) | `WriteAsTable` derives columns from the first array element only | | CentralUI-023 | [CentralUI](CentralUI/findings.md) | Residual bare `catch {}` blocks swallow JS interop errors | | CentralUI-024 | [CentralUI](CentralUI/findings.md) | Claim lookups use magic strings instead of `JwtTokenService` constants | | CentralUI-025 | [CentralUI](CentralUI/findings.md) | `SessionExpiry` polling/redirect path has no test coverage | | ClusterInfrastructure-010 | [ClusterInfrastructure](ClusterInfrastructure/findings.md) | Validator does not enforce `DownIfAlone = true` despite the design doc requiring it | | Commons-013 | [Commons](Commons/findings.md) | `DynamicJsonElement.TryGetIndex` rejects non-`int` index values | | Commons-014 | [Commons](Commons/findings.md) | `OpcUaEndpointConfigSerializer.Deserialize` can mislabel a corrupt typed row as `Legacy` | | Communication-014 | [Communication](Communication/findings.md) | Untrusted gRPC `correlation_id` flows directly into an Akka actor name | | Communication-015 | [Communication](Communication/findings.md) | No test exercises the real gRPC client factory across a node flip |