Prepare Jason's error handling for mobile platform support (#182)

Makefile

@@ -159,6 +159,7 @@ down.medea: docker.down.medea
 
 up.control:
 	cargo build -p medea-control-api-mock
+	make wait.port port=6565
 	cargo run -p medea-control-api-mock $(if $(call eq,$(background),yes),&,)
 
 

jason/src/api/wasm/constraints_update_exception.rs

@@ -7,7 +7,9 @@ use std::iter::FromIterator as _;
 use derive_more::From;
 use wasm_bindgen::prelude::*;
 
-use crate::{api::JasonError, room};
+use crate::room;
+
+use super::JasonError;
 
 /// Exception returned from [`RoomHandle::set_local_media_settings()`][1].
 ///

jason/src/api/wasm/jason_error.rs

@@ -1,36 +1,81 @@
 //! App error exported to JS side.
 
-use derive_more::From;
+use std::fmt::{Debug, Display};
+
+use derive_more::{Display, From};
+use tracerr::{Trace, Traced};
 use wasm_bindgen::prelude::*;
 
-use crate::utils;
+use crate::{platform, utils::JsCaused};
 
 /// Representation of an app error exported to JS side.
 ///
 /// Contains JS side error if it's the cause, and a trace information.
 #[wasm_bindgen]
-#[derive(From)]
-pub struct JasonError(utils::JasonError);
+#[derive(From, Clone, Debug, Display)]
+#[display(fmt = "{}: {}\n{}", name, message, trace)]
+pub struct JasonError {
+    /// Name of this [`JasonError`].
+    name: &'static str,
+
+    /// Message describing this [`JasonError`].
+    message: String,
+
+    /// [`Trace`] information of this [`JasonError`].
+    trace: Trace,
+
+    /// Optional cause of this [`JasonError`] as a JS side error.
+    source: Option<platform::Error>,
+}
 
 #[wasm_bindgen]
 impl JasonError {
     /// Returns a name of this error.
+    #[must_use]
     pub fn name(&self) -> String {
-        self.0.name()
+        self.name.to_owned()
     }
 
-    /// Returns a message of this errors.
+    /// Returns a message of this error.
+    #[must_use]
     pub fn message(&self) -> String {
-        self.0.message()
+        self.message.clone()
     }
 
     /// Returns a trace information of this error.
+    #[must_use]
     pub fn trace(&self) -> String {
-        self.0.trace()
+        self.trace.to_string()
     }
 
     /// Returns a JS side error if it's the cause.
+    #[must_use]
     pub fn source(&self) -> Option<js_sys::Error> {
-        self.0.source().and_then(|a| a.sys_cause)
+        self.source.clone().and_then(|e| e.sys_cause)
+    }
+}
+
+impl<E: JsCaused + Display> From<(E, Trace)> for JasonError
+where
+    E::Error: Into<platform::Error>,
+{
+    #[inline]
+    fn from((err, trace): (E, Trace)) -> Self {
+        Self {
+            name: err.name(),
+            message: err.to_string(),
+            trace,
+            source: err.js_cause().map(Into::into),
+        }
+    }
+}
+
+impl<E: JsCaused + Display> From<Traced<E>> for JasonError
+where
+    E::Error: Into<platform::Error>,
+{
+    #[inline]
+    fn from(traced: Traced<E>) -> Self {
+        Self::from(traced.into_parts())
     }
 }

jason/src/api/wasm/media_manager_handle.rs

@@ -8,10 +8,12 @@ use wasm_bindgen::prelude::*;
 use wasm_bindgen_futures::future_to_promise;
 
 use crate::{
-    api::{InputDeviceInfo, JasonError, LocalMediaTrack, MediaStreamSettings},
+    api::{InputDeviceInfo, LocalMediaTrack, MediaStreamSettings},
     media,
 };
 
+use super::JasonError;
+
 /// [`MediaManagerHandle`] is a weak reference to a [`MediaManager`].
 ///
 /// [`MediaManager`] performs all the media acquisition requests

jason/src/api/wasm/media_stream_settings.rs

