Fix Check UI deadlock (#672)

* Fix Check UI deadlock

* Add region

* Niceties

CHANGELIST.md

@@ -16,6 +16,7 @@
 - Enable LibIRD for all .NET frameworks (Deterous)
 - Try updating PR check action
 - Fix config access persmission (Deterous)
+- Fix Check UI deadlock (Deterous)
 
 ### 3.1.2 (2024-02-27)
 

MPF.Core/UI/ViewModels/CheckDumpViewModel.cs

@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using System.ComponentModel;
 using System.IO;
 using System.Linq;
+using System.Threading.Tasks;
 using BinaryObjectScanner;
 using MPF.Core.Data;
 using MPF.Core.UI.ComboBoxItems;
@@ -179,6 +180,20 @@ namespace MPF.Core.UI.ViewModels
         }
         private bool _checkDumpButtonEnabled;
 
+        /// <summary>
+        /// Indicates the status of the cancel button
+        /// </summary>
+        public bool CancelButtonEnabled
+        {
+            get => _cancelButtonEnabled;
+            set
+            {
+                _cancelButtonEnabled = value;
+                TriggerPropertyChanged(nameof(CancelButtonEnabled));
+            }
+        }
+        private bool _cancelButtonEnabled;
+
         #endregion
 
         #region List Properties
@@ -243,6 +258,7 @@ namespace MPF.Core.UI.ViewModels
             MediaTypeComboBoxEnabled = true;
             DumpingProgramComboBoxEnabled = true;
             CheckDumpButtonEnabled = false;
+            CancelButtonEnabled = true;
 
             MediaTypes = [];
             Systems = RedumpSystemComboBoxItem.GenerateElements().ToList();
@@ -310,6 +326,38 @@ namespace MPF.Core.UI.ViewModels
 
         #endregion
 
+        #region UI Control
+
+        /// <summary>
+        /// Enables all UI elements that should be enabled
+        /// </summary>
+        private void EnableUIElements()
+        {
+            SystemTypeComboBoxEnabled = true;
+            InputPathTextBoxEnabled = true;
+            InputPathBrowseButtonEnabled = true;
+            DumpingProgramComboBoxEnabled = true;
+            PopulateMediaType();
+            CheckDumpButtonEnabled = ShouldEnableCheckDumpButton();
+            CancelButtonEnabled = true;
+        }
+
+        /// <summary>
+        /// Disables all UI elements
+        /// </summary>
+        private void DisableUIElements()
+        {
+            SystemTypeComboBoxEnabled = false;
+            InputPathTextBoxEnabled = false;
+            InputPathBrowseButtonEnabled = false;
+            MediaTypeComboBoxEnabled = false;
+            DumpingProgramComboBoxEnabled = false;
+            CheckDumpButtonEnabled = false;
+            CancelButtonEnabled = false;
+        }
+
+        #endregion
+
         #region Population
 
         /// <summary>
@@ -398,7 +446,7 @@ namespace MPF.Core.UI.ViewModels
         /// Performs MPF.Check functionality
         /// </summary>
         /// <returns>An error message if failed, otherwise string.Empty/null</returns>
-        public string? CheckDump(Func<SubmissionInfo?, (bool?, SubmissionInfo?)> processUserInfo)
+        public async Task<string?> CheckDump(Func<SubmissionInfo?, (bool?, SubmissionInfo?)> processUserInfo)
         {
             if (string.IsNullOrEmpty(InputPath))
                 return "Invalid Input path";
@@ -406,6 +454,11 @@ namespace MPF.Core.UI.ViewModels
             if (!File.Exists(this.InputPath!.Trim('"')))
                 return "Input Path is not a valid file";
 
+            // Disable UI while Check is running
+            DisableUIElements();
+            bool cachedCanExecuteSelectionChanged = CanExecuteSelectionChanged;
+            DisableEventHandlers();
+
             // Populate an environment
             var env = new DumpEnvironment(Options, Path.GetFullPath(this.InputPath.Trim('"')), null, this.CurrentSystem, this.CurrentMediaType, this.CurrentProgram, parameters: null);
 
@@ -416,13 +469,12 @@ namespace MPF.Core.UI.ViewModels
             protectionProgress.ProgressChanged += ConsoleLogger.ProgressUpdated;
 
             // Finally, attempt to do the output dance
-#if NET40
-                var resultTask = env.VerifyAndSaveDumpOutput(resultProgress, protectionProgress);
-                resultTask.Wait();
-                var result = resultTask.Result;
-#else
-            var result = env.VerifyAndSaveDumpOutput(resultProgress, protectionProgress, processUserInfo).ConfigureAwait(false).GetAwaiter().GetResult();
-#endif
+            var result = await env.VerifyAndSaveDumpOutput(resultProgress, protectionProgress, processUserInfo);
+
+            // Reenable UI and event handlers, if necessary
+            EnableUIElements();
+            if (cachedCanExecuteSelectionChanged)
+                EnableEventHandlers();
 
             return result.Message;
         }

MPF.UI.Core/Windows/CheckDumpWindow.xaml

@@ -117,7 +117,7 @@
                     <Button Name="CheckDumpButton" Height="25" Width="80" IsDefault="True" Content="Check Dump"
                             IsEnabled="{Binding CheckDumpButtonEnabled}" Style="{DynamicResource CustomButtonStyle}" />
                     <Button Name="CancelButton" Height="25" Width="80" IsCancel="True" Content="Cancel"
-                            Style="{DynamicResource CustomButtonStyle}" />
+                            IsEnabled="{Binding CancelButtonEnabled}" Style="{DynamicResource CustomButtonStyle}" />
                     <Label/>
                     <!-- Empty label for padding -->
                 </UniformGrid>

MPF.UI.Core/Windows/CheckDumpWindow.xaml.cs

@@ -209,9 +209,17 @@ namespace MPF.UI.Core.Windows
         /// <summary>
         /// Handler for CheckDumpButton Click event
         /// </summary>
+#if NET40
         private void OnCheckDumpClick(object sender, EventArgs e)
         {
-            string? errorMessage = CheckDumpViewModel.CheckDump(ShowDiscInformationWindow);
+            var checkTask = CheckDumpViewModel.CheckDump(ShowDiscInformationWindow);
+            checkTask.Wait();
+            string? errorMessage = checkTask.Result;
+#else
+        private async void OnCheckDumpClick(object sender, EventArgs e)
+        {
+            string? errorMessage = await CheckDumpViewModel.CheckDump(ShowDiscInformationWindow);
+#endif
             if (string.IsNullOrEmpty(errorMessage))
             {
                 bool? checkAgain = DisplayUserMessage("Check Complete", "The dump has been processed successfully! Would you like to check another dump?", 2, false);