1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
//! Types for the websocket server.
use std::borrow::Cow;
use parse_display_derive::{Display, FromStr};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
#[cfg(feature = "slog")]
use slog::{Record, Serializer, KV};
use uuid::Uuid;
use crate::{
id::ModelingCmdId,
ok_response::OkModelingCmdResponse,
shared::{EngineErrorCode, ExportFile},
ModelingCmd,
};
/// The type of error sent by the KittyCAD API.
#[derive(Display, FromStr, Copy, Eq, PartialEq, Debug, JsonSchema, Deserialize, Serialize, Clone, Ord, PartialOrd)]
#[serde(rename_all = "snake_case")]
pub enum ErrorCode {
/// Graphics engine failed to complete request, consider retrying
InternalEngine,
/// API failed to complete request, consider retrying
InternalApi,
/// User requested something geometrically or graphically impossible.
/// Don't retry this request, as it's inherently impossible. Instead, read the error message
/// and change your request.
BadRequest,
/// Client sent invalid JSON.
InvalidJson,
/// Client sent invalid BSON.
InvalidBson,
/// Client sent a message which is not accepted over this protocol.
WrongProtocol,
/// Problem sending data between client and KittyCAD API.
ConnectionProblem,
/// Client sent a Websocket message type which the KittyCAD API does not handle.
MessageTypeNotAccepted,
/// Client sent a Websocket message intended for WebRTC but it was configured as a WebRTC
/// connection.
MessageTypeNotAcceptedForWebRTC,
}
/// Because [`EngineErrorCode`] is a subset of [`ErrorCode`], you can trivially map
/// each variant of the former to a variant of the latter.
impl From<EngineErrorCode> for ErrorCode {
fn from(value: EngineErrorCode) -> Self {
match value {
EngineErrorCode::InternalEngine => Self::InternalEngine,
EngineErrorCode::BadRequest => Self::BadRequest,
}
}
}
/// A graphics command submitted to the KittyCAD engine via the Modeling API.
#[derive(Debug, Clone, JsonSchema, Deserialize, Serialize)]
pub struct ModelingCmdReq {
/// Which command to submit to the Kittycad engine.
pub cmd: ModelingCmd,
/// ID of command being submitted.
pub cmd_id: ModelingCmdId,
}
/// The websocket messages the server receives.
#[derive(Serialize, Deserialize, JsonSchema, Debug)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum WebSocketRequest {
/// The trickle ICE candidate request.
// We box these to avoid a huge size difference between variants.
TrickleIce {
/// Information about the ICE candidate.
candidate: Box<RtcIceCandidateInit>,
},
/// The SDP offer request.
SdpOffer {
/// The session description.
offer: Box<RtcSessionDescription>,
},
/// The modeling command request.
ModelingCmdReq(ModelingCmdReq),
/// A sequence of modeling requests. If any request fails, following requests will not be tried.
ModelingCmdBatchReq(ModelingBatch),
/// The client-to-server Ping to ensure the WebSocket stays alive.
Ping {},
/// The response to a metrics collection request from the server.
MetricsResponse {
/// Collected metrics from the Client's end of the engine connection.
metrics: Box<ClientMetrics>,
},
}
/// A sequence of modeling requests. If any request fails, following requests will not be tried.
#[derive(Serialize, Deserialize, JsonSchema, Debug)]
#[serde(rename_all = "snake_case")]
pub struct ModelingBatch {
/// A sequence of modeling requests. If any request fails, following requests will not be tried.
pub requests: Vec<ModelingCmdReq>,
/// ID of batch being submitted.
/// Each request has their own individual ModelingCmdId, but this is the
/// ID of the overall batch.
pub batch_id: ModelingCmdId,
/// If false or omitted, responses to each batch command will just be Ok(()).
/// If true, responses will be the actual response data for that modeling command.
#[serde(default)]
pub responses: bool,
}
impl std::default::Default for ModelingBatch {
/// Creates a batch with 0 requests and a random ID.
fn default() -> Self {
Self {
requests: Default::default(),
batch_id: Uuid::new_v4().into(),
responses: false,
}
}
}
impl ModelingBatch {
/// Add a new modeling command to the end of this batch.
pub fn push(&mut self, req: ModelingCmdReq) {
self.requests.push(req);
}
/// Are there any requests in the batch?
pub fn is_empty(&self) -> bool {
self.requests.is_empty()
}
}
/// Representation of an ICE server used for STUN/TURN
/// Used to initiate WebRTC connections
/// based on <https://developer.mozilla.org/en-US/docs/Web/API/RTCIceServer>
#[derive(serde::Serialize, serde::Deserialize, Debug, JsonSchema)]
pub struct IceServer {
/// URLs for a given STUN/TURN server.
/// IceServer urls can either be a string or an array of strings
/// But, we choose to always convert to an array of strings for consistency
pub urls: Vec<String>,
/// Credentials for a given TURN server.
pub credential: Option<String>,
/// Username for a given TURN server.
pub username: Option<String>,
}
/// The websocket messages this server sends.
#[derive(Serialize, Deserialize, JsonSchema, Debug)]
#[serde(tag = "type", content = "data", rename_all = "snake_case")]
pub enum OkWebSocketResponseData {
/// Information about the ICE servers.
IceServerInfo {
/// Information about the ICE servers.
ice_servers: Vec<IceServer>,
},
/// The trickle ICE candidate response.
// We box these to avoid a huge size difference between variants.
TrickleIce {
/// Information about the ICE candidate.
candidate: Box<RtcIceCandidateInit>,
},
/// The SDP answer response.
SdpAnswer {
/// The session description.
answer: Box<RtcSessionDescription>,
},
/// The modeling command response.
Modeling {
/// The result of the command.
modeling_response: OkModelingCmdResponse,
},
/// The exported files.
Export {
/// The exported files
files: Vec<RawFile>,
},
/// Request a collection of metrics, to include WebRTC.
MetricsRequest {},
/// Pong response to a Ping message.
Pong {},
}
/// Successful Websocket response.
#[derive(JsonSchema, Debug, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct SuccessWebSocketResponse {
/// Always true
pub success: bool,
/// Which request this is a response to.
/// If the request was a modeling command, this is the modeling command ID.
/// If no request ID was sent, this will be null.
pub request_id: Option<Uuid>,
/// The data sent with a successful response.
/// This will be flattened into a 'type' and 'data' field.
pub resp: OkWebSocketResponseData,
}
/// Unsuccessful Websocket response.
#[derive(JsonSchema, Debug, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct FailureWebSocketResponse {
/// Always false
pub success: bool,
/// Which request this is a response to.
/// If the request was a modeling command, this is the modeling command ID.
/// If no request ID was sent, this will be null.
pub request_id: Option<Uuid>,
/// The errors that occurred.
pub errors: Vec<ApiError>,
}
/// Websocket responses can either be successful or unsuccessful.
/// Slightly different schemas in either case.
#[derive(JsonSchema, Debug, Serialize, Deserialize)]
#[serde(rename_all = "snake_case", untagged)]
pub enum WebSocketResponse {
/// Response sent when a request succeeded.
Success(SuccessWebSocketResponse),
/// Response sent when a request did not succeed.
Failure(FailureWebSocketResponse),
}
impl WebSocketResponse {
/// Make a new success response.
pub fn success(request_id: Option<Uuid>, resp: OkWebSocketResponseData) -> Self {
Self::Success(SuccessWebSocketResponse {
success: true,
request_id,
resp,
})
}
/// Make a new failure response.
pub fn failure(request_id: Option<Uuid>, errors: Vec<ApiError>) -> Self {
Self::Failure(FailureWebSocketResponse {
success: false,
request_id,
errors,
})
}
/// Did the request succeed?
pub fn is_success(&self) -> bool {
matches!(self, Self::Success(_))
}
/// Did the request fail?
pub fn is_failure(&self) -> bool {
matches!(self, Self::Failure(_))
}
/// Get the ID of whichever request this response is for.
pub fn request_id(&self) -> Option<Uuid> {
match self {
WebSocketResponse::Success(x) => x.request_id,
WebSocketResponse::Failure(x) => x.request_id,
}
}
}
/// A raw file with unencoded contents to be passed over binary websockets.
/// When raw files come back for exports it is sent as binary/bson, not text/json.
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct RawFile {
/// The name of the file.
pub name: String,
/// The contents of the file.
#[serde(
serialize_with = "serde_bytes::serialize",
deserialize_with = "serde_bytes::deserialize"
)]
pub contents: Vec<u8>,
}
impl From<ExportFile> for RawFile {
fn from(f: ExportFile) -> Self {
Self {
name: f.name,
contents: f.contents.0,
}
}
}
/// An error with an internal message for logging.
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct LoggableApiError {
/// The error shown to users
pub error: ApiError,
/// The string logged internally
pub msg_internal: Option<Cow<'static, str>>,
}
#[cfg(feature = "slog")]
impl KV for LoggableApiError {
fn serialize(&self, _rec: &Record, serializer: &mut dyn Serializer) -> slog::Result {
if let Some(ref msg_internal) = self.msg_internal {
serializer.emit_str("msg_internal", msg_internal)?;
}
serializer.emit_str("msg_external", &self.error.message)?;
serializer.emit_str("error_code", &self.error.error_code.to_string())
}
}
/// An error.
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ApiError {
/// The error code.
pub error_code: ErrorCode,
/// The error message.
pub message: String,
}
impl ApiError {
/// Convert to a `LoggableApiError` with no internal message.
pub fn no_internal_message(self) -> LoggableApiError {
LoggableApiError {
error: self,
msg_internal: None,
}
}
/// Add an internal log message to this error.
pub fn with_message(self, msg_internal: Cow<'static, str>) -> LoggableApiError {
LoggableApiError {
error: self,
msg_internal: Some(msg_internal),
}
}
/// Should the internal error message be logged?
pub fn should_log_internal_message(&self) -> bool {
use ErrorCode as Code;
match self.error_code {
// Internal errors should always be logged, as they're problems with KittyCAD programming
Code::InternalEngine | Code::InternalApi => true,
// The user did something wrong, no need to log it, as there's nothing KittyCAD programmers can fix
Code::MessageTypeNotAcceptedForWebRTC
| Code::MessageTypeNotAccepted
| Code::BadRequest
| Code::WrongProtocol
| Code::InvalidBson
| Code::InvalidJson => false,
// In debug builds, log connection problems, otherwise don't.
Code::ConnectionProblem => cfg!(debug_assertions),
}
}
}
/// Serde serializes Result into JSON as "Ok" and "Err", but we want "ok" and "err".
/// So, create a new enum that serializes as lowercase.
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case", rename = "SnakeCaseResult")]
pub enum SnakeCaseResult<T, E> {
/// The result is Ok.
Ok(T),
/// The result is Err.
Err(E),
}
impl<T, E> From<SnakeCaseResult<T, E>> for Result<T, E> {
fn from(value: SnakeCaseResult<T, E>) -> Self {
match value {
SnakeCaseResult::Ok(x) => Self::Ok(x),
SnakeCaseResult::Err(x) => Self::Err(x),
}
}
}
impl<T, E> From<Result<T, E>> for SnakeCaseResult<T, E> {
fn from(value: Result<T, E>) -> Self {
match value {
Ok(x) => Self::Ok(x),
Err(x) => Self::Err(x),
}
}
}
/// ClientMetrics contains information regarding the state of the peer.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
pub struct ClientMetrics {
/// Counter of the number of WebRTC frames the client has dropped during
/// this session.
pub rtc_frames_dropped: u32,
/// Counter of the number of WebRTC frames that the client has decoded
/// during this session.
pub rtc_frames_decoded: u64,
/// Counter of the number of WebRTC frames that the client has received
/// during this session.
pub rtc_frames_received: u64,
/// Current number of frames being rendered per second. A good target
/// is 60 frames per second, but it can fluctuate depending on network
/// conditions.
pub rtc_frames_per_second: u8, // no way we're more than 255 fps :)
/// Number of times the WebRTC playback has frozen. This is usually due to
/// network conditions.
pub rtc_freeze_count: u32,
/// Amount of "jitter" in the WebRTC session. Network latency is the time
/// it takes a packet to traverse the network. The amount that the latency
/// varies is the jitter. Video latency is the time it takes to render
/// a frame sent by the server (including network latency). A low jitter
/// means the video latency can be reduced without impacting smooth
/// playback. High jitter means clients will increase video latency to
/// ensure smooth playback.
pub rtc_jitter_sec: f32,
/// Number of "key frames" decoded in the underlying h.264 stream. A
/// key frame is an expensive (bandwidth-wise) "full image" of the video
/// frame. Data after the keyframe become -- effectively -- "diff"
/// operations on that key frame. The Engine will only send a keyframe if
/// required, which is an indication that some of the "diffs" have been
/// lost, usually an indication of poor network conditions. We like this
/// metric to understand times when the connection has had to recover.
pub rtc_keyframes_decoded: u32,
/// Number of seconds of frozen video the user has been subjected to.
pub rtc_total_freezes_duration_sec: f32,
}
/// ICECandidate represents a ice candidate
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct RtcIceCandidate {
/// The stats ID.
pub stats_id: String,
/// The foundation for the address.
pub foundation: String,
/// The priority of the candidate.
pub priority: u32,
/// The address of the candidate.
pub address: String,
/// The protocol used for the candidate.
pub protocol: RtcIceProtocol,
/// The port used for the candidate.
pub port: u16,
/// The type of the candidate.
pub typ: RtcIceCandidateType,
/// The component of the candidate.
pub component: u16,
/// The related address of the candidate.
pub related_address: String,
/// The related port of the candidate.
pub related_port: u16,
/// The TCP type of the candidate.
pub tcp_type: String,
}
impl From<webrtc::ice_transport::ice_candidate::RTCIceCandidate> for RtcIceCandidate {
fn from(candidate: webrtc::ice_transport::ice_candidate::RTCIceCandidate) -> Self {
Self {
stats_id: candidate.stats_id,
foundation: candidate.foundation,
priority: candidate.priority,
address: candidate.address,
protocol: candidate.protocol.into(),
port: candidate.port,
typ: candidate.typ.into(),
component: candidate.component,
related_address: candidate.related_address,
related_port: candidate.related_port,
tcp_type: candidate.tcp_type,
}
}
}
impl From<RtcIceCandidate> for webrtc::ice_transport::ice_candidate::RTCIceCandidate {
fn from(candidate: RtcIceCandidate) -> Self {
Self {
stats_id: candidate.stats_id,
foundation: candidate.foundation,
priority: candidate.priority,
address: candidate.address,
protocol: candidate.protocol.into(),
port: candidate.port,
typ: candidate.typ.into(),
component: candidate.component,
related_address: candidate.related_address,
related_port: candidate.related_port,
tcp_type: candidate.tcp_type,
}
}
}
/// ICECandidateType represents the type of the ICE candidate used.
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum RtcIceCandidateType {
/// Unspecified indicates that the candidate type is unspecified.
#[default]
Unspecified,
/// ICECandidateTypeHost indicates that the candidate is of Host type as
/// described in <https://tools.ietf.org/html/rfc8445#section-5.1.1.1>. A
/// candidate obtained by binding to a specific port from an IP address on
/// the host. This includes IP addresses on physical interfaces and logical
/// ones, such as ones obtained through VPNs.
Host,
/// ICECandidateTypeSrflx indicates the the candidate is of Server
/// Reflexive type as described
/// <https://tools.ietf.org/html/rfc8445#section-5.1.1.2>. A candidate type
/// whose IP address and port are a binding allocated by a NAT for an ICE
/// agent after it sends a packet through the NAT to a server, such as a
/// STUN server.
Srflx,
/// ICECandidateTypePrflx indicates that the candidate is of Peer
/// Reflexive type. A candidate type whose IP address and port are a binding
/// allocated by a NAT for an ICE agent after it sends a packet through the
/// NAT to its peer.
Prflx,
/// ICECandidateTypeRelay indicates the the candidate is of Relay type as
/// described in <https://tools.ietf.org/html/rfc8445#section-5.1.1.2>. A
/// candidate type obtained from a relay server, such as a TURN server.
Relay,
}
impl From<webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType> for RtcIceCandidateType {
fn from(candidate_type: webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType) -> Self {
match candidate_type {
webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType::Host => RtcIceCandidateType::Host,
webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType::Srflx => RtcIceCandidateType::Srflx,
webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType::Prflx => RtcIceCandidateType::Prflx,
webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType::Relay => RtcIceCandidateType::Relay,
webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType::Unspecified => {
RtcIceCandidateType::Unspecified
}
}
}
}
impl From<RtcIceCandidateType> for webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType {
fn from(candidate_type: RtcIceCandidateType) -> Self {
match candidate_type {
RtcIceCandidateType::Host => webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType::Host,
RtcIceCandidateType::Srflx => webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType::Srflx,
RtcIceCandidateType::Prflx => webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType::Prflx,
RtcIceCandidateType::Relay => webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType::Relay,
RtcIceCandidateType::Unspecified => {
webrtc::ice_transport::ice_candidate_type::RTCIceCandidateType::Unspecified
}
}
}
}
/// ICEProtocol indicates the transport protocol type that is used in the
/// ice.URL structure.
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum RtcIceProtocol {
/// Unspecified indicates that the protocol is unspecified.
#[default]
Unspecified,
/// UDP indicates the URL uses a UDP transport.
Udp,
/// TCP indicates the URL uses a TCP transport.
Tcp,
}
impl From<webrtc::ice_transport::ice_protocol::RTCIceProtocol> for RtcIceProtocol {
fn from(protocol: webrtc::ice_transport::ice_protocol::RTCIceProtocol) -> Self {
match protocol {
webrtc::ice_transport::ice_protocol::RTCIceProtocol::Udp => RtcIceProtocol::Udp,
webrtc::ice_transport::ice_protocol::RTCIceProtocol::Tcp => RtcIceProtocol::Tcp,
webrtc::ice_transport::ice_protocol::RTCIceProtocol::Unspecified => RtcIceProtocol::Unspecified,
}
}
}
impl From<RtcIceProtocol> for webrtc::ice_transport::ice_protocol::RTCIceProtocol {
fn from(protocol: RtcIceProtocol) -> Self {
match protocol {
RtcIceProtocol::Udp => webrtc::ice_transport::ice_protocol::RTCIceProtocol::Udp,
RtcIceProtocol::Tcp => webrtc::ice_transport::ice_protocol::RTCIceProtocol::Tcp,
RtcIceProtocol::Unspecified => webrtc::ice_transport::ice_protocol::RTCIceProtocol::Unspecified,
}
}
}
/// ICECandidateInit is used to serialize ice candidates
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
// These HAVE to be camel case as per the RFC.
pub struct RtcIceCandidateInit {
/// The candidate string associated with the object.
pub candidate: String,
/// The identifier of the "media stream identification" as defined in
/// [RFC 8841](https://tools.ietf.org/html/rfc8841).
pub sdp_mid: Option<String>,
/// The index (starting at zero) of the m-line in the SDP this candidate is
/// associated with.
#[serde(rename = "sdpMLineIndex")]
pub sdp_mline_index: Option<u16>,
/// The username fragment (as defined in
/// [RFC 8445](https://tools.ietf.org/html/rfc8445#section-5.2.1)) associated with the object.
pub username_fragment: Option<String>,
}
impl From<webrtc::ice_transport::ice_candidate::RTCIceCandidateInit> for RtcIceCandidateInit {
fn from(candidate: webrtc::ice_transport::ice_candidate::RTCIceCandidateInit) -> Self {
Self {
candidate: candidate.candidate,
sdp_mid: candidate.sdp_mid,
sdp_mline_index: candidate.sdp_mline_index,
username_fragment: candidate.username_fragment,
}
}
}
impl From<RtcIceCandidateInit> for webrtc::ice_transport::ice_candidate::RTCIceCandidateInit {
fn from(candidate: RtcIceCandidateInit) -> Self {
Self {
candidate: candidate.candidate,
sdp_mid: candidate.sdp_mid,
sdp_mline_index: candidate.sdp_mline_index,
username_fragment: candidate.username_fragment,
}
}
}
/// SessionDescription is used to expose local and remote session descriptions.
#[derive(Default, Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct RtcSessionDescription {
/// SDP type.
#[serde(rename = "type")]
pub sdp_type: RtcSdpType,
/// SDP string.
pub sdp: String,
}
impl From<webrtc::peer_connection::sdp::session_description::RTCSessionDescription> for RtcSessionDescription {
fn from(desc: webrtc::peer_connection::sdp::session_description::RTCSessionDescription) -> Self {
Self {
sdp_type: desc.sdp_type.into(),
sdp: desc.sdp,
}
}
}
impl TryFrom<RtcSessionDescription> for webrtc::peer_connection::sdp::session_description::RTCSessionDescription {
type Error = anyhow::Error;
fn try_from(desc: RtcSessionDescription) -> Result<Self, Self::Error> {
let result = match desc.sdp_type {
RtcSdpType::Offer => {
webrtc::peer_connection::sdp::session_description::RTCSessionDescription::offer(desc.sdp)?
}
RtcSdpType::Pranswer => {
webrtc::peer_connection::sdp::session_description::RTCSessionDescription::pranswer(desc.sdp)?
}
RtcSdpType::Answer => {
webrtc::peer_connection::sdp::session_description::RTCSessionDescription::answer(desc.sdp)?
}
RtcSdpType::Rollback => anyhow::bail!("Rollback is not supported"),
RtcSdpType::Unspecified => anyhow::bail!("Unspecified is not supported"),
};
Ok(result)
}
}
/// SDPType describes the type of an SessionDescription.
#[derive(Default, Debug, PartialEq, Eq, Copy, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum RtcSdpType {
/// Unspecified indicates that the type is unspecified.
#[default]
Unspecified = 0,
/// indicates that a description MUST be treated as an SDP offer.
Offer,
/// indicates that a description MUST be treated as an
/// SDP answer, but not a final answer. A description used as an SDP
/// pranswer may be applied as a response to an SDP offer, or an update to
/// a previously sent SDP pranswer.
Pranswer,
/// indicates that a description MUST be treated as an SDP
/// final answer, and the offer-answer exchange MUST be considered complete.
/// A description used as an SDP answer may be applied as a response to an
/// SDP offer or as an update to a previously sent SDP pranswer.
Answer,
/// indicates that a description MUST be treated as
/// canceling the current SDP negotiation and moving the SDP offer and
/// answer back to what it was in the previous stable state. Note the
/// local or remote SDP descriptions in the previous stable state could be
/// null if there has not yet been a successful offer-answer negotiation.
Rollback,
}
impl From<webrtc::peer_connection::sdp::sdp_type::RTCSdpType> for RtcSdpType {
fn from(sdp_type: webrtc::peer_connection::sdp::sdp_type::RTCSdpType) -> Self {
match sdp_type {
webrtc::peer_connection::sdp::sdp_type::RTCSdpType::Offer => Self::Offer,
webrtc::peer_connection::sdp::sdp_type::RTCSdpType::Pranswer => Self::Pranswer,
webrtc::peer_connection::sdp::sdp_type::RTCSdpType::Answer => Self::Answer,
webrtc::peer_connection::sdp::sdp_type::RTCSdpType::Rollback => Self::Rollback,
webrtc::peer_connection::sdp::sdp_type::RTCSdpType::Unspecified => Self::Unspecified,
}
}
}
impl From<RtcSdpType> for webrtc::peer_connection::sdp::sdp_type::RTCSdpType {
fn from(sdp_type: RtcSdpType) -> Self {
match sdp_type {
RtcSdpType::Offer => Self::Offer,
RtcSdpType::Pranswer => Self::Pranswer,
RtcSdpType::Answer => Self::Answer,
RtcSdpType::Rollback => Self::Rollback,
RtcSdpType::Unspecified => Self::Unspecified,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::output;
const REQ_ID: Uuid = uuid::uuid!("cc30d5e2-482b-4498-b5d2-6131c30a50a4");
#[test]
fn serialize_websocket_modeling_ok() {
let actual = WebSocketResponse::Success(SuccessWebSocketResponse {
success: true,
request_id: Some(REQ_ID),
resp: OkWebSocketResponseData::Modeling {
modeling_response: OkModelingCmdResponse::CurveGetControlPoints(output::CurveGetControlPoints {
control_points: vec![],
}),
},
});
let expected = serde_json::json!({
"success": true,
"request_id": "cc30d5e2-482b-4498-b5d2-6131c30a50a4",
"resp": {
"type": "modeling",
"data": {
"modeling_response": {
"type": "curve_get_control_points",
"data": { "control_points": [] }
}
}
}
});
assert_json_eq(actual, expected);
}
#[test]
fn serialize_websocket_webrtc_ok() {
let actual = WebSocketResponse::Success(SuccessWebSocketResponse {
success: true,
request_id: Some(REQ_ID),
resp: OkWebSocketResponseData::IceServerInfo { ice_servers: vec![] },
});
let expected = serde_json::json!({
"success": true,
"request_id": "cc30d5e2-482b-4498-b5d2-6131c30a50a4",
"resp": {
"type": "ice_server_info",
"data": {
"ice_servers": []
}
}
});
assert_json_eq(actual, expected);
}
#[test]
fn serialize_websocket_export_ok() {
let actual = WebSocketResponse::Success(SuccessWebSocketResponse {
success: true,
request_id: Some(REQ_ID),
resp: OkWebSocketResponseData::Export { files: vec![] },
});
let expected = serde_json::json!({
"success": true,
"request_id": "cc30d5e2-482b-4498-b5d2-6131c30a50a4",
"resp": {
"type": "export",
"data": {"files": [] }
}
});
assert_json_eq(actual, expected);
}
#[test]
fn serialize_websocket_err() {
let actual = WebSocketResponse::Failure(FailureWebSocketResponse {
success: false,
request_id: Some(REQ_ID),
errors: vec![ApiError {
error_code: ErrorCode::InternalApi,
message: "you fucked up!".to_owned(),
}],
});
let expected = serde_json::json!({
"success": false,
"request_id": "cc30d5e2-482b-4498-b5d2-6131c30a50a4",
"errors": [
{
"error_code": "internal_api",
"message": "you fucked up!"
}
],
});
assert_json_eq(actual, expected);
}
#[test]
fn serialize_websocket_metrics() {
let actual = WebSocketRequest::MetricsResponse {
metrics: Box::new(ClientMetrics {
rtc_frames_dropped: 1,
rtc_frames_decoded: 2,
rtc_frames_per_second: 3,
rtc_frames_received: 4,
rtc_freeze_count: 5,
rtc_jitter_sec: 6.7,
rtc_keyframes_decoded: 8,
rtc_total_freezes_duration_sec: 9.1,
}),
};
let expected = serde_json::json!({
"type": "metrics_response",
"metrics": {
"rtc_frames_dropped": 1,
"rtc_frames_decoded": 2,
"rtc_frames_per_second": 3,
"rtc_frames_received": 4,
"rtc_freeze_count": 5,
"rtc_jitter_sec": 6.7,
"rtc_keyframes_decoded": 8,
"rtc_total_freezes_duration_sec": 9.1
},
});
assert_json_eq(actual, expected);
}
fn assert_json_eq<T: Serialize>(actual: T, expected: serde_json::Value) {
let json_str = serde_json::to_string(&actual).unwrap();
let actual: serde_json::Value = serde_json::from_str(&json_str).unwrap();
assert_eq!(actual, expected, "got\n{actual:#}\n, expected\n{expected:#}\n");
}
}