sonos-sdk-state 0.4.0

Internal reactive state 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
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
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
//! Event decoder - converts EnrichedEvent to typed property changes
//!
//! This module decodes raw events from sonos-stream into typed property
//! changes that can be applied to the StateStore.

use sonos_api::Service;
use sonos_stream::events::{
    AVTransportState, EnrichedEvent, EventData, GroupRenderingControlState, RenderingControlState,
    ZoneGroupTopologyState,
};

use crate::model::{GroupId, SpeakerId};
use crate::property::{
    Bass, CurrentTrack, GroupInfo, GroupMembership, GroupMute, GroupVolume, GroupVolumeChangeable,
    Loudness, Mute, PlaybackState, Position, Treble, Volume,
};
use crate::state::StateStore;

/// Decoded changes from a single event
#[derive(Debug)]
pub struct DecodedChanges {
    /// Speaker ID the changes apply to
    pub speaker_id: SpeakerId,
    /// List of property changes
    pub changes: Vec<PropertyChange>,
}

/// Changes extracted from a ZoneGroupTopology event
///
/// This struct contains the complete topology update including:
/// - All groups with their coordinator and members
/// - GroupMembership for each speaker in the topology
#[derive(Debug)]
pub struct TopologyChanges {
    /// Updated group information
    pub groups: Vec<GroupInfo>,
    /// Updated speaker memberships: (speaker_id, membership)
    pub memberships: Vec<(SpeakerId, GroupMembership)>,
    /// Boot sequence numbers per speaker (for GroupManagement AddMember)
    pub boot_seqs: Vec<(SpeakerId, u32)>,
}

/// A single property change
#[derive(Debug, Clone)]
pub enum PropertyChange {
    Volume(Volume),
    Mute(Mute),
    Bass(Bass),
    Treble(Treble),
    Loudness(Loudness),
    PlaybackState(PlaybackState),
    Position(Position),
    CurrentTrack(CurrentTrack),
    GroupMembership(GroupMembership),
    GroupVolume(GroupVolume),
    GroupMute(GroupMute),
    GroupVolumeChangeable(GroupVolumeChangeable),
}

impl PropertyChange {
    /// Apply this change to the store using scope-based routing
    ///
    /// Speaker-scoped properties are stored in `speaker_props`,
    /// group-scoped properties resolve speaker→group and store in `group_props`.
    ///
    /// Returns `true` if the value actually changed.
    pub fn apply(&self, store: &mut StateStore, speaker_id: &SpeakerId) -> bool {
        match self {
            // Speaker-scoped properties
            PropertyChange::Volume(v) => store.set(speaker_id, v.clone()),
            PropertyChange::Mute(v) => store.set(speaker_id, v.clone()),
            PropertyChange::Bass(v) => store.set(speaker_id, v.clone()),
            PropertyChange::Treble(v) => store.set(speaker_id, v.clone()),
            PropertyChange::Loudness(v) => store.set(speaker_id, v.clone()),
            PropertyChange::PlaybackState(v) => store.set(speaker_id, v.clone()),
            PropertyChange::Position(v) => store.set(speaker_id, v.clone()),
            PropertyChange::CurrentTrack(v) => store.set(speaker_id, v.clone()),
            PropertyChange::GroupMembership(v) => store.set(speaker_id, v.clone()),
            // Group-scoped properties: resolve speaker→group, store in group_props
            PropertyChange::GroupVolume(v) => {
                if let Some(group_id) = store.speaker_to_group.get(speaker_id).cloned() {
                    store.set_group(&group_id, v.clone())
                } else {
                    false
                }
            }
            PropertyChange::GroupMute(v) => {
                if let Some(group_id) = store.speaker_to_group.get(speaker_id).cloned() {
                    store.set_group(&group_id, v.clone())
                } else {
                    false
                }
            }
            PropertyChange::GroupVolumeChangeable(v) => {
                if let Some(group_id) = store.speaker_to_group.get(speaker_id).cloned() {
                    store.set_group(&group_id, v.clone())
                } else {
                    false
                }
            }
        }
    }

