From 67c76f54b33deab2eb76f0826f8c49a653f6f2bb Mon Sep 17 00:00:00 2001
From: Scrub <72096833+ScrubN@users.noreply.github.com>
Date: Sat, 3 Aug 2024 19:20:57 -0400
Subject: [PATCH] Show detailed statuses in task queue (#1172)

* Fix potential NRE

* Support displaying detailed statuses in task queue

* Remove redundant method calls

* Fix race condition
---
 TwitchDownloaderWPF/PageQueue.xaml            |  2 +-
 TwitchDownloaderWPF/PageQueue.xaml.cs         | 22 ++++++++++---------
 .../TwitchTasks/ChatDownloadTask.cs           | 12 ++++++++--
 .../TwitchTasks/ChatRenderTask.cs             | 12 ++++++++--
 .../TwitchTasks/ChatUpdateTask.cs             | 12 ++++++++--
 .../TwitchTasks/ClipDownloadTask.cs           | 12 ++++++++--
 .../TwitchTasks/ITwitchTask.cs                |  1 +
 .../TwitchTasks/VodDownloadTask.cs            | 12 ++++++++--
 TwitchDownloaderWPF/Utils/WpfTaskProgress.cs  |  8 +++----
 .../WindowQueueOptions.xaml.cs                | 10 ---------
 10 files changed, 68 insertions(+), 35 deletions(-)

diff --git a/TwitchDownloaderWPF/PageQueue.xaml b/TwitchDownloaderWPF/PageQueue.xaml
index 3e5e1534..cb02a79d 100644
--- a/TwitchDownloaderWPF/PageQueue.xaml
+++ b/TwitchDownloaderWPF/PageQueue.xaml
@@ -71,7 +71,7 @@
                                     <StackPanel Grid.Column="1" Orientation="Vertical" Margin="8,0,0,0" >
                                         <emoji:TextBlock Text="{Binding Info.Title, StringFormat=Title: {0}}" TextWrapping="Wrap" Foreground="{DynamicResource AppText}"></emoji:TextBlock>
                                         <TextBlock Text="{Binding TaskType, StringFormat=Task Type: {0}}" Foreground="{DynamicResource AppText}"></TextBlock>
-                                        <TextBlock Text="{Binding Status, StringFormat=Status: {0}, Mode=OneWay, NotifyOnSourceUpdated=True, UpdateSourceTrigger=PropertyChanged}" Foreground="{DynamicResource AppText}"></TextBlock>
+                                        <TextBlock Text="{Binding DisplayStatus, StringFormat=Status: {0}, Mode=OneWay, NotifyOnSourceUpdated=True, UpdateSourceTrigger=PropertyChanged}" Foreground="{DynamicResource AppText}"></TextBlock>
                                         <StackPanel Orientation="Horizontal" Margin="1,1,0,1">
                                             <Button Content="{lex:Loc TaskCancel}" Margin="0,0,4,0" MinWidth="60" Height="28" FontSize="12" Click="BtnCancelTask_Click" IsEnabled="{Binding CanCancel}" Background="{DynamicResource ActionButtonBackground}" Foreground="{DynamicResource ActionButtonText}" BorderBrush="{DynamicResource ActionButtonBorder}" />
                                             <Button Visibility="{Binding Exception.Visibility}" Content="{lex:Loc TaskErrorButton}" Margin="0,0,4,0" MinWidth="60" Height="28" FontSize="12" Click="BtnTaskError_Click" Background="{DynamicResource ActionButtonBackground}" Foreground="{DynamicResource ActionButtonText}" BorderBrush="{DynamicResource ActionButtonBorder}" />
diff --git a/TwitchDownloaderWPF/PageQueue.xaml.cs b/TwitchDownloaderWPF/PageQueue.xaml.cs
index 4ab7508d..1343b640 100644
--- a/TwitchDownloaderWPF/PageQueue.xaml.cs
+++ b/TwitchDownloaderWPF/PageQueue.xaml.cs
@@ -17,8 +17,8 @@ namespace TwitchDownloaderWPF
     public partial class PageQueue : Page
     {
         public static readonly object taskLock = new object();
-        public static ObservableCollection<ITwitchTask> taskList { get; set; } = new ObservableCollection<ITwitchTask>();
-        BackgroundWorker taskManager = new BackgroundWorker();
+        public static ObservableCollection<ITwitchTask> taskList { get; } = new ObservableCollection<ITwitchTask>();
+        private static readonly BackgroundWorker taskManager = new BackgroundWorker();
 
         public PageQueue()
         {
@@ -34,7 +34,7 @@ public PageQueue()
             taskManager.RunWorkerAsync();
         }
 
-        private void TaskManager_DoWork(object sender, DoWorkEventArgs e)
+        private static void TaskManager_DoWork(object sender, DoWorkEventArgs e)
         {
             while (true)
             {
@@ -47,10 +47,13 @@ private void TaskManager_DoWork(object sender, DoWorkEventArgs e)
                 int currentChat = 0;
                 int currentRender = 0;
 
-                foreach (var task in taskList)
+                lock (taskLock)
                 {
-                    if (task.Status == TwitchTaskStatus.Running)
+                    foreach (var task in taskList)
                     {
+                        if (task.Status is not TwitchTaskStatus.Running)
+                            continue;
+
                         switch (task)
                         {
                             case VodDownloadTask:
@@ -70,12 +73,12 @@ private void TaskManager_DoWork(object sender, DoWorkEventArgs e)
                                 break;
                         }
                     }
-                }
 
-                foreach (var task in taskList)
-                {
-                    if (task.CanRun())
+                    foreach (var task in taskList)
                     {
+                        if (!task.CanRun())
+                            continue;
+
                         switch (task)
                         {
                             case VodDownloadTask when currentVod < maxVod:
@@ -99,7 +102,6 @@ private void TaskManager_DoWork(object sender, DoWorkEventArgs e)
                                 task.RunAsync();
                                 break;
                         }
-                        continue;
                     }
                 }
 
diff --git a/TwitchDownloaderWPF/TwitchTasks/ChatDownloadTask.cs b/TwitchDownloaderWPF/TwitchTasks/ChatDownloadTask.cs
index e7846026..af9f7f7e 100644
--- a/TwitchDownloaderWPF/TwitchTasks/ChatDownloadTask.cs
+++ b/TwitchDownloaderWPF/TwitchTasks/ChatDownloadTask.cs
@@ -10,7 +10,7 @@
 
 namespace TwitchDownloaderWPF.TwitchTasks
 {
-    class ChatDownloadTask : ITwitchTask
+    internal class ChatDownloadTask : ITwitchTask
     {
         public TaskData Info { get; set; } = new TaskData();
 
@@ -28,6 +28,13 @@ public TwitchTaskStatus Status
             private set => SetField(ref _status, value);
         }
 
+        private string _displayStatus;
+        public string DisplayStatus
+        {
+            get => _displayStatus;
+            private set => SetField(ref _displayStatus, value);
+        }
+
         public ChatDownloadOptions DownloadOptions { get; init; }
         public CancellationTokenSource TokenSource { get; set; } = new CancellationTokenSource();
         public ITwitchTask DependantTask { get; set; }
@@ -77,6 +84,7 @@ public bool CanRun()
         public void ChangeStatus(TwitchTaskStatus newStatus)
         {
             Status = newStatus;
+            DisplayStatus = newStatus.ToString();
 
             if (CanCancel && newStatus is TwitchTaskStatus.Canceled or TwitchTaskStatus.Failed or TwitchTaskStatus.Finished or TwitchTaskStatus.Stopping)
             {
@@ -93,7 +101,7 @@ public async Task RunAsync()
                 return;
             }
 
-            var progress = new WpfTaskProgress(i => Progress = i);
+            var progress = new WpfTaskProgress(i => Progress = i, s => DisplayStatus = s);
             ChatDownloader downloader = new ChatDownloader(DownloadOptions, progress);
             ChangeStatus(TwitchTaskStatus.Running);
             try
diff --git a/TwitchDownloaderWPF/TwitchTasks/ChatRenderTask.cs b/TwitchDownloaderWPF/TwitchTasks/ChatRenderTask.cs
index 6bd991d3..1cd639e4 100644
--- a/TwitchDownloaderWPF/TwitchTasks/ChatRenderTask.cs
+++ b/TwitchDownloaderWPF/TwitchTasks/ChatRenderTask.cs
@@ -10,7 +10,7 @@
 
 namespace TwitchDownloaderWPF.TwitchTasks
 {
-    class ChatRenderTask : ITwitchTask
+    internal class ChatRenderTask : ITwitchTask
     {
         public TaskData Info { get; set; } = new TaskData();
 
@@ -28,6 +28,13 @@ public TwitchTaskStatus Status
             private set => SetField(ref _status, value);
         }
 
+        private string _displayStatus;
+        public string DisplayStatus
+        {
+            get => _displayStatus;
+            private set => SetField(ref _displayStatus, value);
+        }
+
         public ChatRenderOptions DownloadOptions { get; init; }
         public CancellationTokenSource TokenSource { get; set; } = new CancellationTokenSource();
         public ITwitchTask DependantTask { get; set; }
@@ -96,6 +103,7 @@ public bool CanRun()
         public void ChangeStatus(TwitchTaskStatus newStatus)
         {
             Status = newStatus;
+            DisplayStatus = newStatus.ToString();
 
             if (CanCancel && newStatus is TwitchTaskStatus.Canceled or TwitchTaskStatus.Failed or TwitchTaskStatus.Finished or TwitchTaskStatus.Stopping)
             {
@@ -112,7 +120,7 @@ public async Task RunAsync()
                 return;
             }
 
-            var progress = new WpfTaskProgress(i => Progress = i);
+            var progress = new WpfTaskProgress(i => Progress = i, s => DisplayStatus = s);
             ChatRenderer renderer = new ChatRenderer(DownloadOptions, progress);
             ChangeStatus(TwitchTaskStatus.Running);
             try
diff --git a/TwitchDownloaderWPF/TwitchTasks/ChatUpdateTask.cs b/TwitchDownloaderWPF/TwitchTasks/ChatUpdateTask.cs
index 48648be6..d1e59225 100644
--- a/TwitchDownloaderWPF/TwitchTasks/ChatUpdateTask.cs
+++ b/TwitchDownloaderWPF/TwitchTasks/ChatUpdateTask.cs
@@ -10,7 +10,7 @@
 
 namespace TwitchDownloaderWPF.TwitchTasks
 {
-    class ChatUpdateTask : ITwitchTask
+    internal class ChatUpdateTask : ITwitchTask
     {
         public TaskData Info { get; set; } = new TaskData();
 
@@ -28,6 +28,13 @@ public TwitchTaskStatus Status
             private set => SetField(ref _status, value);
         }
 
+        private string _displayStatus;
+        public string DisplayStatus
+        {
+            get => _displayStatus;
+            private set => SetField(ref _displayStatus, value);
+        }
+
         public ChatUpdateOptions UpdateOptions { get; init; }
         public CancellationTokenSource TokenSource { get; set; } = new CancellationTokenSource();
         public ITwitchTask DependantTask { get; set; }
@@ -77,6 +84,7 @@ public bool CanRun()
         public void ChangeStatus(TwitchTaskStatus newStatus)
         {
             Status = newStatus;
+            DisplayStatus = newStatus.ToString();
 
             if (CanCancel && newStatus is TwitchTaskStatus.Canceled or TwitchTaskStatus.Failed or TwitchTaskStatus.Finished or TwitchTaskStatus.Stopping)
             {
@@ -93,7 +101,7 @@ public async Task RunAsync()
                 return;
             }
 
-            var progress = new WpfTaskProgress(i => Progress = i);
+            var progress = new WpfTaskProgress(i => Progress = i, s => DisplayStatus = s);
             ChatUpdater updater = new ChatUpdater(UpdateOptions, progress);
             ChangeStatus(TwitchTaskStatus.Running);
             try
diff --git a/TwitchDownloaderWPF/TwitchTasks/ClipDownloadTask.cs b/TwitchDownloaderWPF/TwitchTasks/ClipDownloadTask.cs
index b5ea1a73..204acbdc 100644
--- a/TwitchDownloaderWPF/TwitchTasks/ClipDownloadTask.cs
+++ b/TwitchDownloaderWPF/TwitchTasks/ClipDownloadTask.cs
@@ -10,7 +10,7 @@
 
 namespace TwitchDownloaderWPF.TwitchTasks
 {
-    class ClipDownloadTask : ITwitchTask
+    internal class ClipDownloadTask : ITwitchTask
     {
         public TaskData Info { get; set; } = new TaskData();
 
@@ -28,6 +28,13 @@ public TwitchTaskStatus Status
             private set => SetField(ref _status, value);
         }
 
+        private string _displayStatus;
+        public string DisplayStatus
+        {
+            get => _displayStatus;
+            private set => SetField(ref _displayStatus, value);
+        }
+
         public ClipDownloadOptions DownloadOptions { get; init; }
         public CancellationTokenSource TokenSource { get; set; } = new CancellationTokenSource();
         public ITwitchTask DependantTask { get; set; }
@@ -77,6 +84,7 @@ public bool CanRun()
         public void ChangeStatus(TwitchTaskStatus newStatus)
         {
             Status = newStatus;
+            DisplayStatus = newStatus.ToString();
 
             if (CanCancel && newStatus is TwitchTaskStatus.Canceled or TwitchTaskStatus.Failed or TwitchTaskStatus.Finished or TwitchTaskStatus.Stopping)
             {
@@ -93,7 +101,7 @@ public async Task RunAsync()
                 return;
             }
 
-            var progress = new WpfTaskProgress(i => Progress = i);
+            var progress = new WpfTaskProgress(i => Progress = i, s => DisplayStatus = s);
             ClipDownloader downloader = new ClipDownloader(DownloadOptions, progress);
             ChangeStatus(TwitchTaskStatus.Running);
             try
diff --git a/TwitchDownloaderWPF/TwitchTasks/ITwitchTask.cs b/TwitchDownloaderWPF/TwitchTasks/ITwitchTask.cs
index 118e90dc..759e9add 100644
--- a/TwitchDownloaderWPF/TwitchTasks/ITwitchTask.cs
+++ b/TwitchDownloaderWPF/TwitchTasks/ITwitchTask.cs
@@ -20,6 +20,7 @@ public interface ITwitchTask : INotifyPropertyChanged
         TaskData Info { get; set; }
         int Progress { get; }
         TwitchTaskStatus Status { get; }
+        string DisplayStatus { get; }
         CancellationTokenSource TokenSource { get; set; }
         ITwitchTask DependantTask { get; set; }
         string TaskType { get; }
diff --git a/TwitchDownloaderWPF/TwitchTasks/VodDownloadTask.cs b/TwitchDownloaderWPF/TwitchTasks/VodDownloadTask.cs
index 111693f0..d61867e5 100644
--- a/TwitchDownloaderWPF/TwitchTasks/VodDownloadTask.cs
+++ b/TwitchDownloaderWPF/TwitchTasks/VodDownloadTask.cs
@@ -10,7 +10,7 @@
 
 namespace TwitchDownloaderWPF.TwitchTasks
 {
-    class VodDownloadTask : ITwitchTask
+    internal class VodDownloadTask : ITwitchTask
     {
         public TaskData Info { get; set; } = new TaskData();
 
@@ -28,6 +28,13 @@ public TwitchTaskStatus Status
             private set => SetField(ref _status, value);
         }
 
+        private string _displayStatus;
+        public string DisplayStatus
+        {
+            get => _displayStatus;
+            private set => SetField(ref _displayStatus, value);
+        }
+
         public VideoDownloadOptions DownloadOptions { get; init; }
         public CancellationTokenSource TokenSource { get; set; } = new CancellationTokenSource();
         public ITwitchTask DependantTask { get; set; }
@@ -77,6 +84,7 @@ public bool CanRun()
         public void ChangeStatus(TwitchTaskStatus newStatus)
         {
             Status = newStatus;
+            DisplayStatus = newStatus.ToString();
 
             if (CanCancel && newStatus is TwitchTaskStatus.Canceled or TwitchTaskStatus.Failed or TwitchTaskStatus.Finished or TwitchTaskStatus.Stopping)
             {
@@ -93,7 +101,7 @@ public async Task RunAsync()
                 return;
             }
 
-            var progress = new WpfTaskProgress(i => Progress = i);
+            var progress = new WpfTaskProgress(i => Progress = i, s => DisplayStatus = s);
             VideoDownloader downloader = new VideoDownloader(DownloadOptions, progress);
             ChangeStatus(TwitchTaskStatus.Running);
             try
diff --git a/TwitchDownloaderWPF/Utils/WpfTaskProgress.cs b/TwitchDownloaderWPF/Utils/WpfTaskProgress.cs
index 02a8fae3..727b35d8 100644
--- a/TwitchDownloaderWPF/Utils/WpfTaskProgress.cs
+++ b/TwitchDownloaderWPF/Utils/WpfTaskProgress.cs
@@ -21,10 +21,10 @@ internal class WpfTaskProgress : ITaskProgress
         private readonly Action<string> _handleLog;
         private readonly Action<string> _handleFfmpegLog;
 
-        public WpfTaskProgress(Action<int> handlePercent)
+        public WpfTaskProgress(Action<int> handlePercent, Action<string> handleStatus)
         {
             _handlePercent = handlePercent;
-            _handleStatus = null;
+            _handleStatus = handleStatus;
             _handleLog = null;
             _handleFfmpegLog = null;
 
@@ -145,14 +145,14 @@ public void LogInfo(string logMessage)
         {
             if ((_logLevel & LogLevel.Info) == 0) return;
 
-            _handleLog.Invoke(logMessage);
+            _handleLog?.Invoke(logMessage);
         }
 
         public void LogInfo(DefaultInterpolatedStringHandler logMessage)
         {
             if ((_logLevel & LogLevel.Info) == 0) return;
 
-            _handleLog.Invoke(logMessage.ToStringAndClear());
+            _handleLog?.Invoke(logMessage.ToStringAndClear());
         }
 
         public void LogWarning(string logMessage)
diff --git a/TwitchDownloaderWPF/WindowQueueOptions.xaml.cs b/TwitchDownloaderWPF/WindowQueueOptions.xaml.cs
index 561c4308..0d68f4e6 100644
--- a/TwitchDownloaderWPF/WindowQueueOptions.xaml.cs
+++ b/TwitchDownloaderWPF/WindowQueueOptions.xaml.cs
@@ -145,7 +145,6 @@ private void btnQueue_Click(object sender, RoutedEventArgs e)
                             Thumbnail = vodDownloadPage.imgThumbnail.Source
                         }
                     };
-                    downloadTask.ChangeStatus(TwitchTaskStatus.Ready);
 
                     lock (PageQueue.taskLock)
                     {
@@ -187,7 +186,6 @@ private void btnQueue_Click(object sender, RoutedEventArgs e)
                                 Thumbnail = vodDownloadPage.imgThumbnail.Source
                             }
                         };
-                        chatTask.ChangeStatus(TwitchTaskStatus.Ready);
 
                         lock (PageQueue.taskLock)
                         {
@@ -261,7 +259,6 @@ private void btnQueue_Click(object sender, RoutedEventArgs e)
                             Thumbnail = clipDownloadPage.imgThumbnail.Source
                         }
                     };
-                    downloadTask.ChangeStatus(TwitchTaskStatus.Ready);
 
                     lock (PageQueue.taskLock)
                     {
@@ -294,7 +291,6 @@ private void btnQueue_Click(object sender, RoutedEventArgs e)
                                 Thumbnail = clipDownloadPage.imgThumbnail.Source
                             }
                         };
-                        chatTask.ChangeStatus(TwitchTaskStatus.Ready);
 
                         lock (PageQueue.taskLock)
                         {
@@ -359,7 +355,6 @@ private void btnQueue_Click(object sender, RoutedEventArgs e)
                             Thumbnail = chatDownloadPage.imgThumbnail.Source
                         }
                     };
-                    chatTask.ChangeStatus(TwitchTaskStatus.Ready);
 
                     lock (PageQueue.taskLock)
                     {
@@ -419,7 +414,6 @@ private void btnQueue_Click(object sender, RoutedEventArgs e)
                             Thumbnail = chatUpdatePage.imgThumbnail.Source
                         }
                     };
-                    chatTask.ChangeStatus(TwitchTaskStatus.Ready);
 
                     lock (PageQueue.taskLock)
                     {
@@ -459,7 +453,6 @@ private void btnQueue_Click(object sender, RoutedEventArgs e)
                         {
                             renderTask.Info.Thumbnail = image;
                         }
-                        renderTask.ChangeStatus(TwitchTaskStatus.Ready);
 
                         lock (PageQueue.taskLock)
                         {
@@ -520,7 +513,6 @@ private void EnqueueDataList()
                                 Thumbnail = taskData.Thumbnail
                             }
                         };
-                        downloadTask.ChangeStatus(TwitchTaskStatus.Ready);
 
                         lock (PageQueue.taskLock)
                         {
@@ -553,7 +545,6 @@ private void EnqueueDataList()
                                 Thumbnail = taskData.Thumbnail
                             }
                         };
-                        downloadTask.ChangeStatus(TwitchTaskStatus.Ready);
 
                         lock (PageQueue.taskLock)
                         {
@@ -594,7 +585,6 @@ private void EnqueueDataList()
                             Thumbnail = taskData.Thumbnail
                         }
                     };
-                    downloadTask.ChangeStatus(TwitchTaskStatus.Ready);
 
                     lock (PageQueue.taskLock)
                     {