sim1222/osukey
1
1
Fork 0
mirror of https://github.com/osukey/osukey.git synced 2025-05-07 06:37:18 +09:00
Code Issues Packages Projects Releases Wiki Activity

Ensure all async writes are completed before realm is disposed

Browse Source
This commit is contained in:
Dean Herbert 2022-06-27 19:20:28 +09:00
parent 1fc4fa6820
commit c39c99bd43
1 changed files with 31 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
osu.Game/Database/RealmAccess.cs
View File

@ -388,26 +388,43 @@ namespace osu.Game.Database
} }
} }
private readonly CountdownEvent pendingAsyncWrites = new CountdownEvent(0);
/// <summary> /// <summary>
/// Write changes to realm asynchronously, guaranteeing order of execution. /// Write changes to realm asynchronously, guaranteeing order of execution.
/// </summary> /// </summary>
/// <param name="action">The work to run.</param> /// <param name="action">The work to run.</param>
public Task WriteAsync(Action<Realm> action) public Task WriteAsync(Action<Realm> action)
{ {
// Regardless of calling Realm.GetInstance or Realm.GetInstanceAsync, there is a blocking overhead on retrieval. // Required to ensure the write is tracked and accounted for before disposal.
// Adding a forced Task.Run resolves this. // Can potentially be avoided if we have a need to do so in the future.
if (!ThreadSafety.IsUpdateThread)
throw new InvalidOperationException(@$"{nameof(WriteAsync)} must be called from the update thread.");
return Task.Run(async () => lock (realmLock)
{ {
total_writes_async.Value++; // CountdownEvent will fail if already at zero.
if (!pendingAsyncWrites.TryAddCount())
pendingAsyncWrites.Reset(1);
// Not attempting to use Realm.GetInstanceAsync as there's seemingly no benefit to us (for now) and it adds complexity due to locking // Regardless of calling Realm.GetInstance or Realm.GetInstanceAsync, there is a blocking overhead on retrieval.
// concerns in getRealmInstance(). On a quick check, it looks to be more suited to cases where realm is connecting to an online sync // Adding a forced Task.Run resolves this.
// server, which we don't use. May want to report upstream or revisit in the future. var writeTask = Task.Run(async () =>
using (var realm = getRealmInstance()) {
// ReSharper disable once AccessToDisposedClosure (WriteAsync should be marked as [InstantHandle]). total_writes_async.Value++;
await realm.WriteAsync(() => action(realm));
}); // Not attempting to use Realm.GetInstanceAsync as there's seemingly no benefit to us (for now) and it adds complexity due to locking
// concerns in getRealmInstance(). On a quick check, it looks to be more suited to cases where realm is connecting to an online sync
// server, which we don't use. May want to report upstream or revisit in the future.
using (var realm = getRealmInstance())
// ReSharper disable once AccessToDisposedClosure (WriteAsync should be marked as [InstantHandle]).
await realm.WriteAsync(() => action(realm));
pendingAsyncWrites.Signal();
});
return writeTask;
}
} }
/// <summary> /// <summary>
@ -910,6 +927,9 @@ namespace osu.Game.Database
public void Dispose() public void Dispose()
{ {
if (!pendingAsyncWrites.Wait(10000))
Logger.Log("Realm took too long waiting on pending async writes", level: LogLevel.Error);
lock (realmLock) lock (realmLock)
{ {
updateRealm?.Dispose(); updateRealm?.Dispose();