chore(crypto-js): Clean up code and make CI happy.

Author: Hywan

.github/workflows/coverage.yml

@@ -38,7 +38,7 @@ jobs:
       uses: actions-rs/cargo@v1
       with:
         command: tarpaulin
-        args: --ignore-config --exclude-files "crates/matrix-sdk/examples/*,crates/matrix-sdk-common,crates/matrix-sdk-test,crates/matrix-sdk-crypto-js,crates/matrix-sdk-crypto-nodejs" --out Xml
+        args: --workspace --ignore-config --exclude-files "crates/matrix-sdk/examples/*,crates/matrix-sdk-common,crates/matrix-sdk-test" --exclude matrix-sdk-crypto-js --exclude matrix-sdk-crypto-nodejs --out Xml
 
     - name: Upload to codecov.io
       uses: codecov/codecov-action@v3

.github/workflows/docs.yml

@@ -32,7 +32,7 @@ jobs:
           RUSTDOCFLAGS: "--enable-index-page -Zunstable-options --cfg docsrs -Dwarnings"
         with:
           command: doc
-          args: --no-deps --workspace --features docsrs -Zrustdoc-map
+          args: --no-deps --workspace --exclude matrix-sdk-crypto-js --exclude matrix-sdk-crypto-nodejs --features docsrs -Zrustdoc-map
 
       - name: Deploy docs
         if: github.event_name == 'push' && github.ref == 'refs/heads/main'

crates/matrix-sdk-crypto-js/.cargo/config

@@ -1,2 +1,2 @@
 [build]
-target = "wasm32-unknown-unknown"
+target = "wasm32-unknown-unknown"

crates/matrix-sdk-crypto-js/Cargo.toml

@@ -35,4 +35,4 @@ wasm-bindgen-futures = "0.4.30"
 js-sys = "0.3.49"
 serde_json = "1.0.79"
 http = "0.2.6"
-anyhow = "1.0"
+anyhow = "1.0"

crates/matrix-sdk-crypto-js/src/identifiers.rs

