Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api: add Frame.page() getter #3392

Merged
merged 1 commit into from
Aug 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2092,6 +2092,7 @@ console.log(text);
- [frame.innerText(selector[, options])](#frameinnertextselector-options)
- [frame.isDetached()](#frameisdetached)
- [frame.name()](#framename)
- [frame.page()](#framepage)
- [frame.parentFrame()](#frameparentframe)
- [frame.press(selector, key[, options])](#framepressselector-key-options)
- [frame.selectOption(selector, values[, options])](#frameselectoptionselector-values-options)
Expand Down Expand Up @@ -2458,6 +2459,11 @@ If the name is empty, returns the id attribute instead.

> **NOTE** This value is calculated once when the frame is created, and will not update if the attribute is changed later.

#### frame.page()
- returns: <[Page]>

Returns the page containing this frame.

#### frame.parentFrame()
- returns: <[null]|[Frame]> Parent frame, if any. Detached frames and main frames return `null`.

Expand Down
4 changes: 4 additions & 0 deletions src/frames.ts
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,10 @@ export class Frame {
this._parentFrame._childFrames.add(this);
}

page(): Page {
return this._page;
}

private _apiName(method: string) {
const subject = this._page._callingPageAPI ? 'page' : 'frame';
return `${subject}.${method}`;
Expand Down
4 changes: 4 additions & 0 deletions src/rpc/client/frame.ts
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,10 @@ export class Frame extends ChannelOwner<FrameChannel, FrameInitializer> {
return this._page!._isPageCall ? 'page.' + method : 'frame.' + method;
}

page(): Page {
return this._page!;
}

async goto(url: string, options: FrameGotoOptions = {}): Promise<network.Response | null> {
return this._wrapApiCall(this._apiName('goto'), async () => {
const waitUntil = verifyLoadState('waitUntil', options.waitUntil === undefined ? 'load' : options.waitUntil);
Expand Down
6 changes: 6 additions & 0 deletions test/frame-hierarchy.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -189,3 +189,9 @@ it.fail(FFOX)('should refuse to display x-frame-options:deny iframe', async({pag
await page.setContent(`<iframe src="${server.CROSS_PROCESS_PREFIX}/x-frame-options-deny.html"></iframe>`);
expect(await refusalText).toMatch(/Refused to display 'http.*\/x-frame-options-deny\.html' in a frame because it set 'X-Frame-Options' to 'deny'./i)
});

it('should return frame.page()', async({page, server}) => {
await page.goto(server.PREFIX + '/frames/one-frame.html');
expect(page.mainFrame().page()).toBe(page);
expect(page.mainFrame().childFrames()[0].page()).toBe(page);
});