feat(Update::Postpone): User can now decide to postpone the update and be reminded about it at a later date.

Author: Belphemur

SoundSwitch/Framework/Configuration/ISoundSwitchConfiguration.cs

@@ -14,13 +14,15 @@
 
 using System;
 using System.Collections.Generic;
+using JetBrains.Annotations;
 using SoundSwitch.Common.Framework.Audio.Device;
 using SoundSwitch.Framework.DeviceCyclerManager;
 using SoundSwitch.Framework.NotificationManager;
 using SoundSwitch.Framework.Profile;
 using SoundSwitch.Framework.TrayIcon.Icon;
 using SoundSwitch.Framework.TrayIcon.TooltipInfoManager.TootipInfo;
 using SoundSwitch.Framework.Updater;
+using SoundSwitch.Framework.Updater.Remind;
 using SoundSwitch.Framework.WinApi.Keyboard;
 using SoundSwitch.Localization.Factory;
 
@@ -69,6 +71,9 @@ public interface ISoundSwitchConfiguration : IConfiguration
         /// Unique ID assigned at installation
         /// </summary>
         Guid UniqueInstallationId { get; set; }
+        
+        [CanBeNull]
+        ReleasePostponed Postponed { get; set; }
 
         /// <summary>
         /// Fields of the config that got migrated

SoundSwitch/Framework/Configuration/SoundSwitchConfiguration.cs

@@ -27,6 +27,7 @@
 using SoundSwitch.Framework.TrayIcon.Icon;
 using SoundSwitch.Framework.TrayIcon.TooltipInfoManager.TootipInfo;
 using SoundSwitch.Framework.Updater;
+using SoundSwitch.Framework.Updater.Remind;
 using SoundSwitch.Framework.WinApi.Keyboard;
 using SoundSwitch.Localization.Factory;
 
@@ -101,6 +102,8 @@ public SoundSwitchConfiguration()
 
         public HashSet<Profile.Profile> Profiles { get; set; } = new();
 
+        public ReleasePostponed Postponed { get; set; }
+
         /// <summary>
         /// Fields of the config that got migrated
         /// </summary>

SoundSwitch/Framework/Updater/Installer/WebFile.cs

@@ -45,6 +45,7 @@ public WebFile(Uri fileUri, string filePath)
 
         public Uri FileUri { get; }
         public string FilePath { get; }
+        public bool DownloadStarted { get; private set; }
 
         private static string DefaultFilePath(Uri fileUri)
         {
@@ -88,6 +89,7 @@ public void DownloadFile()
                 {
                     await using (var stream = File.OpenWrite(FilePath))
                     {
+                        DownloadStarted = true;
                         await FileDownloader.DownloadFileAsync(
                             FileUri,
                             stream,

SoundSwitch/Framework/Updater/Release.cs

@@ -30,5 +30,10 @@ public Release(Version releaseVersion, GitHubRelease.Asset asset, string name)
         public GitHubRelease.Asset Asset { get; private set; }
         public List<string> Changelog { get; } = new List<string>();
         public string Name { get; private set; }
+
+        public override string ToString()
+        {
+            return $"{nameof(ReleaseVersion)}: {ReleaseVersion}, {nameof(Name)}: {Name}";
+        }
     }
 }

SoundSwitch/Framework/Updater/Remind/ReleasePostponed.cs

@@ -0,0 +1,22 @@
+using System;
+
+namespace SoundSwitch.Framework.Updater.Remind
+{
+    public record ReleasePostponed(Version Version, DateTime Until)
+    {
+        /// <summary>
+        /// Return true if the release should be postponed, false if it can be done now.
+        /// </summary>
+        /// <param name="release"></param>
+        /// <returns></returns>
+        public bool ShouldPostpone(Release release)
+        {
+            if (release.ReleaseVersion > Version)
+            {
+                return false;
+            }
+
+            return Until > DateTime.UtcNow;
+        }
+    }
+}

SoundSwitch/Framework/Updater/UpdateChecker.cs

@@ -66,6 +66,8 @@ private bool ProcessRelease(GitHubRelease serverRelease)
                         return false;
                     }
 
+              
+
                     var changelog = Regex.Split(serverRelease.body, "\r\n|\r|\n");
                     var release = new Release(version, installer, serverRelease.name);
                     release.Changelog.AddRange(changelog);

SoundSwitch/Localization/UpdateDownloadStrings.Designer.cs

@@ -115,4 +115,7 @@
   <data name="notSigned" xml:space="preserve">
 		<value>La mise à jour téléchargée ne comporte pas de signature valide. Nous vous conseillons de supprimer le fichier et de contacter le développeur !</value>
   </data>
+  <data name="remindMe" xml:space="preserve">
+	  <value>Plus tard</value>
+  </data>
 </root>

SoundSwitch/Localization/UpdateDownloadStrings.fr.resx

@@ -115,4 +115,7 @@
 	<data name="notSignedTitle" xml:space="preserve">
 		<value>Invalid Digital Signature</value>
 	</data>
+	<data name="remindMe" xml:space="preserve">
+		<value>Later</value>
+	</data>
 </root>

SoundSwitch/Localization/UpdateDownloadStrings.resx

@@ -34,6 +34,7 @@
 using SoundSwitch.Framework.Profile.Trigger;
 using SoundSwitch.Framework.Updater;
 using SoundSwitch.Framework.Updater.Job;
+using SoundSwitch.Framework.Updater.Remind;
 using SoundSwitch.Framework.WinApi;
 using SoundSwitch.Framework.WinApi.Keyboard;
 using SoundSwitch.Localization;
@@ -160,6 +161,16 @@ public UpdateMode UpdateMode
             }
         }
 