@@ -71,6 +71,8 @@ impl AudioTrackConstraints {
 #[derive(From, Into)]
 pub struct DeviceVideoTrackConstraints(media::DeviceVideoTrackConstraints);
 
+/// Constraints applicable to video tracks that are sourced from a screen
+/// capturing.
 #[wasm_bindgen]
 impl DeviceVideoTrackConstraints {
     /// Creates new [`DeviceVideoTrackConstraints`] with none constraints

jason/src/api/wasm/mod.rs

@@ -3,9 +3,6 @@
 //!
 //! [`Jason`]: crate::api::Jason
 
-use derive_more::Display;
-use wasm_bindgen::prelude::*;
-
 pub mod connection_handle;
 pub mod constraints_update_exception;
 pub mod input_device_info;
@@ -19,6 +16,11 @@ pub mod remote_media_track;
 pub mod room_close_reason;
 pub mod room_handle;
 
+use derive_more::Display;
+use wasm_bindgen::prelude::*;
+
+pub use self::jason_error::JasonError;
+
 /// [MediaStreamTrack.kind][1] representation.
 ///
 /// [1]: https://w3.org/TR/mediacapture-streams/#dom-mediastreamtrack-kind

jason/src/api/wasm/reconnect_handle.rs

@@ -5,7 +5,9 @@ use js_sys::Promise;
 use wasm_bindgen::prelude::*;
 use wasm_bindgen_futures::future_to_promise;
 
-use crate::{api::JasonError, rpc};
+use crate::rpc;
+
+use super::JasonError;
 
 /// Handle that JS side can reconnect to a media server with when a connection
 /// is lost.

jason/src/api/wasm/room_handle.rs

@@ -8,13 +8,12 @@ use wasm_bindgen::{prelude::*, JsValue};
 use wasm_bindgen_futures::future_to_promise;
 
 use crate::{
-    api::{
-        ConstraintsUpdateException, JasonError, MediaSourceKind,
-        MediaStreamSettings,
-    },
+    api::{ConstraintsUpdateException, MediaSourceKind, MediaStreamSettings},
     room,
 };
 
+use super::JasonError;
+
 /// JS side handle to a [`Room`] where all the media happens.
 ///
 /// Like all handles it contains a weak reference to the object that is managed
@@ -171,6 +170,12 @@ impl RoomHandle {
 
     /// Mutes outbound audio in this [`Room`].
     ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if [`RoomHandle::unmute_audio()`] was
+    /// called while muting or a media server didn't approve this state
+    /// transition.
+    ///
     /// [`Room`]: room::Room
     pub fn mute_audio(&self) -> Promise {
         let this = self.0.clone();
@@ -183,6 +188,12 @@ impl RoomHandle {
 
     /// Unmutes outbound audio in this [`Room`].
     ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if [`RoomHandle::mute_audio()`] was
+    /// called while unmuting or a media server didn't approve this state
+    /// transition.
+    ///
     /// [`Room`]: room::Room
     pub fn unmute_audio(&self) -> Promise {
         let this = self.0.clone();
@@ -195,6 +206,12 @@ impl RoomHandle {
 
     /// Mutes outbound video in this [`Room`].
     ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if [`RoomHandle::unmute_video()`] was
+    /// called while muting or a media server didn't approve this state
+    /// transition.
+    ///
     /// [`Room`]: room::Room
     pub fn mute_video(&self, source_kind: Option<MediaSourceKind>) -> Promise {
         let this = self.0.clone();
@@ -209,6 +226,12 @@ impl RoomHandle {
 
     /// Unmutes outbound video in this [`Room`].
     ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if [`RoomHandle::mute_video()`] was
+    /// called while unmuting or a media server didn't approve this state
+    /// transition.
+    ///
     /// [`Room`]: room::Room
     pub fn unmute_video(
         &self,
@@ -226,6 +249,13 @@ impl RoomHandle {
 
     /// Disables outbound audio in this [`Room`].
     ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if the target sender is configured as
+    /// `required` by a media server or [`RoomHandle::enable_audio()`] was
+    /// called while disabling or a media server didn't approve this state
+    /// transition.
+    ///
     /// [`Room`]: room::Room
     pub fn disable_audio(&self) -> Promise {
         let this = self.0.clone();
@@ -238,6 +268,15 @@ impl RoomHandle {
 
     /// Enables outbound audio in this [`Room`].
     ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if [`RoomHandle::disable_audio()`] was
+    /// called while enabling or a media server didn't approve this state
+    /// transition.
+    ///
+    /// With `name = 'MediaManagerError'` if media acquisition request to User
+    /// Agent failed.
+    ///
     /// [`Room`]: room::Room
     pub fn enable_audio(&self) -> Promise {
         let this = self.0.clone();
@@ -251,6 +290,13 @@ impl RoomHandle {
     /// Disables outbound video.
     ///
     /// Affects only video with a specific [`MediaSourceKind`] if specified.
+    ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if the target sender is configured as
+    /// `required` by a media server or [`RoomHandle::enable_video()`] was
+    /// called while disabling or a media server didn't approve this state
+    /// transition.
     pub fn disable_video(
         &self,
         source_kind: Option<MediaSourceKind>,
@@ -269,6 +315,15 @@ impl RoomHandle {
     /// Enables outbound video.
     ///
     /// Affects only video with a specific [`MediaSourceKind`] if specified.
+    ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if [`RoomHandle::disable_video()`] was
+    /// called while enabling or a media server didn't approve this state
+    /// transition.
+    ///
+    /// With `name = 'MediaManagerError'` if media acquisition request to User
+    /// Agent failed.
     pub fn enable_video(
         &self,
         source_kind: Option<MediaSourceKind>,
@@ -285,6 +340,12 @@ impl RoomHandle {
 
     /// Disables inbound audio in this [`Room`].
     ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if
+    /// [`RoomHandle::enable_remote_audio()`] was called while disabling or a
+    /// media server didn't approve this state transition.
+    ///
     /// [`Room`]: room::Room
     pub fn disable_remote_audio(&self) -> Promise {
         let this = self.0.clone();
@@ -299,6 +360,12 @@ impl RoomHandle {
 
     /// Disables inbound video in this [`Room`].
     ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if
+    /// [`RoomHandle::enable_remote_video()`] was called while disabling or
+    /// a media server didn't approve this state transition.
+    ///
     /// [`Room`]: room::Room
     pub fn disable_remote_video(&self) -> Promise {
         let this = self.0.clone();
@@ -313,6 +380,12 @@ impl RoomHandle {
 
     /// Enables inbound audio in this [`Room`].
     ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if
+    /// [`RoomHandle::disable_remote_audio()`] was called while enabling or a
+    /// media server didn't approve this state transition.
+    ///
     /// [`Room`]: room::Room
     pub fn enable_remote_audio(&self) -> Promise {
         let this = self.0.clone();
@@ -325,6 +398,12 @@ impl RoomHandle {
 
     /// Enables inbound video in this [`Room`].
     ///
+    /// # Errors
+    ///
+    /// With `name = 'MediaConnections'` if
+    /// [`RoomHandle::disable_remote_video()`] was called while enabling or a
+    /// media server didn't approve this state transition.
+    ///
     /// [`Room`]: room::Room
     pub fn enable_remote_video(&self) -> Promise {
         let this = self.0.clone();