feat(commons): CachedCallTelemetry combined operational+audit packet (#23 M3)

This commit is contained in:
Joseph Doherty
2026-05-20 13:58:57 -04:00
parent 0f28d13da7
commit e416b21dad
3 changed files with 283 additions and 0 deletions

View File

@@ -0,0 +1,34 @@
using ScadaLink.Commons.Entities.Audit;
using ScadaLink.Commons.Types;
namespace ScadaLink.Commons.Messages.Integration;
/// <summary>
/// Combined audit + operational telemetry packet for cached outbound calls
/// (Audit Log #23 / M3). The site emits one packet per lifecycle event
/// — <c>Submit</c> (Audit kind <c>CachedSubmit</c>), per-attempt
/// <c>ApiCallCached</c>/<c>DbWriteCached</c>, terminal <c>CachedResolve</c> —
/// and central writes the <see cref="AuditEvent"/> row plus the
/// <see cref="SiteCallOperational"/> upsert in one MS SQL transaction. Two
/// payload shapes ride on a single wire message so the same on-the-wire batch
/// can carry mixed lifecycle events without the central dual-write needing a
/// second RPC for the operational state.
/// </summary>
/// <remarks>
/// <para>
/// Both inner records carry the same <c>TrackedOperationId</c> — the
/// idempotency key end-to-end. The <see cref="AuditEvent.CorrelationId"/>
/// pattern (used by Audit Log #23 to thread cached-call rows together) is
/// honoured by the site emitter; the packet itself is shape-only and makes no
/// independent correlation guarantees.
/// </para>
/// <para>
/// Additive-only per Commons REQ-COM-5a (M2 reviewer note) — this is a new
/// message, not a rename of any existing M2 envelope.
/// </para>
/// </remarks>
/// <param name="Audit">The Audit Log #23 row to insert at central.</param>
/// <param name="Operational">The <c>SiteCalls</c> upsert mirroring this lifecycle event.</param>
public sealed record CachedCallTelemetry(
AuditEvent Audit,
SiteCallOperational Operational);

View File

@@ -0,0 +1,46 @@
namespace ScadaLink.Commons.Types;
/// <summary>
/// Operational state of one cached call as seen by the site, carried on the
/// combined <c>CachedCallTelemetry</c> packet (Audit Log #23 / M3) and persisted
/// at central as the <c>SiteCalls</c> row mirroring the call's status.
/// </summary>
/// <remarks>
/// <para>
/// One row per <see cref="TrackedOperationId"/> at central; ingest is
/// insert-if-not-exists then upsert-on-newer-status (monotonic — never rolls
/// back). The site remains the source of truth — this record is the
/// "eventually-consistent mirror" the central UI's Site Calls page reads.
/// </para>
/// </remarks>
/// <param name="TrackedOperationId">Idempotency key shared with the audit row.</param>
/// <param name="Channel">
/// Trust-boundary channel — <c>"ApiOutbound"</c> or <c>"DbOutbound"</c>. String form
/// (not the <see cref="ScadaLink.Commons.Types.Enums.AuditChannel"/> enum) so the
/// record serialises identically across SQL / gRPC / JSON boundaries.
/// </param>
/// <param name="Target">Human-readable target (e.g. <c>"ERP.GetOrder"</c>).</param>
/// <param name="SourceSite">Site id that submitted the cached call.</param>
/// <param name="Status">
/// Lifecycle status — string form of <see cref="ScadaLink.Commons.Types.Enums.AuditStatus"/>:
/// <c>Submitted</c>, <c>Retrying</c>, <c>Attempted</c>, <c>Delivered</c>,
/// <c>Failed</c>, <c>Parked</c>, <c>Discarded</c>.
/// </param>
/// <param name="RetryCount">Number of dispatch attempts so far; 0 prior to first attempt.</param>
/// <param name="LastError">Most recent error message; null when no failures have occurred.</param>
/// <param name="HttpStatus">Most recent HTTP status code (API calls only); null otherwise.</param>
/// <param name="CreatedAtUtc">UTC timestamp the cached call was first submitted.</param>
/// <param name="UpdatedAtUtc">UTC timestamp of the latest status mutation.</param>
/// <param name="TerminalAtUtc">UTC timestamp the row reached a terminal status; null while still active.</param>
public sealed record SiteCallOperational(
TrackedOperationId TrackedOperationId,
string Channel,
string Target,
string SourceSite,
string Status,
int RetryCount,
string? LastError,
int? HttpStatus,
DateTime CreatedAtUtc,
DateTime UpdatedAtUtc,
DateTime? TerminalAtUtc);