[dotnet] Fix network response data encoding (#13576)

nvborisenko · web-flow · commit 0209bec558fd · 2024-02-16T12:07:22.000+01:00
* Fix network response data encoding

* Fix network interception tests

* Avoid unnecessary convertion

* Rename to ReadAsByteArray
diff --git a/dotnet/src/webdriver/DevTools/v119/V119Network.cs b/dotnet/src/webdriver/DevTools/v119/V119Network.cs
@@ -257,11 +257,11 @@ public override async Task AddResponseBody(HttpResponseData responseData)
                 {
                     if (bodyResponse.Base64Encoded)
                     {
-                        responseData.Body = Encoding.UTF8.GetString(Convert.FromBase64String(bodyResponse.Body));
+                        responseData.Content = new HttpResponseContent(Convert.FromBase64String(bodyResponse.Body));
                     }
                     else
                     {
-                        responseData.Body = bodyResponse.Body;
+                        responseData.Content = new HttpResponseContent(bodyResponse.Body);
                     }
                 }
             }
diff --git a/dotnet/src/webdriver/DevTools/v120/V120Network.cs b/dotnet/src/webdriver/DevTools/v120/V120Network.cs
@@ -257,11 +257,11 @@ public override async Task AddResponseBody(HttpResponseData responseData)
                 {
                     if (bodyResponse.Base64Encoded)
                     {
-                        responseData.Body = Encoding.UTF8.GetString(Convert.FromBase64String(bodyResponse.Body));
+                        responseData.Content = new HttpResponseContent(Convert.FromBase64String(bodyResponse.Body));
                     }
                     else
                     {
-                        responseData.Body = bodyResponse.Body;
+                        responseData.Content = new HttpResponseContent(bodyResponse.Body);
                     }
                 }
             }
diff --git a/dotnet/src/webdriver/DevTools/v121/V121Network.cs b/dotnet/src/webdriver/DevTools/v121/V121Network.cs
@@ -257,11 +257,11 @@ public override async Task AddResponseBody(HttpResponseData responseData)
                 {
                     if (bodyResponse.Base64Encoded)
                     {
-                        responseData.Body = Encoding.UTF8.GetString(Convert.FromBase64String(bodyResponse.Body));
+                        responseData.Content = new HttpResponseContent(Convert.FromBase64String(bodyResponse.Body));
                     }
                     else
                     {
-                        responseData.Body = bodyResponse.Body;
+                        responseData.Content = new HttpResponseContent(bodyResponse.Body);
                     }
                 }
             }
diff --git a/dotnet/src/webdriver/DevTools/v85/V85Network.cs b/dotnet/src/webdriver/DevTools/v85/V85Network.cs
@@ -255,11 +255,11 @@ public override async Task AddResponseBody(HttpResponseData responseData)
                 var bodyResponse = await fetch.GetResponseBody(new Fetch.GetResponseBodyCommandSettings() { RequestId = responseData.RequestId }).ConfigureAwait(false);
                 if (bodyResponse.Base64Encoded)
                 {
-                    responseData.Body = Encoding.UTF8.GetString(Convert.FromBase64String(bodyResponse.Body));
+                    responseData.Content = new HttpResponseContent(Convert.FromBase64String(bodyResponse.Body));
                 }
                 else
                 {
-                    responseData.Body = bodyResponse.Body;
+                    responseData.Content = new HttpResponseContent(bodyResponse.Body);
                 }
             }
         }
