Add consent & user preference streaming to WASM bindings (#1647)

* Add consent streaming

* consent & preference streaming

* improve browser integration test

---------

Co-authored-by: Andrew Plaza <[email protected]>

Author: rygine

.cargo/nextest.toml

@@ -1,3 +1,3 @@
 [profile.default]
 default-filter = "not test(test_stream_all_messages_does_not_lose_messages)"
-retries = 3
+retries = 1

Cargo.lock

@@ -14,9 +14,11 @@ js-sys.workspace = true
 prost.workspace = true
 serde.workspace = true
 serde-wasm-bindgen = "0.6.5"
+serde_bytes = "0.11"
 tracing.workspace = true
 tracing-subscriber = { workspace = true, features = ["env-filter", "json"] }
 tracing-web = "0.1"
+tsify-next = { version = "0.5", default-features = false, features = ["js"] }
 wasm-bindgen.workspace = true
 wasm-bindgen-futures.workspace = true
 xmtp_api.workspace = true
@@ -27,7 +29,6 @@ xmtp_cryptography.workspace = true
 xmtp_id.workspace = true
 xmtp_mls = { workspace = true, features = ["test-utils", "http-api"] }
 xmtp_proto = { workspace = true, features = ["proto_full"] }
-
 [dev-dependencies]
 wasm-bindgen-test.workspace = true
 xmtp_common = { workspace = true, features = ["test-utils"] }

bindings_wasm/Cargo.toml

@@ -1,3 +1,4 @@
+use serde::{Deserialize, Serialize};
 use wasm_bindgen::{prelude::wasm_bindgen, JsError};
 use xmtp_mls::storage::consent_record::{
   ConsentState as XmtpConsentState, ConsentType as XmtpConsentType, StoredConsentRecord,
@@ -6,7 +7,7 @@ use xmtp_mls::storage::consent_record::{
 use crate::{client::Client, conversation::Conversation};
 
 #[wasm_bindgen]
-#[derive(Clone, serde::Serialize)]
+#[derive(Clone, Serialize, Deserialize)]
 pub enum ConsentState {
   Unknown,
   Allowed,
@@ -34,11 +35,12 @@ impl From<ConsentState> for XmtpConsentState {
 }
 
 #[wasm_bindgen]
-#[derive(Clone)]
+#[derive(Copy, Clone, Serialize, Deserialize)]
+#[repr(u16)]
 pub enum ConsentEntityType {
-  GroupId,
-  InboxId,
-  Address,
+  GroupId = 0,
+  InboxId = 1,
+  Address = 2,
 }
 
 impl From<ConsentEntityType> for XmtpConsentType {
@@ -51,9 +53,19 @@ impl From<ConsentEntityType> for XmtpConsentType {
   }
 }
 
+fn entity_to_u16<S>(consent_entity_type: &ConsentEntityType, s: S) -> Result<S::Ok, S::Error>
+where
+  S: serde::Serializer,
+{
+  let num: u16 = (*consent_entity_type) as u16;
+  s.serialize_u16(num)
+}
+
 #[wasm_bindgen(getter_with_clone)]
+#[derive(Clone, Serialize, Deserialize)]
 pub struct Consent {
   #[wasm_bindgen(js_name = entityType)]
+  #[serde(rename = "entityType", serialize_with = "entity_to_u16")]
   pub entity_type: ConsentEntityType,
   pub state: ConsentState,
   pub entity: String,
@@ -81,6 +93,20 @@ impl From<Consent> for StoredConsentRecord {
   }
 }
 
+impl From<StoredConsentRecord> for Consent {
+  fn from(value: StoredConsentRecord) -> Self {
+    Self {
+      entity: value.entity,
+      entity_type: match value.entity_type {
+        XmtpConsentType::Address => ConsentEntityType::Address,
+        XmtpConsentType::ConversationId => ConsentEntityType::GroupId,
+        XmtpConsentType::InboxId => ConsentEntityType::InboxId,
+      },
+      state: value.state.into(),
+    }
+  }
+}
+
 #[wasm_bindgen]
 impl Client {
   #[wasm_bindgen(js_name = setConsentStates)]

bindings_wasm/src/consent_state.rs

@@ -1,6 +1,7 @@
 use std::collections::HashMap;
 use std::sync::Arc;
 use wasm_bindgen::prelude::wasm_bindgen;
+use wasm_bindgen::UnwrapThrowExt;
 use wasm_bindgen::{JsError, JsValue};
 use xmtp_mls::groups::{
   DMMetadataOptions, GroupMetadataOptions, HmacKey as XmtpHmacKey, PreconfiguredPolicies,
@@ -10,10 +11,11 @@ use xmtp_mls::storage::group::ConversationType as XmtpConversationType;
 use xmtp_mls::storage::group::GroupMembershipState as XmtpGroupMembershipState;
 use xmtp_mls::storage::group::GroupQueryArgs;
 
-use crate::consent_state::ConsentState;
+use crate::consent_state::{Consent, ConsentState};
 use crate::messages::Message;
 use crate::permissions::{GroupPermissionsOptions, PermissionPolicySet};
 use crate::streams::{StreamCallback, StreamCloser};
+use crate::user_preferences::UserPreference;
 use crate::{client::RustXmtpClient, conversation::Conversation};
 
 use xmtp_mls::groups::group_mutable_metadata::MessageDisappearingSettings as XmtpMessageDisappearingSettings;
@@ -660,4 +662,34 @@ impl Conversations {
     );
     Ok(StreamCloser::new(stream_closer))
   }
+
+  #[wasm_bindgen(js_name = "streamConsent")]
+  pub fn stream_consent(&self, callback: StreamCallback) -> Result<StreamCloser, JsError> {
+    let stream_closer =
+      RustXmtpClient::stream_consent_with_callback(self.inner_client.clone(), move |message| {
+        match message {
+          Ok(m) => {
+            let array = m.into_iter().map(Consent::from).collect::<Vec<Consent>>();
+            let value = serde_wasm_bindgen::to_value(&array).unwrap_throw();
+            callback.on_consent_update(value)
+          }
+          Err(e) => callback.on_error(JsError::from(e)),
+        }
+      });
+    Ok(StreamCloser::new(stream_closer))
+  }
+
+  #[wasm_bindgen(js_name = "streamPreferences")]
+  pub fn stream_preferences(&self, callback: StreamCallback) -> Result<StreamCloser, JsError> {
+    let stream_closer =
+      RustXmtpClient::stream_preferences_with_callback(self.inner_client.clone(), move |message| {
+        match message {
+          Ok(m) => {
+            callback.on_user_preference_update(m.into_iter().map(UserPreference::from).collect())
+          }
+          Err(e) => callback.on_error(JsError::from(e)),
+        }
+      });
+    Ok(StreamCloser::new(stream_closer))
+  }
 }

bindings_wasm/src/conversations.rs

@@ -10,6 +10,7 @@ pub mod messages;
 pub mod permissions;
 pub mod signatures;
 pub mod streams;
+mod user_preferences;
 
 fn error(e: impl std::error::Error) -> JsError {
   JsError::new(&format!("{}", e))

bindings_wasm/src/lib.rs

@@ -1,5 +1,6 @@
 use crate::conversation::Conversation;
 use crate::messages::Message;
+use crate::user_preferences::UserPreference;
 use std::{cell::RefCell, rc::Rc};
 use wasm_bindgen::prelude::*;
 use wasm_bindgen::JsError;
@@ -18,6 +19,12 @@ extern "C" {
   #[wasm_bindgen(structural, method)]
   pub fn on_message(this: &StreamCallback, item: Message);
 
+  #[wasm_bindgen(structural, method)]
+  pub fn on_consent_update(this: &StreamCallback, item: JsValue);
+
+  #[wasm_bindgen(structural, method)]
+  pub fn on_user_preference_update(this: &StreamCallback, item: Vec<UserPreference>);
+
   #[wasm_bindgen(structural, method)]
   pub fn on_conversation(this: &StreamCallback, item: Conversation);
 

bindings_wasm/src/streams.rs

@@ -0,0 +1,30 @@
+use crate::consent_state::Consent;
+use serde::{Deserialize, Serialize};
+use tsify_next::Tsify;
+use wasm_bindgen::prelude::wasm_bindgen;
+use xmtp_mls::groups::device_sync::preference_sync::UserPreferenceUpdate;
+
+#[derive(Tsify, Serialize, Deserialize)]
+#[tsify(into_wasm_abi, from_wasm_abi)]
+#[serde(tag = "type")]
+pub enum UserPreference {
+  Consent {
+    consent: Consent,
+  },
+  HmacKeyUpdate {
+    // serde bytes converts to Uint8Array
+    #[serde(with = "serde_bytes")]
+    key: Vec<u8>,
+  },
+}
+
+impl From<UserPreferenceUpdate> for UserPreference {
+  fn from(v: UserPreferenceUpdate) -> UserPreference {
+    match v {
+      UserPreferenceUpdate::ConsentUpdate(c) => UserPreference::Consent {
+        consent: Consent::from(c),
+      },
+      UserPreferenceUpdate::HmacKeyUpdate { key } => UserPreference::HmacKeyUpdate { key },
+    }
+  }
+}

bindings_wasm/src/user_preferences.rs

@@ -1,38 +1,63 @@
 #!/bin/bash
 set -eou pipefail
 
-TMP=$(mktemp -d 2>/dev/null || mktemp -d -t 'test-browser-tmp')
+# USAGE
+# ./dev/test/browser-sdk will clone browser sdk to a tmp directory and execute the tests
+# ./dev/test/browser-sdk MY_DIR will clone to MY_DIR and execute the tests
+# ./dev/test/browser-sdk MY_DIR my_branch will clone to MY_DIR checkout MY_BRANCH and excute tests
+
+function tmp() {
+  mktemp -d 2>/dev/null || mktemp -d -t 'test-browser-tmp'
+}
+
+TMP=$(tmp)
+DIR="${1:-$TMP}"
+BRANCH="${2:-main}"
 CARGO="nix develop -i.#wasmBuild --command cargo"
 WORKSPACE_MANIFEST="$($CARGO locate-project --workspace --message-format=plain)"
 WORKSPACE_PATH="$(dirname $WORKSPACE_MANIFEST)"
 PLAYWRIGHT_VERSION=$(nix develop .#js --command bash -c 'echo $PLAYWRIGHT_VERSION')
 YARN="nix develop -i ${WORKSPACE_PATH}#js --command yarn"
 
+trap ctrl_c INT
+function ctrl_c() {
+  if [ -d $TMP ]; then
+    rm -rf $TMP
+  fi
+}
+
 function run() {
-  git clone [email protected]:xmtp/xmtp-js.git $TMP/xmtp-js
+  cd $WORKSPACE_PATH
+  nix build .#bindings_wasm --no-substitute --refresh
+
+  if [ ! -d $DIR/xmtp-js ]; then
+    git clone [email protected]:xmtp/xmtp-js.git $DIR/xmtp-js
+  fi
+
+  cd $DIR/xmtp-js
+  git checkout $BRANCH
+
+  rm -rf node_modules/@xmtp/wasm-bindings
 
-  cd $TMP/xmtp-js
   $YARN install
+  rm -rf $DIR/xmtp-js/node_modules/@xmtp/wasm-bindings/dist
+  cp --no-preserve=mode,ownership -r $WORKSPACE_PATH/result/dist $DIR/xmtp-js/node_modules/@xmtp/wasm-bindings/
+
   $YARN build
+  # set playwright to same version as nix (otherwise will not work)
   $YARN set resolution "playwright@npm:^1.49.1" npm:$PLAYWRIGHT_VERSION
   $YARN set resolution "playwright-core@npm:^1.49.1" npm:$PLAYWRIGHT_VERSION
 
   cd $WORKSPACE_PATH
-
-  nix build .#bindings_wasm
-
-  rm -rf $TMP/xmtp-js/node_modules/@xmtp/wasm-bindings/dist
-  cp -r result/dist $TMP/xmtp-js/node_modules/@xmtp/wasm-bindings
-
-  $YARN --cwd $TMP/xmtp-js/sdks/browser-sdk test
+  $YARN --cwd $DIR/xmtp-js/sdks/browser-sdk test test/Conversations.test.ts
 
   return 0
 }
 
 run
 RUN_STATUS=$?
 
-rm -rf $TMP
+ctrl_c
 
 # Check if run was successful
 if [ $RUN_STATUS -eq 0 ]; then