spotify_player 0.23.0

A Spotify player in the terminal with full feature parity
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
use std::{
    collections::HashSet,
    fmt::Write as _,
    fs::{create_dir_all, remove_dir_all},
    io::Write,
    net::SocketAddr,
};

use anyhow::{Context as _, Result};
use rand::seq::SliceRandom;
use tokio::net::UdpSocket;
use tracing::Instrument;

use crate::{
    cli::Request,
    client::{AppClient, PlayerRequest},
    config::{self, get_cache_folder_path},
    state::{
        AlbumId, ArtistId, Context, ContextId, Id, PlayableId, Playback, PlaybackMetadata,
        PlaylistId, SharedState, TrackId,
    },
};
use rspotify::prelude::{BaseClient, OAuthClient};

use super::{
    Command, Deserialize, EditAction, GetRequest, IdOrName, ItemId, ItemType, Key, PlaylistCommand,
    Response, Serialize, MAX_REQUEST_SIZE,
};

pub async fn start_socket(
    client: &AppClient,
    state: Option<&SharedState>,
    socket: Option<tokio::net::UdpSocket>,
) {
    let socket = if let Some(s) = socket {
        s
    } else {
        let configs = config::get_config();
        let port = configs.app_config.client_port;
        tracing::info!("Starting a client socket at 127.0.0.1:{port}");

        match tokio::net::UdpSocket::bind(("127.0.0.1", port)).await {
            Ok(socket) => socket,
            Err(err) => {
                tracing::warn!(
                    "Failed to create a client socket for handling CLI commands: {err:#}"
                );
                return;
            }
        }
    };

    let mut buf = [0; MAX_REQUEST_SIZE];

    loop {
        match socket.recv_from(&mut buf).await {
            Err(err) => tracing::warn!("Failed to receive from the socket: {err:#}"),
            Ok((n_bytes, dest_addr)) => {
                if n_bytes == 0 {
                    // received a connection request from the destination address
                    socket.send_to(&[], dest_addr).await.unwrap_or_default();
                    continue;
                }

                let req_buf = &buf[0..n_bytes];
                let request: Request = match serde_json::from_slice(req_buf) {
                    Ok(v) => v,
                    Err(err) => {
                        tracing::error!("Cannot deserialize the socket request: {err:#}");
                        continue;
                    }
                };

                let span = tracing::info_span!("socket_request", request = ?request, dest_addr = ?dest_addr);

                async {
                    let response = match handle_socket_request(client, state, request).await {
                        Err(err) => {
                            tracing::error!("Failed to handle socket request: {err:#}");
                            let msg = format!("Bad request: {err:#}");
                            Response::Err(msg.into_bytes())
                        }
                        Ok(data) => Response::Ok(data),
                    };
                    send_response(response, &socket, dest_addr)
                        .await
                        .unwrap_or_default();

                    tracing::info!("Successfully handled the socket request.",);
                }
                .instrument(span)
                .await;
            }
        }
    }
}

async fn send_response(
    response: Response,
    socket: &UdpSocket,
    dest_addr: SocketAddr,
) -> Result<()> {
    let data = serde_json::to_vec(&response)?;

    // as the result data can be large and may not be sent in a single UDP datagram,
    // split it into smaller chunks
    for chunk in data.chunks(4096) {
        socket.send_to(chunk, dest_addr).await?;
    }
    // send an empty buffer to indicate end of chunk
    socket.send_to(&[], dest_addr).await?;
    Ok(())
}

async fn current_playback(
    client: &AppClient,
    state: Option<&SharedState>,
) -> Result<Option<rspotify::model::CurrentPlaybackContext>> {
    // get current playback from the application's state, if exists, or by making an API request
    match state {
        Some(state) => Ok(state.player.read().current_playback()),
        None => client
            .current_playback2()
            .await
            .context("get current playback"),
    }
}

