osu-lazer/osu.Game/Database/EFToRealmMigrator.cs

// 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.Framework.Logging;
using osu.Game.Beatmaps;
using osu.Game.Configuration;
using osu.Game.Models;
using osu.Game.Rulesets;
using osu.Game.Scoring;
using osu.Game.Skinning;
using Realms;

#nullable enable

namespace osu.Game.Database
{
    internal class EFToRealmMigrator
    {
        private readonly DatabaseContextFactory efContextFactory;
        private readonly RealmContextFactory realmContextFactory;
        private readonly OsuConfigManager config;

        private bool hasTakenBackup;

        public EFToRealmMigrator(DatabaseContextFactory efContextFactory, RealmContextFactory realmContextFactory, OsuConfigManager config)
        {
            this.efContextFactory = efContextFactory;
            this.realmContextFactory = realmContextFactory;
            this.config = config;
        }

        public void Run()
        {
            using (var ef = efContextFactory.GetForWrite())
            {
                migrateSettings(ef);
                migrateSkins(ef);
                migrateBeatmaps(ef);
                migrateScores(ef);
            }

            // Delete the database permanently.
            // Will cause future startups to not attempt migration.
            Logger.Log("Migration successful, deleting EF database", LoggingTarget.Database);
            efContextFactory.ResetDatabase();
        }

        private void migrateBeatmaps(DatabaseWriteUsage ef)
        {
            // can be removed 20220730.
            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();

            Logger.Log("Beginning beatmaps migration to realm", LoggingTarget.Database);

            // previous entries in EF are removed post migration.
            if (!existingBeatmapSets.Any())
            {
                Logger.Log("No beatmaps found to migrate", LoggingTarget.Database);
                return;
            }

            using (var realm = realmContextFactory.CreateContext())
            {
                Logger.Log($"Found {existingBeatmapSets.Count} beatmaps in EF", LoggingTarget.Database);

                if (!hasTakenBackup)
                {
                    string migration = $"before_beatmap_migration_{DateTimeOffset.UtcNow.ToUnixTimeSeconds()}";

                    efContextFactory.CreateBackup($"client.{migration}.db");
                    realmContextFactory.CreateBackup($"client.{migration}.realm");

                    hasTakenBackup = true;
                }

                // only migrate data if the realm database is empty.
                // note that this cannot be written as: `realm.All<BeatmapSetInfo>().All(s => s.Protected)`, because realm does not support `.All()`.
                if (realm.All<BeatmapSetInfo>().Any(s => !s.Protected))
                {
                    Logger.Log("Skipping migration as realm already has beatmaps loaded", LoggingTarget.Database);
                }
                else
                {
                    using (var transaction = realm.BeginWrite())
                    {
                        foreach (var beatmapSet in existingBeatmapSets)
                        {
                            var realmBeatmapSet = new BeatmapSetInfo
                            {
                                OnlineID = beatmapSet.OnlineID ?? -1,
                                DateAdded = beatmapSet.DateAdded,
                                Status = beatmapSet.Status,
                                DeletePending = beatmapSet.DeletePending,
                                Hash = beatmapSet.Hash,
                                Protected = beatmapSet.Protected,
                            };

                            migrateFiles(beatmapSet, realm, realmBeatmapSet);

                            foreach (var beatmap in beatmapSet.Beatmaps)
                            {
                                var realmBeatmap = new BeatmapInfo
                                {
                                    DifficultyName = beatmap.DifficultyName,
                                    Status = beatmap.Status,
                                    OnlineID = beatmap.OnlineID ?? -1,
                                    Length = beatmap.Length,
                                    BPM = beatmap.BPM,
                                    Hash = beatmap.Hash,
                                    StarRating = beatmap.StarRating,
                                    MD5Hash = beatmap.MD5Hash,
                                    Hidden = beatmap.Hidden,
                                    AudioLeadIn = beatmap.AudioLeadIn,
                                    StackLeniency = beatmap.StackLeniency,
                                    SpecialStyle = beatmap.SpecialStyle,
                                    LetterboxInBreaks = beatmap.LetterboxInBreaks,
                                    WidescreenStoryboard = beatmap.WidescreenStoryboard,
                                    EpilepsyWarning = beatmap.EpilepsyWarning,
                                    SamplesMatchPlaybackRate = beatmap.SamplesMatchPlaybackRate,
                                    DistanceSpacing = beatmap.DistanceSpacing,
                                    BeatDivisor = beatmap.BeatDivisor,
                                    GridSize = beatmap.GridSize,
                                    TimelineZoom = beatmap.TimelineZoom,
                                    Countdown = beatmap.Countdown,
                                    CountdownOffset = beatmap.CountdownOffset,
                                    MaxCombo = beatmap.MaxCombo,
                                    Bookmarks = beatmap.Bookmarks,
                                    Ruleset = realm.Find<RulesetInfo>(beatmap.RulesetInfo.ShortName),
                                    Difficulty = new BeatmapDifficulty(beatmap.BaseDifficulty),
                                    Metadata = getBestMetadata(beatmap.Metadata, beatmapSet.Metadata),
                                    BeatmapSet = realmBeatmapSet,
                                };

                                realmBeatmapSet.Beatmaps.Add(realmBeatmap);
                            }

                            realm.Add(realmBeatmapSet);
                        }

                        transaction.Commit();
                        Logger.Log($"Successfully migrated {existingBeatmapSets.Count} beatmaps to realm", LoggingTarget.Database);
                    }
                }

                ef.Context.RemoveRange(existingBeatmapSets);
                // Intentionally don't clean up the files, so they don't get purged by EF.
            }
        }

