Provided a http timeout

The `HttpClient` does not take the `Timeout` argument which by default is 100 seconds. Implemented a change where the user has an option to provide the timeout. This is to address the octokit#963.
naveensrinivasan · Nov 24, 2015 · e2500f6 · e2500f6
1 parent ddcfc0a
commit e2500f6
Show file tree

Hide file tree

Showing 6 changed files with 170 additions and 7 deletions.
diff --git a/Octokit.Tests.Integration/Clients/GitHubClientTests.cs b/Octokit.Tests.Integration/Clients/GitHubClientTests.cs
@@ -36,6 +36,15 @@ public async Task CanRetrieveLastApiInfoWithEtag()
             }
         }
 
+
+        [IntegrationTest]
+        public async Task WillFailWithHttpTimeout()
+        {
+            var github = Helper.GetAnonymousClient(TimeSpan.FromMilliseconds(5));
+
+           await Assert.ThrowsAnyAsync<System.Threading.Tasks.TaskCanceledException>(async () => await github.Repository.GetAllContributors("octokit", "octokit.net"));
+        }
+
         [IntegrationTest]
         public async Task CanRetrieveLastApiInfoWithLinks()
         {

diff --git a/Octokit.Tests.Integration/Helper.cs b/Octokit.Tests.Integration/Helper.cs
@@ -118,6 +118,7 @@ public static IGitHubClient GetAuthenticatedClient()
             };
         }
 
