sonos-sdk-stream 0.5.2

Internal event streaming and subscription management for sonos-sdk
Documentation
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
//! Service-specific polling strategies
//!
//! Each poller delegates to sonos-api's `poll()` function, producing the canonical
//! State type as JSON. The scheduler compares JSON snapshots for change detection
//! and emits full-state events (same type as UPnP event streaming).
//!
//! Blocking I/O: sonos-api uses `ureq` (blocking HTTP). All real pollers wrap
//! `poll()` calls in `tokio::task::spawn_blocking` to avoid starving the async runtime.

use async_trait::async_trait;
use sonos_api::{Service, SonosClient};
use std::collections::HashMap;

use crate::error::{PollingError, PollingResult};
use crate::events::types::EventData;
use crate::registry::SpeakerServicePair;

/// Trait for service-specific polling strategies.
///
/// Each poller returns a JSON snapshot string and can convert it back to EventData.
#[async_trait]
pub trait ServicePoller: Send + Sync {
    /// Poll the device state and return a JSON snapshot for comparison.
    async fn poll_state(
        &self,
        client: &SonosClient,
        pair: &SpeakerServicePair,
    ) -> PollingResult<String>;

    /// Convert a JSON state snapshot back into an EventData variant.
    fn state_to_event_data(&self, json_state: &str) -> PollingResult<EventData>;

    /// Get the service type this poller handles.
    fn service_type(&self) -> Service;
}

/// Polling strategy for AVTransport service.
///
/// Delegates to `sonos_api::services::av_transport::state::poll()`.
pub struct AVTransportPoller;

#[async_trait]
impl ServicePoller for AVTransportPoller {
    async fn poll_state(
        &self,
        client: &SonosClient,
        pair: &SpeakerServicePair,
    ) -> PollingResult<String> {
        let client = client.clone();
        let ip = pair.speaker_ip.to_string();

        let state = tokio::task::spawn_blocking(move || {
            sonos_api::services::av_transport::state::poll(&client, &ip)
        })
        .await
        .map_err(|e| PollingError::Network(format!("Polling task panicked: {e}")))?
        .map_err(|e| PollingError::Network(e.to_string()))?;

        serde_json::to_string(&state)
            .map_err(|e| PollingError::StateParsing(format!("Failed to serialize state: {e}")))
    }

    fn state_to_event_data(&self, json_state: &str) -> PollingResult<EventData> {
        let state: sonos_api::services::av_transport::state::AVTransportState =
            serde_json::from_str(json_state).map_err(|e| {
                PollingError::StateParsing(format!("Failed to deserialize AVTransport state: {e}"))
            })?;
        Ok(EventData::AVTransport(state))
    }

    fn service_type(&self) -> Service {
        Service::AVTransport
    }
}

/// Polling strategy for RenderingControl service.
///
/// Delegates to `sonos_api::services::rendering_control::state::poll()`.
pub struct RenderingControlPoller;

#[async_trait]
impl ServicePoller for RenderingControlPoller {
    async fn poll_state(
        &self,
        client: &SonosClient,
        pair: &SpeakerServicePair,
    ) -> PollingResult<String> {
        let client = client.clone();
        let ip = pair.speaker_ip.to_string();

        let state = tokio::task::spawn_blocking(move || {
            sonos_api::services::rendering_control::state::poll(&client, &ip)
        })
        .await
        .map_err(|e| PollingError::Network(format!("Polling task panicked: {e}")))?
        .map_err(|e| PollingError::Network(e.to_string()))?;

        serde_json::to_string(&state)
            .map_err(|e| PollingError::StateParsing(format!("Failed to serialize state: {e}")))
    }

    fn state_to_event_data(&self, json_state: &str) -> PollingResult<EventData> {
        let state: sonos_api::services::rendering_control::state::RenderingControlState =
            serde_json::from_str(json_state).map_err(|e| {
                PollingError::StateParsing(format!(
                    "Failed to deserialize RenderingControl state: {e}"
                ))
            })?;
        Ok(EventData::RenderingControl(state))
    }

    fn service_type(&self) -> Service {
        Service::RenderingControl
    }
}

