feat: Page.removeScriptToEvaluateOnNewDocument (#10250)

Co-authored-by: Alex Rudenko <alexrudenko@chromium.org>
puppeteer · May 26, 2023 · b5a124f · b5a124f
1 parent 031b021
commit b5a124f
Show file tree

Hide file tree

Showing 9 changed files with 220 additions and 112 deletions.
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -98,6 +98,7 @@ sidebar_label: API
 | [MouseOptions](./puppeteer.mouseoptions.md)                                 |                                                                                                                                                                                                     |
 | [MouseWheelOptions](./puppeteer.mousewheeloptions.md)                       |                                                                                                                                                                                                     |
 | [NetworkConditions](./puppeteer.networkconditions.md)                       |                                                                                                                                                                                                     |
+| [NewDocumentScriptEvaluation](./puppeteer.newdocumentscriptevaluation.md)   |                                                                                                                                                                                                     |
 | [Offset](./puppeteer.offset.md)                                             |                                                                                                                                                                                                     |
 | [PageEventObject](./puppeteer.pageeventobject.md)                           | <p>Denotes the objects received by callback functions for page events.</p><p>See [PageEmittedEvents](./puppeteer.pageemittedevents.md) for more detail on the events and when they are emitted.</p> |
 | [PDFMargin](./puppeteer.pdfmargin.md)                                       |                                                                                                                                                                                                     |

diff --git a/docs/api/puppeteer.newdocumentscriptevaluation.md b/docs/api/puppeteer.newdocumentscriptevaluation.md
@@ -0,0 +1,17 @@
+---
+sidebar_label: NewDocumentScriptEvaluation
+---
+
+# NewDocumentScriptEvaluation interface
+
+#### Signature:
+
+```typescript
+export interface NewDocumentScriptEvaluation
+```
+
+## Properties
+
+| Property   | Modifiers | Type   | Description | Default |
+| ---------- | --------- | ------ | ----------- | ------- |
+| identifier |           | string |             |         |
diff --git a/docs/api/puppeteer.page.evaluateonnewdocument.md b/docs/api/puppeteer.page.evaluateonnewdocument.md
@@ -19,7 +19,10 @@ class Page {
   evaluateOnNewDocument<
     Params extends unknown[],
     Func extends (...args: Params) => unknown = (...args: Params) => unknown
-  >(pageFunction: Func | string, ...args: Params): Promise<void>;
+  >(
+    pageFunction: Func | string,
+    ...args: Params
+  ): Promise<NewDocumentScriptEvaluation>;
 }
 ```
 
@@ -32,7 +35,7 @@ class Page {
 
 **Returns:**
 
-Promise&lt;void&gt;
+Promise&lt;[NewDocumentScriptEvaluation](./puppeteer.newdocumentscriptevaluation.md)&gt;
 
 ## Example
 

diff --git a/docs/api/puppeteer.page.md b/docs/api/puppeteer.page.md
diff --git a/docs/api/puppeteer.page.removescripttoevaluateonnewdocument.md b/docs/api/puppeteer.page.removescripttoevaluateonnewdocument.md
@@ -0,0 +1,25 @@
+---
+sidebar_label: Page.removeScriptToEvaluateOnNewDocument
+---
+
+# Page.removeScriptToEvaluateOnNewDocument() method
+
+Removes script that injected into page by Page.evaluateOnNewDocument.
+
+#### Signature:
+
+```typescript
+class Page {
+  removeScriptToEvaluateOnNewDocument(identifier: string): Promise<void>;
+}
+```
+
+## Parameters
+
+| Parameter  | Type   | Description       |
+| ---------- | ------ | ----------------- |
+| identifier | string | script identifier |
+
+**Returns:**
+
+Promise&lt;void&gt;
diff --git a/packages/puppeteer-core/src/api/Page.ts b/packages/puppeteer-core/src/api/Page.ts
@@ -386,6 +386,13 @@ export interface PageEventObject {
   workerdestroyed: WebWorker;
 }
 
+/**
+ * @public
+ */
+export interface NewDocumentScriptEvaluation {
+  identifier: string;
+}
+
 /**
  * Page provides methods to interact with a single tab or
  * {@link https://developer.chrome.com/extensions/background_pages | extension background page}
@@ -2109,8 +2116,21 @@ export class Page extends EventEmitter {
   async evaluateOnNewDocument<
     Params extends unknown[],
     Func extends (...args: Params) => unknown = (...args: Params) => unknown
-  >(pageFunction: Func | string, ...args: Params): Promise<void>;
-  async evaluateOnNewDocument(): Promise<void> {
+  >(
+    pageFunction: Func | string,
+    ...args: Params
+  ): Promise<NewDocumentScriptEvaluation>;
+  async evaluateOnNewDocument(): Promise<NewDocumentScriptEvaluation> {
+    throw new Error('Not implemented');
+  }
+
+  /**
+   * Removes script that injected into page by Page.evaluateOnNewDocument.
+   *
+   * @param identifier - script identifier
+   */
+  async removeScriptToEvaluateOnNewDocument(identifier: string): Promise<void>;
+  async removeScriptToEvaluateOnNewDocument(): Promise<void> {
     throw new Error('Not implemented');
   }
 

diff --git a/packages/puppeteer-core/src/common/Page.ts b/packages/puppeteer-core/src/common/Page.ts
@@ -40,6 +40,7 @@ import {
   ScreenshotOptions,
   WaitForOptions,
   WaitTimeoutOptions,
+  NewDocumentScriptEvaluation,
 } from '../api/Page.js';
 import {assert} from '../util/assert.js';
 import {
@@ -1288,10 +1289,26 @@ export class CDPPage extends Page {
   override async evaluateOnNewDocument<
     Params extends unknown[],
     Func extends (...args: Params) => unknown = (...args: Params) => unknown
-  >(pageFunction: Func | string, ...args: Params): Promise<void> {
+  >(
+    pageFunction: Func | string,
+    ...args: Params
+  ): Promise<NewDocumentScriptEvaluation> {
     const source = evaluationString(pageFunction, ...args);
-    await this.#client.send('Page.addScriptToEvaluateOnNewDocument', {
-      source,
+    const {identifier} = await this.#client.send(
+      'Page.addScriptToEvaluateOnNewDocument',
+      {
+        source,
+      }
+    );
+
+    return {identifier};
+  }
+
+  override async removeScriptToEvaluateOnNewDocument(
+    identifier: string
+  ): Promise<void> {
+    await this.#client.send('Page.removeScriptToEvaluateOnNewDocument', {
+      identifier,
     });
   }
 

diff --git a/test/TestExpectations.json b/test/TestExpectations.json
@@ -17,6 +17,18 @@
     "parameters": ["webDriverBiDi"],
     "expectations": ["PASS"]
   },
+  {
+    "testIdPattern": "[evaluation.spec] Evaluation specs Page.evaluateOnNewDocument *",
+    "platforms": ["darwin", "linux", "win32"],
+    "parameters": ["webDriverBiDi"],
+    "expectations": ["SKIP"]
+  },
+  {
+    "testIdPattern": "[evaluation.spec] Evaluation specs Page.removeScriptToEvaluateOnNewDocument *",
+    "platforms": ["darwin", "linux", "win32"],
+    "parameters": ["webDriverBiDi"],
+    "expectations": ["SKIP"]
+  },
   {
     "testIdPattern": "[EventEmitter.spec] EventEmitter *",
     "platforms": ["darwin", "linux", "win32"],
@@ -294,15 +306,15 @@
     "expectations": ["SKIP"]
   },
   {
-    "testIdPattern": "[evaluation.spec] Evaluation specs Page.evaluateOnNewDocument should evaluate before anything else on the page",
+    "testIdPattern": "[evaluation.spec] Evaluation specs Page.evaluateOnNewDocument *",
     "platforms": ["darwin", "linux", "win32"],
-    "parameters": ["webDriverBiDi"],
+    "parameters": ["cdp", "firefox"],
     "expectations": ["SKIP"]
   },
   {
-    "testIdPattern": "[evaluation.spec] Evaluation specs Page.evaluateOnNewDocument should work with CSP",
+    "testIdPattern": "[evaluation.spec] Evaluation specs Page.removeScriptToEvaluateOnNewDocument *",
     "platforms": ["darwin", "linux", "win32"],
-    "parameters": ["webDriverBiDi"],
+    "parameters": ["cdp", "firefox"],
     "expectations": ["SKIP"]
   },
   {
@@ -905,18 +917,6 @@
     "parameters": ["cdp", "firefox"],
     "expectations": ["SKIP"]
   },
-  {
-    "testIdPattern": "[evaluation.spec] Evaluation specs Page.evaluateOnNewDocument should evaluate before anything else on the page",
-    "platforms": ["darwin", "linux", "win32"],
-    "parameters": ["cdp", "firefox"],
-    "expectations": ["SKIP"]
-  },
-  {
-    "testIdPattern": "[evaluation.spec] Evaluation specs Page.evaluateOnNewDocument should work with CSP",
-    "platforms": ["darwin", "linux", "win32"],
-    "parameters": ["cdp", "firefox"],
-    "expectations": ["FAIL"]
-  },
   {
     "testIdPattern": "[fixtures.spec] Fixtures dumpio option should work with pipe option",
     "platforms": ["darwin", "linux", "win32"],

diff --git a/test/src/evaluation.spec.ts b/test/src/evaluation.spec.ts
@@ -537,6 +537,30 @@ describe('Evaluation specs', function () {
     });
   });
 
+  describe('Page.removeScriptToEvaluateOnNewDocument', function () {
+    it('should remove new document script', async () => {
+      const {page, server} = getTestState();
+
+      const {identifier} = await page.evaluateOnNewDocument(function () {
+        (globalThis as any).injected = 123;
+      });
+      await page.goto(server.PREFIX + '/tamperable.html');
+      expect(
+        await page.evaluate(() => {
+          return (globalThis as any).result;
+        })
+      ).toBe(123);
+
+      await page.removeScriptToEvaluateOnNewDocument(identifier);
+      await page.reload();
+      expect(
+        await page.evaluate(() => {
+          return (globalThis as any).result || null;
+        })
+      ).toBe(null);
+    });
+  });
+
   describe('Frame.evaluate', function () {
     it('should have different execution contexts', async () => {
       const {page, server} = getTestState();