    /// Get the property key for this change
    pub fn key(&self) -> &'static str {
        use crate::property::Property;
        match self {
            PropertyChange::Volume(_) => Volume::KEY,
            PropertyChange::Mute(_) => Mute::KEY,
            PropertyChange::Bass(_) => Bass::KEY,
            PropertyChange::Treble(_) => Treble::KEY,
            PropertyChange::Loudness(_) => Loudness::KEY,
            PropertyChange::PlaybackState(_) => PlaybackState::KEY,
            PropertyChange::Position(_) => Position::KEY,
            PropertyChange::CurrentTrack(_) => CurrentTrack::KEY,
            PropertyChange::GroupMembership(_) => GroupMembership::KEY,
            PropertyChange::GroupVolume(_) => GroupVolume::KEY,
            PropertyChange::GroupMute(_) => GroupMute::KEY,
            PropertyChange::GroupVolumeChangeable(_) => GroupVolumeChangeable::KEY,
        }
    }

    /// Get the service this property belongs to
    pub fn service(&self) -> Service {
        use crate::property::SonosProperty;
        match self {
            PropertyChange::Volume(_) => Volume::SERVICE,
            PropertyChange::Mute(_) => Mute::SERVICE,
            PropertyChange::Bass(_) => Bass::SERVICE,
            PropertyChange::Treble(_) => Treble::SERVICE,
            PropertyChange::Loudness(_) => Loudness::SERVICE,
            PropertyChange::PlaybackState(_) => PlaybackState::SERVICE,
            PropertyChange::Position(_) => Position::SERVICE,
            PropertyChange::CurrentTrack(_) => CurrentTrack::SERVICE,
            PropertyChange::GroupMembership(_) => GroupMembership::SERVICE,
            PropertyChange::GroupVolume(_) => GroupVolume::SERVICE,
            PropertyChange::GroupMute(_) => GroupMute::SERVICE,
            PropertyChange::GroupVolumeChangeable(_) => GroupVolumeChangeable::SERVICE,
        }
    }
}

/// Decode an enriched event into typed property changes
pub fn decode_event(event: &EnrichedEvent, speaker_id: SpeakerId) -> DecodedChanges {
    let changes = match &event.event_data {
        EventData::RenderingControl(rc) => decode_rendering_control(rc),
        EventData::AVTransport(avt) => decode_av_transport(avt),
        EventData::ZoneGroupTopology(zgt) => decode_topology(zgt),
        EventData::DeviceProperties(_) => vec![],
        // GroupManagement is action-only; group changes surface via ZoneGroupTopology events.
        // No user-facing properties to decode.
        EventData::GroupManagement(_) => vec![],
        EventData::GroupRenderingControl(grc) => decode_group_rendering_control(grc),
    };

    DecodedChanges {
        speaker_id,
        changes,
    }
}

/// Decode RenderingControl event data
fn decode_rendering_control(event: &RenderingControlState) -> Vec<PropertyChange> {
    let mut changes = vec![];

    // Volume
    if let Some(vol_str) = &event.master_volume {
        if let Ok(vol) = vol_str.parse::<u8>() {
            changes.push(PropertyChange::Volume(Volume(vol.min(100))));
        }
    }

    // Mute
    if let Some(mute_str) = &event.master_mute {
        let muted = mute_str == "1" || mute_str.eq_ignore_ascii_case("true");
        changes.push(PropertyChange::Mute(Mute(muted)));
    }

    // Bass
    if let Some(bass_str) = &event.bass {
        if let Ok(bass) = bass_str.parse::<i8>() {
            changes.push(PropertyChange::Bass(Bass(bass.clamp(-10, 10))));
        }
    }

    // Treble
    if let Some(treble_str) = &event.treble {
        if let Ok(treble) = treble_str.parse::<i8>() {
            changes.push(PropertyChange::Treble(Treble(treble.clamp(-10, 10))));
        }
    }

    // Loudness
    if let Some(loudness_str) = &event.loudness {
        let loudness = loudness_str == "1" || loudness_str.eq_ignore_ascii_case("true");
        changes.push(PropertyChange::Loudness(Loudness(loudness)));
    }

    changes
}

