[dotnet] Restore ability to add headers to WebDriver HTTP commands

dotnet/src/webdriver/ICommandExecutor.cs

@@ -26,10 +26,11 @@ namespace OpenQA.Selenium
     public interface ICommandExecutor : IDisposable
     {
         /// <summary>
-        /// Gets the repository of objects containin information about commands.
+        /// Attempts to add a command to the repository of commands known to this executor.
         /// </summary>
-        //CommandInfoRepository CommandInfoRepository { get; }
-
+        /// <param name="commandName">The name of the command to attempt to add.</param>
+        /// <param name="info">The <see cref="CommandInfo"/> describing the commnd to add.</param>
+        /// <returns><see langword="true"/> if the new command has been added successfully; otherwise, <see langword="false"/>.</returns>
         bool TryAddCommand(string commandName, CommandInfo info);
 
         /// <summary>

dotnet/src/webdriver/Remote/HttpCommandExecutor.cs

@@ -17,6 +17,7 @@
 // </copyright>
 
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.Globalization;
 using System.IO;
@@ -43,6 +44,7 @@ public class HttpCommandExecutor : ICommandExecutor
         private const string UserAgentHeaderTemplate = "selenium/{0} (.net {1})";
         private Uri remoteServerUri;
         private TimeSpan serverResponseTimeout;
+        private string userAgent;
         private bool enableKeepAlive;
         private bool isDisposed;
         private IWebProxy proxy;
@@ -78,6 +80,7 @@ public HttpCommandExecutor(Uri addressOfRemoteServer, TimeSpan timeout, bool ena
                 addressOfRemoteServer = new Uri(addressOfRemoteServer.ToString() + "/");
             }
 
+            this.userAgent = string.Format(CultureInfo.InvariantCulture, UserAgentHeaderTemplate, ResourceUtilities.AssemblyVersion, ResourceUtilities.PlatformFamily);
             this.remoteServerUri = addressOfRemoteServer;
             this.serverResponseTimeout = timeout;
             this.enableKeepAlive = enableKeepAlive;
@@ -89,15 +92,6 @@ public HttpCommandExecutor(Uri addressOfRemoteServer, TimeSpan timeout, bool ena
         /// </summary>
         public event EventHandler<SendingRemoteHttpRequestEventArgs> SendingRemoteHttpRequest;
 
-        /// <summary>
-        /// Gets the repository of objects containin information about commands.
-        /// </summary>
-        //public CommandInfoRepository CommandInfoRepository
-        //{
-        //    get { return this.commandInfoRepository; }
-        //    protected set { this.commandInfoRepository = value; }
-        //}
-
         /// <summary>
         /// Gets or sets an <see cref="IWebProxy"/> object to be used to proxy requests
         /// between this <see cref="HttpCommandExecutor"/> and the remote end WebDriver
@@ -120,6 +114,32 @@ public bool IsKeepAliveEnabled
             set { this.enableKeepAlive = value; }
         }
 
+        /// <summary>
+        /// Gets or sets the user agent string used for HTTP communication
+        /// batween this <see cref="HttpCommandExecutor"/> and the remote end
+        /// WebDriver implementation
+        /// </summary>
+        public string UserAgent
+        {
+            get { return this.userAgent; }
+            set { this.userAgent = value; }
+        }
+
+        /// <summary>
+        /// Gets the repository of objects containing information about commands.
+        /// </summary>
+        protected CommandInfoRepository CommandInfoRepository
+        {
+            get { return this.commandInfoRepository; }
+            set { this.commandInfoRepository = value; }
+        }
+
+        /// <summary>
+        /// Attempts to add a command to the repository of commands known to this executor.
+        /// </summary>
+        /// <param name="commandName">The name of the command to attempt to add.</param>
+        /// <param name="info">The <see cref="CommandInfo"/> describing the commnd to add.</param>
+        /// <returns><see langword="true"/> if the new command has been added successfully; otherwise, <see langword="false"/>.</returns>
         public bool TryAddCommand(string commandName, CommandInfo info)
         {
             HttpCommandInfo commandInfo = info as HttpCommandInfo;
@@ -234,9 +254,7 @@ private void CreateHttpClient()
             httpClientHandler.Proxy = this.Proxy;
 
             this.client = new HttpClient(httpClientHandler);
-            string userAgentString = string.Format(CultureInfo.InvariantCulture, UserAgentHeaderTemplate, ResourceUtilities.AssemblyVersion, ResourceUtilities.PlatformFamily);
-            this.client.DefaultRequestHeaders.UserAgent.ParseAdd(userAgentString);
-
+            this.client.DefaultRequestHeaders.UserAgent.ParseAdd(this.UserAgent);
             this.client.DefaultRequestHeaders.Accept.ParseAdd(RequestAcceptHeader);
             if (!this.IsKeepAliveEnabled)
             {
@@ -254,6 +272,11 @@ private async Task<HttpResponseInfo> MakeHttpRequest(HttpRequestInfo requestInfo
             HttpMethod method = new HttpMethod(requestInfo.HttpMethod);
             using (HttpRequestMessage requestMessage = new HttpRequestMessage(method, requestInfo.FullUri))
             {
+                foreach (KeyValuePair<string, string> header in eventArgs.Headers)
+                {
+                    requestMessage.Headers.Add(header.Key, header.Value);
+                }
+
                 if (requestInfo.HttpMethod == HttpCommandInfo.GetCommand)
                 {
                     CacheControlHeaderValue cacheControlHeader = new CacheControlHeaderValue();
@@ -291,7 +314,7 @@ private Response CreateResponse(HttpResponseInfo responseInfo)
         {
             Response response = new Response();
             string body = responseInfo.Body;
-            if (responseInfo.ContentType != null && responseInfo.ContentType.StartsWith("application/json", StringComparison.OrdinalIgnoreCase))
+            if (responseInfo.ContentType != null && responseInfo.ContentType.StartsWith(JsonMimeType, StringComparison.OrdinalIgnoreCase))
             {
                 response = Response.FromJson(body);
             }

dotnet/src/webdriver/Remote/SendingRemoteHttpRequestEventArgs.cs

@@ -17,6 +17,7 @@
 // </copyright>
 
 using System;
+using System.Collections.Generic;
 using System.Net;
 
 namespace OpenQA.Selenium.Remote
@@ -29,6 +30,7 @@ public class SendingRemoteHttpRequestEventArgs : EventArgs
         private string method;
         private string fullUrl;
         private string requestBody;
+        private Dictionary<string, string> headers = new Dictionary<string, string>();
 
         /// <summary>
         /// Initializes a new instance of the <see cref="SendingRemoteHttpRequestEventArgs"/> class.
@@ -75,5 +77,39 @@ public string RequestBody
         {
             get { return this.requestBody; }
         }
+
+        /// <summary>
+        /// Gets a read-only dictionary of the headers of the HTTP request.
+        /// Does not include default headers of the web client making the request.
+        /// </summary>
+        public IReadOnlyDictionary<string, string> Headers
+        {
+            get { return this.headers; }
+        }
+
+        /// <summary>
+        /// Adds a header to the HTTP request.
+        /// </summary>
+        /// <param name="headerName">The name of the header to add.</param>
+        /// <param name="headerValue">The value of the header to add.</param>
+        /// <remarks>
+        /// Adding headers here will attempt to add them to the headers for the
+        /// HTTP request being sent; however, be aware they may be overwritten by
+        /// the client raising the event.
+        /// </remarks>
+        public void AddHeader(string headerName, string headerValue)
+        {
+            if (string.IsNullOrEmpty(headerName))
+            {
+                throw new ArgumentException("Header name may not be null or the empty string.", "headerName");
+            }
+
+            if (headerValue == null)
+            {
+                throw new ArgumentNullException("headerValue", "Header value may not be null.")
+            }
+
+            this.headers[headerName] = headerValue;
+        }
     }
 }