Files
ersatztv/ErsatzTV.Core/Scheduling/YamlScheduling/EnumeratorCache.cs
T
timothyandClaude Opus 4.8 f54c9ae195
PR Gates / CI image pin matches docker/ci (pull_request) Successful in 9s
PR Gates / Docs update reminder (pull_request) Successful in 13s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 1m25s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 1m21s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 7m36s
PR Gates / decisions lifecycle (pull_request) Failing after 14s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been cancelled
Build ErsatzTV Image / Functional E2E (curl contracts) (pull_request) Has been cancelled
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Has been cancelled
refactor(395): dedup Scripted≡YAML enumerator construction into ContentEnumeratorBuilder
Extract the byte-identical PlaybackOrder -> IMediaCollectionEnumerator switch
shared by SchedulingEngine.EnumeratorForContent (Scripted) and
EnumeratorCache.GetEnumeratorForContent (Sequential/YAML) into one static
per-family seam, mirroring #380's ShuffleSourceBuilder. Each engine keeps its own
"not supported" warning on the None branch, so the per-engine message is unchanged.
Adds ContentEnumeratorBuilderTests pinning the block-shuffle-not-classic trap and
the unsupported-order -> None (#70) contract across all 8 unsupported orders.

Corrects the testing.scripted-playout-golden-deferred decision record: Scripted's
external-process + HTTP pipeline is integration-only (deferred to #563), but the
in-process SchedulingEngine it drives IS unit-testable (ScriptedScheduleController
is a 1:1 pass-through) -- the earlier "un-golden-able by construction" framing
conflated transport with engine. docs/testing.md reframed to match.

[decisions-edit]

fixes #395

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 20:21:52 +02:00

201 lines
7.8 KiB
C#

using ErsatzTV.Core.Domain;
using ErsatzTV.Core.Interfaces.Repositories;
using ErsatzTV.Core.Interfaces.Scheduling;
using ErsatzTV.Core.Scheduling.BlockScheduling;
using ErsatzTV.Core.Scheduling.Engine;
using ErsatzTV.Core.Scheduling.YamlScheduling.Models;
using Microsoft.Extensions.Logging;
namespace ErsatzTV.Core.Scheduling.YamlScheduling;
public class EnumeratorCache(IMediaCollectionRepository mediaCollectionRepository, ILogger logger)
{
private readonly Dictionary<string, IMediaCollectionEnumerator> _enumerators = new();
private readonly Dictionary<string, List<MediaItem>> _mediaItems = new();
private readonly Dictionary<PlaylistKey, List<MediaItem>> _playlistMediaItems = new();
public System.Collections.Generic.HashSet<string> MissingContentKeys { get; } = [];
public List<MediaItem> MediaItemsForContent(string contentKey) =>
_mediaItems.TryGetValue(contentKey, out List<MediaItem> items) ? items : [];
public List<MediaItem> PlaylistMediaItemsForContent(string contentKey, CollectionKey collectionKey) =>
_playlistMediaItems.TryGetValue(new PlaylistKey(contentKey, collectionKey), out List<MediaItem> items)
? items
: [];
public async Task<Option<IMediaCollectionEnumerator>> GetCachedEnumeratorForContent(
YamlPlayoutContext context,
string contentKey,
CancellationToken cancellationToken)
{
if (string.IsNullOrWhiteSpace(contentKey))
{
return Option<IMediaCollectionEnumerator>.None;
}
if (!_enumerators.TryGetValue(contentKey, out IMediaCollectionEnumerator enumerator))
{
Option<IMediaCollectionEnumerator> maybeEnumerator =
await GetEnumeratorForContent(context, contentKey, cancellationToken);
if (maybeEnumerator.IsNone)
{
return Option<IMediaCollectionEnumerator>.None;
}
foreach (IMediaCollectionEnumerator e in maybeEnumerator)
{
enumerator = e;
_enumerators.Add(contentKey, enumerator);
}
}
return Some(enumerator);
}
private async Task<Option<IMediaCollectionEnumerator>> GetEnumeratorForContent(
YamlPlayoutContext context,
string contentKey,
CancellationToken cancellationToken)
{
int index = context.Definition.Content.FindIndex(c => c.Key == contentKey);
if (index < 0)
{
return Option<IMediaCollectionEnumerator>.None;
}
List<MediaItem> items = [];
YamlPlayoutContentItem content = context.Definition.Content[index];
switch (content)
{
case YamlPlayoutContentSearchItem search:
items = await mediaCollectionRepository.GetSmartCollectionItems(search.Query, string.Empty, cancellationToken);
break;
case YamlPlayoutContentShowItem show:
items = await mediaCollectionRepository.GetShowItemsByShowGuids(
show.Guids.Map(g => $"{g.Source}://{g.Value}").ToList());
break;
case YamlPlayoutContentCollectionItem collection:
items = await mediaCollectionRepository.GetCollectionItemsByName(
collection.Collection,
cancellationToken);
break;
case YamlPlayoutContentSmartCollectionItem smartCollection:
items = await mediaCollectionRepository.GetSmartCollectionItemsByName(
smartCollection.SmartCollection,
cancellationToken);
break;
case YamlPlayoutContentMultiCollectionItem multiCollection:
items = await mediaCollectionRepository.GetMultiCollectionItemsByName(
multiCollection.MultiCollection,
cancellationToken);
break;
// playlist is handled later
}
_mediaItems[content.Key] = items;
var state = new CollectionEnumeratorState { Seed = context.Playout.Seed + index, Index = 0 };
// marathon is a special case that needs to be handled on its own
if (content is YamlPlayoutContentMarathonItem marathon)
{
var helper = new MarathonHelper(mediaCollectionRepository);
var guids = new Dictionary<string, List<string>>();
foreach (var guid in marathon.Guids)
{
if (!guids.TryGetValue(guid.Source, out List<string> value))
{
value = [];
guids.Add(guid.Source, value);
}
value.Add(guid.Value);
}
if (!Enum.TryParse(marathon.ItemOrder, true, out PlaybackOrder itemPlaybackOrder))
{
itemPlaybackOrder = PlaybackOrder.Shuffle;
}
Option<PlaylistContentResult> maybeResult = await helper.GetEnumerator(
guids,
marathon.Searches,
marathon.GroupBy,
marathon.ShuffleGroups,
itemPlaybackOrder,
marathon.PlayAllItems,
state,
cancellationToken);
foreach (PlaylistContentResult result in maybeResult)
{
foreach ((CollectionKey collectionKey, List<MediaItem> mediaItems) in result.Content)
{
_playlistMediaItems.Add(new PlaylistKey(contentKey, collectionKey), mediaItems);
}
return result.PlaylistEnumerator;
}
}
// playlist is a special case that needs to be handled on its own
if (content is YamlPlayoutContentPlaylistItem playlist)
{
if (!string.IsNullOrWhiteSpace(playlist.Order) && !string.Equals(
playlist.Order,
"none",
StringComparison.OrdinalIgnoreCase))
{
logger.LogWarning(
"Ignoring playback order {Order} for playlist {Playlist}",
playlist.Order,
playlist.Playlist);
}
Dictionary<PlaylistItem, List<MediaItem>> itemMap =
await mediaCollectionRepository.GetPlaylistItemMap(
playlist.PlaylistGroup,
playlist.Playlist,
cancellationToken);
foreach ((PlaylistItem playlistItem, List<MediaItem> mediaItems) in itemMap)
{
_playlistMediaItems.Add(
new PlaylistKey(contentKey, CollectionKey.ForPlaylistItem(playlistItem)),
mediaItems);
}
return await PlaylistEnumerator.Create(
mediaCollectionRepository,
itemMap,
state,
shufflePlaylistItems: false,
batchSize: Option<int>.None,
cancellationToken,
Optional(logger));
}
var parsedOrder = Enum.Parse<PlaybackOrder>(content.Order, true);
Option<IMediaCollectionEnumerator> enumerator =
ContentEnumeratorBuilder.ForContent(items, state, parsedOrder, content.MultiPart);
// this path schedules nothing for the content, which is indistinguishable from "no items" downstream.
// Orders are addressed by name here, so any order the enum knows parses fine and then lands here --
// say so, rather than leaving an empty schedule to be explained (#70).
if (enumerator.IsNone)
{
logger.LogWarning(
"Playback order {PlaybackOrder} is not supported by sequential (YAML) scheduling; no content will be scheduled for this entry",
parsedOrder);
}
return enumerator;
}
private record PlaylistKey(string ContentKey, CollectionKey CollectionKey);
}