From 6b4a99fcfa25a6904e49e8133cc8446a85fc679a Mon Sep 17 00:00:00 2001
From: jrandolf <101637635+jrandolf@users.noreply.github.com>
Date: Thu, 1 Sep 2022 17:52:08 +0200
Subject: [PATCH] chore: migrate `addStyleTag` (#8879)

* chore: remove unnecessary type signature

* chore: fix tests

* chore: migrate `addStyleTag`

* chore: fix tests

* chore: fix tests
---
 docs/api/puppeteer.frame.addstyletag.md   | 16 ++--
 docs/api/puppeteer.frame.addstyletag_1.md | 25 +++++++
 docs/api/puppeteer.frame.md               |  3 +-
 docs/api/puppeteer.page.addstyletag.md    | 20 ++---
 docs/api/puppeteer.page.addstyletag_1.md  | 25 +++++++
 docs/api/puppeteer.page.md                |  3 +-
 src/common/Frame.ts                       | 90 +++++++++++++++++++++--
 src/common/IsolatedWorld.ts               | 87 ----------------------
 src/common/Page.ts                        | 34 ++++++---
 test/src/page.spec.ts                     |  6 +-
 10 files changed, 180 insertions(+), 129 deletions(-)
 create mode 100644 docs/api/puppeteer.frame.addstyletag_1.md
 create mode 100644 docs/api/puppeteer.page.addstyletag_1.md

diff --git a/docs/api/puppeteer.frame.addstyletag.md b/docs/api/puppeteer.frame.addstyletag.md
index 5b00d734afa3b..7ca3032cf1461 100644
--- a/docs/api/puppeteer.frame.addstyletag.md
+++ b/docs/api/puppeteer.frame.addstyletag.md
@@ -4,26 +4,26 @@ sidebar_label: Frame.addStyleTag
 
 # Frame.addStyleTag() method
 
-Adds a `<link rel="stylesheet">` tag into the page with the desired url or a `<style type="text/css">` tag with the content.
+Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
 
 **Signature:**
 
 ```typescript
 class Frame {
   addStyleTag(
-    options: FrameAddStyleTagOptions
-  ): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>>;
+    options: Omit<FrameAddStyleTagOptions, 'url'>
+  ): Promise<ElementHandle<HTMLStyleElement>>;
 }
 ```
 
 ## Parameters
 
-| Parameter | Type                                                              | Description                 |
-| --------- | ----------------------------------------------------------------- | --------------------------- |
-| options   | [FrameAddStyleTagOptions](./puppeteer.frameaddstyletagoptions.md) | Options for the style link. |
+| Parameter | Type                                                                                 | Description |
+| --------- | ------------------------------------------------------------------------------------ | ----------- |
+| options   | Omit&lt;[FrameAddStyleTagOptions](./puppeteer.frameaddstyletagoptions.md), 'url'&gt; |             |
 
 **Returns:**
 
-Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)&lt;HTMLStyleElement \| HTMLLinkElement&gt;&gt;
+Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)&lt;HTMLStyleElement&gt;&gt;
 
-a promise that resolves to the added tag when the stylesheets's `onload` event fires or when the CSS content was injected into the frame.
+An [element handle](./puppeteer.elementhandle.md) to the loaded `<link>` or `<style>` element.
diff --git a/docs/api/puppeteer.frame.addstyletag_1.md b/docs/api/puppeteer.frame.addstyletag_1.md
new file mode 100644
index 0000000000000..81805b3ae5f53
--- /dev/null
+++ b/docs/api/puppeteer.frame.addstyletag_1.md
@@ -0,0 +1,25 @@
+---
+sidebar_label: Frame.addStyleTag_1
+---
+
+# Frame.addStyleTag() method
+
+**Signature:**
+
+```typescript
+class Frame {
+  addStyleTag(
+    options: FrameAddStyleTagOptions
+  ): Promise<ElementHandle<HTMLLinkElement>>;
+}
+```
+
+## Parameters
+
+| Parameter | Type                                                              | Description |
+| --------- | ----------------------------------------------------------------- | ----------- |
+| options   | [FrameAddStyleTagOptions](./puppeteer.frameaddstyletagoptions.md) |             |
+
+**Returns:**
+
+Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)&lt;HTMLLinkElement&gt;&gt;
diff --git a/docs/api/puppeteer.frame.md b/docs/api/puppeteer.frame.md
index 0d94f79992ce3..e615cd45b5fb4 100644
--- a/docs/api/puppeteer.frame.md
+++ b/docs/api/puppeteer.frame.md
@@ -69,7 +69,8 @@ console.log(text);
 | [$eval(selector, pageFunction, args)](./puppeteer.frame._eval.md)                    |           | <p>Runs the given function on the first element matching the given selector in the frame.</p><p>If the given function returns a promise, then this method will wait till the promise resolves.</p>                                                                         |
 | [$x(expression)](./puppeteer.frame._x.md)                                            |           |                                                                                                                                                                                                                                                                            |
 | [addScriptTag(options)](./puppeteer.frame.addscripttag.md)                           |           | Adds a <code>&lt;script&gt;</code> tag into the page with the desired url or content.                                                                                                                                                                                      |
