Add configurable playlists to console app by Tapanila · Pull Request #390 · Tapanila/SharpCaster

Tapanila · 2025-09-20T10:42:21Z

No description provided.

My first take as basis for discussions. I added micrososfts configuration.json package to parse application.json. Hope this is compatible with the AOT and multi target goal. Not yet clear how to really structure the config. I tend to have a List<playlists> to be able to have one level of 'category' like "Classic-Cds", "Pop-Cds", "Web-Radios". On the other hand I want to avoid to much keystrokes to navigate. So That would be a Command line switch where I need to address somehow which playlist to use. (by "cat"-"Name" or some - self generated unique IDs?). Or I could start with a category only and directly reach the according playlist selection menu....

Replaced hierarchical playlist management with a flat structure loaded from `userSettings.json`, removing reliance on `Microsoft.Extensions.Configuration` and `appsettings.json`. Refactored `PlaylistService` to deserialize playlists directly from JSON, simplifying the API and removing unused classes (`Category`, `MenuNode`). Updated `Playlist` to use `QueueItem[]` for better alignment with `Sharpcaster.Models.Queue`. Simplified `QueueController` logic for playlist selection and casting.

coderabbitai · 2025-09-20T10:42:28Z

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Adds playlist support across the console app: new models (Playlist, UserSettingsModel), a PlaylistService loading userSettings.json, DI wiring, CLI parsing for playlist IDs, command execution to play playlists, queue UI to load playlists, and a new “Back” option in media URL selection. Serialization context and tests updated accordingly.

Changes

Cohort / File(s)	Summary
Controllers: Playlist & Media navigation `SharpCaster.Console/Controllers/QueueController.cs`, `SharpCaster.Console/Controllers/MediaController.cs`	QueueController now depends on PlaylistService, adds CastPlaylistAsync, updates queue management UI, safer next-track handling, and richer queue display. MediaController adds a “Back” option to URL selection, returning early when chosen.
Flows & Menu integration `SharpCaster.Console/Flows/ApplicationFlows.cs`	Main menu gains “Cast playlist”; conversion/display updated; invokes QueueController.CastPlaylistAsync.
CLI parsing & DI wiring `SharpCaster.Console/Program.cs`, `SharpCaster.Console/Models/CommandLineArgs.cs`	CommandLineArgs adds PlaylistId. Parser now takes PlaylistService, recognizes playlist IDs, and defaults to “play”. Program registers PlaylistService and passes it to the parser.
Command execution `SharpCaster.Console/Services/CommandExecutor.cs`	Constructor updated to include PlaylistService. Adds private PlayPlaylistAsync and extends play command to handle PlaylistId. Improves connection flow to join existing app or launch DMR.
Models & Serialization `SharpCaster.Console/Models/Playlist.cs`, `SharpCaster.Console/Models/UserSettingsModel.cs`, `SharpCaster.Console/Models/ConsoleJsonContext.cs`	Adds Playlist and UserSettingsModel. ConsoleJsonContext now serializes Playlist, Playlist[], and UserSettingsModel for source-gen JSON.
Playlist service & data `SharpCaster.Console/Services/PlaylistService.cs`, `SharpCaster.Console/userSettings.json`, `SharpCaster.Console/SharpCaster.Console.csproj`	New PlaylistService loads playlists from userSettings.json and validates IDs. Project copies userSettings.json to output. Adds initial playlists data file.
Tests & helpers `Sharpcaster.Test/LoggingTester.cs`, `Sharpcaster.Test/helper/TestHelper.cs`	Updates expected MessageTypes to include PONG. Enhances test logs with receiver Name/Version and fixes array initialization in CreateTestCd.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant User as User
  participant App as Console App
  participant Flow as ApplicationFlows
  participant QC as QueueController
  participant PS as PlaylistService
  participant Dev as DeviceService/Chromecast

  User->>App: Start / Open menu
  App->>Flow: Show main actions
  User-->>Flow: Select "Cast playlist"
  Flow->>QC: CastPlaylistAsync()
  QC->>PS: List/validate playlists
  PS-->>QC: Playlist selection/instance
  QC->>Dev: ConnectToDeviceQuietAsync()
  Dev-->>QC: Connected (join/launch app)
  QC->>Dev: QueueLoadAsync(playlist.QueueItems)
  Dev-->>QC: Load status
  QC-->>Flow: Result (success/error)
  Flow-->>User: Display outcome

