diff options
| author | Bond-009 <bond.009@outlook.com> | 2026-11-12 19:28:58 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-11-12 19:28:58 +0100 |
| commit | 4ac3c8f357113d0c850ff9b3d6d201377b96afd3 (patch) | |
| tree | 9fac607473c498898038cfa2ee8d062df1aca75e | |
| parent | ca65685f91d45519a76c91878aa30f03e7369d6d (diff) | |
| parent | ee3a982374c0df337af5b78e0e6eef95f47d551b (diff) | |
Merge pull request #17811 from Shadowghost/port-async-migration-routines
Migrate to IAsyncMigrationRoutine
34 files changed, 264 insertions, 177 deletions
diff --git a/Jellyfin.Server/Migrations/IAsyncMigrationRoutine.cs b/Jellyfin.Server/Migrations/IAsyncMigrationRoutine.cs index 5b6a5fe942..a40b831cf2 100644 --- a/Jellyfin.Server/Migrations/IAsyncMigrationRoutine.cs +++ b/Jellyfin.Server/Migrations/IAsyncMigrationRoutine.cs @@ -1,4 +1,3 @@ -using System; using System.Threading; using System.Threading.Tasks; @@ -16,16 +15,3 @@ internal interface IAsyncMigrationRoutine /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns> public Task PerformAsync(CancellationToken cancellationToken); } - -/// <summary> -/// Interface that describes a migration routine. -/// </summary> -[Obsolete("Use IAsyncMigrationRoutine instead")] -internal interface IMigrationRoutine -{ - /// <summary> - /// Execute the migration routine. - /// </summary> - [Obsolete("Use IAsyncMigrationRoutine.PerformAsync instead")] - public void Perform(); -} diff --git a/Jellyfin.Server/Migrations/IDatabaseMigrationRoutine.cs b/Jellyfin.Server/Migrations/IDatabaseMigrationRoutine.cs index d2d80a81eb..a794708764 100644 --- a/Jellyfin.Server/Migrations/IDatabaseMigrationRoutine.cs +++ b/Jellyfin.Server/Migrations/IDatabaseMigrationRoutine.cs @@ -7,8 +7,6 @@ namespace Jellyfin.Server.Migrations; /// <summary> /// Defines a migration that operates on the Database. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete -internal interface IDatabaseMigrationRoutine : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +internal interface IDatabaseMigrationRoutine : IAsyncMigrationRoutine { } diff --git a/Jellyfin.Server/Migrations/JellyfinMigrationAttribute.cs b/Jellyfin.Server/Migrations/JellyfinMigrationAttribute.cs index 70e54125b8..f07693c8e0 100644 --- a/Jellyfin.Server/Migrations/JellyfinMigrationAttribute.cs +++ b/Jellyfin.Server/Migrations/JellyfinMigrationAttribute.cs @@ -17,9 +17,7 @@ public sealed class JellyfinMigrationAttribute : Attribute /// </summary> /// <param name="order">The ordering this migration should be applied to. Must be a valid DateTime ISO8601 formatted string.</param> /// <param name="name">The name of this Migration.</param> -#pragma warning disable CS0618 // Type or member is obsolete public JellyfinMigrationAttribute(string order, string name) : this(order, name, null) -#pragma warning restore CS0618 // Type or member is obsolete { } @@ -29,7 +27,6 @@ public sealed class JellyfinMigrationAttribute : Attribute /// <param name="order">The ordering this migration should be applied to. Must be a valid DateTime ISO8601 formatted string.</param> /// <param name="name">The name of this Migration.</param> /// <param name="key">[ONLY FOR LEGACY MIGRATIONS]The unique key of this migration. Must be a valid Guid formatted string.</param> - [Obsolete("This Constructor should only be used for Legacy migrations. Use the (Order,Name) one for all new ones instead.")] public JellyfinMigrationAttribute(string order, string name, string? key) { Order = DateTime.Parse(order, CultureInfo.InvariantCulture); diff --git a/Jellyfin.Server/Migrations/JellyfinMigrationService.cs b/Jellyfin.Server/Migrations/JellyfinMigrationService.cs index 21ffab8dd6..0722409c53 100644 --- a/Jellyfin.Server/Migrations/JellyfinMigrationService.cs +++ b/Jellyfin.Server/Migrations/JellyfinMigrationService.cs @@ -59,8 +59,7 @@ internal class JellyfinMigrationService _backupService = backupService; _jellyfinDatabaseProvider = jellyfinDatabaseProvider; _applicationPaths = applicationPaths; -#pragma warning disable CS0618 // Type or member is obsolete - Migrations = [.. typeof(IMigrationRoutine).Assembly.GetTypes().Where(e => typeof(IMigrationRoutine).IsAssignableFrom(e) || typeof(IAsyncMigrationRoutine).IsAssignableFrom(e)) + Migrations = [.. typeof(IAsyncMigrationRoutine).Assembly.GetTypes().Where(e => typeof(IAsyncMigrationRoutine).IsAssignableFrom(e)) .Select(e => (Type: e, Metadata: e.GetCustomAttribute<JellyfinMigrationAttribute>(), Backup: e.GetCustomAttributes<JellyfinMigrationBackupAttribute>())) .Where(e => e.Metadata is not null) .GroupBy(e => e.Metadata!.Stage) @@ -80,7 +79,6 @@ internal class JellyfinMigrationService return stage; })]; -#pragma warning restore CS0618 // Type or member is obsolete } private interface IInternalMigration diff --git a/Jellyfin.Server/Migrations/PreStartupRoutines/CreateNetworkConfiguration.cs b/Jellyfin.Server/Migrations/PreStartupRoutines/CreateNetworkConfiguration.cs index fd472cff7c..87cbe0477c 100644 --- a/Jellyfin.Server/Migrations/PreStartupRoutines/CreateNetworkConfiguration.cs +++ b/Jellyfin.Server/Migrations/PreStartupRoutines/CreateNetworkConfiguration.cs @@ -1,5 +1,7 @@ using System; using System.IO; +using System.Threading; +using System.Threading.Tasks; using System.Xml; using System.Xml.Serialization; using Emby.Server.Implementations; @@ -8,10 +10,8 @@ using Microsoft.Extensions.Logging; namespace Jellyfin.Server.Migrations.PreStartupRoutines; /// <inheritdoc /> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T00:00:00", nameof(CreateNetworkConfiguration), "9B354818-94D5-4B68-AC49-E35CB85F9D84", Stage = Stages.JellyfinMigrationStageTypes.PreInitialisation)] -public class CreateNetworkConfiguration : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +public class CreateNetworkConfiguration : IAsyncMigrationRoutine { private readonly ServerApplicationPaths _applicationPaths; private readonly ILogger<CreateNetworkConfiguration> _logger; @@ -28,13 +28,13 @@ public class CreateNetworkConfiguration : IMigrationRoutine } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { string path = Path.Combine(_applicationPaths.ConfigurationDirectoryPath, "network.xml"); if (File.Exists(path)) { _logger.LogDebug("Network configuration file already exists, skipping"); - return; + return Task.CompletedTask; } var serverConfigSerializer = new XmlSerializer(typeof(OldNetworkConfiguration), new XmlRootAttribute("ServerConfiguration")); @@ -45,6 +45,8 @@ public class CreateNetworkConfiguration : IMigrationRoutine var xmlWriterSettings = new XmlWriterSettings { Indent = true }; using var xmlWriter = XmlWriter.Create(path, xmlWriterSettings); networkConfigSerializer.Serialize(xmlWriter, networkSettings); + + return Task.CompletedTask; } #pragma warning disable diff --git a/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateEncodingOptions.cs b/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateEncodingOptions.cs index a5006c9bfa..78b8697baf 100644 --- a/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateEncodingOptions.cs +++ b/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateEncodingOptions.cs @@ -1,5 +1,7 @@ using System; using System.IO; +using System.Threading; +using System.Threading.Tasks; using System.Xml; using System.Xml.Serialization; using Emby.Server.Implementations; @@ -10,10 +12,8 @@ using Microsoft.Extensions.Logging; namespace Jellyfin.Server.Migrations.PreStartupRoutines; /// <inheritdoc /> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T03:00:00", nameof(MigrateEncodingOptions), "A8E61960-7726-4450-8F3D-82C12DAABBCB", Stage = Stages.JellyfinMigrationStageTypes.PreInitialisation)] -public class MigrateEncodingOptions : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +public class MigrateEncodingOptions : IAsyncMigrationRoutine { private readonly ServerApplicationPaths _applicationPaths; private readonly ILogger<MigrateEncodingOptions> _logger; @@ -30,7 +30,7 @@ public class MigrateEncodingOptions : IMigrationRoutine } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { string path = Path.Combine(_applicationPaths.ConfigurationDirectoryPath, "encoding.xml"); var oldSerializer = new XmlSerializer(typeof(OldEncodingOptions), new XmlRootAttribute("EncodingOptions")); @@ -52,7 +52,7 @@ public class MigrateEncodingOptions : IMigrationRoutine if (oldConfig is null) { - return; + return Task.CompletedTask; } var hardwareAccelerationType = HardwareAccelerationType.none; @@ -143,6 +143,8 @@ public class MigrateEncodingOptions : IMigrationRoutine var xmlWriterSettings = new XmlWriterSettings { Indent = true }; using var xmlWriter = XmlWriter.Create(path, xmlWriterSettings); newSerializer.Serialize(xmlWriter, encodingOptions); + + return Task.CompletedTask; } #pragma warning disable diff --git a/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateMusicBrainzTimeout.cs b/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateMusicBrainzTimeout.cs index e8da9f515d..3eb26b8689 100644 --- a/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateMusicBrainzTimeout.cs +++ b/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateMusicBrainzTimeout.cs @@ -1,5 +1,7 @@ using System; using System.IO; +using System.Threading; +using System.Threading.Tasks; using System.Xml; using System.Xml.Serialization; using Emby.Server.Implementations; @@ -9,10 +11,8 @@ using Microsoft.Extensions.Logging; namespace Jellyfin.Server.Migrations.PreStartupRoutines; /// <inheritdoc /> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T02:00:00", nameof(MigrateMusicBrainzTimeout), "A6DCACF4-C057-4Ef9-80D3-61CEF9DDB4F0", Stage = Stages.JellyfinMigrationStageTypes.PreInitialisation)] -public class MigrateMusicBrainzTimeout : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +public class MigrateMusicBrainzTimeout : IAsyncMigrationRoutine { private readonly ServerApplicationPaths _applicationPaths; private readonly ILogger<MigrateMusicBrainzTimeout> _logger; @@ -29,13 +29,13 @@ public class MigrateMusicBrainzTimeout : IMigrationRoutine } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { string path = Path.Combine(_applicationPaths.PluginConfigurationsPath, "Jellyfin.Plugin.MusicBrainz.xml"); if (!File.Exists(path)) { _logger.LogDebug("No MusicBrainz plugin configuration file found, skipping"); - return; + return Task.CompletedTask; } var oldPluginConfiguration = ReadOld(path); @@ -51,6 +51,8 @@ public class MigrateMusicBrainzTimeout : IMigrationRoutine newPluginConfiguration.RateLimit = newRateLimit < 1.0 ? 1.0 : newRateLimit; WriteNew(path, newPluginConfiguration); } + + return Task.CompletedTask; } private OldMusicBrainzConfiguration? ReadOld(string path) diff --git a/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateNetworkConfiguration.cs b/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateNetworkConfiguration.cs index f2790c1a1f..e409b78130 100644 --- a/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateNetworkConfiguration.cs +++ b/Jellyfin.Server/Migrations/PreStartupRoutines/MigrateNetworkConfiguration.cs @@ -2,6 +2,8 @@ using System; using System.IO; +using System.Threading; +using System.Threading.Tasks; using System.Xml; using System.Xml.Serialization; using Emby.Server.Implementations; @@ -12,7 +14,7 @@ namespace Jellyfin.Server.Migrations.PreStartupRoutines; /// <inheritdoc /> [JellyfinMigration("2025-04-20T01:00:00", nameof(MigrateNetworkConfiguration), "4FB5C950-1991-11EE-9B4B-0800200C9A66", Stage = Stages.JellyfinMigrationStageTypes.PreInitialisation)] -public class MigrateNetworkConfiguration : IMigrationRoutine +public class MigrateNetworkConfiguration : IAsyncMigrationRoutine { private readonly ServerApplicationPaths _applicationPaths; private readonly ILogger<MigrateNetworkConfiguration> _logger; @@ -29,7 +31,7 @@ public class MigrateNetworkConfiguration : IMigrationRoutine } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { string path = Path.Combine(_applicationPaths.ConfigurationDirectoryPath, "network.xml"); var oldNetworkConfigSerializer = new XmlSerializer(typeof(OldNetworkConfiguration), new XmlRootAttribute("NetworkConfiguration")); @@ -51,7 +53,7 @@ public class MigrateNetworkConfiguration : IMigrationRoutine if (oldNetworkConfiguration is null) { - return; + return Task.CompletedTask; } // Migrate network config values to new config schema @@ -96,6 +98,8 @@ public class MigrateNetworkConfiguration : IMigrationRoutine var xmlWriterSettings = new XmlWriterSettings { Indent = true }; using var xmlWriter = XmlWriter.Create(path, xmlWriterSettings); networkConfigSerializer.Serialize(xmlWriter, networkConfiguration); + + return Task.CompletedTask; } #pragma warning disable diff --git a/Jellyfin.Server/Migrations/PreStartupRoutines/RenameEnableGroupingIntoCollections.cs b/Jellyfin.Server/Migrations/PreStartupRoutines/RenameEnableGroupingIntoCollections.cs index 995b2bbf9b..a33bd4004b 100644 --- a/Jellyfin.Server/Migrations/PreStartupRoutines/RenameEnableGroupingIntoCollections.cs +++ b/Jellyfin.Server/Migrations/PreStartupRoutines/RenameEnableGroupingIntoCollections.cs @@ -2,6 +2,8 @@ using System; using System.IO; using System.Linq; using System.Text; +using System.Threading; +using System.Threading.Tasks; using System.Xml.Linq; using Emby.Server.Implementations; using Microsoft.Extensions.Logging; @@ -9,10 +11,8 @@ using Microsoft.Extensions.Logging; namespace Jellyfin.Server.Migrations.PreStartupRoutines; /// <inheritdoc /> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T04:00:00", nameof(RenameEnableGroupingIntoCollections), "E73B777D-CD5C-4E71-957A-B86B3660B7CF", Stage = Stages.JellyfinMigrationStageTypes.PreInitialisation)] -public class RenameEnableGroupingIntoCollections : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +public class RenameEnableGroupingIntoCollections : IAsyncMigrationRoutine { private readonly ServerApplicationPaths _applicationPaths; private readonly ILogger<RenameEnableGroupingIntoCollections> _logger; @@ -29,13 +29,13 @@ public class RenameEnableGroupingIntoCollections : IMigrationRoutine } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { string path = Path.Combine(_applicationPaths.ConfigurationDirectoryPath, "system.xml"); if (!File.Exists(path)) { _logger.LogWarning("Configuration file not found: {Path}", path); - return; + return Task.CompletedTask; } try @@ -53,5 +53,7 @@ public class RenameEnableGroupingIntoCollections : IMigrationRoutine { _logger.LogError(ex, "An error occurred while updating the XML file: {Message}", ex.Message); } + + return Task.CompletedTask; } } diff --git a/Jellyfin.Server/Migrations/Routines/20250420050000_DisableTranscodingThrottling.cs b/Jellyfin.Server/Migrations/Routines/20250420050000_DisableTranscodingThrottling.cs index acf2835fe0..4e0046f254 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420050000_DisableTranscodingThrottling.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420050000_DisableTranscodingThrottling.cs @@ -1,4 +1,6 @@ using System; +using System.Threading; +using System.Threading.Tasks; using MediaBrowser.Common.Configuration; using Microsoft.Extensions.Logging; @@ -7,10 +9,8 @@ namespace Jellyfin.Server.Migrations.Routines /// <summary> /// Disable transcode throttling for all installations since it is currently broken for certain video formats. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T05:00:00", nameof(DisableTranscodingThrottling), "4124C2CD-E939-4FFB-9BE9-9B311C413638")] - internal class DisableTranscodingThrottling : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete + internal class DisableTranscodingThrottling : IAsyncMigrationRoutine { private readonly ILogger<DisableTranscodingThrottling> _logger; private readonly IConfigurationManager _configManager; @@ -22,7 +22,7 @@ namespace Jellyfin.Server.Migrations.Routines } /// <inheritdoc/> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { // Set EnableThrottling to false since it wasn't used before and may introduce issues var encoding = _configManager.GetEncodingOptions(); @@ -33,6 +33,8 @@ namespace Jellyfin.Server.Migrations.Routines _configManager.SaveConfiguration("encoding", encoding); } + + return Task.CompletedTask; } } } diff --git a/Jellyfin.Server/Migrations/Routines/20250420060000_CreateUserLoggingConfigFile.cs b/Jellyfin.Server/Migrations/Routines/20250420060000_CreateUserLoggingConfigFile.cs index 1326a6dc8d..bfbc5a9dad 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420060000_CreateUserLoggingConfigFile.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420060000_CreateUserLoggingConfigFile.cs @@ -2,6 +2,8 @@ using System; using System.Collections.Generic; using System.IO; using System.Linq; +using System.Threading; +using System.Threading.Tasks; using MediaBrowser.Common.Configuration; using Newtonsoft.Json.Linq; @@ -12,10 +14,8 @@ namespace Jellyfin.Server.Migrations.Routines /// If the deprecated logging.json file exists and has a custom config, it will be used as logging.user.json, /// otherwise a blank file will be created. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T06:00:00", nameof(CreateUserLoggingConfigFile), "EF103419-8451-40D8-9F34-D1A8E93A1679")] - internal class CreateUserLoggingConfigFile : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete + internal class CreateUserLoggingConfigFile : IAsyncMigrationRoutine { /// <summary> /// File history for logging.json as existed during this migration creation. The contents for each has been minified. @@ -46,7 +46,7 @@ namespace Jellyfin.Server.Migrations.Routines } /// <inheritdoc/> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { var logDirectory = _appPaths.ConfigurationDirectoryPath; var existingConfigPath = Path.Combine(logDirectory, "logging.json"); @@ -57,6 +57,8 @@ namespace Jellyfin.Server.Migrations.Routines { File.Move(existingConfigPath, Path.Combine(logDirectory, "logging.old.json")); } + + return Task.CompletedTask; } /// <summary> diff --git a/Jellyfin.Server/Migrations/Routines/20250420070000_MigrateActivityLogDb.cs b/Jellyfin.Server/Migrations/Routines/20250420070000_MigrateActivityLogDb.cs index 8c8563190d..c4d4495201 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420070000_MigrateActivityLogDb.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420070000_MigrateActivityLogDb.cs @@ -1,6 +1,8 @@ using System; using System.Collections.Generic; using System.IO; +using System.Threading; +using System.Threading.Tasks; using Emby.Server.Implementations.Data; using Jellyfin.Database.Implementations; using Jellyfin.Database.Implementations.Entities; @@ -14,10 +16,8 @@ namespace Jellyfin.Server.Migrations.Routines /// <summary> /// The migration routine for migrating the activity log database to EF Core. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T07:00:00", nameof(MigrateActivityLogDb), "3793eb59-bc8c-456c-8b9f-bd5a62a42978")] - public class MigrateActivityLogDb : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete + public class MigrateActivityLogDb : IAsyncMigrationRoutine { private const string DbFilename = "activitylog.db"; @@ -38,8 +38,15 @@ namespace Jellyfin.Server.Migrations.Routines _paths = paths; } - /// <inheritdoc/> - public void Perform() + /// <inheritdoc /> + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { var logLevelDictionary = new Dictionary<string, LogLevel>(StringComparer.OrdinalIgnoreCase) { diff --git a/Jellyfin.Server/Migrations/Routines/20250420080000_RemoveDuplicateExtras.cs b/Jellyfin.Server/Migrations/Routines/20250420080000_RemoveDuplicateExtras.cs index c9e66d0cfe..3cc4c4f9ed 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420080000_RemoveDuplicateExtras.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420080000_RemoveDuplicateExtras.cs @@ -2,6 +2,8 @@ using System; using System.Globalization; using System.IO; using System.Linq; +using System.Threading; +using System.Threading.Tasks; using Emby.Server.Implementations.Data; using MediaBrowser.Controller; using Microsoft.Data.Sqlite; @@ -12,10 +14,8 @@ namespace Jellyfin.Server.Migrations.Routines; /// <summary> /// Remove duplicate entries which were caused by a bug where a file was considered to be an "Extra" to itself. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T08:00:00", nameof(RemoveDuplicateExtras), "ACBE17B7-8435-4A83-8B64-6FCF162CB9BD")] -internal class RemoveDuplicateExtras : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +internal class RemoveDuplicateExtras : IAsyncMigrationRoutine { private const string DbFilename = "library.db"; private readonly ILogger<RemoveDuplicateExtras> _logger; @@ -27,8 +27,15 @@ internal class RemoveDuplicateExtras : IMigrationRoutine _paths = paths; } - /// <inheritdoc/> - public void Perform() + /// <inheritdoc /> + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { var dataPath = _paths.DataPath; var dbPath = Path.Combine(dataPath, DbFilename); diff --git a/Jellyfin.Server/Migrations/Routines/20250420090000_AddDefaultPluginRepository.cs b/Jellyfin.Server/Migrations/Routines/20250420090000_AddDefaultPluginRepository.cs index 8c8398a161..c705f8513f 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420090000_AddDefaultPluginRepository.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420090000_AddDefaultPluginRepository.cs @@ -1,4 +1,6 @@ using System; +using System.Threading; +using System.Threading.Tasks; using MediaBrowser.Controller.Configuration; using MediaBrowser.Model.Updates; @@ -7,10 +9,8 @@ namespace Jellyfin.Server.Migrations.Routines /// <summary> /// Migration to initialize system configuration with the default plugin repository. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T09:00:00", nameof(AddDefaultPluginRepository), "EB58EBEE-9514-4B9B-8225-12E1A40020DF", RunMigrationOnSetup = true)] - public class AddDefaultPluginRepository : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete + public class AddDefaultPluginRepository : IAsyncMigrationRoutine { private readonly IServerConfigurationManager _serverConfigurationManager; @@ -30,10 +30,12 @@ namespace Jellyfin.Server.Migrations.Routines } /// <inheritdoc/> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { _serverConfigurationManager.Configuration.PluginRepositories = new[] { _defaultRepositoryInfo }; _serverConfigurationManager.SaveConfiguration(); + + return Task.CompletedTask; } } } diff --git a/Jellyfin.Server/Migrations/Routines/20250420100000_MigrateUserDb.cs b/Jellyfin.Server/Migrations/Routines/20250420100000_MigrateUserDb.cs index 8c3361ee16..f577a9d9fa 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420100000_MigrateUserDb.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420100000_MigrateUserDb.cs @@ -1,5 +1,7 @@ using System; using System.IO; +using System.Threading; +using System.Threading.Tasks; using Emby.Server.Implementations.Data; using Jellyfin.Data; using Jellyfin.Database.Implementations; @@ -22,10 +24,8 @@ namespace Jellyfin.Server.Migrations.Routines; /// <summary> /// The migration routine for migrating the user database to EF Core. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T10:00:00", nameof(MigrateUserDb), "5C4B82A2-F053-4009-BD05-B6FCAD82F14C")] -public class MigrateUserDb : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +public class MigrateUserDb : IAsyncMigrationRoutine { private const string DbFilename = "users.db"; @@ -53,8 +53,15 @@ public class MigrateUserDb : IMigrationRoutine _xmlSerializer = xmlSerializer; } - /// <inheritdoc/> - public void Perform() + /// <inheritdoc /> + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { var dataPath = _paths.DataPath; var userDbPath = Path.Combine(dataPath, DbFilename); diff --git a/Jellyfin.Server/Migrations/Routines/20250420110000_ReaddDefaultPluginRepository.cs b/Jellyfin.Server/Migrations/Routines/20250420110000_ReaddDefaultPluginRepository.cs index ebf4a2780e..df2a8cef98 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420110000_ReaddDefaultPluginRepository.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420110000_ReaddDefaultPluginRepository.cs @@ -1,4 +1,6 @@ using System; +using System.Threading; +using System.Threading.Tasks; using MediaBrowser.Controller.Configuration; using MediaBrowser.Model.Updates; @@ -7,10 +9,8 @@ namespace Jellyfin.Server.Migrations.Routines; /// <summary> /// Migration to initialize system configuration with the default plugin repository. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T11:00:00", nameof(ReaddDefaultPluginRepository), "5F86E7F6-D966-4C77-849D-7A7B40B68C4E", RunMigrationOnSetup = true)] -public class ReaddDefaultPluginRepository : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +public class ReaddDefaultPluginRepository : IAsyncMigrationRoutine { private readonly IServerConfigurationManager _serverConfigurationManager; @@ -30,7 +30,7 @@ public class ReaddDefaultPluginRepository : IMigrationRoutine } /// <inheritdoc/> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { // Only add if repository list is empty if (_serverConfigurationManager.Configuration.PluginRepositories.Length == 0) @@ -38,5 +38,7 @@ public class ReaddDefaultPluginRepository : IMigrationRoutine _serverConfigurationManager.Configuration.PluginRepositories = new[] { _defaultRepositoryInfo }; _serverConfigurationManager.SaveConfiguration(); } + + return Task.CompletedTask; } } diff --git a/Jellyfin.Server/Migrations/Routines/20250420120000_MigrateDisplayPreferencesDb.cs b/Jellyfin.Server/Migrations/Routines/20250420120000_MigrateDisplayPreferencesDb.cs index ffd06fea0d..b3d08790dc 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420120000_MigrateDisplayPreferencesDb.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420120000_MigrateDisplayPreferencesDb.cs @@ -4,6 +4,8 @@ using System.IO; using System.Linq; using System.Text.Json; using System.Text.Json.Serialization; +using System.Threading; +using System.Threading.Tasks; using Emby.Server.Implementations.Data; using Jellyfin.Database.Implementations; using Jellyfin.Database.Implementations.Entities; @@ -20,10 +22,8 @@ namespace Jellyfin.Server.Migrations.Routines /// <summary> /// The migration routine for migrating the display preferences database to EF Core. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T12:00:00", nameof(MigrateDisplayPreferencesDb), "06387815-C3CC-421F-A888-FB5F9992BEA8")] - public class MigrateDisplayPreferencesDb : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete + public class MigrateDisplayPreferencesDb : IAsyncMigrationRoutine { private const string DbFilename = "displaypreferences.db"; @@ -55,7 +55,14 @@ namespace Jellyfin.Server.Migrations.Routines } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { HomeSectionType[] defaults = { diff --git a/Jellyfin.Server/Migrations/Routines/20250420130000_RemoveDownloadImagesInAdvance.cs b/Jellyfin.Server/Migrations/Routines/20250420130000_RemoveDownloadImagesInAdvance.cs index b626c473e3..805a25decd 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420130000_RemoveDownloadImagesInAdvance.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420130000_RemoveDownloadImagesInAdvance.cs @@ -1,4 +1,6 @@ using System; +using System.Threading; +using System.Threading.Tasks; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Library; using Microsoft.Extensions.Logging; @@ -8,10 +10,8 @@ namespace Jellyfin.Server.Migrations.Routines; /// <summary> /// Removes the old 'RemoveDownloadImagesInAdvance' from library options. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T13:00:00", nameof(RemoveDownloadImagesInAdvance), "A81F75E0-8F43-416F-A5E8-516CCAB4D8CC")] -internal class RemoveDownloadImagesInAdvance : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +internal class RemoveDownloadImagesInAdvance : IAsyncMigrationRoutine { private readonly ILogger<RemoveDownloadImagesInAdvance> _logger; private readonly ILibraryManager _libraryManager; @@ -23,7 +23,7 @@ internal class RemoveDownloadImagesInAdvance : IMigrationRoutine } /// <inheritdoc/> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { var virtualFolders = _libraryManager.GetVirtualFolders(false); _logger.LogInformation("Removing 'RemoveDownloadImagesInAdvance' settings in all the libraries"); @@ -41,5 +41,7 @@ internal class RemoveDownloadImagesInAdvance : IMigrationRoutine collectionFolder.UpdateLibraryOptions(libraryOptions); _logger.LogInformation("Removed from '{VirtualFolder}'", virtualFolder.Name); } + + return Task.CompletedTask; } } diff --git a/Jellyfin.Server/Migrations/Routines/20250420140000_MigrateAuthenticationDb.cs b/Jellyfin.Server/Migrations/Routines/20250420140000_MigrateAuthenticationDb.cs index cbdc6efb44..e71f802985 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420140000_MigrateAuthenticationDb.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420140000_MigrateAuthenticationDb.cs @@ -2,6 +2,8 @@ using System; using System.Collections.Generic; using System.Globalization; using System.IO; +using System.Threading; +using System.Threading.Tasks; using Emby.Server.Implementations.Data; using Jellyfin.Database.Implementations; using Jellyfin.Database.Implementations.Entities.Security; @@ -16,10 +18,8 @@ namespace Jellyfin.Server.Migrations.Routines /// <summary> /// A migration that moves data from the authentication database into the new schema. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T14:00:00", nameof(MigrateAuthenticationDb), "5BD72F41-E6F3-4F60-90AA-09869ABE0E22")] - public class MigrateAuthenticationDb : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete + public class MigrateAuthenticationDb : IAsyncMigrationRoutine { private const string DbFilename = "authentication.db"; @@ -48,7 +48,14 @@ namespace Jellyfin.Server.Migrations.Routines } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { var dataPath = _appPaths.DataPath; var dbFilePath = Path.Combine(dataPath, DbFilename); diff --git a/Jellyfin.Server/Migrations/Routines/20250420150000_FixPlaylistOwner.cs b/Jellyfin.Server/Migrations/Routines/20250420150000_FixPlaylistOwner.cs index 56614ece3c..eda91958eb 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420150000_FixPlaylistOwner.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420150000_FixPlaylistOwner.cs @@ -1,6 +1,7 @@ using System; using System.Linq; using System.Threading; +using System.Threading.Tasks; using Jellyfin.Data.Enums; using MediaBrowser.Controller.Entities; @@ -13,10 +14,8 @@ namespace Jellyfin.Server.Migrations.Routines; /// <summary> /// Properly set playlist owner. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T15:00:00", nameof(FixPlaylistOwner), "615DFA9E-2497-4DBB-A472-61938B752C5B")] -internal class FixPlaylistOwner : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +internal class FixPlaylistOwner : IAsyncMigrationRoutine { private readonly ILogger<FixPlaylistOwner> _logger; private readonly ILibraryManager _libraryManager; @@ -32,8 +31,15 @@ internal class FixPlaylistOwner : IMigrationRoutine _playlistManager = playlistManager; } - /// <inheritdoc/> - public void Perform() + /// <inheritdoc /> + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { var playlists = _libraryManager.GetItemList(new InternalItemsQuery { diff --git a/Jellyfin.Server/Migrations/Routines/20250420160000_AddDefaultCastReceivers.cs b/Jellyfin.Server/Migrations/Routines/20250420160000_AddDefaultCastReceivers.cs index 00d152b4b8..e52b03f757 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420160000_AddDefaultCastReceivers.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420160000_AddDefaultCastReceivers.cs @@ -1,4 +1,6 @@ using System; +using System.Threading; +using System.Threading.Tasks; using MediaBrowser.Controller.Configuration; using MediaBrowser.Model.System; @@ -7,10 +9,8 @@ namespace Jellyfin.Server.Migrations.Routines; /// <summary> /// Migration to add the default cast receivers to the system config. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T16:00:00", nameof(AddDefaultCastReceivers), "34A1A1C4-5572-418E-A2F8-32CDFE2668E8", RunMigrationOnSetup = true)] -public class AddDefaultCastReceivers : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +public class AddDefaultCastReceivers : IAsyncMigrationRoutine { private readonly IServerConfigurationManager _serverConfigurationManager; @@ -24,7 +24,7 @@ public class AddDefaultCastReceivers : IMigrationRoutine } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { _serverConfigurationManager.Configuration.CastReceiverApplications = [ @@ -41,5 +41,7 @@ public class AddDefaultCastReceivers : IMigrationRoutine ]; _serverConfigurationManager.SaveConfiguration(); + + return Task.CompletedTask; } } diff --git a/Jellyfin.Server/Migrations/Routines/20250420170000_UpdateDefaultPluginRepository.cs b/Jellyfin.Server/Migrations/Routines/20250420170000_UpdateDefaultPluginRepository.cs index f58cf27413..a97dbef707 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420170000_UpdateDefaultPluginRepository.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420170000_UpdateDefaultPluginRepository.cs @@ -1,4 +1,6 @@ using System; +using System.Threading; +using System.Threading.Tasks; using MediaBrowser.Controller.Configuration; namespace Jellyfin.Server.Migrations.Routines; @@ -6,10 +8,8 @@ namespace Jellyfin.Server.Migrations.Routines; /// <summary> /// Migration to update the default Jellyfin plugin repository. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T17:00:00", nameof(UpdateDefaultPluginRepository), "852816E0-2712-49A9-9240-C6FC5FCAD1A8", RunMigrationOnSetup = true)] -public class UpdateDefaultPluginRepository : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +public class UpdateDefaultPluginRepository : IAsyncMigrationRoutine { private const string NewRepositoryUrl = "https://repo.jellyfin.org/files/plugin/manifest.json"; private const string OldRepositoryUrl = "https://repo.jellyfin.org/releases/plugin/manifest-stable.json"; @@ -26,7 +26,7 @@ public class UpdateDefaultPluginRepository : IMigrationRoutine } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { var updated = false; foreach (var repo in _serverConfigurationManager.Configuration.PluginRepositories) @@ -42,5 +42,7 @@ public class UpdateDefaultPluginRepository : IMigrationRoutine { _serverConfigurationManager.SaveConfiguration(); } + + return Task.CompletedTask; } } diff --git a/Jellyfin.Server/Migrations/Routines/20250420180000_FixAudioData.cs b/Jellyfin.Server/Migrations/Routines/20250420180000_FixAudioData.cs index d102e24b91..a736ccb4ec 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420180000_FixAudioData.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420180000_FixAudioData.cs @@ -1,5 +1,6 @@ using System.Linq; using System.Threading; +using System.Threading.Tasks; using Jellyfin.Data.Enums; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.Audio; @@ -12,11 +13,9 @@ namespace Jellyfin.Server.Migrations.Routines /// <summary> /// Fixes the data column of audio types to be deserializable. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T18:00:00", nameof(FixAudioData), "CF6FABC2-9FBE-4933-84A5-FFE52EF22A58")] [JellyfinMigrationBackup(LegacyLibraryDb = true)] - internal class FixAudioData : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete + internal class FixAudioData : IAsyncMigrationRoutine { private readonly ILogger<FixAudioData> _logger; private readonly IItemRepository _itemRepository; @@ -36,7 +35,7 @@ namespace Jellyfin.Server.Migrations.Routines } /// <inheritdoc/> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { _logger.LogInformation("Backfilling audio lyrics data to database."); var startIndex = 0; @@ -71,6 +70,8 @@ namespace Jellyfin.Server.Migrations.Routines startIndex += results.Count; _logger.LogInformation("Backfilled data for {UpdatedRecords} of {TotalRecords} audio records", startIndex, records); } + + return Task.CompletedTask; } } } diff --git a/Jellyfin.Server/Migrations/Routines/20250420200000_MigrateLibraryDb.cs b/Jellyfin.Server/Migrations/Routines/20250420200000_MigrateLibraryDb.cs index 3e4205547a..06eba8cd94 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420200000_MigrateLibraryDb.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420200000_MigrateLibraryDb.cs @@ -9,6 +9,8 @@ using System.Globalization; using System.IO; using System.Linq; using System.Text; +using System.Threading; +using System.Threading.Tasks; using Emby.Server.Implementations.Data; using Jellyfin.Database.Implementations; using Jellyfin.Database.Implementations.Entities; @@ -59,8 +61,15 @@ internal class MigrateLibraryDb : IDatabaseMigrationRoutine _jellyfinDatabaseProvider = jellyfinDatabaseProvider; } - /// <inheritdoc/> - public void Perform() + /// <inheritdoc /> + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { _logger.LogInformation("Migrating the userdata from library.db may take a while, do not stop Jellyfin."); diff --git a/Jellyfin.Server/Migrations/Routines/20250420230000_MoveTrickplayFiles.cs b/Jellyfin.Server/Migrations/Routines/20250420230000_MoveTrickplayFiles.cs index 79a8f9577c..46f4ce13c0 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420230000_MoveTrickplayFiles.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420230000_MoveTrickplayFiles.cs @@ -3,6 +3,8 @@ using System.Diagnostics; using System.Globalization; using System.IO; using System.Linq; +using System.Threading; +using System.Threading.Tasks; using Jellyfin.Data.Enums; using Jellyfin.Server.ServerSetupApp; using MediaBrowser.Controller.Entities; @@ -16,10 +18,8 @@ namespace Jellyfin.Server.Migrations.Routines; /// <summary> /// Migration to move trickplay files to the new directory. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2025-04-20T23:00:00", nameof(MoveTrickplayFiles), RunMigrationOnSetup = true)] -public class MoveTrickplayFiles : IMigrationRoutine -#pragma warning restore CS0618 // Type or member is obsolete +public class MoveTrickplayFiles : IAsyncMigrationRoutine { private readonly ITrickplayManager _trickplayManager; private readonly IFileSystem _fileSystem; @@ -46,7 +46,7 @@ public class MoveTrickplayFiles : IMigrationRoutine } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) { const int Limit = 5000; int itemCount = 0, offset = 0, previousCount; @@ -103,6 +103,8 @@ public class MoveTrickplayFiles : IMigrationRoutine } while (previousCount == Limit); _logger.LogInformation("Moved {Count} items in {Time}", itemCount, sw.Elapsed); + + return Task.CompletedTask; } private string GetOldTrickplayDirectory(BaseItem item, int? width = null) diff --git a/Jellyfin.Server/Migrations/Routines/20250420230000_RefreshInternalDateModified.cs b/Jellyfin.Server/Migrations/Routines/20250420230000_RefreshInternalDateModified.cs index b23a7dbc42..420105b856 100644 --- a/Jellyfin.Server/Migrations/Routines/20250420230000_RefreshInternalDateModified.cs +++ b/Jellyfin.Server/Migrations/Routines/20250420230000_RefreshInternalDateModified.cs @@ -2,6 +2,8 @@ using System; using System.Collections.Generic; using System.Diagnostics; using System.Linq; +using System.Threading; +using System.Threading.Tasks; using Jellyfin.Database.Implementations; using Jellyfin.Database.Implementations.Entities; using Jellyfin.Extensions; @@ -70,7 +72,14 @@ public class RefreshInternalDateModified : IDatabaseMigrationRoutine } /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { const int Limit = 5000; int itemCount = 0, offset = 0; diff --git a/Jellyfin.Server/Migrations/Routines/20250421000000_MigrateKeyframeData.cs b/Jellyfin.Server/Migrations/Routines/20250421000000_MigrateKeyframeData.cs index aa55309264..fd42ce5224 100644 --- a/Jellyfin.Server/Migrations/Routines/20250421000000_MigrateKeyframeData.cs +++ b/Jellyfin.Server/Migrations/Routines/20250421000000_MigrateKeyframeData.cs @@ -5,6 +5,8 @@ using System.Globalization; using System.IO; using System.Linq; using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; using Jellyfin.Data.Enums; using Jellyfin.Database.Implementations; using Jellyfin.Database.Implementations.Entities; @@ -47,7 +49,14 @@ public class MigrateKeyframeData : IDatabaseMigrationRoutine private string KeyframeCachePath => Path.Combine(_appPaths.DataPath, "keyframes"); /// <inheritdoc /> - public void Perform() + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { const int Limit = 5000; int itemCount = 0, offset = 0; diff --git a/Jellyfin.Server/Migrations/Routines/20260113120000_MigrateLinkedChildren.cs b/Jellyfin.Server/Migrations/Routines/20260113120000_MigrateLinkedChildren.cs index 7fa555f005..ea2c0ddc22 100644 --- a/Jellyfin.Server/Migrations/Routines/20260113120000_MigrateLinkedChildren.cs +++ b/Jellyfin.Server/Migrations/Routines/20260113120000_MigrateLinkedChildren.cs @@ -3,6 +3,8 @@ using System.Collections.Generic; using System.IO; using System.Linq; using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; using Jellyfin.Database.Implementations; using Jellyfin.Database.Implementations.Entities; using Jellyfin.Extensions; @@ -49,8 +51,15 @@ internal class MigrateLinkedChildren : IDatabaseMigrationRoutine _appPaths = appPaths; } - /// <inheritdoc/> - public void Perform() + /// <inheritdoc /> + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { using var context = _dbProvider.CreateDbContext(); diff --git a/Jellyfin.Server/Migrations/Routines/20260729120000_RestorePlaylistChildrenFromMetadata.cs b/Jellyfin.Server/Migrations/Routines/20260729120000_RestorePlaylistChildrenFromMetadata.cs index 16ac6cb5e5..82c8601e9e 100644 --- a/Jellyfin.Server/Migrations/Routines/20260729120000_RestorePlaylistChildrenFromMetadata.cs +++ b/Jellyfin.Server/Migrations/Routines/20260729120000_RestorePlaylistChildrenFromMetadata.cs @@ -2,6 +2,8 @@ using System; using System.Collections.Generic; using System.IO; using System.Linq; +using System.Threading; +using System.Threading.Tasks; using System.Xml; using Jellyfin.Database.Implementations; using Jellyfin.Database.Implementations.Entities; @@ -34,8 +36,15 @@ internal class RestorePlaylistChildrenFromMetadata : IDatabaseMigrationRoutine _appHost = appHost; } - /// <inheritdoc/> - public void Perform() + /// <inheritdoc /> + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { using var context = _dbProvider.CreateDbContext(); diff --git a/Jellyfin.Server/Migrations/Routines/20260911120000_StripEmbeddedLinkedChildren.cs b/Jellyfin.Server/Migrations/Routines/20260911120000_StripEmbeddedLinkedChildren.cs index f61e42337a..4f7b464ac4 100644 --- a/Jellyfin.Server/Migrations/Routines/20260911120000_StripEmbeddedLinkedChildren.cs +++ b/Jellyfin.Server/Migrations/Routines/20260911120000_StripEmbeddedLinkedChildren.cs @@ -1,3 +1,5 @@ +using System.Threading; +using System.Threading.Tasks; using Jellyfin.Database.Implementations; using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Logging; @@ -22,23 +24,26 @@ internal class StripEmbeddedLinkedChildren : IDatabaseMigrationRoutine } /// <inheritdoc/> - public void Perform() + public async Task PerformAsync(CancellationToken cancellationToken) { - using var context = _dbProvider.CreateDbContext(); + var context = await _dbProvider.CreateDbContextAsync(cancellationToken).ConfigureAwait(false); + await using (context.ConfigureAwait(false)) + { + // json_valid guards the rare malformed blob: json_remove would abort the statement on it, + // and one bad row must not cost every other row the fix. + var updated = await context.Database.ExecuteSqlRawAsync( + """ + UPDATE "BaseItems" + SET "Data" = json_remove("Data", '$.LinkedChildren', '$.ExtraIds', '$.SupportsExternalTransfer') + WHERE "Data" IS NOT NULL + AND json_valid("Data") = 1 + AND ("Data" LIKE '%"LinkedChildren"%' + OR "Data" LIKE '%"ExtraIds"%' + OR "Data" LIKE '%"SupportsExternalTransfer"%') + """, + cancellationToken).ConfigureAwait(false); - // json_valid guards the rare malformed blob: json_remove would abort the statement on it, - // and one bad row must not cost every other row the fix. - var updated = context.Database.ExecuteSqlRaw( - """ - UPDATE "BaseItems" - SET "Data" = json_remove("Data", '$.LinkedChildren', '$.ExtraIds', '$.SupportsExternalTransfer') - WHERE "Data" IS NOT NULL - AND json_valid("Data") = 1 - AND ("Data" LIKE '%"LinkedChildren"%' - OR "Data" LIKE '%"ExtraIds"%' - OR "Data" LIKE '%"SupportsExternalTransfer"%') - """); - - _logger.LogInformation("Dropped dead keys from the serialized data of {Count} items", updated); + _logger.LogInformation("Dropped dead keys from the serialized data of {Count} items", updated); + } } } diff --git a/Jellyfin.Server/Migrations/Routines/20260915120000_MigrateRatingLevels.cs b/Jellyfin.Server/Migrations/Routines/20260915120000_MigrateRatingLevels.cs index 903d91e046..aaa4b82c35 100644 --- a/Jellyfin.Server/Migrations/Routines/20260915120000_MigrateRatingLevels.cs +++ b/Jellyfin.Server/Migrations/Routines/20260915120000_MigrateRatingLevels.cs @@ -1,4 +1,6 @@ using System.Linq; +using System.Threading; +using System.Threading.Tasks; using Jellyfin.Database.Implementations; using Jellyfin.Server.ServerSetupApp; using MediaBrowser.Model.Globalization; @@ -10,10 +12,8 @@ namespace Jellyfin.Server.Migrations.Routines; /// <summary> /// Migrate rating levels. /// </summary> -#pragma warning disable CS0618 // Type or member is obsolete [JellyfinMigration("2026-09-15T12:00:00", nameof(MigrateRatingLevels))] [JellyfinMigrationBackup(JellyfinDb = true)] -#pragma warning restore CS0618 // Type or member is obsolete internal class MigrateRatingLevels : IDatabaseMigrationRoutine { private readonly IStartupLogger _logger; @@ -30,8 +30,15 @@ internal class MigrateRatingLevels : IDatabaseMigrationRoutine _logger = logger; } - /// <inheritdoc/> - public void Perform() + /// <inheritdoc /> + public Task PerformAsync(CancellationToken cancellationToken) + { + // This routine predates the async interface and has not been ported to async database access yet. + PerformCore(); + return Task.CompletedTask; + } + + private void PerformCore() { _logger.LogInformation("Recalculating parental rating levels based on rating string."); using var context = _provider.CreateDbContext(); diff --git a/Jellyfin.Server/Migrations/Stages/CodeMigration.cs b/Jellyfin.Server/Migrations/Stages/CodeMigration.cs index 71706811b8..fa2210ea40 100644 --- a/Jellyfin.Server/Migrations/Stages/CodeMigration.cs +++ b/Jellyfin.Server/Migrations/Stages/CodeMigration.cs @@ -22,9 +22,9 @@ internal class CodeMigration(Type migrationType, JellyfinMigrationAttribute meta public async Task Perform(IServiceProvider serviceProvider, IStartupLogger logger, CancellationToken cancellationToken) { - if (!IsMigrationRoutine(MigrationType)) + if (!typeof(IAsyncMigrationRoutine).IsAssignableFrom(MigrationType)) { - throw new InvalidOperationException($"The type {MigrationType} does not implement either IMigrationRoutine or IAsyncMigrationRoutine and is not a valid migration type"); + throw new InvalidOperationException($"The type {MigrationType} does not implement IAsyncMigrationRoutine and is not a valid migration type"); } // The routine runs against a scope of the applications own container. Copying the application service @@ -37,28 +37,8 @@ internal class CodeMigration(Type migrationType, JellyfinMigrationAttribute meta // Nests everything the routine logs through an injected IStartupLogger under the migrations own topic. using (StartupLogger.BeginAmbientTopic(logger.Topic)) { - await RunAsync(ActivatorUtilities.CreateInstance(scope.ServiceProvider, MigrationType), cancellationToken).ConfigureAwait(false); + await ((IAsyncMigrationRoutine)ActivatorUtilities.CreateInstance(scope.ServiceProvider, MigrationType)).PerformAsync(cancellationToken).ConfigureAwait(false); } } } - - // The obsolete IMigrationRoutine is still implemented by every routine that predates the async interface, so - // the members that have to touch it are grouped here behind a single suppression. -#pragma warning disable CS0618 // Type or member is obsolete - private static bool IsMigrationRoutine(Type migrationType) - { - return typeof(IMigrationRoutine).IsAssignableFrom(migrationType) || typeof(IAsyncMigrationRoutine).IsAssignableFrom(migrationType); - } - - private static async Task RunAsync(object routine, CancellationToken cancellationToken) - { - if (routine is IMigrationRoutine migrationRoutine) - { - migrationRoutine.Perform(); - return; - } - - await ((IAsyncMigrationRoutine)routine).PerformAsync(cancellationToken).ConfigureAwait(false); - } -#pragma warning restore CS0618 // Type or member is obsolete } diff --git a/tests/Jellyfin.Server.Tests/Migrations/FixNullEncoderPresetTests.cs b/tests/Jellyfin.Server.Tests/Migrations/FixNullEncoderPresetTests.cs index b41ecbb8ed..baa7909929 100644 --- a/tests/Jellyfin.Server.Tests/Migrations/FixNullEncoderPresetTests.cs +++ b/tests/Jellyfin.Server.Tests/Migrations/FixNullEncoderPresetTests.cs @@ -102,7 +102,7 @@ public sealed class FixNullEncoderPresetTests : IDisposable _configurationDirectory); var migration = new MigrateEncodingOptions(applicationPaths, NullLoggerFactory.Instance); - migration.Perform(); + await migration.PerformAsync(TestContext.Current.CancellationToken); var serializer = new XmlSerializer(typeof(EncodingOptions)); using var reader = XmlReader.Create(_encodingConfigurationPath); diff --git a/tests/Jellyfin.Server.Tests/Migrations/MigrateLinkedChildrenStaleItemsTests.cs b/tests/Jellyfin.Server.Tests/Migrations/MigrateLinkedChildrenStaleItemsTests.cs index 92fc1dca97..03d39c0ee7 100644 --- a/tests/Jellyfin.Server.Tests/Migrations/MigrateLinkedChildrenStaleItemsTests.cs +++ b/tests/Jellyfin.Server.Tests/Migrations/MigrateLinkedChildrenStaleItemsTests.cs @@ -3,6 +3,7 @@ using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading; +using System.Threading.Tasks; using Jellyfin.Database.Implementations; using Jellyfin.Database.Implementations.Entities; using Jellyfin.Database.Implementations.Locking; @@ -54,18 +55,18 @@ public sealed class MigrateLinkedChildrenStaleItemsTests : IDisposable private string LibraryDefinitionRoot => Path.Combine(_root, "root", "default"); [Fact] - public void Perform_NoLibraryLocationsResolved_KeepsEverything() + public async Task Perform_NoLibraryLocationsResolved_KeepsEverything() { var itemId = Guid.Parse("aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"); SeedItem(itemId, SeedMediaFile("kept.flac")); - var deleted = Perform(libraryLocations: []); + var deleted = await PerformAsync(libraryLocations: []); Assert.Empty(deleted); } [Fact] - public void Perform_ItemOutsideEveryLocation_IsRemoved() + public async Task Perform_ItemOutsideEveryLocation_IsRemoved() { var itemId = Guid.Parse("bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"); @@ -74,36 +75,36 @@ public sealed class MigrateLinkedChildrenStaleItemsTests : IDisposable SeedMediaFile("anchor.flac"); SeedItem(itemId, Path.Combine(_root, "removed-media", "gone.flac")); - var deleted = Perform(libraryLocations: [Path.Combine(_root, "media")]); + var deleted = await PerformAsync(libraryLocations: [Path.Combine(_root, "media")]); Assert.Equal([itemId], deleted); } [Fact] - public void Perform_ItemInsideLocationWithMissingFile_IsRemoved() + public async Task Perform_ItemInsideLocationWithMissingFile_IsRemoved() { var itemId = Guid.Parse("cccccccc-cccc-cccc-cccc-cccccccccccc"); SeedMediaFile("anchor.flac"); SeedItem(itemId, Path.Combine(_root, "media", "deleted.flac")); - var deleted = Perform(libraryLocations: [Path.Combine(_root, "media")]); + var deleted = await PerformAsync(libraryLocations: [Path.Combine(_root, "media")]); Assert.Equal([itemId], deleted); } [Fact] - public void Perform_ItemInsideLocationWithFilePresent_IsKept() + public async Task Perform_ItemInsideLocationWithFilePresent_IsKept() { var itemId = Guid.Parse("dddddddd-dddd-dddd-dddd-dddddddddddd"); SeedItem(itemId, SeedMediaFile("present.flac")); - var deleted = Perform(libraryLocations: [Path.Combine(_root, "media")]); + var deleted = await PerformAsync(libraryLocations: [Path.Combine(_root, "media")]); Assert.Empty(deleted); } [Fact] - public void Perform_LibraryDefinitionMissing_KeepsItsItems() + public async Task Perform_LibraryDefinitionMissing_KeepsItsItems() { var libraryId = Guid.Parse("11111111-1111-1111-1111-111111111111"); var itemId = Guid.Parse("22222222-2222-2222-2222-222222222222"); @@ -114,13 +115,13 @@ public sealed class MigrateLinkedChildrenStaleItemsTests : IDisposable SeedMediaFile("anchor.flac"); SeedItem(itemId, Path.Combine(_root, "movies", "kept.mkv"), libraryId); - var deleted = Perform(libraryLocations: [Path.Combine(_root, "media")]); + var deleted = await PerformAsync(libraryLocations: [Path.Combine(_root, "media")]); Assert.Empty(deleted); } [Fact] - public void Perform_PathRemovedFromSurvivingLibrary_IsRemoved() + public async Task Perform_PathRemovedFromSurvivingLibrary_IsRemoved() { var libraryId = Guid.Parse("33333333-3333-3333-3333-333333333333"); var itemId = Guid.Parse("44444444-4444-4444-4444-444444444444"); @@ -131,7 +132,7 @@ public sealed class MigrateLinkedChildrenStaleItemsTests : IDisposable SeedMediaFile("anchor.flac"); SeedItem(itemId, Path.Combine(_root, "removed-media", "gone.flac"), libraryId); - var deleted = Perform(libraryLocations: [Path.Combine(_root, "media")]); + var deleted = await PerformAsync(libraryLocations: [Path.Combine(_root, "media")]); Assert.Equal([itemId], deleted); } @@ -200,7 +201,7 @@ public sealed class MigrateLinkedChildrenStaleItemsTests : IDisposable } } - private IReadOnlyList<Guid> Perform(string[] libraryLocations, string libraryName = "Media") + private async Task<IReadOnlyList<Guid>> PerformAsync(string[] libraryLocations, string libraryName = "Media") { var deleted = new List<Guid>(); @@ -229,13 +230,13 @@ public sealed class MigrateLinkedChildrenStaleItemsTests : IDisposable factory.Setup(f => f.CreateDbContext()).Returns(CreateDbContext); factory.Setup(f => f.CreateDbContextAsync(It.IsAny<CancellationToken>())).ReturnsAsync(CreateDbContext); - new MigrateLinkedChildren( + await new MigrateLinkedChildren( NullLoggerFactory.Instance, factory.Object, libraryManager.Object, appHost.Object, appPaths.Object) - .Perform(); + .PerformAsync(TestContext.Current.CancellationToken); return deleted; } |