-| [addStyleTag(options)](./puppeteer.frame.addstyletag.md)                             |           | Adds a <code>&lt;link rel=&quot;stylesheet&quot;&gt;</code> tag into the page with the desired url or a <code>&lt;style type=&quot;text/css&quot;&gt;</code> tag with the content.                                                                                         |
+| [addStyleTag(options)](./puppeteer.frame.addstyletag.md)                             |           | Adds a <code>&lt;link rel=&quot;stylesheet&quot;&gt;</code> tag into the page with the desired URL or a <code>&lt;style type=&quot;text/css&quot;&gt;</code> tag with the content.                                                                                         |
+| [addStyleTag(options)](./puppeteer.frame.addstyletag_1.md)                           |           |                                                                                                                                                                                                                                                                            |
 | [childFrames()](./puppeteer.frame.childframes.md)                                    |           |                                                                                                                                                                                                                                                                            |
 | [click(selector, options)](./puppeteer.frame.click.md)                               |           | Clicks the first element found that matches <code>selector</code>.                                                                                                                                                                                                         |
 | [content()](./puppeteer.frame.content.md)                                            |           |                                                                                                                                                                                                                                                                            |
diff --git a/docs/api/puppeteer.page.addstyletag.md b/docs/api/puppeteer.page.addstyletag.md
index 2855855a7b712..a4c91c0d4c915 100644
--- a/docs/api/puppeteer.page.addstyletag.md
+++ b/docs/api/puppeteer.page.addstyletag.md
@@ -6,26 +6,26 @@ sidebar_label: Page.addStyleTag
 
 Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
 
+Shortcut for .
+
 **Signature:**
 
 ```typescript
 class Page {
-  addStyleTag(options: {
-    url?: string;
-    path?: string;
-    content?: string;
-  }): Promise<ElementHandle<Node>>;
+  addStyleTag(
+    options: Omit<FrameAddStyleTagOptions, 'url'>
+  ): Promise<ElementHandle<HTMLStyleElement>>;
 }
 ```
 
 ## Parameters
 
-| Parameter | Type                                               | Description |
-| --------- | -------------------------------------------------- | ----------- |
-| options   | { url?: string; path?: string; content?: string; } |             |
+| Parameter | Type                                                                                 | Description |
+| --------- | ------------------------------------------------------------------------------------ | ----------- |
+| options   | Omit&lt;[FrameAddStyleTagOptions](./puppeteer.frameaddstyletagoptions.md), 'url'&gt; |             |
 
 **Returns:**
 
-Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt;&gt;
+Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)&lt;HTMLStyleElement&gt;&gt;
 
