feat: add deep link for exam-environment (#59)

* feat: add deep link for exam-environment

* feat: maybe macos support?

Author: ShaunSHamilton

package.json

@@ -1,7 +1,7 @@
 {
   "name": "exam-env",
   "private": true,
-  "version": "0.8.0",
+  "version": "0.9.0",
   "type": "module",
   "scripts": {
     "prisma": "prisma",
@@ -21,6 +21,7 @@
     "@tanstack/react-query": "5.87.4",
     "@tanstack/react-router": "1.131.41",
     "@tauri-apps/api": "2.8.0",
+    "@tauri-apps/plugin-deep-link": "~2",
     "@tauri-apps/plugin-dialog": "2.4.0",
     "@tauri-apps/plugin-http": "2.5.2",
     "@tauri-apps/plugin-log": "2.7.0",

pnpm-lock.yaml

@@ -1,6 +1,6 @@
 [package]
 name = "exam-env"
-version = "0.8.0"
+version = "0.9.0"
 description = "Exam environment for freeCodeCamp"
 authors = ["freeCodeCamp"]
 edition = "2021"
@@ -29,6 +29,8 @@ time = "0.3.44"
 tauri-plugin-log = "2"
 tracing = "0.1.41"
 tracing-subscriber = { version = "0.3.20", features = ["env-filter"] }
+tauri-plugin-deep-link = "2"
 
 [target.'cfg(not(any(target_os = "android", target_os = "ios")))'.dependencies]
+tauri-plugin-single-instance = { version = "2", features = ["deep-link"] }
 tauri-plugin-updater = "2.9.0"

src-tauri/Cargo.lock

@@ -6,5 +6,16 @@
 	<string>Request microphone access for WebRTC</string>
 	<key>ITSAppUsesNonExemptEncryption</key>
 	<false/>
+  <key>CFBundleURLTypes</key>
+  <array>
+    <dict>
+      <key>CFBundleURLName</key>
+      <string>org.freecodecamp.exam</string>
+      <key>CFBundleURLSchemes</key>
+      <array>
+        <string>exam-environment</string>
+      </array>
+    </dict>
+  </array>
 </dict>
 </plist>

src-tauri/Cargo.toml

@@ -1,6 +1,10 @@
 // Prevents additional console window on Windows in release, DO NOT REMOVE!!
 #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
 
+use tauri::Manager;
+#[cfg(debug_assertions)]
+#[cfg(desktop)]
+use tauri_plugin_deep_link::DeepLinkExt;
 use tracing::info;
 use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
 use utils::valid_sentry_dsn;
@@ -71,6 +75,22 @@ fn main() {
     );
 
     tauri::Builder::default()
+        .plugin(tauri_plugin_deep_link::init())
+        // Ensure only one window of the app may be open at a time.
+        .plugin(tauri_plugin_single_instance::init(|app, _argv, _cwd| {
+            // NOTE: `argv` is ordinarily double-checked for CSRF for runtime-registered deep links.
+            //       However, deep links are only registered during runtime for development.
+            // println!("a new app instance was opened with {argv:?} and the deep link event was already triggered");
+            // If app is already open, focus window when deep link is triggered
+            let _ = app
+                .get_webview_window("main")
+                .expect("no main window")
+                .set_focus();
+            // let callback_url = argv.get(1)
+            //     .expect("no callback URL")
+            //     .to_string();
+            // app.emit("auth0-redirect", callback_url).expect("failed to emit deep link event");
+        }))
         .plugin(tauri_plugin_log::Builder::new().skip_logger().build())
         .plugin(tauri_plugin_opener::init())
         .plugin(tauri_plugin_http::init())
@@ -86,6 +106,22 @@ fn main() {
             commands::check,
         ])
         .manage(sentry_state)
+        .setup(|app| {
+            // Deep Link for app is registered during runtime as well as install,
+            // because this is the only way to use deep links during development.
+            #[cfg(desktop)]
+            #[cfg(debug_assertions)]
+            app.deep_link().register("exam-environment")?;
+
+            #[cfg(target_os = "macos")]
+            {
+                log::trace!("hiding Dock icon on macOS");
+                app.set_activation_policy(tauri::ActivationPolicy::Accessory);
+                log::trace!("Dock icon should be hidden now");
+            }
+
+            Ok(())
+        })
         .run(tauri::generate_context!())
         .expect("error while running tauri application");
 }

src-tauri/Info.plist

@@ -1,6 +1,6 @@
 {
   "productName": "Exam Environment",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "identifier": "org.freecodecamp.exam",
   "build": {
     "beforeDevCommand": "pnpm run dev",
@@ -51,6 +51,13 @@
     }
   },
   "plugins": {
+    "deep-link": {
+      "desktop": {
+        "schemes": [
+          "exam-environment"
+        ]
+      }
+    },
     "updater": {
       "pubkey": "dW50cnVzdGVkIGNvbW1lbnQ6IG1pbmlzaWduIHB1YmxpYyBrZXk6IDQwMkZBRkI4MUY5QzZBQzQKUldURWFwd2Z1Szh2UU81ZmVJenNsTXpSQURMbUFqaDF1Rm1WOG9XUEJxYUxxa1RLalRtVm5DVVkK",
       "endpoints": [

src-tauri/src/main.rs

@@ -36,6 +36,13 @@
     "windows": null
   },
   "plugins": {
+    "deep-link": {
+      "desktop": {
+        "schemes": [
+          "exam-environment"
+        ]
+      }
+    },
     "updater": {
       "pubkey": "dW50cnVzdGVkIGNvbW1lbnQ6IG1pbmlzaWduIHB1YmxpYyBrZXk6IERBMEZDMUIzMTc4N0E1NTMKUldSVHBZY1hzOEVQMnEydTAzSFNQOWxjelRMdHJ1SmZwVy9vNnJ0bmVtSU1LTFFFZzhsRlZ0UmEK",
       "endpoints": [