/// Decode AVTransport event data
fn decode_av_transport(event: &AVTransportState) -> Vec<PropertyChange> {
    let mut changes = vec![];

    // Playback state
    if let Some(state) = &event.transport_state {
        let ps = match state.to_uppercase().as_str() {
            "PLAYING" => PlaybackState::Playing,
            "PAUSED_PLAYBACK" | "PAUSED" => PlaybackState::Paused,
            "STOPPED" => PlaybackState::Stopped,
            _ => PlaybackState::Transitioning,
        };
        changes.push(PropertyChange::PlaybackState(ps));
    }

    // Position
    if event.rel_time.is_some() || event.track_duration.is_some() {
        let position_ms = parse_duration_ms(event.rel_time.as_deref()).unwrap_or(0);
        let duration_ms = parse_duration_ms(event.track_duration.as_deref()).unwrap_or(0);

        let position = Position {
            position_ms,
            duration_ms,
        };
        changes.push(PropertyChange::Position(position));
    }

    // CurrentTrack
    if event.current_track_uri.is_some() || event.track_metadata.is_some() {
        // Parse metadata if available (track_metadata is raw XML, need to parse it)
        let (title, artist, album, album_art_uri) =
            parse_track_metadata(event.track_metadata.as_deref());

        let track = CurrentTrack {
            title,
            artist,
            album,
            album_art_uri,
            uri: event.current_track_uri.clone(),
        };
        changes.push(PropertyChange::CurrentTrack(track));
    }

    changes
}

/// Decode ZoneGroupTopology event data into property changes
///
/// Note: This returns an empty Vec because topology changes are handled
/// specially via `decode_topology_event()` which returns `TopologyChanges`.
fn decode_topology(_event: &ZoneGroupTopologyState) -> Vec<PropertyChange> {
    // Topology events are handled specially via decode_topology_event()
    // which returns TopologyChanges instead of PropertyChange
    vec![]
}

/// Decode GroupRenderingControl event data
fn decode_group_rendering_control(event: &GroupRenderingControlState) -> Vec<PropertyChange> {
    let mut changes = vec![];

    if let Some(vol) = event.group_volume {
        changes.push(PropertyChange::GroupVolume(GroupVolume(vol.min(100))));
    }

    if let Some(muted) = event.group_mute {
        changes.push(PropertyChange::GroupMute(GroupMute(muted)));
    }

    if let Some(changeable) = event.group_volume_changeable {
        changes.push(PropertyChange::GroupVolumeChangeable(
            GroupVolumeChangeable(changeable),
        ));
    }

    changes
}

/// Decode a ZoneGroupTopology event into TopologyChanges
///
/// This extracts group information and speaker memberships from the topology event.
/// Each zone group becomes a GroupInfo, and each member gets a GroupMembership.
///
/// # Arguments
/// * `event` - The ZoneGroupTopology event to decode
///
/// # Returns
/// TopologyChanges containing all groups and speaker memberships
pub fn decode_topology_event(event: &ZoneGroupTopologyState) -> TopologyChanges {
    let mut groups = Vec::new();
    let mut memberships = Vec::new();
    let mut boot_seqs = Vec::new();

    for zone_group in &event.zone_groups {
        let group_id = GroupId::new(&zone_group.id);
        let coordinator_id = SpeakerId::new(&zone_group.coordinator);

        // Collect all member IDs
        let member_ids: Vec<SpeakerId> = zone_group
            .members
            .iter()
            .map(|m| SpeakerId::new(&m.uuid))
            .collect();

        // Create GroupInfo for this zone group
        let group_info =
            GroupInfo::new(group_id.clone(), coordinator_id.clone(), member_ids.clone());
        groups.push(group_info);

        // Create GroupMembership and extract boot_seq for each member
        for member in &zone_group.members {
            let speaker_id = SpeakerId::new(&member.uuid);
            let is_coordinator = speaker_id == coordinator_id;
            let membership = GroupMembership::new(group_id.clone(), is_coordinator);
            memberships.push((speaker_id.clone(), membership));
            boot_seqs.push((speaker_id, member.boot_seq));
        }
    }

    TopologyChanges {
        groups,
        memberships,
        boot_seqs,
    }
}

/// Parse duration string (HH:MM:SS or H:MM:SS) to milliseconds
fn parse_duration_ms(duration: Option<&str>) -> Option<u64> {
    let d = duration?;

    // Handle NOT_IMPLEMENTED or empty strings
    if d.is_empty() || d == "NOT_IMPLEMENTED" {
        return None;
    }

    let parts: Vec<&str> = d.split(':').collect();
    if parts.len() != 3 {
        return None;
    }

    let hours: u64 = parts[0].parse().ok()?;
    let minutes: u64 = parts[1].parse().ok()?;

    // Handle potential milliseconds in seconds part (HH:MM:SS.mmm)
    let seconds_parts: Vec<&str> = parts[2].split('.').collect();
    let seconds: u64 = seconds_parts[0].parse().ok()?;
    let millis: u64 = seconds_parts
        .get(1)
        .and_then(|m| m.parse().ok())
        .unwrap_or(0);

    Some((hours * 3600 + minutes * 60 + seconds) * 1000 + millis)
}

