Fixing .NET HttpCommandExecutor event for RemoteWebDriver

This commit moves the firing of the event raised before sending a remote
HTTP request to before the setting of the request body. This allows the
request settings to be properly set without throwing an exeception. This
commit also renames the event and event args object to
`SendingReomteHttpRequest` and `SendingRemoteHttpRequestEventArgs`,
respectively. The previous event and event args are marked as deprecated
for removal in a future release, and the previously named event is now a
no-op, and will never be fired, even if a handler is attached.

Author: jimevans

dotnet/src/webdriver/Remote/BeforeRemoteHttpRequestEventArgs.cs

@@ -21,6 +21,7 @@
 
 namespace OpenQA.Selenium.Remote
 {
+    [Obsolete("Replaced by the SendingRemoteHttpRequestEventArgs class")]
     public class BeforeRemoteHttpRequestEventArgs : EventArgs
     {
         private HttpWebRequest request;

dotnet/src/webdriver/Remote/HttpCommandExecutor.cs

@@ -91,8 +91,11 @@ public HttpCommandExecutor(Uri addressOfRemoteServer, TimeSpan timeout, bool ena
 
         }
 
+        [Obsolete("Replaced by the SendingRemoteHttpRequest event. This event is a no-op, and event handlers for it will no longer be called.")]
         public event EventHandler<BeforeRemoteHttpRequestEventArgs> BeforeRemoteHttpRequest;
 
+        public event EventHandler<SendingRemoteHttpRequestEventArgs> SendingRemoteHttpRequest;
+
         /// <summary>
         /// Gets the repository of objects containin information about commands.
         /// </summary>
@@ -136,19 +139,19 @@ public virtual Response Execute(Command commandToExecute)
         }
 
         /// <summary>
-        /// Raises the <see cref="BeforeRemoteHttpRequest"/> event.
+        /// Raises the <see cref="SendingRemoteHttpRequest"/> event.
         /// </summary>
-        /// <param name="eventArgs">A <see cref="BeforeRemoteHttpRequestEventArgs"/> that contains the event data.</param>
-        protected virtual void OnBeforeRemoteHttpRequest(BeforeRemoteHttpRequestEventArgs eventArgs)
+        /// <param name="eventArgs">A <see cref="SendingRemoteHttpRequestEventArgs"/> that contains the event data.</param>
+        protected virtual void OnSendingRemoteHttpRequest(SendingRemoteHttpRequestEventArgs eventArgs)
         {
             if (eventArgs == null)
             {
                 throw new ArgumentNullException("eventArgs", "eventArgs must not be null");
             }
 
-            if (this.BeforeRemoteHttpRequest != null)
+            if (this.SendingRemoteHttpRequest != null)
             {
-                this.BeforeRemoteHttpRequest(this, eventArgs);
+                this.SendingRemoteHttpRequest(this, eventArgs);
             }
         }
 
@@ -188,21 +191,23 @@ private HttpResponseInfo MakeHttpRequest(HttpRequestInfo requestInfo)
             request.KeepAlive = this.enableKeepAlive;
             request.Proxy = null;
             request.ServicePoint.ConnectionLimit = 2000;
+            if (request.Method == CommandInfo.GetCommand)
+            {
+                request.Headers.Add("Cache-Control", "no-cache");
+            }
+
+            SendingRemoteHttpRequestEventArgs eventArgs = new SendingRemoteHttpRequestEventArgs(request, requestInfo.RequestBody);
+            this.OnSendingRemoteHttpRequest(eventArgs);
+
             if (request.Method == CommandInfo.PostCommand)
             {
-                string payload = requestInfo.RequestBody;
+                string payload = eventArgs.RequestBody;
                 byte[] data = Encoding.UTF8.GetBytes(payload);
                 request.ContentType = ContentTypeHeader;
                 Stream requestStream = request.GetRequestStream();
                 requestStream.Write(data, 0, data.Length);
                 requestStream.Close();
             }
-            else if (request.Method == CommandInfo.GetCommand)
-            {
-                request.Headers.Add("Cache-Control", "no-cache");
-            }
-
-            this.OnBeforeRemoteHttpRequest(new BeforeRemoteHttpRequestEventArgs(request));
 
             HttpResponseInfo responseInfo = new HttpResponseInfo();
             HttpWebResponse webResponse = null;

dotnet/src/webdriver/Remote/SendingRemoteHttpRequestEventArgs.cs

@@ -0,0 +1,45 @@
+// <copyright file="SendingRemoteHttpRequestEventArgs.cs" company="WebDriver Committers">
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using System;
+using System.Net;
+
+namespace OpenQA.Selenium.Remote
+{
+    public class SendingRemoteHttpRequestEventArgs : EventArgs
+    {
+        private HttpWebRequest request;
+        private string requestBody;
+
+        public SendingRemoteHttpRequestEventArgs(HttpWebRequest request, string requestBody)
+        {
+            this.request = request;
+            this.requestBody = requestBody;
+        }
+
+        public HttpWebRequest Request
+        {
+            get { return this.request; }
+        }
+
+        public string RequestBody
+        {
+            get { return this.requestBody; }
+        }
+    }
+}