Run wizard on update to guide users to reset settings (#1763)

* run wizard on update to guide users to reset settings Reason: when we change a setting for a reason and users still use the old option because it is not reset because it can be extrapolated which may cause issues ask users to rerun wizard to reset them * add reset settings page
alvr-org · Aug 2, 2023 · 586a262 · 586a262
1 parent b1be8db
commit 586a262
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 10 deletions.
diff --git a/alvr/dashboard/src/dashboard/components/setup_wizard.rs b/alvr/dashboard/src/dashboard/components/setup_wizard.rs
@@ -1,4 +1,5 @@
 use alvr_packets::{FirewallRulesAction, ServerRequest};
+use alvr_session::SessionConfig;
 use eframe::{
     egui::{Button, Label, Layout, RichText, Ui},
     emath::Align,
@@ -12,22 +13,24 @@ pub enum SetupWizardRequest {
 #[derive(Clone, Copy, PartialEq, Eq)]
 enum Page {
     Welcome = 0,
-    HardwareRequirements = 1,
-    SoftwareRequirements = 2,
-    Firewall = 3,
+    ResetSettings = 1,
+    HardwareRequirements = 2,
+    SoftwareRequirements = 3,
+    Firewall = 4,
     // PerformancePreset,
-    Recommendations = 4,
-    Finished = 5,
+    Recommendations = 5,
+    Finished = 6,
 }
 
 fn index_to_page(index: usize) -> Page {
     match index {
         0 => Page::Welcome,
-        1 => Page::HardwareRequirements,
-        2 => Page::SoftwareRequirements,
-        3 => Page::Firewall,
-        4 => Page::Recommendations,
-        5 => Page::Finished,
+        1 => Page::ResetSettings,
+        2 => Page::HardwareRequirements,
+        3 => Page::SoftwareRequirements,
+        4 => Page::Firewall,
+        5 => Page::Recommendations,
+        6 => Page::Finished,
         _ => unreachable!(),
     }
 }
@@ -89,6 +92,18 @@ impl SetupWizard {
                 "",
                 |_| (),
             ),
+            Page::ResetSettings => page_content(
+                ui,
+                "Reset Settings",
+                "It is recommended to reset your settings everytime you update ALVR.",
+                |ui| {
+                    if ui.button("Reset Settings").clicked() {
+                        request = Some(SetupWizardRequest::ServerRequest(
+                            ServerRequest::UpdateSession(Box::new(SessionConfig::default())),
+                        ));
+                    }
+                },
+            ),
             Page::HardwareRequirements => page_content(
                 ui,
                 "Hardware requirements",

diff --git a/alvr/dashboard/src/main.rs b/alvr/dashboard/src/main.rs
@@ -52,6 +52,7 @@ fn main() {
             let mut session_ref = data_manager.session_mut();
             session_ref.server_version = ALVR_VERSION.clone();
             session_ref.client_connections.clear();
+            session_ref.session_settings.open_setup_wizard = true;
         }
 
         if data_manager