Analysis: one selected period, one set of numbers, on every page
ci / build-test (push) Successful in 2m31s
ci / build-test (push) Successful in 2m31s
The dashboards told several stories at once. Overview asked for full calendar years, meter detail for a fixed 12-month window that was really 13, Trends for 24 months with an Apply button, and the energy pages for 60. Each page derived "today" from UTC, so the first hours of a local day belonged to yesterday. A missing tariff, a month nobody measured and a genuine zero all rendered as 0. And a virtual meter -- the one thing the spreadsheet leans on hardest -- was excluded from analysis outright: MeterPeriodService returned null for it and the page offered a flow diagram instead. docs/DASHBOARD_ANALYSIS_CHANGE_BRIEF.md is the work order. Every choice it left open is settled in docs/ANALYSIS_IMPLEMENTATION_NOTE.md as D-01..D-58 plus amendments A-01..A-30; code, tests and release notes cite those ids. The analysis layer Core/Analysis holds the pure rules: period presets resolved once in the instance zone into a local date range and a half-open UTC range, bucket plans, calendar-unit comparisons, coverage runs with a resolution class, normalized quantities and units, the totals policy, the virtual formula parser/validator/evaluator, and the cost calculator. "Now" comes from TimeProvider; services never read the clock. Normalization now writes, in the same transaction as consumption and by diff, per-meter rollups by local day and month plus coverage runs and a rollup state (AnalysisDataWriter). AnalysisReader answers a request from those tables -- month rollups for month and year buckets, day rollups otherwise, at most two partial edge days from consumption -- and CostReader prices the result month by month. Pages, /api/v1 and the CSV export read nothing else. The unused continuous aggregates are dropped. The reader's statement count per request is constant whether it covers one meter or a thousand. On a synthetic 1,000-meter, ten-year instance the brief's target request (100 meters, ten years, monthly) takes 374 ms against a two-second target, and the Overview went from 48,244 SQL statements per load to 205. Missing is not zero Every bucket carries a status -- available, partial, missing, unresolved, invalid, pending -- derived from coverage, never from the amount, with provenance and a reason code beside it. A true zero is a number and a bar on the baseline; an unknown bucket is a gap that says why; a month whose data only exists monthly says so instead of inventing daily detail; a scope with no tariff says "not priced" instead of 0. Rows whose interval closes after now are reported separately rather than counted. Virtual meters are analysis subjects A virtual meter stores a canonical definition -- expression over m<id> references, result kind, unit and cost rule -- validated on save and on read for syntax, unknown or self references, loops and unit/kind rules. It is evaluated on read from its sources' rollups over their joint coverage: a missing source makes the bucket missing, an observed zero is a valid input, a non-finite result is invalid with its dependency path, and the page lists each source's contribution. Topology links are topology only and never rewrite a saved calculation; expression-less meters from older installs are converted once at startup. The editor has Sum, Difference and Advanced modes with a live preview. Totals and the bill Per energy type the totals policy separates use, grid import, export, generation and runtime, marks breakdown meters as breakdowns and virtual meters as views, and never adds across units. The bill follows it: grid import where there is one, separately priced subsections at their own price, feed-in only on export meters, standing charges once per scope per local day, manual costs once on their start day, categories as non-overlapping covers whose composition reconciles to the bill. The seeded demo's yearly totals now match the spreadsheet. Pages and navigation The period lives in the URL and every page reads the same contract, so a link, a reload and the browser's Back button keep it. Shared components carry it: page header with breadcrumbs, period toolbar, theme-aware chart with an accessible table beside it, metric cards, comparison and availability states, attention items that each link to the one action that fixes them. Meter detail leads with an Analysis tab and resolves its tabs by key; the energy page has Overview, History, Flow and Meters; the old cost-only Trends page is a general Analysis page over portfolio, type, category, meter or a meter comparison. Records tabs are paged server-side instead of showing the latest 200. Everything is English and German, light and dark, down to 360px. Some figures change on purpose; docs/RELEASE_NOTES.md lists each one and what the first start after the update does (it rebuilds all analysis data before the web server listens). docs/SDD.md and CLAUDE.md describe the system as it now is. Tests: 1,733 Core and 746 integration, all green, plus an opt-in performance suite with a synthetic 1,000-meter generator.
This commit is contained in:
@@ -0,0 +1,187 @@
|
||||
using MeterVault.Core.Analysis;
|
||||
using MeterVault.Core.Analysis.Rollups;
|
||||
using MeterVault.Core.Domain;
|
||||
|
||||
namespace MeterVault.Infrastructure.Persistence.Analysis;
|
||||
|
||||
// The analysis tables (D-12). All four are derived: RecomputeMeterAsync writes them from the same engine
|
||||
// output it stores as consumption, in the caller's transaction, by diff. They are plain tables — not
|
||||
// hypertables — each keyed by meter first, with an FK to meter that cascades, so deleting a meter (or
|
||||
// wiping all of them) never trips over them.
|
||||
|
||||
/// <summary>The columns a day and a month rollup share (<see cref="RollupBucket"/> without its start).</summary>
|
||||
public abstract class ConsumptionRollupBase
|
||||
{
|
||||
public int MeterId { get; set; }
|
||||
|
||||
/// <summary>Consumption or generation, as the consumption rows are stored.</summary>
|
||||
public ConsumptionKind Kind { get; set; }
|
||||
|
||||
/// <summary>The sum of the bucket's rows; signed.</summary>
|
||||
public double Amount { get; set; }
|
||||
|
||||
public double Measured { get; set; }
|
||||
|
||||
public double Manual { get; set; }
|
||||
|
||||
public double Imported { get; set; }
|
||||
|
||||
/// <summary>Divided, coalesced, interpolated or otherwise inferred amounts.</summary>
|
||||
public double Estimated { get; set; }
|
||||
|
||||
/// <summary>How many consumption rows the bucket sums.</summary>
|
||||
public int Rows { get; set; }
|
||||
|
||||
/// <summary>Opening balance (1) and divided (2) markers.</summary>
|
||||
public RollupFlags Flags { get; set; }
|
||||
|
||||
/// <summary>The latest source-interval end among the bucket's rows (A-05), UTC.</summary>
|
||||
public DateTimeOffset MaxIntervalEnd { get; set; }
|
||||
|
||||
/// <summary>The bucket this row stores, with <paramref name="start"/> as its day or month.</summary>
|
||||
protected RollupBucket ToBucket(DateOnly start) =>
|
||||
new(start, Kind, Amount, Measured, Manual, Imported, Estimated, Rows, Flags, MaxIntervalEnd);
|
||||
|
||||
/// <summary>Copies every column but the key from <paramref name="bucket"/>; true when anything changed.</summary>
|
||||
internal bool Assign(RollupBucket bucket)
|
||||
{
|
||||
var end = bucket.MaxIntervalEnd.ToUniversalTime();
|
||||
if (Amount.Equals(bucket.Amount) && Measured.Equals(bucket.Measured) && Manual.Equals(bucket.Manual)
|
||||
&& Imported.Equals(bucket.Imported) && Estimated.Equals(bucket.Estimated) && Rows == bucket.Rows
|
||||
&& Flags == bucket.Flags && MaxIntervalEnd == end && MaxIntervalEnd.Offset == TimeSpan.Zero)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
Amount = bucket.Amount;
|
||||
Measured = bucket.Measured;
|
||||
Manual = bucket.Manual;
|
||||
Imported = bucket.Imported;
|
||||
Estimated = bucket.Estimated;
|
||||
Rows = bucket.Rows;
|
||||
Flags = bucket.Flags;
|
||||
MaxIntervalEnd = end;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>One local day of one kind for one meter: table <c>consumption_rollup</c>, key (meter_id, day, kind).</summary>
|
||||
public sealed class ConsumptionRollup : ConsumptionRollupBase
|
||||
{
|
||||
/// <summary>The local calendar day in the instance zone.</summary>
|
||||
public DateOnly Day { get; set; }
|
||||
|
||||
public RollupBucket ToBucket() => ToBucket(Day);
|
||||
|
||||
public static ConsumptionRollup From(int meterId, RollupBucket bucket)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(bucket);
|
||||
|
||||
var row = new ConsumptionRollup { MeterId = meterId, Day = bucket.Start, Kind = bucket.Kind };
|
||||
row.Assign(bucket);
|
||||
return row;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// One local month of one kind for one meter: table <c>consumption_rollup_month</c>, key (meter_id, month, kind).
|
||||
/// Month and year reads use it.
|
||||
/// </summary>
|
||||
public sealed class ConsumptionRollupMonth : ConsumptionRollupBase
|
||||
{
|
||||
/// <summary>The first day of the local month.</summary>
|
||||
public DateOnly Month { get; set; }
|
||||
|
||||
public RollupBucket ToBucket() => ToBucket(Month);
|
||||
|
||||
public static ConsumptionRollupMonth From(int meterId, RollupBucket bucket)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(bucket);
|
||||
|
||||
var row = new ConsumptionRollupMonth { MeterId = meterId, Month = bucket.Start, Kind = bucket.Kind };
|
||||
row.Assign(bucket);
|
||||
return row;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// One stored coverage run of a meter (D-13): table <c>meter_coverage</c>, key (meter_id, span_from). Stored
|
||||
/// uncapped (A-04); a reader caps it at its own now with <see cref="Core.Analysis.Coverage.CoverageRuns.CapAt"/>.
|
||||
/// </summary>
|
||||
public sealed class MeterCoverageRun
|
||||
{
|
||||
public int MeterId { get; set; }
|
||||
|
||||
public DateTimeOffset SpanFrom { get; set; }
|
||||
|
||||
public DateTimeOffset SpanTo { get; set; }
|
||||
|
||||
public ResolutionClass ResolutionClass { get; set; }
|
||||
|
||||
public bool DividedAtMonths { get; set; }
|
||||
|
||||
/// <summary>Not <see cref="CoverageGapReason.None"/> for a known hole rather than covered time.</summary>
|
||||
public CoverageGapReason GapReason { get; set; }
|
||||
|
||||
/// <summary>Where the run's final interval starts (A-04).</summary>
|
||||
public DateTimeOffset? LastIntervalStart { get; set; }
|
||||
|
||||
public CoverageRun ToRun() => new(SpanFrom, SpanTo, ResolutionClass, DividedAtMonths, GapReason, LastIntervalStart);
|
||||
|
||||
public static MeterCoverageRun From(int meterId, CoverageRun run)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(run);
|
||||
|
||||
var row = new MeterCoverageRun { MeterId = meterId, SpanFrom = run.From.ToUniversalTime() };
|
||||
row.Assign(run);
|
||||
return row;
|
||||
}
|
||||
|
||||
/// <summary>Copies every column but the key from <paramref name="run"/>; true when anything changed.</summary>
|
||||
internal bool Assign(CoverageRun run)
|
||||
{
|
||||
var to = run.To.ToUniversalTime();
|
||||
var last = run.LastIntervalStart?.ToUniversalTime();
|
||||
if (SpanTo == to && SpanTo.Offset == TimeSpan.Zero && ResolutionClass == run.Resolution
|
||||
&& DividedAtMonths == run.DividedAtMonths && GapReason == run.Gap && Nullable.Equals(LastIntervalStart, last))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
SpanTo = to;
|
||||
ResolutionClass = run.Resolution;
|
||||
DividedAtMonths = run.DividedAtMonths;
|
||||
GapReason = run.Gap;
|
||||
LastIntervalStart = last;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// What a meter's stored analysis data was built with (D-16): table <c>meter_rollup_state</c>, one row per meter.
|
||||
/// A reader whose revision or zone differs — or that finds no row — reports the meter's analysis as being
|
||||
/// prepared, never as "no data".
|
||||
/// </summary>
|
||||
public sealed class MeterRollupState
|
||||
{
|
||||
public int MeterId { get; set; }
|
||||
|
||||
/// <summary>The normalization revision the rows were built with (<c>NormalizationUpgrade.CurrentRevision</c>).</summary>
|
||||
public int Revision { get; set; }
|
||||
|
||||
/// <summary>The timezone id local days and months were cut in.</summary>
|
||||
public string Zone { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>The unit every amount of the meter is in (D-20); canonical spelling.</summary>
|
||||
public string NormalizedUnit { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>What the meter's amounts measure (D-20).</summary>
|
||||
public QuantityKind Kind { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// When the meter's analysis data last changed: a rollup or coverage row was added, changed or removed, or
|
||||
/// one of the columns above changed. A recompute that reproduces the stored data leaves it alone, so it
|
||||
/// doubles as a change marker for anything cached from these tables.
|
||||
/// </summary>
|
||||
public DateTimeOffset BuiltAt { get; set; }
|
||||
}
|
||||
Reference in New Issue
Block a user