SargonOS v1 integration API

apple/Sources/Sargon/Drivers/ProfileChange/ProfileChange.swift

@@ -0,0 +1,52 @@
+import Foundation
+import SargonUniFFI
+import AsyncExtensions
+
+// Makes it possible to type `.shared` on an initalizer/func taking
+// `some EventBusDriver` as parameter.
+extension ProfileChangeDriver where Self == ProfileChangeBus {
+
+    public static var shared: Self { Self.shared }
+}
+
+/// An `EventBusDriver` actor which handles incoming
+/// `EventNotifications` and forwards them to any
+/// subscriber of `notifications()`, being a multicasted
+/// async sequence.
+public final actor ProfileChangeBus {
+    /// A stream we multicast on.
+    private let stream = AsyncThrowingPassthroughSubject<Element, any Error>()
+    private let subject: Subject
+
+#if DEBUG
+    public init() {
+        subject = .init()
+    }
+#else
+    private init() {
+        subject = .init()
+    }
+#endif
+}
+
+extension ProfileChangeBus {
+
+    public typealias Element = Profile
+    public typealias Subject = AsyncPassthroughSubject<Element>
+
+    public static let shared = ProfileChangeBus()
+
+    /// A multicasted async sequence of `EventNotification` values
+    /// over time, originally emitted by `SargonOS` (Rust side).
+    public func profile_change_stream() -> AsyncMulticastSequence<Subject, AsyncThrowingPassthroughSubject<Element, any Error>> {
+        subject
+         .multicast(stream)
+         .autoconnect()
+    }
+}
+
+extension ProfileChangeBus: ProfileChangeDriver {
+    public func handleProfileChange(changedProfile: Profile) async {
+        subject.send(changedProfile)
+    }
+}

apple/Sources/Sargon/Extensions/Swiftified/System/Drivers/Drivers+Swiftified.swift

@@ -55,7 +55,8 @@ extension Drivers {
 			logging: .shared,
 			eventBus: .shared,
 			fileSystem: .shared,
-			unsafeStorage: unsafeStorage
+			unsafeStorage: unsafeStorage,
+            profileChangeDriver: .shared
 		)
 	}
 }

apple/Sources/Sargon/Extensions/Swiftified/System/SargonOS+Swiftified.swift

@@ -12,11 +12,3 @@ import SargonUniFFI
 public typealias SargonOS = SargonOs
 
 extension SargonOS: @unchecked Sendable {}
-
-extension SargonOS {
-
-	@available(*, deprecated, message: "SHOULD migrate to use more specialized methods on SargonOS instead, e.g. `createAndSaveNewAccount` - SargonOS should be the SOLE object to perform the mutation and persisting.")
-	public func saveChangedProfile(_ profile: Profile) async throws {
-		try await deprecatedSaveFfiChangedProfile(profile: profile)
-	}
-}

apple/Sources/Sargon/SargonOS/SargonOSProtocol.swift

@@ -29,12 +29,6 @@ extension SargonOSProtocol {
 
 // MARK: Extensions
 extension SargonOSProtocol {
-
-	@available(*, deprecated, message: "SHOULD migrate to use more specialized access methods on SargonOS instead, e.g. `accountsOnCurrentNetwork`.")
-	public var profile: Profile {
-		os.profile()
-	}
-
 	public var currentNetworkID: NetworkID {
 		os.currentNetworkId()
 	}

src/system/clients/client/mod.rs

@@ -3,6 +3,7 @@ mod event_bus_client;
 mod file_system_client;
 mod host_info_client;
 mod http_client;
+mod profile_change_client;
 mod secure_storage_client;
 mod unsafe_storage_client;
 
@@ -11,5 +12,6 @@ pub use event_bus_client::*;
 pub use file_system_client::*;
 pub use host_info_client::*;
 pub use http_client::*;
+pub use profile_change_client::*;
 pub use secure_storage_client::*;
 pub use unsafe_storage_client::*;

src/system/clients/client/profile_change_client/mod.rs

@@ -0,0 +1,3 @@
+mod profile_change_client;
+
+pub use profile_change_client::*;

src/system/clients/client/profile_change_client/profile_change_client.rs

@@ -0,0 +1,18 @@
+use crate::prelude::*;
+
+#[derive(Debug)]
+pub struct ProfileChangeClient {
+    driver: Arc<dyn ProfileChangeDriver>,
+}
+
+impl ProfileChangeClient {
+    pub(crate) fn new(driver: Arc<dyn ProfileChangeDriver>) -> Self {
+        Self { driver }
+    }
+}
+
+impl ProfileChangeClient {
+    pub async fn emit(&self, changed_profile: Profile) {
+        self.driver.handle_profile_change(changed_profile).await
+    }
+}

src/system/clients/clients.rs

@@ -9,6 +9,7 @@ pub struct Clients {
     pub unsafe_storage: UnsafeStorageClient,
     pub file_system: FileSystemClient,
     pub event_bus: EventBusClient,
+    pub profile_change: ProfileChangeClient,
 }
 
 impl Clients {
@@ -22,6 +23,8 @@ impl Clients {
             UnsafeStorageClient::new(drivers.unsafe_storage.clone());
         let file_system = FileSystemClient::new(drivers.file_system.clone());
         let event_bus = EventBusClient::new(drivers.event_bus.clone());
+        let profile_change =
+            ProfileChangeClient::new(drivers.profile_change_driver.clone());
         Self {
             host,
             secure_storage,
@@ -30,6 +33,7 @@ impl Clients {
             unsafe_storage,
             file_system,
             event_bus,
+            profile_change,
         }
     }
 

src/system/drivers/drivers.rs

@@ -10,6 +10,7 @@ pub struct Drivers {
     pub event_bus: Arc<dyn EventBusDriver>,
     pub file_system: Arc<dyn FileSystemDriver>,
     pub unsafe_storage: Arc<dyn UnsafeStorageDriver>,
+    pub profile_change_driver: Arc<dyn ProfileChangeDriver>,
 }
 
 #[uniffi::export]
@@ -25,6 +26,7 @@ impl Drivers {
         event_bus: Arc<dyn EventBusDriver>,
         file_system: Arc<dyn FileSystemDriver>,
         unsafe_storage: Arc<dyn UnsafeStorageDriver>,
+        profile_change_driver: Arc<dyn ProfileChangeDriver>,
     ) -> Arc<Self> {
         Arc::new(Self {
             networking,
@@ -35,6 +37,7 @@ impl Drivers {
             event_bus,
             file_system,
             unsafe_storage,
+            profile_change_driver,
         })
     }
 }
@@ -51,6 +54,7 @@ impl Drivers {
             RustEventBusDriver::new(),
             RustFileSystemDriver::new(),
             EphemeralUnsafeStorage::new(),
+            RustProfileChangeDriver::new(),
         )
     }
 
@@ -64,6 +68,7 @@ impl Drivers {
             RustEventBusDriver::new(),
             RustFileSystemDriver::new(),
             EphemeralUnsafeStorage::new(),
+            RustProfileChangeDriver::new(),
         )
     }
 
@@ -79,6 +84,7 @@ impl Drivers {
             RustEventBusDriver::new(),
             RustFileSystemDriver::new(),
             EphemeralUnsafeStorage::new(),
+            RustProfileChangeDriver::new(),
         )
     }
 
@@ -94,6 +100,7 @@ impl Drivers {
             RustEventBusDriver::new(),
             RustFileSystemDriver::new(),
             EphemeralUnsafeStorage::new(),
+            RustProfileChangeDriver::new(),
         )
     }
 
