Backport pull request #17842 from jellyfin/release-12.z

Fix versions of a video still listing separately from their group and preserve manual merges

Original-merge: cabec7ec28df671e3bb1c360c32db60b085f4084

Merged-by: crobibero <cody@robibe.ro>

Backported-by: Cody Robibero <cody@robibe.ro>

3 files changed, 414 insertions, 1 deletions

diff --git a/tests/Jellyfin.Server.Implementations.Tests/Item/BaseItemRepositoryChildrenTests.cs b/tests/Jellyfin.Server.Implementations.Tests/Item/BaseItemRepositoryChildrenTests.cs
new file mode 100644
index 0000000000..5e045e9f83
--- /dev/null
+++ b/tests/Jellyfin.Server.Implementations.Tests/Item/BaseItemRepositoryChildrenTests.cs
@@ -0,0 +1,103 @@
+using System;
+using System.Linq;
+using Emby.Server.Implementations.Data;
+using Jellyfin.Database.Implementations.Entities;
+using Jellyfin.Server.Implementations.Item;
+using MediaBrowser.Controller.Entities;
+using Xunit;
+using BaseItemKind = Jellyfin.Data.Enums.BaseItemKind;
+
+namespace Jellyfin.Server.Implementations.Tests.Item;
+
+/// <summary>
+/// Covers the children query the library scan runs against a folder: a version merged by hand is
+/// hidden from ordinary queries, but the scan has to see it or it takes the row for a new item and
+/// recreates it, splitting the version group apart again.
+/// </summary>
+public sealed class BaseItemRepositoryChildrenTests : SqliteDbTestFixture
+{
+    private static readonly Guid _folderId = Guid.Parse("aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa");
+    private static readonly Guid _primaryId = Guid.Parse("bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb");
+    private static readonly Guid _mergedVersionId = Guid.Parse("cccccccc-cccc-cccc-cccc-cccccccccccc");
+    private static readonly Guid _ownedVersionId = Guid.Parse("dddddddd-dddd-dddd-dddd-dddddddddddd");
+
+    private readonly BaseItemRepository _repository;
+
+    public BaseItemRepositoryChildrenTests()
+    {
+        var itemTypeLookup = new ItemTypeLookup();
+        _repository = CreateBaseItemRepository(itemTypeLookup);
+
+        var movieTypeName = itemTypeLookup.BaseItemKindNames[BaseItemKind.Movie];
+        using var ctx = CreateDbContext();
+        ctx.BaseItems.Add(new BaseItemEntity
+        {
+            Id = _folderId,
+            Type = itemTypeLookup.BaseItemKindNames[BaseItemKind.Folder]!,
+            Name = "Movies",
+            Path = "/movies",
+            IsFolder = true
+        });
+        ctx.BaseItems.Add(CreateMovie(_primaryId, movieTypeName!, "Big Buck Bunny", "/media1/Big Buck Bunny/bbb-1080p.mp4", null, null));
+        ctx.BaseItems.Add(CreateMovie(_mergedVersionId, movieTypeName!, "Big Buck Bunny", "/media2/Big Buck Bunny/bbb-2160p.mp4", _primaryId, null));
+        ctx.BaseItems.Add(CreateMovie(_ownedVersionId, movieTypeName!, "Big Buck Bunny - 720p", "/media1/Big Buck Bunny/bbb-720p.mp4", _primaryId, _primaryId));
+        ctx.SaveChanges();
+    }
+
+    [Fact]
+    public void GetItemList_ChildrenOfFolder_ExcludesAlternateVersionsByDefault()
+    {
+        var result = _repository.GetItemList(new InternalItemsQuery { ParentId = _folderId });
+
+        var item = Assert.Single(result);
+        Assert.Equal(_primaryId, item.Id);
+    }
+
+    [Fact]
+    public void GetItemList_ChildrenOfFolderIncludingAlternateVersions_KeepsMergedVersion()
+    {
+        var result = _repository.GetItemList(new InternalItemsQuery
+        {
+            ParentId = _folderId,
+            IncludeAlternateVersions = true
+        });
+
+        Assert.Equal(2, result.Count);
+        Assert.Contains(result, i => i.Id.Equals(_primaryId));
+        Assert.Contains(result, i => i.Id.Equals(_mergedVersionId));
+    }
+
+    [Fact]
+    public void GetItemList_ChildrenOfFolderIncludingAlternateVersions_StillExcludesOwnedVersion()
+    {
+        // A version stored next to the file it belongs to is owned by its primary and is never
+        // resolved on its own, so the scan must not see it as a child of the folder either.
+        var result = _repository.GetItemList(new InternalItemsQuery
+        {
+            ParentId = _folderId,
+            IncludeAlternateVersions = true
+        });
+
+        Assert.DoesNotContain(result, i => i.Id.Equals(_ownedVersionId));
+    }
+
+    private static BaseItemEntity CreateMovie(Guid id, string typeName, string name, string path, Guid? primaryVersionId, Guid? ownerId)
+    {
+        return new BaseItemEntity
+        {
+            Id = id,
+            Type = typeName,
+            Name = name,
+            Path = path,
+            ParentId = _folderId,
+            TopParentId = _folderId,
+            PresentationUniqueKey = (primaryVersionId ?? id).ToString("N"),
+            PrimaryVersionId = primaryVersionId,
+            OwnerId = ownerId,
+            MediaType = "Video",
+            IsMovie = true,
+            IsFolder = false,
+            IsVirtualItem = false
+        };
+    }
+}
diff --git a/tests/Jellyfin.Server.Implementations.Tests/Item/BaseItemRepositoryGroupingTests.cs b/tests/Jellyfin.Server.Implementations.Tests/Item/BaseItemRepositoryGroupingTests.cs
index 535961a66c..9238ec9fd1 100644
--- a/tests/Jellyfin.Server.Implementations.Tests/Item/BaseItemRepositoryGroupingTests.cs
+++ b/tests/Jellyfin.Server.Implementations.Tests/Item/BaseItemRepositoryGroupingTests.cs
@@ -13,13 +13,18 @@ namespace Jellyfin.Server.Implementations.Tests.Item;
 
 public sealed class BaseItemRepositoryGroupingTests : SqliteDbTestFixture
 {
+    private static readonly Guid _movieLibraryId = Guid.Parse("aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa");
+    private static readonly Guid _movie4KLibraryId = Guid.Parse("bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb");
+
     private readonly BaseItemRepository _repository;
     private readonly string _movieTypeName;
+    private readonly string _folderTypeName;
 
     public BaseItemRepositoryGroupingTests()
     {
         var itemTypeLookup = new ItemTypeLookup();
         _movieTypeName = itemTypeLookup.BaseItemKindNames[BaseItemKind.Movie];
+        _folderTypeName = itemTypeLookup.BaseItemKindNames[BaseItemKind.Folder];
 
         _repository = CreateBaseItemRepository(itemTypeLookup);
     }
@@ -67,6 +72,118 @@ public sealed class BaseItemRepositoryGroupingTests : SqliteDbTestFixture
         Assert.Equal(firstId, item.Id);
     }
 