sequenceDiagram
  autonumber
  participant User as User
  participant MC as MediaController
  participant UI as UIHelper

  User->>MC: CastMediaAsync()
  MC->>UI: Prompt URL options ["Back", ...]
  alt User selects "Back"
    UI-->>MC: "Back"
    MC-->>User: Return without loading media
  else User selects a URL
    UI-->>MC: Selected URL
    MC->>MC: Proceed to cast selected media
    MC-->>User: Status/result
  end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Add configurable playlists to console app #384 — Introduces the same playlist feature set (PlaylistService, models, CLI/menu hooks, QueueController.CastPlaylistAsync, CommandExecutor changes, MediaController “Back”).

Poem

A rabbit queued a moonlight mix, so spry,
From userSettings.json, oh my!
It tapped “Cast playlist” with a twitch,
Hopped back with “Back” if plans should switch.
Tracks leapt in line, a burrowed beat—
PING, PONG, then play—such tidy feat! 🐇🎶

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description Check	❓ Inconclusive	No pull request description was provided (the description field is empty), so there is no descriptive text to confirm intent, motivation, or usage; this makes the description check inconclusive. Although the title and raw change summaries indicate playlist support was added, the absent description conveys no meaningful information to reviewers about rationale, migration, or CLI usage. Because the description is effectively missing, it cannot be judged as related or unrelated.	Please ask the author to add a short PR description summarizing the intent and key changes (e.g., Playlist model, PlaylistService, CLI parsing updates, Program DI changes, CommandExecutor and QueueController updates, and userSettings.json), note any migration or configuration steps, and include at least one example of how to use the new playlist feature from the CLI or UI.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "Add configurable playlists to console app" succinctly and accurately summarizes the primary change set: adding Playlist and UserSettings models, a PlaylistService, DI registration, CLI and UI flow updates to load/cast playlists, and related controller/service changes. It is specific, concise, and directly related to the changes in the provided summary, so a reviewer scanning history will understand the main intent. The title avoids noisy details and is appropriate as-is.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feature/playlist

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull Request Overview

This PR adds configurable playlist functionality to the SharpCaster console application, allowing users to define playlists in a JSON configuration file and play them via command line or interactive mode.

Introduces a JSON-based playlist configuration system through userSettings.json
Adds playlist support to both command-line and interactive UI workflows
Enhances the queue management system with playlist loading capabilities

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
userSettings.json	Adds playlist configuration file with sample radio stations and music tracks
PlaylistService.cs	Implements playlist loading and validation from JSON configuration
Program.cs	Integrates PlaylistService into dependency injection and command parsing
CommandLineArgs.cs	Adds playlist ID support to command line argument parsing
CommandExecutor.cs	Adds playlist playback functionality to command execution
Playlist.cs	Defines playlist data model with queue items
UserSettingsModel.cs	Defines user settings container for playlists
ConsoleJsonContext.cs	Adds JSON serialization context for new models
QueueController.cs	Adds interactive playlist selection and enhanced queue display
MediaController.cs	Adds back navigation option to media casting
ApplicationFlows.cs	Integrates playlist casting into main application flow
SharpCaster.Console.csproj	Configures userSettings.json to copy to output directory
TestHelper.cs	Enhances test logging with additional receiver information
LoggingTester.cs	Updates test assertion to include PONG message type

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

SharpCaster.Console/Services/PlaylistService.cs

Copilot · 2025-09-20T10:43:15Z

SharpCaster.Console/Services/CommandExecutor.cs

+                            System.Console.WriteLine("Error: Media URL or valid Playlist ID is required for play command.");
+                            return 1;
+                        }
+                        return await PlayPlaylistAsync(_playlistService.Playlists.First(p => p.Name == args.PlaylistId));


The First() method will throw an exception if no playlist with the specified name is found. Since IsPlaylistId() has the same issue, this could fail even after validation. Use FirstOrDefault() and add null checking.

Suggested change

return await PlayPlaylistAsync(_playlistService.Playlists.First(p => p.Name == args.PlaylistId));

var playlist = _playlistService.Playlists.FirstOrDefault(p => p.Name == args.PlaylistId);

if (playlist == null)

{

System.Console.WriteLine($"Error: Playlist with name '{args.PlaylistId}' not found.");

return 1;

}

return await PlayPlaylistAsync(playlist);

Copilot · 2025-09-20T10:43:16Z

SharpCaster.Console/Controllers/QueueController.cs