+
         public static GitHubClient GetAuthenticatedApplicationClient()
         {
             return new GitHubClient(new ProductHeaderValue("OctokitTests"))
@@ -130,6 +131,10 @@ public static IGitHubClient GetAnonymousClient()
         {
             return new GitHubClient(new ProductHeaderValue("OctokitTests"));
         }
+        public static IGitHubClient GetAnonymousClient(TimeSpan httpTimeout)
+        {
+            return new GitHubClient(new ProductHeaderValue("OctokitTests"),httpTimeout);
+        }
 
         public static IGitHubClient GetBadCredentialsClient()
         {

diff --git a/Octokit/GitHubClient.cs b/Octokit/GitHubClient.cs
@@ -27,6 +27,23 @@ public GitHubClient(ProductHeaderValue productInformation)
         {
         }
 
+
+        /// <summary>
+        /// Create a new instance of the GitHub API v3 client pointing to 
+        /// https://api.github.com/
+        /// </summary>
+        /// <param name="productInformation">
+        /// The name (and optionally version) of the product using this library. This is sent to the server as part of
+        /// the user agent for analytics purposes.
+        /// </param>
+        /// <param name="httpTimeout">
+        /// The number of milliseconds to wait before the request times out. The default HTTP timeout is 100000.
+        /// </param>
+        public GitHubClient(ProductHeaderValue productInformation,TimeSpan httpTimeout)
+            : this(new Connection(productInformation, GitHubApiUrl,httpTimeout))
+        {
+        }
+
         /// <summary>
         /// Create a new instance of the GitHub API v3 client pointing to 
         /// https://api.github.com/
@@ -40,6 +57,22 @@ public GitHubClient(ProductHeaderValue productInformation, ICredentialStore cred
             : this(new Connection(productInformation, credentialStore))
         {
         }
+        /// <summary>
+        /// Create a new instance of the GitHub API v3 client pointing to 
+        /// https://api.github.com/
+        /// </summary>
+        /// <param name="productInformation">
+        /// The name (and optionally version) of the product using this library. This is sent to the server as part of
+        /// the user agent for analytics purposes.
+        /// </param>
+        /// <param name="credentialStore">Provides credentials to the client when making requests</param>
+        /// <param name="httpTimeout">
+        /// The number of milliseconds to wait before the request times out. The default HTTP timeout is 100000.
+        /// </param>
+        public GitHubClient(ProductHeaderValue productInformation, ICredentialStore credentialStore,TimeSpan httpTimeout)
+            : this(new Connection(productInformation, credentialStore,httpTimeout))
+        {
+        }
 
         /// <summary>
         /// Create a new instance of the GitHub API v3 client pointing to the specified baseAddress.
@@ -56,6 +89,25 @@ public GitHubClient(ProductHeaderValue productInformation, Uri baseAddress)
         {
         }
 
+
+        /// <summary>
+        /// Create a new instance of the GitHub API v3 client pointing to the specified baseAddress.
+        /// </summary>
+        /// <param name="productInformation">
+        /// The name (and optionally version) of the product using this library. This is sent to the server as part of
+        /// the user agent for analytics purposes.
+        /// </param>
+        /// <param name="baseAddress">
+        /// The address to point this client to. Typically used for GitHub Enterprise 
+        /// instances</param>
+        /// <param name="httpTimeout">
+        /// The number of milliseconds to wait before the request times out. The default HTTP timeout is 100000.
+        /// </param>
+        public GitHubClient(ProductHeaderValue productInformation, Uri baseAddress,TimeSpan httpTimeout)
+            : this(new Connection(productInformation, FixUpBaseUri(baseAddress),httpTimeout))
+        {
+        }
+
         /// <summary>
         /// Create a new instance of the GitHub API v3 client pointing to the specified baseAddress.
         /// </summary>
@@ -72,6 +124,25 @@ public GitHubClient(ProductHeaderValue productInformation, ICredentialStore cred
         {
         }
 
+        /// <summary>
+        /// Create a new instance of the GitHub API v3 client pointing to the specified baseAddress.
+        /// </summary>
+        /// <param name="productInformation">
+        /// The name (and optionally version) of the product using this library. This is sent to the server as part of
+        /// the user agent for analytics purposes.
+        /// </param>
+        /// <param name="credentialStore">Provides credentials to the client when making requests</param>
+        /// <param name="baseAddress">
+        /// The address to point this client to. Typically used for GitHub Enterprise 
+        /// instances</param>
+        /// <param name="httpTimeout">
+        /// The number of milliseconds to wait before the request times out. The default HTTP timeout is 100000.
+        /// </param>
+        public GitHubClient(ProductHeaderValue productInformation, ICredentialStore credentialStore, Uri baseAddress,TimeSpan httpTimeout)
+            : this(new Connection(productInformation, FixUpBaseUri(baseAddress), credentialStore,httpTimeout))
+        {
+        }
+
         /// <summary>
         /// Create a new instance of the GitHub API v3 client using the specified connection.
         /// </summary>

diff --git a/Octokit/Http/Connection.cs b/Octokit/Http/Connection.cs
@@ -36,6 +36,21 @@ public Connection(ProductHeaderValue productInformation)
         {
         }
 
+        /// <summary>
+        /// Creates a new connection instance used to make requests of the GitHub API.
+        /// </summary>
+        /// <param name="productInformation">
+        /// The name (and optionally version) of the product using this library. This is sent to the server as part of
+        /// the user agent for analytics purposes.
+        /// </param>
+        /// <param name="httpTimeout">
+        /// The number of milliseconds to wait before the request times out. The default HTTP timeout is 100000.
+        /// </param>
+        public Connection(ProductHeaderValue productInformation,TimeSpan httpTimeout)
+            : this(productInformation, _defaultGitHubApiUrl, _anonymousCredentials,httpTimeout)
+        {
+        }
+
         /// <summary>
         /// Creates a new connection instance used to make requests of the GitHub API.
         /// </summary>
@@ -66,6 +81,25 @@ public Connection(ProductHeaderValue productInformation, Uri baseAddress)
         {
         }
 
+
+        /// <summary>
+        /// Creates a new connection instance used to make requests of the GitHub API.
+        /// </summary>
+        /// <param name="productInformation">
+        /// The name (and optionally version) of the product using this library. This is sent to the server as part of
+        /// the user agent for analytics purposes.
+        /// </param>
+        /// <param name="baseAddress">
+        /// The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise 
+        /// instance</param>
+        /// <param name="httpTimeout">
+        /// The number of milliseconds to wait before the request times out. The default HTTP timeout is 100000.
+        /// </param>
+        public Connection(ProductHeaderValue productInformation, Uri baseAddress,TimeSpan httpTimeout)
+            : this(productInformation, baseAddress, _anonymousCredentials,httpTimeout)
+        {
+        }
+
         /// <summary>
         /// Creates a new connection instance used to make requests of the GitHub API.
         /// </summary>
@@ -79,6 +113,21 @@ public Connection(ProductHeaderValue productInformation, ICredentialStore creden
         {
         }
 
+        /// <summary>
+        /// Creates a new connection instance used to make requests of the GitHub API.
+        /// </summary>
+        /// <param name="productInformation">
+        /// The name (and optionally version) of the product using this library. This is sent to the server as part of
+        /// the user agent for analytics purposes.
+        /// </param>
+        /// <param name="credentialStore">Provides credentials to the client when making requests</param>
+        /// <param name="httpTimeout">
+        /// The number of milliseconds to wait before the request times out. The default HTTP timeout is 100000.
+        /// </param>
+        public Connection(ProductHeaderValue productInformation, ICredentialStore credentialStore,TimeSpan httpTimeout)
+            : this(productInformation, _defaultGitHubApiUrl, credentialStore,httpTimeout)
+        {
+        }
         /// <summary>
         /// Creates a new connection instance used to make requests of the GitHub API.
         /// </summary>
@@ -96,6 +145,27 @@ public Connection(ProductHeaderValue productInformation, Uri baseAddress, ICrede
         {
         }
 
+
+        /// <summary>
+        /// Creates a new connection instance used to make requests of the GitHub API.
+        /// </summary>
+        /// <param name="productInformation">
+        /// The name (and optionally version) of the product using this library. This is sent to the server as part of
+        /// the user agent for analytics purposes.
+        /// </param>
+        /// <param name="baseAddress">
+        /// The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise 
+        /// instance</param>
+        /// <param name="credentialStore">Provides credentials to the client when making requests</param>
+        ///<param name="httpTimeout">
+        /// The number of milliseconds to wait before the request times out. The default HTTP timeout is 100000.
+        /// </param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope")]
+        public Connection(ProductHeaderValue productInformation, Uri baseAddress, ICredentialStore credentialStore,TimeSpan httpTimeout)
+            : this(productInformation, baseAddress, credentialStore, new HttpClientAdapter(HttpMessageHandlerFactory.CreateDefault,httpTimeout), new SimpleJsonSerializer())
+        {
+        }
+
         /// <summary>
         /// Creates a new connection instance used to make requests of the GitHub API.
         /// </summary>

diff --git a/Octokit/Http/HttpClientAdapter.cs b/Octokit/Http/HttpClientAdapter.cs
@@ -21,13 +21,21 @@ public class HttpClientAdapter : IHttpClient
         readonly HttpClient _http;
 
         [SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope")]
-        public HttpClientAdapter(Func<HttpMessageHandler> getHandler)
+        public HttpClientAdapter(Func<HttpMessageHandler> getHandler) 
         {
             Ensure.ArgumentNotNull(getHandler, "getHandler");
-
             _http = new HttpClient(new RedirectHandler { InnerHandler = getHandler() });
         }
 
+        [SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope")]
+        public HttpClientAdapter(Func<HttpMessageHandler> getHandler,TimeSpan httpTimeout)
+        {
+            Ensure.ArgumentNotNull(getHandler, "getHandler");
+            Ensure.GreaterThanZero(httpTimeout, "httpTimeout");
+
+            _http = new HttpClient(new RedirectHandler { InnerHandler = getHandler() });
+            _http.Timeout = httpTimeout;
+        }
         /// <summary>
         /// Sends the specified request and returns a response.
         /// </summary>
@@ -37,9 +45,10 @@ public HttpClientAdapter(Func<HttpMessageHandler> getHandler)
         public async Task<IResponse> Send(IRequest request, CancellationToken cancellationToken)
         {
             Ensure.ArgumentNotNull(request, "request");
-
+           
             var cancellationTokenForRequest = GetCancellationTokenForRequest(request, cancellationToken);
 
+
             using (var requestMessage = BuildRequestMessage(request))
             {
                 // Make the request
@@ -60,6 +69,7 @@ static CancellationToken GetCancellationTokenForRequest(IRequest request, Cancel
                 var unifiedCancellationToken = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, timeoutCancellation.Token);
 
                 cancellationTokenForRequest = unifiedCancellationToken.Token;
+
             }
             return cancellationTokenForRequest;
         }

diff --git a/SolutionInfo.cs b/SolutionInfo.cs
@@ -6,10 +6,8 @@
 [assembly: AssemblyVersionAttribute("0.17.0")]
 [assembly: AssemblyFileVersionAttribute("0.17.0")]
 [assembly: ComVisibleAttribute(false)]
-namespace System
-{
-    internal static class AssemblyVersionInformation
-    {
+namespace System {
+    internal static class AssemblyVersionInformation {
         internal const string Version = "0.17.0";
     }
 }