Merge pull request #15519 from peppy/realm-ruleset-store-thread-correctness

Start initialising `RealmRulesetStore` on startup
This commit is contained in:
Dan Balasescu 2021-11-08 17:08:25 +09:00 committed by GitHub
commit 68d6a5f2c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 70 additions and 57 deletions

View File

@ -40,6 +40,7 @@ using osu.Game.Rulesets;
using osu.Game.Rulesets.Mods; using osu.Game.Rulesets.Mods;
using osu.Game.Scoring; using osu.Game.Scoring;
using osu.Game.Skinning; using osu.Game.Skinning;
using osu.Game.Stores;
using osu.Game.Utils; using osu.Game.Utils;
using RuntimeInfo = osu.Framework.RuntimeInfo; using RuntimeInfo = osu.Framework.RuntimeInfo;
@ -160,6 +161,8 @@ namespace osu.Game
private readonly BindableNumber<double> globalTrackVolumeAdjust = new BindableNumber<double>(GLOBAL_TRACK_VOLUME_ADJUST); private readonly BindableNumber<double> globalTrackVolumeAdjust = new BindableNumber<double>(GLOBAL_TRACK_VOLUME_ADJUST);
private RealmRulesetStore realmRulesetStore;
public OsuGameBase() public OsuGameBase()
{ {
UseDevelopmentServer = DebugUtils.IsDebugBuild; UseDevelopmentServer = DebugUtils.IsDebugBuild;
@ -231,6 +234,11 @@ namespace osu.Game
dependencies.Cache(ScoreManager = new ScoreManager(RulesetStore, () => BeatmapManager, Storage, API, contextFactory, Scheduler, Host, () => difficultyCache, LocalConfig)); dependencies.Cache(ScoreManager = new ScoreManager(RulesetStore, () => BeatmapManager, Storage, API, contextFactory, Scheduler, Host, () => difficultyCache, LocalConfig));
dependencies.Cache(BeatmapManager = new BeatmapManager(Storage, contextFactory, RulesetStore, API, Audio, Resources, Host, defaultBeatmap, performOnlineLookups: true)); dependencies.Cache(BeatmapManager = new BeatmapManager(Storage, contextFactory, RulesetStore, API, Audio, Resources, Host, defaultBeatmap, performOnlineLookups: true));
// the following realm components are not actively used yet, but initialised and kept up to date for initial testing.
realmRulesetStore = new RealmRulesetStore(realmFactory, Storage);
dependencies.Cache(realmRulesetStore);
// this should likely be moved to ArchiveModelManager when another case appears where it is necessary // this should likely be moved to ArchiveModelManager when another case appears where it is necessary
// to have inter-dependent model managers. this could be obtained with an IHasForeign<T> interface to // to have inter-dependent model managers. this could be obtained with an IHasForeign<T> interface to
// allow lookups to be done on the child (ScoreManager in this case) to perform the cascading delete. // allow lookups to be done on the child (ScoreManager in this case) to perform the cascading delete.
@ -512,6 +520,8 @@ namespace osu.Game
LocalConfig?.Dispose(); LocalConfig?.Dispose();
contextFactory?.FlushConnections(); contextFactory?.FlushConnections();
realmRulesetStore?.Dispose();
realmFactory?.Dispose(); realmFactory?.Dispose();
} }
} }

View File

