feat: Add updating for Linux AppImage (#410)

Author: brandonskiser

Cargo.lock

@@ -71,8 +71,10 @@ fig_request = { path = "crates/fig_request" }
 fig_settings = { path = "crates/fig_settings" }
 fig_telemetry = { path = "crates/fig_telemetry" }
 fig_telemetry_core = { path = "crates/fig_telemetry_core" }
+fig_test_utils = { path = "crates/fig_test_utils" }
 fig_util = { path = "crates/fig_util" }
 hex = "0.4.3"
+http = "1.2.0"
 indoc = "2.0.5"
 insta = "1.38.0"
 libc = "0.2.167"
@@ -108,6 +110,7 @@ reqwest = { version = "0.12.5", default-features = false, features = [
     "socks",
     "cookies",
 ] }
+ring = "0.17.8"
 shell-color = { path = "crates/shell-color" }
 semver = { version = "1.0.16", features = ["serde"] }
 serde = { version = "1.0.216", features = ["derive", "rc"] }
@@ -125,6 +128,7 @@ time = { version = "0.3.34", features = [
     "serde",
 ] }
 tokio = { version = "1.42.0", features = ["full"] }
+tokio-util = { version = "0.7.13", features = ["compat"] }
 toml = "0.8.12"
 tracing = { version = "0.1.40", features = ["log"] }
 tracing-subscriber = { version = "0.3.19", features = [

Cargo.toml

@@ -7,7 +7,9 @@
 import shutil
 from typing import Dict, List, Mapping, Sequence
 from util import (
+    Package,
     Variant,
+    enum_encoder,
     get_variants,
     isDarwin,
     isLinux,
@@ -471,6 +473,7 @@ def linux_tauri_config(
     themes_path: pathlib.Path,
     legacy_extension_dir_path: pathlib.Path,
     modern_extension_dir_path: pathlib.Path,
+    bundle_metadata_path: pathlib.Path,
     target: str,
 ) -> str:
     config = {
@@ -490,6 +493,7 @@ def linux_tauri_config(
                     themes_path.absolute().as_posix(): "themes",
                     legacy_extension_dir_path.absolute().as_posix(): LINUX_LEGACY_GNOME_EXTENSION_UUID,
                     modern_extension_dir_path.absolute().as_posix(): LINUX_MODERN_GNOME_EXTENSION_UUID,
+                    bundle_metadata_path.absolute().as_posix(): "bundle-metadata",
                 },
             },
         }
@@ -509,6 +513,24 @@ def linux_desktop_entry() -> str:
     )
 
 
+@dataclass
+class BundleMetadata:
+    packaged_as: Package
+
+
+def make_linux_bundle_metadata(packaged_as: Package) -> pathlib.Path:
+    """
+    Creates the bundle metadata json file under a new directory, returning the path to the directory.
+    """
+    metadata_dir_path = BUILD_DIR / f"{packaged_as.value}-metadata"
+    shutil.rmtree(metadata_dir_path, ignore_errors=True)
+    metadata_dir_path.mkdir(parents=True)
+    (metadata_dir_path / "metadata.json").write_text(
+        json.dumps(BundleMetadata(packaged_as=packaged_as), default=enum_encoder)
+    )
+    return metadata_dir_path
+
+
 @dataclass
 class LinuxDebResources:
     cli_path: pathlib.Path
@@ -517,6 +539,7 @@ class LinuxDebResources:
     themes_path: pathlib.Path
     legacy_extension_dir_path: pathlib.Path
     modern_extension_dir_path: pathlib.Path
+    bundle_metadata_path: pathlib.Path
     npm_packages: NpmBuildOutput
 
 
@@ -651,6 +674,7 @@ def copy_extension(extension_uuid, extension_dir_name):
             themes_path=themes_path,
             legacy_extension_dir_path=legacy_extension_dir_path,
             modern_extension_dir_path=modern_extension_dir_path,
+            bundle_metadata_path=make_linux_bundle_metadata(Package.APPIMAGE),
             target=target,
         )
     )
@@ -683,6 +707,7 @@ def copy_extension(extension_uuid, extension_dir_name):
         themes_path=themes_path,
         legacy_extension_dir_path=legacy_extension_dir_path,
         modern_extension_dir_path=modern_extension_dir_path,
