async cancellationToken support

JoshuaMiller · JoshuaMiller · commit 2dc23b1ec08b · 2018-06-09T17:53:12.000-04:00
diff --git a/Jenkins.NET/Internal/Commands/BuildGetCommand.cs b/Jenkins.NET/Internal/Commands/BuildGetCommand.cs
@@ -28,7 +28,7 @@ public BuildGetCommand(IJenkinsContext context, string jobName, string buildNumb
                 request.Method = "POST";
             };
 
-            OnReadAsync = async response => {
+            OnReadAsync = async (response, token) => {
                 var document = await ReadXmlAsync(response);
 
                 var args = new object[] {document.Root};
diff --git a/Jenkins.NET/Internal/Commands/BuildOutputCommand.cs b/Jenkins.NET/Internal/Commands/BuildOutputCommand.cs
@@ -1,5 +1,5 @@
 ﻿using System;
-using System.IO;
+using System.Text;
 
 namespace JenkinsNET.Internal.Commands
 {
@@ -24,13 +24,12 @@ public BuildOutputCommand(IJenkinsContext context, string jobName, string buildN
             Password = context.Password;
             Crumb = context.Crumb;
 
-            OnReadAsync = async response => {
+            OnReadAsync = async (response, token) => {
                 using (var stream = response.GetResponseStream()) {
                     if (stream == null) return;
 
-                    using (var reader = new StreamReader(stream)) {
-                        Result = await reader.ReadToEndAsync();
-                    }
+                    var encoding = TryGetEncoding(response.ContentEncoding, Encoding.UTF8);
+                    Result = await stream.ReadToEndAsync(encoding, token);
                 }
             };
         }
diff --git a/Jenkins.NET/Internal/Commands/BuildProgressiveHtmlCommand.cs b/Jenkins.NET/Internal/Commands/BuildProgressiveHtmlCommand.cs
@@ -1,6 +1,7 @@
 ﻿using JenkinsNET.Models;
 using System;
 using System.IO;
+using System.Text;
 
 namespace JenkinsNET.Internal.Commands
 {
@@ -25,7 +26,7 @@ public BuildProgressiveHtmlCommand(IJenkinsContext context, string jobName, stri
             Password = context.Password;
             Crumb = context.Crumb;
 
-            OnWriteAsync = async (request) => {
+            OnWriteAsync = async (request, token) => {
                 request.Method = "POST";
                 request.ContentType = "application/x-www-form-urlencoded; charset=UTF-8";
 
@@ -35,7 +36,7 @@ public BuildProgressiveHtmlCommand(IJenkinsContext context, string jobName, stri
                 }
             };
 
-            OnReadAsync = async response => {
+            OnReadAsync = async (response, token) => {
                 var hSize = response.Headers["X-Text-Size"];
                 var hMoreData = response.Headers["X-More-Data"];
 
@@ -52,9 +53,8 @@ public BuildProgressiveHtmlCommand(IJenkinsContext context, string jobName, stri
                 using (var stream = response.GetResponseStream()) {
                     if (stream == null) return;
 
-                    using (var reader = new StreamReader(stream)) {
-                        Result.Html = await reader.ReadToEndAsync();
-                    }
+                    var encoding = TryGetEncoding(response.ContentEncoding, Encoding.UTF8);
+                    Result.Html = await stream.ReadToEndAsync(encoding, token);
                 }
             };
         }
diff --git a/Jenkins.NET/Internal/Commands/BuildProgressiveTextCommand.cs b/Jenkins.NET/Internal/Commands/BuildProgressiveTextCommand.cs
@@ -1,6 +1,7 @@
 ﻿using JenkinsNET.Models;
 using System;
 using System.IO;
+using System.Text;
 
 namespace JenkinsNET.Internal.Commands
 {
@@ -25,7 +26,7 @@ public BuildProgressiveTextCommand(IJenkinsContext context, string jobName, stri
             Password = context.Password;
             Crumb = context.Crumb;
 
-            OnWriteAsync = async (request) => {
+            OnWriteAsync = async (request, token) => {
                 request.Method = "POST";
                 request.ContentType = "application/x-www-form-urlencoded; charset=UTF-8";
 
@@ -35,7 +36,7 @@ public BuildProgressiveTextCommand(IJenkinsContext context, string jobName, stri
                 }
             };
 
-            OnReadAsync = async response => {
+            OnReadAsync = async (response, token) => {
                 var hSize = response.Headers["X-Text-Size"];
                 var hMoreData = response.Headers["X-More-Data"];
 
@@ -52,9 +53,8 @@ public BuildProgressiveTextCommand(IJenkinsContext context, string jobName, stri
                 using (var stream = response.GetResponseStream()) {
                     if (stream == null) return;
 
-                    using (var reader = new StreamReader(stream)) {
-                        Result.Text = await reader.ReadToEndAsync();
-                    }
+                    var encoding = TryGetEncoding(response.ContentEncoding, Encoding.UTF8);
+                    Result.Text = await stream.ReadToEndAsync(encoding, token);
                 }
             };
         }
diff --git a/Jenkins.NET/Internal/Commands/JenkinsGetCommand.cs b/Jenkins.NET/Internal/Commands/JenkinsGetCommand.cs
@@ -23,7 +23,7 @@ public JenkinsGetCommand(IJenkinsContext context)
                 request.Method = "GET";
             };
 
-            OnReadAsync = async response => {
+            OnReadAsync = async (response, token) => {
                 var document = await ReadXmlAsync(response);
                 Result = new Jenkins(document.Root);
             };
diff --git a/Jenkins.NET/Internal/Commands/JobCreateCommand.cs b/Jenkins.NET/Internal/Commands/JobCreateCommand.cs
@@ -1,6 +1,5 @@
 ﻿using JenkinsNET.Models;
 using System;
-using System.Xml;
 
 namespace JenkinsNET.Internal.Commands
 {
@@ -24,10 +23,10 @@ public JobCreateCommand(IJenkinsContext context, string jobName, JenkinsProject
             Password = context.Password;
             Crumb = context.Crumb;
 
-            OnWriteAsync = async request => {
+            OnWriteAsync = async (request, token) => {
                 request.Method = "POST";
                 request.ContentType = "application/xml";
-                await WriteXmlAsync(request, job.Node);
+                await WriteXmlAsync(request, job.Node, token);
             };
         }
     }
diff --git a/Jenkins.NET/Internal/Commands/JobGetCommand.cs b/Jenkins.NET/Internal/Commands/JobGetCommand.cs
@@ -26,10 +26,10 @@ public JobGetCommand(IJenkinsContext context, string jobName)
                 request.Method = "GET";
             };
 
-            OnReadAsync = async response => {
+            OnReadAsync = async (response, token) => {
                 var document = await ReadXmlAsync(response);
 
-                Result = Activator.CreateInstance(typeof(T), new[] {document.Root}) as T;
+                Result = Activator.CreateInstance(typeof(T), document.Root) as T;
             };
         }
     }
diff --git a/Jenkins.NET/Internal/Commands/JobGetConfigCommand.cs b/Jenkins.NET/Internal/Commands/JobGetConfigCommand.cs
@@ -26,7 +26,7 @@ public JobGetConfigCommand(IJenkinsContext context, string jobName)
                 request.Method = "GET";
             };
 
-            OnReadAsync = async response => {
+            OnReadAsync = async (response, token) => {
                 var document = await ReadXmlAsync(response);
                 Result = new JenkinsProject(document.Root);
             };
diff --git a/Jenkins.NET/Internal/Commands/JobUpdateConfigurationCommand.cs b/Jenkins.NET/Internal/Commands/JobUpdateConfigurationCommand.cs
@@ -23,10 +23,10 @@ public JobUpdateConfigurationCommand(IJenkinsContext context, string jobName, Je
             Password = context.Password;
             Crumb = context.Crumb;
 
-            OnWriteAsync = async request => {
+            OnWriteAsync = async (request, token) => {
                 request.Method = "POST";
                 request.ContentType = "application/xml";
-                await WriteXmlAsync(request, job.Node);
+                await WriteXmlAsync(request, job.Node, token);
             };
         }
     }
diff --git a/Jenkins.NET/Internal/JenkinsHttpCommand.cs b/Jenkins.NET/Internal/JenkinsHttpCommand.cs
@@ -4,6 +4,7 @@
 using System.Net;
 using System.Text;
 using System.Text.RegularExpressions;
+using System.Threading;
 using System.Threading.Tasks;
 using System.Xml;
 using System.Xml.Linq;
@@ -18,33 +19,36 @@ internal class JenkinsHttpCommand
         public JenkinsCrumb Crumb {get; set;}
         public Action<HttpWebRequest> OnWrite {get; set;}
         public Action<HttpWebResponse> OnRead {get; set;}
-        public Func<HttpWebRequest, Task> OnWriteAsync {get; set;}
-        public Func<HttpWebResponse, Task> OnReadAsync {get; set;}
+        public Func<HttpWebRequest, CancellationToken, Task> OnWriteAsync {get; set;}
+        public Func<HttpWebResponse, CancellationToken, Task> OnReadAsync {get; set;}
 
 
         public void Run()
         {
             var request = CreateRequest();
 
             if (OnWrite != null) OnWrite.Invoke(request);
-            else if (OnWriteAsync != null) OnWriteAsync.Invoke(request).GetAwaiter().GetResult();
+            else OnWriteAsync?.Invoke(request, CancellationToken.None).GetAwaiter().GetResult();
 
             using (var response = (HttpWebResponse)request.GetResponse()) {
                 if (OnRead != null) OnRead?.Invoke(response);
-                else if (OnReadAsync != null) OnReadAsync.Invoke(response).GetAwaiter().GetResult();
+                else OnReadAsync?.Invoke(response, CancellationToken.None).GetAwaiter().GetResult();
             }
         }
 
-        public async Task RunAsync()
+        public async Task RunAsync(CancellationToken token = default(CancellationToken))
         {
             var request = CreateRequest();
 
-            if (OnWriteAsync != null) await OnWriteAsync.Invoke(request);
-            else if (OnWrite != null) OnWrite.Invoke(request);
+            if (OnWriteAsync != null) await OnWriteAsync.Invoke(request, token);
+            else OnWrite?.Invoke(request);
 
+            using (token.Register(() => request.Abort(), false))
             using (var response = (HttpWebResponse)await request.GetResponseAsync()) {
-                if (OnReadAsync != null) await OnReadAsync.Invoke(response);
-                else if (OnRead != null) OnRead?.Invoke(response);
+                token.ThrowIfCancellationRequested();
+
+                if (OnReadAsync != null) await OnReadAsync.Invoke(response, token);
+                else OnRead?.Invoke(response);
             }
         }
 
@@ -77,9 +81,12 @@ private HttpWebRequest CreateRequest()
         protected async Task<XDocument> ReadXmlAsync(HttpWebResponse response)
         {
             string xml;
-            using (var stream = response.GetResponseStream())
-            using (var reader = new StreamReader(stream)) {
-                xml = await reader.ReadToEndAsync();
+            using (var stream = response.GetResponseStream()) {
+                if (stream == null) return null;
+
+                using (var reader = new StreamReader(stream)) {
+                    xml = await reader.ReadToEndAsync();
+                }
             }
 
             // Remove Decleration
@@ -89,17 +96,30 @@ protected async Task<XDocument> ReadXmlAsync(HttpWebResponse response)
             return XDocument.Parse(xml);
         }
 
-        protected async Task WriteXmlAsync(HttpWebRequest request, XNode node)
+        protected async Task WriteXmlAsync(HttpWebRequest request, XNode node, CancellationToken token = default(CancellationToken))
         {
             var xmlSettings = new XmlWriterSettings {
                 ConformanceLevel = ConformanceLevel.Fragment,
                 Indent = false,
             };
 
+            using (token.Register(request.Abort, false))
             using (var stream = await request.GetRequestStreamAsync())
             using (var writer = XmlWriter.Create(stream, xmlSettings)) {
+                token.ThrowIfCancellationRequested();
+
                 node.WriteTo(writer);
             }
         }
+
+        protected static Encoding TryGetEncoding(string name, Encoding fallback)
+        {
+            try {
+                return Encoding.GetEncoding(name);
+            }
+            catch {
+                return fallback;
+            }
+        }
     }
 }
diff --git a/Jenkins.NET/Internal/StreamExtensions.cs b/Jenkins.NET/Internal/StreamExtensions.cs
@@ -0,0 +1,33 @@
+﻿using System.IO;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace JenkinsNET.Internal
+{
+    internal static class StreamExtensions
+    {
+        public static async Task CopyToAsync(this Stream srcStream, Stream destStream, CancellationToken token)
+        {
+            const int bufferSize = 4096;
+            var buffer = new byte[bufferSize];
+
+            while (true) {
+                token.ThrowIfCancellationRequested();
+
+                var readSize = await srcStream.ReadAsync(buffer, 0, bufferSize, token);
+                if (readSize == 0) break;
+
+                await destStream.WriteAsync(buffer, 0, readSize, token);
+            }
+        }
+
+        public static async Task<string> ReadToEndAsync(this Stream stream, Encoding encoding, CancellationToken token)
+        {
+            using (var bufferStream = new MemoryStream()) {
+                await stream.CopyToAsync(bufferStream, token);
+                return Encoding.UTF8.GetString(bufferStream.ToArray());
+            }
+        }
+    }
+}
diff --git a/Jenkins.NET/Internal/XNodeExtensions.cs b/Jenkins.NET/Internal/XNodeExtensions.cs
@@ -40,7 +40,7 @@ public static IEnumerable<T> WrapGroup<T>(this XNode parentNode, string expressi
         {
             return parentNode
                 .XPathSelectElements(expression)
-                .Select(n => wrapFunc(n));
+                .Select(wrapFunc);
         }
 
         private static string GetNodeValue(object node)
@@ -50,10 +50,16 @@ private static string GetNodeValue(object node)
                     .Cast<object>()
                     .FirstOrDefault();
 
-            if (node == null) return null;
-            if (node is XElement) return (node as XElement).Value;
-            if (node is XAttribute) return (node as XAttribute).Value;
-            throw new ApplicationException($"Unable to retrieve value from node of type '{node.GetType().Name}'!");
+            switch (node) {
+                case null:
+                    return null;
+                case XElement _e:
+                    return _e.Value;
+                case XAttribute _a:
+                    return _a.Value;
+                default:
+                    throw new ApplicationException($"Unable to retrieve value from node of type '{node.GetType().Name}'!");
+            }
         }
     }
 }
diff --git a/Jenkins.NET/Jenkins.NET.csproj b/Jenkins.NET/Jenkins.NET.csproj
@@ -71,6 +71,7 @@
     <Compile Include="Exceptions\JenkinsJobBuildException.cs" />
     <Compile Include="IJenkinsContext.cs" />
     <Compile Include="Internal\JenkinsHttpCommand.cs" />
+    <Compile Include="Internal\StreamExtensions.cs" />
     <Compile Include="Models\JenkinsBallColor.cs" />
     <Compile Include="Models\IJenkinsBuild.cs" />
     <Compile Include="Models\JenkinsBuildDescription.cs" />
diff --git a/Jenkins.NET/Jenkins.NET.nuspec b/Jenkins.NET/Jenkins.NET.nuspec
@@ -4,7 +4,8 @@
     <id>jenkinsnet</id>
     <title>Jenkins.NET</title>
     <version>$version$</version>
-    <authors>null511</authors>
+    <authors>Joshua Miller</authors>
+    <owners>null511</owners>
     <projectUrl>http://github.com/null511/Jenkins.NET</projectUrl>
     <iconUrl>https://github.com/null511/Jenkins.NET/raw/master/media/icon.png</iconUrl>
     <licenseUrl>https://raw.githubusercontent.com/null511/Jenkins.NET/master/LICENSE</licenseUrl>
diff --git a/Jenkins.NET/JenkinsClient.cs b/Jenkins.NET/JenkinsClient.cs
@@ -2,6 +2,7 @@
 using JenkinsNET.Internal.Commands;
 using JenkinsNET.Models;
 using System;
+using System.Threading;
 using System.Threading.Tasks;
 
 namespace JenkinsNET
@@ -100,12 +101,13 @@ public void UpdateSecurityCrumb()
         /// <summary>
         /// Updates the security Crumb attached to this client asynchronously.
         /// </summary>
+        /// <param name="token">An optional token for aborting the request.</param>
         /// <exception cref="JenkinsNetException"></exception>
-        public async Task UpdateSecurityCrumbAsync()
+        public async Task UpdateSecurityCrumbAsync(CancellationToken token = default(CancellationToken))
         {
             try {
                 var cmd = new CrumbGetCommand(this);
-                await cmd.RunAsync();
+                await cmd.RunAsync(token);
                 Crumb = cmd.Result;
             }
             catch (Exception error) {
@@ -132,12 +134,13 @@ public Jenkins Get()
         /// <summary>
         /// Gets the root description of the Jenkins node asynchronously.
         /// </summary>
+        /// <param name="token">An optional token for aborting the request.</param>
         /// <exception cref="JenkinsNetException"></exception>
-        public async Task<Jenkins> GetAsync()
+        public async Task<Jenkins> GetAsync(CancellationToken token = default(CancellationToken))
         {
             try {
                 var cmd = new JenkinsGetCommand(this);
-                await cmd.RunAsync();
+                await cmd.RunAsync(token);
                 return cmd.Result;
             }
             catch (Exception error) {
diff --git a/Jenkins.NET/JenkinsClientArtifacts.cs b/Jenkins.NET/JenkinsClientArtifacts.cs
diff --git a/Jenkins.NET/JenkinsClientBuilds.cs b/Jenkins.NET/JenkinsClientBuilds.cs
diff --git a/Jenkins.NET/JenkinsClientJobs.cs b/Jenkins.NET/JenkinsClientJobs.cs
diff --git a/Jenkins.NET/JenkinsClientQueue.cs b/Jenkins.NET/JenkinsClientQueue.cs
diff --git a/Jenkins.NET/Properties/AssemblyInfo.cs b/Jenkins.NET/Properties/AssemblyInfo.cs

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`using JenkinsNET.Models;`
`2`	`2`	`using System;`
`3`		`-using System.Xml;`
`4`	`3`
`5`	`4`	`namespace JenkinsNET.Internal.Commands`
`6`	`5`	`{`
`@@ -24,10 +23,10 @@ public JobCreateCommand(IJenkinsContext context, string jobName, JenkinsProject`
`24`	`23`	`Password = context.Password;`
`25`	`24`	`Crumb = context.Crumb;`
`26`	`25`
`27`		`- OnWriteAsync = async request => {`
	`26`	`+ OnWriteAsync = async (request, token) => {`
`28`	`27`	`request.Method = "POST";`
`29`	`28`	`request.ContentType = "application/xml";`
`30`		`- await WriteXmlAsync(request, job.Node);`
	`29`	`+ await WriteXmlAsync(request, job.Node, token);`
`31`	`30`	`};`
`32`	`31`	`}`
`33`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,10 @@ public JobGetCommand(IJenkinsContext context, string jobName)`
`26`	`26`	`request.Method = "GET";`
`27`	`27`	`};`
`28`	`28`
`29`		`- OnReadAsync = async response => {`
	`29`	`+ OnReadAsync = async (response, token) => {`
`30`	`30`	`var document = await ReadXmlAsync(response);`
`31`	`31`
`32`		`- Result = Activator.CreateInstance(typeof(T), new[] {document.Root}) as T;`
	`32`	`+ Result = Activator.CreateInstance(typeof(T), document.Root) as T;`
`33`	`33`	`};`
`34`	`34`	`}`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,10 +23,10 @@ public JobUpdateConfigurationCommand(IJenkinsContext context, string jobName, Je`
`23`	`23`	`Password = context.Password;`
`24`	`24`	`Crumb = context.Crumb;`
`25`	`25`
`26`		`- OnWriteAsync = async request => {`
	`26`	`+ OnWriteAsync = async (request, token) => {`
`27`	`27`	`request.Method = "POST";`
`28`	`28`	`request.ContentType = "application/xml";`
`29`		`- await WriteXmlAsync(request, job.Node);`
	`29`	`+ await WriteXmlAsync(request, job.Node, token);`
`30`	`30`	`};`
`31`	`31`	`}`
`32`	`32`	`}`