Implement HostInfo struct #189

micbakos-rdx · 2024-07-22T13:58:35Z

This PR aims to decouple DeviceInfo which is stored in profile with host information got from the device in realtime. HostInfoDriver aims to construct host info. Previously it used to return DeviceInfo which includes optional information about the newer data like host app version, host os version and vendor. Also DeviceInfo still uses the old description: String which is not helping when it comes to naming factor sources with device and model names. Since I wanted to keep compatibility with Profile's DeviceInfo, I chose to use a new struct that directly describes the state of the host.

HostInfo replaced DeviceInfo in sargon and wherever a host information is used to create new factor sources or relevant data types.
When in need to compare profile device infos we just compare with id and do not perform equals in the whole DeviceInfo model. (Will attach a comment related to this)
Changed the logic on what needs to be stored on secure storage. Now in order to resolve the host information, we need to:
1. Load if any stored device id along with its creation date. This is the HostId. If none exists, os generates a new one and stores it in secure storage
2. Resolve the rest attributes of HostInfo on the fly and attach the host id from (i).
HostInfo can be converted to DeviceInfo in order for the latter to be stored in profile, but I didn't want to expose the opposite. Since only the OS can/should query the most recent host information and should not rely on older data stored on profile.

micbakos-rdx · 2024-07-22T13:59:17Z

examples/android/src/main/java/com/radixdlt/sargon/android/MainActivity.kt

