ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.StoreAndForward.Tests/StoreAndForwardSiteEventTests.cs

using System.Collections.Concurrent;
using Microsoft.Extensions.Logging.Abstractions;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
using ZB.MOM.WW.ScadaBridge.SiteEventLogging;
using ZB.MOM.WW.ScadaBridge.TestSupport;

namespace ZB.MOM.WW.ScadaBridge.StoreAndForward.Tests;

/// <summary>
/// The StoreAndForwardService emits site operational events for its own
/// buffer/park activity — <c>store_and_forward</c> for cached-call categories
/// (ExternalSystem / CachedDbWrite) and <c>notification</c> for the site's
/// notification forward-to-central path. Emission rides the existing
/// <c>OnActivity</c> hook and is best-effort (a failing logger never affects
/// delivery bookkeeping).
/// </summary>
public class StoreAndForwardSiteEventTests : IAsyncLifetime, IDisposable
{
    private sealed record Entry(string EventType, string Severity, string Source, string Message);

    private sealed class FakeSiteEventLogger : ISiteEventLogger
    {
        private readonly ConcurrentQueue<Entry> _entries = new();
        /// <summary>Gets the entries logged so far.</summary>
        public IReadOnlyList<Entry> Entries => _entries.ToArray();
        /// <summary>Returns the logged entries of one event type.</summary>
        /// <param name="t">The event type to filter by.</param>
        /// <returns>The logged entries whose event type matches.</returns>
        public IReadOnlyList<Entry> OfType(string t) => _entries.Where(e => e.EventType == t).ToArray();

        /// <inheritdoc />
        public Task LogEventAsync(string eventType, string severity, string? instanceId,
            string source, string message, string? details = null)
        {
            _entries.Enqueue(new Entry(eventType, severity, source, message));
            return Task.CompletedTask;
        }

        /// <inheritdoc />
        public long FailedWriteCount => 0;
    }

    private readonly TestLocalDb _localDb;
    private readonly StoreAndForwardStorage _storage;
    private readonly StoreAndForwardOptions _options;
    private readonly FakeSiteEventLogger _siteLog = new();
    private readonly StoreAndForwardService _service;

    /// <summary>Initializes the test class with a temporary LocalDb and a store-and-forward service wired to a fake site event logger.</summary>
    public StoreAndForwardSiteEventTests()
    {
        _localDb = TestLocalDb.CreateTemp("SiteEvt");

        _storage = new StoreAndForwardStorage(_localDb.Db, NullLogger<StoreAndForwardStorage>.Instance);
        _options = new StoreAndForwardOptions
        {
            DefaultRetryInterval = TimeSpan.Zero,
            DefaultMaxRetries = 1,
            RetryTimerInterval = TimeSpan.FromMinutes(10)
        };

        _service = new StoreAndForwardService(
            _storage, _options, NullLogger<StoreAndForwardService>.Instance,
            cachedCallObserver: null, siteId: "site-a",
            siteEventLogger: _siteLog);
    }

    /// <summary>Initializes the fixture before the tests run.</summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    public async Task InitializeAsync() => await _storage.InitializeAsync();
    /// <summary>Releases the fixture after the tests run.</summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    public Task DisposeAsync() => Task.CompletedTask;
    /// <summary>Releases the resources held by the test fixture.</summary>
    public void Dispose()
    {
        var path = _localDb.Path;
        _localDb.Dispose();
        TestLocalDb.DeleteFiles(path);
    }

    /// <summary>Verifies that buffering an external system message for retry emits a store-and-forward site event.</summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    [Fact]
    public async Task BufferForRetry_ExternalSystem_EmitsStoreAndForwardSiteEvent()
    {
        _service.RegisterDeliveryHandler(StoreAndForwardCategory.ExternalSystem,
            _ => throw new HttpRequestException("transient"));

        await _service.EnqueueAsync(StoreAndForwardCategory.ExternalSystem, "api.example.com", """{}""", "Pump1");

        var rows = _siteLog.OfType("store_and_forward");
        Assert.Contains(rows, r => r.Severity == "Warning" &&
            r.Source == "StoreAndForwardService" &&
            r.Message.Contains("queued", StringComparison.OrdinalIgnoreCase));
        // The cached-call categories must NOT surface as notification events.
        Assert.Empty(_siteLog.OfType("notification"));
    }