+    [Fact]
+    public void GetItemList_LibraryWithoutThePrimaryOfTheGroup_KeepsTheVersionVisible()
+    {
+        var primaryId = Guid.Parse("33333333-3333-3333-3333-333333333333");
+        var versionId = Guid.Parse("44444444-4444-4444-4444-444444444444");
+        var sameLibraryPrimaryId = Guid.Parse("55555555-5555-5555-5555-555555555555");
+        var sameLibraryVersionId = Guid.Parse("66666666-6666-6666-6666-666666666666");
+
+        SeedCrossLibraryGroup(primaryId, versionId, sameLibraryPrimaryId, sameLibraryVersionId);
+
+        var result = _repository.GetItemList(CreateLibraryQuery(_movieLibraryId));
+
+        // The version stands in for the group in the library it lives in, because its primary is in
+        // a library of its own; a group merged inside this library still collapses onto its primary.
+        Assert.Contains(result, i => i.Id.Equals(versionId));
+        Assert.Contains(result, i => i.Id.Equals(sameLibraryPrimaryId));
+        Assert.DoesNotContain(result, i => i.Id.Equals(sameLibraryVersionId));
+        Assert.DoesNotContain(result, i => i.Id.Equals(primaryId));
+    }
+
+    [Fact]
+    public void GetItemList_LibraryHoldingThePrimary_ReturnsThePrimary()
+    {
+        var primaryId = Guid.Parse("33333333-3333-3333-3333-333333333333");
+        var versionId = Guid.Parse("44444444-4444-4444-4444-444444444444");
+
+        SeedCrossLibraryGroup(primaryId, versionId);
+
+        var result = _repository.GetItemList(CreateLibraryQuery(_movie4KLibraryId));
+
+        var item = Assert.Single(result);
+        Assert.Equal(primaryId, item.Id);
+    }
+
+    [Fact]
+    public void GetItemList_BothLibrariesOfACrossLibraryGroup_ReturnsItOnce()
+    {
+        var primaryId = Guid.Parse("33333333-3333-3333-3333-333333333333");
+        var versionId = Guid.Parse("44444444-4444-4444-4444-444444444444");
+
+        SeedCrossLibraryGroup(primaryId, versionId);
+
+        var result = _repository.GetItemList(CreateLibraryQuery(_movieLibraryId, _movie4KLibraryId));
+
+        // With both libraries in scope the presentation key grouping collapses the version.
+        var item = Assert.Single(result);
+        Assert.Equal(primaryId, item.Id);
+    }
+
+    [Fact]
+    public void GetItems_LibraryWithoutThePrimaryOfTheGroup_CountsWhatItLists()
+    {
+        var primaryId = Guid.Parse("33333333-3333-3333-3333-333333333333");
+        var versionId = Guid.Parse("44444444-4444-4444-4444-444444444444");
+
+        SeedCrossLibraryGroup(primaryId, versionId);
+
+        var listed = _repository.GetItemList(CreateLibraryQuery(_movieLibraryId)).Count;
+
+        var query = CreateLibraryQuery(_movieLibraryId);
+        query.EnableTotalRecordCount = true;
+        query.Limit = 1;
+
+        // The total the client pages against has to agree with the listing.
+        Assert.Equal(1, listed);
+        Assert.Equal(listed, _repository.GetItems(query).TotalRecordCount);
+    }
+
+    private static InternalItemsQuery CreateLibraryQuery(params Guid[] topParentIds)
+    {
+        return new InternalItemsQuery(new Database.Implementations.Entities.User("test", "auth", "reset"))
+        {
+            IncludeItemTypes = [BaseItemKind.Movie],
+            TopParentIds = topParentIds
+        };
+    }
+
+    private void SeedCrossLibraryGroup(
+        Guid primaryId,
+        Guid versionId,
+        Guid? sameLibraryPrimaryId = null,
+        Guid? sameLibraryVersionId = null)
+    {
+        using var ctx = CreateDbContext();
+        ctx.BaseItems.Add(CreateFolderEntity(_movieLibraryId, "Movies"));
+        ctx.BaseItems.Add(CreateFolderEntity(_movie4KLibraryId, "Movies-4K"));
+
+        // The 4K version heads the group and lives in a library of its own.
+        ctx.BaseItems.Add(CreateMovieEntity(primaryId, "Movie - 4K", primaryId.ToString("N"), null, _movie4KLibraryId));
+        ctx.BaseItems.Add(CreateMovieEntity(versionId, "Movie", primaryId.ToString("N"), primaryId, _movieLibraryId));
+
+        if (sameLibraryPrimaryId.HasValue && sameLibraryVersionId.HasValue)
+        {
+            ctx.BaseItems.Add(CreateMovieEntity(sameLibraryPrimaryId.Value, "Other - 4K", sameLibraryPrimaryId.Value.ToString("N"), null, _movieLibraryId));
+            ctx.BaseItems.Add(CreateMovieEntity(sameLibraryVersionId.Value, "Other", sameLibraryPrimaryId.Value.ToString("N"), sameLibraryPrimaryId.Value, _movieLibraryId));
+        }
+
+        ctx.SaveChanges();
+    }
+
+    private BaseItemEntity CreateFolderEntity(Guid id, string name)
+    {
+        return new BaseItemEntity
+        {
+            Id = id,
+            Type = _folderTypeName,
+            Name = name,
+            Path = "/" + name,
+            IsFolder = true
+        };
+    }
+
     private static InternalItemsQuery CreateQuery()
     {
         // IncludeOwnedItems keeps the alternate version rows in the query so the
@@ -78,13 +195,15 @@ public sealed class BaseItemRepositoryGroupingTests : SqliteDbTestFixture
         };
     }
 
