Start addressing some wasm32-unknown-unknown errors for matrix-sdk-ui crate #4122

zzorba · 2024-10-12T18:33:08Z

This change consists mostly of type-wrangling to support building the matrix-sdk-ui crate for wasm32-unknown-unknown. It is a step along the way of (ideally) supporting wasm32 throughout the entire project. The matrix-sdk-ui packages is not yet compiling due to some blocking issues, but these changes should be able to be landed now as a step towards that goal.

The changes consist of one of two main types.

Promoting some types related to futures to the matrix-sdk-base, where an existing 'polyfill' of sorts for Futures already existed. This includes stuff around 'boxing' futures and aborting them.
Switching to use the matrix-sdk-base spawn instead of tokio::spawn. On non-wasm32 platforms this should be a noop.

Public API changes documented in changelogs (optional)

Signed-off-by: Daniel Salinas

crates/matrix-sdk-base/src/event_cache_store/traits.rs

crates/matrix-sdk-base/src/read_receipts.rs

crates/matrix-sdk-base/src/store/traits.rs

jplatte · 2024-10-12T19:08:00Z

crates/matrix-sdk-common/src/executor.rs

+#[cfg(target_arch = "wasm32")]
+pub type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + 'a>>;
+#[cfg(not(target_arch = "wasm32"))]
+pub type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;


Suggested change

#[cfg(target_arch = "wasm32")]

pub type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + 'a>>;

#[cfg(not(target_arch = "wasm32"))]

pub type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;

pub type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + SendOutsideWasm + 'a>>;

I see this definition already existed though, why did you move it here?

I needed to expose the .boxed method on the wasm version of the code (it was present on the real future, but not the Wasm version). It seemed like this was where the wasm future was being defined, so I wanted to move the BoxFuture method here so it can be exposed in the same place.

jplatte · 2024-10-12T19:08:28Z

crates/matrix-sdk-common/src/executor.rs

+#[cfg(not(target_arch = "wasm32"))]
+impl<'a, F, T> BoxFutureExt<'a, T> for F
+where
+    F: Future<Output = T> + 'a + Send,
+    T: 'a,
+{
+    fn box_future(self) -> BoxFuture<'a, T> {
+        self.boxed()
+    }
+}
+
+#[cfg(target_arch = "wasm32")]
+impl<'a, F, T> BoxFutureExt<'a, T> for F
+where
+    F: Future<Output = T> + 'a,
+    T: 'a,
+{
+    fn box_future(self) -> BoxFuture<'a, T> {
+        self.boxed_local()
+    }
+}


impl blocks can be merged the same way.

I was struggling to get it to compile with the extra + Send trait needed on the not-wasm32 version.

This commit adjusts types and traits to support targeting wasm32.

codecov · 2024-10-13T15:05:14Z

Codecov Report

Attention: Patch coverage is 40.90909% with 13 lines in your changes missing coverage. Please review.

Project coverage is 84.67%. Comparing base (a4bda1a) to head (ac6b065).

Files with missing lines	Patch %	Lines
crates/matrix-sdk-common/src/executor.rs	56.25%	7 Missing ⚠️
crates/matrix-sdk-base/src/store/observable_map.rs	0.00%	5 Missing ⚠️
crates/matrix-sdk/src/sliding_sync/mod.rs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4122      +/-   ##
==========================================
- Coverage   84.69%   84.67%   -0.03%     
==========================================
  Files         269      268       -1     
  Lines       28816    28830      +14     
==========================================
+ Hits        24405    24411       +6     
- Misses       4411     4419       +8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

zzorba · 2024-10-13T19:31:49Z

With an additional change to relax the use of Send+Sync in the eyeball package, I have the rest of this crate building locally.

remaining.patch

poljar

Looks sensible, left a couple of nits.

poljar · 2024-10-16T10:13:11Z

crates/matrix-sdk-ui/src/timeline/event_item/local.rs