-Promise which resolves to the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
+An [element handle](./puppeteer.elementhandle.md) to the injected `<link>` or `<style>` element.
diff --git a/docs/api/puppeteer.page.addstyletag_1.md b/docs/api/puppeteer.page.addstyletag_1.md
new file mode 100644
index 0000000000000..7e259e4f8cdf7
--- /dev/null
+++ b/docs/api/puppeteer.page.addstyletag_1.md
@@ -0,0 +1,25 @@
+---
+sidebar_label: Page.addStyleTag_1
+---
+
+# Page.addStyleTag() method
+
+**Signature:**
+
+```typescript
+class Page {
+  addStyleTag(
+    options: FrameAddStyleTagOptions
+  ): Promise<ElementHandle<HTMLLinkElement>>;
+}
+```
+
+## Parameters
+
+| Parameter | Type                                                              | Description |
+| --------- | ----------------------------------------------------------------- | ----------- |
+| options   | [FrameAddStyleTagOptions](./puppeteer.frameaddstyletagoptions.md) |             |
+
+**Returns:**
+
+Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)&lt;HTMLLinkElement&gt;&gt;
diff --git a/docs/api/puppeteer.page.md b/docs/api/puppeteer.page.md
index 21f2efa9e0148..f6d63edbcdbe3 100644
--- a/docs/api/puppeteer.page.md
+++ b/docs/api/puppeteer.page.md
@@ -82,7 +82,8 @@ page.off('request', logRequest);
 | [$eval(selector, pageFunction, args)](./puppeteer.page._eval.md)                            |           | This method runs <code>document.querySelector</code> within the page and passes the result as the first argument to the <code>pageFunction</code>.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | [$x(expression)](./puppeteer.page._x.md)                                                    |           | The method evaluates the XPath expression relative to the page document as its context node. If there are no such elements, the method resolves to an empty array.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | [addScriptTag(options)](./puppeteer.page.addscripttag.md)                                   |           | Adds a <code>&lt;script&gt;</code> tag into the page with the desired URL or content.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
-| [addStyleTag(options)](./puppeteer.page.addstyletag.md)                                     |           | Adds a <code>&lt;link rel=&quot;stylesheet&quot;&gt;</code> tag into the page with the desired URL or a <code>&lt;style type=&quot;text/css&quot;&gt;</code> tag with the content.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| [addStyleTag(options)](./puppeteer.page.addstyletag.md)                                     |           | <p>Adds a <code>&lt;link rel=&quot;stylesheet&quot;&gt;</code> tag into the page with the desired URL or a <code>&lt;style type=&quot;text/css&quot;&gt;</code> tag with the content.</p><p>Shortcut for .</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| [addStyleTag(options)](./puppeteer.page.addstyletag_1.md)                                   |           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | [authenticate(credentials)](./puppeteer.page.authenticate.md)                               |           | Provide credentials for <code>HTTP authentication</code>.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 | [bringToFront()](./puppeteer.page.bringtofront.md)                                          |           | Brings page to front (activates tab).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | [browser()](./puppeteer.page.browser.md)                                                    |           | Get the browser the page belongs to.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
diff --git a/src/common/Frame.ts b/src/common/Frame.ts
index bb99290827567..8a5507c87bbf4 100644
--- a/src/common/Frame.ts
+++ b/src/common/Frame.ts
@@ -18,6 +18,7 @@ import {LifecycleWatcher, PuppeteerLifeCycleEvent} from './LifecycleWatcher.js';
 import {Page} from './Page.js';
 import {getQueryHandlerAndSelector} from './QueryHandler.js';
 import {EvaluateFunc, HandleFor, NodeFor} from './types.js';
+import {importFS} from './util.js';
 
 /**
  * @public
@@ -751,7 +752,7 @@ export class Frame {
     const {path} = options;
     if (+!!options.url + +!!path + +!!content !== 1) {
       throw new Error(
-        'Exactly one of `url`, `path`, or `content` may be specified.'
+        'Exactly one of `url`, `path`, or `content` must be specified.'
       );
     }
 
@@ -795,7 +796,11 @@ export class Frame {
             script.addEventListener(
               'error',
               event => {
-                rej(event.message ?? 'Could not load script');
+                let message = 'Could not load script';
+                if (event instanceof ErrorEvent) {
+                  message = event.message ?? message;
+                }
+                rej(message);
               },
               {once: true}
             );
@@ -813,18 +818,87 @@ export class Frame {
   }
 
   /**
-   * Adds a `<link rel="stylesheet">` tag into the page with the desired url or
+   * Adds a `<link rel="stylesheet">` tag into the page with the desired URL or
    * a `<style type="text/css">` tag with the content.
    *
-   * @param options - Options for the style link.
-   * @returns a promise that resolves to the added tag when the stylesheets's
-   * `onload` event fires or when the CSS content was injected into the
-   * frame.
+   * @returns An {@link ElementHandle | element handle} to the loaded `<link>`
+   * or `<style>` element.
    */