        private BeatmapMetadata getBestMetadata(EFBeatmapMetadata? beatmapMetadata, EFBeatmapMetadata? beatmapSetMetadata)
        {
            var metadata = beatmapMetadata ?? beatmapSetMetadata ?? new EFBeatmapMetadata();

            return new BeatmapMetadata
            {
                Title = metadata.Title,
                TitleUnicode = metadata.TitleUnicode,
                Artist = metadata.Artist,
                ArtistUnicode = metadata.ArtistUnicode,
                Author = new RealmUser
                {
                    OnlineID = metadata.Author.Id,
                    Username = metadata.Author.Username,
                },
                Source = metadata.Source,
                Tags = metadata.Tags,
                PreviewTime = metadata.PreviewTime,
                AudioFile = metadata.AudioFile,
                BackgroundFile = metadata.BackgroundFile,
                AuthorString = metadata.AuthorString,
            };
        }

        private void migrateScores(DatabaseWriteUsage db)
        {
            // can be removed 20220730.
            List<EFScoreInfo> existingScores = db.Context.ScoreInfo
                                                 .Include(s => s.Ruleset)
                                                 .Include(s => s.BeatmapInfo)
                                                 .Include(s => s.Files)
                                                 .ThenInclude(f => f.FileInfo)
                                                 .ToList();

            Logger.Log("Beginning scores migration to realm", LoggingTarget.Database);

            // previous entries in EF are removed post migration.
            if (!existingScores.Any())
            {
                Logger.Log("No scores found to migrate", LoggingTarget.Database);
                return;
            }

            using (var realm = realmContextFactory.CreateContext())
            {
                Logger.Log($"Found {existingScores.Count} scores in EF", LoggingTarget.Database);

                if (!hasTakenBackup)
                {
                    string migration = $"before_score_migration_{DateTimeOffset.UtcNow.ToUnixTimeSeconds()}";

                    efContextFactory.CreateBackup($"client.{migration}.db");
                    realmContextFactory.CreateBackup($"client.{migration}.realm");

                    hasTakenBackup = true;
                }

                // only migrate data if the realm database is empty.
                if (realm.All<ScoreInfo>().Any())
                {
                    Logger.Log("Skipping migration as realm already has scores loaded", LoggingTarget.Database);
                }
                else
                {
                    using (var transaction = realm.BeginWrite())
                    {
                        foreach (var score in existingScores)
                        {
                            var realmScore = new ScoreInfo
                            {
                                Hash = score.Hash,
                                DeletePending = score.DeletePending,
                                OnlineID = score.OnlineID ?? -1,
                                ModsJson = score.ModsJson,
                                StatisticsJson = score.StatisticsJson,
                                User = score.User,
                                TotalScore = score.TotalScore,
                                MaxCombo = score.MaxCombo,
                                Accuracy = score.Accuracy,
                                HasReplay = ((IScoreInfo)score).HasReplay,
                                Date = score.Date,
                                PP = score.PP,
                                BeatmapInfo = realm.All<BeatmapInfo>().First(b => b.Hash == score.BeatmapInfo.Hash),
                                Ruleset = realm.Find<RulesetInfo>(score.Ruleset.ShortName),
                                Rank = score.Rank,
                                HitEvents = score.HitEvents,
                                Passed = score.Passed,
                                Combo = score.Combo,
                                Position = score.Position,
                                Statistics = score.Statistics,
                                Mods = score.Mods,
                                APIMods = score.APIMods,
                            };

                            migrateFiles(score, realm, realmScore);

                            realm.Add(realmScore);
                        }

                        transaction.Commit();
                        Logger.Log($"Successfully migrated {existingScores.Count} scores to realm", LoggingTarget.Database);
                    }
                }

                db.Context.RemoveRange(existingScores);
                // Intentionally don't clean up the files, so they don't get purged by EF.
            }
        }

