Implement call quality estimation (#27)

CHANGELOG.md

@@ -38,7 +38,8 @@ All user visible changes to this project will be documented in this file. This p
     - Send `Event::RpcSettingsUpdated` when `Member` connects ([#75]);
     - Send relay mode in `Event::PeerCreated` which is used for configuring client's `RtcIceTransportPolicy` ([#79]);
     - Emit `TracksApplied` event to create new and update existing tracks ([#105]);
-    - `PeerConnection` renegotiation functionality ([#105]).
+    - `PeerConnection` renegotiation functionality ([#105]);
+    - Calculate and send call quality score based on RTC stats ([#132]).
 - [Coturn] integration:
     - [Coturn] sessions destroying ([#84]);
     - [Coturn] stats processing ([#94]).
@@ -73,6 +74,7 @@ All user visible changes to this project will be documented in this file. This p
 [#95]: /../../pull/95
 [#98]: /../../pull/98
 [#105]: /../../pull/105
+[#132]: /../../pull/132
 
 
 

Cargo.toml

@@ -37,7 +37,7 @@ bytes = "0.5"
 chrono = "0.4"
 config = "0.10"
 deadpool = "0.5"
-deadpool-redis = "0.6"
+deadpool-redis = "=0.6.0"
 derive_more = "0.99"
 dotenv = "0.15"
 failure = "0.1"

docs/rfc/0002-webrtc-client-api.md

@@ -703,6 +703,24 @@ It's recommended to cache `Peer` ID and `Member` ID relations in `Web Client`'s
 ```
 </details>
 
+#### 10. ConnectionQualityUpdated
+
+```rust
+pub enum ConnectionQualityScore {
+    Poor = 1,
+    Low = 2,
+    Medium = 3,
+    High = 4,
+}
+
+struct ConnectionQualityUpdated {
+    partner_member_id: MemberId,
+    quality_score: ConnectionQualityScore,
+}
+```
+
+`Media Server` notifies `Web Client` about connection quality score update.
+
 
 ### Commands
 

jason/CHANGELOG.md

@@ -54,7 +54,8 @@ All user visible changes to this project will be documented in this file. This p
         - `Room.on_connection_loss` callback that JS side can start Jason reconnection on connection loss with ([#75]);
         - `Room.on_close` callback for WebSocket close initiated by server ([#55]);
         - `ConnectionHandle.on_close` callback ([#120]);
-        - `ConnectionHandle.get_remote_member_id` method ([#124]).
+        - `ConnectionHandle.get_remote_member_id` method ([#124]);
+        - `ConnectionHandle.on_quality_score_update` callback for quality score updates received from server ([#132]).
 - RPC messaging:
     - Cleanup Jason state on normal (`code = 1000`) WebSocket close ([#55]);
     - `RpcClient` and `RpcTransport` reconnection ([#75]).
@@ -64,7 +65,8 @@ All user visible changes to this project will be documented in this file. This p
         - `ApplyTracks` for muting/unmuting ([#81]);
         - `AddPeerConnectionStats` with `RtcStats` ([#90]);
     - Handling of RPC events:
-        - `TracksApplied` ([#105]).
+        - `TracksApplied` ([#105]);
+        - `ConnectionQualityUpdated` ([#132]).
 - Error handling:
     - Library API:
         - `JasonError` as library error with trace information and underlying JS error if it is the cause ([#55])
@@ -92,6 +94,7 @@ All user visible changes to this project will be documented in this file. This p
 [#120]: /../../pull/120
 [#123]: /../../pull/123
 [#124]: /../../pull/124
+[#132]: /../../pull/132
 
 
 

jason/demo/index.html

@@ -495,10 +495,10 @@
           let innerVideoDiv = document.createElement("div");
           innerVideoDiv.className = "col-md-3";
           innerVideoDiv.appendChild(video);
-          let remoteMemberIdEl = document.createElement('p');
-          remoteMemberIdEl.className = 'text-center';
+          let remoteMemberIdEl = document.createElement('span');
           remoteMemberIdEl.innerHTML = remoteMemberId;
           innerVideoDiv.appendChild(remoteMemberIdEl);
+          innerVideoDiv.appendChild(document.createElement('br'));
           remote_videos[remoteMemberId] = innerVideoDiv;
           videoDiv.appendChild(innerVideoDiv);
 
@@ -533,6 +533,19 @@
           remote_videos[remoteMemberId].remove();
           delete remote_videos[remoteMemberId];
         });
+
+        connection.on_quality_score_update((score) => {
+          let videoDiv = remote_videos[remoteMemberId];
+          let el = videoDiv.getElementsByClassName('quality-score');
+
+          if (el[0] === undefined) {
+            let qualityEl = document.createElement('span');
+            qualityEl.innerHTML = score;
+            qualityEl.className = 'quality-score';
+            videoDiv.appendChild(qualityEl);
+          }
+          el[0].innerHTML = score;
+        })
       });
 
       room.on_local_stream((stream) => {
@@ -691,7 +704,7 @@
   </div>
 
   <div id="video-call" style="display: none">
-    <div id="remote-videos" class="row">
+    <div id="remote-videos" class="row text-center">
     </div>
 
     <div class="row h-25 w-75">

jason/e2e-demo/js/index.js

@@ -564,6 +564,19 @@ window.onload = async function() {
         remote_videos[remoteMemberId].remove();
         delete remote_videos[remoteMemberId];
       });
+
+      connection.on_quality_score_update((score) => {
+        let videoDiv = remote_videos[remoteMemberId];
+        let el = videoDiv.getElementsByClassName('quality-score');
+
+        if (el[0] === undefined) {
+          let qualityEl = document.createElement('span');
+          qualityEl.innerHTML = score;
+          qualityEl.className = 'quality-score';
+          videoDiv.appendChild(qualityEl);
+        }
+        el[0].innerHTML = score;
+      })
     });
 
     room.on_local_stream((stream) => {

jason/e2e-demo/video-call.html

@@ -19,6 +19,7 @@
     .remote-videos {
       display: flex;
       width: 100%;
+      margin-top: 30px;
       justify-content: space-around;
     }
 

jason/src/api/connection.rs

@@ -1,12 +1,14 @@
 //! Connection with specific remote `Member`.
 
 use std::{
-    cell::RefCell,
+    cell::{Cell, RefCell},
     collections::{HashMap, HashSet},
     rc::{Rc, Weak},
 };
 
-use medea_client_api_proto::{MemberId, PeerId, TrackId};
+use medea_client_api_proto::{
+    ConnectionQualityScore, MemberId, PeerId, TrackId,
+};
 use wasm_bindgen::prelude::*;
 
 use crate::{
@@ -102,10 +104,17 @@ struct InnerConnection {
     /// [`PeerMediaStream`] received from remote member.
     remote_stream: RefCell<Option<PeerMediaStream>>,
 
+    /// Current [`ConnectionQualityScore`] of this [`Connection`].
+    quality_score: Cell<Option<ConnectionQualityScore>>,
+
     /// JS callback, that will be invoked when remote [`PeerMediaStream`] is
     /// received.
     on_remote_stream: Callback1<RemoteMediaStream>,
 
+    /// JS callback, that will be invoked when [`ConnectionQualityScore`] will
+    /// be updated.
+    on_quality_score_update: Callback1<u8>,
+
     /// JS callback, that will be invoked when this connection is closed.
     on_close: Callback0,
 }
@@ -132,6 +141,16 @@ impl ConnectionHandle {
     pub fn get_remote_member_id(&self) -> Result<String, JsValue> {
         upgrade_or_detached!(self.0).map(|inner| inner.remote_id.0.clone())
     }
+
+    /// Sets callback, which will be invoked when connection quality score will
+    /// be updated by server.
+    pub fn on_quality_score_update(
+        &self,
+        f: js_sys::Function,
+    ) -> Result<(), JsValue> {
+        upgrade_or_detached!(self.0)
+            .map(|inner| inner.on_quality_score_update.set_func(f))
+    }
 }
 
 /// Connection with a specific remote [`Member`], that is used on Rust side.
@@ -146,8 +165,10 @@ impl Connection {
     pub fn new(remote_id: MemberId) -> Self {
         Self(Rc::new(InnerConnection {
             remote_id,
-            remote_stream: RefCell::new(None),
+            remote_stream: RefCell::default(),
+            quality_score: Cell::default(),
             on_remote_stream: Callback1::default(),
+            on_quality_score_update: Callback1::default(),
             on_close: Callback0::default(),
         }))
     }
@@ -173,4 +194,11 @@ impl Connection {
     pub fn new_handle(&self) -> ConnectionHandle {
         ConnectionHandle(Rc::downgrade(&self.0))
     }
+
+    /// Updates [`ConnectionQualityScore`] of this [`Connection`].
+    pub fn update_quality_score(&self, score: ConnectionQualityScore) {
+        if self.0.quality_score.replace(Some(score)) != Some(score) {
+            self.0.on_quality_score_update.call(score as u8);
+        }
+    }
 }