Merge pull request #763 from jeschu1/timeout2

cli: add GCM_HTTP_TIMEOUT and httpTimeout support
microsoft · Sep 21, 2018 · b76af7e · b76af7e
2 parents afedbe1 + c25ad07
commit b76af7e
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 5 deletions.
diff --git a/Docs/Configuration.md b/Docs/Configuration.md
@@ -111,6 +111,19 @@ git config --global credential.visualstudio.com.preserve true
 
 See [GCM_PRESERVE](Environment.md#gcm_preserve)
 
+### httpTimeout
+
+Sets the maximum time, in milliseconds, for a network request to wait before timing out. 
+This allows changing the default for slow connections.
+
+Supports an integer value. Defaults to 90,000 miliseconds.
+
+```shell
+git config --global credential.visualstudio.com.httpTimeout 100000
+```
+
+See [GCM_HTTP_TIMEOUT](Environment.md#gcm_http_timeout)
+
 ### tokenDuration
 
 Sets a duration, in hours, limit for the validity of Personal Access Tokens requested from Azure DevOps.

diff --git a/Docs/Environment.md b/Docs/Environment.md
@@ -95,6 +95,15 @@ Supports `true` or `false`. Defaults to `false`.
 
 See [credential.preserve](Configuration.md#preserve).
 
+### GCM_HTTP_TIMEOUT
+
+Sets the maximum time, in milliseconds, for a network request to wait before timing out. 
+This allows changing the default for slow connections.
+
+Supports an integer value. Defaults to 90,000 miliseconds.
+
+See [credential.httpTimeout](Configuration.md#httpTimeout).
+
 ### GCM_TOKEN_DURATION
 
 Sets a duration, in hours, limit for the validity of Personal Access Tokens requested from Azure DevOps.

diff --git a/Microsoft.Alm.Authentication/Src/Global.cs b/Microsoft.Alm.Authentication/Src/Global.cs
@@ -34,11 +34,7 @@ public static class Global
         /// </summary>
         public const int MaxAutomaticRedirections = 16;
 
-        /// <summary>
-        /// The maximum wait time for a network request before timing out
-        /// </summary>
-        public const int RequestTimeout = 90 * 1000; // 90 second limit
-
+        private static int _requestTimeout = 90 * 1000; // 90 second default limit.
         private static readonly object _syncpoint = new object();
         private static string _useragent = BuildDefaultUserAgent(RuntimeContext.Default);
 
@@ -67,6 +63,12 @@ public static string UserAgent
 
         }
 
+        public static int RequestTimeout
+        {
+            get { lock (_syncpoint) return _requestTimeout; }
+            set { lock (_syncpoint) _requestTimeout = value; }
+        }
+
         private static string BuildDefaultUserAgent(RuntimeContext context)
         {
             if (context is null)

diff --git a/Shared/Cli/Functions/Common.cs b/Shared/Cli/Functions/Common.cs
@@ -684,6 +684,17 @@ public static async Task LoadOperationArguments(Program program, OperationArgume
                     operationArguments.UrlOverride = value;
                 }
             }
+
+            // Look for timeout override.
+            if (program.TryReadString(operationArguments, KeyType.HttpTimeout, out value))
+            {
+                program.Trace.WriteLine($"{program.KeyTypeName(KeyType.HttpTimeout)} = '{value}'.");
+
+                if (int.TryParse(value, out int milliseconds))
+                {
+                    Global.RequestTimeout = milliseconds;
+                }
+            }
         }
 
         public static void LogEvent(Program program, string message, EventLogEntryType eventType)

diff --git a/Shared/Cli/Program.cs b/Shared/Cli/Program.cs
@@ -48,6 +48,7 @@ enum KeyType
         HttpPath,
         HttpProxy,
         HttpsProxy,
+        HttpTimeout,
         HttpUserAgent,
         Interactive,
         ModalPrompt,
@@ -129,6 +130,7 @@ partial class Program
             { KeyType.PreserveCredentials, "preserve" },
             { KeyType.TokenDuration, "tokenDuration" },
             { KeyType.HttpPath, "useHttpPath" },
+            { KeyType.HttpTimeout, "httpTimeout" },
             { KeyType.Username, "username" },
             { KeyType.Validate, "validate" },
             { KeyType.VstsScope,"vstsScope" },
@@ -142,6 +144,7 @@ partial class Program
             { KeyType.DevOpsScope, "GCM_DEVOPS_SCOPE" },
             { KeyType.HttpProxy, "HTTP_PROXY" },
             { KeyType.HttpsProxy, "HTTPS_PROXY" },
+            { KeyType.HttpTimeout, "GCM_HTTP_TIMEOUT" },
             { KeyType.HttpUserAgent, "GCM_HTTP_USER_AGENT" },
             { KeyType.Interactive, "GCM_INTERACTIVE" },
             { KeyType.ModalPrompt, "GCM_MODAL_PROMPT" },