/// Polling strategy for ZoneGroupTopology service.
///
/// Delegates to `sonos_api::services::zone_group_topology::state::poll()`.
pub struct ZoneGroupTopologyPoller;

#[async_trait]
impl ServicePoller for ZoneGroupTopologyPoller {
    async fn poll_state(
        &self,
        client: &SonosClient,
        pair: &SpeakerServicePair,
    ) -> PollingResult<String> {
        let client = client.clone();
        let ip = pair.speaker_ip.to_string();

        let state = tokio::task::spawn_blocking(move || {
            sonos_api::services::zone_group_topology::state::poll(&client, &ip)
        })
        .await
        .map_err(|e| PollingError::Network(format!("Polling task panicked: {e}")))?
        .map_err(|e| PollingError::Network(e.to_string()))?;

        serde_json::to_string(&state)
            .map_err(|e| PollingError::StateParsing(format!("Failed to serialize state: {e}")))
    }

    fn state_to_event_data(&self, json_state: &str) -> PollingResult<EventData> {
        let state: sonos_api::services::zone_group_topology::state::ZoneGroupTopologyState =
            serde_json::from_str(json_state).map_err(|e| {
                PollingError::StateParsing(format!(
                    "Failed to deserialize ZoneGroupTopology state: {e}"
                ))
            })?;
        Ok(EventData::ZoneGroupTopology(state))
    }

    fn service_type(&self) -> Service {
        Service::ZoneGroupTopology
    }
}

/// Polling strategy for GroupManagement service.
///
/// GroupManagement is an action-only service with no Get operations.
/// Returns a stable empty JSON state (`"{}"`), so the scheduler never detects
/// changes after the initial poll.
///
/// **Startup behavior:** The first poll emits a single `GroupManagement` event
/// with all fields set to `None` (since `"{}"` deserializes to an all-`None`
/// `GroupManagementState`). This is benign — the sonos-state decoder ignores
/// `GroupManagement` events (returns an empty change set).
pub struct GroupManagementPoller;

#[async_trait]
impl ServicePoller for GroupManagementPoller {
    async fn poll_state(
        &self,
        _client: &SonosClient,
        _pair: &SpeakerServicePair,
    ) -> PollingResult<String> {
        // No Get operations — return stable empty state
        Ok("{}".to_string())
    }

    fn state_to_event_data(&self, json_state: &str) -> PollingResult<EventData> {
        let state: sonos_api::services::group_management::state::GroupManagementState =
            serde_json::from_str(json_state).map_err(|e| {
                PollingError::StateParsing(format!(
                    "Failed to deserialize GroupManagement state: {e}"
                ))
            })?;
        Ok(EventData::GroupManagement(state))
    }

    fn service_type(&self) -> Service {
        Service::GroupManagement
    }
}

/// Polling strategy for GroupRenderingControl service.
///
/// Delegates to `sonos_api::services::group_rendering_control::state::poll()`.
pub struct GroupRenderingControlPoller;

#[async_trait]
impl ServicePoller for GroupRenderingControlPoller {
    async fn poll_state(
        &self,
        client: &SonosClient,
        pair: &SpeakerServicePair,
    ) -> PollingResult<String> {
        let client = client.clone();
        let ip = pair.speaker_ip.to_string();

        let state = tokio::task::spawn_blocking(move || {
            sonos_api::services::group_rendering_control::state::poll(&client, &ip)
        })
        .await
        .map_err(|e| PollingError::Network(format!("Polling task panicked: {e}")))?
        .map_err(|e| PollingError::Network(e.to_string()))?;

        serde_json::to_string(&state)
            .map_err(|e| PollingError::StateParsing(format!("Failed to serialize state: {e}")))
    }

    fn state_to_event_data(&self, json_state: &str) -> PollingResult<EventData> {
        let state: sonos_api::services::group_rendering_control::state::GroupRenderingControlState =
            serde_json::from_str(json_state).map_err(|e| {
                PollingError::StateParsing(format!(
                    "Failed to deserialize GroupRenderingControl state: {e}"
                ))
            })?;
        Ok(EventData::GroupRenderingControl(state))
    }

    fn service_type(&self) -> Service {
        Service::GroupRenderingControl
    }
}

