| | |
| | | use std::{io, time::Duration}; |
| | | use std::{collections::HashMap, io, time::Duration}; |
| | | |
| | | use anyhow::{Context, Result, anyhow}; |
| | | use base64::{Engine as _, engine::general_purpose}; |
| | |
| | | pub(crate) chunk_duration_ms: u64, |
| | | } |
| | | |
| | | #[derive(Clone, Debug, PartialEq, Eq)] |
| | | pub(crate) struct AudioIngressMetadata { |
| | | pub(crate) input_source_category: String, |
| | | pub(crate) client_fixture_sequence: String, |
| | | } |
| | | |
| | | impl AudioIngressMetadata { |
| | | pub(crate) fn origin_status(attributes: &HashMap<String, String>) -> &'static str { |
| | | let source = attributes.get("inputSourceCategory").map(String::as_str); |
| | | let sequence = attributes.get("clientFixtureSequence").map(String::as_str); |
| | | match (source, sequence) { |
| | | (None, None) => "ordinary_mic_absent", |
| | | (Some("controlled_fixture"), Some(sequence)) if valid_sequence(sequence) => { |
| | | "controlled_fixture_bound" |
| | | } |
| | | (Some("controlled_fixture"), None) => "sequence_absent", |
| | | (Some("controlled_fixture"), Some(_)) => "participant_attributes_invalid", |
| | | (Some(_), _) | (None, Some(_)) => "participant_attributes_invalid", |
| | | } |
| | | } |
| | | |
| | | pub(crate) fn from_participant( |
| | | attributes: &HashMap<String, String>, |
| | | ) -> Result<Option<Self>, &'static str> { |
| | | let source = attributes.get("inputSourceCategory").map(String::as_str); |
| | | let sequence = attributes.get("clientFixtureSequence").map(String::as_str); |
| | | match (source, sequence) { |
| | | (None, None) => Ok(None), |
| | | (Some("controlled_fixture"), Some(sequence)) if valid_sequence(sequence) => { |
| | | Ok(Some(Self { |
| | | input_source_category: "controlled_fixture".to_string(), |
| | | client_fixture_sequence: sequence.to_string(), |
| | | })) |
| | | } |
| | | (Some(_), _) => Err("invalid_source_or_sequence"), |
| | | _ => Err("incomplete_metadata"), |
| | | } |
| | | } |
| | | } |
| | | |
| | | fn valid_sequence(value: &str) -> bool { |
| | | !value.is_empty() |
| | | && value.len() <= 64 |
| | | && value |
| | | .chars() |
| | | .all(|ch| ch.is_ascii_alphanumeric() || matches!(ch, '-' | '_' | '.')) |
| | | } |
| | | |
| | | impl RealtimeAsrConfig { |
| | | pub(crate) fn is_ready(&self) -> bool { |
| | | self.enabled |
| | |
| | | } |
| | | |
| | | impl RealtimeAsrUpload { |
| | | pub(crate) fn start_with_participant_attributes<F>( |
| | | http: Client, |
| | | config: RealtimeAsrConfig, |
| | | call_id: &str, |
| | | trace_id: &str, |
| | | turn_id: &str, |
| | | initial_samples_48k: &[i16], |
| | | read_attributes: F, |
| | | ) -> Result<Self> |
| | | where |
| | | F: FnOnce() -> HashMap<String, String>, |
| | | { |
| | | let metadata = AudioIngressMetadata::from_participant(&read_attributes()) |
| | | .map_err(|reason| anyhow!(reason))?; |
| | | Self::start( |
| | | http, |
| | | config, |
| | | call_id, |
| | | trace_id, |
| | | turn_id, |
| | | initial_samples_48k, |
| | | metadata.as_ref(), |
| | | ) |
| | | } |
| | | |
| | | pub(crate) fn start( |
| | | http: Client, |
| | | config: RealtimeAsrConfig, |
| | |
| | | trace_id: &str, |
| | | turn_id: &str, |
| | | initial_samples_48k: &[i16], |
| | | ingress_metadata: Option<&AudioIngressMetadata>, |
| | | ) -> Result<Self> { |
| | | if !config.is_ready() { |
| | | return Err(anyhow!("realtime asr config is not ready")); |
| | | } |
| | | let nonce = config.runtime_session_nonce.as_deref().unwrap_or_default(); |
| | | let session_line = session_start_line(call_id, trace_id, turn_id, nonce)?; |
| | | let session_line = session_start_line(call_id, trace_id, turn_id, nonce, ingress_metadata)?; |
| | | let (sender, receiver) = mpsc::channel(UPLOAD_QUEUE_CAPACITY); |
| | | let request_call_id = call_id.to_string(); |
| | | let request_trace_id = trace_id.to_string(); |
| | |
| | | samples: Vec<i16>, |
| | | } |
| | | |
| | | fn session_start_line( |
| | | pub(crate) fn session_start_line( |
| | | call_id: &str, |
| | | trace_id: &str, |
| | | turn_id: &str, |
| | | runtime_session_nonce: &str, |
| | | ingress_metadata: Option<&AudioIngressMetadata>, |
| | | ) -> Result<Vec<u8>> { |
| | | encode_line(json!({ |
| | | let mut line = json!({ |
| | | "event": "session_start", |
| | | "callId": call_id, |
| | | "traceId": trace_id, |
| | |
| | | "sampleRate": SAMPLE_RATE_16K, |
| | | "channels": CHANNELS_MONO, |
| | | } |
| | | })) |
| | | }); |
| | | if let Some(metadata) = ingress_metadata { |
| | | line["inputSourceCategory"] = json!(metadata.input_source_category); |
| | | line["clientFixtureSequence"] = json!(metadata.client_fixture_sequence); |
| | | } |
| | | line["audioIngressOriginStatus"] = json!(match ingress_metadata { |
| | | Some(_) => "controlled_fixture_bound", |
| | | None => "ordinary_mic_absent", |
| | | }); |
| | | encode_line(line) |
| | | } |
| | | |
| | | fn audio_chunk_line(chunk_seq: u64, samples: &[i16]) -> Result<Vec<u8>> { |
| | |
| | | |
| | | #[test] |
| | | fn session_start_uses_canonical_nonce_hash_and_audio_contract() { |
| | | let line = session_start_line("call-001", "trace-001", "turn-0001", "nonce-001") |
| | | let line = session_start_line("call-001", "trace-001", "turn-0001", "nonce-001", None) |
| | | .expect("session start line"); |
| | | let value: serde_json::Value = serde_json::from_slice(&line).expect("valid json"); |
| | | |
| | |
| | | assert_eq!("pcm_s16le", value["audio"]["format"]); |
| | | assert_eq!(16000, value["audio"]["sampleRate"]); |
| | | assert_eq!(1, value["audio"]["channels"]); |
| | | assert_eq!("ordinary_mic_absent", value["audioIngressOriginStatus"]); |
| | | } |
| | | |
| | | #[test] |
| | | fn participant_attributes_only_metadata_is_bounded_and_frozen() { |
| | | let mut attributes = HashMap::new(); |
| | | attributes.insert( |
| | | "inputSourceCategory".to_string(), |
| | | "controlled_fixture".to_string(), |
| | | ); |
| | | attributes.insert( |
| | | "clientFixtureSequence".to_string(), |
| | | "fixture-01".to_string(), |
| | | ); |
| | | let metadata = |
| | | AudioIngressMetadata::from_participant(&attributes).expect("valid attributes"); |
| | | assert_eq!( |
| | | Some(AudioIngressMetadata { |
| | | input_source_category: "controlled_fixture".to_string(), |
| | | client_fixture_sequence: "fixture-01".to_string(), |
| | | }), |
| | | metadata |
| | | ); |
| | | assert_eq!( |
| | | "controlled_fixture_bound", |
| | | AudioIngressMetadata::origin_status(&attributes) |
| | | ); |
| | | |
| | | attributes.insert( |
| | | "clientFixtureSequence".to_string(), |
| | | "bad sequence".to_string(), |
| | | ); |
| | | assert_eq!( |
| | | Err("invalid_source_or_sequence"), |
| | | AudioIngressMetadata::from_participant(&attributes) |
| | | ); |
| | | assert_eq!( |
| | | Ok(None), |
| | | AudioIngressMetadata::from_participant(&HashMap::new()) |
| | | ); |
| | | attributes.remove("clientFixtureSequence"); |
| | | assert_eq!( |
| | | "sequence_absent", |
| | | AudioIngressMetadata::origin_status(&attributes) |
| | | ); |
| | | attributes.insert( |
| | | "clientFixtureSequence".to_string(), |
| | | "bad sequence".to_string(), |
| | | ); |
| | | assert_eq!( |
| | | "participant_attributes_invalid", |
| | | AudioIngressMetadata::origin_status(&attributes) |
| | | ); |
| | | assert_eq!( |
| | | "ordinary_mic_absent", |
| | | AudioIngressMetadata::origin_status(&HashMap::new()) |
| | | ); |
| | | } |
| | | |
| | | #[test] |
| | | fn session_start_omits_absent_attributes_and_emits_bound_attributes() { |
| | | let bound = AudioIngressMetadata { |
| | | input_source_category: "controlled_fixture".to_string(), |
| | | client_fixture_sequence: "fixture-01".to_string(), |
| | | }; |
| | | let absent = serde_json::from_slice::<serde_json::Value>( |
| | | &session_start_line("call-001", "trace-001", "turn-0001", "nonce-001", None) |
| | | .expect("absent session line"), |
| | | ) |
| | | .expect("absent json"); |
| | | assert!(absent.get("inputSourceCategory").is_none()); |
| | | assert_eq!("ordinary_mic_absent", absent["audioIngressOriginStatus"]); |
| | | let with_metadata = serde_json::from_slice::<serde_json::Value>( |
| | | &session_start_line( |
| | | "call-001", |
| | | "trace-001", |
| | | "turn-0001", |
| | | "nonce-001", |
| | | Some(&bound), |
| | | ) |
| | | .expect("bound session line"), |
| | | ) |
| | | .expect("bound json"); |
| | | assert_eq!("controlled_fixture", with_metadata["inputSourceCategory"]); |
| | | assert_eq!("fixture-01", with_metadata["clientFixtureSequence"]); |
| | | assert_eq!( |
| | | "controlled_fixture_bound", |
| | | with_metadata["audioIngressOriginStatus"] |
| | | ); |
| | | let next = AudioIngressMetadata { |
| | | input_source_category: "controlled_fixture".to_string(), |
| | | client_fixture_sequence: "fixture-02".to_string(), |
| | | }; |
| | | let next_line = session_start_line( |
| | | "call-001", |
| | | "trace-001", |
| | | "turn-0002", |
| | | "nonce-001", |
| | | Some(&next), |
| | | ) |
| | | .expect("next bound session line"); |
| | | let next_value: serde_json::Value = serde_json::from_slice(&next_line).expect("next json"); |
| | | assert_eq!("fixture-02", next_value["clientFixtureSequence"]); |
| | | assert_ne!( |
| | | with_metadata["clientFixtureSequence"], |
| | | next_value["clientFixtureSequence"] |
| | | ); |
| | | } |
| | | |
| | | #[tokio::test] |
| | | async fn production_session_boundary_reads_updated_attributes_per_session() { |
| | | let mut attributes = HashMap::new(); |
| | | attributes.insert( |
| | | "inputSourceCategory".to_string(), |
| | | "controlled_fixture".to_string(), |
| | | ); |
| | | attributes.insert( |
| | | "clientFixtureSequence".to_string(), |
| | | "fixture-01".to_string(), |
| | | ); |
| | | let (url1, captured1, server1) = |
| | | spawn_http_fixture(json!({"code": 0, "data": {"status": "cancelled"}}).to_string()); |
| | | let upload1 = RealtimeAsrUpload::start_with_participant_attributes( |
| | | Client::new(), |
| | | fixture_config(url1), |
| | | "call-001", |
| | | "trace-001", |
| | | "turn-0001", |
| | | &vec![1; 9_600], |
| | | || attributes.clone(), |
| | | ) |
| | | .expect("session one"); |
| | | upload1.cancel("test").await; |
| | | let request1 = captured1.recv().expect("session one request"); |
| | | server1.join().expect("session one server"); |
| | | assert!( |
| | | request1 |
| | | .body |
| | | .contains("\"clientFixtureSequence\":\"fixture-01\"") |
| | | ); |
| | | assert!(!request1.body.contains("fixture-02")); |
| | | |
| | | attributes.insert( |
| | | "clientFixtureSequence".to_string(), |
| | | "fixture-02".to_string(), |
| | | ); |
| | | let (url2, captured2, server2) = |
| | | spawn_http_fixture(json!({"code": 0, "data": {"status": "cancelled"}}).to_string()); |
| | | let upload2 = RealtimeAsrUpload::start_with_participant_attributes( |
| | | Client::new(), |
| | | fixture_config(url2), |
| | | "call-001", |
| | | "trace-001", |
| | | "turn-0002", |
| | | &vec![1; 9_600], |
| | | || attributes.clone(), |
| | | ) |
| | | .expect("session two"); |
| | | upload2.cancel("test").await; |
| | | let request2 = captured2.recv().expect("session two request"); |
| | | server2.join().expect("session two server"); |
| | | assert!( |
| | | request2 |
| | | .body |
| | | .contains("\"clientFixtureSequence\":\"fixture-02\"") |
| | | ); |
| | | assert!(!request2.body.contains("fixture-01")); |
| | | } |
| | | |
| | | #[test] |
| | |
| | | "trace-001", |
| | | "turn-0001", |
| | | &vec![1; 9_600], |
| | | None, |
| | | ) |
| | | .expect("start upload"); |
| | | upload |
| | |
| | | "trace-002", |
| | | "turn-0002", |
| | | &vec![1; 9_600], |
| | | None, |
| | | ) |
| | | .expect("start upload"); |
| | | |