diff --git a/dotnet/src/webdriver/HttpResponseContent.cs b/dotnet/src/webdriver/HttpResponseContent.cs
@@ -0,0 +1,66 @@
+// <copyright file="HttpResponseContent.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.Text;
+
+namespace OpenQA.Selenium
+{
+    /// <summary>
+    /// Represents the content of an HTTP response.
+    /// </summary>
+    public class HttpResponseContent
+    {
+        private readonly byte[] content;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="HttpResponseContent"/> class.
+        /// </summary>
+        /// <param name="content">The byte array representing the content of the response.</param>
+        public HttpResponseContent(byte[] content)
+        {
+            this.content = content;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="HttpResponseContent"/> class.
+        /// </summary>
+        /// <param name="content">The UTF8 encoded string representing the content of the response.</param>
+        public HttpResponseContent(string content)
+        {
+            this.content = Encoding.UTF8.GetBytes(content);
+        }
+
+        /// <summary>
+        /// Reads the content of the response as a UTF8 encoded string.
+        /// </summary>
+        /// <returns>The content of the response as a string.</returns>
+        public string ReadAsString()
+        {
+            return Encoding.UTF8.GetString(content);
+        }
+
+        /// <summary>
+        /// Reads the content of the response as a byte array.
+        /// </summary>
+        /// <returns>The content of the response as a byte array.</returns>
+        public byte[] ReadAsByteArray()
+        {
+            return content;
+        }
+    }
+}
diff --git a/dotnet/src/webdriver/HttpResponseData.cs b/dotnet/src/webdriver/HttpResponseData.cs
@@ -16,10 +16,7 @@
 // limitations under the License.
 // </copyright>
 
-using System;
 using System.Collections.Generic;
-using System.Data.Common;
-using System.Text;
 
 namespace OpenQA.Selenium
 {
@@ -49,7 +46,22 @@ public class HttpResponseData
         /// <summary>
         /// Gets or sets the body of the HTTP response.
         /// </summary>
-        public string Body { get; set; }
+        public string Body
+        {
+            get
+            {
+                return this.Content?.ReadAsString();
+            }
+            set
+            {
+                this.Content = new HttpResponseContent(value);
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the content of the HTTP response.
+        /// </summary>
+        public HttpResponseContent Content { get; set; }
 
         /// <summary>
         /// Gets or sets the type of resource for this response.
diff --git a/dotnet/src/webdriver/NetworkResponseReceivedEventArgs.cs b/dotnet/src/webdriver/NetworkResponseReceivedEventArgs.cs
@@ -29,7 +29,7 @@ public class NetworkResponseReceivedEventArgs : EventArgs
         private readonly string requestId;
         private readonly string responseUrl;
         private readonly long responseStatusCode;
-        private readonly string responseBody;
+        private readonly HttpResponseContent responseContent;
         private readonly string responseResourceType;
         private readonly Dictionary<string, string> responseHeaders = new Dictionary<string, string>();
 
@@ -42,7 +42,7 @@ public NetworkResponseReceivedEventArgs(HttpResponseData responseData)
             this.requestId = responseData.RequestId;
             this.responseUrl = responseData.Url;
             this.responseStatusCode = responseData.StatusCode;
-            this.responseBody = responseData.Body;
+            this.responseContent = responseData.Content;
             this.responseResourceType = responseData.ResourceType;
             foreach (KeyValuePair<string, string> header in responseData.Headers)
             {
@@ -68,7 +68,15 @@ public NetworkResponseReceivedEventArgs(HttpResponseData responseData)
         /// <summary>
         /// Gets the body of the network response.
         /// </summary>
-        public string ResponseBody => this.responseBody;
+        /// <remarks>
+        /// This property is an alias for <see cref="ResponseContent"/>.ReadAsString() to keep backward compatibility.
+        /// </remarks>
+        public string ResponseBody => this.ResponseContent?.ReadAsString();
+
+        /// <summary>
+        /// Gets the content of the network response.
+        /// </summary>
+        public HttpResponseContent ResponseContent => this.responseContent;
 
         /// <summary>
         /// Gets the type of resource of the network response.

Original file line number	Diff line number	Diff line change
`@@ -257,11 +257,11 @@ public override async Task AddResponseBody(HttpResponseData responseData)`
`257`	`257`	`{`
`258`	`258`	`if (bodyResponse.Base64Encoded)`
`259`	`259`	`{`
`260`		`- responseData.Body = Encoding.UTF8.GetString(Convert.FromBase64String(bodyResponse.Body));`
	`260`	`+ responseData.Content = new HttpResponseContent(Convert.FromBase64String(bodyResponse.Body));`
`261`	`261`	`}`
`262`	`262`	`else`
`263`	`263`	`{`
`264`		`- responseData.Body = bodyResponse.Body;`
	`264`	`+ responseData.Content = new HttpResponseContent(bodyResponse.Body);`
`265`	`265`	`}`
`266`	`266`	`}`
`267`	`267`	`}`
Original file line number	Diff line number	Diff line change
`@@ -255,11 +255,11 @@ public override async Task AddResponseBody(HttpResponseData responseData)`
`255`	`255`	`var bodyResponse = await fetch.GetResponseBody(new Fetch.GetResponseBodyCommandSettings() { RequestId = responseData.RequestId }).ConfigureAwait(false);`
`256`	`256`	`if (bodyResponse.Base64Encoded)`
`257`	`257`	`{`
`258`		`- responseData.Body = Encoding.UTF8.GetString(Convert.FromBase64String(bodyResponse.Body));`
	`258`	`+ responseData.Content = new HttpResponseContent(Convert.FromBase64String(bodyResponse.Body));`
`259`	`259`	`}`
`260`	`260`	`else`
`261`	`261`	`{`
`262`		`- responseData.Body = bodyResponse.Body;`
	`262`	`+ responseData.Content = new HttpResponseContent(bodyResponse.Body);`
`263`	`263`	`}`
`264`	`264`	`}`
`265`	`265`	`}`