mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00

feat(page): Adding support for referrerPolicy in page.goto (#9561 )

Issue: #9394

**What kind of change does this PR introduce?**

Feature - Added support of the `referrerPolicy` parameter (from CDP's
`Page.navigate`) to Puppeteer's `page.goto`.

**Did you add tests for your changes?**

No, currently it has no meaning that isn't browser implementation based,
which might get broken in the future. If there are suggestions to tests,
please let me know so I'll add them.

**If relevant, did you update the documentation?**
Yes, the documentation of the `goto` method has been updated.

**Summary**
I wanted to contribute to this project, which I used for testing on our
environment and saw issue #9394, so I decided to resolve it :)

**Does this PR introduce a breaking change?**
No. I added the `referrerPolicy` as an optional parameter, which will
use the HTTP header `Referrer-Policy` if not provided (much like the
`referer` parameter) so it will not interfere.

Co-authored-by: Ophir Back <ophir.back@broadcom.com>

2023-01-23 11:11:20 +00:00

3.3 KiB

Raw Blame History

sidebar_label
Frame.goto

Frame.goto() method

Navigates a frame to the given url.

Signature:

class Frame {
  goto(
    url: string,
    options?: {
      referer?: string;
      referrerPolicy?: string;
      timeout?: number;
      waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[];
    }
  ): Promise<HTTPResponse | null>;
}

Parameters

Parameter	Type	Description
url	string	the URL to navigate the frame to. This should include the scheme, e.g. `https://`.
options	{ referer?: string; referrerPolicy?: string; timeout?: number; waitUntil?: PuppeteerLifeCycleEvent \| PuppeteerLifeCycleEvent[]; }	(Optional) navigation options. `waitUntil` is useful to define when the navigation should be considered successful - see the docs for PuppeteerLifeCycleEvent for more details.

Returns:

Promise<HTTPResponse | null>

A promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.

Exceptions

This method will throw an error if:

there's an SSL error (e.g. in case of self-signed certificates). - target URL is invalid. - the timeout is exceeded during navigation. - the remote server does not respond or is unreachable. - the main resource failed to load.

This method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling HTTPResponse.status().

Remarks

Navigation to about:blank or navigation to the same URL with a different hash will succeed and return null.

:::warning

Headless mode doesn't support navigation to a PDF document. See the upstream issue.

:::

3.3 KiB Raw Blame History