Files
ersatztv/ErsatzTV.Scanner/Core/Emby/EmbyTelevisionLibraryScanner.cs
T
timothy 6f4497e1ce fix(484): guard the nested TV season and episode sweeps against projection failures
Review finding 1 (blocking). ScanSeasons' FlagFileNotFoundSeasons and ScanEpisodes'
FlagFileNotFoundEpisodes had no guard at all — neither #477's nor #484's — so ProjectToSeason /
ProjectToEpisode returning Failed() was computed and discarded.

#477 scoped those out because "the blast radius is one show's seasons / one season's episodes",
which holds for a per-parent EMPTY fetch but not for a projection failure: that is systematic by
construction. One bad code path fires on every parent, so every season enumerates zero episodes,
existing.Except([]) is the whole episode library, and EmptyTrashHandler deletes it permanently.

Threads the counter into GetSeasonLibraryItems / GetEpisodeLibraryItems(WithoutPeople) for
Jellyfin and Emby using the same optional-trailing-param shape, and guards both sweeps with
MediaServerReconciliationGuard.ShouldFlagMissingDescendants — the same class and the same private
failure predicate as ShouldFlagMissing, deliberately WITHOUT #477's empty-fetch branch so
per-parent empty behaviour (and #476's cascade, which depends on it) is unchanged.

Also from the review:
- finding 3: tests now pin the same-instance JOIN at every level (movie, show, season, episode,
  music video) by driving the real ScanLibrary entry point and recording the failure from inside
  the enumeration, so a refactor handing the api client a fresh counter goes red.
- finding 4: the missing-library Failed() branch is documented as defensive and unreachable.
- finding 2: the mass-Skip residual (Emby's response-shape-dependent MediaSources guard, Plex's
  pre-projection filter) is stated as a known limitation in the decision record.
- finding 5: the log-contract change (only the #484 message when both refusals apply) is noted.

fixes #484
2026-07-25 16:36:35 +02:00

287 lines
11 KiB
C#

using System.IO.Abstractions;
using ErsatzTV.Core;
using ErsatzTV.Core.Domain;
using ErsatzTV.Core.Emby;
using ErsatzTV.Core.Errors;
using ErsatzTV.Core.Extensions;
using ErsatzTV.Core.Interfaces.Emby;
using ErsatzTV.Core.Interfaces.Repositories;
using ErsatzTV.Core.Metadata;
using ErsatzTV.Scanner.Core.Interfaces;
using ErsatzTV.Scanner.Core.Interfaces.Metadata;
using ErsatzTV.Scanner.Core.Metadata;
using Microsoft.Extensions.Logging;
namespace ErsatzTV.Scanner.Core.Emby;
public class EmbyTelevisionLibraryScanner : MediaServerTelevisionLibraryScanner<EmbyConnectionParameters, EmbyLibrary,
EmbyShow, EmbySeason, EmbyEpisode,
EmbyItemEtag>, IEmbyTelevisionLibraryScanner
{
private readonly IEmbyApiClient _embyApiClient;
private readonly ILogger<EmbyTelevisionLibraryScanner> _logger;
private readonly IMediaSourceRepository _mediaSourceRepository;
private readonly IEmbyPathReplacementService _pathReplacementService;
private readonly IEmbyTelevisionRepository _televisionRepository;
public EmbyTelevisionLibraryScanner(
IScannerProxy scannerProxy,
IEmbyApiClient embyApiClient,
IMediaSourceRepository mediaSourceRepository,
IEmbyTelevisionRepository televisionRepository,
IEmbyPathReplacementService pathReplacementService,
IFileSystem fileSystem,
ILocalChaptersProvider localChaptersProvider,
IMetadataRepository metadataRepository,
ILogger<EmbyTelevisionLibraryScanner> logger)
: base(
scannerProxy,
fileSystem,
localChaptersProvider,
metadataRepository,
logger)
{
_embyApiClient = embyApiClient;
_mediaSourceRepository = mediaSourceRepository;
_televisionRepository = televisionRepository;
_pathReplacementService = pathReplacementService;
_logger = logger;
}
protected override bool ServerSupportsRemoteStreaming => true;
public async Task<Either<BaseError, Unit>> ScanLibrary(
string address,
string apiKey,
EmbyLibrary library,
bool deepScan,
CancellationToken cancellationToken)
{
List<EmbyPathReplacement> pathReplacements =
await _mediaSourceRepository.GetEmbyPathReplacements(library.MediaSourceId);
string GetLocalPath(EmbyEpisode episode)
{
return _pathReplacementService.GetReplacementEmbyPath(
pathReplacements,
episode.GetHeadVersion().MediaFiles.Head().Path,
false);
}
return await ScanLibrary(
_televisionRepository,
new EmbyConnectionParameters(address, apiKey),
library,
GetLocalPath,
deepScan,
cancellationToken);
}
public async Task<Either<BaseError, Unit>> ScanSingleShow(
string address,
string apiKey,
EmbyLibrary library,
string showId,
string showTitle,
bool deepScan,
CancellationToken cancellationToken)
{
List<EmbyPathReplacement> pathReplacements =
await _mediaSourceRepository.GetEmbyPathReplacements(library.MediaSourceId);
string GetLocalPath(EmbyEpisode episode)
{
return _pathReplacementService.GetReplacementEmbyPath(
pathReplacements,
episode.GetHeadVersion().MediaFiles.Head().Path,
false);
}
// Search for the specific show
Either<BaseError, Option<EmbyShow>> searchResult = await _embyApiClient.GetSingleShow(
address,
apiKey,
library,
showId);
return await searchResult.Match(
async maybeShow =>
{
foreach (EmbyShow show in maybeShow)
{
_logger.LogInformation(
"Found show '{ShowTitle}' with id {ShowId}, starting targeted scan",
showTitle,
show.ItemId);
return await ScanSingleShowInternal(
_televisionRepository,
new EmbyConnectionParameters(address, apiKey),
library,
show,
GetLocalPath,
deepScan,
cancellationToken);
}
_logger.LogWarning("No show found with id {ShowId} in library {LibraryName}", showId, library.Name);
return Right<BaseError, Unit>(Unit.Default);
},
error => Task.FromResult<Either<BaseError, Unit>>(error));
}
protected override IAsyncEnumerable<Tuple<EmbyShow, int>> GetShowLibraryItems(
EmbyConnectionParameters connectionParameters,
EmbyLibrary library,
MediaServerProjectionFailureCounter projectionFailures) =>
_embyApiClient.GetShowLibraryItems(
connectionParameters.Address,
connectionParameters.ApiKey,
library,
projectionFailures);
protected override string MediaServerItemId(EmbyShow show) => show.ItemId;
protected override string MediaServerItemId(EmbySeason season) => season.ItemId;
protected override string MediaServerItemId(EmbyEpisode episode) => episode.ItemId;
protected override string MediaServerEtag(EmbyShow show) => show.Etag;
protected override string MediaServerEtag(EmbySeason season) => season.Etag;
protected override string MediaServerEtag(EmbyEpisode episode) => episode.Etag;
protected override IAsyncEnumerable<Tuple<EmbySeason, int>> GetSeasonLibraryItems(
EmbyLibrary library,
EmbyConnectionParameters connectionParameters,
EmbyShow show,
MediaServerProjectionFailureCounter projectionFailures) =>
_embyApiClient.GetSeasonLibraryItems(
connectionParameters.Address,
connectionParameters.ApiKey,
library,
show.ItemId,
projectionFailures);
protected override IAsyncEnumerable<Tuple<EmbyEpisode, int>> GetEpisodeLibraryItems(
EmbyLibrary library,
EmbyConnectionParameters connectionParameters,
EmbyShow show,
EmbySeason season,
bool isNewSeason,
MediaServerProjectionFailureCounter projectionFailures) =>
_embyApiClient.GetEpisodeLibraryItems(
connectionParameters.Address,
connectionParameters.ApiKey,
library,
show.ItemId,
season.ItemId,
projectionFailures);
protected override Task<Option<ShowMetadata>> GetFullMetadata(
EmbyConnectionParameters connectionParameters,
EmbyLibrary library,
MediaItemScanResult<EmbyShow> result,
EmbyShow incoming,
bool deepScan) =>
Task.FromResult(Option<ShowMetadata>.None);
protected override Task<Option<SeasonMetadata>> GetFullMetadata(
EmbyConnectionParameters connectionParameters,
EmbyLibrary library,
MediaItemScanResult<EmbySeason> result,
EmbySeason incoming,
bool deepScan) =>
Task.FromResult(Option<SeasonMetadata>.None);
protected override Task<Option<EpisodeMetadata>> GetFullMetadata(
EmbyConnectionParameters connectionParameters,
EmbyLibrary library,
MediaItemScanResult<EmbyEpisode> result,
EmbyEpisode incoming,
bool deepScan) =>
Task.FromResult(Option<EpisodeMetadata>.None);
protected override Task<Option<Tuple<EpisodeMetadata, MediaVersion>>> GetFullMetadataAndStatistics(
EmbyConnectionParameters connectionParameters,
EmbyLibrary library,
MediaItemScanResult<EmbyEpisode> result,
EmbyEpisode incoming) => Task.FromResult(Option<Tuple<EpisodeMetadata, MediaVersion>>.None);
protected override async Task<Option<MediaVersion>> GetMediaServerStatistics(
EmbyConnectionParameters connectionParameters,
EmbyLibrary library,
MediaItemScanResult<EmbyEpisode> result,
EmbyEpisode incoming)
{
_logger.LogDebug("Refreshing {Attribute} for {Path}", "Emby Statistics", result.LocalPath);
Either<BaseError, MediaVersion> maybeVersion =
await _embyApiClient.GetPlaybackInfo(
connectionParameters.Address,
connectionParameters.ApiKey,
library,
incoming.ItemId);
foreach (BaseError error in maybeVersion.LeftToSeq())
{
_logger.LogWarning("Failed to get episode statistics from Emby: {Error}", error.ToString());
}
// chapters are pulled with metadata, not with statistics, but we need to save them here
foreach (MediaVersion version in maybeVersion.RightToSeq())
{
version.Chapters = result.Item.GetHeadVersion().Chapters;
}
return maybeVersion.ToOption();
}
protected override Task<Either<BaseError, MediaItemScanResult<EmbyShow>>> UpdateMetadata(
MediaItemScanResult<EmbyShow> result,
ShowMetadata fullMetadata) =>
Task.FromResult<Either<BaseError, MediaItemScanResult<EmbyShow>>>(result);
protected override Task<Either<BaseError, MediaItemScanResult<EmbySeason>>> UpdateMetadata(
MediaItemScanResult<EmbySeason> result,
SeasonMetadata fullMetadata) =>
Task.FromResult<Either<BaseError, MediaItemScanResult<EmbySeason>>>(result);
protected override Task<Either<BaseError, MediaItemScanResult<EmbyEpisode>>> UpdateMetadata(
MediaItemScanResult<EmbyEpisode> result,
EpisodeMetadata fullMetadata,
CancellationToken cancellationToken) =>
Task.FromResult<Either<BaseError, MediaItemScanResult<EmbyEpisode>>>(result);
private async Task<Either<BaseError, Unit>> ScanSingleShowInternal(
IEmbyTelevisionRepository televisionRepository,
EmbyConnectionParameters connectionParameters,
EmbyLibrary library,
EmbyShow targetShow,
Func<EmbyEpisode, string> getLocalPath,
bool deepScan,
CancellationToken cancellationToken)
{
try
{
async IAsyncEnumerable<Tuple<EmbyShow, int>> GetSingleShow()
{
yield return new Tuple<EmbyShow, int>(targetShow, 1);
await Task.CompletedTask;
}
return await ScanLibraryWithoutCleanup(
televisionRepository,
connectionParameters,
library,
getLocalPath,
GetSingleShow(),
deepScan,
cancellationToken);
}
catch (Exception ex) when (ex is TaskCanceledException or OperationCanceledException)
{
return new ScanCanceled();
}
}
}