/// Main device state poller that coordinates different service strategies
pub struct DeviceStatePoller {
    /// Service-specific polling strategies
    service_pollers: HashMap<Service, Box<dyn ServicePoller>>,
    /// SonosClient for making requests
    sonos_client: SonosClient,
}

impl Default for DeviceStatePoller {
    fn default() -> Self {
        Self::new()
    }
}

impl DeviceStatePoller {
    /// Create a new device state poller with all supported strategies
    pub fn new() -> Self {
        let mut service_pollers: HashMap<Service, Box<dyn ServicePoller>> = HashMap::new();

        service_pollers.insert(Service::AVTransport, Box::new(AVTransportPoller));
        service_pollers.insert(Service::RenderingControl, Box::new(RenderingControlPoller));
        service_pollers.insert(
            Service::ZoneGroupTopology,
            Box::new(ZoneGroupTopologyPoller),
        );
        service_pollers.insert(Service::GroupManagement, Box::new(GroupManagementPoller));
        service_pollers.insert(
            Service::GroupRenderingControl,
            Box::new(GroupRenderingControlPoller),
        );

        Self {
            service_pollers,
            sonos_client: SonosClient::new(),
        }
    }

    /// Poll device state for a specific speaker/service pair
    pub async fn poll_device_state(&self, pair: &SpeakerServicePair) -> PollingResult<String> {
        match self.service_pollers.get(&pair.service) {
            Some(poller) => poller.poll_state(&self.sonos_client, pair).await,
            None => Err(PollingError::UnsupportedService {
                service: pair.service,
            }),
        }
    }

    /// Convert a JSON state snapshot to EventData for a given service.
    pub fn state_to_event_data(
        &self,
        service: &Service,
        json_state: &str,
    ) -> PollingResult<EventData> {
        match self.service_pollers.get(service) {
            Some(poller) => poller.state_to_event_data(json_state),
            None => Err(PollingError::UnsupportedService { service: *service }),
        }
    }

    /// Get list of supported service types
    pub fn supported_services(&self) -> Vec<Service> {
        self.service_pollers.keys().cloned().collect()
    }

    /// Check if a service type is supported
    pub fn is_service_supported(&self, service: &Service) -> bool {
        self.service_pollers.contains_key(service)
    }

    /// Get statistics about the device poller
    pub fn stats(&self) -> DevicePollerStats {
        DevicePollerStats {
            supported_services: self.supported_services(),
            total_pollers: self.service_pollers.len(),
        }
    }
}

/// Statistics about the device poller
#[derive(Debug)]
pub struct DevicePollerStats {
    pub supported_services: Vec<Service>,
    pub total_pollers: usize,
}