async fn handle_socket_request(
    client: &AppClient,
    state: Option<&SharedState>,
    request: super::Request,
) -> Result<Vec<u8>> {
    if let Some(state) = state {
        client.check_valid_session(state).await?;
    }

    match request {
        Request::Get(GetRequest::Key(key)) => handle_get_key_request(client, state, key).await,
        Request::Get(GetRequest::Item(item_type, id_or_name)) => {
            handle_get_item_request(client, item_type, id_or_name).await
        }
        Request::Playback(command) => {
            handle_playback_request(client, state, command).await?;
            Ok(Vec::new())
        }
        Request::Connect(data) => {
            let id = match data {
                IdOrName::Id(id) => id,
                IdOrName::Name(name) => {
                    let devices = client.available_devices().await?;
                    match devices
                        .into_iter()
                        .find(|d| d.name == name)
                        .and_then(|d| d.id)
                    {
                        Some(id) => id,
                        None => {
                            anyhow::bail!("No device with name={name} found");
                        }
                    }
                }
            };

            client.transfer_playback(&id, None).await?;
            Ok(Vec::new())
        }
        Request::Like { unlike } => {
            let playback = current_playback(client, state).await?;

            // get currently playing track from the playback
            let track = match playback {
                None => None,
                Some(ref playback) => match playback.item {
                    Some(rspotify::model::PlayableItem::Track(ref track)) => Some(track),
                    _ => None,
                },
            };

            if let Some(id) = track.and_then(|t| t.id.clone()) {
                if unlike {
                    client.current_user_saved_tracks_delete([id]).await?;
                } else {
                    client.current_user_saved_tracks_add([id]).await?;
                }
            }

            Ok(Vec::new())
        }
        Request::Playlist(command) => {
            let resp = handle_playlist_request(client, command).await?;
            Ok(resp.into_bytes())
        }
        Request::Search { query } => {
            let resp = handle_search_request(client, query).await?;
            Ok(resp)
        }
    }
}

async fn handle_get_key_request(
    client: &AppClient,
    state: Option<&SharedState>,
    key: Key,
) -> Result<Vec<u8>> {
    Ok(match key {
        Key::Playback => {
            let playback = current_playback(client, state).await?;
            serde_json::to_vec(&playback)?
        }
        Key::Devices => {
            let devices = client.available_devices().await?;
            serde_json::to_vec(&devices)?
        }
        Key::UserPlaylists => {
            let playlists = client.current_user_playlists().await?;
            serde_json::to_vec(&playlists)?
        }
        Key::UserLikedTracks => {
            let tracks = client.current_user_saved_tracks().await?;
            serde_json::to_vec(&tracks)?
        }
        Key::UserTopTracks => {
            let tracks = client.current_user_top_tracks().await?;
            serde_json::to_vec(&tracks)?
        }
        Key::UserSavedAlbums => {
            let albums = client.current_user_saved_albums().await?;
            serde_json::to_vec(&albums)?
        }
        Key::UserFollowedArtists => {
            let artists = client.current_user_followed_artists().await?;
            serde_json::to_vec(&artists)?
        }
        Key::Queue => {
            let queue = client.current_user_queue().await?;
            serde_json::to_vec(&queue)?
        }
    })
}

/// Get a Spotify item's ID from its `IdOrName` representation
async fn get_spotify_id(client: &AppClient, typ: ItemType, id_or_name: IdOrName) -> Result<ItemId> {
    // For `IdOrName::Name`, we search for the first item matching the name and return its Spotify id.
    // The item's id is then used to retrieve the item's data.

    let sid = match typ {
        ItemType::Playlist => match id_or_name {
            IdOrName::Id(id) => ItemId::Playlist(PlaylistId::from_id(id)?),
            IdOrName::Name(name) => {
                let results = client
                    .search_specific_type(&name, rspotify::model::SearchType::Playlist)
                    .await?;

                match results {
                    rspotify::model::SearchResult::Playlists(page) => {
                        if page.items.is_empty() {
                            anyhow::bail!("Cannot find playlist with name='{name}'");
                        }
                        ItemId::Playlist(page.items[0].id.clone())
                    }
                    _ => unreachable!(),
                }
            }
        },
        ItemType::Album => match id_or_name {
            IdOrName::Id(id) => ItemId::Album(AlbumId::from_id(id)?),
            IdOrName::Name(name) => {
                let results = client
                    .search_specific_type(&name, rspotify::model::SearchType::Album)
                    .await?;

                match results {
                    rspotify::model::SearchResult::Albums(page) => {
                        if !page.items.is_empty() && page.items[0].id.is_some() {
                            ItemId::Album(page.items[0].id.clone().unwrap())
                        } else {
                            anyhow::bail!("Cannot find album with name='{name}'");
                        }
                    }
                    _ => unreachable!(),
                }
            }
        },
        ItemType::Artist => match id_or_name {
            IdOrName::Id(id) => ItemId::Artist(ArtistId::from_id(id)?),
            IdOrName::Name(name) => {
                let results = client
                    .search_specific_type(&name, rspotify::model::SearchType::Artist)
                    .await?;

                match results {
                    rspotify::model::SearchResult::Artists(page) => {
                        if page.items.is_empty() {
                            anyhow::bail!("Cannot find artist with name='{name}'");
                        }
                        ItemId::Artist(page.items[0].id.clone())
                    }
                    _ => unreachable!(),
                }
            }
        },
        ItemType::Track => match id_or_name {
            IdOrName::Id(id) => ItemId::Track(TrackId::from_id(id)?),
            IdOrName::Name(name) => {
                let results = client
                    .search_specific_type(&name, rspotify::model::SearchType::Track)
                    .await?;

                match results {
                    rspotify::model::SearchResult::Tracks(page) => {
                        if !page.items.is_empty() && page.items[0].id.is_some() {
                            ItemId::Track(page.items[0].id.clone().unwrap())
                        } else {
                            anyhow::bail!("Cannot find track with name='{name}'");
                        }
                    }
                    _ => unreachable!(),
                }
            }
        },
    };

    Ok(sid)
}

