Merge pull request #2740 from wabbajack-tools/publish_button_progress

Publish Button visual progress

Author: tr4wzified

CHANGELOG.md

@@ -1,11 +1,12 @@
 ### Changelog
 
-#### Version - 4.0.0.4 - Unreleased
+#### Version - 4.0.1.0 - Unreleased
 * Fixed subfolders of profiles showing up under additional profiles within compiler settings
 * Fixed Nexus login not taking cancellation token into account while waiting for authorization (closing the Nexus login prompt did not work)
 * Added 2FA support for MEGA login, added some extra logging for MEGA logins
   * Special thanks to [@erri120](https://www.github.com/erri120) who originally implemented part of this in Wabbajack and the MegaApiClient library 4 years ago, which made the change rather easy
 * Added a warning for when WebView is not loading
+* Addd progress indicator to the publish button after compilation (thanks to [@JanuarySnow](https://www.github.com/JanuarySnow)))
 
 #### Version - 4.0.0.3 - 3/20/2025
 * Fixed the open logs folder button not actually opening the logs folder on a failed installation

Wabbajack.App.Wpf/ViewModels/Compiler/CompilerMainVM.cs

@@ -52,7 +52,10 @@ public class CompilerMainVM : BaseCompilerVM, ICanGetHelpVM, ICpuStatusVM
     public ICommand OpenFolderCommand { get; }
     public ICommand PublishCommand { get; }
 
+    [Reactive] public bool IsPublishing { get; set; }
+    [Reactive] public Percent PublishingPercentage { get; set; } = Percent.One;
     [Reactive] public CompilerState State { get; set; }
+
     public bool Cancelling { get; private set; }
 
     public ReadOnlyObservableCollection<CPUDisplayVM> StatusList => _resourceMonitor.Tasks;
@@ -90,7 +93,11 @@ public CompilerMainVM(ILogger<CompilerMainVM> logger, DTOSerializer dtos, Settin
         CancelCommand = ReactiveCommand.Create(CancelCompilation);
         OpenLogCommand = ReactiveCommand.Create(OpenLog);
         OpenFolderCommand = ReactiveCommand.Create(OpenFolder);
-        PublishCommand = ReactiveCommand.Create(Publish); 
+        PublishCommand = ReactiveCommand.Create(Publish,
+            this.WhenAnyValue(vm => vm.State,
+                              vm => vm.IsPublishing,
+                              (state, isPublishing) => !isPublishing && state == CompilerState.Completed)); 
+
         ProgressPercent = Percent.Zero;
 
         this.WhenActivated(disposables =>
@@ -136,14 +143,33 @@ private void OpenLog()
 
     private async Task Publish()
     {
-        _logger.LogInformation("Running preflight checks before publishing list");
-        bool readyForPublish = await RunPreflightChecks(CancellationToken.None);
-        if (!readyForPublish) return;
-
-        _logger.LogInformation("Publishing list with machineURL {machineURL}, version {version}, output {output}", Settings.MachineUrl, Settings.Version, Settings.OutputFile);
-        var downloadMetadata = _dtos.Deserialize<DownloadMetadata>(
-            await Settings.OutputFile.WithExtension(Ext.Meta).WithExtension(Ext.Json).ReadAllTextAsync())!;
-        await _wjClient.PublishModlist(Settings.MachineUrl, Version.Parse(Settings.Version), Settings.OutputFile, downloadMetadata);
+        try
+        {
+            IsPublishing = true;
+            PublishingPercentage = Percent.Zero;
+
+            _logger.LogInformation("Running preflight checks before publishing list");
+            bool readyForPublish = await RunPreflightChecks(CancellationToken.None);
+            if (!readyForPublish) return;
+
+            _logger.LogInformation("Publishing list with machineURL {machineURL}, version {version}, output {output}",
+                Settings.MachineUrl, Settings.Version, Settings.OutputFile);
+
+            var downloadMetadata = _dtos.Deserialize<DownloadMetadata>(
+                await Settings.OutputFile.WithExtension(Ext.Meta).WithExtension(Ext.Json).ReadAllTextAsync())!;
+            var (progress, publishTask) = await _wjClient.PublishModlist(Settings.MachineUrl, Version.Parse(Settings.Version), Settings.OutputFile, downloadMetadata);
+            using var progressSubscription = progress.Subscribe(p => PublishingPercentage = p.PercentDone);
+            await publishTask;
+        }
+        catch (Exception ex)
+        {
+            _logger.LogError("While publishing: {ex}", ex);
+        }
+        finally
+        {
+            IsPublishing = false;
+            PublishingPercentage = Percent.One;
+        }
     }
 
     private void OpenFolder() => UIUtils.OpenFolderAndSelectFile(Settings.OutputFile);
@@ -312,7 +338,7 @@ private async Task<bool> RunPreflightChecks(CancellationToken token)
             return false;
         }
 
-        if (!Version.TryParse(Settings.Version, out var version))
+        if (!System.Version.TryParse(Settings.Version, out var version))
         {
             _logger.LogError("Preflight Check failed, version {Version} was not valid", Settings.Version);
             return false;

Wabbajack.App.Wpf/Views/Common/WJButton.xaml.cs

@@ -4,10 +4,8 @@
 using System.Reactive.Linq;
 using System.Windows;
 using System;
-using System.Windows.Input;
 using Wabbajack.RateLimiter;
 using System.Windows.Media;
-using ReactiveUI.Fody.Helpers;
 using System.Windows.Controls;
 using System.ComponentModel;
 
@@ -137,18 +135,17 @@ public WJButton()
                 .DisposeWith(dispose);
 
             this.WhenAnyValue(x => x.ProgressPercentage)
+            .ObserveOnGuiThread()
             .Subscribe(percent =>
             {
                 if (ButtonStyle != ButtonStyle.Progress) return;
                 if (percent == Percent.One)
                 {
+                    this.ClearValue(BackgroundProperty);
+                    ButtonTextBlock.ClearValue(ForegroundProperty);
+                    ButtonSymbolIcon.ClearValue(ForegroundProperty);
                     Style = (Style)Application.Current.Resources["WJColorButtonStyle"];
                 }
-                else if (percent == Percent.Zero)
-                {
-                    Background = new SolidColorBrush((Color)Application.Current.Resources["ComplementaryPrimary08"]);
-                    Foreground = new SolidColorBrush((Color)Application.Current.Resources["ForegroundColor"]);
-                }
                 else
                 {
                     var bgBrush = new LinearGradientBrush();

Wabbajack.App.Wpf/Views/Compiler/CompilerMainView.xaml

@@ -67,7 +67,7 @@
             </Grid.ColumnDefinitions>
             <local:WJButton x:Name="OpenLogButton" Text="Open Log" Icon="DocumentText" HorizontalAlignment="Left" />
             <local:WJButton x:Name="OpenFolderButton" Text="Open in File Explorer" Icon="Folder" HorizontalAlignment="Right" Grid.Column="2" ButtonStyle="Color" />
-            <local:WJButton x:Name="PublishButton" Text="Publish Modlist" Icon="CloudArrowUp" HorizontalAlignment="Right" Grid.Column="4" ButtonStyle="Color" />
+            <local:WJButton x:Name="PublishButton" Text="Publish Modlist" Icon="CloudArrowUp" HorizontalAlignment="Right" Grid.Column="4" ButtonStyle="Progress" />
         </Grid>
     </Grid>
 </rxui:ReactiveUserControl>

Wabbajack.App.Wpf/Views/Compiler/CompilerMainView.xaml.cs

@@ -17,12 +17,15 @@ namespace Wabbajack;
 /// </summary>
 public partial class CompilerMainView : ReactiveUserControl<CompilerMainVM>
 {
+    private bool _ClickedPublish = false;
+
     public CompilerMainView()
     {
         InitializeComponent();
 
         this.WhenActivated(disposables =>
         {
+            _ClickedPublish = false;
             ViewModel.WhenAny(vm => vm.Settings.ModListImage)
                 .Where(i => i.FileExists())
                 .Select(i => (UIUtils.TryGetBitmapImageFromFile(i, out var img), img))
@@ -88,11 +91,6 @@ public CompilerMainView()
                     .BindToStrict(this, view => view.OpenFolderButton.IsEnabled)
                     .DisposeWith(disposables);
 
-            ViewModel.WhenAny(vm => vm.State)
-                    .Select(s => s == CompilerState.Completed)
-                    .BindToStrict(this, view => view.PublishButton.IsEnabled)
-                    .DisposeWith(disposables);
-
             ViewModel.WhenAny(vm => vm.State)
                      .Select(s => s == CompilerState.Completed ? Visibility.Visible : Visibility.Hidden)
                      .BindToStrict(this, view => view.CompiledImage.Visibility)
@@ -128,6 +126,17 @@ public CompilerMainView()
 
             this.BindCommand(ViewModel, x => x.PublishCommand, x => x.PublishButton)
                 .DisposeWith(disposables);
+
+            ViewModel.WhenAnyValue(vm => vm.PublishingPercentage)
+                .ObserveOnGuiThread()
+                .Subscribe(pct =>
+                {
+                    if (pct != RateLimiter.Percent.One) _ClickedPublish = true;
+                    PublishButton.ProgressPercentage = pct;
+                    PublishButton.Text = (pct.Value >= 0 && pct.Value < 1) ? "Publishing..." : _ClickedPublish ? "Publish Completed" : "Publish Modlist";
+                })
+                .DisposeWith(disposables);
+
         });
     }
 }

Wabbajack.App.Wpf/Wabbajack.App.Wpf.csproj

@@ -7,8 +7,8 @@
     <Platforms>x64</Platforms>
     <RuntimeIdentifier>win-x64</RuntimeIdentifier>
     <Version>$(VERSION)</Version>
-    <AssemblyVersion>$(VERSION)</AssemblyVersion>
-    <FileVersion>$(VERSION)</FileVersion>
+    <AssemblyVersion>4.0.0.0</AssemblyVersion>
+    <FileVersion>4.0.0.0</FileVersion>
     <Copyright>Copyright © 2019-2024</Copyright>
     <Description>An automated ModList installer</Description>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>

Wabbajack.Networking.WabbajackClientApi/Client.cs

@@ -6,6 +6,7 @@
 using System.Net;
 using System.Net.Http;
 using System.Net.Http.Json;
+using System.Reactive.Linq;
 using System.Reactive.Subjects;
 using System.Text;
 using System.Text.Json;
@@ -434,7 +435,7 @@ public async Task DeleteMirror(Hash hash)
         var apiKey = (await _token.Get())!.AuthorKey;
         var report = new Subject<(Percent PercentDone, string Message)>();
 
-        var tsk = Task.Run<Uri>(async () =>
+        var tsk = Task.Run(async () =>
         {
             report.OnNext((Percent.Zero, "Generating File Definition"));
             var definition = await GenerateFileDefinition(path);
@@ -479,6 +480,7 @@ await CircuitBreaker.WithAutoRetryAllAsync(_logger, async () =>
             });
 
             report.OnNext((Percent.Zero, "Finalizing upload"));
+            _logger.LogInformation("Finalizing upload");
             return await CircuitBreaker.WithAutoRetryAllAsync(_logger, async () =>
             {
                 var msg = await MakeMessage(HttpMethod.Put,
@@ -542,53 +544,62 @@ public async Task<bool> ProxyHas(Uri uri)
 
     public async Task<IReadOnlyList<string>> GetMyModlists(CancellationToken token)
     {
+        return ["tr4wzified/trawzifieds_helper"];
+
         var msg = await MakeMessage(HttpMethod.Get, new Uri($"{_configuration.BuildServerUrl}author_controls/lists"));
         using var response = await _client.SendAsync(msg, token);
         HttpException.ThrowOnFailure(response);
         return (await _dtos.DeserializeAsync<string[]>(await response.Content.ReadAsStreamAsync(token), token))!;
     }
 
-    public async Task PublishModlist(string namespacedName, Version version,  AbsolutePath modList, DownloadMetadata metadata)
+    public async Task<(IObservable<(Percent PercentDone, string Message)> Progress, Task PublishTask)> PublishModlist(
+    string namespacedName, Version version, AbsolutePath modList, DownloadMetadata metadata)
     {
         var pair = namespacedName.Split("/");
         var wjRepoName = pair[0];
         var machineUrl = pair[1];
 
         var repoUrl = (await LoadRepositories())[wjRepoName];
-
         var decomposed = repoUrl.LocalPath.Split("/");
         var owner = decomposed[1];
         var repoName = decomposed[2];
         var path = string.Join("/", decomposed[4..]);
-        
-        _logger.LogInformation("Uploading modlist {MachineUrl}", namespacedName);
-        
+
         var (progress, uploadTask) = await UploadAuthorFile(modList);
-        progress.Subscribe(x => _logger.LogInformation(x.Message));
-        var downloadUrl = await uploadTask;
 
-        _logger.LogInformation("Publishing modlist {MachineUrl}", namespacedName);
-
-        var creds = new Credentials((await _token.Get())!.AuthorKey);
-        var ghClient = new GitHubClient(new ProductHeaderValue("wabbajack")) {Credentials = creds};
+        // Usually the GitHub publish will take basically no time at all compared to the upload so just ignore progress percentage here
+        var publishTask = Task.Run(async () =>
+        {
+            var downloadUrl = await uploadTask;
 
-        var oldData =
-            (await ghClient.Repository.Content.GetAllContents(owner, repoName, path))
-            .First();
-        var oldContent = _dtos.Deserialize<ModlistMetadata[]>(oldData.Content);
-        var list = oldContent.First(c => c.Links.MachineURL == machineUrl);
-        list.Version = version;
-        list.DownloadMetadata = metadata;
-        list.Links.Download = downloadUrl.ToString();
-        list.DateUpdated = DateTime.UtcNow;
+            _logger.LogInformation("Publishing modlist {MachineUrl}", namespacedName);
 
+            var creds = new Credentials((await _token.Get())!.AuthorKey);
+            var ghClient = new GitHubClient(new ProductHeaderValue("wabbajack"))
+            {
+                Credentials = creds
+            };
 
-        var newContent = _dtos.Serialize(oldContent, true);
-        // the website requires all names be in lowercase;
-        newContent = GameRegistry.Games.Keys.Aggregate(newContent,
-            (current, g) => current.Replace($"\"game\": \"{g}\",", $"\"game\": \"{g.ToString().ToLower()}\","));
+            var oldData =
+                (await ghClient.Repository.Content.GetAllContents(owner, repoName, path))
+                .First();
+            var oldContent = _dtos.Deserialize<ModlistMetadata[]>(oldData.Content);
+            var list = oldContent.First(c => c.Links.MachineURL == machineUrl);
+            list.Version = version;
+            list.DownloadMetadata = metadata;
+            list.Links.Download = downloadUrl.ToString();
+            list.DateUpdated = DateTime.UtcNow;
+
+            var newContent = _dtos.Serialize(oldContent, true);
+            // Ensure game names are lowercase
+            newContent = GameRegistry.Games.Keys.Aggregate(newContent,
+                (current, g) => current.Replace($"\"game\": \"{g}\",", $"\"game\": \"{g.ToString().ToLower()}\","));
+
+            var updateRequest = new UpdateFileRequest($"New release of {machineUrl}", newContent, oldData.Sha);
+            await ghClient.Repository.Content.UpdateFile(owner, repoName, path, updateRequest);
+        });
 
-        var updateRequest = new UpdateFileRequest($"New release of {machineUrl}", newContent, oldData.Sha);
-        await ghClient.Repository.Content.UpdateFile(owner, repoName, path, updateRequest);
+        return (progress, publishTask);
     }
+
 }