From 798482c94122eb9d23221e90e33ccc390a52380a Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 18 Jan 2022 14:19:25 +0900
Subject: [PATCH] Create backups before deleting scores and beatmaps from EF
 database

---
 osu.Game/Database/DatabaseContextFactory.cs |  8 +++++++
 osu.Game/Database/EFToRealmMigrator.cs      | 25 +++++++++++++--------
 2 files changed, 24 insertions(+), 9 deletions(-)

diff --git a/osu.Game/Database/DatabaseContextFactory.cs b/osu.Game/Database/DatabaseContextFactory.cs
index f79505d7c5..c2a60122eb 100644
--- a/osu.Game/Database/DatabaseContextFactory.cs
+++ b/osu.Game/Database/DatabaseContextFactory.cs
@@ -1,6 +1,7 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using System.IO;
 using System.Linq;
 using System.Threading;
 using Microsoft.EntityFrameworkCore.Storage;
@@ -144,6 +145,13 @@ namespace osu.Game.Database
             Database = { AutoTransactionsEnabled = false }
         };
 
+        public void CreateBackup(string filename)
+        {
+            using (var source = storage.GetStream(DATABASE_NAME))
+            using (var destination = storage.GetStream(filename, FileAccess.Write, FileMode.CreateNew))
+                source.CopyTo(destination);
+        }
+
         public void ResetDatabase()
         {
             lock (writeLock)
diff --git a/osu.Game/Database/EFToRealmMigrator.cs b/osu.Game/Database/EFToRealmMigrator.cs
index 7ad8e507bb..3ecbd50b3e 100644
--- a/osu.Game/Database/EFToRealmMigrator.cs
+++ b/osu.Game/Database/EFToRealmMigrator.cs
@@ -1,6 +1,8 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using System;
+using System.Collections.Generic;
 using System.Linq;
 using Microsoft.EntityFrameworkCore;
 using osu.Game.Beatmaps;
@@ -31,13 +33,16 @@ namespace osu.Game.Database
         public void Run()
         {
             using (var ef = efContextFactory.GetForWrite())
-            {
                 migrateSettings(ef);
+
+            using (var ef = efContextFactory.GetForWrite())
                 migrateSkins(ef);
 
+            using (var ef = efContextFactory.GetForWrite())
                 migrateBeatmaps(ef);
+
+            using (var ef = efContextFactory.GetForWrite())
                 migrateScores(ef);
-            }
 
             // Delete the database permanently.
             // Will cause future startups to not attempt migration.
@@ -47,13 +52,13 @@ namespace osu.Game.Database
         private void migrateBeatmaps(DatabaseWriteUsage ef)
         {
             // can be removed 20220730.
-            var existingBeatmapSets = ef.Context.EFBeatmapSetInfo
-                                        .Include(s => s.Beatmaps).ThenInclude(b => b.RulesetInfo)
-                                        .Include(s => s.Beatmaps).ThenInclude(b => b.Metadata)
-                                        .Include(s => s.Beatmaps).ThenInclude(b => b.BaseDifficulty)
-                                        .Include(s => s.Files).ThenInclude(f => f.FileInfo)
-                                        .Include(s => s.Metadata)
-                                        .ToList();
+            List<EFBeatmapSetInfo> existingBeatmapSets = ef.Context.EFBeatmapSetInfo
+                                                           .Include(s => s.Beatmaps).ThenInclude(b => b.RulesetInfo)
+                                                           .Include(s => s.Beatmaps).ThenInclude(b => b.Metadata)
+                                                           .Include(s => s.Beatmaps).ThenInclude(b => b.BaseDifficulty)
+                                                           .Include(s => s.Files).ThenInclude(f => f.FileInfo)
+                                                           .Include(s => s.Metadata)
+                                                           .ToList();
 
             // previous entries in EF are removed post migration.
             if (!existingBeatmapSets.Any())
@@ -121,6 +126,7 @@ namespace osu.Game.Database
                     }
                 }
 
+                efContextFactory.CreateBackup($"client.before_beatmap_migration_{DateTimeOffset.UtcNow.ToUnixTimeSeconds()}.db");
                 ef.Context.RemoveRange(existingBeatmapSets);
                 // Intentionally don't clean up the files, so they don't get purged by EF.
 
@@ -207,6 +213,7 @@ namespace osu.Game.Database
                     }
                 }
 
+                efContextFactory.CreateBackup($"client.before_scores_migration_{DateTimeOffset.UtcNow.ToUnixTimeSeconds()}.db");
                 db.Context.RemoveRange(existingScores);
                 // Intentionally don't clean up the files, so they don't get purged by EF.