+        bundle_metadata_path=make_linux_bundle_metadata(Package.DEB),
         npm_packages=npm_packages,
     )
     deb_output = build_linux_deb(

build-scripts/build.py

@@ -136,3 +136,14 @@ def get_variants() -> List[Variant]:
                 return [Variant.MINIMAL]
         case other:
             raise ValueError(f"Unsupported platform {other}")
+
+
+class Package(Enum):
+    DEB = "deb"
+    APPIMAGE = "appImage"
+
+
+def enum_encoder(obj):
+    if isinstance(obj, Enum):
+        return obj.value
+    return obj.__dict__

build-scripts/util.py

@@ -18,7 +18,7 @@ serde.workspace = true
 serde_json.workspace = true
 thiserror.workspace = true
 tokio.workspace = true
-tokio-util = { version = "0.7.12", features = ["compat"] }
+tokio-util.workspace = true
 tracing.workspace = true
 zbus = { path = "../zbus" }
 

crates/dbus/Cargo.toml

@@ -31,7 +31,7 @@ fig_aws_common.workspace = true
 fig_request.workspace = true
 fig_settings.workspace = true
 fig_util.workspace = true
-http = "1.1.0"
+http.workspace = true
 regex.workspace = true
 serde.workspace = true
 serde_json.workspace = true

crates/fig_api_client/Cargo.toml

@@ -34,11 +34,7 @@ pub enum Event {
         is_logged_in: bool,
     },
 
-    ShowMessageNotification {
-        title: Cow<'static, str>,
-        body: Cow<'static, str>,
-        parent: Option<WindowId>,
-    },
+    ShowMessageNotification(ShowMessageNotification),
 }
 
 impl From<PlatformBoundEvent> for Event {
@@ -47,6 +43,21 @@ impl From<PlatformBoundEvent> for Event {
     }
 }
 
+impl From<ShowMessageNotification> for Event {
+    fn from(event: ShowMessageNotification) -> Self {
+        Self::ShowMessageNotification(event)
+    }
+}
+
+#[derive(Debug, Default)]
+pub struct ShowMessageNotification {
+    pub title: Cow<'static, str>,
+    pub body: Cow<'static, str>,
+    pub parent: Option<WindowId>,
+    pub buttons: Option<rfd::MessageButtons>,
+    pub buttons_result: Option<tokio::sync::mpsc::Sender<rfd::MessageDialogResult>>,
+}
+
 #[derive(Debug, Clone)]
 pub enum EmitEventName {
     Notification,

crates/fig_desktop/src/event.rs

@@ -1,12 +1,14 @@
 use std::sync::Mutex;
 
 use fig_os_shim::{
+    Context,
     ContextArcProvider,
     ContextProvider,
 };
 use fig_proto::local::command_response::Response as CommandResponseTypes;
 use fig_proto::local::dump_state_command::Type as DumpStateType;
 use fig_proto::local::{
+    BundleMetadataResponse,
     DebugModeCommand,
     DiagnosticsCommand,
     DiagnosticsResponse,
@@ -295,3 +297,15 @@ pub async fn connect_to_ibus(proxy: EventLoopProxy, platform_state: &PlatformSta
         }
     }
 }
+
+pub async fn bundle_metadata(ctx: &Context) -> LocalResult {
+    match fig_util::manifest::bundle_metadata_json(ctx).await {
+        Ok(json) => Ok(LocalResponse::Message(Box::new(CommandResponseTypes::BundleMetadata(
+            BundleMetadataResponse { json },
+        )))),
+        Err(err) => Err(LocalResponse::Error {
+            code: None,
+            message: Some(format!("Failed to get the bundled metadata: {:?}", err)),
+        }),
+    }
+}

crates/fig_desktop/src/local_ipc/commands.rs

@@ -164,6 +164,7 @@ async fn handle_local_ipc<Ctx>(
                     },
                     Some(command) => {
                         use fig_proto::local::command::Command::{
+                            BundleMetadata,
                             ConnectToIbus,
                             DebugMode,
                             Devtools,
@@ -204,6 +205,7 @@ async fn handle_local_ipc<Ctx>(
                                 &platform_state,
                             ),
                             ConnectToIbus(_) => commands::connect_to_ibus(proxy.clone(), &platform_state).await,
+                            BundleMetadata(_) => commands::bundle_metadata(&ctx.context_arc()).await,
                             Update(_) => fig_install::update(
                                 ctx.context_arc(),
                                 Some(Box::new(move |_| {
@@ -215,7 +217,7 @@ async fn handle_local_ipc<Ctx>(
                             .map(|_| LocalResponse::Success(None))
                             .map_err(|err| LocalResponse::Error {
                                 code: None,
-                                message: Some(format!("Failed to check for updates: {err}")),
+                                message: Some(format!("Failed to update: {err}")),
                             }),
                             Devtools(command) => {
                                 let window_id = match command.window() {