feat: add rootFrame helper / convenience method

Bug: #11072
puppeteer · Oct 13, 2023 · be87afd · be87afd
1 parent eae37d9
commit be87afd
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/packages/puppeteer-core/src/api/Frame.ts b/packages/puppeteer-core/src/api/Frame.ts
@@ -830,6 +830,11 @@ export abstract class Frame extends EventEmitter<FrameEvents> {
    */
   abstract parentFrame(): Frame | null;
 
+  /**
+   * The root of this frame, if any.
+   */
+  abstract rootFrame(): Frame | null;
+
   /**
    * An array of child frames.
    */

diff --git a/packages/puppeteer-core/src/bidi/Frame.ts b/packages/puppeteer-core/src/bidi/Frame.ts
@@ -132,6 +132,14 @@ export class BidiFrame extends Frame {
     return this.#page.frame(this._parentId ?? '');
   }
 
+  override rootFrame(): BidiFrame | null {
+    if (this.parentFrame() === null) {
+      return this;
+    } else {
+      return this.parentFrame()!.rootFrame();
+    }
+  }
+
   override childFrames(): BidiFrame[] {
     return this.#page.childFrames(this.#context.id);
   }

diff --git a/packages/puppeteer-core/src/cdp/Frame.ts b/packages/puppeteer-core/src/cdp/Frame.ts
@@ -287,6 +287,14 @@ export class CdpFrame extends Frame {
     return this._frameManager._frameTree.parentFrame(this._id) || null;
   }
 
+  override rootFrame(): CdpFrame | null {
+    if (this.parentFrame() === null) {
+      return this;
+    } else {
+      return this.parentFrame()!.rootFrame();
+    }
+  }
+
   override childFrames(): CdpFrame[] {
     return this._frameManager._frameTree.childFrames(this._id);
   }
@@ -295,9 +303,9 @@ export class CdpFrame extends Frame {
     if (this.isOOPFrame()) {
       return this._frameManager._deviceRequestPromptManager(this.#client);
     }
-    const parentFrame = this.parentFrame();
-    assert(parentFrame !== null);
-    return parentFrame.#deviceRequestPromptManager();
+    const rootFrame = this.rootFrame();
+    assert(rootFrame !== null);
+    return rootFrame._frameManager._deviceRequestPromptManager(this.#client);
   }
 
   @throwIfDetached