1
0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-13 05:48:35 +00:00

Profile editor - Fixed some race conditions with active module override

This commit is contained in:
SpoinkyNL 2020-08-25 20:40:19 +02:00
parent ccd04494f4
commit 0beae810ea
4 changed files with 66 additions and 37 deletions

View File

@ -8,11 +8,6 @@ namespace Artemis.Core.Services.Interfaces
/// </summary>
public interface IModuleService : IArtemisService
{
/// <summary>
/// Gets whether an override is currently being applied
/// </summary>
bool ApplyingOverride { get; }
/// <summary>
/// Gets the current active module override. If set, all other modules are deactivated and only the
/// <see cref="ActiveModuleOverride" /> is active.

View File

@ -6,6 +6,7 @@ using System.Threading;
using System.Threading.Tasks;
using System.Timers;
using Artemis.Core.Events;
using Artemis.Core.Exceptions;
using Artemis.Core.Plugins.Modules;
using Artemis.Core.Services.Interfaces;
using Artemis.Core.Services.Storage.Interfaces;
@ -17,6 +18,7 @@ namespace Artemis.Core.Services
{
internal class ModuleService : IModuleService
{
private static readonly SemaphoreSlim ActiveModuleSemaphore = new SemaphoreSlim(1, 1);
private readonly ILogger _logger;
private readonly IModuleRepository _moduleRepository;
private readonly IPluginService _pluginService;
@ -37,7 +39,6 @@ namespace Artemis.Core.Services
PopulatePriorities();
}
public bool ApplyingOverride { get; private set; }
public Module ActiveModuleOverride { get; private set; }
public async Task SetActiveModuleOverride(Module overrideModule)
@ -45,42 +46,43 @@ namespace Artemis.Core.Services
if (ActiveModuleOverride == overrideModule)
return;
if (!await ActiveModuleSemaphore.WaitAsync(TimeSpan.FromSeconds(10)))
throw new ArtemisCoreException("Timed out while acquiring active module lock");
try
{
// Not the cleanest way but locks don't work async and I cba with a mutex
while (ApplyingOverride)
await Task.Delay(50);
ApplyingOverride = true;
ActiveModuleOverride = overrideModule;
// If set to null, resume regular activation
if (ActiveModuleOverride == null)
{
await UpdateModuleActivation();
_logger.Information("Cleared active module override");
return;
}
// If a module was provided, activate it and deactivate everything else
var modules = _pluginService.GetPluginsOfType<Module>().ToList();
var deactivationTasks = new List<Task>();
var tasks = new List<Task>();
foreach (var module in modules)
{
if (module != ActiveModuleOverride)
deactivationTasks.Add(DeactivateModule(module, true));
tasks.Add(DeactivateModule(module, true));
}
await Task.WhenAll(deactivationTasks);
if (!ActiveModuleOverride.IsActivated)
await ActivateModule(ActiveModuleOverride, true);
tasks.Add(ActivateModule(ActiveModuleOverride, true));
await Task.WhenAll(tasks);
_logger.Information($"Set active module override to {ActiveModuleOverride.DisplayName}");
}
finally
{
ApplyingOverride = false;
ActiveModuleSemaphore.Release();
// With the semaphore released, trigger an update with the override was cleared
if (ActiveModuleOverride == null)
await UpdateModuleActivation();
}
}
@ -89,25 +91,35 @@ namespace Artemis.Core.Services
if (ActiveModuleOverride != null)
return;
var stopwatch = new Stopwatch();
stopwatch.Start();
if (!await ActiveModuleSemaphore.WaitAsync(TimeSpan.FromSeconds(10)))
throw new ArtemisCoreException("Timed out while acquiring active module lock");
var modules = _pluginService.GetPluginsOfType<Module>().ToList();
var tasks = new List<Task>();
foreach (var module in modules)
try
{
var shouldBeActivated = module.EvaluateActivationRequirements();
if (shouldBeActivated && !module.IsActivated)
tasks.Add(ActivateModule(module, false));
else if (!shouldBeActivated && module.IsActivated)
tasks.Add(DeactivateModule(module, false));
var stopwatch = new Stopwatch();
stopwatch.Start();
var modules = _pluginService.GetPluginsOfType<Module>().ToList();
var tasks = new List<Task>();
foreach (var module in modules)
{
var shouldBeActivated = module.EvaluateActivationRequirements();
if (shouldBeActivated && !module.IsActivated)
tasks.Add(ActivateModule(module, false));
else if (!shouldBeActivated && module.IsActivated)
tasks.Add(DeactivateModule(module, false));
}
await Task.WhenAll(tasks);
stopwatch.Stop();
if (stopwatch.ElapsedMilliseconds > 100 && !tasks.Any())
_logger.Warning("Activation requirements evaluation took too long: {moduleCount} module(s) in {elapsed}", modules.Count, stopwatch.Elapsed);
}
finally
{
ActiveModuleSemaphore.Release();
}
await Task.WhenAll(tasks);
stopwatch.Stop();
if (stopwatch.ElapsedMilliseconds > 100)
_logger.Warning("Activation requirements evaluation took too long: {moduleCount} module(s) in {elapsed}", modules.Count, stopwatch.Elapsed);
}
public void UpdateModulePriority(Module module, ModulePriorityCategory category, int priority)

