From 5197d0fa9e1afbc25f004b56413121a9637b386a Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Thu, 7 Jul 2022 17:32:48 +0900
Subject: [PATCH 1/3] Add automatic transaction handling to realm helper
 methods

---
 osu.Game.Tests/Database/RealmLiveTests.cs | 19 ++++++++++++
 osu.Game/Database/RealmExtensions.cs      | 35 ++++++++++++++++++++---
 2 files changed, 50 insertions(+), 4 deletions(-)

diff --git a/osu.Game.Tests/Database/RealmLiveTests.cs b/osu.Game.Tests/Database/RealmLiveTests.cs
index a50eb22c67..d15e038723 100644
--- a/osu.Game.Tests/Database/RealmLiveTests.cs
+++ b/osu.Game.Tests/Database/RealmLiveTests.cs
@@ -59,6 +59,25 @@ namespace osu.Game.Tests.Database
             });
         }
 
+        [Test]
+        public void TestNestedWriteCalls()
+        {
+            RunTestWithRealm((realm, _) =>
+            {
+                var beatmap = new BeatmapInfo(CreateRuleset(), new BeatmapDifficulty(), new BeatmapMetadata());
+
+                var liveBeatmap = beatmap.ToLive(realm);
+
+                realm.Run(r =>
+                    r.Write(_ =>
+                        r.Write(_ =>
+                            r.Add(beatmap)))
+                );
+
+                Assert.IsFalse(liveBeatmap.PerformRead(l => l.Hidden));
+            });
+        }
+
         [Test]
         public void TestAccessAfterAttach()
         {
diff --git a/osu.Game/Database/RealmExtensions.cs b/osu.Game/Database/RealmExtensions.cs
index 73e9f16d33..2cd81b6af1 100644
--- a/osu.Game/Database/RealmExtensions.cs
+++ b/osu.Game/Database/RealmExtensions.cs
@@ -8,18 +8,45 @@ namespace osu.Game.Database
 {
     public static class RealmExtensions
     {
+        /// <summary>
+        /// Perform a write operation against the provided realm instance.
+        /// </summary>
+        /// <remarks>
+        /// This will automatically start a transaction if not already in one.
+        /// </remarks>
+        /// <param name="realm">The realm to operate on.</param>
+        /// <param name="function">The write operation to run.</param>
         public static void Write(this Realm realm, Action<Realm> function)
         {
-            using var transaction = realm.BeginWrite();
+            Transaction? transaction = null;
+
+            if (!realm.IsInTransaction)
+                transaction = realm.BeginWrite();
+
             function(realm);
-            transaction.Commit();
+
+            transaction?.Commit();
         }
 
+        /// <summary>
+        /// Perform a write operation against the provided realm instance.
+        /// </summary>
+        /// <remarks>
+        /// This will automatically start a transaction if not already in one.
+        /// </remarks>
+        /// <param name="realm">The realm to operate on.</param>
+        /// <param name="function">The write operation to run.</param>
         public static T Write<T>(this Realm realm, Func<Realm, T> function)
         {
-            using var transaction = realm.BeginWrite();
+            Transaction? transaction = null;
+
+            if (!realm.IsInTransaction)
+                transaction = realm.BeginWrite();
+
             var result = function(realm);
-            transaction.Commit();
+
+            transaction?.Commit();
+
             return result;
         }
 

From ac216d94a81db5e896b13cebf997b0d00d50c986 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Thu, 7 Jul 2022 18:15:15 +0900
Subject: [PATCH 2/3] Fix transaction not being disposed

---
 osu.Game.Tests/Database/RealmLiveTests.cs | 18 +++++++++++++
 osu.Game/Database/RealmExtensions.cs      | 32 ++++++++++++++++-------
 2 files changed, 41 insertions(+), 9 deletions(-)

diff --git a/osu.Game.Tests/Database/RealmLiveTests.cs b/osu.Game.Tests/Database/RealmLiveTests.cs
index d15e038723..aec8c0b1e1 100644
--- a/osu.Game.Tests/Database/RealmLiveTests.cs
+++ b/osu.Game.Tests/Database/RealmLiveTests.cs
@@ -59,6 +59,24 @@ namespace osu.Game.Tests.Database
             });
         }
 
+        [Test]
+        public void TestFailedWritePerformsRollback()
+        {
+            RunTestWithRealm((realm, _) =>
+            {
+                Assert.Throws<InvalidOperationException>(() =>
+                {
+                    realm.Write(r =>
+                    {
+                        r.Add(new BeatmapInfo(CreateRuleset(), new BeatmapDifficulty(), new BeatmapMetadata()));
+                        throw new InvalidOperationException();
+                    });
+                });
+
+                Assert.That(realm.Run(r => r.All<BeatmapInfo>()), Is.Empty);
+            });
+        }
+
         [Test]
         public void TestNestedWriteCalls()
         {
diff --git a/osu.Game/Database/RealmExtensions.cs b/osu.Game/Database/RealmExtensions.cs
index 2cd81b6af1..13c4defb83 100644
--- a/osu.Game/Database/RealmExtensions.cs
+++ b/osu.Game/Database/RealmExtensions.cs
@@ -20,12 +20,19 @@ namespace osu.Game.Database
         {
             Transaction? transaction = null;
 
-            if (!realm.IsInTransaction)
-                transaction = realm.BeginWrite();
+            try
+            {
+                if (!realm.IsInTransaction)
+                    transaction = realm.BeginWrite();
 
-            function(realm);
+                function(realm);
 
-            transaction?.Commit();
+                transaction?.Commit();
+            }
+            finally
+            {
+                transaction?.Dispose();
+            }
         }
 
         /// <summary>
@@ -40,14 +47,21 @@ namespace osu.Game.Database
         {
             Transaction? transaction = null;
 
-            if (!realm.IsInTransaction)
-                transaction = realm.BeginWrite();
+            try
+            {
+                if (!realm.IsInTransaction)
+                    transaction = realm.BeginWrite();
 
-            var result = function(realm);
+                var result = function(realm);
 
-            transaction?.Commit();
+                transaction?.Commit();
 
-            return result;
+                return result;
+            }
+            finally
+            {
+                transaction?.Dispose();
+            }
         }
 
         /// <summary>

From bf10f2db2ed2148ba47e6652c467e4c341a6d654 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Thu, 7 Jul 2022 18:19:01 +0900
Subject: [PATCH 3/3] Add test coverage of nested rollback for good measure

---
 osu.Game.Tests/Database/RealmLiveTests.cs | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/osu.Game.Tests/Database/RealmLiveTests.cs b/osu.Game.Tests/Database/RealmLiveTests.cs
index aec8c0b1e1..3615cebe6a 100644
--- a/osu.Game.Tests/Database/RealmLiveTests.cs
+++ b/osu.Game.Tests/Database/RealmLiveTests.cs
@@ -77,6 +77,27 @@ namespace osu.Game.Tests.Database
             });
         }
 
+        [Test]
+        public void TestFailedNestedWritePerformsRollback()
+        {
+            RunTestWithRealm((realm, _) =>
+            {
+                Assert.Throws<InvalidOperationException>(() =>
+                {
+                    realm.Write(r =>
+                    {
+                        realm.Write(_ =>
+                        {
+                            r.Add(new BeatmapInfo(CreateRuleset(), new BeatmapDifficulty(), new BeatmapMetadata()));
+                            throw new InvalidOperationException();
+                        });
+                    });
+                });
+
+                Assert.That(realm.Run(r => r.All<BeatmapInfo>()), Is.Empty);
+            });
+        }
+
         [Test]
         public void TestNestedWriteCalls()
         {