Version-aware playback tracking

This commit is contained in:
Shadowghost
2026-06-02 02:07:23 +02:00
parent 82b946733f
commit 5db84fee1a
8 changed files with 392 additions and 60 deletions

View File

@@ -1,6 +1,14 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using Jellyfin.Database.Implementations.Entities;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.LiveTv;
using MediaBrowser.Controller.MediaSegments;
using MediaBrowser.Model.Dto;
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.MediaInfo;
using Moq;
using Xunit;
@@ -108,4 +116,164 @@ public class BaseItemTests
Assert.Equal(expectedPrimary, video.GetMediaSourceName(video, commonPrefix));
Assert.Equal(expectedAlt, videoAlt.GetMediaSourceName(videoAlt, commonPrefix));
}
[Fact]
public void GetAlternateVersion_ReturnsMatchingLocalVersion()
{
var (primary, alt1, alt2) = SetupVersionGroup();
Assert.Same(alt1, primary.GetAlternateVersion(alt1.Id));
Assert.Same(alt2, primary.GetAlternateVersion(alt2.Id));
Assert.Same(primary, primary.GetAlternateVersion(primary.Id));
Assert.Null(primary.GetAlternateVersion(Guid.NewGuid()));
}
[Fact]
public void PropagatePlayedState_MarksAlternateVersions_AndResetsPositionByDefault()
{
var (primary, alt1, alt2) = SetupVersionGroup();
var saved = CaptureSaves();
var user = new User("test", "default", "default");
primary.PropagatePlayedState(user, true);
// Both alternate versions are marked played, the primary (self) is not, and the position is
// reset so a watched version does not linger in "Continue Watching".
Assert.Equal(2, saved.Count);
Assert.DoesNotContain(saved, e => e.ItemId.Equals(primary.Id));
Assert.Contains(saved, e => e.ItemId.Equals(alt1.Id));
Assert.Contains(saved, e => e.ItemId.Equals(alt2.Id));
Assert.All(saved, e =>
{
Assert.True(e.Dto.Played.GetValueOrDefault());
Assert.Equal(0, e.Dto.PlaybackPositionTicks);
});
}
[Fact]
public void PropagatePlayedState_WithoutReset_LeavesPositionUntouched()
{
var (primary, _, _) = SetupVersionGroup();
var saved = CaptureSaves();
primary.PropagatePlayedState(new User("test", "default", "default"), true, resetPosition: false);
Assert.Equal(2, saved.Count);
Assert.All(saved, e =>
{
Assert.True(e.Dto.Played.GetValueOrDefault());
Assert.Null(e.Dto.PlaybackPositionTicks);
});
}
private static List<(Guid ItemId, UpdateUserItemDataDto Dto)> CaptureSaves()
{
var saved = new List<(Guid ItemId, UpdateUserItemDataDto Dto)>();
var userDataManager = new Mock<IUserDataManager>();
userDataManager
.Setup(x => x.SaveUserData(It.IsAny<User>(), It.IsAny<BaseItem>(), It.IsAny<UpdateUserItemDataDto>(), It.IsAny<UserDataSaveReason>()))
.Callback<User, BaseItem, UpdateUserItemDataDto, UserDataSaveReason>((_, item, dto, _) => saved.Add((item.Id, dto)));
BaseItem.UserDataManager = userDataManager.Object;
return saved;
}
[Fact]
public void PropagatePlayedState_SingleVersion_DoesNothing()
{
var solo = new Video { Id = Guid.NewGuid(), Path = "/Movies/Solo/Solo.mkv" };
var mediaSourceManager = new Mock<IMediaSourceManager>();
mediaSourceManager.Setup(x => x.GetPathProtocol(It.IsAny<string>())).Returns(MediaProtocol.File);
var libraryManager = new Mock<ILibraryManager>();
libraryManager.Setup(x => x.GetLocalAlternateVersionIds(It.IsAny<Video>())).Returns(Array.Empty<Guid>());
libraryManager.Setup(x => x.GetLinkedAlternateVersions(It.IsAny<Video>())).Returns(Array.Empty<Video>());
BaseItem.MediaSourceManager = mediaSourceManager.Object;
BaseItem.LibraryManager = libraryManager.Object;
var userDataManager = new Mock<IUserDataManager>();
BaseItem.UserDataManager = userDataManager.Object;
solo.PropagatePlayedState(new User("test", "default", "default"), true);
userDataManager.Verify(
x => x.SaveUserData(It.IsAny<User>(), It.IsAny<BaseItem>(), It.IsAny<UpdateUserItemDataDto>(), It.IsAny<UserDataSaveReason>()),
Times.Never);
}
private static (Video Primary, Video Alt1, Video Alt2) SetupVersionGroup()
{
var primary = new Video { Id = Guid.NewGuid(), Path = "/Movies/Movie/Movie.mkv" };
var alt1 = new Video { Id = Guid.NewGuid(), Path = "/Movies/Movie/Movie - 1080p.mkv", PrimaryVersionId = primary.Id };
var alt2 = new Video { Id = Guid.NewGuid(), Path = "/Movies/Movie/Movie - 4K.mkv", PrimaryVersionId = primary.Id };
// 2160p primary, 1080p alternates: width is only the ordering tiebreaker, set so it would place
// the primary first — letting the tests confirm the queried version's own source still wins.
var widths = new Dictionary<Guid, int> { [primary.Id] = 3840, [alt1.Id] = 1920, [alt2.Id] = 1920 };
var mediaSourceManager = new Mock<IMediaSourceManager>();
mediaSourceManager.Setup(x => x.GetPathProtocol(It.IsAny<string>())).Returns(MediaProtocol.File);
mediaSourceManager.Setup(x => x.GetMediaStreams(It.IsAny<Guid>()))
.Returns((Guid id) => new List<MediaStream> { new MediaStream { Type = MediaStreamType.Video, Width = widths.GetValueOrDefault(id) } });
mediaSourceManager.Setup(x => x.GetMediaAttachments(It.IsAny<Guid>())).Returns(new List<MediaAttachment>());
var segmentManager = new Mock<IMediaSegmentManager>();
segmentManager.Setup(x => x.IsTypeSupported(It.IsAny<BaseItem>())).Returns(false);
BaseItem.MediaSegmentManager = segmentManager.Object;
var libraryManager = new Mock<ILibraryManager>();
libraryManager.Setup(x => x.GetLinkedAlternateVersions(It.IsAny<Video>())).Returns(Array.Empty<Video>());
libraryManager.Setup(x => x.GetLocalAlternateVersionIds(primary)).Returns(new[] { alt1.Id, alt2.Id });
libraryManager.Setup(x => x.GetLocalAlternateVersionIds(alt1)).Returns(Array.Empty<Guid>());
libraryManager.Setup(x => x.GetLocalAlternateVersionIds(alt2)).Returns(Array.Empty<Guid>());
libraryManager.Setup(x => x.GetItemById(alt1.Id)).Returns(alt1);
libraryManager.Setup(x => x.GetItemById(alt2.Id)).Returns(alt2);
libraryManager.Setup(x => x.GetItemById(primary.Id)).Returns(primary);
var recordingsManager = new Mock<IRecordingsManager>();
recordingsManager.Setup(x => x.GetActiveRecordingInfo(It.IsAny<string>())).Returns((ActiveRecordingInfo?)null);
Video.RecordingsManager = recordingsManager.Object;
BaseItem.MediaSourceManager = mediaSourceManager.Object;
BaseItem.LibraryManager = libraryManager.Object;
return (primary, alt1, alt2);
}
[Fact]
public void GetMediaSources_DefaultsToTheQueriedVersionsOwnSource()
{
var (primary, alt1, _) = SetupVersionGroup();
// Resuming the 1080p alternate must default to the 1080p source, not the higher-resolution
// 2160p primary that the width ordering would otherwise place first.
Assert.Equal(alt1.Id.ToString("N"), alt1.GetMediaSources(false)[0].Id);
// Opening the primary still defaults to the primary's own (here highest-resolution) source.
Assert.Equal(primary.Id.ToString("N"), primary.GetMediaSources(false)[0].Id);
}
[Fact]
public void GetAllItemsForMediaSources_FromAnyVersion_HasNoDuplicates()
{
var (primary, alt1, alt2) = SetupVersionGroup();
var method = typeof(Video).GetMethod("GetAllItemsForMediaSources", BindingFlags.Instance | BindingFlags.NonPublic);
Assert.NotNull(method);
// Each version must surface exactly once, regardless of which member the list is built from.
// Building from an alternate previously re-added that alternate as a "local alternate" of the
// primary, producing a duplicate entry in the version dropdown.
foreach (var source in new[] { primary, alt1, alt2 })
{
var items = (IEnumerable<(BaseItem Item, MediaSourceType MediaSourceType)>)method!.Invoke(source, null)!;
var ids = items.Select(i => i.Item.Id).ToList();
Assert.Equal(3, ids.Count);
Assert.Equal(ids.Count, ids.Distinct().Count());
Assert.Contains(primary.Id, ids);
Assert.Contains(alt1.Id, ids);
Assert.Contains(alt2.Id, ids);
}
}
}