View File

@ -8,10 +8,12 @@ using Artemis.Core.Plugins.Exceptions;
using Artemis.Core.Plugins.Modules;
using Artemis.Core.Services.Storage.Interfaces;
using Artemis.UI.Shared.Events;
using Artemis.UI.Shared.Exceptions;
using Artemis.UI.Shared.PropertyInput;
using Artemis.UI.Shared.Services.Interfaces;
using Ninject;
using Serilog;
using Stylet;
namespace Artemis.UI.Shared.Services
{
@ -20,10 +22,10 @@ namespace Artemis.UI.Shared.Services
private readonly ILogger _logger;
private readonly IProfileService _profileService;
private readonly List<PropertyInputRegistration> _registeredPropertyEditors;
private TimeSpan _currentTime;
private int _pixelsPerSecond;
private readonly object _selectedProfileElementLock = new object();
private readonly object _selectedProfileLock = new object();
private TimeSpan _currentTime;
private int _pixelsPerSecond;
public ProfileEditorService(IProfileService profileService, IKernel kernel, ILogger logger)
{
@ -72,11 +74,20 @@ namespace Artemis.UI.Shared.Services
if (SelectedProfile == profile)
return;
if (profile != null && !profile.IsActivated)
throw new ArtemisSharedUIException("Cannot change the selected profile to an inactive profile");
_logger.Verbose("ChangeSelectedProfile {profile}", profile);
ChangeSelectedProfileElement(null);
var profileElementEvent = new ProfileEventArgs(profile, SelectedProfile);
// Ensure there is never a deactivated profile as the selected profile
if (SelectedProfile != null)
SelectedProfile.Deactivated -= SelectedProfileOnDeactivated;
SelectedProfile = profile;
if (SelectedProfile != null)
SelectedProfile.Deactivated += SelectedProfileOnDeactivated;
OnSelectedProfileChanged(profileElementEvent);
UpdateProfilePreview();
@ -309,5 +320,10 @@ namespace Artemis.UI.Shared.Services
{
ProfilePreviewUpdated?.Invoke(this, EventArgs.Empty);
}
private void SelectedProfileOnDeactivated(object sender, EventArgs e)
{
Execute.PostToUIThread(() => ChangeSelectedProfile(null));
}
}
}

View File

@ -270,6 +270,9 @@ namespace Artemis.UI.Screens.ProfileEditor
{
Execute.PostToUIThread(async () =>
{
if (SelectedProfile == null)
return;
var changeTask = _profileService.ActivateProfileAnimated(SelectedProfile);
_profileEditorService.ChangeSelectedProfile(null);
var profile = await changeTask;
@ -279,7 +282,10 @@ namespace Artemis.UI.Screens.ProfileEditor
private void ModuleOnActiveProfileChanged(object sender, EventArgs e)
{
SelectedProfile = Profiles.FirstOrDefault(d => d.Id == Module.ActiveProfile.EntityId);
if (Module.ActiveProfile == null)
SelectedProfile = null;
else
SelectedProfile = Profiles.FirstOrDefault(d => d.Id == Module.ActiveProfile.EntityId);
}
private void LoadWorkspaceSettings()