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
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
//! `WebSocket` connection management for `MoosicBox` application state.
//!
//! This module provides functionality for establishing and managing `WebSocket`
//! connections to `MoosicBox` servers, including message handling, connection
//! lifecycle management, and playback state synchronization.
//!
//! # Features
//!
//! * `WebSocket` connection initialization and teardown
//! * Message queuing and buffering for unreliable connections
//! * Playback state synchronization across clients
//! * Session and audio zone updates via `WebSocket` events
//!
//! # Example
//!
//! ```no_run
//! # use moosicbox_app_state::AppState;
//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
//! let state = AppState::new();
//!
//! // Start WebSocket connection
//! state.start_ws_connection().await?;
//!
//! // Connection handles messages automatically
//! // Close when done
//! state.close_ws_connection().await?;
//! # Ok(())
//! # }
//! ```
#![allow(clippy::module_name_repetitions)]
use moosicbox_app_ws::{
CloseError, WebsocketSendError, WebsocketSender as _, WsClient, WsHandle, WsMessage,
};
use moosicbox_audio_output::AudioOutputScannerError;
use moosicbox_player::{DEFAULT_PLAYBACK_RETRY_OPTIONS, PlayerError};
use moosicbox_session::models::{ApiSession, ApiUpdateSession};
use moosicbox_ws::models::{EmptyPayload, InboundPayload, OutboundPayload};
use serde::Serialize;
use switchy_async::{task::JoinError, util::CancellationToken};
use thiserror::Error;
use crate::{AppState, AppStateError};
/// `WebSocket` connection initialization message.
///
/// Contains the connection identifier and `WebSocket` URL needed to establish
/// a connection to the `MoosicBox` server.
#[derive(Clone, Serialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct WsConnectMessage {
/// Unique identifier for this connection
pub connection_id: String,
/// `WebSocket` URL to connect to
pub ws_url: String,
}
/// Errors that can occur during `WebSocket` initialization.
#[derive(Debug, Error)]
pub enum InitWsError {
/// Audio output scanner error
#[error(transparent)]
AudioOutputScanner(#[from] AudioOutputScannerError),
/// JSON serialization/deserialization error
#[error(transparent)]
Serde(#[from] serde_json::Error),
/// Error closing existing `WebSocket` connection
#[error(transparent)]
CloseWs(#[from] CloseWsError),
/// Required `MoosicBox` profile is missing
#[error("Missing profile")]
MissingProfile,
}
/// Errors that can occur when closing a `WebSocket` connection.
#[derive(Debug, Error)]
pub enum CloseWsError {
/// Error from the underlying `WebSocket` close operation
#[error(transparent)]
Close(#[from] CloseError),
/// Error joining async task handles
#[error(transparent)]
Join(#[from] JoinError),
}
/// Errors that can occur when sending a `WebSocket` message.
#[derive(Debug, Error)]
pub enum SendWsMessageError {
/// Error from the underlying `WebSocket` send operation
#[error(transparent)]
WebsocketSend(#[from] WebsocketSendError),
/// Error handling the `WebSocket` message
#[error(transparent)]
HandleWsMessage(#[from] HandleWsMessageError),
}
/// Errors that can occur when handling incoming `WebSocket` messages.
#[derive(Debug, Error)]
pub enum HandleWsMessageError {
/// JSON serialization/deserialization error
#[error(transparent)]
Serde(#[from] serde_json::Error),
/// Audio player error
#[error(transparent)]
Player(#[from] PlayerError),
}
impl AppState {
/// Establishes a `WebSocket` connection to the `MoosicBox` server.
///
/// Creates and starts a `WebSocket` client connection, spawns a message handling loop,
/// and sends an initial connection ID request. The connection runs until cancelled
/// or an error occurs.
///
/// # Errors
///
/// * If the existing websocket connection fails to close
/// * If the websocket connection is `UNAUTHORIZED`
/// * If the request is missing a `MoosicBox` profile
///
/// # Panics
///
/// * If any of the required state properties are missing
///
/// # Examples
///
/// ```no_run
/// # use moosicbox_app_state::AppState;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let state = AppState::new();
/// state.start_ws_connection().await?;
/// state.close_ws_connection().await?;
/// # Ok(())
/// # }
/// ```
#[allow(clippy::too_many_lines)]
pub async fn start_ws_connection(&self) -> Result<(), AppStateError> {
log::debug!("init_ws_connection: attempting to connect to ws");
{
if self.api_url.as_ref().read().await.is_none() {
log::debug!("init_ws_connection: missing API_URL");
return Ok(());
}
}
{
let token = self.ws_token.read().await.clone();
if let Some(token) = token {
token.cancel();
}
}
let token = {
let token = CancellationToken::new();
self.ws_token.write().await.replace(token.clone());
token
};
let api_url = self.api_url.read().await.clone().unwrap();
let profile = self
.profile
.read()
.await
.clone()
.ok_or(InitWsError::MissingProfile)?;
let client_id = self.client_id.read().await.clone();
let signature_token = self.signature_token.read().await.clone();
let ws_url = format!("ws{}/ws", &api_url[4..]);
{
*self.ws_url.write().await = Some(ws_url.clone());
}
let (client, handle) = WsClient::new(ws_url);
self.ws_handle.write().await.replace(handle.clone());
let client = client.with_cancellation_token(token.clone());
let state = self.clone();
let (tx, mut rx) = switchy_async::sync::mpsc::unbounded();
switchy_async::runtime::Handle::current().spawn_with_name("ws message loop", async move {
while let Some(m) = switchy_async::select! {
resp = rx.recv_async() => {
resp.ok()
}
() = token.cancelled() => {
log::debug!("message loop cancelled");
None
}
} {
match m {
WsMessage::TextMessage(message) => {
match serde_json::from_str::<OutboundPayload>(&message) {
Ok(message) => {
if let Err(e) = state.handle_ws_message(message).await {
log::error!("Failed to handle_ws_message: {e:?}");
}
}
Err(e) => {
moosicbox_assert::die_or_error!(
"got invalid message: {message}: {e:?}"
);
}
}
}
WsMessage::Message(bytes) => match String::from_utf8(bytes.into()) {
Ok(message) => match serde_json::from_str::<OutboundPayload>(&message) {
Ok(message) => {
if let Err(e) = state.handle_ws_message(message).await {
log::error!("Failed to handle_ws_message: {e:?}");
}
}
Err(e) => {
moosicbox_assert::die_or_error!(
"got invalid message: {message}: {e:?}"
);
}
},
Err(e) => {
log::error!("Failed to read ws message: {e:?}");
}
},
WsMessage::Ping => {
log::trace!("got ping");
}
}
}
log::debug!("Exiting ws message loop");
});
Ok(client
.start(
client_id,
signature_token,
profile,
{
let handle = handle.clone();
let state = self.clone();
move || {
switchy_async::runtime::Handle::current().spawn_with_name(
"moosicbox_app_state: ws GetConnectionId",
{
let handle = handle.clone();
let state = state.clone();
async move {
log::debug!("Sending GetConnectionId");
if let Err(e) = state
.send_ws_message(
&handle,
InboundPayload::GetConnectionId(EmptyPayload {}),
true,
)
.await
{
log::error!(
"Failed to send GetConnectionId WS message: {e:?}"
);
}
if let Err(e) = state.flush_ws_message_buffer().await {
log::error!("Failed to flush WS message buffer: {e:?}");
}
}
},
);
}
},
tx,
)
.await?)
}
/// Closes the active `WebSocket` connection.
///
/// Terminates the `WebSocket` connection and aborts the message handling task.
/// Safe to call even if no connection is active.
///
/// # Errors
///
/// * If the websocket connection fails to close
pub async fn close_ws_connection(&self) -> Result<(), AppStateError> {
log::debug!("close_ws_connection: attempting to close ws connection");
let handle = self.ws_handle.read().await.clone();
if let Some(handle) = handle {
handle.close();
}
let handle = self.ws_join_handle.write().await.take();
if let Some(handle) = handle {
handle.abort();
}
log::debug!("close_ws_connection: ws connection closed");
Ok(())
}
/// Queues a `WebSocket` message for sending or buffers it if not connected.
///
/// Sends the message immediately if a connection exists, otherwise adds it to the
/// message buffer to be sent when the connection is established.
///
/// # Errors
///
/// * If fails to handle playback update
/// * If the websocket message fails to send
///
/// # Panics
///
/// * If the websocket message serialization fails
pub async fn queue_ws_message(
&self,
message: InboundPayload,
handle_update: bool,
) -> Result<(), AppStateError> {
let handle = { self.ws_handle.read().await.clone() };
if let Some(handle) = handle {
self.send_ws_message(&handle, message, handle_update)
.await?;
} else {
moosicbox_logging::debug_or_trace!(
("queue_ws_message: pushing message to buffer: {message}"),
("queue_ws_message: pushing message to buffer: {message:?}")
);
self.ws_message_buffer.write().await.push(message);
}
Ok(())
}
/// Sends a `WebSocket` message to the server.
///
/// Serializes and sends the message over the `WebSocket` connection. If `handle_update`
/// is true, also applies the update to local players asynchronously.
///
/// # Errors
///
/// * If fails to handle playback update
/// * If the websocket message fails to send
///
/// # Panics
///
/// * If the websocket message serialization fails
pub async fn send_ws_message(
&self,
handle: &WsHandle,
message: InboundPayload,
handle_update: bool,
) -> Result<(), AppStateError> {
log::debug!("send_ws_message: handle_update={handle_update} message={message:?}");
if handle_update {
let message = message.clone();
let state = self.clone();
switchy_async::runtime::Handle::current().spawn_with_name(
"send_ws_message: handle_update",
async move {
match &message {
InboundPayload::UpdateSession(payload) => {
state
.handle_playback_update(&payload.payload.clone().into(), true)
.await?;
}
InboundPayload::SetSeek(payload) => {
#[allow(clippy::cast_precision_loss)]
state
.handle_playback_update(
&ApiUpdateSession {
session_id: payload.payload.session_id,
profile: payload.payload.profile.clone(),
playback_target: payload.payload.playback_target.clone(),
play: None,
stop: None,
name: None,
active: None,
playing: None,
position: None,
seek: Some(payload.payload.seek as f64),
volume: None,
playlist: None,
quality: None,
},
true,
)
.await?;
}
_ => {}
}
Ok::<_, AppStateError>(())
},
);
}
handle
.send(&serde_json::to_string(&message).unwrap())
.await
.map_err(SendWsMessageError::WebsocketSend)?;
Ok(())
}
/// Processes an incoming `WebSocket` message from the server.
///
/// Handles various message types including session updates, connection info, audio
/// zones, and playback commands. Triggers appropriate state updates and notifies
/// registered listeners.
///
/// # Errors
///
/// * If fails to handle playback update
/// * If fails to update audio zones
/// * If fails to update connection outputs
/// * If fails to update playlists
///
/// # Examples
///
/// ```ignore
/// # use moosicbox_app_state::AppState;
/// # use moosicbox_ws::models::OutboundPayload;
/// # async fn example(state: AppState, message: OutboundPayload) -> Result<(), Box<dyn std::error::Error>> {
/// state.handle_ws_message(message).await?;
/// # Ok(())
/// # }
/// ```
#[allow(clippy::too_many_lines)]
pub async fn handle_ws_message(&self, message: OutboundPayload) -> Result<(), AppStateError> {
log::debug!("handle_ws_message: {message:?}");
for listener in &self.on_before_handle_ws_message_listeners {
listener(&message).await;
}
let state = self.clone();
switchy_async::runtime::Handle::current().spawn_with_name("handle_ws_message", {
let message = message.clone();
async move {
match &message {
OutboundPayload::SessionUpdated(payload) => {
state.handle_playback_update(&payload.payload, true).await?;
}
OutboundPayload::SetSeek(payload) => {
#[allow(clippy::cast_precision_loss)]
state
.handle_playback_update(
&ApiUpdateSession {
session_id: payload.payload.session_id,
profile: payload.payload.profile.clone(),
playback_target: payload.payload.playback_target.clone(),
play: None,
stop: None,
name: None,
active: None,
playing: None,
position: None,
seek: Some(payload.payload.seek as f64),
volume: None,
playlist: None,
quality: None,
},
true,
)
.await?;
}
OutboundPayload::ConnectionId(payload) => {
state
.ws_connection_id
.write()
.await
.replace(payload.connection_id.clone());
}
OutboundPayload::Connections(payload) => {
(*state.current_connections.write().await).clone_from(&payload.payload);
state.update_audio_zones().await?;
for listener in &state.on_connections_updated_listeners {
listener(&payload.payload).await;
}
}
OutboundPayload::Sessions(payload) => {
let player_ids = {
let mut player_ids = vec![];
let player_sessions = state
.pending_player_sessions
.read()
.await
.iter()
.map(|(x, y)| (*x, *y))
.collect::<Vec<_>>();
let profile = { state.profile.read().await.clone() };
if let Some(profile) = profile {
for (player_id, session_id) in player_sessions {
if let Some(session) =
payload.payload.iter().find(|x| x.session_id == session_id)
{
let mut binding = state.active_players.write().await;
let player = binding
.iter_mut()
.find(|x| x.player.id == player_id)
.map(|x| &mut x.player);
if let Some(player) = player {
log::debug!(
"handle_ws_message: init_from_api_session session={session:?}"
);
if let Err(e) = player
.init_from_api_session(
profile.clone(),
session.clone(),
)
.await
{
log::error!(
"Failed to init player from api session: {e:?}"
);
}
drop(binding);
player_ids.push(player_id);
}
}
}
}
player_ids
};
{
state
.pending_player_sessions
.write()
.await
.retain(|id, _| !player_ids.contains(id));
}
{
(*state.current_sessions.write().await).clone_from(&payload.payload);
for listener in &state.on_current_sessions_updated_listeners {
listener(&payload.payload).await;
}
}
state.update_audio_zones().await?;
state
.update_connection_outputs(
&payload
.payload
.iter()
.map(|x| x.session_id)
.collect::<Vec<_>>(),
)
.await?;
state.update_playlist().await;
}
OutboundPayload::AudioZoneWithSessions(payload) => {
(*state.current_audio_zones.write().await).clone_from(&payload.payload);
state.update_audio_zones().await?;
for listener in &state.on_audio_zone_with_sessions_updated_listeners {
listener(&payload.payload).await;
}
}
_ => {}
}
for listener in &state.on_after_handle_ws_message_listeners {
listener(&message).await;
}
Ok::<_, AppStateError>(())
}
});
Ok(())
}
/// Applies an update to a session's state fields.
///
/// This method updates the session matching `update.session_id` in `current_sessions`
/// with any non-`None` fields from the update. This is a pure state mutation
/// without player interaction or event triggering.
pub async fn apply_session_update(&self, update: &ApiUpdateSession) {
let mut binding = self.current_sessions.write().await;
let session = binding
.iter_mut()
.find(|x| x.session_id == update.session_id);
if let Some(session) = session {
if let Some(seek) = update.seek {
session.seek.replace(seek);
}
if let Some(name) = update.name.clone() {
session.name = name;
}
if let Some(active) = update.active {
session.active = active;
}
if let Some(playing) = update.playing {
session.playing = playing;
}
if let Some(volume) = update.volume {
session.volume.replace(volume);
}
if let Some(position) = update.position {
session.position.replace(position);
}
if let Some(playlist) = update.playlist.clone() {
session.playlist.tracks = playlist.tracks;
}
}
drop(binding);
}
/// Updates the playlist for the current session.
///
/// Fetches the current session and triggers all registered playlist update
/// listeners with the session data. If no current session is set or the
/// session doesn't exist, the method returns early.
pub async fn update_playlist(&self) {
log::trace!("update_playlist");
for listener in &self.on_before_update_playlist_listeners {
listener().await;
}
let current_session_id = { *self.current_session_id.read().await };
let Some(current_session_id) = current_session_id else {
log::debug!("update_playlist: no CURRENT_SESSION_ID");
return;
};
log::trace!("update_playlist: current_session_id={current_session_id}");
let session = {
let binding = self.current_sessions.read().await;
let sessions: &[ApiSession] = &binding;
let session = sessions
.iter()
.find(|x| x.session_id == current_session_id)
.cloned();
drop(binding);
session
};
let Some(session) = session else {
log::debug!("update_playlist: no session exists");
return;
};
log::debug!("update_playlist: session={session:?}");
for listener in &self.on_after_update_playlist_listeners {
listener(&session).await;
}
}
/// Sends all buffered `WebSocket` messages to the server.
///
/// Processes all messages that were queued while the `WebSocket` connection was
/// not available. Called automatically when a connection is established.
///
/// # Errors
///
/// * If any websocket messages fail to send
pub async fn flush_ws_message_buffer(&self) -> Result<(), AppStateError> {
let handle = self.ws_handle.read().await.clone();
if let Some(handle) = handle {
let mut binding = self.ws_message_buffer.write().await;
log::debug!(
"flush_ws_message_buffer: Flushing {} ws messages from buffer",
binding.len()
);
let messages = binding.drain(..);
for message in messages {
self.send_ws_message(&handle, message, true).await?;
}
drop(binding);
} else {
log::debug!("flush_ws_message_buffer: No WS_HANDLE");
}
Ok(())
}
/// Applies a playback update to local players and session state.
///
/// Updates the local session state and applies the changes to all matching players.
/// Optionally triggers before/after event listeners based on `trigger_events`.
///
/// # Errors
///
/// * If fails to update playback
///
/// # Examples
///
/// ```ignore
/// # use moosicbox_app_state::AppState;
/// # use moosicbox_session::models::ApiUpdateSession;
/// # async fn example(state: AppState, update: ApiUpdateSession) -> Result<(), Box<dyn std::error::Error>> {
/// state.handle_playback_update(&update, true).await?;
/// # Ok(())
/// # }
/// ```
#[allow(clippy::cognitive_complexity)]
pub async fn handle_playback_update(
&self,
update: &ApiUpdateSession,
trigger_events: bool,
) -> Result<(), AppStateError> {
log::debug!("handle_playback_update: {update:?}");
if trigger_events {
for listener in &self.on_before_handle_playback_update_listeners {
listener(update).await;
}
}
self.apply_session_update(update).await;
let players = self
.get_players(update.session_id, Some(&update.playback_target))
.await;
moosicbox_logging::debug_or_trace!(
("handle_playback_update: player count={}", players.len()),
(
"handle_playback_update: player count={} players={players:?}",
players.len()
)
);
for mut player in players {
let update = self
.get_session_playback_for_player(update.to_owned(), &player)
.await;
log::debug!("handle_playback_update: player={}", player.id);
if let Some(quality) = update.quality {
self.playback_quality.write().await.replace(quality);
}
player
.update_playback(
true,
update.play,
update.stop,
update.playing,
update.position,
update.seek,
update.volume,
update
.playlist
.map(|x| x.tracks.into_iter().map(Into::into).collect()),
update.quality,
Some(update.session_id),
Some(update.profile.clone()),
Some(update.playback_target.into()),
false,
Some(DEFAULT_PLAYBACK_RETRY_OPTIONS),
)
.await?;
}
if trigger_events {
for listener in &self.on_after_handle_playback_update_listeners {
listener(update).await;
}
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use std::sync::{
Arc,
atomic::{AtomicU32, Ordering},
};
use moosicbox_session::models::{
ApiPlaybackTarget, ApiSessionPlaylist, ApiUpdateSessionPlaylist,
};
use moosicbox_ws::models::EmptyPayload;
use super::*;
fn create_test_session(session_id: u64, name: &str) -> ApiSession {
ApiSession {
session_id,
name: name.to_string(),
active: true,
playing: false,
position: None,
seek: None,
volume: Some(0.5),
playback_target: None,
playlist: ApiSessionPlaylist {
session_playlist_id: 1,
tracks: vec![],
},
}
}
fn create_update(session_id: u64) -> ApiUpdateSession {
ApiUpdateSession {
session_id,
profile: "test".to_string(),
playback_target: ApiPlaybackTarget::default(),
play: None,
stop: None,
name: None,
active: None,
playing: None,
position: None,
seek: None,
volume: None,
playlist: None,
quality: None,
}
}
// Tests for queue_ws_message
#[test_log::test(switchy_async::test)]
async fn test_queue_ws_message_buffers_when_no_handle() {
let state = crate::AppState::new();
// Ensure no ws_handle is set (default state)
assert!(state.ws_handle.read().await.is_none());
// Queue a message
let message = InboundPayload::Ping(EmptyPayload {});
state
.queue_ws_message(message, false)
.await
.expect("queue_ws_message should succeed");
// Verify message was buffered
let buffer = state.ws_message_buffer.read().await;
assert_eq!(buffer.len(), 1);
// Verify it's the right type of message
assert!(matches!(buffer[0], InboundPayload::Ping(_)));
drop(buffer);
}
#[test_log::test(switchy_async::test)]
async fn test_queue_ws_message_multiple_messages_buffer() {
let state = crate::AppState::new();
// Queue multiple messages
let message1 = InboundPayload::Ping(EmptyPayload {});
let message2 = InboundPayload::GetConnectionId(EmptyPayload {});
let message3 = InboundPayload::GetSessions(EmptyPayload {});
state
.queue_ws_message(message1, false)
.await
.expect("queue_ws_message should succeed");
state
.queue_ws_message(message2, false)
.await
.expect("queue_ws_message should succeed");
state
.queue_ws_message(message3, false)
.await
.expect("queue_ws_message should succeed");
// Verify all messages were buffered in order
let buffer = state.ws_message_buffer.read().await;
assert_eq!(buffer.len(), 3);
assert!(matches!(buffer[0], InboundPayload::Ping(_)));
assert!(matches!(buffer[1], InboundPayload::GetConnectionId(_)));
assert!(matches!(buffer[2], InboundPayload::GetSessions(_)));
drop(buffer);
}
// Tests for update_playlist
#[test_log::test(switchy_async::test)]
async fn test_update_playlist_calls_before_listeners_even_without_session_id() {
let before_count = Arc::new(AtomicU32::new(0));
let before_count_clone = before_count.clone();
let state = crate::AppState::new().with_on_before_update_playlist_listener(move || {
let count = before_count_clone.clone();
async move {
count.fetch_add(1, Ordering::SeqCst);
}
});
// No session ID is set, but before listener should still be called
state.update_playlist().await;
assert_eq!(before_count.load(Ordering::SeqCst), 1);
}
#[test_log::test(switchy_async::test)]
async fn test_update_playlist_does_not_call_after_listeners_without_session_id() {
let after_count = Arc::new(AtomicU32::new(0));
let after_count_clone = after_count.clone();
let state =
crate::AppState::new().with_on_after_update_playlist_listener(move |_session| {
let count = after_count_clone.clone();
async move {
count.fetch_add(1, Ordering::SeqCst);
}
});
// No session ID is set
state.update_playlist().await;
// After listener should NOT be called when no session ID
assert_eq!(after_count.load(Ordering::SeqCst), 0);
}
#[test_log::test(switchy_async::test)]
async fn test_update_playlist_does_not_call_after_listeners_when_session_not_found() {
let after_count = Arc::new(AtomicU32::new(0));
let after_count_clone = after_count.clone();
let state =
crate::AppState::new().with_on_after_update_playlist_listener(move |_session| {
let count = after_count_clone.clone();
async move {
count.fetch_add(1, Ordering::SeqCst);
}
});
// Set session ID but don't add any sessions
*state.current_session_id.write().await = Some(999);
state.update_playlist().await;
// After listener should NOT be called when session not found
assert_eq!(after_count.load(Ordering::SeqCst), 0);
}
#[test_log::test(switchy_async::test)]
async fn test_update_playlist_calls_after_listeners_when_session_exists() {
let before_count = Arc::new(AtomicU32::new(0));
let before_count_clone = before_count.clone();
let after_count = Arc::new(AtomicU32::new(0));
let after_count_clone = after_count.clone();
let received_session_id = Arc::new(AtomicU32::new(0));
let received_session_id_clone = received_session_id.clone();
let state = crate::AppState::new()
.with_on_before_update_playlist_listener(move || {
let count = before_count_clone.clone();
async move {
count.fetch_add(1, Ordering::SeqCst);
}
})
.with_on_after_update_playlist_listener(move |session| {
let count = after_count_clone.clone();
let session_id_store = received_session_id_clone.clone();
let session_id = session.session_id;
async move {
count.fetch_add(1, Ordering::SeqCst);
#[allow(clippy::cast_possible_truncation)]
session_id_store.store(session_id as u32, Ordering::SeqCst);
}
});
// Add a session and set it as current
let session = create_test_session(42, "Test Session");
*state.current_sessions.write().await = vec![session];
*state.current_session_id.write().await = Some(42);
state.update_playlist().await;
// Both listeners should be called
assert_eq!(before_count.load(Ordering::SeqCst), 1);
assert_eq!(after_count.load(Ordering::SeqCst), 1);
// And should receive the correct session
assert_eq!(received_session_id.load(Ordering::SeqCst), 42);
}
#[test_log::test(switchy_async::test)]
async fn test_update_playlist_finds_correct_session_among_multiple() {
let received_session_name = Arc::new(std::sync::RwLock::new(String::new()));
let received_session_name_clone = received_session_name.clone();
let state = crate::AppState::new().with_on_after_update_playlist_listener(move |session| {
let name_store = received_session_name_clone.clone();
let name = session.name;
async move {
*name_store.write().unwrap() = name;
}
});
// Add multiple sessions
let session1 = create_test_session(1, "First");
let session2 = create_test_session(2, "Target");
let session3 = create_test_session(3, "Third");
*state.current_sessions.write().await = vec![session1, session2, session3];
*state.current_session_id.write().await = Some(2);
state.update_playlist().await;
// Should receive the correct session
assert_eq!(*received_session_name.read().unwrap(), "Target");
}
// Tests for apply_session_update
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_does_nothing_when_session_not_found() {
let state = crate::AppState::new();
// Add a session with ID 1
let session = create_test_session(1, "Session 1");
*state.current_sessions.write().await = vec![session];
// Try to update session with ID 999 (doesn't exist)
let update = create_update(999);
state.apply_session_update(&update).await;
// Session 1 should remain unchanged
let sessions = state.current_sessions.read().await;
assert_eq!(sessions.len(), 1);
assert_eq!(sessions[0].session_id, 1);
assert_eq!(sessions[0].name, "Session 1");
drop(sessions);
}
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_updates_seek() {
let state = crate::AppState::new();
let session = create_test_session(1, "Test Session");
*state.current_sessions.write().await = vec![session];
let mut update = create_update(1);
update.seek = Some(42.5);
state.apply_session_update(&update).await;
let sessions = state.current_sessions.read().await;
assert_eq!(sessions[0].seek, Some(42.5));
drop(sessions);
}
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_updates_name() {
let state = crate::AppState::new();
let session = create_test_session(1, "Original Name");
*state.current_sessions.write().await = vec![session];
let mut update = create_update(1);
update.name = Some("New Name".to_string());
state.apply_session_update(&update).await;
let sessions = state.current_sessions.read().await;
assert_eq!(sessions[0].name, "New Name");
drop(sessions);
}
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_updates_active() {
let state = crate::AppState::new();
let mut session = create_test_session(1, "Test Session");
session.active = true;
*state.current_sessions.write().await = vec![session];
let mut update = create_update(1);
update.active = Some(false);
state.apply_session_update(&update).await;
let sessions = state.current_sessions.read().await;
assert!(!sessions[0].active);
drop(sessions);
}
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_updates_playing() {
let state = crate::AppState::new();
let mut session = create_test_session(1, "Test Session");
session.playing = false;
*state.current_sessions.write().await = vec![session];
let mut update = create_update(1);
update.playing = Some(true);
state.apply_session_update(&update).await;
let sessions = state.current_sessions.read().await;
assert!(sessions[0].playing);
drop(sessions);
}
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_updates_volume() {
let state = crate::AppState::new();
let session = create_test_session(1, "Test Session");
*state.current_sessions.write().await = vec![session];
let mut update = create_update(1);
update.volume = Some(0.8);
state.apply_session_update(&update).await;
let sessions = state.current_sessions.read().await;
assert_eq!(sessions[0].volume, Some(0.8));
drop(sessions);
}
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_updates_position() {
let state = crate::AppState::new();
let session = create_test_session(1, "Test Session");
*state.current_sessions.write().await = vec![session];
let mut update = create_update(1);
update.position = Some(5);
state.apply_session_update(&update).await;
let sessions = state.current_sessions.read().await;
assert_eq!(sessions[0].position, Some(5));
drop(sessions);
}
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_updates_playlist_tracks() {
let state = crate::AppState::new();
let session = create_test_session(1, "Test Session");
*state.current_sessions.write().await = vec![session];
let mut update = create_update(1);
let track = moosicbox_music_models::api::ApiTrack::default();
update.playlist = Some(ApiUpdateSessionPlaylist {
session_playlist_id: 1,
tracks: vec![track.clone()],
});
state.apply_session_update(&update).await;
let sessions = state.current_sessions.read().await;
assert_eq!(sessions[0].playlist.tracks.len(), 1);
drop(sessions);
}
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_does_not_update_unset_fields() {
let state = crate::AppState::new();
let mut session = create_test_session(1, "Original");
session.seek = Some(10.0);
session.volume = Some(0.5);
session.position = Some(3);
session.active = true;
session.playing = true;
*state.current_sessions.write().await = vec![session];
// Update with only name set, others None
let mut update = create_update(1);
update.name = Some("Updated Name".to_string());
state.apply_session_update(&update).await;
let sessions = state.current_sessions.read().await;
// Name should be updated
assert_eq!(sessions[0].name, "Updated Name");
// Other fields should remain unchanged
assert_eq!(sessions[0].seek, Some(10.0));
assert_eq!(sessions[0].volume, Some(0.5));
assert_eq!(sessions[0].position, Some(3));
assert!(sessions[0].active);
assert!(sessions[0].playing);
drop(sessions);
}
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_multiple_fields_at_once() {
let state = crate::AppState::new();
let session = create_test_session(1, "Original");
*state.current_sessions.write().await = vec![session];
let mut update = create_update(1);
update.name = Some("New Name".to_string());
update.seek = Some(25.0);
update.volume = Some(0.9);
update.playing = Some(true);
update.active = Some(false);
update.position = Some(7);
state.apply_session_update(&update).await;
let sessions = state.current_sessions.read().await;
assert_eq!(sessions[0].name, "New Name");
assert_eq!(sessions[0].seek, Some(25.0));
assert_eq!(sessions[0].volume, Some(0.9));
assert!(sessions[0].playing);
assert!(!sessions[0].active);
assert_eq!(sessions[0].position, Some(7));
drop(sessions);
}
#[test_log::test(switchy_async::test)]
async fn test_apply_session_update_updates_correct_session_among_multiple() {
let state = crate::AppState::new();
let session1 = create_test_session(1, "Session 1");
let session2 = create_test_session(2, "Session 2");
let session3 = create_test_session(3, "Session 3");
*state.current_sessions.write().await = vec![session1, session2, session3];
// Update session 2 only
let mut update = create_update(2);
update.name = Some("Updated Session 2".to_string());
update.volume = Some(0.3);
state.apply_session_update(&update).await;
let sessions = state.current_sessions.read().await;
// Session 1 unchanged
assert_eq!(sessions[0].name, "Session 1");
assert_eq!(sessions[0].volume, Some(0.5));
// Session 2 updated
assert_eq!(sessions[1].name, "Updated Session 2");
assert_eq!(sessions[1].volume, Some(0.3));
// Session 3 unchanged
assert_eq!(sessions[2].name, "Session 3");
assert_eq!(sessions[2].volume, Some(0.5));
drop(sessions);
}
}