From 1d52231d4fb1ad53e3052c93c09138b5fe7c86cd Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Wed, 18 Jul 2018 16:43:46 +0900
Subject: [PATCH] Remove SingletonContextFactory

It is dangerous to use this as it doesn't correctly handle contexts and can cause issues that will never actually arise in normal execution.
---
 .../Visual/TestCasePlaySongSelect.cs          |  7 ++++++-
 osu.Game/Database/DatabaseContextFactory.cs   | 10 +++++-----
 osu.Game/Database/SingletonContextFactory.cs  | 19 -------------------
 osu.Game/OsuGameBase.cs                       |  2 +-
 osu.Game/Tests/Platform/TestStorage.cs        |  8 +++-----
 5 files changed, 15 insertions(+), 31 deletions(-)
 delete mode 100644 osu.Game/Database/SingletonContextFactory.cs

diff --git a/osu.Game.Tests/Visual/TestCasePlaySongSelect.cs b/osu.Game.Tests/Visual/TestCasePlaySongSelect.cs
index dab7f7e037..4afb76a7e2 100644
--- a/osu.Game.Tests/Visual/TestCasePlaySongSelect.cs
+++ b/osu.Game.Tests/Visual/TestCasePlaySongSelect.cs
@@ -62,7 +62,12 @@ namespace osu.Game.Tests.Visual
             var storage = new TestStorage(@"TestCasePlaySongSelect");
 
             // this is by no means clean. should be replacing inside of OsuGameBase somehow.
-            IDatabaseContextFactory factory = new SingletonContextFactory(new OsuDbContext());
+            DatabaseContextFactory factory = new DatabaseContextFactory(storage);
+
+            factory.ResetDatabase();
+
+            using (var usage = factory.Get())
+                usage.Migrate();
 
             Dependencies.Cache(rulesets = new RulesetStore(factory));
             Dependencies.Cache(manager = new BeatmapManager(storage, factory, rulesets, null, null)
diff --git a/osu.Game/Database/DatabaseContextFactory.cs b/osu.Game/Database/DatabaseContextFactory.cs
index 5160239c38..c20d4569f6 100644
--- a/osu.Game/Database/DatabaseContextFactory.cs
+++ b/osu.Game/Database/DatabaseContextFactory.cs
@@ -11,7 +11,7 @@ namespace osu.Game.Database
 {
     public class DatabaseContextFactory : IDatabaseContextFactory
     {
-        private readonly GameHost host;
+        private readonly Storage storage;
 
         private const string database_name = @"client";
 
@@ -26,9 +26,9 @@ namespace osu.Game.Database
 
         private IDbContextTransaction currentWriteTransaction;
 
-        public DatabaseContextFactory(GameHost host)
+        public DatabaseContextFactory(Storage storage)
         {
-            this.host = host;
+            this.storage = storage;
             recycleThreadContexts();
         }
 
@@ -117,7 +117,7 @@ namespace osu.Game.Database
 
         private void recycleThreadContexts() => threadContexts = new ThreadLocal<OsuDbContext>(CreateContext);
 
-        protected virtual OsuDbContext CreateContext() => new OsuDbContext(host.Storage.GetDatabaseConnectionString(database_name))
+        protected virtual OsuDbContext CreateContext() => new OsuDbContext(storage.GetDatabaseConnectionString(database_name))
         {
             Database = { AutoTransactionsEnabled = false }
         };
@@ -129,7 +129,7 @@ namespace osu.Game.Database
                 recycleThreadContexts();
                 GC.Collect();
                 GC.WaitForPendingFinalizers();
-                host.Storage.DeleteDatabase(database_name);
+                storage.DeleteDatabase(database_name);
             }
         }
     }
diff --git a/osu.Game/Database/SingletonContextFactory.cs b/osu.Game/Database/SingletonContextFactory.cs
deleted file mode 100644
index a7158c0583..0000000000
--- a/osu.Game/Database/SingletonContextFactory.cs
+++ /dev/null
@@ -1,19 +0,0 @@
-// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
-// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
-
-namespace osu.Game.Database
-{
-    public class SingletonContextFactory : IDatabaseContextFactory
-    {
-        private readonly OsuDbContext context;
-
-        public SingletonContextFactory(OsuDbContext context)
-        {
-            this.context = context;
-        }
-
-        public OsuDbContext Get() => context;
-
-        public DatabaseWriteUsage GetForWrite(bool withTransaction = true) => new DatabaseWriteUsage(context, null) { IsTransactionLeader = true };
-    }
-}
diff --git a/osu.Game/OsuGameBase.cs b/osu.Game/OsuGameBase.cs
index a9b74d6740..63cc883844 100644
--- a/osu.Game/OsuGameBase.cs
+++ b/osu.Game/OsuGameBase.cs
@@ -107,7 +107,7 @@ namespace osu.Game
         {
             Resources.AddStore(new DllResourceStore(@"osu.Game.Resources.dll"));
 
-            dependencies.Cache(contextFactory = new DatabaseContextFactory(Host));
+            dependencies.Cache(contextFactory = new DatabaseContextFactory(Host.Storage));
 
             dependencies.Cache(new LargeTextureStore(new RawTextureLoaderStore(new NamespacedResourceStore<byte[]>(Resources, @"Textures"))));
 
diff --git a/osu.Game/Tests/Platform/TestStorage.cs b/osu.Game/Tests/Platform/TestStorage.cs
index 5b31c7b4d0..a6b6b5530d 100644
--- a/osu.Game/Tests/Platform/TestStorage.cs
+++ b/osu.Game/Tests/Platform/TestStorage.cs
@@ -7,13 +7,11 @@ namespace osu.Game.Tests.Platform
 {
     public class TestStorage : DesktopStorage
     {
-        public TestStorage(string baseName) : base(baseName, null)
+        public TestStorage(string baseName)
+            : base(baseName, null)
         {
         }
 
-        public override string GetDatabaseConnectionString(string name)
-        {
-            return "DataSource=:memory:";
-        }
+        public override string GetDatabaseConnectionString(string name) => "Data Source=" + GetUsablePathFor($"{(object)name}.db", true);
     }
 }