Add possibility to configure GitHubClient timeout (#963) (#1693)

* Add possibility to configure GitHubClient timeout (#963)

A first attempt to fix the problem describe in #963 by adding a possibility
to extend the default timeout value (100s)
that is too short to be able to post assets in github release.

* Rename to SetRequestTimeout
Make comments consistent

Octokit.Reactive/IObservableGitHubClient.cs

@@ -6,6 +6,16 @@ public interface IObservableGitHubClient : IApiInfoProvider
     {
         IConnection Connection { get; }
 
+        /// <summary>
+        /// Set the GitHub Api request timeout.
+        /// Useful to set a specific timeout for lengthy operations, such as uploading release assets
+        /// </summary>
+        /// <remarks>
+        /// See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx
+        /// </remarks>
+        /// <param name="timeout">The Timeout value</param>
+        void SetRequestTimeout(TimeSpan timeout);
+
         IObservableAuthorizationsClient Authorization { get; }
         IObservableActivitiesClient Activity { get; }
         IObservableIssuesClient Issue { get; }

Octokit.Reactive/ObservableGitHubClient.cs

@@ -54,6 +54,20 @@ public IConnection Connection
             get { return _gitHubClient.Connection; }
         }
 
+        /// <summary>
+        /// Set the GitHub Api request timeout.
+        /// Useful to set a specific timeout for lengthy operations, such as uploading release assets
+        /// </summary>
+        /// <remarks>
+        /// See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx
+        /// </remarks>
+        /// <param name="timeout">The Timeout value</param>
+        public void SetRequestTimeout(TimeSpan timeout)
+        {
+
+            _gitHubClient.SetRequestTimeout(timeout);
+        }
+
         public IObservableAuthorizationsClient Authorization { get; private set; }
         public IObservableActivitiesClient Activity { get; private set; }
         public IObservableIssuesClient Issue { get; private set; }

Octokit.Tests/GitHubClientTests.cs

@@ -196,5 +196,20 @@ public async Task ReturnsObjectIfNotNew()
                 var temp = connection.Received(1).GetLastApiInfo();
             }
         }
+
+        public class TheSetRequestTimeoutMethod
+        {
+            [Fact]
+            public void SetsTheTimeoutOnTheUnderlyingHttpClient()
+            {
+                var httpClient = Substitute.For<IHttpClient>();
+                var client = new GitHubClient(new Connection(new ProductHeaderValue("OctokitTests"), httpClient));
+
+                client.SetRequestTimeout(TimeSpan.FromSeconds(15));
+
+
+                httpClient.Received(1).SetRequestTimeout(TimeSpan.FromSeconds(15));
+            }
+        }
     }
 }

Octokit/GitHubClient.cs

@@ -99,6 +99,19 @@ public GitHubClient(IConnection connection)
             Reaction = new ReactionsClient(apiConnection);
         }
 
+        /// <summary>
+        /// Set the GitHub Api request timeout.
+        /// Useful to set a specific timeout for lengthy operations, such as uploading release assets
+        /// </summary>
+        /// <remarks>
+        /// See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx
+        /// </remarks>
+        /// <param name="timeout">The Timeout value</param>
+        public void SetRequestTimeout(TimeSpan timeout)
+        {
+            Connection.SetRequestTimeout(timeout);
+        }
+
         /// <summary>
         /// Gets the latest API Info - this will be null if no API calls have been made
         /// </summary>

Octokit/Http/Connection.cs

@@ -752,5 +752,14 @@ static string GetVersionInformation()
 
             return _versionInformation;
         }
+
+        /// <summary>
+        /// Set the GitHub Api request timeout.
+        /// </summary>
+        /// <param name="timeout">The Timeout value</param>
+        public void SetRequestTimeout(TimeSpan timeout)
+        {
+            _httpClient.SetRequestTimeout(timeout);
+        }
     }
 }

Octokit/Http/HttpClientAdapter.cs

@@ -264,6 +264,15 @@ public static async Task<HttpRequestMessage> CloneHttpRequestMessageAsync(HttpRe
 
             return newRequest;
         }
+
+        /// <summary>
+        /// Set the GitHub Api request timeout.
+        /// </summary>
+        /// <param name="timeout">The Timeout value</param>
+        public void SetRequestTimeout(TimeSpan timeout)
+        {
+            _http.Timeout = timeout;
+        }
     }
 
     internal class RedirectHandler : DelegatingHandler

Octokit/Http/IConnection.cs

@@ -292,5 +292,11 @@ public interface IConnection : IApiInfoProvider
         /// the default <see cref="InMemoryCredentialStore"/> with just these credentials.
         /// </remarks>
         Credentials Credentials { get; set; }
+
+        /// <summary>
+        /// Set the GitHub Api request timeout.
+        /// </summary>
+        /// <param name="timeout">The Timeout value</param>
+        void SetRequestTimeout(TimeSpan timeout);
     }
 }

Octokit/Http/IHttpClient.cs

@@ -19,5 +19,12 @@ public interface IHttpClient : IDisposable
         /// <param name="cancellationToken">Used to cancel the request</param>
         /// <returns>A <see cref="Task" /> of <see cref="IResponse"/></returns>
         Task<IResponse> Send(IRequest request, CancellationToken cancellationToken);
+
+
+        /// <summary>
+        /// Set the GitHub Api request timeout.
+        /// </summary>
+        /// <param name="timeout">The Timeout value</param>
+        void SetRequestTimeout(TimeSpan timeout);
     }
 }

Octokit/IGitHubClient.cs

@@ -7,6 +7,16 @@ namespace Octokit
     /// </summary>
     public interface IGitHubClient : IApiInfoProvider
     {
+        /// <summary>
+        /// Set the GitHub Api request timeout.
+        /// Useful to set a specific timeout for lengthy operations, such as uploading release assets
+        /// </summary>
+        /// <remarks>
+        /// See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx
+        /// </remarks>
+        /// <param name="timeout">The Timeout value</param>
+        void SetRequestTimeout(TimeSpan timeout);
+
         /// <summary>
         /// Provides a client connection to make rest requests to HTTP endpoints.
         /// </summary>