dohertj2/scadalink-design
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

feat(notification-outbox): add NotificationOutbox repository

Browse Source
This commit is contained in:
Joseph Doherty
2026-05-19 01:02:06 -04:00
parent 3022aa8379
commit 2c59d59b61
6 changed files with 630 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

337
tests/ScadaLink.ConfigurationDatabase.Tests/RepositoryCoverageTests.cs
View File

@@ -6,6 +6,7 @@ using ScadaLink.Commons.Entities.Notifications;
using ScadaLink.Commons.Entities.Sites;
using ScadaLink.Commons.Entities.Templates;
using ScadaLink.Commons.Types.Enums;
using ScadaLink.Commons.Types.Notifications;
using ScadaLink.ConfigurationDatabase;
using ScadaLink.ConfigurationDatabase.Repositories;
using ScadaLink.ConfigurationDatabase.Services;
@@ -334,6 +335,342 @@ public class NotificationOutboxConfigurationTests : IDisposable
}
}
// Coverage for the Notification Outbox repository (Task 5 of the notification-outbox feature).
public class NotificationOutboxRepositoryTests : IDisposable
{
private readonly ScadaLinkDbContext _context;
private readonly NotificationOutboxRepository _repository;
public NotificationOutboxRepositoryTests()
{
_context = SqliteTestHelper.CreateInMemoryContext();
_repository = new NotificationOutboxRepository(_context);
}
public void Dispose()
{
_context.Database.CloseConnection();
_context.Dispose();
}
private static Notification MakeNotification(
string id,
NotificationStatus status = NotificationStatus.Pending,
DateTimeOffset? createdAt = null,
DateTimeOffset? nextAttemptAt = null,
DateTimeOffset? deliveredAt = null,
string listName = "Ops List",
string subject = "Subject",
string sourceSiteId = "site-north",
NotificationType type = NotificationType.Email)
{
return new Notification(id, type, listName, subject, "Body", sourceSiteId)
{
Status = status,
CreatedAt = createdAt ?? new DateTimeOffset(2026, 5, 19, 8, 0, 0, TimeSpan.Zero),
NextAttemptAt = nextAttemptAt,
DeliveredAt = deliveredAt,
};
}
[Fact]
public async Task InsertIfNotExistsAsync_NewRow_InsertsAndReturnsTrue()
{
var id = Guid.NewGuid().ToString();
var inserted = await _repository.InsertIfNotExistsAsync(MakeNotification(id));
Assert.True(inserted);
_context.ChangeTracker.Clear();
Assert.NotNull(await _context.Notifications.FindAsync(id));
}
[Fact]
public async Task InsertIfNotExistsAsync_DuplicateId_ReturnsFalseAndLeavesExistingRow()
{
var id = Guid.NewGuid().ToString();
await _repository.InsertIfNotExistsAsync(MakeNotification(id, subject: "Original"));
_context.ChangeTracker.Clear();
var inserted = await _repository.InsertIfNotExistsAsync(MakeNotification(id, subject: "Changed"));
Assert.False(inserted);
_context.ChangeTracker.Clear();
var loaded = await _context.Notifications.FindAsync(id);
Assert.Equal("Original", loaded!.Subject);
}
[Fact]
public async Task GetDueAsync_ReturnsPendingAndDueRetrying_OrderedByCreatedAt_CappedAtBatchSize()
{
var now = new DateTimeOffset(2026, 5, 19, 12, 0, 0, TimeSpan.Zero);
var pendingOld = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Pending,
createdAt: now.AddMinutes(-30));
var pendingNew = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Pending,
createdAt: now.AddMinutes(-10));
var retryingDue = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Retrying,
createdAt: now.AddMinutes(-20), nextAttemptAt: now.AddMinutes(-1));
var retryingNotDue = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Retrying,
createdAt: now.AddMinutes(-25), nextAttemptAt: now.AddMinutes(5));
var delivered = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Delivered,
createdAt: now.AddMinutes(-40));
var parked = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Parked,
createdAt: now.AddMinutes(-45));
_context.Notifications.AddRange(pendingOld, pendingNew, retryingDue, retryingNotDue, delivered, parked);
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
var due = await _repository.GetDueAsync(now, batchSize: 10);
// pendingOld, retryingDue, pendingNew are due; ordered by CreatedAt ascending.
Assert.Equal(
new[] { pendingOld.NotificationId, retryingDue.NotificationId, pendingNew.NotificationId },
due.Select(n => n.NotificationId).ToArray());
var capped = await _repository.GetDueAsync(now, batchSize: 2);
Assert.Equal(2, capped.Count);
Assert.Equal(pendingOld.NotificationId, capped[0].NotificationId);
Assert.Equal(retryingDue.NotificationId, capped[1].NotificationId);
}
[Fact]
public async Task GetByIdAsync_ReturnsRowOrNull()
{
var id = Guid.NewGuid().ToString();
_context.Notifications.Add(MakeNotification(id));
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
Assert.NotNull(await _repository.GetByIdAsync(id));
Assert.Null(await _repository.GetByIdAsync("does-not-exist"));
}
[Fact]
public async Task UpdateAsync_PersistsStatusTransition()
{
var id = Guid.NewGuid().ToString();
_context.Notifications.Add(MakeNotification(id, NotificationStatus.Pending));
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
var loaded = await _repository.GetByIdAsync(id);
loaded!.Status = NotificationStatus.Delivered;
loaded.DeliveredAt = new DateTimeOffset(2026, 5, 19, 9, 0, 0, TimeSpan.Zero);
await _repository.UpdateAsync(loaded);
_context.ChangeTracker.Clear();
var reloaded = await _context.Notifications.FindAsync(id);
Assert.Equal(NotificationStatus.Delivered, reloaded!.Status);
Assert.Equal(new DateTimeOffset(2026, 5, 19, 9, 0, 0, TimeSpan.Zero), reloaded.DeliveredAt);
}
[Fact]
public async Task QueryAsync_AppliesFilters_OrdersByCreatedAtDescending_AndPaginates()
{
var baseTime = new DateTimeOffset(2026, 5, 19, 8, 0, 0, TimeSpan.Zero);
// 5 matching rows for site-north / Ops List, plus noise.
for (var i = 0; i < 5; i++)
{
_context.Notifications.Add(MakeNotification(
Guid.NewGuid().ToString(), NotificationStatus.Pending,
createdAt: baseTime.AddMinutes(i),
subject: $"Tank Level {i}"));
}
_context.Notifications.Add(MakeNotification(Guid.NewGuid().ToString(),
sourceSiteId: "site-south", subject: "Other Site"));
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
var filter = new NotificationOutboxFilter(SourceSiteId: "site-north", ListName: "Ops List");
var (rows, total) = await _repository.QueryAsync(filter, pageNumber: 1, pageSize: 3);
Assert.Equal(5, total);
Assert.Equal(3, rows.Count);
// Descending by CreatedAt: Tank Level 4, 3, 2.
Assert.Equal("Tank Level 4", rows[0].Subject);
Assert.Equal("Tank Level 3", rows[1].Subject);
Assert.Equal("Tank Level 2", rows[2].Subject);
var (page2, _) = await _repository.QueryAsync(filter, pageNumber: 2, pageSize: 3);
Assert.Equal(2, page2.Count);
Assert.Equal("Tank Level 1", page2[0].Subject);
Assert.Equal("Tank Level 0", page2[1].Subject);
}
[Fact]
public async Task QueryAsync_SubjectKeyword_UsesContains()
{
_context.Notifications.Add(MakeNotification(Guid.NewGuid().ToString(), subject: "Tank Level High"));
_context.Notifications.Add(MakeNotification(Guid.NewGuid().ToString(), subject: "Pump Failure"));
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
var (rows, total) = await _repository.QueryAsync(
new NotificationOutboxFilter(SubjectKeyword: "Level"), pageNumber: 1, pageSize: 10);
Assert.Equal(1, total);
Assert.Equal("Tank Level High", rows[0].Subject);
}
[Fact]
public async Task QueryAsync_StuckOnly_ReturnsNonTerminalRowsOlderThanCutoff()
{
var cutoff = new DateTimeOffset(2026, 5, 19, 10, 0, 0, TimeSpan.Zero);
var stuckPending = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Pending,
createdAt: cutoff.AddHours(-2), subject: "Stuck Pending");
var stuckRetrying = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Retrying,
createdAt: cutoff.AddHours(-3), subject: "Stuck Retrying");
var freshPending = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Pending,
createdAt: cutoff.AddHours(1), subject: "Fresh");
var oldDelivered = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Delivered,
createdAt: cutoff.AddHours(-5), subject: "Old Delivered");
_context.Notifications.AddRange(stuckPending, stuckRetrying, freshPending, oldDelivered);
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
var (rows, total) = await _repository.QueryAsync(
new NotificationOutboxFilter(StuckOnly: true, StuckCutoff: cutoff),
pageNumber: 1, pageSize: 10);
Assert.Equal(2, total);
Assert.Equal(
new[] { "Stuck Pending", "Stuck Retrying" },
rows.Select(r => r.Subject).OrderBy(s => s).ToArray());
}
[Fact]
public async Task QueryAsync_FromTo_FilterAgainstCreatedAt()
{
var baseTime = new DateTimeOffset(2026, 5, 19, 8, 0, 0, TimeSpan.Zero);
for (var i = 0; i < 5; i++)
{
_context.Notifications.Add(MakeNotification(Guid.NewGuid().ToString(),
createdAt: baseTime.AddHours(i), subject: $"Row {i}"));
}
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
var (rows, total) = await _repository.QueryAsync(
new NotificationOutboxFilter(From: baseTime.AddHours(1), To: baseTime.AddHours(3)),
pageNumber: 1, pageSize: 10);
Assert.Equal(3, total);
Assert.Equal(
new[] { "Row 1", "Row 2", "Row 3" },
rows.Select(r => r.Subject).OrderBy(s => s).ToArray());
}
[Fact]
public async Task QueryAsync_StatusAndTypeFilters()
{
_context.Notifications.Add(MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Parked,
subject: "Parked Row"));
_context.Notifications.Add(MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Pending,
subject: "Pending Row"));
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
var (rows, total) = await _repository.QueryAsync(
new NotificationOutboxFilter(Status: NotificationStatus.Parked, Type: NotificationType.Email),
pageNumber: 1, pageSize: 10);
Assert.Equal(1, total);
Assert.Equal("Parked Row", rows[0].Subject);
}
[Fact]
public async Task DeleteTerminalOlderThanAsync_DeletesTerminalRowsOlderThanCutoff_LeavesOthers()
{
var cutoff = new DateTimeOffset(2026, 5, 19, 10, 0, 0, TimeSpan.Zero);
var oldDelivered = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Delivered,
createdAt: cutoff.AddHours(-1));
var oldParked = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Parked,
createdAt: cutoff.AddHours(-2));
var oldDiscarded = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Discarded,
createdAt: cutoff.AddHours(-3));
var recentDelivered = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Delivered,
createdAt: cutoff.AddHours(1));
var oldPending = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Pending,
createdAt: cutoff.AddHours(-4));
_context.Notifications.AddRange(oldDelivered, oldParked, oldDiscarded, recentDelivered, oldPending);
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
var deleted = await _repository.DeleteTerminalOlderThanAsync(cutoff);
Assert.Equal(3, deleted);
var remaining = await _context.Notifications.Select(n => n.NotificationId).ToListAsync();
Assert.Equal(2, remaining.Count);
Assert.Contains(recentDelivered.NotificationId, remaining);
Assert.Contains(oldPending.NotificationId, remaining);
}
[Fact]
public async Task ComputeKpisAsync_ComputesSnapshotFields()
{
var now = DateTimeOffset.UtcNow;
var stuckCutoff = now.AddMinutes(-30);
var deliveredSince = now.AddHours(-1);
var oldestPending = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Pending,
createdAt: now.AddHours(-2)); // stuck
var freshPending = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Pending,
createdAt: now.AddMinutes(-5)); // not stuck
var stuckRetrying = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Retrying,
createdAt: now.AddMinutes(-45)); // stuck
var parked = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Parked,
createdAt: now.AddHours(-3));
var recentlyDelivered = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Delivered,
createdAt: now.AddHours(-4), deliveredAt: now.AddMinutes(-10));
var oldDelivered = MakeNotification(Guid.NewGuid().ToString(), NotificationStatus.Delivered,
createdAt: now.AddHours(-5), deliveredAt: now.AddHours(-2));
_context.Notifications.AddRange(oldestPending, freshPending, stuckRetrying, parked,
recentlyDelivered, oldDelivered);
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
var kpis = await _repository.ComputeKpisAsync(stuckCutoff, deliveredSince);
Assert.Equal(3, kpis.QueueDepth); // 2 pending + 1 retrying
Assert.Equal(2, kpis.StuckCount); // oldestPending + stuckRetrying
Assert.Equal(1, kpis.ParkedCount); // parked
Assert.Equal(1, kpis.DeliveredLastInterval); // recentlyDelivered only
Assert.NotNull(kpis.OldestPendingAge);
// Oldest non-terminal row is oldestPending (created ~2h ago).
Assert.True(kpis.OldestPendingAge!.Value >= TimeSpan.FromMinutes(115));
}
[Fact]
public async Task ComputeKpisAsync_NoNonTerminalRows_OldestPendingAgeIsNull()
{
var now = DateTimeOffset.UtcNow;
_context.Notifications.Add(MakeNotification(Guid.NewGuid().ToString(),
NotificationStatus.Delivered, createdAt: now.AddHours(-1), deliveredAt: now.AddMinutes(-5)));
await _context.SaveChangesAsync();
_context.ChangeTracker.Clear();
var kpis = await _repository.ComputeKpisAsync(now.AddMinutes(-30), now.AddHours(-1));
Assert.Equal(0, kpis.QueueDepth);
Assert.Equal(0, kpis.StuckCount);
Assert.Null(kpis.OldestPendingAge);
}
[Fact]
public void Constructor_NullContext_Throws()
{
Assert.Throws<ArgumentNullException>(() => new NotificationOutboxRepository(null!));
}
}
public class SiteRepositoryTests : IDisposable
{
private readonly ScadaLinkDbContext _context;