Introduce RemoveExposedFunctionAsync and RemoveScriptToEvaluateOnNewDocumentAsync (#2510)

Author: kblok

lib/PuppeteerSharp.Tests/EvaluationTests/RemoveScriptToEvaluateOnNewDocumentTests.cs

@@ -0,0 +1,23 @@
+using System.Threading.Tasks;
+using NUnit.Framework;
+using PuppeteerSharp.Nunit;
+
+namespace PuppeteerSharp.Tests.EvaluationTests
+{
+    public class RemoveScriptToEvaluateOnNewDocumentTests : PuppeteerPageBaseTest
+    {
+        [Test, Retry(2), PuppeteerTest("evaluation.spec", "Evaluation specs Page.removeScriptToEvaluateOnNewDocument", "should remove new document script")]
+        public async Task ShouldRemoveNewDocumentScript()
+        {
+            var id = await Page.EvaluateFunctionOnNewDocumentAsync("() => globalThis.injected = 123");
+            await Page.GoToAsync(TestConstants.ServerUrl + "/tamperable.html");
+            var result = await Page.EvaluateFunctionAsync<int>("async () => globalThis.result");
+            Assert.AreEqual(123, result);
+
+            await Page.RemoveScriptToEvaluateOnNewDocumentAsync(id.Identifier);
+
+            await Page.ReloadAsync();
+            Assert.IsNull(await Page.EvaluateFunctionAsync("() => globalThis.result ?? null"));
+        }
+    }
+}

lib/PuppeteerSharp.Tests/PageTests/ExposeFunctionTests.cs

@@ -8,10 +8,6 @@ namespace PuppeteerSharp.Tests.PageTests
 {
     public class ExposeFunctionTests : PuppeteerPageBaseTest
     {
-        public ExposeFunctionTests() : base()
-        {
-        }
-
         [Test, Retry(2), PuppeteerTest("page.spec", "Page Page.exposeFunction", "should work")]
         public async Task ShouldWork()
         {

lib/PuppeteerSharp.Tests/PageTests/RemoveExposedFunctionTests.cs

@@ -0,0 +1,21 @@
+using System.Threading.Tasks;
+using NUnit.Framework;
+using PuppeteerSharp.Nunit;
+
+namespace PuppeteerSharp.Tests.PageTests
+{
+    public class RemoveExposeFunctionTests : PuppeteerPageBaseTest
+    {
+        [Test, Retry(2), PuppeteerTest("page.spec", "Page Page.removeExposedFunction", "should work")]
+        public async Task ShouldWork()
+        {
+            await Page.ExposeFunctionAsync("compute", (int a, int b) => a * b);
+            var result = await Page.EvaluateFunctionAsync<int>("async () => compute(9, 4)");
+            Assert.AreEqual(36, result);
+
+            await Page.RemoveExposedFunctionAsync("compute");
+
+            Assert.ThrowsAsync<EvaluationFailedException>(() => Page.EvaluateFunctionAsync<int>("async () => compute(9, 4)"));
+        }
+    }
+}

lib/PuppeteerSharp/IPage.cs

@@ -574,7 +574,7 @@ public interface IPage : IDisposable, IAsyncDisposable
         /// </code>
         /// </example>
         /// <returns>Task.</returns>
-        Task EvaluateExpressionOnNewDocumentAsync(string expression);
+        Task<NewDocumentScriptEvaluation> EvaluateExpressionOnNewDocumentAsync(string expression);
 
         /// <summary>
         /// Executes a function in browser context.
@@ -632,7 +632,7 @@ public interface IPage : IDisposable, IAsyncDisposable
         /// </code>
         /// </example>
         /// <returns>Task.</returns>
-        Task EvaluateFunctionOnNewDocumentAsync(string pageFunction, params object[] args);
+        Task<NewDocumentScriptEvaluation> EvaluateFunctionOnNewDocumentAsync(string pageFunction, params object[] args);
 
         /// <summary>
         /// Adds a function called <c>name</c> on the page's <c>window</c> object.
@@ -647,6 +647,13 @@ public interface IPage : IDisposable, IAsyncDisposable
         /// <returns>Task.</returns>
         Task ExposeFunctionAsync(string name, Action puppeteerFunction);
 
+        /// <summary>
+        /// Removes a previously added function via <see cref="IPage.ExposeFunctionAsync(string, Action)"/>.
+        /// </summary>
+        /// <param name="name">Name of the function to remove.</param>
+        /// <returns>Task.</returns>
+        Task RemoveExposedFunctionAsync(string name);
+
         /// <summary>
         /// Adds a function called <c>name</c> on the page's <c>window</c> object.
         /// When called, the function executes <paramref name="puppeteerFunction"/> in C# and returns a <see cref="Task"/> which resolves to the return value of <paramref name="puppeteerFunction"/>.
@@ -1464,5 +1471,12 @@ public interface IPage : IDisposable, IAsyncDisposable
         /// </summary>
         /// <returns>A task that returns a <see cref="ICDPSession"/>.</returns>
         Task<ICDPSession> CreateCDPSessionAsync();
+
+        /// <summary>
+        /// Removes script that injected into page by <see cref="IPage.EvaluateExpressionOnNewDocumentAsync(string)"/> or <see cref="IPage.EvaluateExpressionOnNewDocumentAsync(string)"/>.
+        /// </summary>
+        /// <param name="identifier">Function identifier.</param>
+        /// <returns>A task that resolves when the script is removed.</returns>
+        public Task RemoveScriptToEvaluateOnNewDocumentAsync(string identifier);
     }
 }

lib/PuppeteerSharp/Messaging/PageAddScriptToEvaluateOnNewDocumentResponse.cs

@@ -0,0 +1,6 @@
+namespace PuppeteerSharp.Messaging;
+
+internal class PageAddScriptToEvaluateOnNewDocumentResponse
+{
+    public string Identifier { get; set; }
+}

lib/PuppeteerSharp/Messaging/PageRemoveScriptToEvaluateOnNewDocumentRequest.cs

@@ -0,0 +1,6 @@
+namespace PuppeteerSharp.Messaging;
+
+internal class PageRemoveScriptToEvaluateOnNewDocumentRequest
+{
+    public string Identifier { get; set; }
+}

lib/PuppeteerSharp/Messaging/RuntimeRemoveBindingRequest.cs

@@ -0,0 +1,6 @@
+namespace PuppeteerSharp.Messaging;
+
+internal class RuntimeRemoveBindingRequest
+{
+    public string Name { get; set; }
+}

lib/PuppeteerSharp/NewDocumentScriptEvaluation.cs

@@ -0,0 +1,12 @@
+namespace PuppeteerSharp;
+
+/// <summary>
+/// New document information.
+/// </summary>
+public class NewDocumentScriptEvaluation(string documentIdentifierIdentifier)
+{
+    /// <summary>
+    /// New document identifier.
+    /// </summary>
+    public string Identifier { get; set; } = documentIdentifierIdentifier;
+}