+  async addStyleTag(
+    options: Omit<FrameAddStyleTagOptions, 'url'>
+  ): Promise<ElementHandle<HTMLStyleElement>>;
+  async addStyleTag(
+    options: FrameAddStyleTagOptions
+  ): Promise<ElementHandle<HTMLLinkElement>>;
   async addStyleTag(
     options: FrameAddStyleTagOptions
   ): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>> {
-    return this.worlds[MAIN_WORLD].addStyleTag(options);
+    let {content = ''} = options;
+    const {path} = options;
+    if (+!!options.url + +!!path + +!!content !== 1) {
+      throw new Error(
+        'Exactly one of `url`, `path`, or `content` must be specified.'
+      );
+    }
+
+    if (path) {
+      let fs: typeof import('fs').promises;
+      try {
+        fs = (await importFS()).promises;
+      } catch (error) {
+        if (error instanceof TypeError) {
+          throw new Error(
+            'Can only pass a file path in a Node-like environment.'
+          );
+        }
+        throw error;
+      }
+
+      content = await fs.readFile(path, 'utf8');
+      content += '/*# sourceURL=' + path.replace(/\n/g, '') + '*/';
+      options.content = content;
+    }
+
+    return this.worlds[MAIN_WORLD].transferHandle(
+      await this.worlds[PUPPETEER_WORLD].evaluateHandle(
+        async ({url, content}) => {
+          if (!url) {
+            const style = document.createElement('style');
+            style.appendChild(document.createTextNode(content!));
+            const promise = new Promise((res, rej) => {
+              style.addEventListener('load', res, {once: true});
+              style.addEventListener(
+                'error',
+                event => {
+                  rej(event.message ?? 'Could not load style');
+                },
+                {once: true}
+              );
+            });
+            document.head.appendChild(style);
+            await promise;
+            return style;
+          }
+          const link = document.createElement('link');
+          link.rel = 'stylesheet';
+          link.href = url;
+          const promise = new Promise((res, rej) => {
+            link.addEventListener('load', res, {once: true});
+            link.addEventListener(
+              'error',
+              event => {
+                rej(event.message ?? 'Could not load style');
+              },
+              {once: true}
+            );
+          });
+          document.head.appendChild(link);
+          await promise;
+          return link;
+        },
+        options
+      )
+    );
   }
 
   /**
diff --git a/src/common/IsolatedWorld.ts b/src/common/IsolatedWorld.ts
index 0b93dae9c5b33..9fe587e7c48bd 100644
--- a/src/common/IsolatedWorld.ts
+++ b/src/common/IsolatedWorld.ts
@@ -32,7 +32,6 @@ import {EvaluateFunc, HandleFor, NodeFor} from './types.js';
 import {
   createJSHandle,
   debugError,
-  importFS,
   isNumber,
   isString,
   makePredicateString,
@@ -334,92 +333,6 @@ export class IsolatedWorld {
     }
   }
 
-  /**
-   * Adds a style tag into the current context.
-   *
-   * @remarks
-   * You can pass a URL, filepath or string of contents. Note that when running Puppeteer
-   * in a browser environment you cannot pass a filepath and should use either
-   * `url` or `content`.
-   */
-  async addStyleTag(options: {
-    url?: string;
-    path?: string;
-    content?: string;
-  }): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>> {
-    const {url = null, path = null, content = null} = options;
-    if (url !== null) {
-      try {
-        const context = await this.executionContext();
-        return (await context.evaluateHandle(
-          addStyleUrl,
-          url
-        )) as ElementHandle<HTMLLinkElement>;
-      } catch (error) {
-        throw new Error(`Loading style from ${url} failed`);
-      }
-    }
-
-    if (path !== null) {
-      let fs: typeof import('fs').promises;
-      try {
-        fs = (await importFS()).promises;
-      } catch (error) {
-        if (error instanceof TypeError) {
-          throw new Error(
-            'Cannot pass a filepath to addStyleTag in the browser environment.'
-          );
-        }
-        throw error;
-      }
-
-      let contents = await fs.readFile(path, 'utf8');
-      contents += '/*# sourceURL=' + path.replace(/\n/g, '') + '*/';
-      const context = await this.executionContext();
-      return (await context.evaluateHandle(
-        addStyleContent,
-        contents
-      )) as ElementHandle<HTMLStyleElement>;
-    }
-
-    if (content !== null) {
-      const context = await this.executionContext();
-      return (await context.evaluateHandle(
-        addStyleContent,
-        content
-      )) as ElementHandle<HTMLStyleElement>;
-    }
-
-    throw new Error(
-      'Provide an object with a `url`, `path` or `content` property'
-    );
-
-    async function addStyleUrl(url: string): Promise<HTMLElement> {
-      const link = document.createElement('link');
-      link.rel = 'stylesheet';
-      link.href = url;
-      const promise = new Promise((res, rej) => {
-        link.onload = res;
-        link.onerror = rej;
-      });
-      document.head.appendChild(link);
-      await promise;
-      return link;
-    }
-
-    async function addStyleContent(content: string): Promise<HTMLElement> {
-      const style = document.createElement('style');
-      style.appendChild(document.createTextNode(content));
-      const promise = new Promise((res, rej) => {
-        style.onload = res;
-        style.onerror = rej;
-      });
-      document.head.appendChild(style);
-      await promise;
-      return style;
-    }
-  }
-
   async click(
     selector: string,
     options: {delay?: number; button?: MouseButton; clickCount?: number}
diff --git a/src/common/Page.ts b/src/common/Page.ts
index c760f6fef5891..0391891dc114a 100644
--- a/src/common/Page.ts
+++ b/src/common/Page.ts
@@ -32,7 +32,11 @@ import {ElementHandle} from './ElementHandle.js';
 import {EmulationManager} from './EmulationManager.js';
 import {EventEmitter, Handler} from './EventEmitter.js';
 import {FileChooser} from './FileChooser.js';
-import {Frame, FrameAddScriptTagOptions} from './Frame.js';
+import {
+  Frame,
+  FrameAddScriptTagOptions,
+  FrameAddStyleTagOptions,
+} from './Frame.js';
 import {FrameManager, FrameManagerEmittedEvents} from './FrameManager.js';
 import {HTTPRequest} from './HTTPRequest.js';
 import {HTTPResponse} from './HTTPResponse.js';
@@ -1423,16 +1427,24 @@ export class Page extends EventEmitter {
   }
 
   /**
-   * Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a
-   * `<style type="text/css">` tag with the content.
-   * @returns Promise which resolves to the added tag when the stylesheet's
-   * onload fires or when the CSS content was injected into frame.
-   */
-  async addStyleTag(options: {
-    url?: string;
-    path?: string;
-    content?: string;
-  }): Promise<ElementHandle<Node>> {
+   * Adds a `<link rel="stylesheet">` tag into the page with the desired URL or
+   * a `<style type="text/css">` tag with the content.
+   *
+   * Shortcut for
+   * {@link Frame.addStyleTag | page.mainFrame().addStyleTag(options)}.
+   *
+   * @returns An {@link ElementHandle | element handle} to the injected `<link>`
+   * or `<style>` element.
+   */
+  async addStyleTag(
+    options: Omit<FrameAddStyleTagOptions, 'url'>
+  ): Promise<ElementHandle<HTMLStyleElement>>;
+  async addStyleTag(
+    options: FrameAddStyleTagOptions
+  ): Promise<ElementHandle<HTMLLinkElement>>;
+  async addStyleTag(
+    options: FrameAddStyleTagOptions
+  ): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>> {
     return this.mainFrame().addStyleTag(options);
   }
 
diff --git a/test/src/page.spec.ts b/test/src/page.spec.ts
index d7620546cae5f..31b997110251b 100644
--- a/test/src/page.spec.ts
+++ b/test/src/page.spec.ts
@@ -1631,7 +1631,7 @@ describe('Page', function () {
         error = error_ as Error;
       }
       expect(error.message).toBe(
-        'Exactly one of `url`, `path`, or `content` may be specified.'
+        'Exactly one of `url`, `path`, or `content` must be specified.'
       );
     });
 
@@ -1797,7 +1797,7 @@ describe('Page', function () {
         error = error_ as Error;
       }
       expect(error.message).toBe(
-        'Provide an object with a `url`, `path` or `content` property'
+        'Exactly one of `url`, `path`, or `content` must be specified.'
       );
     });
 
@@ -1824,7 +1824,7 @@ describe('Page', function () {
       } catch (error_) {
         error = error_ as Error;
       }
-      expect(error.message).toBe('Loading style from /nonexistfile.js failed');
+      expect(error.message).toContain('Could not load style');
     });
 
     it('should work with a path', async () => {