Merge pull request #555 from TheTrackerCouncil/update-sprite-download…

…-window

Add sprite download progress bar and cancellation

src/TrackerCouncil.Smz3.Data/Services/GitHubSpriteDownloaderService.cs

@@ -5,6 +5,7 @@
 using System.Linq;
 using System.Net.Http;
 using System.Text.Json;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
 using TrackerCouncil.Smz3.Data.Options;
@@ -19,6 +20,7 @@ public class GitHubSpriteDownloaderService : IGitHubSpriteDownloaderService
     private ILogger<GitHubSpriteDownloaderService> _logger;
     private string _spriteFolder;
     private OptionsFactory _optionsFactory;
+    private CancellationTokenSource _cts = new();
 
     public GitHubSpriteDownloaderService(ILogger<GitHubSpriteDownloaderService> logger, OptionsFactory optionsFactory)
     {
@@ -28,6 +30,10 @@ public GitHubSpriteDownloaderService(ILogger<GitHubSpriteDownloaderService> logg
         _logger.LogInformation("Sprite path: {Path} | {OtherPath}", Sprite.SpritePath, AppContext.BaseDirectory);
     }
 
+    public void CancelDownload() => _cts.Cancel();
+
+    public event EventHandler<SpriteDownloadUpdateEventArgs>? SpriteDownloadUpdate;
+
     public async Task<IDictionary<string, string>?> GetSpritesToDownloadAsync(string owner, string repo, TimeSpan? timeout = null)
     {
         var sprites = await GetGitHubSpritesAsync(owner, repo, timeout);
@@ -59,11 +65,14 @@ public GitHubSpriteDownloaderService(ILogger<GitHubSpriteDownloaderService> logg
 
     public async Task DownloadSpritesAsync(string owner, string repo, IDictionary<string, string>? spritesToDownload = null, TimeSpan? timeout = null)
     {
+        spritesToDownload ??= await GetSpritesToDownloadAsync(owner, repo, timeout);
         if (spritesToDownload == null)
         {
-            spritesToDownload = await GetSpritesToDownloadAsync(owner, repo, timeout);
+            return;
         }
 
+        _cts.TryReset();
+
         if (!Directory.Exists(_spriteFolder))
         {
             Directory.CreateDirectory(_spriteFolder);
@@ -72,9 +81,12 @@ public async Task DownloadSpritesAsync(string owner, string repo, IDictionary<st
         var previousHashes = GetPreviousSpriteHashes();
         var added = new ConcurrentDictionary<string, string>();
 
+        var total = spritesToDownload.Count;
+        var completed = 0;
+
         if (spritesToDownload?.Any() == true)
         {
-            await Parallel.ForEachAsync(spritesToDownload, parallelOptions: new ParallelOptions() { MaxDegreeOfParallelism = 4 },
+            await Parallel.ForEachAsync(spritesToDownload, parallelOptions: new ParallelOptions() { MaxDegreeOfParallelism = 4, CancellationToken = _cts.Token},
                 async (spriteData, _) =>
                 {
                     var localPath = ConvertGitHubPath(spriteData.Key);
@@ -86,6 +98,9 @@ public async Task DownloadSpritesAsync(string owner, string repo, IDictionary<st
                     {
                         added[localPath] = currentHash;
                     }
+
+                    completed++;
+                    SpriteDownloadUpdate.Invoke(this, new SpriteDownloadUpdateEventArgs(completed, total));
                 });
         }
 

src/TrackerCouncil.Smz3.Data/Services/IGitHubSpriteDownloaderService.cs

@@ -27,4 +27,14 @@ public interface IGitHubSpriteDownloaderService
     /// <param name="timeout">How long to timeout from the api call</param>
     /// <returns></returns>
     public Task DownloadSpritesAsync(string owner, string repo, IDictionary<string, string>? spritesToDownload = null, TimeSpan? timeout = null);
+
+    /// <summary>
+    /// Cancels the current sprite download
+    /// </summary>
+    public void CancelDownload();
+
+    /// <summary>
+    /// Event that fires off after each completed sprite download
+    /// </summary>
+    public event EventHandler<SpriteDownloadUpdateEventArgs> SpriteDownloadUpdate;
 }

src/TrackerCouncil.Smz3.Data/Services/SpriteDownloadUpdateEventArgs.cs

@@ -0,0 +1,9 @@
+using System;
+
+namespace TrackerCouncil.Smz3.Data.Services;
+
+public class SpriteDownloadUpdateEventArgs(int completed, int total) : EventArgs
+{
+    public int Completed => completed;
+    public int Total => total;
+}

src/TrackerCouncil.Smz3.UI/ServiceCollectionExtensions.cs

@@ -53,7 +53,7 @@ public static IServiceCollection ConfigureServices(this IServiceCollection servi
         services.AddSingleton<IGameDbService, GameDbService>();
         services.AddTransient<SourceRomValidationService>();
         services.AddTransient<IGitHubConfigDownloaderService, GitHubConfigDownloaderService>();
-        services.AddTransient<IGitHubSpriteDownloaderService, GitHubSpriteDownloaderService>();
+        services.AddSingleton<IGitHubSpriteDownloaderService, GitHubSpriteDownloaderService>();
         services.AddSingleton<OptionsFactory>();
         services.AddSingleton<IMicrophoneService, NullMicrophoneService>();
 

src/TrackerCouncil.Smz3.UI/Services/SpriteDownloadWindowService.cs

@@ -0,0 +1,26 @@
+using AvaloniaControls.ControlServices;
+using TrackerCouncil.Smz3.Data.Services;
+using TrackerCouncil.Smz3.UI.ViewModels;
+
+namespace TrackerCouncil.Smz3.UI.Services;
+
+public class SpriteDownloadWindowService(IGitHubSpriteDownloaderService gitHubSpriteDownloaderService) : ControlService
+{
+    private SpriteDownloadWindowViewModel _model = new();
+
+    public SpriteDownloadWindowViewModel InitializeModel()
+    {
+        gitHubSpriteDownloaderService.SpriteDownloadUpdate += (sender, args) =>
+        {
+            _model.NumTotal = args.Total;
+            _model.NumCompleted = args.Completed;
+        };
+
+        return _model;
+    }
+
+    public void CancelDownload()
+    {
+        gitHubSpriteDownloaderService.CancelDownload();
+    }
+}

src/TrackerCouncil.Smz3.UI/TrackerCouncil.Smz3.UI.csproj

@@ -6,7 +6,7 @@
         <BuiltInComInteropSupport>true</BuiltInComInteropSupport>
         <ApplicationManifest>app.manifest</ApplicationManifest>
         <AvaloniaUseCompiledBindingsByDefault>true</AvaloniaUseCompiledBindingsByDefault>
-        <Version>9.8.2</Version>
+        <Version>9.8.3</Version>
         <AssemblyName>SMZ3CasRandomizer</AssemblyName>
         <ApplicationIcon>Assets\smz3.ico</ApplicationIcon>
         <RootNamespace>$(MSBuildProjectName.Replace(" ", "_"))</RootNamespace>

src/TrackerCouncil.Smz3.UI/ViewModels/SpriteDownloadWindowViewModel.cs

@@ -0,0 +1,9 @@
+using ReactiveUI.Fody.Helpers;
+
+namespace TrackerCouncil.Smz3.UI.ViewModels;
+
+public class SpriteDownloadWindowViewModel : ViewModelBase
+{
+    [Reactive] public int NumCompleted { get; set; }
+    [Reactive] public int NumTotal { get; set; } = 1;
+}

src/TrackerCouncil.Smz3.UI/Views/SpriteDownloadWindow.axaml

@@ -2,16 +2,28 @@
         xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
         xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
         xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+        xmlns:viewModels="clr-namespace:TrackerCouncil.Smz3.UI.ViewModels"
+        xmlns:controls="clr-namespace:AvaloniaControls.Controls;assembly=AvaloniaControls"
         mc:Ignorable="d"
         Width="300"
         Height="100"
         CanResize="False"
-        VerticalContentAlignment="Center"
-        HorizontalContentAlignment="Center"
+        Padding="10"
+        SizeToContent="Height"
         WindowStartupLocation="CenterOwner"
         Icon="/Assets/smz3.ico"
         x:Class="TrackerCouncil.Smz3.UI.Views.SpriteDownloadWindow"
+        x:DataType="viewModels:SpriteDownloadWindowViewModel"
+        Closing="Window_OnClosing"
         Title="SMZ3 Cas' Randomizer">
-  Downloading Sprites
+  <DockPanel Margin="0">
+
+    <StackPanel Orientation="Vertical">
+      <TextBlock Text="Downloading Sprites"></TextBlock>
+      <ProgressBar Maximum="{Binding NumTotal}" Value="{Binding NumCompleted}" Margin="0 5 0 0"></ProgressBar>
+      <Button HorizontalAlignment="Center" Margin="0 10 0 0" Click="Button_OnClick">Cancel Download</Button>
+    </StackPanel>
+  </DockPanel>
+
 </Window>
 

src/TrackerCouncil.Smz3.UI/Views/SpriteDownloadWindow.axaml.cs

@@ -1,12 +1,41 @@
 using Avalonia.Controls;
+using Avalonia.Interactivity;
+using AvaloniaControls.Extensions;
+using TrackerCouncil.Smz3.UI.Services;
+using TrackerCouncil.Smz3.UI.ViewModels;
 
 namespace TrackerCouncil.Smz3.UI.Views;
 
 public partial class SpriteDownloadWindow : Window
 {
+    private SpriteDownloadWindowService? _service;
+
     public SpriteDownloadWindow()
     {
         InitializeComponent();
+
+        if (Design.IsDesignMode)
+        {
+            DataContext = new SpriteDownloadWindowViewModel
+            {
+                NumCompleted = 5, NumTotal = 10
+            };
+        }
+        else
+        {
+            _service = this.GetControlService<SpriteDownloadWindowService>();
+            DataContext = _service?.InitializeModel() ?? new SpriteDownloadWindowViewModel();
+        }
+    }
+
+    private void Window_OnClosing(object? sender, WindowClosingEventArgs e)
+    {
+        _service?.CancelDownload();
+    }
+
+    private void Button_OnClick(object? sender, RoutedEventArgs e)
+    {
+        Close();
     }
 }