@@ -57,69 +56,69 @@ class MainActivity : ComponentActivity() {

 @Composable
 fun WalletContent(modifier: Modifier = Modifier, storage: SecureStorageDriver) {
-    var walletState: Wallet? by remember { mutableStateOf(null) }


Didn't have time to make example app compatible with sargon os. I can do that if needed.

src/system/clients/client/host_info_client/host_info_client.rs

src/system/sargon_os/sargon_os.rs

micbakos-rdx · 2024-07-22T14:01:13Z

src/system/sargon_os/sargon_os_profile.rs

+        let was_needed =
+            profile.header.last_used_on_device.id != device_info.id;


Here we need to check against the IDs and not the whole object.

src/system/sargon_os/sargon_os_profile.rs

micbakos-rdx · 2024-07-22T14:02:23Z

src/system/sargon_os/sargon_os_profile.rs

-                Ok(Self::claim_provided_profile(&mut p, device_info.clone()))
+                Ok(Self::claim_provided_profile(
+                    &mut p,
+                    host_info.clone().into(),


Same as above.

codecov · 2024-07-22T14:12:03Z

Codecov Report

Attention: Patch coverage is 99.54128% with 1 line in your changes missing coverage. Please review.

Project coverage is 97.4%. Comparing base (ecd8c96) to head (777f0b3).

Additional details and impacted files

@@            Coverage Diff             @@
##           sargon_os    #189    +/-   ##
==========================================
  Coverage       97.4%   97.4%            
==========================================
  Files            895     906    +11     
  Lines          14386   14489   +103     
  Branches          38      38            
==========================================
+ Hits           14016   14119   +103     
  Misses           364     364            
  Partials           6       6

Flag	Coverage Δ
kotlin	`96.6% <100.0%> (+<0.1%)`	⬆️
rust	`97.0% <99.4%> (+<0.1%)`	⬆️
swift	`99.5% <100.0%> (+<0.1%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
...n/Drivers/HostInfo/HostInfoDriver+DeviceInfo.swift	`96.2% <100.0%> (-0.4%)`	⬇️
...Methods/Crypto/Keys/PrivateHD+Wrap+Functions.swift	`100.0% <100.0%> (ø)`
...ile/Factor/DeviceFactorSource+Wrap+Functions.swift	`100.0% <100.0%> (ø)`
...Swiftified/System/Drivers/Drivers+Swiftified.swift	`100.0% <100.0%> (ø)`
.../Swiftified/System/Drivers/HostOS+Swiftified.swift	`100.0% <100.0%> (ø)`
.../java/com/radixdlt/sargon/extensions/DeviceInfo.kt	`100.0% <100.0%> (ø)`
...adixdlt/sargon/extensions/DeviceInfoDescription.kt	`100.0% <100.0%> (ø)`
...ava/com/radixdlt/sargon/extensions/FactorSource.kt	`83.3% <100.0%> (ø)`
...main/java/com/radixdlt/sargon/extensions/HostOs.kt	`100.0% <100.0%> (ø)`
...ns/PrivateHierarchicalDeterministicFactorSource.kt	`100.0% <100.0%> (ø)`
... and 31 more

... and 1 file with indirect coverage changes

src/profile/supporting_types/host_info.rs

GhenadieVP · 2024-07-23T06:19:09Z

src/profile/supporting_types/host_info.rs

+            id: DeviceID::from_str("66F07CA2-A9D9-49E5-8152-77ACA3D1DD74")
+                .unwrap(),
+            date: Timestamp::sample(),
+            description: DeviceInfoDescription {


I would expected DeviceInfoDescription to also implement HasSampleValues

It does but does not follow the logic of one sample being for an iOS client and other for Android.

src/profile/supporting_types/host_info.rs

micbakos-rdx · 2024-07-24T10:10:32Z

@GhenadieVP I have pushed the latest commits were

The HostId is separate from HostInfo. Those two together can create an instance of DeviceInfo.
The host info driver, now can return a HostOS which is an enum with various properties according to the operating system.

…ants of each host os

GhenadieVP

Nice, well done!

* Rust: `SargonOS` &`Drivers` more Profile Logic | Swift: Shared State (working example app)! (#131) Introducing SargonOS * MFA: Sec Structure of Factor <Source | ID | Instance>s (#150) MFA Batch 1: SecurityStructureOfFactorSources and MatrixOfFactorSoures and also on FactorSourceID and FactorInstance level. Also add some new FactorSourceKinds at least a POC version of them or stubbed out ones. * Sargon OS undo Profile JSON format change (#177) Revert Profile JSON format changes in DeviceInfo * Merge 'main' into 'sargon_os' * Implement HostInfo struct (#189) * Implement HostInfo struct * Store host id in secure storage * Fix doc * Separate id and date from host info * Implement HostOS that will encapsulate the different values and constants of each host os * Expose uniffi method for creating device info from host info * Small fix for AppleHostDriver (#192) wip --------- Co-authored-by: micbakos-rdx <michael.bakogiannis@rdx.works> Co-authored-by: micbakos-rdx <125959264+micbakos-rdx@users.noreply.github.com> Co-authored-by: Ghenadie <118184705+GhenadieVP@users.noreply.github.com>

* Rust: `SargonOS` &`Drivers` more Profile Logic | Swift: Shared State (working example app)! (#131) Introducing SargonOS * MFA: Sec Structure of Factor <Source | ID | Instance>s (#150) MFA Batch 1: SecurityStructureOfFactorSources and MatrixOfFactorSoures and also on FactorSourceID and FactorInstance level. Also add some new FactorSourceKinds at least a POC version of them or stubbed out ones. * Sargon OS undo Profile JSON format change (#177) Revert Profile JSON format changes in DeviceInfo * Merge 'main' into 'sargon_os' * wip * Implement HostInfo struct (#189) * Implement HostInfo struct * Store host id in secure storage * Fix doc * Separate id and date from host info * Implement HostOS that will encapsulate the different values and constants of each host os * Expose uniffi method for creating device info from host info * wip * Sargon os v1 android (#196) * Implement sargon os drivers * Boot sargon os in example app * Remove active profile id * Add more unit tests * Fix apple tests * pr review * version bump --------- Co-authored-by: Alexander Cyon <116169792+CyonAlexRDX@users.noreply.github.com> Co-authored-by: micbakos-rdx <michael.bakogiannis@rdx.works> Co-authored-by: micbakos-rdx <125959264+micbakos-rdx@users.noreply.github.com>

* Rust: `SargonOS` &`Drivers` more Profile Logic | Swift: Shared State (working example app)! (#131) Introducing SargonOS * MFA: Sec Structure of Factor <Source | ID | Instance>s (#150) MFA Batch 1: SecurityStructureOfFactorSources and MatrixOfFactorSoures and also on FactorSourceID and FactorInstance level. Also add some new FactorSourceKinds at least a POC version of them or stubbed out ones. * Sargon OS undo Profile JSON format change (#177) Revert Profile JSON format changes in DeviceInfo * Merge 'main' into 'sargon_os' * Implement HostInfo struct (#189) * Implement HostInfo struct * Store host id in secure storage * Fix doc * Separate id and date from host info * Implement HostOS that will encapsulate the different values and constants of each host os * Expose uniffi method for creating device info from host info * wip * Sargon os v1 android (#196) * Implement sargon os drivers * Boot sargon os in example app * Remove active profile id * Add more unit tests * Fix apple tests * Change profile holder to keep profile state instead of profile * Driver emits profile states instead of profile * Implement new and delete wallet functions * Remove unused comment * Implement import functionality * Propagate CRUD operations on profile to the profile state change driver. * Remove unnecessary comment * Fix swift tests * Fix doc * Prioritize bdfs save and then save profile in new wallet * Implement retry read mechanism for profile snapshot. This currently exists on Android codebase and needs revisiting. * Bump version --------- Co-authored-by: Alexander Cyon <116169792+CyonAlexRDX@users.noreply.github.com> Co-authored-by: Ghenadie Vasiliev-Pusca <ghenadie.vasiliev-pusca@rdx.works>

micbakos-rdx added Swift 🍏 Changes in Swift Sargon Rust 🦀 Changes in Rust Sargon Kotlin 🤖 Changes in Kotlin Sargon UniFFI 🦄 Changes in UniFFI exported APIs labels Jul 22, 2024

micbakos-rdx requested a review from GhenadieVP July 22, 2024 13:58

micbakos-rdx self-assigned this Jul 22, 2024

micbakos-rdx commented Jul 22, 2024

View reviewed changes

src/system/clients/client/host_info_client/host_info_client.rs Outdated Show resolved Hide resolved

micbakos-rdx commented Jul 22, 2024

View reviewed changes

src/system/sargon_os/sargon_os.rs Outdated Show resolved Hide resolved

micbakos-rdx commented Jul 22, 2024

View reviewed changes

src/system/sargon_os/sargon_os_profile.rs Outdated Show resolved Hide resolved

micbakos-rdx commented Jul 22, 2024

View reviewed changes

GhenadieVP reviewed Jul 23, 2024

View reviewed changes

sergiupuhalschi-rdx reviewed Jul 23, 2024

View reviewed changes

src/profile/supporting_types/host_info.rs Outdated Show resolved Hide resolved

micbakos-rdx requested a review from GhenadieVP July 24, 2024 10:10

micbakos-rdx added 5 commits July 24, 2024 17:44

Implement HostInfo struct

e10e05f

Store host id in secure storage

8b8d5a7

Fix doc

1cc87b2

Separate id and date from host info

d4d6490

Implement HostOS that will encapsulate the different values and const…

21432c5

…ants of each host os

micbakos-rdx force-pushed the host_info branch from 71f16ec to 21432c5 Compare July 24, 2024 14:44

micbakos-rdx marked this pull request as ready for review July 24, 2024 14:44

Expose uniffi method for creating device info from host info

777f0b3

GhenadieVP approved these changes Jul 25, 2024

View reviewed changes

micbakos-rdx mentioned this pull request Jul 25, 2024

App compatibility with sargon os branch radixdlt/babylon-wallet-android#1098

Merged

micbakos-rdx merged commit b1058da into sargon_os Jul 25, 2024
12 checks passed

micbakos-rdx deleted the host_info branch July 25, 2024 11:47

micbakos-rdx mentioned this pull request Aug 6, 2024

Sargon os v1 android #196

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement HostInfo struct #189

Implement HostInfo struct #189

micbakos-rdx commented Jul 22, 2024 •

edited

Loading

micbakos-rdx Jul 22, 2024

micbakos-rdx Jul 22, 2024

micbakos-rdx Jul 22, 2024

codecov bot commented Jul 22, 2024 •

edited

Loading

GhenadieVP Jul 23, 2024

micbakos-rdx Jul 23, 2024

micbakos-rdx commented Jul 24, 2024

GhenadieVP left a comment

		let was_needed =
		profile.header.last_used_on_device.id != device_info.id;

Implement HostInfo struct #189

Implement HostInfo struct #189

Conversation

micbakos-rdx commented Jul 22, 2024 • edited Loading

micbakos-rdx Jul 22, 2024

Choose a reason for hiding this comment

micbakos-rdx Jul 22, 2024

Choose a reason for hiding this comment

micbakos-rdx Jul 22, 2024

Choose a reason for hiding this comment

codecov bot commented Jul 22, 2024 • edited Loading

Codecov Report

GhenadieVP Jul 23, 2024

Choose a reason for hiding this comment

micbakos-rdx Jul 23, 2024

Choose a reason for hiding this comment

micbakos-rdx commented Jul 24, 2024

GhenadieVP left a comment

Choose a reason for hiding this comment

micbakos-rdx commented Jul 22, 2024 •

edited

Loading

codecov bot commented Jul 22, 2024 •

edited

Loading