async fn handle_get_item_request(
    client: &AppClient,
    item_type: ItemType,
    id_or_name: IdOrName,
) -> Result<Vec<u8>> {
    let sid = get_spotify_id(client, item_type, id_or_name).await?;
    Ok(match sid {
        ItemId::Playlist(id) => serde_json::to_vec(&client.playlist_context(id).await?)?,
        ItemId::Album(id) => serde_json::to_vec(&client.album_context(id).await?)?,
        ItemId::Artist(id) => serde_json::to_vec(&client.artist_context(id).await?)?,
        ItemId::Track(id) => serde_json::to_vec(&client.track(id).await?)?,
    })
}

async fn handle_search_request(client: &AppClient, query: String) -> Result<Vec<u8>> {
    let search_result = client.search(&query).await?;

    Ok(serde_json::to_vec(&search_result)?)
}

async fn handle_playback_request(
    client: &AppClient,
    state: Option<&SharedState>,
    command: Command,
) -> Result<()> {
    let playback = if let Some(state) = state {
        state.player.read().buffered_playback.clone()
    } else {
        let playback = client.current_playback2().await?;
        playback.as_ref().map(PlaybackMetadata::from_playback)
    };

    let player_request = match command {
        Command::StartRadio(item_type, id_or_name) => {
            let sid = get_spotify_id(client, item_type, id_or_name).await?;
            let tracks = client.radio_tracks(sid.uri()).await?;

            PlayerRequest::StartPlayback(
                Playback::URIs(tracks.into_iter().map(|t| t.id.into()).collect(), None),
                None,
            )
        }
        Command::StartLikedTracks { limit, random } => {
            // get a list of liked tracks' ids
            let mut ids: Vec<PlayableId> = if let Some(state) = state {
                state
                    .data
                    .read()
                    .user_data
                    .saved_tracks
                    .values()
                    .map(|t| t.id.clone().into())
                    .collect()
            } else {
                client
                    .current_user_saved_tracks()
                    .await?
                    .into_iter()
                    .map(|t| t.id.into())
                    .collect()
            };

            if random {
                let mut rng = rand::rng();
                ids.shuffle(&mut rng);
            }

            ids.truncate(limit);

            PlayerRequest::StartPlayback(Playback::URIs(ids, None), None)
        }
        Command::StartContext {
            context_type,
            id_or_name,
            shuffle,
        } => {
            let sid = get_spotify_id(client, context_type.into(), id_or_name).await?;
            let context_id = match sid {
                ItemId::Playlist(id) => ContextId::Playlist(id),
                ItemId::Album(id) => ContextId::Album(id),
                ItemId::Artist(id) => ContextId::Artist(id),
                ItemId::Track(_) => unreachable!(),
            };

            PlayerRequest::StartPlayback(Playback::Context(context_id, None), Some(shuffle))
        }
        Command::StartTrack(id_or_name) => {
            let ItemId::Track(id) = get_spotify_id(client, ItemType::Track, id_or_name).await?
            else {
                anyhow::bail!("Unable to get track id")
            };

            let track = client.track(id).await?;
            PlayerRequest::StartPlayback(Playback::URIs(vec![track.id.into()], None), None)
        }
        Command::PlayPause => PlayerRequest::ResumePause,
        Command::Play => PlayerRequest::Resume,
        Command::Pause => PlayerRequest::Pause,
        Command::Next => PlayerRequest::NextTrack,
        Command::Previous => PlayerRequest::PreviousTrack,
        Command::Shuffle => PlayerRequest::Shuffle,
        Command::Repeat => PlayerRequest::Repeat,
        Command::Volume { percent, is_offset } => {
            let volume = playback
                .as_ref()
                .context("no active playback found!")?
                .volume
                .context("playback has no volume!")?;
            let percent = if is_offset {
                std::cmp::max(0, (volume as i8) + percent)
            } else {
                percent
            };
            PlayerRequest::Volume(percent.try_into()?)
        }
        Command::Seek(position_offset_ms) => {
            // Playback's progress cannot be computed trivially without knowing the `playback` variable in
            // the function scope is from the application's state (cached) or the `current_playback` API.
            // Therefore, we need to make an additional API request to get the playback's progress.
            let progress = client
                .current_playback2()
                .await?
                .context("no active playback found!")?
                .progress
                .context("playback has no progress!")?;
            PlayerRequest::SeekTrack(
                progress + chrono::Duration::try_milliseconds(position_offset_ms).unwrap(),
            )
        }
    };

    if let Some(state) = state {
        // A non-null application's state indicates there is a running application instance.
        // To reduce the latency of the CLI command, the player request is handled asynchronously
        // knowing that the application will outlive the asynchronous task.
        tokio::task::spawn({
            let client = client.clone();
            let state = state.clone();
            async move {
                match client.handle_player_request(player_request, playback).await {
                    Ok(playback) => {
                        // update application's states
                        state.player.write().buffered_playback = playback;
                        client.update_playback(&state);
                    }
                    Err(err) => {
                        tracing::warn!(
                            "Failed to handle a player request for playback CLI command: {err:#}"
                        );
                    }
                }
            }
        });
    } else {
        // Handles the player request synchronously
        client
            .handle_player_request(player_request, playback)
            .await?;
    }
    Ok(())
}