+                .StartAsync("Loading playlist", async ctx =>
+                {
+                    ctx.Status("Loading queue...");
+                    var status = await _state.Client.MediaChannel.QueueLoadAsync(_playlistService.Playlists.First(p => p.Name == urlChoice).QueueItems);


The First() method will throw an exception if no playlist with the specified name is found. Use FirstOrDefault() and add null checking to prevent runtime exceptions.

Suggested change

var status = await _state.Client.MediaChannel.QueueLoadAsync(_playlistService.Playlists.First(p => p.Name == urlChoice).QueueItems);

var playlist = _playlistService.Playlists.FirstOrDefault(p => p.Name == urlChoice);

if (playlist == null)

throw new Exception($"Playlist '{urlChoice}' not found.");

var status = await _state.Client.MediaChannel.QueueLoadAsync(playlist.QueueItems);

SharpCaster.Console/Models/UserSettingsModel.cs

SharpCaster.Console/userSettings.json

SharpCaster.Console/Models/CommandLineArgs.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Tapanila · 2025-09-20T10:48:45Z

@RobertK66 I took your pull request and made some changes on it.
Largest part is the changing from Configuration Builder to JSON and simplified the models quite a bit.
This lost certain features like categories you had implemented but now it's way more simplified.

I have few todos still left before I will merge with this and make a new release:

I plan to only deliver the binaries on releases. So we need to create the initial version if the file doesn't exist and make sure we don't overwrite it if there's changes
Error handling on loading the queue items. Currently you can have issues on the json and they popup strangely so I was thinking of adding some checks on the playlist service

coderabbitai

Actionable comments posted: 4

♻️ Duplicate comments (3)

SharpCaster.Console/Models/UserSettingsModel.cs (1)

1-5: Remove unused using statements.

The file includes several using statements that aren't used by the simple UserSettingsModel class definition.

Apply this diff to remove unused imports:
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-
+

SharpCaster.Console/Controllers/QueueController.cs (1)

55-59: Avoid First() throw when playlist not found; use FirstOrDefault() + null check.
Even though the choice comes from the list, this prevents edge cases and aligns with prior feedback.

Apply this diff:

-                    var status = await _state.Client.MediaChannel.QueueLoadAsync(_playlistService.Playlists.First(p => p.Name == urlChoice).QueueItems);
+                    var playlist = _playlistService.Playlists.FirstOrDefault(p => p.Name == urlChoice);
+                    if (playlist == null)
+                        throw new Exception($"Playlist '{urlChoice}' not found.");
+                    var status = await _state.Client.MediaChannel.QueueLoadAsync(playlist.QueueItems);

SharpCaster.Console/Services/CommandExecutor.cs (1)

291-297: Case-insensitive check and null-safe lookup for playlist; avoid First() throw.
Matches CLI lowercasing and prevents exceptions.

Apply this diff:

-                        if (string.IsNullOrEmpty(args.PlaylistId) || !_playlistService.IsPlaylistId(args.PlaylistId))
+                        if (string.IsNullOrEmpty(args.PlaylistId) || !_playlistService.IsPlaylistId(args.PlaylistId))
                         {
                             System.Console.WriteLine("Error: Media URL or valid Playlist ID is required for play command.");
                             return 1;
                         }
-                        return await PlayPlaylistAsync(_playlistService.Playlists.First(p => p.Name == args.PlaylistId));
+                        var playlist = _playlistService.Playlists.FirstOrDefault(p => string.Equals(p.Name, args.PlaylistId, StringComparison.OrdinalIgnoreCase));
+                        if (playlist == null)
+                        {
+                            System.Console.WriteLine($"Error: Playlist '{args.PlaylistId}' not found.");
+                            return 1;
+                        }
+                        return await PlayPlaylistAsync(playlist);

🧹 Nitpick comments (4)

SharpCaster.Console/Flows/ApplicationFlows.cs (2)

196-206: Add option LGTM; make PageSize dynamic to avoid future truncation.
Hard‑coding 11 risks truncation if options change.

Apply this diff:

-                    .PageSize(11)
+                    .PageSize(choices.Length)

Also applies to: 211-217

237-240: Prevent nested menus; invoke Queue Management from here instead of inside CastPlaylistAsync.
Calling ShowQueueManagementAsync inside CastPlaylistAsync leads to nested loops when invoked from Queue Management. Trigger it here after casting.

Apply this diff:

-                case "Cast playlist":
-                    _ui.AddSeparator("Casting Playlist");
-                    await _queueController.CastPlaylistAsync();
-                    break;
+                case "Cast playlist":
+                    _ui.AddSeparator("💿 Casting Playlist");
+                    await _queueController.CastPlaylistAsync();
+                    await _queueController.ShowQueueManagementAsync();
+                    break;

SharpCaster.Console/Services/PlaylistService.cs (1)

7-10: Prefer a property and encapsulate mutation. Remove unused using.
Exposing a public field invites unintended writes.

Apply this diff:

-    public class PlaylistService
+    public class PlaylistService
     {
-        public Playlist[] Playlists;
+        public Playlist[] Playlists { get; private set; }

And at the top:

-using Microsoft.Extensions.Configuration;
+using System;
 using SharpCaster.Console.Models;
 using System.Text.Json;
+using System.IO;

SharpCaster.Console/Controllers/QueueController.cs (1)

131-146: Guard next-track when queue is empty or status unavailable.
Avoid misleading “last track” message when there’s no queue.

Apply this diff:

-                        var ids = await mediaChannel.QueueGetItemIdsAsync();
-
-                        if (ids?.LastOrDefault() == mediaChannel.MediaStatus?.CurrentItemId)
+                        var ids = await mediaChannel.QueueGetItemIdsAsync();
+                        if (ids == null || ids.Length == 0 || mediaChannel.MediaStatus?.CurrentItemId == null)
+                        {
+                            AnsiConsole.MarkupLine("[yellow]📋 No queue loaded or no current item.[/]");
+                        }
+                        else if (ids.LastOrDefault() == mediaChannel.MediaStatus.CurrentItemId)
                         {
                             AnsiConsole.MarkupLine("[yellow]⚠️  Already at the last track in the queue. Cannot skip to next track.[/]");
                         }
                         else
                         {

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d89e7d8 and 9da27c9.

📒 Files selected for processing (14)

SharpCaster.Console/Controllers/MediaController.cs (3 hunks)
SharpCaster.Console/Controllers/QueueController.cs (6 hunks)
SharpCaster.Console/Flows/ApplicationFlows.cs (3 hunks)
SharpCaster.Console/Models/CommandLineArgs.cs (3 hunks)
SharpCaster.Console/Models/ConsoleJsonContext.cs (1 hunks)
SharpCaster.Console/Models/Playlist.cs (1 hunks)
SharpCaster.Console/Models/UserSettingsModel.cs (1 hunks)
SharpCaster.Console/Program.cs (3 hunks)
SharpCaster.Console/Services/CommandExecutor.cs (6 hunks)
SharpCaster.Console/Services/PlaylistService.cs (1 hunks)
SharpCaster.Console/SharpCaster.Console.csproj (1 hunks)
SharpCaster.Console/userSettings.json (1 hunks)
Sharpcaster.Test/LoggingTester.cs (1 hunks)
Sharpcaster.Test/helper/TestHelper.cs (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{cs,csproj}

📄 CodeRabbit inference engine (CLAUDE.md)

Prefer System.Text.Json for JSON serialization (do not use Newtonsoft.Json)

Files:

SharpCaster.Console/Models/UserSettingsModel.cs
SharpCaster.Console/SharpCaster.Console.csproj
SharpCaster.Console/Models/CommandLineArgs.cs
SharpCaster.Console/Controllers/MediaController.cs
SharpCaster.Console/Models/Playlist.cs
SharpCaster.Console/Services/CommandExecutor.cs
SharpCaster.Console/Flows/ApplicationFlows.cs
SharpCaster.Console/Services/PlaylistService.cs
SharpCaster.Console/Controllers/QueueController.cs
SharpCaster.Console/Program.cs
SharpCaster.Console/Models/ConsoleJsonContext.cs
Sharpcaster.Test/LoggingTester.cs
Sharpcaster.Test/helper/TestHelper.cs

Sharpcaster.Test/**/*.cs

📄 CodeRabbit inference engine (CLAUDE.md)

Use xUnit for tests with Moq for mocking in the main test suite

Files:

Sharpcaster.Test/LoggingTester.cs
Sharpcaster.Test/helper/TestHelper.cs

🧠 Learnings (8)

📓 Common learnings

Learnt from: RobertK66
PR: Tapanila/SharpCaster#384
File: SharpCaster.Console/appsettings.json:88-100
Timestamp: 2025-09-08T09:11:28.905Z
Learning: In SharpCaster.Console appsettings.json playlist configuration, inconsistent ID usage is intentional flexibility - some playlists have explicit IDs while others rely on auto-generation from names. This design choice allows configuration authors to choose between explicit control and automatic ID generation.

📚 Learning: 2025-09-08T09:11:28.905Z

Learnt from: RobertK66
PR: Tapanila/SharpCaster#384
File: SharpCaster.Console/appsettings.json:88-100
Timestamp: 2025-09-08T09:11:28.905Z
Learning: In SharpCaster.Console appsettings.json playlist configuration, inconsistent ID usage is intentional flexibility - some playlists have explicit IDs while others rely on auto-generation from names. This design choice allows configuration authors to choose between explicit control and automatic ID generation.

Applied to files:

SharpCaster.Console/Models/UserSettingsModel.cs
SharpCaster.Console/Models/CommandLineArgs.cs
SharpCaster.Console/Models/Playlist.cs
SharpCaster.Console/Services/PlaylistService.cs
SharpCaster.Console/userSettings.json
SharpCaster.Console/Models/ConsoleJsonContext.cs