aboutsummaryrefslogtreecommitdiff
path: root/tests/Jellyfin.Server.Implementations.Tests/Item/BaseItemRepositoryByNameTotalCountTests.cs
blob: f675621e2109d5ae23313bcb19c468a8d17f34e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
using System;
using System.Linq;
using Emby.Server.Implementations.Data;
using Jellyfin.Database.Implementations;
using Jellyfin.Database.Implementations.Entities;
using Jellyfin.Database.Implementations.Locking;
using Jellyfin.Database.Providers.Sqlite;
using Jellyfin.Server.Implementations.Item;
using MediaBrowser.Controller;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Model.Configuration;
using Microsoft.Data.Sqlite;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Logging.Abstractions;
using Moq;
using Xunit;
using BaseItemKind = Jellyfin.Data.Enums.BaseItemKind;

namespace Jellyfin.Server.Implementations.Tests.Item;

/// <summary>
/// The by-name endpoints (artists, album artists, genres, studios) all funnel through
/// <c>GetItemValues</c>. A query without a <c>Limit</c> used to have its total record count
/// silently disabled, so callers got a populated <c>Items</c> array next to a zero total.
/// </summary>
public sealed class BaseItemRepositoryByNameTotalCountTests : IDisposable
{
    private readonly SqliteConnection _connection;
    private readonly DbContextOptions<JellyfinDbContext> _dbOptions;
    private readonly BaseItemRepository _repository;
    private readonly ItemTypeLookup _itemTypeLookup;

    public BaseItemRepositoryByNameTotalCountTests()
    {
        _connection = new SqliteConnection("Data Source=:memory:");
        _connection.Open();

        _dbOptions = new DbContextOptionsBuilder<JellyfinDbContext>()
            .UseSqlite(_connection)
            .Options;

        using (var ctx = CreateDbContext())
        {
            ctx.Database.EnsureCreated();
        }

        var factory = new Mock<IDbContextFactory<JellyfinDbContext>>();
        factory.Setup(f => f.CreateDbContext()).Returns(CreateDbContext);

        _itemTypeLookup = new ItemTypeLookup();

        var serverConfigurationManager = new Mock<IServerConfigurationManager>();
        serverConfigurationManager.Setup(c => c.Configuration).Returns(new ServerConfiguration());

        _repository = new BaseItemRepository(
            factory.Object,
            new Mock<IServerApplicationHost>().Object,
            _itemTypeLookup,
            serverConfigurationManager.Object,
            NullLogger<BaseItemRepository>.Instance);
    }

    public void Dispose()
    {
        _connection.Dispose();
    }

    [Fact]
    public void GetArtists_WithoutLimit_ReportsTotalRecordCount()
    {
        SeedArtists(3);

        var result = _repository.GetArtists(CreateQuery(limit: null));

        Assert.Equal(3, result.Items.Count);
        Assert.Equal(3, result.TotalRecordCount);
    }

    [Fact]
    public void GetArtists_WithLimit_ReportsTotalBeyondThePage()
    {
        SeedArtists(3);

        var result = _repository.GetArtists(CreateQuery(limit: 2));

        Assert.Equal(2, result.Items.Count);
        Assert.Equal(3, result.TotalRecordCount);
    }

    [Fact]
    public void GetArtists_TotalRecordCountDisabled_StaysZero()
    {
        SeedArtists(3);

        var query = CreateQuery(limit: null);
        query.EnableTotalRecordCount = false;

        var result = _repository.GetArtists(query);

        Assert.Equal(3, result.Items.Count);
        Assert.Equal(0, result.TotalRecordCount);
    }

    [Fact]
    public void GetArtists_WithoutLimit_DoesNotMutateCallerQuery()
    {
        SeedArtists(1);

        var query = CreateQuery(limit: null);
        Assert.True(query.EnableTotalRecordCount);

        _repository.GetArtists(query);

        // The repository used to flip this flag on the caller's own query object, so a
        // reused query silently lost its total on every subsequent call.
        Assert.True(query.EnableTotalRecordCount);
    }

    private static InternalItemsQuery CreateQuery(int? limit)
    {
        return new InternalItemsQuery(new User("test", "auth", "reset"))
        {
            Limit = limit
        };
    }

    /// <summary>
    /// Creates <paramref name="count"/> artists, each credited on one song, which is what
    /// makes them visible to the item-value join behind the by-name endpoints.
    /// </summary>
    private void SeedArtists(int count)
    {
        using var ctx = CreateDbContext();

        for (var i = 0; i < count; i++)
        {
            var name = $"Artist {i}";
            var cleanName = name.ToLowerInvariant();

            var artistId = Guid.Parse($"aaaaaaaa-0000-0000-0000-{i:D12}");
            var songId = Guid.Parse($"55555555-0000-0000-0000-{i:D12}");
            var valueId = Guid.Parse($"cccccccc-0000-0000-0000-{i:D12}");

            var artist = new BaseItemEntity
            {
                Id = artistId,
                Type = _itemTypeLookup.BaseItemKindNames[BaseItemKind.MusicArtist],
                Name = name,
                CleanName = cleanName,
                PresentationUniqueKey = artistId.ToString("N"),
                IsFolder = true,
                IsVirtualItem = false
            };

            var song = new BaseItemEntity
            {
                Id = songId,
                Type = _itemTypeLookup.BaseItemKindNames[BaseItemKind.Audio],
                Name = $"Song {i}",
                CleanName = $"song {i}",
                PresentationUniqueKey = songId.ToString("N"),
                MediaType = "Audio",
                IsFolder = false,
                IsVirtualItem = false
            };

            var itemValue = new ItemValue
            {
                ItemValueId = valueId,
                Type = ItemValueType.Artist,
                Value = name,
                CleanValue = cleanName
            };

            ctx.BaseItems.Add(artist);
            ctx.BaseItems.Add(song);
            ctx.ItemValues.Add(itemValue);
            ctx.ItemValuesMap.Add(new ItemValueMap
            {
                ItemId = songId,
                ItemValueId = valueId,
                Item = song,
                ItemValue = itemValue
            });
        }

        ctx.SaveChanges();
    }

    private JellyfinDbContext CreateDbContext()
    {
        return new JellyfinDbContext(
            _dbOptions,
            NullLogger<JellyfinDbContext>.Instance,
            new SqliteDatabaseProvider(null!, NullLogger<SqliteDatabaseProvider>.Instance),
            new NoLockBehavior(NullLogger<NoLockBehavior>.Instance));
    }
}