Count a failed image refresh as a failure too

This commit is contained in:
Shadowghost 2026-09-10 16:12:55 +02:00
parent c645b39f55
commit 3f02cb66ae
4 changed files with 149 additions and 2 deletions

View file

@ -254,6 +254,7 @@ namespace MediaBrowser.Providers.Manager
}
catch (Exception ex)
{
result.Failures++;
result.ErrorMessage = ex.Message;
_logger.LogError(ex, "Error in {Provider} for {Item}", provider.Name, item.Path ?? item.Name);
}
@ -338,6 +339,7 @@ namespace MediaBrowser.Providers.Manager
}
catch (Exception ex)
{
result.Failures++;
result.ErrorMessage = ex.Message;
_logger.LogError(ex, "Error in {Provider} for {Item}", provider.Name, item.Path ?? item.Name);
}

View file

@ -192,9 +192,13 @@ namespace MediaBrowser.Providers.Manager
}
}
// Next run remote image providers, but only if local image providers didn't throw an exception
if (!localImagesFailed && refreshOptions.ImageRefreshMode > MetadataRefreshMode.ValidationOnly)
if (localImagesFailed)
{
hasRefreshedImages = false;
}
else if (refreshOptions.ImageRefreshMode > MetadataRefreshMode.ValidationOnly)
{
// Next run remote image providers, now that local image providers didn't throw
var providers = GetNonLocalImageProviders(item, allImageProviders, refreshOptions).ToList();
if (providers.Count > 0)

View file

@ -557,6 +557,47 @@ namespace Jellyfin.Providers.Tests.Manager
Assert.Equal(expectedToUpdate, result.UpdateType.HasFlag(ItemUpdateType.ImageUpdate));
}
[Fact]
public async Task RefreshImages_ProviderDynamicThrows_CountsAFailure()
{
var item = GetItemWithImages(ImageType.Primary, 0, false);
var libraryOptions = GetLibraryOptions(item, ImageType.Primary, 1);
var dynamicProvider = new Mock<IDynamicImageProvider>(MockBehavior.Strict);
dynamicProvider.Setup(rp => rp.Name).Returns("MockDynamicProvider");
dynamicProvider.Setup(rp => rp.GetSupportedImages(item))
.Returns(new[] { ImageType.Primary });
dynamicProvider.Setup(rp => rp.GetImage(item, ImageType.Primary, It.IsAny<CancellationToken>()))
.ThrowsAsync(new InvalidOperationException("provider is broken"));
var itemImageProvider = GetItemImageProvider(null, new Mock<IFileSystem>());
var result = await itemImageProvider.RefreshImages(item, libraryOptions, new List<IImageProvider> { dynamicProvider.Object }, new ImageRefreshOptions(Mock.Of<IDirectoryService>()), CancellationToken.None);
// Without this the caller stamps DateLastRefreshed and never asks this provider again.
Assert.Equal(1, result.Failures);
}
[Fact]
public async Task RefreshImages_ProviderRemoteThrows_CountsAFailure()
{
var item = GetItemWithImages(ImageType.Primary, 0, false);
var libraryOptions = GetLibraryOptions(item, ImageType.Primary, 1);
var remoteProvider = new Mock<IRemoteImageProvider>(MockBehavior.Strict);
remoteProvider.Setup(rp => rp.Name).Returns("MockRemoteProvider");
remoteProvider.Setup(rp => rp.GetSupportedImages(item))
.Returns(new[] { ImageType.Primary });
var providerManager = new Mock<IProviderManager>(MockBehavior.Strict);
providerManager.Setup(pm => pm.GetAvailableRemoteImages(It.IsAny<BaseItem>(), It.IsAny<RemoteImageQuery>(), It.IsAny<CancellationToken>()))
.ThrowsAsync(new HttpRequestException("unreachable"));
var itemImageProvider = GetItemImageProvider(providerManager.Object, new Mock<IFileSystem>());
var result = await itemImageProvider.RefreshImages(item, libraryOptions, new List<IImageProvider> { remoteProvider.Object }, new ImageRefreshOptions(Mock.Of<IDirectoryService>()), CancellationToken.None);
Assert.Equal(1, result.Failures);
}
private static ItemImageProvider GetItemImageProvider(IProviderManager? providerManager, Mock<IFileSystem>? mockFileSystem)
{
// strict to ensure this isn't accidentally used where a prepared mock is intended

View file

@ -342,6 +342,106 @@ namespace Jellyfin.Providers.Tests.Manager
Assert.Equal(providerThrows, item.DateLastRefreshed == stampBefore);
}
[Theory]
[InlineData(true)]
[InlineData(false)]
public async Task RefreshMetadata_ImageProviderThrew_LeavesRefreshDateAlone(bool providerThrows)
{
var item = NewStampedTestItem();
var stampBefore = item.DateLastRefreshed;
var imageProvider = new Mock<IDynamicImageProvider>(MockBehavior.Loose);
imageProvider.Setup(p => p.Name).Returns("Throwing Image Provider");
imageProvider.Setup(p => p.GetSupportedImages(It.IsAny<BaseItem>())).Returns(new[] { ImageType.Primary });
imageProvider.Setup(p => p.GetImage(It.IsAny<BaseItem>(), ImageType.Primary, It.IsAny<CancellationToken>()))
.Returns(providerThrows
? Task.FromException<DynamicImageResponse>(new InvalidOperationException("image fetch failed"))
: Task.FromResult(new DynamicImageResponse { HasImage = false }));
var providerManager = NewProviderManager(imageProviders: [imageProvider.Object]);
var service = NewService(providerManager);
await service.RefreshMetadata(
item,
new MetadataRefreshOptions(Mock.Of<IDirectoryService>())
{
MetadataRefreshMode = MetadataRefreshMode.FullRefresh,
ImageRefreshMode = MetadataRefreshMode.FullRefresh
},
CancellationToken.None).ConfigureAwait(true);
Assert.Equal(providerThrows, item.DateLastRefreshed == stampBefore);
}
[Fact]
public async Task RefreshMetadata_LocalImageValidationThrew_LeavesRefreshDateAlone()
{
var item = NewStampedTestItem();
var stampBefore = item.DateLastRefreshed;
// A throw here skips the remote image stage altogether, so no image work happened at all.
var localImageProvider = new Mock<ILocalImageProvider>(MockBehavior.Loose);
localImageProvider.Setup(p => p.Name).Returns("Throwing Local Image Provider");
localImageProvider.Setup(p => p.GetImages(It.IsAny<BaseItem>(), It.IsAny<IDirectoryService>()))
.Throws(new UnauthorizedAccessException("metadata folder is not readable"));
var providerManager = NewProviderManager(imageProviders: [localImageProvider.Object]);
var service = NewService(providerManager);
await service.RefreshMetadata(
item,
new MetadataRefreshOptions(Mock.Of<IDirectoryService>())
{
MetadataRefreshMode = MetadataRefreshMode.FullRefresh,
ImageRefreshMode = MetadataRefreshMode.FullRefresh
},
CancellationToken.None).ConfigureAwait(true);
Assert.Equal(stampBefore, item.DateLastRefreshed);
}
private static TestItem NewStampedTestItem()
{
var item = new TestItem
{
Id = Guid.NewGuid(),
Name = "Test Item",
PreferredMetadataLanguage = "en",
PreferredMetadataCountryCode = "US",
DateLastRefreshed = DateTime.UtcNow.AddDays(-60),
DateLastSaved = DateTime.UtcNow.AddDays(-60)
};
item.PresentationUniqueKey = item.CreatePresentationUniqueKey();
return item;
}
private static Mock<IProviderManager> NewProviderManager(
IMetadataProvider<TestItem>[]? metadataProviders = null,
IImageProvider[]? imageProviders = null)
{
var providerManager = new Mock<IProviderManager>(MockBehavior.Loose);
providerManager.Setup(p => p.GetImageProviders(It.IsAny<BaseItem>(), It.IsAny<ImageRefreshOptions>()))
.Returns(imageProviders ?? Array.Empty<IImageProvider>());
providerManager.Setup(p => p.GetMetadataProviders<TestItem>(It.IsAny<BaseItem>(), It.IsAny<LibraryOptions>()))
.Returns(metadataProviders ?? Array.Empty<IMetadataProvider<TestItem>>());
providerManager.Setup(p => p.GetMetadataSavers(It.IsAny<BaseItem>(), It.IsAny<LibraryOptions>()))
.Returns(Array.Empty<IMetadataSaver>());
return providerManager;
}
private static TestItemMetadataService NewService(Mock<IProviderManager> providerManager)
{
var libraryManager = new Mock<ILibraryManager>(MockBehavior.Loose);
libraryManager.Setup(l => l.GetLibraryOptions(It.IsAny<BaseItem>())).Returns(new LibraryOptions());
var itemRepository = new Mock<IItemRepository>(MockBehavior.Loose);
itemRepository.Setup(r => r.ItemExistsAsync(It.IsAny<Guid>())).ReturnsAsync(true);
return new TestItemMetadataService(libraryManager.Object, providerManager.Object, itemRepository.Object);
}
/// <summary>
/// Stands in for a real item so the refresh stays off the shared BaseItem statics, which other
/// test classes in this assembly overwrite while xUnit runs them in parallel.