/// Parse DIDL-Lite track metadata XML
pub fn parse_track_metadata(
    metadata: Option<&str>,
) -> (
    Option<String>,
    Option<String>,
    Option<String>,
    Option<String>,
) {
    let xml = match metadata {
        Some(m) if !m.is_empty() && m != "NOT_IMPLEMENTED" => m,
        _ => return (None, None, None, None),
    };

    // Simple XML extraction (could use quick-xml for more robust parsing)
    let title = extract_xml_element(xml, "dc:title");
    let artist = extract_xml_element(xml, "dc:creator")
        .or_else(|| extract_xml_element(xml, "r:albumArtist"));
    let album = extract_xml_element(xml, "upnp:album");
    let album_art_uri = extract_xml_element(xml, "upnp:albumArtURI");

    (title, artist, album, album_art_uri)
}

/// Extract content from an XML element (simple regex-free implementation)
pub fn extract_xml_element(xml: &str, element: &str) -> Option<String> {
    let start_tag = format!("<{element}>");
    let end_tag = format!("</{element}>");

    let start_idx = xml.find(&start_tag)? + start_tag.len();
    let end_idx = xml[start_idx..].find(&end_tag)? + start_idx;

    let content = &xml[start_idx..end_idx];

    // Unescape basic XML entities
    let unescaped = content
        .replace("&lt;", "<")
        .replace("&gt;", ">")
        .replace("&amp;", "&")
        .replace("&apos;", "'")
        .replace("&quot;", "\"");

    if unescaped.is_empty() {
        None
    } else {
        Some(unescaped)
    }
}

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

    #[test]
    fn test_parse_duration_ms() {
        assert_eq!(parse_duration_ms(Some("0:00:00")), Some(0));
        assert_eq!(parse_duration_ms(Some("0:01:00")), Some(60_000));
        assert_eq!(parse_duration_ms(Some("1:00:00")), Some(3_600_000));
        assert_eq!(parse_duration_ms(Some("0:03:45")), Some(225_000));
        assert_eq!(parse_duration_ms(Some("0:03:45.500")), Some(225_500));
        assert_eq!(parse_duration_ms(Some("NOT_IMPLEMENTED")), None);
        assert_eq!(parse_duration_ms(None), None);
        assert_eq!(parse_duration_ms(Some("")), None);
    }

    #[test]
    fn test_extract_xml_element() {
        let xml = r#"<DIDL-Lite><item><dc:title>Test Song</dc:title><dc:creator>Artist Name</dc:creator></item></DIDL-Lite>"#;

        assert_eq!(
            extract_xml_element(xml, "dc:title"),
            Some("Test Song".to_string())
        );
        assert_eq!(
            extract_xml_element(xml, "dc:creator"),
            Some("Artist Name".to_string())
        );
        assert_eq!(extract_xml_element(xml, "upnp:album"), None);
    }

    #[test]
    fn test_decode_rendering_control() {
        let event = RenderingControlState {
            master_volume: Some("50".to_string()),
            master_mute: Some("0".to_string()),
            bass: Some("5".to_string()),
            treble: Some("-3".to_string()),
            loudness: Some("1".to_string()),
            lf_volume: None,
            rf_volume: None,
            lf_mute: None,
            rf_mute: None,
            balance: None,
            other_channels: std::collections::HashMap::new(),
        };

        let changes = decode_rendering_control(&event);

        assert_eq!(changes.len(), 5);

        // Check volume
        if let PropertyChange::Volume(v) = &changes[0] {
            assert_eq!(v.0, 50);
        } else {
            panic!("Expected Volume change");
        }

        // Check mute
        if let PropertyChange::Mute(m) = &changes[1] {
            assert!(!m.0);
        } else {
            panic!("Expected Mute change");
        }
    }

    #[test]
    fn test_decode_av_transport() {
        let event = AVTransportState {
            transport_state: Some("PLAYING".to_string()),
            transport_status: None,
            speed: None,
            current_track_uri: Some("x-sonos-spotify:track123".to_string()),
            track_duration: Some("0:03:45".to_string()),
            rel_time: Some("0:01:30".to_string()),
            abs_time: None,
            rel_count: None,
            abs_count: None,
            play_mode: None,
            track_metadata: None,
            next_track_uri: None,
            next_track_metadata: None,
            queue_length: None,
        };

        let changes = decode_av_transport(&event);

        assert!(changes.len() >= 2);

        // Check playback state
        if let PropertyChange::PlaybackState(ps) = &changes[0] {
            assert_eq!(*ps, PlaybackState::Playing);
        } else {
            panic!("Expected PlaybackState change");
        }
    }

    #[test]
    fn test_decode_group_rendering_control() {
        let event = GroupRenderingControlState {
            group_volume: Some(42),
            group_mute: Some(false),
            group_volume_changeable: Some(true),
        };

        let changes = decode_group_rendering_control(&event);

        assert_eq!(changes.len(), 3);

        if let PropertyChange::GroupVolume(v) = &changes[0] {
            assert_eq!(v.0, 42);
        } else {
            panic!("Expected GroupVolume change");
        }

        if let PropertyChange::GroupMute(m) = &changes[1] {
            assert!(!m.0);
        } else {
            panic!("Expected GroupMute change");
        }

        if let PropertyChange::GroupVolumeChangeable(c) = &changes[2] {
            assert!(c.0);
        } else {
            panic!("Expected GroupVolumeChangeable change");
        }
    }

    #[test]
    fn test_decode_group_rendering_control_clamps_volume() {
        let event = GroupRenderingControlState {
            group_volume: Some(150),
            group_mute: None,
            group_volume_changeable: None,
        };

        let changes = decode_group_rendering_control(&event);

        assert_eq!(changes.len(), 1);

        if let PropertyChange::GroupVolume(v) = &changes[0] {
            assert_eq!(v.0, 100);
        } else {
            panic!("Expected GroupVolume change");
        }
    }

    #[test]
    fn test_decode_group_rendering_control_no_volume() {
        let event = GroupRenderingControlState {
            group_volume: None,
            group_mute: Some(true),
            group_volume_changeable: None,
        };

        let changes = decode_group_rendering_control(&event);
        assert_eq!(changes.len(), 1);

        if let PropertyChange::GroupMute(m) = &changes[0] {
            assert!(m.0);
        } else {
            panic!("Expected GroupMute change");
        }
    }

    #[test]
    fn test_property_change_key() {
        use crate::property::Property;

        let vol_change = PropertyChange::Volume(Volume(50));
        assert_eq!(vol_change.key(), Volume::KEY);

        let mute_change = PropertyChange::Mute(Mute(false));
        assert_eq!(mute_change.key(), Mute::KEY);

        let ps_change = PropertyChange::PlaybackState(PlaybackState::Playing);
        assert_eq!(ps_change.key(), PlaybackState::KEY);
    }

    #[test]
    fn test_property_change_service() {
        use crate::model::GroupId;
        use crate::property::SonosProperty;

        let vol_change = PropertyChange::Volume(Volume(50));
        assert_eq!(vol_change.service(), Volume::SERVICE);

        let ps_change = PropertyChange::PlaybackState(PlaybackState::Playing);
        assert_eq!(ps_change.service(), PlaybackState::SERVICE);

        let gm_change = PropertyChange::GroupMembership(GroupMembership::new(
            GroupId::new("RINCON_test:1"),
            true,
        ));
        assert_eq!(gm_change.service(), GroupMembership::SERVICE);
    }

    // ========================================================================
    // Unit Tests for decode_topology_event
    // ========================================================================

    use sonos_stream::events::types::{NetworkInfo, ZoneGroupInfo, ZoneGroupMemberInfo};

    /// Helper to create a ZoneGroupMemberInfo for testing
    fn make_member(uuid: &str, zone_name: &str) -> ZoneGroupMemberInfo {
        make_member_with_boot_seq(uuid, zone_name, 0)
    }

    fn make_member_with_boot_seq(
        uuid: &str,
        zone_name: &str,
        boot_seq: u32,
    ) -> ZoneGroupMemberInfo {
        ZoneGroupMemberInfo {
            uuid: uuid.to_string(),
            location: "http://192.168.1.100:1400/xml/device_description.xml".to_string(),
            zone_name: zone_name.to_string(),
            software_version: "79.1-56030".to_string(),
            boot_seq,
            network_info: NetworkInfo {
                wireless_mode: "0".to_string(),
                wifi_enabled: "1".to_string(),
                eth_link: "1".to_string(),
                channel_freq: "2412".to_string(),
                behind_wifi_extender: "0".to_string(),
            },
            satellites: vec![],
        }
    }

    #[test]
    fn test_decode_topology_single_group_one_speaker() {
        // Single speaker in a standalone group
        let event = ZoneGroupTopologyState {
            zone_groups: vec![ZoneGroupInfo {
                coordinator: "RINCON_111111111111".to_string(),
                id: "RINCON_111111111111:0".to_string(),
                members: vec![make_member("RINCON_111111111111", "Living Room")],
            }],
            vanished_devices: vec![],
        };

        let result = decode_topology_event(&event);

        // Should have 1 group
        assert_eq!(result.groups.len(), 1);
        let group = &result.groups[0];
        assert_eq!(group.id.as_str(), "RINCON_111111111111:0");
        assert_eq!(group.coordinator_id.as_str(), "RINCON_111111111111");
        assert_eq!(group.member_ids.len(), 1);
        assert!(group.is_standalone());

        // Should have 1 membership
        assert_eq!(result.memberships.len(), 1);
        let (speaker_id, membership) = &result.memberships[0];
        assert_eq!(speaker_id.as_str(), "RINCON_111111111111");
        assert_eq!(membership.group_id.as_str(), "RINCON_111111111111:0");
        assert!(membership.is_coordinator);
    }

    #[test]
    fn test_decode_topology_single_group_multiple_speakers() {
        // Group with 3 speakers: coordinator + 2 members
        let event = ZoneGroupTopologyState {
            zone_groups: vec![ZoneGroupInfo {
                coordinator: "RINCON_111111111111".to_string(),
                id: "RINCON_111111111111:0".to_string(),
                members: vec![
                    make_member("RINCON_111111111111", "Living Room"),
                    make_member("RINCON_222222222222", "Kitchen"),
                    make_member("RINCON_333333333333", "Bedroom"),
                ],
            }],
            vanished_devices: vec![],
        };

        let result = decode_topology_event(&event);

        // Should have 1 group with 3 members
        assert_eq!(result.groups.len(), 1);
        let group = &result.groups[0];
        assert_eq!(group.member_ids.len(), 3);
        assert!(!group.is_standalone());

        // Should have 3 memberships
        assert_eq!(result.memberships.len(), 3);

        // Check coordinator membership
        let coordinator_membership = result
            .memberships
            .iter()
            .find(|(sid, _)| sid.as_str() == "RINCON_111111111111")
            .map(|(_, m)| m);
        assert!(coordinator_membership.is_some());
        assert!(coordinator_membership.unwrap().is_coordinator);

        // Check non-coordinator memberships
        let kitchen_membership = result
            .memberships
            .iter()
            .find(|(sid, _)| sid.as_str() == "RINCON_222222222222")
            .map(|(_, m)| m);
        assert!(kitchen_membership.is_some());
        assert!(!kitchen_membership.unwrap().is_coordinator);

        let bedroom_membership = result
            .memberships
            .iter()
            .find(|(sid, _)| sid.as_str() == "RINCON_333333333333")
            .map(|(_, m)| m);
        assert!(bedroom_membership.is_some());
        assert!(!bedroom_membership.unwrap().is_coordinator);
    }

    #[test]
    fn test_decode_topology_multiple_groups() {
        // Two separate groups
        let event = ZoneGroupTopologyState {
            zone_groups: vec![
                ZoneGroupInfo {
                    coordinator: "RINCON_111111111111".to_string(),
                    id: "RINCON_111111111111:0".to_string(),
                    members: vec![
                        make_member("RINCON_111111111111", "Living Room"),
                        make_member("RINCON_222222222222", "Kitchen"),
                    ],
                },
                ZoneGroupInfo {
                    coordinator: "RINCON_333333333333".to_string(),
                    id: "RINCON_333333333333:0".to_string(),
                    members: vec![make_member("RINCON_333333333333", "Bedroom")],
                },
            ],
            vanished_devices: vec![],
        };

        let result = decode_topology_event(&event);

        // Should have 2 groups
        assert_eq!(result.groups.len(), 2);

        // First group: 2 members
        let group1 = &result.groups[0];
        assert_eq!(group1.id.as_str(), "RINCON_111111111111:0");
        assert_eq!(group1.member_ids.len(), 2);

        // Second group: 1 member (standalone)
        let group2 = &result.groups[1];
        assert_eq!(group2.id.as_str(), "RINCON_333333333333:0");
        assert_eq!(group2.member_ids.len(), 1);
        assert!(group2.is_standalone());

        // Should have 3 total memberships
        assert_eq!(result.memberships.len(), 3);

        // Verify each speaker has correct group_id
        let living_room = result
            .memberships
            .iter()
            .find(|(sid, _)| sid.as_str() == "RINCON_111111111111")
            .map(|(_, m)| m)
            .unwrap();
        assert_eq!(living_room.group_id.as_str(), "RINCON_111111111111:0");
        assert!(living_room.is_coordinator);

        let kitchen = result
            .memberships
            .iter()
            .find(|(sid, _)| sid.as_str() == "RINCON_222222222222")
            .map(|(_, m)| m)
            .unwrap();
        assert_eq!(kitchen.group_id.as_str(), "RINCON_111111111111:0");
        assert!(!kitchen.is_coordinator);

        let bedroom = result
            .memberships
            .iter()
            .find(|(sid, _)| sid.as_str() == "RINCON_333333333333")
            .map(|(_, m)| m)
            .unwrap();
        assert_eq!(bedroom.group_id.as_str(), "RINCON_333333333333:0");
        assert!(bedroom.is_coordinator);
    }

    #[test]
    fn test_decode_topology_empty_event() {
        // Empty topology (no groups)
        let event = ZoneGroupTopologyState {
            zone_groups: vec![],
            vanished_devices: vec![],
        };

        let result = decode_topology_event(&event);

        assert!(result.groups.is_empty());
        assert!(result.memberships.is_empty());
    }

    #[test]
    fn test_decode_topology_extracts_boot_seq_values() {
        let event = ZoneGroupTopologyState {
            zone_groups: vec![ZoneGroupInfo {
                coordinator: "RINCON_111111111111".to_string(),
                id: "RINCON_111111111111:0".to_string(),
                members: vec![
                    make_member_with_boot_seq("RINCON_111111111111", "Living Room", 42),
                    make_member_with_boot_seq("RINCON_222222222222", "Kitchen", 17),
                ],
            }],
            vanished_devices: vec![],
        };

        let result = decode_topology_event(&event);

        assert_eq!(result.boot_seqs.len(), 2);

        let boot_seq_111 = result
            .boot_seqs
            .iter()
            .find(|(id, _)| id.as_str() == "RINCON_111111111111")
            .map(|(_, bs)| *bs);
        assert_eq!(boot_seq_111, Some(42));

        let boot_seq_222 = result
            .boot_seqs
            .iter()
            .find(|(id, _)| id.as_str() == "RINCON_222222222222")
            .map(|(_, bs)| *bs);
        assert_eq!(boot_seq_222, Some(17));
    }

    #[test]
    fn test_decode_topology_boot_seq_defaults_to_zero() {
        // make_member() uses boot_seq: 0
        let event = ZoneGroupTopologyState {
            zone_groups: vec![ZoneGroupInfo {
                coordinator: "RINCON_111111111111".to_string(),
                id: "RINCON_111111111111:0".to_string(),
                members: vec![make_member("RINCON_111111111111", "Living Room")],
            }],
            vanished_devices: vec![],
        };

        let result = decode_topology_event(&event);

        assert_eq!(result.boot_seqs.len(), 1);
        assert_eq!(result.boot_seqs[0].1, 0);
    }
}

