Merge pull request #1681 from CapSoftware/desktop-onboarding

New desktop onboarding experience

Author: richiemcilroy

apps/desktop/src-tauri/src/general_settings.rs

@@ -149,6 +149,8 @@ pub struct GeneralSettingsStore {
     pub camera_window_position: Option<WindowPosition>,
     #[serde(default)]
     pub camera_window_positions_by_monitor_name: BTreeMap<String, WindowPosition>,
+    #[serde(default = "default_true")]
+    pub has_completed_onboarding: bool,
 }
 
 fn default_enable_native_camera_preview() -> bool {
@@ -229,6 +231,7 @@ impl Default for GeneralSettingsStore {
             main_window_position: None,
             camera_window_position: None,
             camera_window_positions_by_monitor_name: BTreeMap::new(),
+            has_completed_onboarding: false,
         }
     }
 }

apps/desktop/src-tauri/src/lib.rs

@@ -638,6 +638,15 @@ async fn set_camera_input(
     drop(app);
 
     if id == current_id && camera_in_use {
+        if id.is_some() && !skip_camera_window.unwrap_or(false) {
+            let show_result = ShowCapWindow::Camera { centered: false }
+                .show(&app_handle)
+                .await;
+            show_result
+                .map_err(|err| error!("Failed to show camera preview window: {err}"))
+                .ok();
+        }
+
         return Ok(());
     }
 
@@ -2693,16 +2702,19 @@ async fn reset_camera_permissions(_app: AppHandle) -> Result<(), String> {
 
 #[tauri::command]
 #[specta::specta]
-#[instrument(skip(app))]
-async fn reset_microphone_permissions(app: AppHandle) -> Result<(), ()> {
-    let bundle_id = app.config().identifier.clone();
+#[instrument(skip(_app))]
+async fn reset_microphone_permissions(_app: AppHandle) -> Result<(), String> {
+    #[cfg(target_os = "macos")]
+    {
+        let bundle_id = _app.config().identifier.clone();
 
-    Command::new("tccutil")
-        .arg("reset")
-        .arg("Microphone")
-        .arg(bundle_id)
-        .output()
-        .expect("Failed to reset microphone permissions");
+        Command::new("tccutil")
+            .arg("reset")
+            .arg("Microphone")
+            .arg(bundle_id)
+            .output()
+            .map_err(|_| "Failed to reset microphone permissions".to_string())?;
+    }
 
     Ok(())
 }
@@ -3336,7 +3348,7 @@ pub async fn run(recording_logging_handle: LoggingHandle, logs_dir: PathBuf) {
                     flags
                 })
                 .with_denylist(&[
-                    CapWindowId::Setup.label().as_str(),
+                    CapWindowId::Onboarding.label().as_str(),
                     CapWindowId::Main.label().as_str(),
                     "window-capture-occluder",
                     "target-select-overlay",
@@ -3501,18 +3513,24 @@ pub async fn run(recording_logging_handle: LoggingHandle, logs_dir: PathBuf) {
             tokio::spawn({
                 let app = app.clone();
                 async move {
-                    if !permissions.screen_recording.permitted()
-                        || !permissions.accessibility.permitted()
-                        || GeneralSettingsStore::get(&app)
-                            .ok()
-                            .flatten()
-                            .map(|s| !s.has_completed_startup)
-                            .unwrap_or(false)
+                    let settings = GeneralSettingsStore::get(&app).ok().flatten();
+                    let startup_completed = settings
+                        .as_ref()
+                        .map(|s| s.has_completed_startup)
+                        .unwrap_or(false);
+                    let onboarding_completed = settings
+                        .as_ref()
+                        .map(|s| s.has_completed_onboarding)
+                        .unwrap_or(false);
+
+                    if !startup_completed
+                        || !onboarding_completed
+                        || !permissions.necessary_granted()
                     {
-                        let _ = ShowCapWindow::Setup.show(&app).await;
+                        println!("Showing onboarding");
+                        let _ = ShowCapWindow::Onboarding.show(&app).await;
                     } else {
-                        println!("Permissions granted, showing main window");
-
+                        println!("Showing main window");
                         let _ = ShowCapWindow::Main {
                             init_target_mode: None,
                         }
@@ -3864,12 +3882,18 @@ pub async fn run(recording_logging_handle: LoggingHandle, logs_dir: PathBuf) {
         .run(move |_handle, event| match event {
             #[cfg(target_os = "macos")]
             tauri::RunEvent::Reopen { .. } => {
+                if let Some(onboarding) = CapWindowId::Onboarding.get(_handle) {
+                    onboarding.show().ok();
+                    onboarding.set_focus().ok();
+                    return;
+                }
+
                 let has_window = _handle.webview_windows().iter().any(|(label, _)| {
                     label.starts_with("editor-")
                         || label.starts_with("screenshot-editor-")
                         || label.as_str() == "settings"
                         || label.as_str() == "signin"
-                        || label.as_str() == "setup"
+                        || label.as_str() == "onboarding"
                 });
 
                 if has_window {
@@ -3881,7 +3905,7 @@ pub async fn run(recording_logging_handle: LoggingHandle, logs_dir: PathBuf) {
                                 || label.starts_with("screenshot-editor-")
                                 || label.as_str() == "settings"
                                 || label.as_str() == "signin"
-                                || label.as_str() == "setup"
+                                || label.as_str() == "onboarding"
                         })
                         .map(|(_, window)| window.clone())
                     {

apps/desktop/src-tauri/src/tray.rs

@@ -330,8 +330,8 @@ fn get_current_mode(app: &AppHandle) -> RecordingMode {
         .unwrap_or_default()
 }
 
-fn is_setup_window_open(app: &AppHandle) -> bool {
-    app.webview_windows().contains_key("setup")
+fn is_onboarding_window_open(app: &AppHandle) -> bool {
+    app.webview_windows().contains_key("onboarding")
 }
 
 fn create_mode_submenu(app: &AppHandle) -> tauri::Result<Submenu<tauri::Wry>> {
@@ -365,7 +365,7 @@ fn create_mode_submenu(app: &AppHandle) -> tauri::Result<Submenu<tauri::Wry>> {
 }
 
 fn build_tray_menu(app: &AppHandle, cache: &PreviousItemsCache) -> tauri::Result<Menu<tauri::Wry>> {
-    if is_setup_window_open(app) {
+    if is_onboarding_window_open(app) {
         return Menu::with_items(
             app,
             &[
@@ -809,7 +809,7 @@ pub fn create_tray(app: &AppHandle) -> tauri::Result<()> {
                 Ok(TrayItem::RequestPermissions) => {
                     let app = app.clone();
                     tokio::spawn(async move {
-                        let _ = ShowCapWindow::Setup.show(&app).await;
+                        let _ = ShowCapWindow::Onboarding.show(&app).await;
                     });
                 }
                 _ => {}