feat(audit)!: ScadaBridge C3 — swap to canonical ZB.MOM.WW.Audit.AuditEvent across seams/emitters/DTO/redactor wiring; transitional 24-col storage shim (Task 2.5)

2026-06-02 12:37:50 -04:00
parent 5aaf9e2923
commit db707bb0de
127 changed files with 2240 additions and 3886 deletions
@@ -0,0 +1,104 @@
+using ZB.MOM.WW.Audit;
+using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;
+using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
+
+namespace ZB.MOM.WW.ScadaBridge.CentralUI.Services;
+
+/// <summary>
+/// Flattened, typed view of a canonical <see cref="ZB.MOM.WW.Audit.AuditEvent"/> for the
+/// Central UI audit pages. C3 (Task 2.5) made the canonical record the seam type — the
+/// query service decomposes it into this view (via <see cref="AuditRowProjection"/>) so the
+/// existing razor bindings (<c>row.Channel</c>, <c>Event.Status</c>, <c>evt.RequestSummary</c>,
+/// …) keep working against typed properties rather than parsing <c>DetailsJson</c> inline.
+/// </summary>
+/// <remarks>
+/// This is presentation-only: it carries the same field surface the bespoke
+/// <c>Commons.Entities.Audit.AuditEvent</c> exposed before C3. <c>ForwardState</c> is always
+/// null on the central read path (it is site-storage-only and not carried on canonical rows).
+/// </remarks>
+public sealed record AuditEventView
+{
+    /// <summary>Idempotency key.</summary>
+    public Guid EventId { get; init; }
+    /// <summary>UTC timestamp when the audited action occurred.</summary>
+    public DateTime OccurredAtUtc { get; init; }
+    /// <summary>UTC ingest timestamp (central-set); null until ingest.</summary>
+    public DateTime? IngestedAtUtc { get; init; }
+    /// <summary>Trust-boundary channel.</summary>
+    public AuditChannel Channel { get; init; }
+    /// <summary>Specific event kind.</summary>
+    public AuditKind Kind { get; init; }
+    /// <summary>Per-operation correlation id.</summary>
+    public Guid? CorrelationId { get; init; }
+    /// <summary>Originating execution id.</summary>
+    public Guid? ExecutionId { get; init; }
+    /// <summary>Spawning execution id; null for top-level runs.</summary>
+    public Guid? ParentExecutionId { get; init; }
+    /// <summary>Site id where the action originated.</summary>
+    public string? SourceSiteId { get; init; }
+    /// <summary>Cluster node that emitted the event.</summary>
+    public string? SourceNode { get; init; }
+    /// <summary>Instance id where the action originated.</summary>
+    public string? SourceInstanceId { get; init; }
+    /// <summary>Script that initiated the action.</summary>
+    public string? SourceScript { get; init; }
+    /// <summary>Authenticated actor.</summary>
+    public string? Actor { get; init; }
+    /// <summary>Target of the action.</summary>
+    public string? Target { get; init; }
+    /// <summary>Lifecycle status.</summary>
+    public AuditStatus Status { get; init; }
+    /// <summary>HTTP status code where applicable.</summary>
+    public int? HttpStatus { get; init; }
+    /// <summary>Duration of the action in ms.</summary>
+    public int? DurationMs { get; init; }
+    /// <summary>Human-readable error summary.</summary>
+    public string? ErrorMessage { get; init; }
+    /// <summary>Verbose error detail.</summary>
+    public string? ErrorDetail { get; init; }
+    /// <summary>Truncated/redacted request summary.</summary>
+    public string? RequestSummary { get; init; }
+    /// <summary>Truncated/redacted response summary.</summary>
+    public string? ResponseSummary { get; init; }
+    /// <summary>True when summaries were truncated.</summary>
+    public bool PayloadTruncated { get; init; }
+    /// <summary>Free-form JSON extension.</summary>
+    public string? Extra { get; init; }
+    /// <summary>Site-local forwarding state; always null on the central read path.</summary>
+    public AuditForwardState? ForwardState { get; init; }
+
+    /// <summary>
+    /// Decomposes a canonical <see cref="AuditEvent"/> into a flat view for the UI.
+    /// </summary>
+    public static AuditEventView From(AuditEvent evt)
+    {
+        var r = AuditRowProjection.Decompose(evt);
+        return new AuditEventView
+        {
+            EventId = r.EventId,
+            OccurredAtUtc = r.OccurredAtUtc,
+            IngestedAtUtc = r.IngestedAtUtc,
+            Channel = r.Channel,
+            Kind = r.Kind,
+            CorrelationId = r.CorrelationId,
+            ExecutionId = r.ExecutionId,
+            ParentExecutionId = r.ParentExecutionId,
+            SourceSiteId = r.SourceSiteId,
+            SourceNode = r.SourceNode,
+            SourceInstanceId = r.SourceInstanceId,
+            SourceScript = r.SourceScript,
+            Actor = r.Actor,
+            Target = r.Target,
+            Status = r.Status,
+            HttpStatus = r.HttpStatus,
+            DurationMs = r.DurationMs,
+            ErrorMessage = r.ErrorMessage,
+            ErrorDetail = r.ErrorDetail,
+            RequestSummary = r.RequestSummary,
+            ResponseSummary = r.ResponseSummary,
+            PayloadTruncated = r.PayloadTruncated,
+            Extra = r.Extra,
+            ForwardState = null,
+        };
+    }
+}
@@ -1,6 +1,5 @@
 using System.Globalization;
 using System.Text;
