Asyny methods now support the use of cancelation tokens

Author: basicx-StrgV

src/WGet.NET/Components/Internal/ProcessManager.cs

@@ -4,6 +4,7 @@
 //--------------------------------------------------//
 using System.IO;
 using System.Text;
+using System.Threading;
 using System.Diagnostics;
 using System.Threading.Tasks;
 using WGetNET.Models;
@@ -58,13 +59,16 @@ public ProcessResult ExecuteWingetProcess(string cmd)
         /// <param name="cmd">
         /// A <see cref="string"/> representing the command that winget should be executed with.
         /// </param>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
         /// A <see cref="ProcessResult"/> object, 
         /// containing the output an exit id of the process.
         /// </returns>
-        public async Task<ProcessResult> ExecuteWingetProcessAsync(string cmd)
+        public async Task<ProcessResult> ExecuteWingetProcessAsync(string cmd, CancellationToken cancellationToken = default)
         {
-            return await RunProcessAsync(GetStartInfo(cmd));
+            return await RunProcessAsync(GetStartInfo(cmd), cancellationToken);
         }
 
         /// <summary>
@@ -93,8 +97,11 @@ private ProcessStartInfo GetStartInfo(string cmd)
         /// <summary>
         /// Runs a process with the current start informations.
         /// </summary>
+        /// <param name="processStartInfo">
+        /// The <see cref="System.Diagnostics.ProcessStartInfo"/> for process that should be executed.
+        /// </param>
         /// <returns>
-        /// A <see cref="ProcessResult"/> object, 
+        /// A <see cref="WGetNET.Models.ProcessResult"/> object, 
         /// containing the output an exit id of the process.
         /// </returns>
         private ProcessResult RunProcess(ProcessStartInfo processStartInfo)
@@ -119,11 +126,17 @@ private ProcessResult RunProcess(ProcessStartInfo processStartInfo)
         /// <summary>
         /// Asynchronous runs a process with the current start informations.
         /// </summary>
+        /// <param name="processStartInfo">
+        /// The <see cref="System.Diagnostics.ProcessStartInfo"/> for process that should be executed.
+        /// </param>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
-        /// A <see cref="ProcessResult"/> object, 
+        /// A <see cref="WGetNET.Models.ProcessResult"/> object, 
         /// containing the output an exit id of the process.
         /// </returns>