    /// <summary>Verifies that a failed notification forward emits a notification site event.</summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    [Fact]
    public async Task ForwardFailure_Notification_EmitsNotificationSiteEvent()
    {
        // The site's notification role is forward-to-central. When the immediate
        // forward to central throws (central unreachable), the notification is
        // buffered for retry — a forward FAILURE, which the spec says to log as a
        // `notification` site event (filling the in-transit blind spot).
        _service.RegisterDeliveryHandler(StoreAndForwardCategory.Notification,
            _ => throw new HttpRequestException("central unreachable"));

        await _service.EnqueueAsync(StoreAndForwardCategory.Notification, "list-a", """{}""", "Pump1");

        var rows = _siteLog.OfType("notification");
        Assert.Contains(rows, r => r.Severity == "Warning" &&
            r.Source == "StoreAndForwardService" &&
            r.Message.Contains("queued", StringComparison.OrdinalIgnoreCase));
        // A notification forward-failure is not a store_and_forward (cached-call) event.
        Assert.Empty(_siteLog.OfType("store_and_forward"));
    }

    /// <summary>Verifies that a routine notification enqueue does not emit a site event.</summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    [Fact]
    public async Task RoutineEnqueue_Notification_DoesNotEmitSiteEvent()
    {
        // Spec: routine enqueue / forward-success on the notification path are
        // deliberately NOT logged — central's Notifications table is the audit
        // record of record. A successful immediate forward emits no site event.
        _service.RegisterDeliveryHandler(StoreAndForwardCategory.Notification,
            _ => Task.FromResult(true));

        await _service.EnqueueAsync(StoreAndForwardCategory.Notification, "list-a", """{}""", "Pump1");

        Assert.Empty(_siteLog.OfType("notification"));
    }

    /// <summary>Verifies that parking a notification emits an error-severity notification site event.</summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    [Fact]
    public async Task Park_Notification_EmitsErrorNotificationSiteEvent()
    {
        // A long-buffered notification that exhausts retries is parked — the spec
        // logs this as a `notification` event (Error severity).
        _service.RegisterDeliveryHandler(StoreAndForwardCategory.Notification,
            _ => throw new HttpRequestException("central unreachable"));

        await _service.EnqueueAsync(
            StoreAndForwardCategory.Notification, "list-a", """{}""", "Pump1",
            attemptImmediateDelivery: false, maxRetries: 1);

        await _service.RetryPendingMessagesAsync();

        var rows = _siteLog.OfType("notification");
        Assert.Contains(rows, r => r.Severity == "Error" &&
            r.Message.Contains("parked", StringComparison.OrdinalIgnoreCase));
    }

    /// <summary>Verifies that parking an external system message emits an error-severity store-and-forward site event.</summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    [Fact]
    public async Task Park_ExternalSystem_EmitsErrorStoreAndForwardSiteEvent()
    {
        // MaxRetries = 1 → the first sweep retry parks the message.
        _service.RegisterDeliveryHandler(StoreAndForwardCategory.ExternalSystem,
            _ => throw new HttpRequestException("transient"));

        await _service.EnqueueAsync(
            StoreAndForwardCategory.ExternalSystem, "api.example.com", """{}""", "Pump1",
            attemptImmediateDelivery: false, maxRetries: 1);

        await _service.RetryPendingMessagesAsync();

        var rows = _siteLog.OfType("store_and_forward");
        Assert.Contains(rows, r => r.Severity == "Error" &&
            r.Message.Contains("parked", StringComparison.OrdinalIgnoreCase));
    }

    /// <summary>Verifies that a message delivered immediately does not emit a site event.</summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    [Fact]
    public async Task DeliveredImmediately_DoesNotEmitSiteEvent()
    {
        // A successful immediate delivery is the normal hot path — it is not a
        // store-and-forward buffering event, so no operational event is logged.
        _service.RegisterDeliveryHandler(StoreAndForwardCategory.ExternalSystem,
            _ => Task.FromResult(true));

        await _service.EnqueueAsync(StoreAndForwardCategory.ExternalSystem, "api", """{}""", "Pump1");

        Assert.Empty(_siteLog.OfType("store_and_forward"));
        Assert.Empty(_siteLog.OfType("notification"));
    }
}