From 35104ce42935e40f1cbdb66cfc7d2191a4e9a9f7 Mon Sep 17 00:00:00 2001
From: Leendert de Borst <ldeborst@xivisoft.com>
Date: Sun, 28 Jul 2024 16:19:34 +0200
Subject: [PATCH] Do not run admin and client tests in parallel as it causes
 issues with the in-memory SQLite db (#126)

---
 .github/workflows/dotnet-e2e-tests.yml        |  8 ++-
 .../Components/WorkerStatus/Services.razor    | 54 ++++++++++++-------
 src/AliasVault.Admin/Program.cs               |  3 +-
 src/AliasVault.Api/Program.cs                 |  1 -
 .../Tests/Admin/AuthTests.cs                  |  1 +
 .../Tests/Admin/EmailLogTests.cs              |  1 +
 .../Tests/Client/ApiLoggingTest.cs            |  1 +
 .../Tests/Client/AuthTests.cs                 |  1 +
 .../Tests/Client/CredentialTests.cs           |  1 +
 .../Tests/Client/DbPersistTest.cs             |  1 +
 .../Tests/Client/DbUpgradeTest.cs             |  1 +
 .../Tests/Client/JwtTokenTests.cs             |  1 +
 .../Tests/Client/UnlockTests.cs               |  1 +
 13 files changed, 52 insertions(+), 23 deletions(-)

diff --git a/.github/workflows/dotnet-e2e-tests.yml b/.github/workflows/dotnet-e2e-tests.yml
index 0bf12ce37..58cdeffb2 100644
--- a/.github/workflows/dotnet-e2e-tests.yml
+++ b/.github/workflows/dotnet-e2e-tests.yml
@@ -25,5 +25,9 @@ jobs:
       run: dotnet build
     - name: Ensure browsers are installed
       run: pwsh src/Tests/AliasVault.E2ETests/bin/Debug/net8.0/playwright.ps1 install --with-deps
-    - name: Run E2E tests
-      run: dotnet test src/Tests/AliasVault.E2ETests --no-build --verbosity normal
+    - name: Run AdminTests
+      run: dotnet test src/Tests/AliasVault.E2ETests --no-build --verbosity normal --filter "Category=AdminTests"
+    - name: Run ClientTests
+      run: dotnet test src/Tests/AliasVault.E2ETests --no-build --verbosity normal --filter "Category=ClientTests"
+    - name: Run remaining tests
+      run: dotnet test src/Tests/AliasVault.E2ETests --no-build --verbosity normal --filter "Category!=AdminTests&Category!=ClientTests"
diff --git a/src/AliasVault.Admin/Main/Components/WorkerStatus/Services.razor b/src/AliasVault.Admin/Main/Components/WorkerStatus/Services.razor
index 08b83ff58..df040bbaf 100644
--- a/src/AliasVault.Admin/Main/Components/WorkerStatus/Services.razor
+++ b/src/AliasVault.Admin/Main/Components/WorkerStatus/Services.razor
@@ -1,6 +1,5 @@
 @using AliasVault.WorkerStatus.Database
 @inherits MainBase
-@implements IDisposable
 
 <button @onclick="SmtpClick"
         class="@GetSmtpButtonClasses() mx-3 inline-flex items-center justify-center rounded-xl px-8 py-2 text-white"
@@ -19,10 +18,10 @@
 @code {
     private List<WorkerServiceStatus> ServiceStatus = [];
     private bool InitInProgress;
-
     private bool SmtpStatus;
     private bool SmtpPending;
     private DateTime LastHeartbeat;
+    private readonly SemaphoreSlim InitLock = new(1, 1);
 
     /// <summary>
     /// The interval in milliseconds for refreshing the service status.
@@ -37,10 +36,10 @@
     /// <inheritdoc />
     protected override async Task OnAfterRenderAsync(bool firstRender)
     {
+        await base.OnAfterRenderAsync(firstRender);
+
         if (firstRender)
         {
-            await InitPage();
-
             Timer = new Timer(async _ =>
             {
                 await InitPage();
@@ -132,27 +131,46 @@
             return;
         }
 
-        if (!SmtpPending)
+        try
         {
-            InitInProgress = true;
-            var dbContext = await DbContextFactory.CreateDbContextAsync();
-            ServiceStatus = await dbContext.WorkerServiceStatuses.ToListAsync();
-            // Service status checks if the status is "Started" and was lastAlive
-            // (so actually reported itself) in the last 5 minutes.
-            var smtpEntry = ServiceStatus.Find(x => x.ServiceName == "AliasVault.SmtpService");
-            if (smtpEntry != null)
+            await InitLock.WaitAsync();
+
+            if (InitInProgress)
             {
-                LastHeartbeat = smtpEntry.Heartbeat;
-                SmtpStatus = IsHeartbeatValid() && smtpEntry.CurrentStatus == "Started";
+                return;
             }
 
-            InitInProgress = false;
+            if (!SmtpPending)
+            {
+                InitInProgress = true;
 
-            await InvokeAsync(() => StateHasChanged());
+                try
+                {
+                    InitInProgress = true;
+                    var dbContext = await DbContextFactory.CreateDbContextAsync();
+                    ServiceStatus = await dbContext.WorkerServiceStatuses.ToListAsync();
+                    // Service status checks if the status is "Started" and was lastAlive
+                    // (so actually reported itself) in the last 5 minutes.
+                    var smtpEntry = ServiceStatus.Find(x => x.ServiceName == "AliasVault.SmtpService");
+                    if (smtpEntry != null)
+                    {
+                        LastHeartbeat = smtpEntry.Heartbeat;
+                        SmtpStatus = IsHeartbeatValid() && smtpEntry.CurrentStatus == "Started";
+                    }
+
+                    InitInProgress = false;
+
+                    await InvokeAsync(() => StateHasChanged());
+                }
+                finally
+                {
+                    InitInProgress = false;
+                }
+            }
         }
-        else
+        finally
         {
-            // Service status changing in progress, don't issue parallel requests..
+            InitLock.Release();
         }
     }
 
diff --git a/src/AliasVault.Admin/Program.cs b/src/AliasVault.Admin/Program.cs
index 3c6dd3860..449367a8a 100644
--- a/src/AliasVault.Admin/Program.cs
+++ b/src/AliasVault.Admin/Program.cs
@@ -114,8 +114,7 @@ app.MapRazorComponents<App>()
 using (var scope = app.Services.CreateScope())
 {
     var container = scope.ServiceProvider;
-    var db = container.GetRequiredService<AliasServerDbContext>();
-
+    var db = await container.GetRequiredService<IDbContextFactory<AliasServerDbContext>>().CreateDbContextAsync();
     await db.Database.MigrateAsync();
 
     await StartupTasks.CreateRolesIfNotExist(scope.ServiceProvider);
diff --git a/src/AliasVault.Api/Program.cs b/src/AliasVault.Api/Program.cs
index 47478f1a6..0566d5657 100644
--- a/src/AliasVault.Api/Program.cs
+++ b/src/AliasVault.Api/Program.cs
@@ -182,7 +182,6 @@ using (var scope = app.Services.CreateScope())
 {
     var container = scope.ServiceProvider;
     var db = await container.GetRequiredService<IDbContextFactory<AliasServerDbContext>>().CreateDbContextAsync();
-
     await db.Database.MigrateAsync();
 }
 
diff --git a/src/Tests/AliasVault.E2ETests/Tests/Admin/AuthTests.cs b/src/Tests/AliasVault.E2ETests/Tests/Admin/AuthTests.cs
index c0ff39567..4e0a64a06 100644
--- a/src/Tests/AliasVault.E2ETests/Tests/Admin/AuthTests.cs
+++ b/src/Tests/AliasVault.E2ETests/Tests/Admin/AuthTests.cs
@@ -11,6 +11,7 @@ namespace AliasVault.E2ETests.Tests.Admin;
 /// End-to-end tests for authentication.
 /// </summary>
 [Parallelizable(ParallelScope.Self)]
+[Category("AdminTests")]
 [TestFixture]
 public class AuthTests : AdminPlaywrightTest
 {
diff --git a/src/Tests/AliasVault.E2ETests/Tests/Admin/EmailLogTests.cs b/src/Tests/AliasVault.E2ETests/Tests/Admin/EmailLogTests.cs
index 546b8f0c9..0317b5685 100644
--- a/src/Tests/AliasVault.E2ETests/Tests/Admin/EmailLogTests.cs
+++ b/src/Tests/AliasVault.E2ETests/Tests/Admin/EmailLogTests.cs
@@ -11,6 +11,7 @@ namespace AliasVault.E2ETests.Tests.Admin;
 /// End-to-end tests for email log feature.
 /// </summary>
 [Parallelizable(ParallelScope.Self)]
+[Category("AdminTests")]
 [TestFixture]
 public class EmailLogTests : AdminPlaywrightTest
 {
diff --git a/src/Tests/AliasVault.E2ETests/Tests/Client/ApiLoggingTest.cs b/src/Tests/AliasVault.E2ETests/Tests/Client/ApiLoggingTest.cs
index 59b5a1b01..feb2f715c 100644
--- a/src/Tests/AliasVault.E2ETests/Tests/Client/ApiLoggingTest.cs
+++ b/src/Tests/AliasVault.E2ETests/Tests/Client/ApiLoggingTest.cs
@@ -13,6 +13,7 @@ using Microsoft.EntityFrameworkCore;
 /// End-to-end tests for making sure errors and warnings in API are logged to database.
 /// </summary>
 [TestFixture]
+[Category("ClientTests")]
 [NonParallelizable]
 public class ApiLoggingTest : ClientPlaywrightTest
 {
diff --git a/src/Tests/AliasVault.E2ETests/Tests/Client/AuthTests.cs b/src/Tests/AliasVault.E2ETests/Tests/Client/AuthTests.cs
index 94ee84207..a437d4a3e 100644
--- a/src/Tests/AliasVault.E2ETests/Tests/Client/AuthTests.cs
+++ b/src/Tests/AliasVault.E2ETests/Tests/Client/AuthTests.cs
@@ -11,6 +11,7 @@ namespace AliasVault.E2ETests.Tests.Client;
 /// End-to-end tests for authentication.
 /// </summary>
 [Parallelizable(ParallelScope.Self)]
+[Category("ClientTests")]
 [TestFixture]
 public class AuthTests : ClientPlaywrightTest
 {
diff --git a/src/Tests/AliasVault.E2ETests/Tests/Client/CredentialTests.cs b/src/Tests/AliasVault.E2ETests/Tests/Client/CredentialTests.cs
index b339b4c8c..2337b22f8 100644
--- a/src/Tests/AliasVault.E2ETests/Tests/Client/CredentialTests.cs
+++ b/src/Tests/AliasVault.E2ETests/Tests/Client/CredentialTests.cs
@@ -11,6 +11,7 @@ namespace AliasVault.E2ETests.Tests.Client;
 /// End-to-end tests for the credential management.
 /// </summary>
 [TestFixture]
+[Category("ClientTests")]
 [Parallelizable(ParallelScope.Self)]
 public class CredentialTests : ClientPlaywrightTest
 {
diff --git a/src/Tests/AliasVault.E2ETests/Tests/Client/DbPersistTest.cs b/src/Tests/AliasVault.E2ETests/Tests/Client/DbPersistTest.cs
index 756030055..b3ae1153f 100644
--- a/src/Tests/AliasVault.E2ETests/Tests/Client/DbPersistTest.cs
+++ b/src/Tests/AliasVault.E2ETests/Tests/Client/DbPersistTest.cs
@@ -11,6 +11,7 @@ namespace AliasVault.E2ETests.Tests.Client;
 /// End-to-end tests for the client database persistence.
 /// </summary>
 [TestFixture]
+[Category("ClientTests")]
 [NonParallelizable]
 public class DbPersistTest : ClientPlaywrightTest
 {
diff --git a/src/Tests/AliasVault.E2ETests/Tests/Client/DbUpgradeTest.cs b/src/Tests/AliasVault.E2ETests/Tests/Client/DbUpgradeTest.cs
index 12dfe6620..6239b7ce0 100644
--- a/src/Tests/AliasVault.E2ETests/Tests/Client/DbUpgradeTest.cs
+++ b/src/Tests/AliasVault.E2ETests/Tests/Client/DbUpgradeTest.cs
@@ -13,6 +13,7 @@ using AliasServerDb;
 /// End-to-end tests for upgrading client databases.
 /// </summary>
 [TestFixture]
+[Category("ClientTests")]
 [NonParallelizable]
 public class DbUpgradeTest : ClientPlaywrightTest
 {
diff --git a/src/Tests/AliasVault.E2ETests/Tests/Client/JwtTokenTests.cs b/src/Tests/AliasVault.E2ETests/Tests/Client/JwtTokenTests.cs
index e0fd9ffc0..c34ca205c 100644
--- a/src/Tests/AliasVault.E2ETests/Tests/Client/JwtTokenTests.cs
+++ b/src/Tests/AliasVault.E2ETests/Tests/Client/JwtTokenTests.cs
@@ -11,6 +11,7 @@ namespace AliasVault.E2ETests.Tests.Client;
 /// End-to-end tests for JWT token handling.
 /// </summary>
 [Parallelizable(ParallelScope.Self)]
+[Category("ClientTests")]
 [TestFixture]
 public class JwtTokenTests : ClientPlaywrightTest
 {
diff --git a/src/Tests/AliasVault.E2ETests/Tests/Client/UnlockTests.cs b/src/Tests/AliasVault.E2ETests/Tests/Client/UnlockTests.cs
index 437dfcf97..e8c300368 100644
--- a/src/Tests/AliasVault.E2ETests/Tests/Client/UnlockTests.cs
+++ b/src/Tests/AliasVault.E2ETests/Tests/Client/UnlockTests.cs
@@ -11,6 +11,7 @@ namespace AliasVault.E2ETests.Tests.Client;
 /// End-to-end tests for the database unlock functionality.
 /// </summary>
 [Parallelizable(ParallelScope.Self)]
+[Category("ClientTests")]
 [TestFixture]
 public class UnlockTests : ClientPlaywrightTest
 {