@ -102,75 +102,78 @@ namespace osu.Game.Stores
private void addMissingRulesets() private void addMissingRulesets()
{ {
realmFactory.Context.Write(realm => using (var context = realmFactory.CreateContext())
{ {
var rulesets = realm.All<RealmRuleset>(); context.Write(realm =>
List<Ruleset> instances = loadedAssemblies.Values
.Select(r => Activator.CreateInstance(r) as Ruleset)
.Where(r => r != null)
.Select(r => r.AsNonNull())
.ToList();
// add all legacy rulesets first to ensure they have exclusive choice of primary key.
foreach (var r in instances.Where(r => r is ILegacyRuleset))
{ {
if (realm.All<RealmRuleset>().FirstOrDefault(rr => rr.OnlineID == r.RulesetInfo.ID) == null) var rulesets = realm.All<RealmRuleset>();
realm.Add(new RealmRuleset(r.RulesetInfo.ShortName, r.RulesetInfo.Name, r.RulesetInfo.InstantiationInfo, r.RulesetInfo.ID));
}
// add any other rulesets which have assemblies present but are not yet in the database. List<Ruleset> instances = loadedAssemblies.Values
foreach (var r in instances.Where(r => !(r is ILegacyRuleset))) .Select(r => Activator.CreateInstance(r) as Ruleset)
{ .Where(r => r != null)
if (rulesets.FirstOrDefault(ri => ri.InstantiationInfo.Equals(r.RulesetInfo.InstantiationInfo, StringComparison.Ordinal)) == null) .Select(r => r.AsNonNull())
.ToList();
// add all legacy rulesets first to ensure they have exclusive choice of primary key.
foreach (var r in instances.Where(r => r is ILegacyRuleset))
{ {
var existingSameShortName = rulesets.FirstOrDefault(ri => ri.ShortName == r.RulesetInfo.ShortName); if (realm.All<RealmRuleset>().FirstOrDefault(rr => rr.OnlineID == r.RulesetInfo.ID) == null)
if (existingSameShortName != null)
{
// even if a matching InstantiationInfo was not found, there may be an existing ruleset with the same ShortName.
// this generally means the user or ruleset provider has renamed their dll but the underlying ruleset is *likely* the same one.
// in such cases, update the instantiation info of the existing entry to point to the new one.
existingSameShortName.InstantiationInfo = r.RulesetInfo.InstantiationInfo;
}
else
realm.Add(new RealmRuleset(r.RulesetInfo.ShortName, r.RulesetInfo.Name, r.RulesetInfo.InstantiationInfo, r.RulesetInfo.ID)); realm.Add(new RealmRuleset(r.RulesetInfo.ShortName, r.RulesetInfo.Name, r.RulesetInfo.InstantiationInfo, r.RulesetInfo.ID));
} }
}
List<RealmRuleset> detachedRulesets = new List<RealmRuleset>(); // add any other rulesets which have assemblies present but are not yet in the database.
foreach (var r in instances.Where(r => !(r is ILegacyRuleset)))
// perform a consistency check and detach final rulesets from realm for cross-thread runtime usage.
foreach (var r in rulesets)
{
try
{ {
var type = Type.GetType(r.InstantiationInfo); if (rulesets.FirstOrDefault(ri => ri.InstantiationInfo.Equals(r.RulesetInfo.InstantiationInfo, StringComparison.Ordinal)) == null)
{
var existingSameShortName = rulesets.FirstOrDefault(ri => ri.ShortName == r.RulesetInfo.ShortName);
if (type == null) if (existingSameShortName != null)
throw new InvalidOperationException(@"Type resolution failure."); {
// even if a matching InstantiationInfo was not found, there may be an existing ruleset with the same ShortName.
var rInstance = (Activator.CreateInstance(type) as Ruleset)?.RulesetInfo; // this generally means the user or ruleset provider has renamed their dll but the underlying ruleset is *likely* the same one.
// in such cases, update the instantiation info of the existing entry to point to the new one.
if (rInstance == null) existingSameShortName.InstantiationInfo = r.RulesetInfo.InstantiationInfo;
throw new InvalidOperationException(@"Instantiation failure."); }
else
r.Name = rInstance.Name; realm.Add(new RealmRuleset(r.RulesetInfo.ShortName, r.RulesetInfo.Name, r.RulesetInfo.InstantiationInfo, r.RulesetInfo.ID));
r.ShortName = rInstance.ShortName; }
r.InstantiationInfo = rInstance.InstantiationInfo;
r.Available = true;
detachedRulesets.Add(r.Clone());
} }
catch (Exception ex)
List<RealmRuleset> detachedRulesets = new List<RealmRuleset>();
// perform a consistency check and detach final rulesets from realm for cross-thread runtime usage.
foreach (var r in rulesets)
{ {
r.Available = false; try
Logger.Log($"Could not load ruleset {r}: {ex.Message}"); {
} var type = Type.GetType(r.InstantiationInfo);
}
availableRulesets.AddRange(detachedRulesets); if (type == null)
}); throw new InvalidOperationException(@"Type resolution failure.");
var rInstance = (Activator.CreateInstance(type) as Ruleset)?.RulesetInfo;
if (rInstance == null)
throw new InvalidOperationException(@"Instantiation failure.");
r.Name = rInstance.Name;
r.ShortName = rInstance.ShortName;
r.InstantiationInfo = rInstance.InstantiationInfo;
r.Available = true;
detachedRulesets.Add(r.Clone());
}
catch (Exception ex)
{
r.Available = false;
Logger.Log($"Could not load ruleset {r}: {ex.Message}");
}
}
availableRulesets.AddRange(detachedRulesets);
});
}
} }
private void loadFromAppDomain() private void loadFromAppDomain()