Files

T

Joseph Doherty 55f46e7c92 perf: close Theme 6 — 11 allocation / N+1 / lock-contention findings

Well-localised perf fixes across 8 modules.

Lock decoupling / SQL streaming:
- AuditLog-005: SqliteAuditWriter gains dedicated read-only _readConnection
  (+ _readLock) backed by WAL journal mode. GetBacklogStatsAsync,
  ReadPendingAsync, ReadPendingSinceAsync, ReadForwardedAsync no longer
  contend with the hot-path INSERT lock — backlog probes on a 30s timer
  can't stall the writer under multi-hundred-K Pending backlog.
- SEL-022: dropped Cache=Shared from SiteEventLogger's default connection
  string (single-connection logger; mode was dormant config).

Memory / streaming:
- CLI-019: bundle export streams base64 in 1 MB-aligned chunks via
  Convert.TryFromBase64Chars straight into the FileStream — no more
  full-bundle byte[] allocation.
- CentralUI-031: TransportImport now stages the upload to a per-session
  temp file under Path.GetTempPath() (replaces in-memory byte[] field);
  page implements IDisposable to delete the temp file on reset / new
  upload / dispose. Per-circuit working set drops from ~100 MB to ~80 KB.

N+1 hoisting:
- Transport-008: added ITemplateEngineRepository.GetTemplatesWithChildrenAsync
  bulk method; BundleImporter.PreviewAsync calls it once instead of per-
  template-name. Single query with .Include(...).AsSplitQuery().
- DM-023: BuildDeployArtifactsCommandAsync's per-site loop now references
  a pre-fetched GlobalArtifactSnapshot (shared scripts, external systems,
  DB connections, notification lists, SMTP) instead of re-querying per site.
- MgmtSvc-023: HandleQueryDeployments unfiltered branch uses one
  GetAllInstancesAsync bulk load + Dictionary<int,int?> lookup (was a
  GetInstanceByIdAsync per record).

Small allocations / per-tick rebuilds:
- InboundAPI-019: AuditWriteMiddleware gates EnableBuffering() on
  RequestHasBody() so GET/HEAD/DELETE/TRACE/OPTIONS and Content-Length:0
  requests skip the FileBufferingReadStream allocation.
- NotifOutbox-006: ResolveAdapters dictionary now cached on
  _adaptersCache (built lazily on first sweep) + actor-lifetime
  _adaptersScope; ResolveAdapters no longer rebuilds per dispatch tick.

Verify-only:
- Comm-017: Confirmed _inProgressDeployments was deleted by Comm-016 in
  commit ac96b83 — marked Resolved with that attribution. No code change.

Doc-correction:
- NS-022: Updated MailKitSmtpClientWrapper XML doc to spell out single-
  connection / per-delivery-factory contract (option (b) — transient
  client per Send — rejected because it re-handshakes TLS per email).

10+ new regression tests across 8 test projects. Build clean; affected
suites all green. README regenerated: 54 open (was 65).

2026-05-28 07:47:24 -04:00

13 KiB

Raw Blame History

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 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	19
Low	35
Total	54

Module Status

Module	Last reviewed	Commit	Open (C/H/M/L)	Open	Total
AuditLog	2026-05-28	`1eb6e97`	0/0/1/1	2	11
CLI	2026-05-28	`1eb6e97`	0/0/0/2	2	23
CentralUI	2026-05-28	`1eb6e97`	0/0/0/3	3	33
ClusterInfrastructure	2026-05-28	`1eb6e97`	0/0/0/3	3	14
Commons	2026-05-28	`1eb6e97`	0/0/0/4	4	23
Communication	2026-05-28	`1eb6e97`	0/0/0/1	1	22
ConfigurationDatabase	2026-05-28	`1eb6e97`	0/0/1/2	3	24
DataConnectionLayer	2026-05-28	`1eb6e97`	0/0/0/0	0	22
DeploymentManager	2026-05-28	`1eb6e97`	0/0/0/3	3	24
ExternalSystemGateway	2026-05-28	`1eb6e97`	0/0/1/1	2	23
HealthMonitoring	2026-05-28	`1eb6e97`	0/0/0/2	2	23
Host	2026-05-28	`1eb6e97`	0/0/1/3	4	22
InboundAPI	2026-05-28	`1eb6e97`	0/0/1/1	2	25
ManagementService	2026-05-28	`1eb6e97`	0/0/2/0	2	23
NotificationOutbox	2026-05-28	`1eb6e97`	0/0/0/1	1	10
NotificationService	2026-05-28	`1eb6e97`	0/0/1/1	2	25
Security	2026-05-28	`1eb6e97`	0/0/0/1	1	21
SiteCallAudit	2026-05-28	`1eb6e97`	0/0/2/1	3	6
SiteEventLogging	2026-05-28	`1eb6e97`	0/0/0/2	2	23
SiteRuntime	2026-05-28	`1eb6e97`	0/0/2/0	2	26
StoreAndForward	2026-05-28	`1eb6e97`	0/0/3/2	5	24
TemplateEngine	2026-05-28	`1eb6e97`	0/0/3/0	3	22
Transport	2026-05-28	`1eb6e97`	0/0/1/1	2	12

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)