using System.Globalization; using Microsoft.Data.Sqlite; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using ScadaLink.Commons.Interfaces; using ScadaLink.Commons.Types; namespace ScadaLink.SiteRuntime.Tracking; /// /// Site-local SQLite source-of-truth for cached-operation tracking — the row /// that Tracking.Status(TrackedOperationId) reads (Audit Log #23 / M3). /// /// /// /// One row per ; lifecycle is /// Submitted → Retrying → Delivered / Parked / Failed / Discarded; terminal /// rows are purged after the configured retention window /// (). Volume is bounded — /// only cached calls produce rows, and only a handful of lifecycle events per /// call — so we keep the implementation deliberately simple: a single owned /// serialised behind a /// (one async writer at a time). This is the pattern the M3 brief calls out as /// "cleaner than the M2 Channel<T> pipeline given the volume"; the M2 /// audit-writer's batched-channel design is reserved for the high-volume audit /// hot-path. /// /// /// All mutations are idempotent / monotonic: is /// INSERT OR IGNORE, filters out terminal /// rows in the WHERE clause, and only /// fires on rows that haven't terminated yet (first-write-wins). This makes the /// store safe under the at-least-once semantics of the site→central telemetry /// path. /// /// public class OperationTrackingStore : IOperationTrackingStore, IAsyncDisposable, IDisposable { private readonly SqliteConnection _connection; private readonly SemaphoreSlim _gate = new(1, 1); private readonly ILogger _logger; private bool _disposed; public OperationTrackingStore( IOptions options, ILogger logger) { ArgumentNullException.ThrowIfNull(options); ArgumentNullException.ThrowIfNull(logger); _logger = logger; _connection = new SqliteConnection(options.Value.ConnectionString); _connection.Open(); InitializeSchema(); } private void InitializeSchema() { using var cmd = _connection.CreateCommand(); cmd.CommandText = """ CREATE TABLE IF NOT EXISTS OperationTracking ( TrackedOperationId TEXT NOT NULL PRIMARY KEY, Kind TEXT NOT NULL, TargetSummary TEXT NULL, Status TEXT NOT NULL, RetryCount INTEGER NOT NULL DEFAULT 0, LastError TEXT NULL, HttpStatus INTEGER NULL, CreatedAtUtc TEXT NOT NULL, UpdatedAtUtc TEXT NOT NULL, TerminalAtUtc TEXT NULL, SourceInstanceId TEXT NULL, SourceScript TEXT NULL, SourceNode TEXT NULL ); CREATE INDEX IF NOT EXISTS IX_OperationTracking_Status_Updated ON OperationTracking (Status, UpdatedAtUtc); """; cmd.ExecuteNonQuery(); // SourceNode stamping: additively add the SourceNode column. // CREATE TABLE IF NOT EXISTS above does NOT add columns to an // OperationTracking table that already exists from a pre-SourceNode // build, so a tracking.db created by an older build needs the column // ALTER-ed in. The file is durable across restart/failover by design // (retention window default 7 days), so without this step every // RecordEnqueueAsync on an upgraded deployment would bind $sourceNode // against a missing column and the write would fail. // SQLite has no "ADD COLUMN IF NOT EXISTS"; the column presence is // probed first and the ALTER skipped when already there. The column is // nullable with no default, so any row written before this migration // reads back SourceNode = null (back-compat). // // NOTE: This is the FIRST idempotent column-upgrade in // OperationTrackingStore — prior schema changes pre-dated any // production rollout and relied solely on CREATE TABLE IF NOT EXISTS. // The helper mirrors the SqliteAuditWriter precedent. AddColumnIfMissing("SourceNode", "TEXT NULL"); } /// /// Additively adds a column to OperationTracking only when it is not /// already present. SQLite lacks ADD COLUMN IF NOT EXISTS, so the /// schema is probed via PRAGMA table_info first. Idempotent — safe /// to run on every . Mirrors the /// SqliteAuditWriter.AddColumnIfMissing precedent. /// private void AddColumnIfMissing(string columnName, string columnDefinition) { using var probe = _connection.CreateCommand(); probe.CommandText = "SELECT COUNT(*) FROM pragma_table_info('OperationTracking') WHERE name = $name"; probe.Parameters.AddWithValue("$name", columnName); var exists = Convert.ToInt32(probe.ExecuteScalar()) > 0; if (exists) { return; } using var alter = _connection.CreateCommand(); // Column name + definition are caller-controlled constants, never user // input — safe to interpolate (parameters are not permitted in DDL). alter.CommandText = $"ALTER TABLE OperationTracking ADD COLUMN {columnName} {columnDefinition}"; alter.ExecuteNonQuery(); } /// public async Task RecordEnqueueAsync( TrackedOperationId id, string kind, string? targetSummary, string? sourceInstanceId, string? sourceScript, string? sourceNode, CancellationToken ct = default) { ArgumentNullException.ThrowIfNull(kind); await _gate.WaitAsync(ct).ConfigureAwait(false); try { ObjectDisposedException.ThrowIf(_disposed, this); var now = DateTime.UtcNow.ToString("o", CultureInfo.InvariantCulture); using var cmd = _connection.CreateCommand(); // INSERT OR IGNORE: duplicate ids are no-ops (first-write-wins) — // matches the at-least-once semantics the site emits under. cmd.CommandText = """ INSERT OR IGNORE INTO OperationTracking ( TrackedOperationId, Kind, TargetSummary, Status, RetryCount, LastError, HttpStatus, CreatedAtUtc, UpdatedAtUtc, TerminalAtUtc, SourceInstanceId, SourceScript, SourceNode ) VALUES ( $id, $kind, $targetSummary, $status, 0, NULL, NULL, $now, $now, NULL, $sourceInstanceId, $sourceScript, $sourceNode ); """; cmd.Parameters.AddWithValue("$id", id.ToString()); cmd.Parameters.AddWithValue("$kind", kind); cmd.Parameters.AddWithValue("$targetSummary", (object?)targetSummary ?? DBNull.Value); cmd.Parameters.AddWithValue("$status", "Submitted"); cmd.Parameters.AddWithValue("$now", now); cmd.Parameters.AddWithValue("$sourceInstanceId", (object?)sourceInstanceId ?? DBNull.Value); cmd.Parameters.AddWithValue("$sourceScript", (object?)sourceScript ?? DBNull.Value); cmd.Parameters.AddWithValue("$sourceNode", (object?)sourceNode ?? DBNull.Value); cmd.ExecuteNonQuery(); } finally { _gate.Release(); } } /// public async Task RecordAttemptAsync( TrackedOperationId id, string status, int retryCount, string? lastError, int? httpStatus, CancellationToken ct = default) { ArgumentNullException.ThrowIfNull(status); await _gate.WaitAsync(ct).ConfigureAwait(false); try { ObjectDisposedException.ThrowIf(_disposed, this); var now = DateTime.UtcNow.ToString("o", CultureInfo.InvariantCulture); using var cmd = _connection.CreateCommand(); // Terminal rows are immutable — the WHERE clause filters them out so // late-arriving attempt telemetry never overwrites a resolved row. cmd.CommandText = """ UPDATE OperationTracking SET Status = $status, RetryCount = $retryCount, LastError = $lastError, HttpStatus = $httpStatus, UpdatedAtUtc = $now WHERE TrackedOperationId = $id AND TerminalAtUtc IS NULL; """; cmd.Parameters.AddWithValue("$id", id.ToString()); cmd.Parameters.AddWithValue("$status", status); cmd.Parameters.AddWithValue("$retryCount", retryCount); cmd.Parameters.AddWithValue("$lastError", (object?)lastError ?? DBNull.Value); cmd.Parameters.AddWithValue("$httpStatus", (object?)httpStatus ?? DBNull.Value); cmd.Parameters.AddWithValue("$now", now); cmd.ExecuteNonQuery(); } finally { _gate.Release(); } } /// public async Task RecordTerminalAsync( TrackedOperationId id, string status, string? lastError, int? httpStatus, CancellationToken ct = default) { ArgumentNullException.ThrowIfNull(status); await _gate.WaitAsync(ct).ConfigureAwait(false); try { ObjectDisposedException.ThrowIf(_disposed, this); var now = DateTime.UtcNow.ToString("o", CultureInfo.InvariantCulture); using var cmd = _connection.CreateCommand(); // First-write-wins on the terminal flip: only update rows that // haven't already terminated. cmd.CommandText = """ UPDATE OperationTracking SET Status = $status, LastError = $lastError, HttpStatus = $httpStatus, UpdatedAtUtc = $now, TerminalAtUtc = $now WHERE TrackedOperationId = $id AND TerminalAtUtc IS NULL; """; cmd.Parameters.AddWithValue("$id", id.ToString()); cmd.Parameters.AddWithValue("$status", status); cmd.Parameters.AddWithValue("$lastError", (object?)lastError ?? DBNull.Value); cmd.Parameters.AddWithValue("$httpStatus", (object?)httpStatus ?? DBNull.Value); cmd.Parameters.AddWithValue("$now", now); cmd.ExecuteNonQuery(); } finally { _gate.Release(); } } /// public async Task GetStatusAsync( TrackedOperationId id, CancellationToken ct = default) { await _gate.WaitAsync(ct).ConfigureAwait(false); try { ObjectDisposedException.ThrowIf(_disposed, this); using var cmd = _connection.CreateCommand(); cmd.CommandText = """ SELECT TrackedOperationId, Kind, TargetSummary, Status, RetryCount, LastError, HttpStatus, CreatedAtUtc, UpdatedAtUtc, TerminalAtUtc, SourceInstanceId, SourceScript, SourceNode FROM OperationTracking WHERE TrackedOperationId = $id; """; cmd.Parameters.AddWithValue("$id", id.ToString()); using var reader = cmd.ExecuteReader(); if (!reader.Read()) { return null; } return new TrackingStatusSnapshot( Id: TrackedOperationId.Parse(reader.GetString(0)), Kind: reader.GetString(1), TargetSummary: reader.IsDBNull(2) ? null : reader.GetString(2), Status: reader.GetString(3), RetryCount: reader.GetInt32(4), LastError: reader.IsDBNull(5) ? null : reader.GetString(5), HttpStatus: reader.IsDBNull(6) ? null : reader.GetInt32(6), CreatedAtUtc: ParseUtc(reader.GetString(7)), UpdatedAtUtc: ParseUtc(reader.GetString(8)), TerminalAtUtc: reader.IsDBNull(9) ? null : ParseUtc(reader.GetString(9)), SourceInstanceId: reader.IsDBNull(10) ? null : reader.GetString(10), SourceScript: reader.IsDBNull(11) ? null : reader.GetString(11), SourceNode: reader.IsDBNull(12) ? null : reader.GetString(12)); } finally { _gate.Release(); } } /// public async Task PurgeTerminalAsync( DateTime olderThanUtc, CancellationToken ct = default) { await _gate.WaitAsync(ct).ConfigureAwait(false); try { ObjectDisposedException.ThrowIf(_disposed, this); using var cmd = _connection.CreateCommand(); // Non-terminal rows (TerminalAtUtc IS NULL) are kept regardless of // age — the operation is still in flight. cmd.CommandText = """ DELETE FROM OperationTracking WHERE TerminalAtUtc IS NOT NULL AND TerminalAtUtc < $threshold; """; cmd.Parameters.AddWithValue( "$threshold", olderThanUtc.ToString("o", CultureInfo.InvariantCulture)); cmd.ExecuteNonQuery(); } finally { _gate.Release(); } } private static DateTime ParseUtc(string raw) { return DateTime.Parse( raw, CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind); } public void Dispose() { DisposeAsyncCore().AsTask().GetAwaiter().GetResult(); GC.SuppressFinalize(this); } public async ValueTask DisposeAsync() { await DisposeAsyncCore().ConfigureAwait(false); GC.SuppressFinalize(this); } private async ValueTask DisposeAsyncCore() { await _gate.WaitAsync().ConfigureAwait(false); try { if (_disposed) return; _disposed = true; _connection.Dispose(); } finally { _gate.Release(); _gate.Dispose(); } } }