nordic-dev.net/nixpkgs
nordic-dev.net/nixpkgs
2
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-22 23:13:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #300228 from davidkna/kavita-fix-migrations

Browse Source 
kavita: restore db migrations
This commit is contained in:
Pol Dellaiera 2024-05-14 21:14:52 +02:00 committed by GitHub
commit 831dced72e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 153 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
pkgs/servers/web-apps/kavita/default.nix
View File

@ -34,6 +34,12 @@ stdenvNoCC.mkDerivation (finalAttrs: {
})
# The webroot is hardcoded as ./wwwroot
./change-webroot.diff
# Upstream removes database migrations between versions
# Restore them to avoid breaking on updates
# Info: Restores migrations for versions between v0.7.1.4 and v0.7.9
# On update: check if more migrations need to be restored!
# Migrations should at least allow updates from previous NixOS versions
./restore-migrations.diff
];
postPatch = ''
substituteInPlace API/Services/DirectoryService.cs --subst-var out

147
pkgs/servers/web-apps/kavita/restore-migrations.diff Normal file
View File

@ -0,0 +1,147 @@
diff --git a/API/Data/ManualMigrations/MigrateDisableScrobblingOnComicLibraries.cs b/API/Data/ManualMigrations/MigrateDisableScrobblingOnComicLibraries.cs
new file mode 100644
index 00000000..0de7bf5d
--- /dev/null
+++ b/API/Data/ManualMigrations/MigrateDisableScrobblingOnComicLibraries.cs
@@ -0,0 +1,38 @@
+using System.Linq;
+using System.Threading.Tasks;
+using API.Entities.Enums;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Logging;
+
+namespace API.Data.ManualMigrations;
+
+/// <summary>
+/// v0.7.4 introduced Scrobbling with Kavita+. By default, it is on, but Comic libraries have no scrobble providers, so disable
+/// </summary>
+public static class MigrateDisableScrobblingOnComicLibraries
+{
+ public static async Task Migrate(IUnitOfWork unitOfWork, DataContext dataContext, ILogger<Program> logger)
+ {
+ if (!await dataContext.Library.Where(s => s.Type == LibraryType.Comic).Where(l => l.AllowScrobbling).AnyAsync())
+ {
+ return;
+ }
+ logger.LogInformation("Running MigrateDisableScrobblingOnComicLibraries migration. Please be patient, this may take some time");
+
+
+ foreach (var lib in await dataContext.Library.Where(s => s.Type == LibraryType.Comic).Where(l => l.AllowScrobbling).ToListAsync())
+ {
+ lib.AllowScrobbling = false;
+ unitOfWork.LibraryRepository.Update(lib);
+ }
+
+ if (unitOfWork.HasChanges())
+ {
+ await unitOfWork.CommitAsync();
+ }
+
+ logger.LogInformation("MigrateDisableScrobblingOnComicLibraries migration finished");
+
+ }
+
+}
diff --git a/API/Data/ManualMigrations/MigrateLoginRoles.cs b/API/Data/ManualMigrations/MigrateLoginRoles.cs
new file mode 100644
index 00000000..f649908a
--- /dev/null
+++ b/API/Data/ManualMigrations/MigrateLoginRoles.cs
@@ -0,0 +1,36 @@
+using System.Threading.Tasks;
+using API.Constants;
+using API.Entities;
+using Microsoft.AspNetCore.Identity;
+using Microsoft.Extensions.Logging;
+
+namespace API.Data.ManualMigrations;
+
+/// <summary>
+/// Added in v0.7.1.18
+/// </summary>
+public static class MigrateLoginRoles
+{
+ /// <summary>
+ /// Will not run if any users have the <see cref="PolicyConstants.LoginRole"/> role already
+ /// </summary>
+ /// <param name="unitOfWork"></param>
+ /// <param name="userManager"></param>
+ /// <param name="logger"></param>
+ public static async Task Migrate(IUnitOfWork unitOfWork, UserManager<AppUser> userManager, ILogger<Program> logger)
+ {
+ var usersWithRole = await userManager.GetUsersInRoleAsync(PolicyConstants.LoginRole);
+ if (usersWithRole.Count != 0) return;
+
+ logger.LogCritical("Running MigrateLoginRoles migration");
+
+ var allUsers = await unitOfWork.UserRepository.GetAllUsersAsync();
+ foreach (var user in allUsers)
+ {
+ await userManager.RemoveFromRoleAsync(user, PolicyConstants.LoginRole);
+ await userManager.AddToRoleAsync(user, PolicyConstants.LoginRole);
+ }
+
+ logger.LogInformation("MigrateLoginRoles migration complete");
+ }
+}
diff --git a/API/Data/ManualMigrations/MigrateRemoveWebPSettingRows.cs b/API/Data/ManualMigrations/MigrateRemoveWebPSettingRows.cs
new file mode 100644
index 00000000..07e98ef6
--- /dev/null
+++ b/API/Data/ManualMigrations/MigrateRemoveWebPSettingRows.cs
@@ -0,0 +1,31 @@
+using System.Threading.Tasks;
+using API.Entities.Enums;
+using Microsoft.Extensions.Logging;
+
+namespace API.Data.ManualMigrations;
+
+/// <summary>
+/// Added in v0.7.2.7/v0.7.3 in which the ConvertXToWebP Setting keys were removed. This migration will remove them.
+/// </summary>
+public static class MigrateRemoveWebPSettingRows
+{
+ public static async Task Migrate(IUnitOfWork unitOfWork, ILogger<Program> logger)
+ {
+ logger.LogCritical("Running MigrateRemoveWebPSettingRows migration - Please be patient, this may take some time. This is not an error");
+
+ var key = await unitOfWork.SettingsRepository.GetSettingAsync(ServerSettingKey.ConvertBookmarkToWebP);
+ var key2 = await unitOfWork.SettingsRepository.GetSettingAsync(ServerSettingKey.ConvertCoverToWebP);
+ if (key == null && key2 == null)
+ {
+ logger.LogCritical("Running MigrateRemoveWebPSettingRows migration - complete. Nothing to do");
+ return;
+ }
+
+ unitOfWork.SettingsRepository.Remove(key);
+ unitOfWork.SettingsRepository.Remove(key2);
+
+ await unitOfWork.CommitAsync();
+
+ logger.LogCritical("Running MigrateRemoveWebPSettingRows migration - Completed. This is not an error");
+ }
+}
diff --git a/API/Startup.cs b/API/Startup.cs
index 21c4fa45..04f4a077 100644
--- a/API/Startup.cs
+++ b/API/Startup.cs
@@ -232,11 +232,19 @@ public class Startup
Task.Run(async () =>
{
// Apply all migrations on startup
+ var userManager = serviceProvider.GetRequiredService<UserManager<AppUser>>();
var dataContext = serviceProvider.GetRequiredService<DataContext>();
logger.LogInformation("Running Migrations");
+ // v0.7.2
+ await MigrateLoginRoles.Migrate(unitOfWork, userManager, logger);
+ // v0.7.3
+ await MigrateRemoveWebPSettingRows.Migrate(unitOfWork, logger);
+ // v0.7.4
+ await MigrateDisableScrobblingOnComicLibraries.Migrate(unitOfWork, dataContext, logger);
+
// v0.7.9
await MigrateUserLibrarySideNavStream.Migrate(unitOfWork, dataContext, logger);