other_sdks for specifying sdk info beyond client-sdk-*

Author: stephen-derosa

.changeset/other_sdks_propagation.md

@@ -0,0 +1,7 @@
+---
+livekit: minor
+livekit-api: minor
+livekit-ffi: minor
+---
+
+Add `other_sdks` field to propagate additional SDK metadata to the server. 

livekit-api/src/signal_client/mod.rs

@@ -147,11 +147,17 @@ pub enum SignalError {
 pub struct SignalSdkOptions {
     pub sdk: String,
     pub sdk_version: Option<String>,
+    /// Comma separated list of additional LiveKit SDKs layered on top of this one, with
+    /// versions, e.g. `"components-js:1.2.3,track-processors-js:1.2.3"`. Sent to the server
+    /// as `ClientInfo.other_sdks`. `None` when there are none — optional so callers that
+    /// predate the field keep working unchanged.
+    #[doc(hidden)]
+    pub other_sdks: Option<String>,
 }
 
 impl Default for SignalSdkOptions {
     fn default() -> Self {
-        Self { sdk: "rust".to_string(), sdk_version: None }
+        Self { sdk: "rust".to_string(), sdk_version: None, other_sdks: None }
     }
 }
 
@@ -816,6 +822,7 @@ fn create_join_request_param(
         device_model,
         capabilities: CLIENT_CAPABILITIES.iter().map(|c| *c as i32).collect(),
         client_protocol: advertised_client_protocol(options),
+        other_sdks: options.sdk_options.other_sdks.clone().unwrap_or_default(),
         ..Default::default()
     };
 
@@ -945,6 +952,12 @@ fn get_livekit_url(
             lk_url.query_pairs_mut().append_pair("version", sdk_version.as_str());
         }
 
+        if let Some(other_sdks) =
+            options.sdk_options.other_sdks.as_deref().filter(|s| !s.is_empty())
+        {
+            lk_url.query_pairs_mut().append_pair("other_sdks", other_sdks);
+        }
+
         // parse client capabilities
         if !CLIENT_CAPABILITIES.is_empty() {
             let caps =
@@ -1300,6 +1313,57 @@ mod tests {
         assert_eq!(client_protocol, CLIENT_PROTOCOL_DATA_STREAM_RPC.to_string());
     }
 
+    #[test]
+    fn livekit_url_forwards_other_sdks_on_both_paths() {
+        let mut io = signal_options_for_cpp("9.9.9-test");
+        io.sdk_options.other_sdks = Some("ros_portal:1.2.3,another-sdk:2.0.0".to_string());
+
+        // v1 path: other_sdks travels inside the join_request param
+        let lk_url =
+            get_livekit_url("wss://localhost:7880", &io, true, false, None, "", None).unwrap();
+        let join_request_param = lk_url
+            .query_pairs()
+            .find_map(|(key, value)| (key == "join_request").then(|| value.into_owned()))
+            .unwrap();
+        let join_request = decode_join_request_param_for_test(&join_request_param);
+        let client_info = join_request.client_info.unwrap();
+        assert_eq!(client_info.other_sdks, "ros_portal:1.2.3,another-sdk:2.0.0");
+
+        // v0 path: other_sdks is a query param
+        let lk_url =
+            get_livekit_url("wss://localhost:7880", &io, false, false, None, "", None).unwrap();
+        let other_sdks = lk_url
+            .query_pairs()
+            .find_map(|(key, value)| (key == "other_sdks").then(|| value.into_owned()))
+            .unwrap();
+        assert_eq!(other_sdks, "ros_portal:1.2.3,another-sdk:2.0.0");
+    }
+
+    #[test]
+    fn livekit_url_omits_other_sdks_when_unset() {
+        assert!(SignalOptions::default().sdk_options.other_sdks.is_none());
+
+        // `None` (callers predating the field) and `Some("")` must both behave as
+        // "no additional SDKs" on either path.
+        for other_sdks in [None, Some(String::new())] {
+            let mut io = SignalOptions::default();
+            io.sdk_options.other_sdks = other_sdks;
+
+            let lk_url =
+                get_livekit_url("wss://localhost:7880", &io, false, false, None, "", None).unwrap();
+            assert!(lk_url.query_pairs().all(|(key, _)| key != "other_sdks"));
+
+            let lk_url =
+                get_livekit_url("wss://localhost:7880", &io, true, false, None, "", None).unwrap();
+            let join_request_param = lk_url
+                .query_pairs()
+                .find_map(|(key, value)| (key == "join_request").then(|| value.into_owned()))
+                .unwrap();
+            let join_request = decode_join_request_param_for_test(&join_request_param);
+            assert!(join_request.client_info.unwrap().other_sdks.is_empty());
+        }
+    }
+
     #[test]
     fn validate_url_test() {
         let io = SignalOptions::default();

livekit-ffi/protocol/room.proto

@@ -400,6 +400,9 @@ message RoomOptions {
   optional bool single_peer_connection = 8; // use single peer connection for both publish/subscribe (default: false)
   optional uint64 connect_timeout_ms = 9; // timeout in milliseconds for each signal connection attempt (default: 5000)
   optional RoomDataStreamOptions data_stream = 10; // data stream behavior for this room
+  // Comma separated list of additional LiveKit SDKs layered on top of this one, with versions,
+  // e.g. "components-js:1.2.3,track-processors-js:1.2.3". Forwarded to ClientInfo.other_sdks.
+  optional string other_sdks = 11;
 }
 
 //

livekit-ffi/src/conversion/room.rs

@@ -300,6 +300,7 @@ impl From<proto::RoomOptions> for RoomOptions {
             value.single_peer_connection.unwrap_or(options.single_peer_connection);
         options.connect_timeout =
             value.connect_timeout_ms.map(Duration::from_millis).unwrap_or(options.connect_timeout);
+        options.sdk_options.other_sdks = value.other_sdks;
         if let Some(data_stream) = value.data_stream {
             let mut data_stream_options = RoomDataStreamOptions::default();
             if let Some(max_payload_byte_length) = data_stream.max_payload_byte_length {
@@ -383,7 +384,10 @@ impl From<proto::AudioEncoding> for AudioEncoding {
 
 #[cfg(test)]
 mod tests {
-    use livekit::options::{TrackPublishOptions, VideoEncoderBackend};
+    use livekit::{
+        options::{TrackPublishOptions, VideoEncoderBackend},
+        prelude::RoomOptions,
+    };
 
     use super::{frame_metadata_features_from_proto, video_encoder_from_proto};
     use crate::proto;
@@ -407,6 +411,23 @@ mod tests {
         assert!(features.frame_id);
     }
 
+    #[test]
+    fn other_sdks_round_trips_from_room_options() {
+        let options = RoomOptions::from(proto::RoomOptions {
+            other_sdks: Some("ros_portal:1.2.3".to_string()),
+            ..Default::default()
+        });
+
+        assert_eq!(options.sdk_options.other_sdks.as_deref(), Some("ros_portal:1.2.3"));
+    }
+
+    #[test]
+    fn other_sdks_defaults_to_none() {
+        let options = RoomOptions::from(proto::RoomOptions::default());
+
+        assert!(options.sdk_options.other_sdks.is_none());
+    }
+
     #[test]
     fn video_encoder_defaults_to_auto() {
         let options = TrackPublishOptions::from(proto::TrackPublishOptions::default());

livekit-protocol/protocol

@@ -383,11 +383,15 @@ pub struct RpcAck {
 pub struct RoomSdkOptions {
     pub sdk: String,
     pub sdk_version: String,
+    /// Comma separated list of additional LiveKit SDKs layered on top of this one, with
+    /// versions, e.g. `"components-js:1.2.3,track-processors-js:1.2.3"`. Reported to the
+    /// server as `ClientInfo.other_sdks`. `None` when there are none.
+    pub other_sdks: Option<String>,
 }
 
 impl Default for RoomSdkOptions {
     fn default() -> Self {
-        Self { sdk: "rust".to_string(), sdk_version: SDK_VERSION.to_string() }
+        Self { sdk: "rust".to_string(), sdk_version: SDK_VERSION.to_string(), other_sdks: None }
     }
 }
 
@@ -396,6 +400,7 @@ impl From<RoomSdkOptions> for SignalSdkOptions {
         let mut sdk_options = SignalSdkOptions::default();
         sdk_options.sdk = options.sdk;
         sdk_options.sdk_version = Some(options.sdk_version);
+        sdk_options.other_sdks = options.other_sdks;
         sdk_options
     }
 }