+        public ReleasePostponed ReleasePostponed
+        {
+            get => AppConfigs.Configuration.Postponed;
+            set
+            {
+                AppConfigs.Configuration.Postponed = value;
+                AppConfigs.Configuration.Save();
+            }
+        }
+
         public Language Language
         {
             get => AppConfigs.Configuration.Language;

SoundSwitch/Model/AppModel.cs

@@ -21,6 +21,7 @@
 using SoundSwitch.Framework.NotificationManager;
 using SoundSwitch.Framework.Profile;
 using SoundSwitch.Framework.Updater;
+using SoundSwitch.Framework.Updater.Remind;
 using SoundSwitch.Framework.WinApi.Keyboard;
 using SoundSwitch.Localization.Factory;
 using SoundSwitch.UI.Component;
@@ -114,6 +115,11 @@ public interface IAppModel : IDisposable
         /// </summary>
         IAudioDeviceLister ActiveUnpluggedAudioLister { get; set; }
 
+        /// <summary>
+        /// Do we have a postponement for a specific release
+        /// </summary>
+        ReleasePostponed ReleasePostponed { get; set; }
+
         #endregion
 
         #region Events

SoundSwitch/Model/IAppModel.cs

@@ -35,6 +35,7 @@
     <ItemGroup>
         <PackageReference Include="AuthenticodeExaminer" Version="0.3.0" />
         <PackageReference Include="ContribSentry" Version="4.0.0" />
+        <PackageReference Include="JetBrains.Annotations" Version="2021.1.0" />
         <PackageReference Include="Job.Scheduler" Version="2.2.0" />
         <PackageReference Include="Markdig" Version="0.24.0" />
         <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />

SoundSwitch/SoundSwitch.csproj

@@ -241,9 +241,16 @@ private void SetEventHandlers()
 
         private void NewReleaseAvailable(object sender, UpdateChecker.NewReleaseEvent newReleaseEvent)
         {
-            StartAnimationIconUpdate();
+ 
             _updateMenuItem.Tag = newReleaseEvent.Release;
             _updateMenuItem.Text = string.Format(TrayIconStrings.updateAvailable, newReleaseEvent.Release.ReleaseVersion);
+            var configurationPostponed = AppConfigs.Configuration.Postponed;
+            if (configurationPostponed?.ShouldPostpone(newReleaseEvent.Release) ?? false)
+            {
+                Log.Information("Release {release} has been postponed to {date:yyyy-MM-dd hh:mm}", newReleaseEvent.Release, configurationPostponed.Until);
+                return;
+            }
+            StartAnimationIconUpdate();
             NotifyIcon.BalloonTipClicked += OnUpdateClick;
             NotifyIcon.ShowBalloonTip(3000, string.Format(TrayIconStrings.versionAvailable, newReleaseEvent.Release.ReleaseVersion), newReleaseEvent.Release.Name + '\n' + TrayIconStrings.clickToUpdate, ToolTipIcon.Info);
         }

SoundSwitch/UI/Component/TrayIcon.cs

@@ -15,9 +15,12 @@
 using System;
 using System.Windows.Forms;
 using Serilog;
+using SoundSwitch.Framework.Configuration;
 using SoundSwitch.Framework.Updater;
 using SoundSwitch.Framework.Updater.Installer;
+using SoundSwitch.Framework.Updater.Remind;
 using SoundSwitch.Localization;
+using SoundSwitch.Model;
 using SoundSwitch.Properties;
 using SoundSwitch.UI.Component;
 
@@ -26,6 +29,7 @@ namespace SoundSwitch.UI.Forms
     public sealed partial class UpdateDownloadForm : Form
     {
         private WebFile _releaseFile;
+        private Release _releaseInfo;
 
         public UpdateDownloadForm()
         {
@@ -40,6 +44,7 @@ public UpdateDownloadForm()
 
         public void DownloadRelease(Release release)
         {
+            _releaseInfo = release;
             installButton.Enabled = true;
             changeLog.SetChangelog(release.Changelog);
             Name = release.Name;
@@ -83,7 +88,14 @@ public void DownloadRelease(Release release)
                 }
 
                 new UpdateRunner().RunUpdate(_releaseFile, "/SILENT");
-                BeginInvoke((Action) Close);
+                if (InvokeRequired)
+                {
+                    BeginInvoke((Action) Close);
+                }
+                else
+                {
+                    Close();
+                }
             };
             ShowDialog();
         }
@@ -92,13 +104,20 @@ private void LocalizeForm()
         {
             // Misc
             changeLogGroup.Text = UpdateDownloadStrings.changelog;
-            cancelButton.Text = UpdateDownloadStrings.cancel;
+            cancelButton.Text = UpdateDownloadStrings.remindMe;
             installButton.Text = UpdateDownloadStrings.install;
         }
 
         private void cancelButton_Click(object sender, EventArgs e)
         {
-            _releaseFile.CancelDownload();
+            if (_releaseFile.DownloadStarted)
+            {
+                _releaseFile.CancelDownload();
+            }
+            else
+            {
+                AppModel.Instance.ReleasePostponed = new ReleasePostponed(_releaseInfo.ReleaseVersion, DateTime.UtcNow + 3 * TimeSpan.FromSeconds(AppConfigs.Configuration.UpdateCheckInterval));
+            }
             Close();
         }
 
@@ -108,6 +127,7 @@ private void installButton_Click(object sender, EventArgs e)
             downloadProgress.Visible = true;
             _releaseFile.DownloadFile();
             installButton.Enabled = false;
+            cancelButton.Text = UpdateDownloadStrings.cancel;
         }
 
         private void UpdateDownloadForm_FormClosing(object sender, FormClosingEventArgs e)