add disconnect reason to Room::close (#925)

Author: theomonnom

.changeset/add_disconnectreason_to_roomclose.md

@@ -0,0 +1,6 @@
+---
+livekit: patch
+livekit-protocol: patch
+---
+
+# Add disconnectReason to Room::close

livekit-api/src/services/connector.rs

@@ -136,6 +136,7 @@ impl ConnectorClient {
                     participant_metadata: options.participant_metadata.unwrap_or_default(),
                     participant_attributes: options.participant_attributes.unwrap_or_default(),
                     destination_country: options.destination_country.unwrap_or_default(),
+                    ringing_timeout: Default::default(),
                 },
                 self.base
                     .auth_header(VideoGrants { room_create: true, ..Default::default() }, None)?,
@@ -242,6 +243,8 @@ impl ConnectorClient {
                     participant_metadata: options.participant_metadata.unwrap_or_default(),
                     participant_attributes: options.participant_attributes.unwrap_or_default(),
                     destination_country: options.destination_country.unwrap_or_default(),
+                    ringing_timeout: Default::default(),
+                    wait_until_answered: Default::default(),
                 },
                 self.base
                     .auth_header(VideoGrants { room_create: true, ..Default::default() }, None)?,

livekit-api/src/services/sip.rs

@@ -201,6 +201,8 @@ impl SIPClient {
                         // TODO: support these attributes
                         include_headers: Default::default(),
                         media_encryption: Default::default(),
+                        created_at: Default::default(),
+                        updated_at: Default::default(),
                     }),
                 },
                 self.base.auth_header(
@@ -243,6 +245,9 @@ impl SIPClient {
                         include_headers: Default::default(),
                         media_encryption: Default::default(),
                         destination_country: Default::default(),
+                        created_at: Default::default(),
+                        updated_at: Default::default(),
+                        from_host: Default::default(),
                     }),
                 },
                 self.base.auth_header(

livekit-ffi/protocol/participant.proto

@@ -85,6 +85,7 @@ enum DisconnectReason {
   SIP_TRUNK_FAILURE = 13;
   CONNECTION_TIMEOUT = 14;
   MEDIA_FAILURE = 15;
+  AGENT_ERROR = 16;
 }
 
 // copied from livekit-protocol/protocol/protobufs/livekit_models.proto and removed deprecated fields

livekit-ffi/protocol/room.proto

@@ -62,6 +62,7 @@ message ConnectCallback {
 message DisconnectRequest {
   required uint64 room_handle = 1;
   optional uint64 request_async_id = 2;
+  optional DisconnectReason reason = 3;
 }
 message DisconnectResponse { required uint64 async_id = 1; }
 message DisconnectCallback { required uint64 async_id = 1; }

livekit-ffi/src/conversion/participant.rs

@@ -96,6 +96,7 @@ impl From<DisconnectReason> for proto::DisconnectReason {
             DisconnectReason::SipTrunkFailure => proto::DisconnectReason::SipTrunkFailure,
             DisconnectReason::ConnectionTimeout => proto::DisconnectReason::ConnectionTimeout,
             DisconnectReason::MediaFailure => proto::DisconnectReason::MediaFailure,
+            DisconnectReason::AgentError => proto::DisconnectReason::AgentError,
         }
     }
 }

livekit-ffi/src/conversion/room.rs

@@ -102,6 +102,31 @@ impl From<DisconnectReason> for proto::DisconnectReason {
             DisconnectReason::SipTrunkFailure => Self::SipTrunkFailure,
             DisconnectReason::ConnectionTimeout => Self::ConnectionTimeout,
             DisconnectReason::MediaFailure => Self::MediaFailure,
+            DisconnectReason::AgentError => Self::AgentError,
+        }
+    }
+}
+
+impl From<proto::DisconnectReason> for DisconnectReason {
+    fn from(value: proto::DisconnectReason) -> Self {
+        match value {
+            proto::DisconnectReason::UnknownReason => Self::UnknownReason,
+            proto::DisconnectReason::ClientInitiated => Self::ClientInitiated,
+            proto::DisconnectReason::DuplicateIdentity => Self::DuplicateIdentity,
+            proto::DisconnectReason::ServerShutdown => Self::ServerShutdown,
+            proto::DisconnectReason::ParticipantRemoved => Self::ParticipantRemoved,
+            proto::DisconnectReason::RoomDeleted => Self::RoomDeleted,
+            proto::DisconnectReason::StateMismatch => Self::StateMismatch,
+            proto::DisconnectReason::JoinFailure => Self::JoinFailure,
+            proto::DisconnectReason::Migration => Self::Migration,
+            proto::DisconnectReason::SignalClose => Self::SignalClose,
+            proto::DisconnectReason::RoomClosed => Self::RoomClosed,
+            proto::DisconnectReason::UserUnavailable => Self::UserUnavailable,
+            proto::DisconnectReason::UserRejected => Self::UserRejected,
+            proto::DisconnectReason::SipTrunkFailure => Self::SipTrunkFailure,
+            proto::DisconnectReason::ConnectionTimeout => Self::ConnectionTimeout,
+            proto::DisconnectReason::MediaFailure => Self::MediaFailure,
+            proto::DisconnectReason::AgentError => Self::AgentError,
         }
     }
 }

livekit-ffi/src/server/mod.rs

@@ -24,6 +24,7 @@ use std::{
 
 use dashmap::{mapref::one::MappedRef, DashMap};
 use downcast_rs::{impl_downcast, Downcast};
+use livekit::prelude::DisconnectReason;
 use livekit::webrtc::{
     native::apm::AudioProcessingModule, native::audio_resampler::AudioResampler, prelude::*,
 };
@@ -169,7 +170,7 @@ impl FfiServer {
         }
 
         for room in rooms {
-            room.close(self).await;
+            room.close(self, DisconnectReason::ClientInitiated).await;
         }
 
         // Drop all handles

livekit-ffi/src/server/requests.rs

@@ -65,11 +65,16 @@ fn on_disconnect(
     disconnect: proto::DisconnectRequest,
 ) -> FfiResult<proto::DisconnectResponse> {
     let async_id = server.resolve_async_id(disconnect.request_async_id);
+    let reason = disconnect
+        .reason
+        .and_then(|r| proto::DisconnectReason::try_from(r).ok())
+        .map(DisconnectReason::from)
+        .unwrap_or(DisconnectReason::ClientInitiated);
     let handle = server.async_runtime.spawn(async move {
         let ffi_room =
             server.retrieve_handle::<room::FfiRoom>(disconnect.room_handle).unwrap().clone();
 
-        ffi_room.close(server).await;
+        ffi_room.close(server, reason).await;
 
         let _ = server.send_event(proto::DisconnectCallback { async_id }.into());
     });

livekit-ffi/src/server/room.rs

@@ -301,7 +301,7 @@ impl FfiRoom {
     }
 
     /// Close the room and stop the tasks
-    pub async fn close(&self, server: &'static FfiServer) {
+    pub async fn close(&self, server: &'static FfiServer, reason: DisconnectReason) {
         // drop associated track handles
         for (_, &handle) in self.inner.track_handle_lookup.lock().iter() {
             if server.drop_handle(handle) {
@@ -310,7 +310,7 @@ impl FfiRoom {
             }
         }
 
-        let _ = self.inner.room.close().await;
+        let _ = self.inner.room.close_with_reason(reason.into()).await;
 
         let handle = self.handle.lock().await.take();
         if let Some(handle) = handle {