Make database version check more reliable on API install (#284)

Author: johnstairs

cli/internal/install/cloudinstall/helm.go

@@ -481,23 +481,29 @@ func (inst *Installer) InstallTyger(ctx context.Context) error {
 
 			for _, parsedLine := range parsedLines {
 				if category, ok := parsedLine["category"].(string); ok {
-					if category == "Tyger.ControlPlane.Database.Migrations.MigrationRunner[NewerDatabaseVersionsExist]" {
+					// We are accepting Tyger.ControlPlane.Database.Migrations.MigrationRunner
+					// as well for backwards compatibility.
+					switch category {
+					case "Tyger.ControlPlane.Database.Migrations.DatabaseVersions[NewerDatabaseVersionsExist]",
+						"Tyger.ControlPlane.Database.Migrations.MigrationRunner[NewerDatabaseVersionsExist]":
 						log.Ctx(ctx).Warn().Msgf("The database schema should be upgraded. Run `tyger api migrations list` to see the available migrations and `tyger api migrations apply` to apply them.")
 						found = true
-						break
-					}
 
-					if category == "Tyger.ControlPlane.Database.Migrations.MigrationRunner[UsingMostRecentDatabaseVersion]" {
+					case "Tyger.ControlPlane.Database.Migrations.DatabaseVersions[UsingMostRecentDatabaseVersion]",
+						"Tyger.ControlPlane.Database.Migrations.MigrationRunner[UsingMostRecentDatabaseVersion]":
 						log.Debug().Msg("Database schema is up to date")
 						found = true
+					}
+
+					if found {
 						break
 					}
 				}
 			}
 		}
 
 		if !found {
-			return errors.New("failed to find expected migration log message")
+			log.Warn().Msg("Unable to determine if database migrations are required")
 		}
 
 		return nil

cli/internal/install/dockerinstall/migrations.go

@@ -8,7 +8,6 @@ import (
 	"bytes"
 	"context"
 	"encoding/json"
-	"errors"
 	"fmt"
 	"io"
 	"strconv"
@@ -245,8 +244,12 @@ func (inst *Installer) initializeDatabase(ctx context.Context) error {
 	found := false
 	for _, parsedLine := range parsedLines {
 		if category, ok := parsedLine["category"].(string); ok {
+			// We are accepting Tyger.ControlPlane.Database.Migrations.MigrationRunner
+			// as well for backwards compatibility.
+			switch category {
+			case "Tyger.ControlPlane.Database.Migrations.DatabaseVersions[DatabaseMigrationRequired]",
+				"Tyger.ControlPlane.Database.Migrations.MigrationRunner[DatabaseMigrationRequired]":
 
-			if category == "Tyger.ControlPlane.Database.Migrations.MigrationRunner[DatabaseMigrationRequired]" {
 				if message, ok := parsedLine["message"].(string); ok {
 					log.Ctx(ctx).Error().Msg(message)
 				}
@@ -256,25 +259,27 @@ func (inst *Installer) initializeDatabase(ctx context.Context) error {
 						return install.ErrAlreadyLoggedError
 					}
 				}
-			}
 
-			if category == "Tyger.ControlPlane.Database.Migrations.MigrationRunner[NewerDatabaseVersionsExist]" {
+			case "Tyger.ControlPlane.Database.Migrations.DatabaseVersions[NewerDatabaseVersionsExist]",
+				"Tyger.ControlPlane.Database.Migrations.MigrationRunner[NewerDatabaseVersionsExist]":
 				log.Ctx(ctx).Warn().Msgf("The database schema should be upgraded. Run `tyger api migrations list` to see the available migrations and `tyger api migrations apply` to apply them.")
 				found = true
-				break
-			}
 
-			if category == "Tyger.ControlPlane.Database.Migrations.MigrationRunner[UsingMostRecentDatabaseVersion]" {
+			case "Tyger.ControlPlane.Database.Migrations.DatabaseVersions[UsingMostRecentDatabaseVersion]",
+				"Tyger.ControlPlane.Database.Migrations.MigrationRunner[UsingMostRecentDatabaseVersion]":
 				log.Debug().Msg("Database schema is up to date")
 				found = true
+			}
+
+			if found {
 				break
 			}
 		}
 	}
 
 	if exitCode == 0 {
 		if !found {
-			return errors.New("failed to find expected migration log message")
+			log.Warn().Msg("Unable to determine if database migrations are required")
 		}
 		return nil
 	}

server/ControlPlane/Database/Migrations/DatabaseVersions.cs

@@ -175,18 +175,22 @@ FROM migrations
 
     public override async Task StartAsync(CancellationToken cancellationToken)
     {
+        var knownVersions = GetKnownVersions();
         while (true)
         {
             if (await DoesMigrationsTableExist(cancellationToken))
             {
                 if (await ReadAndUpdateCachedDatabaseVersion(cancellationToken))
                 {
-                    if (GetKnownVersions().FirstOrDefault(v => v.minimumSupported) is (var minimumVersion, var _, var _) && CachedCurrentVersion < minimumVersion)
+
+                    if (knownVersions.FirstOrDefault(v => v.minimumSupported) is (var minimumVersion, var _, var _) && CachedCurrentVersion < minimumVersion)
                     {
                         _logger.DatabaseMigrationRequired((int)minimumVersion, (int)CachedCurrentVersion);
                         throw new DatabaseMigrationRequiredException($"This version of Tyger requires the database to be migrated to at least version {(int)minimumVersion}. The current version is {(int)CachedCurrentVersion}.");
                     }
 
+                    await LogCurrentOrAvailableDatabaseVersions(knownVersions, cancellationToken);
+
                     break;
                 }
             }
@@ -221,6 +225,36 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
         }
     }
 
+    public async Task LogCurrentOrAvailableDatabaseVersions(List<(DatabaseVersion version, Type migrator, bool isMinimumVersion)> knownVersions, CancellationToken cancellationToken)
+    {
+        if (!await DoesMigrationsTableExist(cancellationToken))
+        {
+            return;
+        }
+
+        var currentVersion = await ReadCurrentDatabaseVersion(cancellationToken);
+        if (currentVersion == null)
+        {
+            return;
+        }
+
+        if (knownVersions.Any(kv => (int)kv.version > (int)currentVersion))
+        {
+            if (knownVersions.FirstOrDefault(v => v.isMinimumVersion) is (var minimumVersion, var _, var _) && currentVersion < minimumVersion)
+            {
+                _logger.DatabaseMigrationRequired((int)minimumVersion, (int)currentVersion);
+            }
+            else
+            {
+                _logger.NewerDatabaseVersionsExist();
+            }
+        }
+        else
+        {
+            _logger.UsingMostRecentDatabaseVersion();
+        }
+    }
+
     private async Task<bool> ReadAndUpdateCachedDatabaseVersion(CancellationToken cancellationToken)
     {
         var readVersion = await ReadCurrentDatabaseVersion(cancellationToken);

server/ControlPlane/Database/Migrations/MigrationRunner.cs

@@ -57,7 +57,7 @@ public async Task RunMigrations(bool initOnly, int? targetVersion, bool offline,
         if (current != null && initOnly)
         {
             _logger.DatabaseAlreadyInitialized();
-            await LogCurrentOrAvailableDatabaseVersions(knownVersions, cancellationToken);
+            await _databaseVersions.LogCurrentOrAvailableDatabaseVersions(knownVersions, cancellationToken);
             return;
         }
 
@@ -161,37 +161,7 @@ await migrator.Apply(_dataSource, migrationLogger, cancellationToken),
             }
         }
 
-        await LogCurrentOrAvailableDatabaseVersions(knownVersions, cancellationToken);
-    }
-
-    private async Task LogCurrentOrAvailableDatabaseVersions(List<(DatabaseVersion version, Type migrator, bool isMinimumVersion)> knownVersions, CancellationToken cancellationToken)
-    {
-        if (!await _databaseVersions.DoesMigrationsTableExist(cancellationToken))
-        {
-            return;
-        }
-
-        var currentVersion = await _databaseVersions.ReadCurrentDatabaseVersion(cancellationToken);
-        if (currentVersion == null)
-        {
-            return;
-        }
-
-        if (knownVersions.Any(kv => (int)kv.version > (int)currentVersion))
-        {
-            if (knownVersions.FirstOrDefault(v => v.isMinimumVersion) is (var minimumVersion, var _, var _) && currentVersion < minimumVersion)
-            {
-                _logger.DatabaseMigrationRequired((int)minimumVersion, (int)currentVersion);
-            }
-            else
-            {
-                _logger.NewerDatabaseVersionsExist();
-            }
-        }
-        else
-        {
-            _logger.UsingMostRecentDatabaseVersion();
-        }
+        await _databaseVersions.LogCurrentOrAvailableDatabaseVersions(knownVersions, cancellationToken);
     }
 
     private async Task GrantAccess(CancellationToken cancellationToken)