Support fetching request POST data (#2402)

* Support fetching request POST data

* rider had the wrong file header

Author: kblok

lib/PuppeteerSharp.Tests/DeviceRequestPromptTests/MockCDPSession.cs

@@ -1,6 +1,6 @@
 // * MIT License
 //  *
-//  * Copyright (c) Microsoft Corporation.
+//  * Copyright (c) Darío Kondratiuk
 //  *
 //  * Permission is hereby granted, free of charge, to any person obtaining a copy
 //  * of this software and associated documentation files (the "Software"), to deal

lib/PuppeteerSharp.Tests/NetworkTests/RequestPostDataTests.cs

@@ -10,10 +10,6 @@ namespace PuppeteerSharp.Tests.NetworkTests
 {
     public class RequestPostDataTests : PuppeteerPageBaseTest
     {
-        public RequestPostDataTests(): base()
-        {
-        }
-
         [PuppeteerTest("network.spec.ts", "Request.postData", "should work")]
         [Skip(SkipAttribute.Targets.Firefox)]
         public async Task ShouldWork()
@@ -34,5 +30,25 @@ public async Task ShouldBeUndefinedWhenThereIsNoPostData()
             var response = await Page.GoToAsync(TestConstants.EmptyPage);
             Assert.Null(response.Request.PostData);
         }
+
+        [PuppeteerTest("network.spec.ts", "Request.postData", "should work with blobs")]
+        [Skip(SkipAttribute.Targets.Firefox)]
+        public async Task ShouldWorkWithBlobs()
+        {
+            await Page.GoToAsync(TestConstants.EmptyPage);
+            Server.SetRoute("/post", _ => Task.CompletedTask);
+            IRequest request = null;
+            Page.Request += (_, e) => request = e.Request;
+            await Page.EvaluateExpressionHandleAsync(@"fetch('./post', {
+                method: 'POST',
+                body:new Blob([JSON.stringify({foo: 'bar'})], {
+                  type: 'application/json',
+                }),
+            })");
+            Assert.NotNull(request);
+            Assert.Null(request.PostData);
+            Assert.True(request.HasPostData);
+            Assert.AreEqual("{\"foo\":\"bar\"}", await request.FetchPostDataAsync());
+        }
     }
 }

lib/PuppeteerSharp/DeviceRequestPromptManager.cs

@@ -1,6 +1,6 @@
 // * MIT License
 //  *
-//  * Copyright (c) Microsoft Corporation.
+//  * Copyright (c) Darío Kondratiuk
 //  *
 //  * Permission is hereby granted, free of charge, to any person obtaining a copy
 //  * of this software and associated documentation files (the "Software"), to deal

lib/PuppeteerSharp/IRequest.cs

@@ -17,7 +17,7 @@ namespace PuppeteerSharp
     public interface IRequest
     {
         /// <summary>
-        /// Responsed attached to the request.
+        /// Response attached to the request.
         /// </summary>
         /// <value>The response.</value>
         public IResponse Response { get; }
@@ -105,6 +105,13 @@ public interface IRequest
         /// <value>The redirect chain.</value>
         IRequest[] RedirectChain { get; }
 
+        /// <summary>
+        /// True when the request has POST data. Note that <see cref="PostData"/> might still be null when this flag is true
+        /// when the data is too long or not readily available in the decoded form.
+        /// In that case, use <see cref="FetchPostDataAsync"/>.
+        /// </summary>
+        bool HasPostData { get; }
+
         /// <summary>
         /// Continues request with optional request overrides. To use this, request interception should be enabled with <see cref="IPage.SetRequestInterceptionAsync(bool)"/>. Exception is immediately thrown if the request interception is not enabled.
         /// If the URL is set it won't perform a redirect. The request will be silently forwarded to the new url. For example, the address bar will show the original url.
@@ -127,5 +134,11 @@ public interface IRequest
         /// <param name="errorCode">Optional error code. Defaults to <see cref="RequestAbortErrorCode.Failed"/>.</param>
         /// <returns>Task.</returns>
         Task AbortAsync(RequestAbortErrorCode errorCode = RequestAbortErrorCode.Failed);
+
+        /// <summary>
+        /// Fetches the POST data for the request from the browser.
+        /// </summary>
+        /// <returns>Task which resolves to the request's POST data.</returns>
+        Task<string> FetchPostDataAsync();
     }
 }

lib/PuppeteerSharp/Messaging/DeviceAccessCancelPrompt.cs

@@ -1,6 +1,6 @@
 // * MIT License
 //  *
-//  * Copyright (c) Microsoft Corporation.
+//  * Copyright (c) Darío Kondratiuk
 //  *
 //  * Permission is hereby granted, free of charge, to any person obtaining a copy
 //  * of this software and associated documentation files (the "Software"), to deal

