Installer: Validate if the storage engine is RavenDB5 compatible

src/ServiceControl.Config/Commands/UpgradeAuditInstanceCommand.cs

@@ -1,6 +1,7 @@
 namespace ServiceControl.Config.Commands
 {
     using System;
+    using System.Diagnostics;
     using System.ServiceProcess;
     using System.Threading.Tasks;
     using Caliburn.Micro;
@@ -50,14 +51,25 @@ public override async Task ExecuteAsync(InstanceDetailsViewModel model)
             var instance = InstanceFinder.FindInstanceByName<ServiceControlAuditInstance>(model.Name);
             instance.Service.Refresh();
 
-            if (instance.PersistenceManifest.Name == "RavenDB35")
+            var compatibleStorageEngine = instance.PersistenceManifest.Name == StorageEngineNames.RavenDB5;
+
+            if (!compatibleStorageEngine)
             {
-                var docsUrl = "https://docs.particular.net/servicecontrol/upgrades/zero-downtime";
+                var upgradeGuide4to5url = "https://docs.particular.net/servicecontrol/upgrades/4to5/";
 
-                await windowManager.ShowMessage("UPGRADE NOTE",
-$@"Please note that the storage format has changed and that upgrading existing instances using RavenDB 3.5 will only be supported for a limited period of time.
+                var openUpgradeGuide = await windowManager.ShowYesNoDialog("STORAGE ENGINE INCOMPATIBLE",
+                    $"Please note that the storage format has changed and the {instance.PersistenceManifest.DisplayName} storage engine is no longer available. Upgrading requires a side-by-side deployment of both versions. Migration guidance is available in the version 4 to 5 upgrade guidance at {upgradeGuide4to5url}",
+                    "Open online ServiceControl 4 to 5 upgrade guide in system default browser?",
+                    "Yes",
+                    "No"
+                );
 
-See our zero downtime upgrade guidance, {docsUrl}, for instructions how migrate to the new storage format by adding a new audit instance.", hideCancel: true);
+                if (openUpgradeGuide)
+                {
+                    Process.Start(new ProcessStartInfo(upgradeGuide4to5url) { UseShellExecute = true });
+                }
+
+                return;
             }
 
             var upgradeInfo = UpgradeControl.GetUpgradeInfoForTargetVersion(serviceControlInstaller.ZipInfo.Version, instance.Version);

src/ServiceControl.Config/Commands/UpgradeServiceControlInstanceCommand.cs

@@ -1,6 +1,7 @@
 namespace ServiceControl.Config.Commands
 {
     using System;
+    using System.Diagnostics;
     using System.ServiceProcess;
     using System.Threading.Tasks;
     using Caliburn.Micro;
@@ -60,6 +61,27 @@ public override async Task ExecuteAsync(InstanceDetailsViewModel model)
 
             instance.Service.Refresh();
 
+            var compatibleStorageEngine = instance.PersistenceManifest.Name == StorageEngineNames.RavenDB5;
+
+            if (!compatibleStorageEngine)
+            {
+                var upgradeGuide4to5url = "https://docs.particular.net/servicecontrol/upgrades/4to5/";
+
+                var openUpgradeGuide = await windowManager.ShowYesNoDialog("STORAGE ENGINE INCOMPATIBLE",
+                    $"Please note that the storage format has changed and the {instance.PersistenceManifest.DisplayName} storage engine is no longer available. Upgrading requires a side-by-side deployment of both versions. Migration guidance is available in the version 4 to 5 upgrade guidance at {upgradeGuide4to5url}",
+                    "Open online ServiceControl 4 to 5 upgrade guide in system default browser?",
+                    "Yes",
+                    "No"
+                );
+
+                if (openUpgradeGuide)
+                {
+                    Process.Start(new ProcessStartInfo(upgradeGuide4to5url) { UseShellExecute = true });
+                }
+
+                return;
+            }
+
             var upgradeInfo = UpgradeControl.GetUpgradeInfoForTargetVersion(serviceControlInstaller.ZipInfo.Version, instance.Version);
             var upgradeOptions = new ServiceControlUpgradeOptions { UpgradeInfo = upgradeInfo };
 

src/ServiceControl.Management.PowerShell/Cmdlets/AuditInstances/InvokeAuditUpgrade.cs

@@ -36,10 +36,9 @@ protected override void ProcessRecord()
 
             foreach (var name in Name)
             {
-                var instance = InstanceFinder.FindServiceControlInstance(name);
-                if (instance == null)
+                if (InstanceFinder.FindServiceControlInstance(name) is not ServiceControlAuditInstance instance)
                 {
-                    WriteWarning($"No action taken. An instance called {name} was not found");
+                    WriteWarning($"No action taken. An audit instance called {name} was not found");
                     break;
                 }
 

src/ServiceControlInstaller.Engine/Instances/ServiceControlAuditNewInstance.cs

@@ -21,7 +21,7 @@ public static ServiceControlAuditNewInstance CreateWithDefaultPersistence()
 
         public static ServiceControlAuditNewInstance CreateWithDefaultPersistence(string deploymentCachePath)
         {
-            const string persisterToUseForBrandNewInstances = "RavenDB5";
+            const string persisterToUseForBrandNewInstances = StorageEngineNames.RavenDB5;
             return CreateWithPersistence(deploymentCachePath, persisterToUseForBrandNewInstances);
         }
 

src/ServiceControlInstaller.Engine/Instances/ServiceControlNewInstance.cs

@@ -22,7 +22,7 @@ public static ServiceControlNewInstance CreateWithDefaultPersistence()
 
         public static ServiceControlNewInstance CreateWithDefaultPersistence(string deploymentCachePath)
         {
-            const string persisterUsedForBrandNewInstances = "RavenDB5";
+            const string persisterUsedForBrandNewInstances = StorageEngineNames.RavenDB5;
             return CreateWithPersistence(deploymentCachePath, persisterUsedForBrandNewInstances);
         }
 

src/ServiceControlInstaller.Engine/Instances/StorageEngineNames.cs

@@ -0,0 +1,7 @@
+namespace ServiceControlInstaller.Engine.Instances
+{
+    public static class StorageEngineNames
+    {
+        public const string RavenDB5 = "RavenDB5";
+    }
+}

src/ServiceControlInstaller.Engine/Unattended/UnattendAuditInstaller.cs

@@ -104,8 +104,17 @@ public async Task<bool> Add(ServiceControlAuditNewInstance details, Func<PathInf
             return true;
         }
 
-        public bool Upgrade(ServiceControlBaseService instance)
+        public bool Upgrade(ServiceControlAuditInstance instance)
         {
+            var compatibleStorageEngine = instance.PersistenceManifest.Name == StorageEngineNames.RavenDB5;
+
+            if (!compatibleStorageEngine)
+            {
+                var upgradeGuide4to5url = "https://docs.particular.net/servicecontrol/upgrades/4to5/";
+                logger.Error($"Upgrade aborted. Please note that the storage format has changed and the {instance.PersistenceManifest.DisplayName} storage engine is no longer available. Upgrading requires a side-by-side deployment of both versions. Migration guidance is available in the version 4 to 5 upgrade guidance at {upgradeGuide4to5url}");
+                return false;
+            }
+
             ZipInfo.ValidateZip();
 
             var checkLicenseResult = CheckLicenseIsValid();

src/ServiceControlInstaller.Engine/Unattended/UnattendServiceControlInstaller.cs

@@ -102,6 +102,15 @@ public async Task<bool> Add(ServiceControlNewInstance details, Func<PathInfo, Ta
 
         public bool Upgrade(ServiceControlInstance instance, ServiceControlUpgradeOptions options)
         {
+            var compatibleStorageEngine = instance.PersistenceManifest.Name == StorageEngineNames.RavenDB5;
+
+            if (!compatibleStorageEngine)
+            {
+                var upgradeGuide4to5url = "https://docs.particular.net/servicecontrol/upgrades/4to5/";
+                logger.Error($"Upgrade aborted. Please note that the storage format has changed and the {instance.PersistenceManifest.DisplayName} storage engine is no longer available. Upgrading requires a side-by-side deployment of both versions. Migration guidance is available in the version 4 to 5 upgrade guidance at {upgradeGuide4to5url}");
+                return false;
+            }
+
             if (instance.Version < options.UpgradeInfo.CurrentMinimumVersion)
             {
                 logger.Error($"Upgrade aborted. An interim upgrade to version {options.UpgradeInfo.RecommendedUpgradeVersion} is required before upgrading to version {ZipInfo.Version}. Download available at https://github.com/Particular/ServiceControl/releases/tag/{options.UpgradeInfo.RecommendedUpgradeVersion}");