fix: prevent reaching the congratulations screen during installation

rust/agama-lib/src/manager.rs

@@ -67,6 +67,8 @@ pub enum InstallationPhase {
     Config,
     /// Installation phase.
     Install,
+    /// Finished installation phase.
+    Finish,
 }
 
 impl TryFrom<u32> for InstallationPhase {
@@ -77,6 +79,7 @@ impl TryFrom<u32> for InstallationPhase {
             0 => Ok(Self::Startup),
             1 => Ok(Self::Config),
             2 => Ok(Self::Install),
+            3 => Ok(Self::Finish),
             _ => Err(ServiceError::UnknownInstallationPhase(value)),
         }
     }

rust/package/agama.changes

@@ -1,3 +1,9 @@
+-------------------------------------------------------------------
+Fri Jan 24 09:33:31 UTC 2025 - Imobach Gonzalez Sosa <[email protected]>
+
+- Introduce a new installation phase "finish"
+  (gh#agama-project/agama#1616).
+
 -------------------------------------------------------------------
 Fri Jan 24 06:43:05 UTC 2025 - Imobach Gonzalez Sosa <[email protected]>
 

service/lib/agama/dbus/clients/manager.rb

@@ -63,6 +63,8 @@ def current_installation_phase
             InstallationPhase::CONFIG
           when DBus::Manager::INSTALL_PHASE
             InstallationPhase::INSTALL
+          when DBus::Manager::FINISH_PHASE
+            InstallationPhase::FINISH
           end
         end
 

service/lib/agama/dbus/manager.rb

@@ -58,6 +58,7 @@ def initialize(backend, logger)
       STARTUP_PHASE = 0
       CONFIG_PHASE = 1
       INSTALL_PHASE = 2
+      FINISH_PHASE = 3
 
       dbus_interface MANAGER_INTERFACE do
         dbus_method(:Probe, "") { config_phase }
@@ -111,7 +112,8 @@ def installation_phases
         [
           { "id" => STARTUP_PHASE, "label" => "startup" },
           { "id" => CONFIG_PHASE,  "label" => "config" },
-          { "id" => INSTALL_PHASE, "label" => "install" }
+          { "id" => INSTALL_PHASE, "label" => "install" },
+          { "id" => FINISH_PHASE, "label"  => "finish" }
         ]
       end
 
@@ -122,6 +124,7 @@ def current_installation_phase
         return STARTUP_PHASE if backend.installation_phase.startup?
         return CONFIG_PHASE if backend.installation_phase.config?
         return INSTALL_PHASE if backend.installation_phase.install?
+        return FINISH_PHASE if backend.installation_phase.finish?
       end
 
       # States whether installation runs on iguana

service/lib/agama/installation_phase.rb

@@ -27,6 +27,7 @@ class InstallationPhase
     STARTUP = "startup"
     CONFIG = "config"
     INSTALL = "install"
+    FINISH = "finish"
 
     def initialize
       @on_change_callbacks = []
@@ -53,6 +54,13 @@ def install?
       value == INSTALL
     end
 
+    # Whether the current installation phase value is finish
+    #
+    # @return [Boolean]
+    def finish?
+      value == FINISH
+    end
+
     # Sets the installation phase value to startup
     #
     # @note Callbacks are called.
@@ -83,6 +91,16 @@ def install
       self
     end
 
+    # Sets the installation phase value to finish
+    #
+    # @note Callbacks are called.
+    #
+    # @return [self]
+    def finish
+      change_to(FINISH)
+      self
+    end
+
     # Registers callbacks to be called when the installation phase value changes
     #
     # @param block [Proc]

service/lib/agama/manager.rb

@@ -144,6 +144,7 @@ def install_phase
       logger.error "Installation error: #{e.inspect}. Backtrace: #{e.backtrace}"
     ensure
       service_status.idle
+      installation_phase.finish
       finish_progress
     end
     # rubocop:enable Metrics/AbcSize

service/package/rubygem-agama-yast.changes

@@ -1,3 +1,9 @@
+-------------------------------------------------------------------
+Fri Jan 24 09:33:27 UTC 2025 - Imobach Gonzalez Sosa <[email protected]>
+
+- Introduce a new installation phase "finish"
+  (gh#agama-project/agama#1616).
+
 -------------------------------------------------------------------
 Fri Jan 24 06:42:00 UTC 2025 - Imobach Gonzalez Sosa <[email protected]>
 

service/test/agama/dbus/clients/manager_test.rb

@@ -99,6 +99,14 @@
         expect(subject.current_installation_phase).to eq(Agama::InstallationPhase::INSTALL)
       end
     end
+
+    context "when the current phase is finish" do
+      let(:current_phase) { Agama::DBus::Manager::FINISH_PHASE }
+
+      it "returns the install phase value" do
+        expect(subject.current_installation_phase).to eq(Agama::InstallationPhase::FINISH)
+      end
+    end
   end
 
   include_examples "service status"

service/test/agama/dbus/manager_test.rb

@@ -157,7 +157,7 @@
   describe "#installation_phases" do
     it "includes all possible values for the installation phase" do
       labels = subject.installation_phases.map { |i| i["label"] }
-      expect(labels).to contain_exactly("startup", "config", "install")
+      expect(labels).to contain_exactly("startup", "config", "install", "finish")
     end
 
     it "associates 'startup' with the id 0" do
@@ -174,6 +174,11 @@
       install = subject.installation_phases.find { |i| i["label"] == "install" }
       expect(install["id"]).to eq(described_class::INSTALL_PHASE)
     end
+
+    it "associates 'finish' with the id 3" do
+      install = subject.installation_phases.find { |i| i["label"] == "finish" }
+      expect(install["id"]).to eq(described_class::FINISH_PHASE)
+    end
   end
 
   describe "#current_installation_phase" do

service/test/agama/installation_phase_test.rb

@@ -95,6 +95,28 @@
     end
   end
 
+  describe "finish?" do
+    context "if the installation phase is finish" do
+      before do
+        subject.finish
+      end
+
+      it "returns true" do
+        expect(subject.finish?).to eq(true)
+      end
+    end
+
+    context "if the installation phase is not finish" do
+      before do
+        subject.config
+      end
+
+      it "returns false" do
+        expect(subject.finish?).to eq(false)
+      end
+    end
+  end
+
   describe "#startup" do
     it "sets the installation phase to startup" do
       subject.startup

service/test/agama/manager_test.rb

@@ -20,7 +20,7 @@
 # find current contact information at www.suse.com.
 
 require_relative "../test_helper"
-require_relative "./with_progress_examples"
+require_relative "with_progress_examples"
 require "agama/manager"
 require "agama/config"
 require "agama/issue"
@@ -115,9 +115,10 @@
   end
 
   describe "#install_phase" do
-    it "sets the installation phase to install" do
+    it "sets the installation phase to install and later to finish" do
+      expect(subject.installation_phase).to receive(:install)
       subject.install_phase
-      expect(subject.installation_phase.install?).to eq(true)
+      expect(subject.installation_phase.finish?).to eq(true)
     end
 
     it "calls #propose on proxy and software modules" do

web/package/agama-web-ui.changes

@@ -1,3 +1,9 @@
+-------------------------------------------------------------------
+Fri Jan 24 09:34:24 UTC 2025 - Imobach Gonzalez Sosa <[email protected]>
+
+- Use the "finish" to decide whether to navigate to the
+  congratulations screen (gh#agama-project/agama#1616).
+
 -------------------------------------------------------------------
 Fri Jan 24 06:43:52 UTC 2025 - Imobach Gonzalez Sosa <[email protected]>
 

web/src/App.test.tsx

@@ -203,10 +203,9 @@ describe("App", () => {
     });
   });
 
-  describe("on the busy installation phase", () => {
+  describe("on the installation phase", () => {
     beforeEach(() => {
       mockClientStatus.phase = InstallationPhase.Install;
-      mockClientStatus.isBusy = true;
       mockSelectedProduct = tumbleweed;
     });
 
@@ -216,10 +215,9 @@ describe("App", () => {
     });
   });
 
-  describe("on the idle installation phase", () => {
+  describe("on the finish phase", () => {
     beforeEach(() => {
-      mockClientStatus.phase = InstallationPhase.Install;
-      mockClientStatus.isBusy = false;
+      mockClientStatus.phase = InstallationPhase.Finish;
       mockSelectedProduct = tumbleweed;
     });
 

web/src/App.tsx

@@ -55,11 +55,11 @@ function App() {
   const Content = () => {
     if (error) return <ServerError />;
 
-    if (phase === InstallationPhase.Install && isBusy) {
+    if (phase === InstallationPhase.Install) {
       return <Navigate to={ROOT.installationProgress} />;
     }
 
-    if (phase === InstallationPhase.Install && !isBusy) {
+    if (phase === InstallationPhase.Finish) {
       return <Navigate to={ROOT.installationFinished} />;
     }
 

web/src/components/core/InstallationFinished.test.tsx

@@ -29,7 +29,7 @@ import { Encryption } from "~/api/storage/types/config";
 
 jest.mock("~/queries/status", () => ({
   ...jest.requireActual("~/queries/status"),
-  useInstallerStatus: () => ({ isBusy: false, useIguana: false, phase: 2, canInstall: false }),
+  useInstallerStatus: () => ({ isBusy: false, useIguana: false, phase: 3, canInstall: false }),
 }));
 
 type storageConfigType = "guided" | "raw";

web/src/components/core/InstallationFinished.tsx

@@ -100,17 +100,13 @@ function usingTpm(config): boolean {
 }
 
 function InstallationFinished() {
-  const { phase, isBusy, useIguana } = useInstallerStatus({ suspense: true });
+  const { phase, useIguana } = useInstallerStatus({ suspense: true });
   const config = useConfig();
 
-  if (phase !== InstallationPhase.Install) {
+  if (phase !== InstallationPhase.Finish) {
     return <Navigate to={PATHS.root} />;
   }
 
-  if (isBusy) {
-    return <Navigate to={PATHS.installationProgress} />;
-  }
-
   return (
     <Center>
       <Grid hasGutter>

web/src/components/core/InstallationProgress.test.tsx

@@ -27,15 +27,14 @@ import { InstallationPhase } from "~/types/status";
 import InstallationProgress from "./InstallationProgress";
 import { ROOT } from "~/routes/paths";
 
-let isBusy = false;
 let phase = InstallationPhase.Install;
 const mockInstallerStatusChanges = jest.fn();
 
 jest.mock("~/components/core/ProgressReport", () => () => <div>ProgressReport Mock</div>);
 
 jest.mock("~/queries/status", () => ({
   ...jest.requireActual("~/queries/status"),
-  useInstallerStatus: () => ({ isBusy, phase }),
+  useInstallerStatus: () => ({ phase }),
   useInstallerStatusChanges: () => mockInstallerStatusChanges(),
 }));
 
@@ -56,27 +55,14 @@ describe("InstallationProgress", () => {
     });
   });
 
-  describe("when installer in the installation phase and busy", () => {
+  describe("when installer in the installation phase", () => {
     beforeEach(() => {
       phase = InstallationPhase.Install;
-      isBusy = true;
     });
 
     it("renders progress report", () => {
       installerRender(<InstallationProgress />);
       screen.getByText("ProgressReport Mock");
     });
   });
-
-  describe("when installer in the installation phase but not busy", () => {
-    beforeEach(() => {
-      phase = InstallationPhase.Install;
-      isBusy = false;
-    });
-
-    it("redirect to installation finished path", async () => {
-      installerRender(<InstallationProgress />);
-      await screen.findByText(`Navigating to ${ROOT.installationFinished}`);
-    });
-  });
 });

web/src/components/core/InstallationProgress.tsx

@@ -29,17 +29,13 @@ import { Navigate } from "react-router-dom";
 import { useInstallerStatus, useInstallerStatusChanges } from "~/queries/status";
 
 function InstallationProgress() {
-  const { isBusy, phase } = useInstallerStatus({ suspense: true });
+  const { phase } = useInstallerStatus({ suspense: true });
   useInstallerStatusChanges();
 
   if (phase !== InstallationPhase.Install) {
     return <Navigate to={PATHS.root} replace />;
   }
 
-  if (!isBusy) {
-    return <Navigate to={PATHS.installationFinished} replace />;
-  }
-
   return <ProgressReport title={_("Installing the system, please wait...")} />;
 }
 

web/src/types/status.ts

@@ -27,6 +27,7 @@ enum InstallationPhase {
   Startup = 0,
   Config = 1,
   Install = 2,
+  Finish = 3,
 }
 
 /*