widget-driver: Support for sending future events through the widget api.

[toger5]

This adds support to parse widget actions that contain a future_timeout
as described in MSC matrix-org/matrix-spec-proposals#4157
those actions need to be handled using the custom send_future and state_future cs api endpoint described in: matrix-org/matrix-spec-proposals#4140.

This is supported by ruma and here we only handle the actions from the widget.

This is the core piece of code for that change:

/// Sends a given `event` to the room.
  pub(crate) async fn send(
      &self,
      event_type: TimelineEventType,
      state_key: Option<String>,
      content: Box<RawJsonValue>,
      future: Option<future::FutureParameters>,
  ) -> Result<SendEventResponse> {
      let type_str = event_type.to_string();
      Ok(match (state_key, future) {
          (None, None) => SendEventResponse::from_event_id(
              self.room.send_raw(&type_str, content).await?.event_id,
          ),
          (Some(key), None) => SendEventResponse::from_event_id(
              self.room.send_state_event_raw(&type_str, &key, content).await?.event_id,
          ),
          (None, Some(future)) => {
              let r = future::send_future_message_event::unstable::Request::new_raw(
                  self.room.room_id().to_owned(),
                  TransactionId::new().to_owned(),
                  MessageLikeEventType::from(type_str),
                  future,
                  Raw::<AnyMessageLikeEventContent>::from_json(content),
              );
              self.room.client.send(r, None).await.map(|r| r.into())?
          }
          (Some(key), Some(future)) => {
              let r = future::send_future_state_event::unstable::Request::new_raw(
                  self.room.room_id().to_owned(),
                  key,
                  StateEventType::from(type_str),
                  future,
                  Raw::<AnyStateEventContent>::from_json(content),
              );
              self.room.client.send(r, None).await.map(|r| r.into())?
          }
      })

• Public API changes documented in changelogs (optional)

Signed-off-by:

[codecov]

Codecov Report

Attention: Patch coverage is 93.47826% with 3 lines in your changes missing coverage. Please review.

Project coverage is 84.28%. Comparing base (b80c2f7) to head (48ca240).
Report is 54 commits behind head on main.

Files	Patch %	Lines
crates/matrix-sdk/src/widget/mod.rs	57.14%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3600      +/-   ##
==========================================
+ Coverage   84.27%   84.28%   +0.01%     
==========================================
  Files         259      259              
  Lines       26621    26658      +37     
==========================================
+ Hits        22435    22470      +35     
- Misses       4186     4188       +2     

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

[AndrewFerr]

LGTM but I'm not an expert on this codebase :)

[andybalaam]

I also don't know much about the widget code but this looks OK to me.

[bnjbvr]

Can you follow the contribution guidelines for good PR titles, please? 🥺

[bnjbvr]

Also, since future has a very specific meaning in Rust as a name, can you precise everywhere that future refers to a future event (rather than a Future as in async/await) instead, please? 🙏

[bnjbvr]

rustfmt found a trailing whitespace 👀 But then, good to go, thanks!

[bnjbvr]

(To run the rustfmt we're using in the codebase, use cargo xtask fixup style.)