feat: add configurable Timeout for BoxClient (#779)

box · Dec 1, 2021 · ac842ed · ac842ed
1 parent 1098f75
commit ac842ed
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 6 deletions.
diff --git a/Box.V2/BoxClient.cs b/Box.V2/BoxClient.cs
@@ -34,7 +34,7 @@ public BoxClient(IBoxConfig boxConfig, string asUser = null, bool? suppressNotif
             _asUser = asUser;
             _suppressNotifications = suppressNotifications;
 
-            _handler = new HttpRequestHandler(boxConfig.WebProxy);
+            _handler = new HttpRequestHandler(boxConfig.WebProxy, boxConfig.Timeout);
             _converter = new BoxJsonConverter();
             _service = new BoxService(_handler);
             Auth = new AuthRepository(Config, _service, _converter, null);
@@ -56,7 +56,7 @@ public BoxClient(IBoxConfig boxConfig, OAuthSession authSession, string asUser =
             _asUser = asUser;
             _suppressNotifications = suppressNotifications;
 
-            _handler = new HttpRequestHandler(boxConfig.WebProxy);
+            _handler = new HttpRequestHandler(boxConfig.WebProxy, boxConfig.Timeout);
             _converter = new BoxJsonConverter();
             _service = new BoxService(_handler);
             Auth = new AuthRepository(Config, _service, _converter, authSession);
@@ -78,7 +78,7 @@ public BoxClient(IBoxConfig boxConfig, IAuthRepository authRepository, string as
             _asUser = asUser;
             _suppressNotifications = suppressNotifications;
 
-            _handler = new HttpRequestHandler(boxConfig.WebProxy);
+            _handler = new HttpRequestHandler(boxConfig.WebProxy, boxConfig.Timeout);
             _converter = new BoxJsonConverter();
             _service = new BoxService(_handler);
             Auth = authRepository;

diff --git a/Box.V2/Config/BoxConfig.cs b/Box.V2/Config/BoxConfig.cs
@@ -64,6 +64,7 @@ public BoxConfig(BoxConfigBuilder builder)
             DeviceName = builder.DeviceName;
             AcceptEncoding = builder.AcceptEncoding;
             WebProxy = builder.WebProxy;
+            Timeout = builder.Timeout;
         }
 
         /// <summary>
@@ -272,6 +273,10 @@ public static IBoxConfig CreateFromJsonString(string jsonString)
         /// The web proxy for HttpRequestHandler
         /// </summary>
         public IWebProxy WebProxy { get; private set; }
+        /// <summary>
+        /// Timeout for the connection
+        /// </summary>
+        public TimeSpan? Timeout { get; private set; }
     }
 
     public enum CompressionType

diff --git a/Box.V2/Config/BoxConfigBuilder.cs b/Box.V2/Config/BoxConfigBuilder.cs
@@ -203,6 +203,17 @@ public BoxConfigBuilder SetWebProxy(IWebProxy webProxy)
             return this;
         }
 
+        /// <summary>
+        /// Sets connection timeout for HttpRequestHandler.
+        /// </summary>
+        /// <param name="timeout">Connection timeout for HttpRequestHandler.</param>
+        /// <returns>this BoxConfigBuilder object for chaining</returns>
+        public BoxConfigBuilder SetTimeout(TimeSpan timeout)
+        {
+            Timeout = timeout;
+            return this;
+        }
+
         public string ClientId { get; private set; }
         public string ClientSecret { get; private set; }
         public string EnterpriseId { get; private set; }
@@ -230,5 +241,10 @@ public BoxConfigBuilder SetWebProxy(IWebProxy webProxy)
         /// The web proxy for HttpRequestHandler
         /// </summary>
         public IWebProxy WebProxy { get; private set; }
+
+        /// <summary>
+        /// Timeout for the connection
+        /// </summary>
+        public TimeSpan? Timeout { get; private set; }
     }
 }
diff --git a/Box.V2/Config/IBoxConfig.cs b/Box.V2/Config/IBoxConfig.cs
@@ -136,5 +136,9 @@ public interface IBoxConfig
         /// The web proxy for HttpRequestHandler
         /// </summary>
         IWebProxy WebProxy { get; }
+        /// <summary>
+        /// Timeout for the connection
+        /// </summary>
+        TimeSpan? Timeout { get; }
     }
 }
diff --git a/Box.V2/JWTAuth/BoxJWTAuth.cs b/Box.V2/JWTAuth/BoxJWTAuth.cs
@@ -93,7 +93,7 @@ public BoxJWTAuth(IBoxConfig boxConfig, IBoxService boxService)
         /// Constructor for JWT authentication with default boxService
         /// </summary>
         /// <param name="boxConfig">Config contains information about client id, client secret, enterprise id, private key, private key password, public key id </param>
-        public BoxJWTAuth(IBoxConfig boxConfig) : this(boxConfig, new BoxService(new HttpRequestHandler(boxConfig.WebProxy)))
+        public BoxJWTAuth(IBoxConfig boxConfig) : this(boxConfig, new BoxService(new HttpRequestHandler(boxConfig.WebProxy, boxConfig.Timeout)))
         {
 
         }

diff --git a/Box.V2/Request/HttpRequestHandler.cs b/Box.V2/Request/HttpRequestHandler.cs
@@ -17,13 +17,15 @@ public class HttpRequestHandler : IRequestHandler
         public const HttpStatusCode TooManyRequests = (HttpStatusCode)429;
         public const int RetryLimit = 5;
         private readonly TimeSpan _defaultRequestTimeout = new TimeSpan(0, 0, 100); // 100 seconds, same as default HttpClient timeout
+        private readonly TimeSpan _timeout;
 
-        public HttpRequestHandler(IWebProxy webProxy = null)
+        public HttpRequestHandler(IWebProxy webProxy = null, TimeSpan? timeout = null)
         {
             ClientFactory.WebProxy = webProxy;
 #if NET45
             System.Net.ServicePointManager.Expect100Continue = false;
 #endif
+            _timeout = timeout ?? _defaultRequestTimeout;
         }
 
         public async Task<IBoxResponse<T>> ExecuteAsyncWithoutRetry<T>(IBoxRequest request)
@@ -168,7 +170,7 @@ private async Task<HttpResponseMessage> GetResponse(IBoxRequest request, bool is
                 }
                 else
                 {
-                    cts.CancelAfter(_defaultRequestTimeout);
+                    cts.CancelAfter(_timeout);
                 }
 
                 var timeoutToken = cts.Token;