fix(kpihistory)+fix(notificationoutbox)+fix(sitecallaudit)+fix(host): P5-5 — rate-fold interval triple made self-consistent + cross-validated
Defect: the hourly KPI rollup fold (KpiHistoryRepository.FoldHourlyRollupsAsync) sums every Rate-classified sample recorded in an hour, correct only if each sample is a non-overlapping delta covering exactly one recorder tick (KpiHistoryOptions.SampleInterval). That invariant was an unenforced silent assumption across three independently-owned config keys — SampleInterval, NotificationOutboxOptions.DeliveredKpiWindow, SiteCallAuditOptions.KpiInterval — so widening DeliveredKpiWindow to e.g. 15 min would silently over-count the rollup ~15x. Robust fix: NotificationOutboxKpiSampleSource and SiteCallAuditKpiSampleSource now rescale their Rate-classified samples (deliveredLastInterval, failedLastInterval) by SampleInterval / (DeliveredKpiWindow or KpiInterval) before recording, so the rollup's per-hour Sum is correct regardless of how the other two keys are tuned — the live dashboard tile's own cutoff/window is untouched. Both sources gain a project reference to KpiHistory to read SampleInterval; no cycle (KpiHistory references only Commons). Eager cross-validation (defense-in-depth): KpiRateFoldIntervalCrossValidator (Host, the one composition root referencing all three component projects) fails boot naming all three config keys when they diverge, protecting the separate (still-real) invariant that the recorded/charted KPI-history sample equals the live tile at the same instant — which the rescale trades away whenever the scale factor isn't 1. Rides KpiHistoryOptions' existing ValidateOnStart trigger. Also: NotificationOutboxOptions had no registered validator at all before this (the gap this task's "whichever options class owns DeliveredKpiWindow" file scope pointed at) — added NotificationOutboxOptionsValidator mirroring SiteCallAuditOptionsValidator's positive-duration/count convention, wired with ValidateOnStart. Tests: new rescale tests in both sample-source suites prove the fold is numerically correct at a non-default SampleInterval (30/40 counted over a 15/20-minute window correctly divides down to a 1-minute-tick delta); new KpiRateFoldIntervalCrossValidatorTests prove divergent config fails with all three keys named; new NotificationOutboxOptionsValidatorTests. Every new test proven to fail against the unfixed computation first (temporarily short-circuited the scale factor / cross-check to the pre-fix behavior, confirmed failure, restored) — not via git stash (repo-wide, shared across concurrent worktrees this session) but via file-copy swap. Full suites green: Host.Tests (527), ConfigurationDatabase.Tests (401), KpiHistory.Tests (54), NotificationOutbox.Tests (163), SiteCallAudit.Tests (67).
This commit is contained in:
Joseph Doherty
+57
-2
@@ -5,6 +5,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Types;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Types.Kpi;
|
||||
using ZB.MOM.WW.ScadaBridge.KpiHistory;
|
||||
using ZB.MOM.WW.ScadaBridge.SiteCallAudit.Kpi;
|
||||
|
||||
namespace ZB.MOM.WW.ScadaBridge.SiteCallAudit.Tests.Kpi;
|
||||
@@ -30,9 +31,21 @@ public class SiteCallAuditKpiSampleSourceTests
|
||||
KpiInterval = kpiInterval ?? TimeSpan.FromMinutes(1),
|
||||
};
|
||||
|
||||
// Matches Options().KpiInterval (1 minute) so the default-config tests below see an
|
||||
// identity rescale factor (1.0) and their pre-existing raw-count assertions hold.
|
||||
private static readonly KpiHistoryOptions DefaultKpiHistoryOptions = new()
|
||||
{
|
||||
SampleInterval = TimeSpan.FromMinutes(1),
|
||||
};
|
||||
|
||||
private static SiteCallAuditKpiSampleSource CreateSource(
|
||||
ISiteCallAuditRepository repo, SiteCallAuditOptions? options = null) =>
|
||||
new(repo, OptionsWrap(options ?? Options()));
|
||||
ISiteCallAuditRepository repo,
|
||||
SiteCallAuditOptions? options = null,
|
||||
KpiHistoryOptions? kpiHistoryOptions = null) =>
|
||||
new(
|
||||
repo,
|
||||
OptionsWrap(options ?? Options()),
|
||||
Microsoft.Extensions.Options.Options.Create(kpiHistoryOptions ?? DefaultKpiHistoryOptions));
|
||||
|
||||
private static IOptions<SiteCallAuditOptions> OptionsWrap(SiteCallAuditOptions o) =>
|
||||
Microsoft.Extensions.Options.Options.Create(o);
|
||||
@@ -205,6 +218,48 @@ public class SiteCallAuditKpiSampleSourceTests
|
||||
Assert.Equal(3, repo.Calls.Count);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------
|
||||
// P5-5 (arch-review Low): failedLastInterval/deliveredLastInterval are rescaled onto
|
||||
// KpiHistoryOptions.SampleInterval before recording, so the central hourly rollup fold's
|
||||
// per-hour Sum stays correct regardless of how KpiInterval is tuned. Before the fix, this
|
||||
// class recorded the RAW KpiInterval-windowed counts verbatim; with a 20-minute
|
||||
// KpiInterval sampled every 1-minute SampleInterval, summing 60 overlapping 20-minute
|
||||
// counts across an hour would over-count ~20x. Proven against the unfixed computation:
|
||||
// temporarily short-circuiting IntervalScaleFactor to always return 1.0 (i.e. "record the
|
||||
// raw count verbatim", the pre-P5-5 behavior) makes this test fail (40/1 != 2/0.05);
|
||||
// restoring the real scale factor passes it.
|
||||
// ---------------------------------------------------------------------
|
||||
|
||||
[Fact]
|
||||
public async Task CollectAsync_RescalesFailedAndDeliveredLastInterval_OntoKpiHistorySampleInterval()
|
||||
{
|
||||
var repo = new StubRepo
|
||||
{
|
||||
Global = new SiteCallKpiSnapshot(
|
||||
BufferedCount: 0,
|
||||
ParkedCount: 0,
|
||||
FailedLastInterval: 1,
|
||||
DeliveredLastInterval: 40,
|
||||
OldestPendingAge: null,
|
||||
StuckCount: 0),
|
||||
};
|
||||
|
||||
// KpiInterval (20 min) is 20x KpiHistoryOptions.SampleInterval (1 min) — a
|
||||
// non-default SampleInterval configuration deliberately chosen to prove the rescale
|
||||
// math, not just the identity (factor == 1) default-config case the other tests use.
|
||||
var options = Options(kpiInterval: TimeSpan.FromMinutes(20));
|
||||
var kpiHistoryOptions = new KpiHistoryOptions { SampleInterval = TimeSpan.FromMinutes(1) };
|
||||
|
||||
var samples = await CreateSource(repo, options, kpiHistoryOptions).CollectAsync(CapturedAt);
|
||||
|
||||
// 1 failure / 40 deliveries counted over a 20-minute window, rescaled onto a
|
||||
// 1-minute recorder tick: divide by 20. Summing 60 such 1-minute-tick samples across
|
||||
// an hour therefore reconstructs the true hourly totals instead of the ~20x
|
||||
// over-count a raw (unscaled) 20-minute count would produce if simply summed 60 times.
|
||||
AssertHas(samples, "failedLastInterval", KpiScopes.Global, null, 0.05);
|
||||
AssertHas(samples, "deliveredLastInterval", KpiScopes.Global, null, 2.0);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------
|
||||
// 6. Multiple sites/nodes are all emitted with distinct ScopeKeys.
|
||||
// ---------------------------------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user