impl std::fmt::Display for DevicePollerStats {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "Device Poller Stats:")?;
        writeln!(f, "  Total pollers: {}", self.total_pollers)?;
        writeln!(f, "  Supported services:")?;
        for service in &self.supported_services {
            writeln!(f, "    {service:?}")?;
        }
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_device_poller_creation() {
        let poller = DeviceStatePoller::new();
        let stats = poller.stats();

        assert_eq!(stats.total_pollers, 5);
        assert!(poller.is_service_supported(&Service::AVTransport));
        assert!(poller.is_service_supported(&Service::RenderingControl));
        assert!(poller.is_service_supported(&Service::ZoneGroupTopology));
        assert!(poller.is_service_supported(&Service::GroupManagement));
        assert!(poller.is_service_supported(&Service::GroupRenderingControl));
    }

    #[test]
    fn test_service_poller_types() {
        assert_eq!(AVTransportPoller.service_type(), Service::AVTransport);
        assert_eq!(
            RenderingControlPoller.service_type(),
            Service::RenderingControl
        );
        assert_eq!(
            ZoneGroupTopologyPoller.service_type(),
            Service::ZoneGroupTopology
        );
        assert_eq!(
            GroupManagementPoller.service_type(),
            Service::GroupManagement
        );
        assert_eq!(
            GroupRenderingControlPoller.service_type(),
            Service::GroupRenderingControl
        );
    }

    #[tokio::test]
    async fn test_group_management_poller_returns_stable_state() {
        let poller = GroupManagementPoller;
        let pair =
            SpeakerServicePair::new("192.168.1.100".parse().unwrap(), Service::GroupManagement);

        let state1 = poller.poll_state(&SonosClient::new(), &pair).await.unwrap();
        let state2 = poller.poll_state(&SonosClient::new(), &pair).await.unwrap();
        assert_eq!(state1, state2, "GroupManagement should return stable state");
        assert_eq!(state1, "{}");
    }

    #[test]
    fn test_state_to_event_data_round_trip_all_services() {
        let poller = DeviceStatePoller::new();

        // AVTransport round-trip
        let avt_state = sonos_api::services::av_transport::state::AVTransportState {
            transport_state: Some("PLAYING".to_string()),
            transport_status: Some("OK".to_string()),
            speed: None,
            current_track_uri: None,
            track_duration: None,
            track_metadata: None,
            rel_time: None,
            abs_time: None,
            rel_count: None,
            abs_count: None,
            play_mode: None,
            next_track_uri: None,
            next_track_metadata: None,
            queue_length: None,
        };
        let json = serde_json::to_string(&avt_state).unwrap();
        let event_data = poller
            .state_to_event_data(&Service::AVTransport, &json)
            .unwrap();
        match event_data {
            EventData::AVTransport(state) => {
                assert_eq!(state.transport_state, Some("PLAYING".to_string()));
                assert_eq!(state.transport_status, Some("OK".to_string()));
            }
            _ => panic!("Expected AVTransport EventData"),
        }

        // RenderingControl round-trip
        let rc_state = sonos_api::services::rendering_control::state::RenderingControlState {
            master_volume: Some("75".to_string()),
            master_mute: Some("0".to_string()),
            bass: None,
            treble: None,
            loudness: None,
            balance: None,
            lf_volume: None,
            rf_volume: None,
            lf_mute: None,
            rf_mute: None,
            other_channels: std::collections::HashMap::new(),
        };
        let json = serde_json::to_string(&rc_state).unwrap();
        let event_data = poller
            .state_to_event_data(&Service::RenderingControl, &json)
            .unwrap();
        match event_data {
            EventData::RenderingControl(state) => {
                assert_eq!(state.master_volume, Some("75".to_string()));
            }
            _ => panic!("Expected RenderingControl EventData"),
        }

        // GroupRenderingControl round-trip
        let grc_state =
            sonos_api::services::group_rendering_control::state::GroupRenderingControlState {
                group_volume: Some(42),
                group_mute: Some(false),
                group_volume_changeable: Some(true),
            };
        let json = serde_json::to_string(&grc_state).unwrap();
        let event_data = poller
            .state_to_event_data(&Service::GroupRenderingControl, &json)
            .unwrap();
        match event_data {
            EventData::GroupRenderingControl(state) => {
                assert_eq!(state.group_volume, Some(42));
                assert_eq!(state.group_mute, Some(false));
            }
            _ => panic!("Expected GroupRenderingControl EventData"),
        }

        // ZoneGroupTopology round-trip
        let zgt_state = sonos_api::services::zone_group_topology::state::ZoneGroupTopologyState {
            zone_groups: vec![],
            vanished_devices: vec![],
        };
        let json = serde_json::to_string(&zgt_state).unwrap();
        let event_data = poller
            .state_to_event_data(&Service::ZoneGroupTopology, &json)
            .unwrap();
        match event_data {
            EventData::ZoneGroupTopology(state) => {
                assert!(state.zone_groups.is_empty());
            }
            _ => panic!("Expected ZoneGroupTopology EventData"),
        }

        // GroupManagement round-trip
        let gm_state = sonos_api::services::group_management::state::GroupManagementState {
            group_coordinator_is_local: Some(true),
            local_group_uuid: None,
            reset_volume_after: None,
            virtual_line_in_group_id: None,
            volume_av_transport_uri: None,
        };
        let json = serde_json::to_string(&gm_state).unwrap();
        let event_data = poller
            .state_to_event_data(&Service::GroupManagement, &json)
            .unwrap();
        match event_data {
            EventData::GroupManagement(state) => {
                assert_eq!(state.group_coordinator_is_local, Some(true));
            }
            _ => panic!("Expected GroupManagement EventData"),
        }
    }
}