-    private BaseItemEntity CreateMovieEntity(Guid id, string name, string presentationKey, Guid? primaryVersionId)
+    private BaseItemEntity CreateMovieEntity(Guid id, string name, string presentationKey, Guid? primaryVersionId, Guid? libraryId = null)
     {
         return new BaseItemEntity
         {
             Id = id,
             Type = _movieTypeName,
             Name = name,
+            ParentId = libraryId,
+            TopParentId = libraryId,
             PresentationUniqueKey = presentationKey,
             PrimaryVersionId = primaryVersionId,
             MediaType = "Video",
diff --git a/tests/Jellyfin.Server.Implementations.Tests/Item/ItemPersistenceAlternateVersionTests.cs b/tests/Jellyfin.Server.Implementations.Tests/Item/ItemPersistenceAlternateVersionTests.cs
new file mode 100644
index 0000000000..c15ea09965
--- /dev/null
+++ b/tests/Jellyfin.Server.Implementations.Tests/Item/ItemPersistenceAlternateVersionTests.cs
@@ -0,0 +1,191 @@
+using System;
+using System.Globalization;
+using System.Linq;
+using System.Threading;
+using Jellyfin.Server.Implementations.Item;
+using MediaBrowser.Controller;
+using MediaBrowser.Controller.Configuration;
+using MediaBrowser.Controller.Entities;
+using MediaBrowser.Controller.Entities.Movies;
+using MediaBrowser.Controller.Library;
+using MediaBrowser.Controller.LiveTv;
+using MediaBrowser.Model.Configuration;
+using Microsoft.Extensions.Logging.Abstractions;
+using Moq;
+using Xunit;
+using DbLinkedChildType = Jellyfin.Database.Implementations.Entities.LinkedChildType;
+
+namespace Jellyfin.Server.Implementations.Tests.Item;
+
+/// <summary>
+/// Covers the invariant that a video linked as an alternate version also carries the
+/// PrimaryVersionId the item queries hide it by, including when it was already a library
+/// item in its own right before it became a version.
+/// </summary>
+public sealed class ItemPersistenceAlternateVersionTests : SqliteDbTestFixture
+{
+    private const string PrimaryPath = "/movies/Movie/Movie - 4K.mkv";
+    private const string VersionPath = "/movies/Movie/Movie - 1080p.mkv";
+
+    private readonly ItemPersistenceService _service;
+    private readonly ILibraryManager? _previousLibraryManager;
+    private readonly IServerConfigurationManager? _previousConfigurationManager;
+    private readonly IRecordingsManager? _previousRecordingsManager;
+
+    public ItemPersistenceAlternateVersionTests()
+    {
+        // BaseItem resolves these through process-wide statics; restored in Dispose.
+        _previousLibraryManager = BaseItem.LibraryManager;
+        _previousConfigurationManager = BaseItem.ConfigurationManager;
+        _previousRecordingsManager = Video.RecordingsManager;
+
+        var libraryManager = new Mock<ILibraryManager>();
+        libraryManager.Setup(l => l.GetCollectionFolders(It.IsAny<BaseItem>()))
+            .Returns([]);
+        BaseItem.LibraryManager = libraryManager.Object;
+
+        var configurationManager = new Mock<IServerConfigurationManager>();
+        configurationManager.Setup(c => c.Configuration).Returns(new ServerConfiguration());
+        BaseItem.ConfigurationManager = configurationManager.Object;
+
+        // Video.SourceType asks this whether the file is an in-progress recording.
+        Video.RecordingsManager = new Mock<IRecordingsManager>().Object;
+
+        // Paths round-trip through the host's virtual path mapping on the way in and out.
+        var appHost = new Mock<IServerApplicationHost>();
+        appHost.Setup(h => h.ReverseVirtualPath(It.IsAny<string>())).Returns((string p) => p);
+        appHost.Setup(h => h.ExpandVirtualPath(It.IsAny<string>())).Returns((string p) => p);
+
+        _service = new ItemPersistenceService(
+            CreateDbContextFactory(),
+            appHost.Object,
+            NullLogger<ItemPersistenceService>.Instance);
+    }
+
+    protected override void Dispose(bool disposing)
+    {
+        BaseItem.LibraryManager = _previousLibraryManager!;
+        BaseItem.ConfigurationManager = _previousConfigurationManager!;
+        Video.RecordingsManager = _previousRecordingsManager!;
+        base.Dispose(disposing);
+    }
+
+    [Fact]
+    public void SaveItems_LocalAlternateVersionAlreadyAnItem_SetsPrimaryVersionId()
+    {
+        var primaryId = Guid.Parse("aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa");
+        var versionId = Guid.Parse("bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb");
+
+        // The version was scanned as a standalone movie before it became a version, so it has a
+        // presentation key of its own and no PrimaryVersionId.
+        var version = CreateMovie(versionId, VersionPath);
+        version.PresentationUniqueKey = "standalone";
+        _service.SaveItems([version], CancellationToken.None);
+
+        using (var ctx = CreateDbContext())
+        {
+            Assert.Null(ctx.BaseItems.First(e => e.Id.Equals(versionId)).PrimaryVersionId);
+        }
+
+        // Now the scan folds it into a primary, which is the item that gets saved.
+        var primary = CreateMovie(primaryId, PrimaryPath);
+        primary.LocalAlternateVersions = [VersionPath];
+        _service.SaveItems([primary], CancellationToken.None);
+
+        using (var ctx = CreateDbContext())
+        {
+            var link = Assert.Single(ctx.LinkedChildren.Where(e => e.ParentId.Equals(primaryId)));
+            Assert.Equal(DbLinkedChildType.LocalAlternateVersion, link.ChildType);
+            Assert.Equal(versionId, link.ChildId);
+
+            var stored = ctx.BaseItems.First(e => e.Id.Equals(versionId));
+            Assert.Equal(primaryId, stored.PrimaryVersionId);
+
+            // Presentation-key grouping has to collapse it onto the primary as well.
+            Assert.Equal(primaryId.ToString("N", CultureInfo.InvariantCulture), stored.PresentationUniqueKey);
+        }
+    }
+
+    [Fact]
+    public void SaveItems_LinkedAlternateVersionAlreadyAnItem_SetsPrimaryVersionId()
+    {
+        var primaryId = Guid.Parse("cccccccc-cccc-cccc-cccc-cccccccccccc");
+        var versionId = Guid.Parse("dddddddd-dddd-dddd-dddd-dddddddddddd");
+
+        _service.SaveItems([CreateMovie(versionId, VersionPath)], CancellationToken.None);
+
+        var primary = CreateMovie(primaryId, PrimaryPath);
+        primary.LinkedAlternateVersions =
+        [
+            new LinkedChild { ItemId = versionId, Type = LinkedChildType.LinkedAlternateVersion }
+        ];
+        _service.SaveItems([primary], CancellationToken.None);
+
+        using var ctx = CreateDbContext();
+        var link = Assert.Single(ctx.LinkedChildren.Where(e => e.ParentId.Equals(primaryId)));
+        Assert.Equal(DbLinkedChildType.LinkedAlternateVersion, link.ChildType);
+        Assert.Equal(primaryId, ctx.BaseItems.First(e => e.Id.Equals(versionId)).PrimaryVersionId);
+    }
+
+    [Fact]
+    public void SaveItems_VersionAlreadyPointingAtPrimary_LeavesItAlone()
+    {
+        var primaryId = Guid.Parse("eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee");
+        var versionId = Guid.Parse("ffffffff-ffff-ffff-ffff-ffffffffffff");
+
+        var version = CreateMovie(versionId, VersionPath);
+        version.SetPrimaryVersionId(primaryId);
+        _service.SaveItems([version], CancellationToken.None);
+
+        var primary = CreateMovie(primaryId, PrimaryPath);
+        primary.LocalAlternateVersions = [VersionPath];
+        _service.SaveItems([primary], CancellationToken.None);
+
+        using var ctx = CreateDbContext();
+        var stored = ctx.BaseItems.First(e => e.Id.Equals(versionId));
+        Assert.Equal(primaryId, stored.PrimaryVersionId);
+        Assert.Equal(primaryId.ToString("N", CultureInfo.InvariantCulture), stored.PresentationUniqueKey);
+    }
+
+    [Fact]
+    public void SaveItems_VideoListedAmongItsOwnVersions_KeepsItsOwnPrimaryVersionId()
+    {
+        var primaryId = Guid.Parse("11111111-1111-1111-1111-111111111111");
+
+        var primary = CreateMovie(primaryId, PrimaryPath);
+        primary.LocalAlternateVersions = [PrimaryPath];
+        _service.SaveItems([primary], CancellationToken.None);
+
+        using var ctx = CreateDbContext();
+        Assert.Null(ctx.BaseItems.First(e => e.Id.Equals(primaryId)).PrimaryVersionId);
+    }
+
+    [Fact]
+    public void SaveItems_PromotedVersionStillPointingAtOldPrimary_DoesNotCreateACycle()
+    {
+        var promotedId = Guid.Parse("22222222-2222-2222-2222-222222222222");
+        var oldPrimaryId = Guid.Parse("33333333-3333-3333-3333-333333333333");
+
+        _service.SaveItems([CreateMovie(oldPrimaryId, VersionPath)], CancellationToken.None);
+
+        // The rescan resolves this one as the primary of the group, but it still carries the pointer
+        // to the version it was promoted over.
+        var promoted = CreateMovie(promotedId, PrimaryPath);
+        promoted.SetPrimaryVersionId(oldPrimaryId);
+        promoted.LocalAlternateVersions = [VersionPath];
+        _service.SaveItems([promoted], CancellationToken.None);
+
+        using var ctx = CreateDbContext();
+
+        // Pointing the old primary back would hide both, and with them the whole group.
+        Assert.Null(ctx.BaseItems.First(e => e.Id.Equals(oldPrimaryId)).PrimaryVersionId);
+        Assert.Equal(oldPrimaryId, ctx.BaseItems.First(e => e.Id.Equals(promotedId)).PrimaryVersionId);
+    }
+
+    private static Movie CreateMovie(Guid id, string path) => new()
+    {
+        Id = id,
+        Name = "Movie",
+        Path = path
+    };
+}