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

Fix transcoding settings migration failure caused by null EncoderPreset

Original-merge: 3e27c7ef7f7ec20199bd0493cd8eba42390b22a7

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

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

1 files changed, 118 insertions, 0 deletions

diff --git a/tests/Jellyfin.Server.Tests/Migrations/FixNullEncoderPresetTests.cs b/tests/Jellyfin.Server.Tests/Migrations/FixNullEncoderPresetTests.cs
new file mode 100644
index 0000000000..a6ebc82425
--- /dev/null
+++ b/tests/Jellyfin.Server.Tests/Migrations/FixNullEncoderPresetTests.cs
@@ -0,0 +1,118 @@
+using System;
+using System.IO;
+using System.Threading.Tasks;
+using System.Xml.Serialization;
+using Emby.Server.Implementations;
+using Jellyfin.Server.Migrations.PreStartupRoutines;
+using Jellyfin.Server.Migrations.Routines;
+using MediaBrowser.Common.Configuration;
+using MediaBrowser.Model.Configuration;
+using MediaBrowser.Model.Entities;
+using Microsoft.Extensions.Logging.Abstractions;
+using Moq;
+using Xunit;
+
+namespace Jellyfin.Server.Tests.Migrations;
+
+public sealed class FixNullEncoderPresetTests : IDisposable
+{
+    private readonly string _configurationDirectory;
+    private readonly string _encodingConfigurationPath;
+    private readonly FixNullEncoderPreset _migration;
+
+    public FixNullEncoderPresetTests()
+    {
+        _configurationDirectory = Directory.CreateTempSubdirectory("jellyfin-migration-test-").FullName;
+        _encodingConfigurationPath = Path.Combine(_configurationDirectory, "encoding.xml");
+
+        var applicationPaths = new Mock<IApplicationPaths>();
+        applicationPaths.SetupGet(paths => paths.ConfigurationDirectoryPath).Returns(_configurationDirectory);
+        _migration = new FixNullEncoderPreset(applicationPaths.Object, NullLogger<FixNullEncoderPreset>.Instance);
+    }
+
+    [Fact]
+    public async Task PerformAsync_ReplacesNullEncoderPresetWithAuto()
+    {
+        const string Configuration = """
+            <?xml version="1.0" encoding="utf-8"?>
+            <EncodingOptions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+              <HardwareAccelerationType>qsv</HardwareAccelerationType>
+              <EncoderPreset xsi:nil="true" />
+              <EnableHardwareEncoding>true</EnableHardwareEncoding>
+            </EncodingOptions>
+            """;
+        await File.WriteAllTextAsync(_encodingConfigurationPath, Configuration, TestContext.Current.CancellationToken);
+
+        await _migration.PerformAsync(TestContext.Current.CancellationToken);
+
+        var serializer = new XmlSerializer(typeof(EncodingOptions));
+        using var reader = File.OpenRead(_encodingConfigurationPath);
+        var encodingOptions = Assert.IsType<EncodingOptions>(serializer.Deserialize(reader));
+        Assert.Equal(EncoderPreset.auto, encodingOptions.EncoderPreset);
+        Assert.Equal(HardwareAccelerationType.qsv, encodingOptions.HardwareAccelerationType);
+        Assert.True(encodingOptions.EnableHardwareEncoding);
+    }
+
+    [Fact]
+    public async Task PerformAsync_LeavesValidEncoderPresetUnchanged()
+    {
+        const string Configuration = """
+            <?xml version="1.0" encoding="utf-8"?>
+            <EncodingOptions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+              <EncoderPreset>fast</EncoderPreset>
+            </EncodingOptions>
+            """;
+        await File.WriteAllTextAsync(_encodingConfigurationPath, Configuration, TestContext.Current.CancellationToken);
+
+        await _migration.PerformAsync(TestContext.Current.CancellationToken);
+
+        Assert.Equal(Configuration, await File.ReadAllTextAsync(_encodingConfigurationPath, TestContext.Current.CancellationToken));
+    }
+
+    [Fact]
+    public async Task PerformAsync_LeavesMalformedConfigurationUnchanged()
+    {
+        const string Configuration = "<EncodingOptions><EncoderPreset xsi:nil=\"true\" />";
+        await File.WriteAllTextAsync(_encodingConfigurationPath, Configuration, TestContext.Current.CancellationToken);
+
+        await _migration.PerformAsync(TestContext.Current.CancellationToken);
+
+        Assert.Equal(Configuration, await File.ReadAllTextAsync(_encodingConfigurationPath, TestContext.Current.CancellationToken));
+    }
+
+    [Fact]
+    public async Task MigrateEncodingOptions_UsesAutoForNullEncoderPreset()
+    {
+        const string Configuration = """
+            <?xml version="1.0" encoding="utf-8"?>
+            <EncodingOptions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+              <HardwareAccelerationType>qsv</HardwareAccelerationType>
+              <TonemappingRange>tv</TonemappingRange>
+              <EncoderPreset xsi:nil="true" />
+              <EnableHardwareEncoding>true</EnableHardwareEncoding>
+            </EncodingOptions>
+            """;
+        await File.WriteAllTextAsync(_encodingConfigurationPath, Configuration, TestContext.Current.CancellationToken);
+        var applicationPaths = new ServerApplicationPaths(
+            _configurationDirectory,
+            _configurationDirectory,
+            _configurationDirectory,
+            _configurationDirectory,
+            _configurationDirectory);
+
+        var migration = new MigrateEncodingOptions(applicationPaths, NullLoggerFactory.Instance);
+        migration.Perform();
+
+        var serializer = new XmlSerializer(typeof(EncodingOptions));
+        using var reader = File.OpenRead(_encodingConfigurationPath);
+        var encodingOptions = Assert.IsType<EncodingOptions>(serializer.Deserialize(reader));
+        Assert.Equal(EncoderPreset.auto, encodingOptions.EncoderPreset);
+        Assert.Equal(HardwareAccelerationType.qsv, encodingOptions.HardwareAccelerationType);
+        Assert.True(encodingOptions.EnableHardwareEncoding);
+    }
+
+    public void Dispose()
+    {
+        Directory.Delete(_configurationDirectory, true);
+    }
+}