@@ -23,7 +23,7 @@ impl UserId {
     /// Parse/validate and create a new `UserId`.
     #[wasm_bindgen(constructor)]
     pub fn new(id: &str) -> Result<UserId, JsError> {
-        Ok(Self { inner: ruma::UserId::parse(id)? })
+        Ok(Self::new_with(ruma::UserId::parse(id)?))
     }
 
     /// Returns the user's localpart.
@@ -76,7 +76,7 @@ impl DeviceId {
     /// Create a new `DeviceId`.
     #[wasm_bindgen(constructor)]
     pub fn new(id: &str) -> DeviceId {
-        Self { inner: id.into() }
+        Self::new_with(id.into())
     }
 
     /// Return the device ID as a string.
@@ -107,7 +107,7 @@ impl RoomId {
     /// Parse/validate and create a new `RoomId`.
     #[wasm_bindgen(constructor)]
     pub fn new(id: &str) -> Result<RoomId, JsError> {
-        Ok(Self { inner: ruma::RoomId::parse(id)? })
+        Ok(Self::new_with(ruma::RoomId::parse(id)?))
     }
 
     /// Returns the user's localpart.

crates/matrix-sdk-crypto-js/src/lib.rs

@@ -1,4 +1,4 @@
-// Copyright 2020 The Matrix.org Foundation C.I.C.
+// Copyright 2022 The Matrix.org Foundation C.I.C.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -16,17 +16,13 @@
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![warn(missing_docs, missing_debug_implementations)]
 
-#[cfg(any(not(target_arch = "wasm32"), target_os = "wasi"))]
-compile_error!("This crate is designed to only be compiled to `wasm32-unknown-unknown`.");
-
 pub mod events;
 mod future;
 pub mod identifiers;
 pub mod machine;
 pub mod requests;
 pub mod responses;
 pub mod sync_events;
-pub mod verifications;
 
 use js_sys::{Object, Reflect};
 use wasm_bindgen::{convert::RefFromWasmAbi, prelude::*};

crates/matrix-sdk-crypto-js/src/machine.rs

@@ -1,13 +1,10 @@
 //! The crypto specific Olm objects.
 
-use std::{collections::BTreeMap, sync::Arc, time::Duration};
+use std::{collections::BTreeMap, time::Duration};
 
 use js_sys::{Array, Map, Promise, Set};
-use ruma::{
-    events::{AnyMessageLikeEventContent, EventContent},
-    DeviceKeyAlgorithm, OwnedTransactionId, UInt,
-};
-use serde_json::value::RawValue as RawJsonValue;
+use ruma::{DeviceKeyAlgorithm, OwnedTransactionId, UInt};
+use serde_json::Value as JsonValue;
 use wasm_bindgen::prelude::*;
 
 use crate::{
@@ -16,15 +13,15 @@ use crate::{
     identifiers, requests,
     requests::OutgoingRequest,
     responses::{self, response_from_string},
-    sync_events, verifications,
+    sync_events,
 };
 
 /// State machine implementation of the Olm/Megolm encryption protocol
 /// used for Matrix end to end encryption.
 #[wasm_bindgen]
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct OlmMachine {
-    inner: Arc<matrix_sdk_crypto::OlmMachine>,
+    inner: matrix_sdk_crypto::OlmMachine,
 }
 
 #[wasm_bindgen]
@@ -45,9 +42,8 @@ impl OlmMachine {
 
         future_to_promise(async move {
             Ok(OlmMachine {
-                inner: Arc::new(
-                    matrix_sdk_crypto::OlmMachine::new(user_id.as_ref(), device_id.as_ref()).await,
-                ),
+                inner: matrix_sdk_crypto::OlmMachine::new(user_id.as_ref(), device_id.as_ref())
+                    .await,
             })
         })
     }
@@ -119,7 +115,8 @@ impl OlmMachine {
         }))
     }
 
-    /// Handle a to-device and one-time key counts from a sync response.
+    /// Handle to-device events and one-time key counts from a sync
+    /// response.
     ///
     /// This will decrypt and handle to-device events returning the
     /// decrypted versions of them.
@@ -206,12 +203,14 @@ impl OlmMachine {
     /// Mark the request with the given request ID as sent (see
     /// `outgoing_requests`).
     ///
-    /// `request_id` represents the unique ID of the request that was
-    /// sent out. This is needed to couple the response with the now
-    /// sent out request. `response_type` represents the type of the
-    /// request that was sent out. `response` represents the response
-    /// that was received from the server after the outgoing request
-    /// was sent out. `
+    /// Arguments are:
+    ///
+    /// * `request_id` represents the unique ID of the request that was sent
+    ///   out. This is needed to couple the response with the now sent out
+    ///   request.
+    /// * `response_type` represents the type of the request that was sent out.
+    /// * `response` represents the response that was received from the server
+    ///   after the outgoing request was sent out.
     #[wasm_bindgen(js_name = "markRequestAsSent")]
     pub fn mark_request_as_sent(
         &self,
@@ -235,34 +234,30 @@ impl OlmMachine {
     /// Beware that a group session needs to be shared before this
     /// method can be called using the `share_group_session` method.
     ///
-    /// Since group sessions can expire or become invalid if the room
-    /// membership changes, client authors should check with the
-    /// `should_share_group_session` method if a new group session
-    /// needs to be shared.
-    ///
     /// `room_id` is the ID of the room for which the message should
     /// be encrypted. `event_type` is the type of the event. `content`
     /// is the plaintext content of the message that should be
     /// encrypted.
     ///
     /// # Panics
     ///
-    /// Panics if a group session for the given room wasn't shared beforehand.
+    /// Panics if a group session for the given room wasn't shared
+    /// beforehand.
     #[wasm_bindgen(js_name = "encryptRoomEvent")]
     pub fn encrypt_room_event(
         &self,
         room_id: &identifiers::RoomId,
-        event_type: &str,
+        event_type: String,
         content: &str,
     ) -> Result<Promise, JsError> {
         let room_id = room_id.inner.clone();
-        let content: Box<RawJsonValue> = serde_json::from_str(content)?;
-        let content = AnyMessageLikeEventContent::from_parts(event_type, &content)?;
-
+        let content: JsonValue = serde_json::from_str(content)?;
         let me = self.inner.clone();
 
         Ok(future_to_promise(async move {
-            Ok(serde_json::to_string(&me.encrypt_room_event(&room_id, content).await?)?)
+            Ok(serde_json::to_string(
+                &me.encrypt_room_event_raw(&room_id, content, event_type.as_ref()).await?,
+            )?)
         }))
     }
 
@@ -362,31 +357,6 @@ impl OlmMachine {
             }
         }))
     }
-
-    /// Get a verification object for the given user ID with the given flow ID.
-    ///
-    /// Returns a list of `JsValue` to represent either (depending on
-    /// how the Wasm module has been compiled):
-    ///   * `Sas` (enabled),
-    ///   * `Qr`
-    #[cfg_attr(feature = "qrcode", doc = "(enabled).")]
-    #[cfg_attr(not(feature = "qrcode"), doc = "(disabled).")]
-    ///
-    /// If a verification mode is missing, please try to compile the
-    /// Wasm module with different features.
-    #[wasm_bindgen(js_name = "getVerification")]
-    pub fn get_verification(
-        &self,
-        user_id: &identifiers::UserId,
-        flow_id: &str,
-    ) -> Result<JsValue, JsError> {
-        self.inner
-            .get_verification(user_id.inner.as_ref(), flow_id)
-            .map(verifications::Verification)
-            .map(JsValue::try_from)
-            .transpose()
-            .map(|r| r.unwrap_or(JsValue::UNDEFINED))
-    }
 }
 
 /// An Ed25519 public key, used to verify digital signatures.

crates/matrix-sdk-crypto-js/src/requests.rs

@@ -15,9 +15,12 @@ use ruma::api::client::keys::{
 };
 use wasm_bindgen::prelude::*;
 