// ============================================================================
// Property-Based Tests for Topology Decoding
// ============================================================================

#[cfg(test)]
mod property_tests {
    use super::*;
    use proptest::prelude::*;
    use sonos_stream::events::types::{NetworkInfo, ZoneGroupInfo, ZoneGroupMemberInfo};

    /// Strategy for generating valid RINCON-style speaker UUIDs
    fn speaker_uuid_strategy() -> impl Strategy<Value = String> {
        "[A-F0-9]{12}".prop_map(|s| format!("RINCON_{s}"))
    }

    /// Strategy for generating a zone group member
    fn zone_group_member_strategy() -> impl Strategy<Value = ZoneGroupMemberInfo> {
        (speaker_uuid_strategy(), "[A-Za-z ]{3,15}").prop_map(|(uuid, zone_name)| {
            ZoneGroupMemberInfo {
                uuid,
                location: "http://192.168.1.100:1400/xml/device_description.xml".to_string(),
                zone_name: zone_name.trim().to_string(),
                software_version: "79.1-56030".to_string(),
                boot_seq: 0,
                network_info: NetworkInfo {
                    wireless_mode: "0".to_string(),
                    wifi_enabled: "1".to_string(),
                    eth_link: "1".to_string(),
                    channel_freq: "2412".to_string(),
                    behind_wifi_extender: "0".to_string(),
                },
                satellites: vec![],
            }
        })
    }