async fn handle_playlist_request(client: &AppClient, command: PlaylistCommand) -> Result<String> {
    let uid = client.current_user().await?.id;

    match command {
        PlaylistCommand::New {
            name,
            public,
            collab,
            description,
        } => {
            let resp = client
                .user_playlist_create(
                    uid,
                    name.as_str(),
                    Some(public),
                    Some(collab),
                    Some(description.as_str()),
                )
                .await?;
            Ok(format!(
                "Playlist '{}' with id '{}' was created.",
                resp.name, resp.id
            ))
        }
        PlaylistCommand::Delete { id } => {
            let following = client
                .playlist_check_follow(id.clone(), &[uid])
                .await
                .context(format!("Could not find playlist '{}'", id.id()))?
                .pop()
                .unwrap();

            // Won't delete if not following
            if following {
                client.playlist_unfollow(id.clone()).await?;
                Ok(format!("Playlist '{id}' was deleted/unfollowed"))
            } else {
                Ok(format!(
                    "Playlist '{id}' was not followed by the user, nothing to be done.",
                ))
            }
        }
        PlaylistCommand::List => {
            let resp = client.current_user_playlists().await?;

            let mut out = String::new();
            for pl in resp {
                writeln!(out, "{}: {}", pl.id.id(), pl.name).unwrap();
            }
            out = out.trim().to_string();

            Ok(out)
        }
        PlaylistCommand::Import {
            from: import_from,
            to: import_to,
            delete,
        } => playlist_import(client, import_from, import_to, delete).await,
        PlaylistCommand::Fork { id } => {
            let from = client
                .playlist(id.clone(), None, None)
                .await
                .context(format!("Cannot import from {}.", id.id()))?;
            let from_desc = from.description.unwrap_or_default();

            let to = client
                .user_playlist_create(
                    uid,
                    &from.name,
                    from.public,
                    Some(from.collaborative),
                    Some(from_desc.as_str()),
                )
                .await?;

            let mut result = format!(
                "Forked {}.\nNew playlist: {}:{}\n",
                id.id(),
                to.id.id(),
                to.name
            );

            result += &playlist_import(client, id, to.id, false).await?;

            Ok(result)
        }
        PlaylistCommand::Sync { id, delete } => {
            // Get import dir/file
            let imports_dir = get_cache_folder_path()?.join("imports");

            let mut result = String::new();

            // Iterate through the playlist `imports` folder in the cache folder to
            // get all playlists' import data represented as subdirectories with `import_to` name.
            // Inside each `import_to` subdirectory, an import `import_from -> import_to`
            // data is represented as a file with `import_from` name.
            for dir in imports_dir.read_dir()? {
                let to_dir = dir?.path();
                let to_id = PlaylistId::from_id(to_dir.file_name().unwrap().to_str().unwrap())?;

                // If a playlist id is specified, only consider sync imports of that playlist
                if let Some(id) = &id {
                    if to_id != *id {
                        continue;
                    }
                }

                let pl_follow = client
                    .playlist_check_follow(to_id.as_ref(), &[uid.as_ref()])
                    .await?
                    .pop()
                    .unwrap();

                if pl_follow {
                    for i in to_dir.read_dir()? {
                        let from_id =
                            PlaylistId::from_id(i?.file_name().to_str().unwrap().to_owned())?;
                        result +=
                            &playlist_import(client, from_id, to_id.clone_static(), delete).await?;
                        result += "\n";
                    }
                } else {
                    remove_dir_all(&to_dir)?;
                    writeln!(result, "Not following playlist '{}'. Deleted its import data in the cache folder...", to_id.id()).unwrap();
                }
            }

            Ok(result)
        }
        PlaylistCommand::Edit {
            playlist_id,
            action,
            track_id,
            album_id,
        } => match action {
            EditAction::Add => {
                if let Some(track_id) = track_id {
                    client
                        .playlist_add_items(
                            playlist_id.clone(),
                            [rspotify::model::PlayableId::Track(track_id.as_ref())],
                            None,
                        )
                        .await?;
                    Ok(format!(
                        "Track '{}' added to playlist '{}'",
                        track_id.id(),
                        playlist_id.id()
                    ))
                } else if let Some(album_id) = album_id {
                    let album = client.album(album_id, None).await?;
                    let track_ids: Vec<rspotify::model::PlayableId> = album
                        .tracks
                        .items
                        .into_iter()
                        .filter_map(|t| t.id.map(rspotify::model::PlayableId::Track))
                        .collect();
                    let track_count = track_ids.len();

                    if !track_ids.is_empty() {
                        client
                            .playlist_add_items(playlist_id.clone(), track_ids, None)
                            .await?;
                    }

                    Ok(format!(
                        "Album '{}' ({} tracks) added to playlist '{}'",
                        album.name,
                        track_count,
                        playlist_id.id()
                    ))
                } else {
                    anyhow::bail!("Either track_id or album_id must be provided")
                }
            }
            EditAction::Delete => {
                if let Some(track_id) = track_id {
                    client
                        .playlist_remove_all_occurrences_of_items(
                            playlist_id.clone(),
                            [rspotify::model::PlayableId::Track(track_id.as_ref())],
                            None,
                        )
                        .await?;
                    Ok(format!(
                        "Track '{}' removed from playlist '{}'",
                        track_id.id(),
                        playlist_id.id()
                    ))
                } else if let Some(album_id) = album_id {
                    let album = client.album(album_id, None).await?;
                    let track_ids: Vec<rspotify::model::PlayableId> = album
                        .tracks
                        .items
                        .into_iter()
                        .filter_map(|t| t.id.map(rspotify::model::PlayableId::Track))
                        .collect();
                    let track_count = track_ids.len();

                    if !track_ids.is_empty() {
                        client
                            .playlist_remove_all_occurrences_of_items(
                                playlist_id.clone(),
                                track_ids,
                                None,
                            )
                            .await?;
                    }

                    Ok(format!(
                        "Album '{}' ({} tracks) removed from playlist '{}'",
                        album.name,
                        track_count,
                        playlist_id.id()
                    ))
                } else {
                    anyhow::bail!("Either track_id or album_id must be provided")
                }
            }
        },
    }
}