lib/PuppeteerSharp/Messaging/DeviceAccessSelectPrompt.cs

@@ -1,6 +1,6 @@
 // * MIT License
 //  *
-//  * Copyright (c) Microsoft Corporation.
+//  * Copyright (c) Darío Kondratiuk
 //  *
 //  * Permission is hereby granted, free of charge, to any person obtaining a copy
 //  * of this software and associated documentation files (the "Software"), to deal

lib/PuppeteerSharp/Messaging/Protocol/Network/GetRequestPostDataRequest.cs

@@ -0,0 +1,28 @@
+// * MIT License
+//  *
+//  * Copyright (c) Darío Kondratiuk
+//  *
+//  * Permission is hereby granted, free of charge, to any person obtaining a copy
+//  * of this software and associated documentation files (the "Software"), to deal
+//  * in the Software without restriction, including without limitation the rights
+//  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  * copies of the Software, and to permit persons to whom the Software is
+//  * furnished to do so, subject to the following conditions:
+//  *
+//  * The above copyright notice and this permission notice shall be included in all
+//  * copies or substantial portions of the Software.
+//  *
+//  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  * SOFTWARE.
+
+namespace PuppeteerSharp.Messaging.Protocol.Network;
+
+internal class GetRequestPostDataRequest(string requestId)
+{
+    public string RequestId { get; set; } = requestId;
+}

lib/PuppeteerSharp/Messaging/Protocol/Network/GetRequestPostDataResponse.cs

@@ -0,0 +1,28 @@
+// * MIT License
+//  *
+//  * Copyright (c) Darío Kondratiuk
+//  *
+//  * Permission is hereby granted, free of charge, to any person obtaining a copy
+//  * of this software and associated documentation files (the "Software"), to deal
+//  * in the Software without restriction, including without limitation the rights
+//  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  * copies of the Software, and to permit persons to whom the Software is
+//  * furnished to do so, subject to the following conditions:
+//  *
+//  * The above copyright notice and this permission notice shall be included in all
+//  * copies or substantial portions of the Software.
+//  *
+//  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  * SOFTWARE.
+
+namespace PuppeteerSharp.Messaging.Protocol.Network;
+
+internal class GetRequestPostDataResponse
+{
+    public string PostData { get; set; }
+}

lib/PuppeteerSharp/Payload.cs

@@ -1,8 +1,5 @@
-using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Net.Http;
-using System.Web;
 using Newtonsoft.Json;
 using PuppeteerSharp.Helpers.Json;
 
@@ -30,12 +27,17 @@ public class Payload
         /// Gets or sets the HTTP headers.
         /// </summary>
         /// <value>HTTP headers.</value>
-        public Dictionary<string, string> Headers { get; set; } = new();
+        public Dictionary<string, string> Headers { get; set; } = [];
 
         /// <summary>
         /// Gets or sets the URL.
         /// </summary>
         /// <value>The URL.</value>
         public string Url { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether this <see cref="Payload"/> has post data.
+        /// </summary>
+        public bool? HasPostData { get; set; }
     }
 }

lib/PuppeteerSharp/Request.cs

@@ -8,6 +8,7 @@
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
 using PuppeteerSharp.Messaging;
+using PuppeteerSharp.Messaging.Protocol.Network;
 
 namespace PuppeteerSharp
 {
@@ -39,6 +40,7 @@ internal Request(
             ResourceType = e.Type;
             Method = e.Request.Method;
             PostData = e.Request.PostData;
+            HasPostData = e.Request.HasPostData ?? false;
             Frame = frame;
             RedirectChainList = redirectChain;
 
@@ -90,6 +92,9 @@ internal Request(
         /// <inheritdoc/>
         public IRequest[] RedirectChain => RedirectChainList.ToArray();
 
+        /// <inheritdoc/>
+        public bool HasPostData { get; private set; }
+
         internal bool FromMemoryCache { get; set; }
 
         internal List<IRequest> RedirectChainList { get; }
@@ -263,6 +268,24 @@ public async Task AbortAsync(RequestAbortErrorCode errorCode = RequestAbortError
             }
         }
 
+        /// <inheritdoc />
+        public async Task<string> FetchPostDataAsync()
+        {
+            try
+            {
+                var result = await _client.SendAsync<GetRequestPostDataResponse>(
+                    "Network.getRequestPostData",
+                    new GetRequestPostDataRequest(RequestId)).ConfigureAwait(false);
+                return result.PostData;
+            }
+            catch (Exception ex)
+            {
+                _logger.LogError(ex, ex.ToString());
+            }
+
+            return null;
+        }
+
         private Header[] HeadersArray(Dictionary<string, string> headers)
             => headers?.Select(pair => new Header { Name = pair.Key, Value = pair.Value }).ToArray();
     }