-using ZB.MOM.WW.ScadaBridge.Commons.Entities.Audit;
 using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
 using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;

@@ -121,7 +120,7 @@ public sealed class AuditLogExportService : IAuditLogExportService
                {
                    break;
                }
-                await writer.WriteLineAsync(FormatCsvRow(evt));
+                await writer.WriteLineAsync(FormatCsvRow(AuditEventView.From(evt)));
                written++;
            }

@@ -140,7 +139,9 @@ public sealed class AuditLogExportService : IAuditLogExportService
            var last = page[^1];
            cursor = new AuditLogPaging(
                PageSize: pageSize,
-                AfterOccurredAtUtc: last.OccurredAtUtc,
+                // C3: canonical OccurredAtUtc is a DateTimeOffset; the keyset
+                // cursor column is a UTC DateTime.
+                AfterOccurredAtUtc: last.OccurredAtUtc.UtcDateTime,
                AfterEventId: last.EventId);
        }

@@ -169,13 +170,13 @@ public sealed class AuditLogExportService : IAuditLogExportService
        "ResponseSummary,PayloadTruncated,Extra,ForwardState";

    /// <summary>
-    /// Serialises one <see cref="AuditEvent"/> as a CSV row (no trailing newline).
+    /// Serialises one <see cref="AuditEventView"/> as a CSV row (no trailing newline).
    /// Each nullable column renders as the empty string when null; non-null
    /// scalars use invariant culture so an export taken on one locale parses
    /// cleanly on another.
    /// </summary>
-    /// <param name="evt">The audit event to format as a CSV row.</param>
-    internal static string FormatCsvRow(AuditEvent evt)
+    /// <param name="evt">The audit event view to format as a CSV row.</param>
+    internal static string FormatCsvRow(AuditEventView evt)
    {
        var sb = new StringBuilder(256);
        AppendField(sb, evt.EventId.ToString(), first: true);
@@ -1,5 +1,4 @@
 using Microsoft.Extensions.DependencyInjection;
-using ZB.MOM.WW.ScadaBridge.Commons.Entities.Audit;
 using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
 using ZB.MOM.WW.ScadaBridge.Commons.Types;
 using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;
@@ -93,7 +92,7 @@ public sealed class AuditLogQueryService : IAuditLogQueryService
    public int DefaultPageSize => 100;

    /// <inheritdoc />
-    public async Task<IReadOnlyList<AuditEvent>> QueryAsync(
+    public async Task<IReadOnlyList<AuditEventView>> QueryAsync(
        AuditLogQueryFilter filter,
        AuditLogPaging? paging = null,
        CancellationToken ct = default)
@@ -101,17 +100,22 @@ public sealed class AuditLogQueryService : IAuditLogQueryService
        ArgumentNullException.ThrowIfNull(filter);
        var effective = paging ?? new AuditLogPaging(DefaultPageSize);

+        // C3 (Task 2.5): the repository seam returns canonical records; decompose
+        // each into a flat AuditEventView so the audit pages keep binding to typed
+        // properties.
        // Test-seam ctor: use the injected repository directly.
        if (_injectedRepository is not null)
        {
-            return await _injectedRepository.QueryAsync(filter, effective, ct);
+            var rows = await _injectedRepository.QueryAsync(filter, effective, ct);
+            return rows.Select(AuditEventView.From).ToList();
        }

        // Production: a fresh scope (and thus a fresh DbContext) per query so the
        // page's auto-load never shares the circuit-scoped context.
        await using var scope = _scopeFactory!.CreateAsyncScope();
        var repository = scope.ServiceProvider.GetRequiredService<IAuditLogRepository>();
-        return await repository.QueryAsync(filter, effective, ct);
+        var result = await repository.QueryAsync(filter, effective, ct);
+        return result.Select(AuditEventView.From).ToList();
    }

    /// <inheritdoc/>
@@ -1,4 +1,3 @@
-using ZB.MOM.WW.ScadaBridge.Commons.Entities.Audit;
 using ZB.MOM.WW.ScadaBridge.Commons.Types;
 using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;

@@ -18,13 +17,18 @@ public interface IAuditLogQueryService
    /// <paramref name="paging"/> is <c>null</c>, defaults to <see cref="DefaultPageSize"/>
    /// rows with no cursor (first page). The repository orders by
    /// <c>(OccurredAtUtc DESC, EventId DESC)</c>; pass the last row's
-    /// <see cref="AuditEvent.OccurredAtUtc"/> + <see cref="AuditEvent.EventId"/>
+    /// <see cref="AuditEventView.OccurredAtUtc"/> + <see cref="AuditEventView.EventId"/>
    /// back as the cursor for the next page.
    /// </summary>
+    /// <remarks>
+    /// C3 (Task 2.5): the repository seam returns the canonical
+    /// <c>ZB.MOM.WW.Audit.AuditEvent</c>; this facade decomposes each row into a flat
+    /// <see cref="AuditEventView"/> so the audit pages keep binding to typed properties.
+    /// </remarks>
    /// <param name="filter">Filter criteria applied to the audit log query.</param>
    /// <param name="paging">Optional paging cursor; defaults to first page when null.</param>
    /// <param name="ct">Cancellation token.</param>
-    Task<IReadOnlyList<AuditEvent>> QueryAsync(
+    Task<IReadOnlyList<AuditEventView>> QueryAsync(
        AuditLogQueryFilter filter,
        AuditLogPaging? paging = null,
        CancellationToken ct = default);