feat: Better auto migrations, feat: Added migration for pre-0.9.0 (#512)

chore: Add 'stopped' podman status

chore: remove 'performedComposeMigrations' from WinboatConfigObj

Co-authored-by: Tibix <[email protected]>

Author: Levev

src/renderer/App.vue

@@ -158,12 +158,13 @@ import { routes } from "./router";
 import { Icon } from "@iconify/vue";
 import { onMounted, onUnmounted, ref, useTemplateRef, watch } from "vue";
 import { isInstalled } from "./lib/install";
-import { Winboat, logger } from "./lib/winboat";
+import { Winboat } from "./lib/winboat";
 import { openAnchorLink } from "./utils/openLink";
 import { WinboatConfig } from "./lib/config";
 import { USBManager } from "./lib/usbmanager";
 import { setIntervalImmediately } from "./utils/interval";
-import { CommonPorts, ContainerRuntimes, getActiveHostPort } from "./lib/containers/common";
+import { CommonPorts, getActiveHostPort } from "./lib/containers/common";
+import { performAutoMigrations } from "./lib/migrate";
 const { BrowserWindow }: typeof import("@electron/remote") = require("@electron/remote");
 const os: typeof import("os") = require("node:os");
 
@@ -191,35 +192,11 @@ onMounted(async () => {
         winboat = Winboat.getInstance(); // Instantiate singleton class
         USBManager.getInstance(); // Instantiate singleton class
 
-        // Avoid performing migrations under podman
-        if(wbConfig.config.containerRuntime === ContainerRuntimes.PODMAN) {
-            wbConfig.config.performedComposeMigrations = true;
-        }
-
-        // Perform migrations under docker
-        if (!wbConfig.config.performedComposeMigrations) {
-            $router.push("/migration");
-            logger.info("Performing migrations for 0.9.0");
-
-            // Compose migration
-            if (await winboat.containerMgr!.exists()) {
-                logger.info("Composing down current WinBoat container");
-                await winboat.containerMgr!.compose("down");
-            }
-
-            const currentCompose = Winboat.readCompose(winboat.containerMgr!.composeFilePath);
-            const defaultCompose = winboat.containerMgr!.defaultCompose;
-
-            currentCompose.services.windows.ports = defaultCompose.services.windows.ports;
-
-            winboat.containerMgr!.writeCompose(currentCompose);
-
-            logger.info("Composing up WinBoat container");
-            await winboat.containerMgr!.compose("up", ["--no-start"]);
-
-            wbConfig!.config.performedComposeMigrations = true;
-        }
+        // Migrations
+        $router.push("/migration");
+        await performAutoMigrations();
 
+        // After migrations, go to home
         $router.push("/home");
     } else {
         console.log("Not installed, redirecting to setup...");

src/renderer/lib/config.ts

@@ -63,7 +63,6 @@ export type WinboatConfigObj = {
     rdpArgs: RdpArg[];
     disableAnimations: boolean;
     containerRuntime: ContainerRuntimes;
-    performedComposeMigrations: boolean;
     versionData: WinboatVersionData;
 };
 
@@ -83,7 +82,6 @@ const defaultConfig: WinboatConfigObj = {
     disableAnimations: false,
     // TODO: Ideally should be podman once we flesh out everything
     containerRuntime: ContainerRuntimes.DOCKER,
-    performedComposeMigrations: false,
     versionData: {
         previous: currentVersion, // As of 0.9.0 this won't exist on the filesystem, so we just set it to the current version
         current: currentVersion

src/renderer/lib/containers/podman.ts

@@ -142,6 +142,7 @@ export class PodmanContainer extends ContainerManager {
             initialized: ContainerStatus.UNKNOWN,
             removing: ContainerStatus.UNKNOWN,
             stopping: ContainerStatus.EXITED,
+            stopped: ContainerStatus.EXITED,
             running: ContainerStatus.RUNNING,
             paused: ContainerStatus.PAUSED,
             exited: ContainerStatus.EXITED,

src/renderer/lib/install.ts

@@ -309,6 +309,7 @@ export class InstallManager {
         } catch (e) {
             this.changeState(InstallStates.INSTALL_ERROR);
             logger.error("Errors encountered, could not complete the installation steps.");
+            logger.error(e);
             return;
         }
         this.changeState(InstallStates.COMPLETED);

src/renderer/lib/migrate.ts

@@ -0,0 +1,61 @@
+import { createLogger } from "../utils/log";
+import { WinboatConfig } from "./config";
+import { WINBOAT_DIR } from "./constants";
+import { CommonPorts, createContainer, getActiveHostPort } from "./containers/common";
+import { ContainerManager } from "./containers/container";
+import { Winboat } from "./winboat";
+
+const path: typeof import("path") = require("path");
+const logger = createLogger(path.join(WINBOAT_DIR, "migrations.log"));
+
+/**
+ * This function performs the necessary automatic migrations
+ * when updating to newer versions of WinBoat
+ */
+export async function performAutoMigrations(): Promise<void> {
+    logger.info("[performAutoMigrations]: Starting automatic migrations");
+
+    const wbConfig = WinboatConfig.getInstance(); // Get WinboatConfig instance
+    const containerManager = createContainer(wbConfig.config.containerRuntime);
+    
+    try {
+        // In case of a version prior to 0.9.0, the NoVNC port will be set to the default 8006
+        // which is how we know we need to perform the migration, because from 0.9.0 we can rely
+        // on the stored version strings
+        if (getActiveHostPort(containerManager, CommonPorts.NOVNC) === CommonPorts.NOVNC) {
+            await migrateComposePorts_Pre090(containerManager);
+        }
+    }
+    catch (e: any) {
+        logger.error("[performAutoMigrations]: Automatic migrations failed");
+        logger.error(e.message ?? e);
+        return;
+    }
+
+    logger.info("[performAutoMigrations]: Finished automatic migrations");
+}
+
+/**
+ * Perform compose port migrations for pre-0.9.0 installations
+ */
+async function migrateComposePorts_Pre090(containerManager: ContainerManager): Promise<void> {
+    logger.info("[migrateComposePorts_Pre090]: Performing migrations for 0.9.0");
+
+    // Compose migration
+    if (await containerManager.exists()) {
+        logger.info("[migrateComposePorts_Pre090]: Composing down current WinBoat container");
+        await containerManager.compose("down");
+    }
+
+    const currentCompose = Winboat.readCompose(containerManager.composeFilePath);
+    const defaultCompose = containerManager.defaultCompose;
+
+    currentCompose.services.windows.ports = defaultCompose.services.windows.ports;
+    currentCompose.services.windows.image = defaultCompose.services.windows.image;
+    currentCompose.services.windows.environment["USER_PORTS"] = defaultCompose.services.windows.environment["USER_PORTS"];
+
+    containerManager.writeCompose(currentCompose);
+
+    logger.info("[migrateComposePorts_Pre090]: Composing up WinBoat container");
+    await containerManager.compose("up", ["--no-start"]);
+}