@@ -107,6 +114,7 @@ impl Drivers {
             RustEventBusDriver::new(),
             RustFileSystemDriver::new(),
             EphemeralUnsafeStorage::new(),
+            RustProfileChangeDriver::new(),
         )
     }
 
@@ -120,6 +128,7 @@ impl Drivers {
             RustEventBusDriver::new(),
             RustFileSystemDriver::new(),
             EphemeralUnsafeStorage::new(),
+            RustProfileChangeDriver::new(),
         )
     }
 
@@ -133,6 +142,7 @@ impl Drivers {
             event_bus,
             RustFileSystemDriver::new(),
             EphemeralUnsafeStorage::new(),
+            RustProfileChangeDriver::new(),
         )
     }
 
@@ -148,6 +158,7 @@ impl Drivers {
             RustEventBusDriver::new(),
             file_system,
             EphemeralUnsafeStorage::new(),
+            RustProfileChangeDriver::new(),
         )
     }
 
@@ -163,6 +174,7 @@ impl Drivers {
             RustEventBusDriver::new(),
             RustFileSystemDriver::new(),
             unsafe_storage,
+            RustProfileChangeDriver::new(),
         )
     }
 }

src/system/drivers/mod.rs

@@ -5,6 +5,7 @@ mod file_system_driver;
 mod host_info_driver;
 mod logging_driver;
 mod networking_driver;
+mod profile_change_driver;
 mod secure_storage_driver;
 mod unsafe_storage_driver;
 
@@ -15,5 +16,6 @@ pub use file_system_driver::*;
 pub use host_info_driver::*;
 pub use logging_driver::*;
 pub use networking_driver::*;
+pub use profile_change_driver::*;
 pub use secure_storage_driver::*;
 pub use unsafe_storage_driver::*;

src/system/drivers/profile_change_driver/mod.rs

@@ -0,0 +1,5 @@
+mod profile_change_driver;
+mod support;
+
+pub use profile_change_driver::*;
+pub use support::*;

src/system/drivers/profile_change_driver/profile_change_driver.rs

@@ -0,0 +1,7 @@
+use crate::prelude::*;
+
+#[uniffi::export(with_foreign)]
+#[async_trait::async_trait]
+pub trait ProfileChangeDriver: Send + Sync + std::fmt::Debug {
+    async fn handle_profile_change(&self, changed_profile: Profile);
+}

src/system/drivers/profile_change_driver/support/mod.rs

@@ -0,0 +1,3 @@
+mod test;
+
+pub use test::*;

src/system/drivers/profile_change_driver/support/test/mod.rs

@@ -0,0 +1,3 @@
+mod rust_profile_change_driver;
+
+pub use rust_profile_change_driver::*;

src/system/drivers/profile_change_driver/support/test/rust_profile_change_driver.rs

@@ -0,0 +1,34 @@
+use crate::prelude::*;
+use std::sync::RwLock;
+
+#[derive(Debug)]
+pub struct RustProfileChangeDriver {
+    recorded: RwLock<Vec<Profile>>,
+    spy: fn(Profile) -> (),
+}
+
+#[async_trait::async_trait]
+impl ProfileChangeDriver for RustProfileChangeDriver {
+    async fn handle_profile_change(&self, changed_profile: Profile) {
+        self.recorded
+            .try_write()
+            .unwrap()
+            .push(changed_profile.clone());
+        (self.spy)(changed_profile)
+    }
+}
+
+impl RustProfileChangeDriver {
+    pub fn recorded(&self) -> Vec<Profile> {
+        self.recorded.try_read().unwrap().clone()
+    }
+    pub fn new() -> Arc<Self> {
+        Self::with_spy(|_| {})
+    }
+    pub fn with_spy(spy: fn(Profile) -> ()) -> Arc<Self> {
+        Arc::new(Self {
+            spy,
+            recorded: RwLock::new(Vec::new()),
+        })
+    }
+}