const TRACK_BUFFER_CAP: usize = 100;

/// Imports a playlist into another playlist.
///
/// All tracks from the `import_from` playlist are added to the `import_to` playlist if they are not in there already.
///
/// The state of `import_from` playlist is stored into a cache file to add/delete the differed tracks between
/// subsequent imports of the same two playlists.
async fn playlist_import(
    client: &AppClient,
    import_from: PlaylistId<'static>,
    import_to: PlaylistId<'static>,
    delete: bool,
) -> Result<String> {
    #[derive(Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
    struct TrackData {
        id: TrackId<'static>,
        name: String,
    }
    // Get playlists' info
    let (from_tracks, from_name) = match client.playlist_context(import_from.clone()).await? {
        Context::Playlist { tracks, playlist } => (
            tracks.into_iter().map(|t| TrackData {
                id: t.id,
                name: t.name,
            }),
            playlist.name,
        ),
        _ => unreachable!(),
    };
    let (to_tracks, to_name) = match client.playlist_context(import_to.clone()).await? {
        Context::Playlist { tracks, playlist } => (
            tracks.into_iter().map(|t| TrackData {
                id: t.id,
                name: t.name,
            }),
            playlist.name,
        ),
        _ => unreachable!(),
    };

    // Get import dir/file
    let cache_dir = get_cache_folder_path()?;
    let imports_dir = cache_dir.join("imports");
    let to_dir = imports_dir.join(import_to.id());
    let from_file = to_dir.join(import_from.id());

    if !to_dir.exists() {
        create_dir_all(to_dir)?;
    }
    // Construct hash sets of the playlists' track IDs
    let to_hash_set: HashSet<TrackData> = to_tracks.collect::<HashSet<_>>();
    let from_hash_set: HashSet<TrackData> = from_tracks.collect::<HashSet<_>>();

    let mut new_tracks_hash_set = &from_hash_set - &to_hash_set;

    let mut result = String::new();
    writeln!(
        result,
        "Importing from {}:{} to {}:{}...",
        import_from.id(),
        from_name,
        import_to.id(),
        to_name
    )
    .unwrap();

    let mut track_buff = Vec::new();
    if from_file.exists() {
        let hash_set_bytes = std::fs::read(&from_file).context(format!(
            "Read cached playlist import data from {}",
            from_file.display()
        ))?;
        std::fs::remove_file(&from_file)?;
        let old_from_hash_set: HashSet<TrackData> =
            serde_json::from_slice(&hash_set_bytes).context("Deserialize playlist import data")?;

        // Only consider new tracks that were not included in the previous import.
        new_tracks_hash_set = &new_tracks_hash_set - &old_from_hash_set;

        // If `delete` option is specified, delete previously imported tracks that are not in the current `from` playlist
        let deleted_hash_set = &old_from_hash_set - &from_hash_set;
        if delete {
            for t in &deleted_hash_set {
                track_buff.push(PlayableId::Track(t.id.as_ref()));

                if track_buff.len() == TRACK_BUFFER_CAP {
                    client
                        .playlist_remove_all_occurrences_of_items(
                            import_to.as_ref(),
                            track_buff,
                            None,
                        )
                        .await?;
                    track_buff = Vec::new();
                }
            }

            if !track_buff.is_empty() {
                client
                    .playlist_remove_all_occurrences_of_items(import_to.as_ref(), track_buff, None)
                    .await?;
            }
            writeln!(result, "Tracks deleted from {from_name}: \n").unwrap();
        } else {
            writeln!(
                result,
                "Tracks that are no longer in {from_name} since last import: "
            )
            .unwrap();
        }

        for t in &deleted_hash_set {
            writeln!(result, "    {}: {}", t.id.id(), t.name).unwrap();
        }
    }

    writeln!(result, "New tracks imported to {to_name}: ").unwrap();

    track_buff = Vec::new();
    for t in &new_tracks_hash_set {
        track_buff.push(PlayableId::Track(t.id.as_ref()));

        if track_buff.len() == TRACK_BUFFER_CAP {
            client
                .playlist_add_items(import_to.as_ref(), track_buff, None)
                .await?;
            track_buff = Vec::new();
        }

        writeln!(result, "    {}: {}", t.id.id(), t.name).unwrap();
    }

    if !track_buff.is_empty() {
        client
            .playlist_add_items(import_to.as_ref(), track_buff, None)
            .await?;
    }

    // Create a new cache file storing the latest import data
    let mut f = std::fs::OpenOptions::new()
        .write(true)
        .create(true)
        .truncate(true)
        .open(&from_file)?;
    let hash_set_bytes =
        serde_json::to_vec(&from_hash_set).context("Serialize new playlist import data")?;
    f.write_all(&hash_set_bytes).context(format!(
        "Save new playlist import data into a cache file {}",
        from_file.display()
    ))?;

    Ok(result)
}