-        private async Task<ProcessResult> RunProcessAsync(ProcessStartInfo processStartInfo)
+        private async Task<ProcessResult> RunProcessAsync(ProcessStartInfo processStartInfo, CancellationToken cancellationToken = default)
         {
             ProcessResult result = new();
 
@@ -132,10 +145,27 @@ private async Task<ProcessResult> RunProcessAsync(ProcessStartInfo processStartI
             {
                 proc.Start();
 
-                result.Output = await ReadSreamOutputAsync(proc.StandardOutput);
+                result.Output = await ReadSreamOutputAsync(proc.StandardOutput, cancellationToken);
 
-                //Wait till end and get exit code
+                // Kill the process and return, if the task is canceled
+                if (cancellationToken.IsCancellationRequested && !proc.HasExited)
+                {
+                    proc.Kill();
+
+                    result.ExitCode = -1;
+
+                    return result;
+                }
+
+                //Wait for the processs to exit
                 proc.WaitForExit();
+
+                // Make sure the process has exited
+                if (!proc.HasExited)
+                {
+                    proc.Kill();
+                }
+
                 result.ExitCode = proc.ExitCode;
             }
 
@@ -175,19 +205,27 @@ private string[] ReadSreamOutput(StreamReader output)
         /// Asynchronous reads the data from the process output to a string array.
         /// </summary>
         /// <param name="output">
-        /// The <see cref="StreamReader"/> with the process output.
+        /// The <see cref="System.IO.StreamReader"/> with the process output.
+        /// </param>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
         /// </param>
         /// <returns>
         /// A <see cref="string"/> array 
         /// containing the process output stream content by lines.
         /// </returns>
-        private async Task<string[]> ReadSreamOutputAsync(StreamReader output)
+        private async Task<string[]> ReadSreamOutputAsync(StreamReader output, CancellationToken cancellationToken = default)
         {
             string[] outputArray = new string[0];
 
             //Read output to list
             while (!output.EndOfStream)
             {
+                if (cancellationToken.IsCancellationRequested)
+                {
+                    break;
+                }
+
                 string? outputLine = await output.ReadLineAsync();
                 if (outputLine is null)
                 {

src/WGet.NET/Components/WinGet.cs

@@ -5,6 +5,7 @@
 using System;
 using System.IO;
 using System.Security;
+using System.Threading;
 using System.Threading.Tasks;
 using System.Security.Principal;
 using System.Collections.Generic;
@@ -154,16 +155,19 @@ public string ExportSettings()
         /// <summary>
         /// Asynchronous exports the WinGet settings to a json string.
         /// </summary>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
         /// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
         /// The result is a <see cref="System.String"/> containing the settings json.
         /// </returns>
         /// <exception cref="WGetNET.Exceptions.WinGetNotInstalledException">
         /// WinGet is not installed or not found on the system.
         /// </exception>
-        public async Task<string> ExportSettingsAsync()
+        public async Task<string> ExportSettingsAsync(CancellationToken cancellationToken = default)
         {
-            ProcessResult result = await ExecuteAsync(_exportSettingsCmd);
+            ProcessResult result = await ExecuteAsync(_exportSettingsCmd, false, cancellationToken);
 
             return _outputReader.ExportOutputToString(result);
         }
@@ -222,6 +226,9 @@ public void ExportSettingsToFile(string file)
         /// <param name="file">
         /// The file for the export.
         /// </param>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
         /// The <see cref="System.Threading.Tasks.Task"/> for the action.
         /// </returns>
@@ -254,14 +261,14 @@ public void ExportSettingsToFile(string file)
         /// <exception cref="System.Security.SecurityException">
         /// The caller does not have the required permission.
         /// </exception>
-        public async Task ExportSettingsToFileAsync(string file)
+        public async Task ExportSettingsToFileAsync(string file, CancellationToken cancellationToken = default)
         {
             ArgsHelper.ThrowIfStringIsNullOrWhiteSpace(file, "file");
             ArgsHelper.ThrowIfPathIsInvalid(file);
 
-            ProcessResult result = await ExecuteAsync(_exportSettingsCmd);
+            ProcessResult result = await ExecuteAsync(_exportSettingsCmd, false, cancellationToken);
 
-            await FileHelper.WriteTextToFileAsync(file, OutputReader.ExportOutputToString(result));
+            await FileHelper.WriteTextToFileAsync(file, OutputReader.ExportOutputToString(result), cancellationToken);
         }
         //---------------------------------------------------------------------------------------------
 
@@ -308,21 +315,24 @@ public List<WinGetAdminSetting> GetAdminSettings()
         /// <summary>
         /// Asynchronously gets all winget admin settings.
         /// </summary>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
         /// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
         /// The result is a <see cref="System.Collections.Generic.List{T}"/> of <see cref="WGetNET.WinGetAdminSetting"/> object.
         /// </returns>
         /// <exception cref="WGetNET.Exceptions.WinGetNotInstalledException">
         /// WinGet is not installed or not found on the system.
         /// </exception>
-        public async Task<List<WinGetAdminSetting>> GetAdminSettingsAsync()
+        public async Task<List<WinGetAdminSetting>> GetAdminSettingsAsync(CancellationToken cancellationToken = default)
         {
             List<WinGetAdminSetting> adminSettings = new();
 
-            string settingsJson = await ExportSettingsAsync();
+            string settingsJson = await ExportSettingsAsync(cancellationToken);
 
 #if NETCOREAPP3_1_OR_GREATER
-            SettingsModel settings = await JsonHelper.StringToObjectAsync<SettingsModel>(settingsJson);
+            SettingsModel settings = await JsonHelper.StringToObjectAsync<SettingsModel>(settingsJson, cancellationToken);
 #elif NETSTANDARD2_0
             SettingsModel settings = JsonHelper.StringToObject<SettingsModel>(settingsJson);
 #endif
@@ -334,6 +344,11 @@ public async Task<List<WinGetAdminSetting>> GetAdminSettingsAsync()
             AdminSettingBuilder builder = new();
             foreach (KeyValuePair<string, bool> entry in settings.AdminSettings)
             {
+                if (cancellationToken.IsCancellationRequested)
+                {
+                    return adminSettings;
+                }
+
                 builder.Clear();
 
                 builder.AddEntryName(entry.Key);
@@ -415,6 +430,9 @@ public bool EnableAdminSetting(WinGetAdminSetting setting)
         /// <param name="settingName">
         /// Name of the admin setting to enable.
         /// </param>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
         /// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
         /// The result is <see langword="true"/> if the action was succesfull and <see langword="false"/> if it failed.
@@ -431,13 +449,13 @@ public bool EnableAdminSetting(WinGetAdminSetting setting)
         /// <exception cref="System.Security.SecurityException">
         /// The current user is missing administrator privileges for this call.
         /// </exception>
-        public async Task<bool> EnableAdminSettingAsync(string settingName)
+        public async Task<bool> EnableAdminSettingAsync(string settingName, CancellationToken cancellationToken = default)
         {
             ArgsHelper.ThrowIfStringIsNullOrWhiteSpace(settingName, "settingName");
 
             string cmd = string.Format(_settingsEnableCmd, settingName);
 
-            ProcessResult result = await ExecuteAsync(cmd, true);
+            ProcessResult result = await ExecuteAsync(cmd, true, cancellationToken);
 
             return result.Success;
         }
@@ -448,6 +466,9 @@ public async Task<bool> EnableAdminSettingAsync(string settingName)
         /// <param name="setting">
         /// The <see cref="WGetNET.WinGetAdminSetting"/> to enable.
         /// </param>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
         /// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
         /// The result is <see langword="true"/> if the action was succesfull and <see langword="false"/> if it failed.
@@ -464,11 +485,11 @@ public async Task<bool> EnableAdminSettingAsync(string settingName)
         /// <exception cref="System.Security.SecurityException">
         /// The current user is missing administrator privileges for this call.
         /// </exception>
-        public async Task<bool> EnableAdminSettingAsynv(WinGetAdminSetting setting)
+        public async Task<bool> EnableAdminSettingAsync(WinGetAdminSetting setting, CancellationToken cancellationToken = default)
         {
             ArgsHelper.ThrowIfObjectIsNull(setting, "setting");
 
-            return await EnableAdminSettingAsync(setting.EntryName);
+            return await EnableAdminSettingAsync(setting.EntryName, cancellationToken);
         }
 
         /// <summary>
@@ -537,6 +558,9 @@ public bool DisableAdminSetting(WinGetAdminSetting setting)
         /// <param name="settingName">
         /// Name of the admin setting to disable.
         /// </param>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
         /// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
         /// The result is <see langword="true"/> if the action was succesfull and <see langword="false"/> if it failed.
@@ -553,13 +577,13 @@ public bool DisableAdminSetting(WinGetAdminSetting setting)
         /// <exception cref="System.Security.SecurityException">
         /// The current user is missing administrator privileges for this call.
         /// </exception>
-        public async Task<bool> DisableAdminSettingAsync(string settingName)
+        public async Task<bool> DisableAdminSettingAsync(string settingName, CancellationToken cancellationToken = default)
         {
             ArgsHelper.ThrowIfStringIsNullOrWhiteSpace(settingName, "settingName");
 
             string cmd = string.Format(_settingsDisableCmd, settingName);
 
-            ProcessResult result = await ExecuteAsync(cmd, true);
+            ProcessResult result = await ExecuteAsync(cmd, true, cancellationToken);
 
             return result.Success;
         }
@@ -570,6 +594,9 @@ public async Task<bool> DisableAdminSettingAsync(string settingName)
         /// <param name="setting">
         /// The <see cref="WGetNET.WinGetAdminSetting"/> to disable.
         /// </param>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
         /// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
         /// The result is <see langword="true"/> if the action was succesfull and <see langword="false"/> if it failed.
@@ -586,11 +613,11 @@ public async Task<bool> DisableAdminSettingAsync(string settingName)
         /// <exception cref="System.Security.SecurityException">
         /// The current user is missing administrator privileges for this call.
         /// </exception>
-        public async Task<bool> DisableAdminSettingAsync(WinGetAdminSetting setting)
+        public async Task<bool> DisableAdminSettingAsync(WinGetAdminSetting setting, CancellationToken cancellationToken = default)
         {
             ArgsHelper.ThrowIfObjectIsNull(setting, "setting");
 
-            return await DisableAdminSettingAsync(setting.EntryName);
+            return await DisableAdminSettingAsync(setting.EntryName, cancellationToken);
         }
         //---------------------------------------------------------------------------------------------
 
@@ -628,17 +655,21 @@ public WinGetInfo GetInfo()
         /// <summary>
         /// Asynchronous gets all WinGet related data provided by the WinGet info action.
         /// </summary>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
         /// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
         /// The result is a <see cref="WGetNET.WinGetInfo"/> object containing winget related information.
         /// </returns>
         /// <exception cref="WGetNET.Exceptions.WinGetNotInstalledException">
         /// WinGet is not installed or not found on the system.
         /// </exception>
-        public async Task<WinGetInfo> GetInfoAsync()
+        public async Task<WinGetInfo> GetInfoAsync(CancellationToken cancellationToken = default)
         {
-            ProcessResult result = await ExecuteAsync(_infoCmd);
+            ProcessResult result = await ExecuteAsync(_infoCmd, false, cancellationToken);
 
+            // Check the version range the action should be performed for
             InfoActionVersionId actionVersionId = InfoActionVersionId.VersionRange1;
             if (CheckWinGetVersion(new Version(1, 4, 3531), new Version(1, 5, 101)))
             {
@@ -653,6 +684,12 @@ public async Task<WinGetInfo> GetInfoAsync()
                 actionVersionId = InfoActionVersionId.VersionRange4;
             }
 
+            // Return empty data if the task was canceled
+            if (cancellationToken.IsCancellationRequested)
+            {
+                return WinGetInfo.Empty;
+            }
+
             return _outputReader.ToWingetInfo(result.Output, actionVersionId);
         }
         //---------------------------------------------------------------------------------------------
@@ -723,6 +760,9 @@ private protected ProcessResult Execute(string args, bool needsAdminRights = fal
         /// <param name="needsAdminRights">
         /// Sets if the process that should be executed needs administrator privileges.
         /// </param>
+        /// <param name="cancellationToken">
+        /// The <see cref="System.Threading.CancellationToken"/> for the <see cref="System.Threading.Tasks.Task"/>.
+        /// </param>
         /// <returns>
         /// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
         /// The result is the <see cref="WGetNET.Models.ProcessResult"/> for the process.
@@ -734,7 +774,7 @@ private protected ProcessResult Execute(string args, bool needsAdminRights = fal
         /// The current process does not have administrator privileges.
         /// (Only if <paramref name="needsAdminRights"/> is set to <see langword="true"/>)
         /// </exception>
-        private protected async Task<ProcessResult> ExecuteAsync(string args, bool needsAdminRights = false)
+        private protected async Task<ProcessResult> ExecuteAsync(string args, bool needsAdminRights = false, CancellationToken cancellationToken = default)
         {
             ThrowIfNotInstalled();
 
@@ -743,7 +783,7 @@ private protected async Task<ProcessResult> ExecuteAsync(string args, bool needs
                 ThrowIfNotAdmin();
             }
 
-            return await _processManager.ExecuteWingetProcessAsync(args);
+            return await _processManager.ExecuteWingetProcessAsync(args, cancellationToken);
         }
         // \endcond
         //---------------------------------------------------------------------------------------------