        private void migrateSkins(DatabaseWriteUsage db)
        {
            // can be removed 20220530.
            var existingSkins = db.Context.SkinInfo
                                  .Include(s => s.Files)
                                  .ThenInclude(f => f.FileInfo)
                                  .ToList();

            // previous entries in EF are removed post migration.
            if (!existingSkins.Any())
                return;

            var userSkinChoice = config.GetBindable<string>(OsuSetting.Skin);
            int.TryParse(userSkinChoice.Value, out int userSkinInt);

            switch (userSkinInt)
            {
                case EFSkinInfo.DEFAULT_SKIN:
                    userSkinChoice.Value = SkinInfo.DEFAULT_SKIN.ToString();
                    break;

                case EFSkinInfo.CLASSIC_SKIN:
                    userSkinChoice.Value = SkinInfo.CLASSIC_SKIN.ToString();
                    break;
            }

            using (var realm = realmContextFactory.CreateContext())
            using (var transaction = realm.BeginWrite())
            {
                // only migrate data if the realm database is empty.
                // note that this cannot be written as: `realm.All<SkinInfo>().All(s => s.Protected)`, because realm does not support `.All()`.
                if (!realm.All<SkinInfo>().Any(s => !s.Protected))
                {
                    Logger.Log($"Migrating {existingSkins.Count} skins", LoggingTarget.Database);

                    foreach (var skin in existingSkins)
                    {
                        var realmSkin = new SkinInfo
                        {
                            Name = skin.Name,
                            Creator = skin.Creator,
                            Hash = skin.Hash,
                            Protected = false,
                            InstantiationInfo = skin.InstantiationInfo,
                        };

                        migrateFiles(skin, realm, realmSkin);

                        realm.Add(realmSkin);

                        if (skin.ID == userSkinInt)
                            userSkinChoice.Value = realmSkin.ID.ToString();
                    }
                }

                db.Context.RemoveRange(existingSkins);
                // Intentionally don't clean up the files, so they don't get purged by EF.

                transaction.Commit();
            }
        }

        private static void migrateFiles<T>(IHasFiles<T> fileSource, Realm realm, IHasRealmFiles realmObject) where T : INamedFileInfo
        {
            foreach (var file in fileSource.Files)
            {
                var realmFile = realm.Find<RealmFile>(file.FileInfo.Hash);

                if (realmFile == null)
                    realm.Add(realmFile = new RealmFile { Hash = file.FileInfo.Hash });

                realmObject.Files.Add(new RealmNamedFileUsage(realmFile, file.Filename));
            }
        }

        private void migrateSettings(DatabaseWriteUsage db)
        {
            // migrate ruleset settings. can be removed 20220315.
            var existingSettings = db.Context.DatabasedSetting.ToList();

            // previous entries in EF are removed post migration.
            if (!existingSettings.Any())
                return;

            Logger.Log("Beginning settings migration to realm", LoggingTarget.Database);

            using (var realm = realmContextFactory.CreateContext())
            using (var transaction = realm.BeginWrite())
            {
                // only migrate data if the realm database is empty.
                if (!realm.All<RealmRulesetSetting>().Any())
                {
                    Logger.Log($"Migrating {existingSettings.Count} settings", LoggingTarget.Database);

                    foreach (var dkb in existingSettings)
                    {
                        if (dkb.RulesetID == null)
                            continue;

                        string? shortName = getRulesetShortNameFromLegacyID(dkb.RulesetID.Value);

                        if (string.IsNullOrEmpty(shortName))
                            continue;

                        realm.Add(new RealmRulesetSetting
                        {
                            Key = dkb.Key,
                            Value = dkb.StringValue,
                            RulesetName = shortName,
                            Variant = dkb.Variant ?? 0,
                        });
                    }
                }

                db.Context.RemoveRange(existingSettings);

                transaction.Commit();
            }
        }

        private string? getRulesetShortNameFromLegacyID(long rulesetId) =>
            efContextFactory.Get().RulesetInfo.FirstOrDefault(r => r.ID == rulesetId)?.ShortName;
    }
}