@@ -28,7 +28,7 @@ pub(in crate::timeline) struct LocalEventTimelineItem {
    pub send_state: EventSendState,
    /// The transaction ID.
    pub transaction_id: OwnedTransactionId,
-    /// A handle to manipulate this event before it is sent, if possible.
+    // A handle to manipulate this event before it is sent, if possible.


What's this about? That looks like an accident.

poljar · 2024-10-16T10:23:07Z

crates/matrix-sdk/src/event_handler/mod.rs

@@ -512,7 +509,7 @@ macro_rules! impl_event_handler {
        impl<Ev, Fun, Fut, $($ty),*> EventHandler<Ev, ($($ty,)*)> for Fun
        where
            Ev: SyncEvent,
-            Fun: FnOnce(Ev, $($ty),*) -> Fut + Clone + SendOutsideWasm + SyncOutsideWasm + 'static,
+            Fun: FnOnce(Ev, $($ty),*) -> Fut + Clone + Send + Sync + 'static,


Wait, why would you need Send + Sync unconditionally here?

zzorba force-pushed the matrix-sdk-ui-support-wasm32 branch 2 times, most recently from 55f7b61 to 617c622 Compare October 12, 2024 18:48

jplatte reviewed Oct 12, 2024

View reviewed changes

Make the matrix-sdk-ui crate support wasm32-unknown-unknown

246d70e

This commit adjusts types and traits to support targeting wasm32.

zzorba force-pushed the matrix-sdk-ui-support-wasm32 branch from 617c622 to b93d3b7 Compare October 13, 2024 14:21

zzorba changed the title ~~Support compilation of wasm32-unknown-unknown for matrix-sdk-ui crate~~ Start addressing some wasm32-unknown-unknown errors for matrix-sdk-ui crate Oct 13, 2024

zzorba force-pushed the matrix-sdk-ui-support-wasm32 branch 4 times, most recently from c9def0d to 26943b1 Compare October 13, 2024 14:37

Restore some marker traits that were needed still

ac6b065

zzorba force-pushed the matrix-sdk-ui-support-wasm32 branch from 26943b1 to ac6b065 Compare October 13, 2024 14:49

zzorba marked this pull request as ready for review October 13, 2024 17:05

zzorba requested review from a team as code owners October 13, 2024 17:05

zzorba requested review from poljar and richvdh and removed request for a team October 13, 2024 17:05

poljar removed the request for review from richvdh October 16, 2024 09:54

poljar requested changes Oct 16, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Start addressing some wasm32-unknown-unknown errors for matrix-sdk-ui crate #4122

Start addressing some wasm32-unknown-unknown errors for matrix-sdk-ui crate #4122

zzorba commented Oct 12, 2024 •

edited

Loading

jplatte Oct 12, 2024

jplatte Oct 12, 2024

zzorba Oct 12, 2024

jplatte Oct 12, 2024

zzorba Oct 12, 2024

codecov bot commented Oct 13, 2024 •

edited

Loading

zzorba commented Oct 13, 2024

poljar left a comment

poljar Oct 16, 2024

poljar Oct 16, 2024

Start addressing some wasm32-unknown-unknown errors for matrix-sdk-ui crate #4122

Are you sure you want to change the base?

Start addressing some wasm32-unknown-unknown errors for matrix-sdk-ui crate #4122

Conversation

zzorba commented Oct 12, 2024 • edited Loading

jplatte Oct 12, 2024

Choose a reason for hiding this comment

jplatte Oct 12, 2024

Choose a reason for hiding this comment

zzorba Oct 12, 2024

Choose a reason for hiding this comment

jplatte Oct 12, 2024

Choose a reason for hiding this comment

zzorba Oct 12, 2024

Choose a reason for hiding this comment

codecov bot commented Oct 13, 2024 • edited Loading

Codecov Report

zzorba commented Oct 13, 2024

poljar left a comment

Choose a reason for hiding this comment

poljar Oct 16, 2024

Choose a reason for hiding this comment

poljar Oct 16, 2024

Choose a reason for hiding this comment

zzorba commented Oct 12, 2024 •

edited

Loading

codecov bot commented Oct 13, 2024 •

edited

Loading