    /// Strategy for generating a zone group with 1-5 members
    fn zone_group_strategy() -> impl Strategy<Value = ZoneGroupInfo> {
        proptest::collection::vec(zone_group_member_strategy(), 1..=5).prop_flat_map(|members| {
            // First member is always the coordinator
            let coordinator = members[0].uuid.clone();
            let group_id = format!("{coordinator}:0");
            Just(ZoneGroupInfo {
                coordinator,
                id: group_id,
                members,
            })
        })
    }

    /// Strategy for generating a topology event with 1-3 groups
    fn topology_event_strategy() -> impl Strategy<Value = ZoneGroupTopologyState> {
        proptest::collection::vec(zone_group_strategy(), 1..=3).prop_map(|zone_groups| {
            ZoneGroupTopologyState {
                zone_groups,
                vanished_devices: vec![],
            }
        })
    }

    proptest! {
        #![proptest_config(ProptestConfig::with_cases(100))]

        /// *For any* valid ZoneGroupTopology event containing zone groups, after processing:
        /// - Each zone group in the event corresponds to a GroupInfo in the result
        /// - Each member in each zone group has a GroupMembership in the result
        /// - The GroupMembership.group_id matches the zone group's ID
        /// - The GroupMembership.is_coordinator is true only for the coordinator
        #[test]
        fn prop_topology_event_processing_round_trip(event in topology_event_strategy()) {
            let result = decode_topology_event(&event);

            // Property: Each zone group in the event corresponds to a GroupInfo
            prop_assert_eq!(
                result.groups.len(),
                event.zone_groups.len(),
                "Number of groups should match number of zone groups in event"
            );

            // Property: Each member has a GroupMembership
            let total_members: usize = event.zone_groups.iter()
                .map(|zg| zg.members.len())
                .sum();
            prop_assert_eq!(
                result.memberships.len(),
                total_members,
                "Number of memberships should match total members across all groups"
            );

            // Property: GroupInfo matches zone group data
            for (group_info, zone_group) in result.groups.iter().zip(event.zone_groups.iter()) {
                prop_assert_eq!(
                    group_info.id.as_str(),
                    &zone_group.id,
                    "GroupInfo ID should match zone group ID"
                );
                prop_assert_eq!(
                    group_info.coordinator_id.as_str(),
                    &zone_group.coordinator,
                    "GroupInfo coordinator should match zone group coordinator"
                );
                prop_assert_eq!(
                    group_info.member_ids.len(),
                    zone_group.members.len(),
                    "GroupInfo member count should match zone group member count"
                );
            }

            // Property: GroupMembership.group_id matches and is_coordinator is correct
            for zone_group in &event.zone_groups {
                for member in &zone_group.members {
                    let membership = result.memberships.iter()
                        .find(|(sid, _)| sid.as_str() == member.uuid)
                        .map(|(_, m)| m);

                    prop_assert!(
                        membership.is_some(),
                        "Each member should have a GroupMembership"
                    );

                    let membership = membership.unwrap();
                    prop_assert_eq!(
                        membership.group_id.as_str(),
                        &zone_group.id,
                        "GroupMembership.group_id should match zone group ID"
                    );

                    let is_coordinator = member.uuid == zone_group.coordinator;
                    prop_assert_eq!(
                        membership.is_coordinator,
                        is_coordinator,
                        "is_coordinator should be true only for the coordinator"
                    );
                }
            }
        }

        /// *For any* decoded topology, the coordinator_id should always be present
        /// in the member_ids list.
        #[test]
        fn prop_coordinator_always_in_members(event in topology_event_strategy()) {
            let result = decode_topology_event(&event);

            for group_info in &result.groups {
                prop_assert!(
                    group_info.member_ids.contains(&group_info.coordinator_id),
                    "Coordinator should always be in member_ids"
                );
            }
        }

        /// *For any* decoded topology, each group should have exactly one member
        /// marked as coordinator in the memberships.
        #[test]
        fn prop_exactly_one_coordinator_per_group(event in topology_event_strategy()) {
            let result = decode_topology_event(&event);

            for group_info in &result.groups {
                let coordinator_count = result.memberships.iter()
                    .filter(|(sid, membership)| {
                        group_info.member_ids.contains(sid) && membership.is_coordinator
                    })
                    .count();

                prop_assert_eq!(
                    coordinator_count,
                    1,
                    "Each group should have exactly one coordinator"
                );
            }
        }
    }
}