h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-12-14 13:22:55 +08:00
Code Issues Releases Wiki Activity

Merge pull request #18210 from peppy/realm-asycn-import-woes

Browse Source 
Fix realm refetch operations potentially being unsafe
This commit is contained in:
Dan Balasescu 2022-05-11 09:53:46 +09:00 committed by GitHub
commit 7473ff49cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 68 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
osu.Game.Tests/Database/BeatmapImporterTests.cs
View File

@ -136,6 +136,37 @@ namespace osu.Game.Tests.Database
});
}
[Test]
public void TestAddFileToAsyncImportedBeatmap()
{
RunTestWithRealm((realm, storage) =>
{
BeatmapSetInfo? detachedSet = null;
using (var importer = new BeatmapModelManager(realm, storage))
using (new RealmRulesetStore(realm, storage))
{
Task.Run(async () =>
{
Live<BeatmapSetInfo>? beatmapSet;
using (var reader = new ZipArchiveReader(TestResources.GetTestBeatmapStream()))
// ReSharper disable once AccessToDisposedClosure
beatmapSet = await importer.Import(reader);
Assert.NotNull(beatmapSet);
Debug.Assert(beatmapSet != null);
// Intentionally detach on async thread as to not trigger a refresh on the main thread.
beatmapSet.PerformRead(s => detachedSet = s.Detach());
}).WaitSafely();
Debug.Assert(detachedSet != null);
importer.AddFile(detachedSet, new MemoryStream(), "test");
}
});
}
[Test]
public void TestImportBeatmapThenCleanup()
{

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

@ -344,6 +344,26 @@ namespace osu.Game.Database
}
}
/// <summary>
/// Write changes to realm.
/// </summary>
/// <param name="action">The work to run.</param>
public T Write<T>(Func<Realm, T> action)
{
if (ThreadSafety.IsUpdateThread)
{
total_writes_update.Value++;
return Realm.Write(action);
}
else
{
total_writes_async.Value++;
using (var realm = getRealmInstance())
return realm.Write(action);
}
}
/// <summary>
/// Write changes to realm.
/// </summary>

25
osu.Game/Stores/RealmArchiveModelManager.cs
View File

@ -45,11 +45,16 @@ namespace osu.Game.Stores
// This method should be removed as soon as all the surrounding pieces support non-detached operations.
if (!item.IsManaged)
{
var managed = Realm.Realm.Find<TModel>(item.ID);
managed.Realm.Write(() => operation(managed));
// Importantly, begin the realm write *before* re-fetching, else the update realm may not be in a consistent state
// (ie. if an async import finished very recently).
Realm.Realm.Write(realm =>
{
var managed = realm.Find<TModel>(item.ID);
operation(managed);
item.Files.Clear();
item.Files.AddRange(managed.Files.Detach());
item.Files.Clear();
item.Files.AddRange(managed.Files.Detach());
});
}
else
operation(item);
@ -165,7 +170,9 @@ namespace osu.Game.Stores
public bool Delete(TModel item)
{
return Realm.Run(realm =>
// Importantly, begin the realm write *before* re-fetching, else the update realm may not be in a consistent state
// (ie. if an async import finished very recently).
return Realm.Write(realm =>
{
if (!item.IsManaged)
item = realm.Find<TModel>(item.ID);
@ -173,14 +180,16 @@ namespace osu.Game.Stores
if (item?.DeletePending != false)
return false;
realm.Write(r => item.DeletePending = true);
item.DeletePending = true;
return true;
});
}
public void Undelete(TModel item)
{
Realm.Run(realm =>
// Importantly, begin the realm write *before* re-fetching, else the update realm may not be in a consistent state
// (ie. if an async import finished very recently).
Realm.Write(realm =>
{
if (!item.IsManaged)
item = realm.Find<TModel>(item.ID);
@ -188,7 +197,7 @@ namespace osu.Game.Stores
if (item?.DeletePending != true)
return;
realm.Write(r => item.DeletePending = false);
item.DeletePending = false;
});
}