-/// Data for a request to the `upload_keys` API endpoint.
+/// Data for a request to the `/keys/upload` API endpoint
+/// ([specification]).
 ///
 /// Publishes end-to-end encryption keys for the device.
+///
+/// [specification]: https://spec.matrix.org/unstable/client-server-api/#post_matrixclientv3keysupload
 #[derive(Debug)]
 #[wasm_bindgen(getter_with_clone)]
 pub struct KeysUploadRequest {
@@ -34,9 +37,12 @@ pub struct KeysUploadRequest {
     pub body: JsString,
 }
 
-/// Data for a request to the `get_keys` API endpoint.
+/// Data for a request to the `/keys/query` API endpoint
+/// ([specification]).
 ///
 /// Returns the current devices and identity keys for the given users.
+///
+/// [specification]: https://spec.matrix.org/unstable/client-server-api/#post_matrixclientv3keysquery
 #[derive(Debug)]
 #[wasm_bindgen(getter_with_clone)]
 pub struct KeysQueryRequest {
@@ -53,9 +59,13 @@ pub struct KeysQueryRequest {
     pub body: JsString,
 }
 
-/// Data for a request to the `claim_keys` API endpoint.
+/// Data for a request to the `/keys/claim` API endpoint
+/// ([specification]).
 ///
-/// Claims one-time keys for use in pre-key messages.
+/// Claims one-time keys that can be used to establish 1-to-1 E2EE
+/// sessions.
+///
+/// [specification]: https://spec.matrix.org/unstable/client-server-api/#post_matrixclientv3keysclaim
 #[derive(Debug)]
 #[wasm_bindgen(getter_with_clone)]
 pub struct KeysClaimRequest {
@@ -72,9 +82,12 @@ pub struct KeysClaimRequest {
     pub body: JsString,
 }
 
-/// Data for a request to the `send_event_to_device` API endpoint.
+/// Data for a request to the `/sendToDevice` API endpoint
+/// ([specification]).
+///
+/// Send an event to a single device or to a group of devices.
 ///
-/// Send an event to a device or devices.
+/// [specification]: https://spec.matrix.org/unstable/client-server-api/#put_matrixclientv3sendtodeviceeventtypetxnid
 #[derive(Debug)]
 #[wasm_bindgen(getter_with_clone)]
 pub struct ToDeviceRequest {
@@ -91,9 +104,12 @@ pub struct ToDeviceRequest {
     pub body: JsString,
 }
 
-/// Data for a request to the `upload_signatures` API endpoint.
+/// Data for a request to the `/keys/signatures/upload` API endpoint
+/// ([specification]).
 ///
 /// Publishes cross-signing signatures for the user.
+///
+/// [specification]: https://spec.matrix.org/unstable/client-server-api/#post_matrixclientv3keyssignaturesupload
 #[derive(Debug)]
 #[wasm_bindgen(getter_with_clone)]
 pub struct SignatureUploadRequest {
@@ -110,7 +126,10 @@ pub struct SignatureUploadRequest {
     pub body: JsString,
 }
 
-/// A customized owned request type for sending out room messages.
+/// A customized owned request type for sending out room messages
+/// ([specification]).
+///
+/// [specification]: https://spec.matrix.org/unstable/client-server-api/#put_matrixclientv3roomsroomidsendeventtypetxnid
 #[derive(Debug)]
 #[wasm_bindgen(getter_with_clone)]
 pub struct RoomMessageRequest {
@@ -127,7 +146,10 @@ pub struct RoomMessageRequest {
     pub body: JsString,
 }
 
-/// A request that will back up a batch of room keys to the server.
+/// A request that will back up a batch of room keys to the server
+/// ([specification]).
+///
+/// [specification]: https://spec.matrix.org/unstable/client-server-api/#put_matrixclientv3room_keyskeys
 #[derive(Debug)]
 #[wasm_bindgen(getter_with_clone)]
 pub struct KeysBackupRequest {
@@ -138,7 +160,7 @@ pub struct KeysBackupRequest {
     /// A JSON-encoded object of form:
     ///
     /// ```
-    /// {"version": …, "rooms": …}
+    /// {"rooms": …}
     /// ```
     #[wasm_bindgen(readonly)]
     pub body: JsString,
@@ -173,7 +195,7 @@ request!(KeysClaimRequest from RumaKeysClaimRequest maps fields timeout, one_tim
 request!(ToDeviceRequest from RumaToDeviceRequest maps fields event_type, txn_id, messages);
 request!(SignatureUploadRequest from RumaSignatureUploadRequest maps fields signed_keys);
 request!(RoomMessageRequest from RumaRoomMessageRequest maps fields room_id, txn_id, content);
-request!(KeysBackupRequest from RumaKeysBackupRequest maps fields version, rooms);
+request!(KeysBackupRequest from RumaKeysBackupRequest maps fields rooms);
 
 // JavaScript has no complex enums like Rust. To return structs of
 // different types, we have no choice that hiding everything behind a