Skip to main content

Request

Whenever the page sends a request for a network resource the following sequence of events are emitted by Page:

  • [event: Page.request] emitted when the request is issued by the page.
  • [event: Page.response] emitted when/if the response status and headers are received for the request.
  • [event: Page.requestFinished] emitted when the response body is downloaded and the request is complete.

If request fails at some point, then instead of 'requestfinished' event (and possibly instead of 'response' event), the [event: Page.requestFailed] event is emitted.

NOTE: HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with 'requestfinished' event.

If request gets a 'redirect' response, the request is successfully finished with the requestfinished event, and a new request is issued to a redirected url.

all_headers​

def all_headers

An object with all the request HTTP headers associated with this request. The header names are lower-cased.

failure​

def failure

The method returns null unless this request has failed, as reported by requestfailed event.

Usage

Example of logging of all the failed requests:

page.on("requestfailed", ->(request) { puts "#{request.url} #{request.failure}" })

frame​

def frame

Returns the Frame that initiated this request.

Usage

frame_url = request.frame.url

Details

Note that in some cases the frame is not available, and this method will throw.

  • When request originates in the Service Worker. You can use request.serviceWorker() to check that.
  • When navigation request is issued before the corresponding frame is created. You can use Request#navigation_request? to check that.

Here is an example that handles all the cases:

headers​

def headers

An object with the request HTTP headers. The header names are lower-cased. Note that this method does not return security-related headers, including cookie-related ones. You can use Request#all_headers for complete list of headers that include cookie information.

headers_array​

def headers_array

An array with all the request HTTP headers associated with this request. Unlike Request#all_headers, header names are NOT lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

header_value​

def header_value(name)

Returns the value of the header matching the name. The name is case insensitive.

def navigation_request?

Whether this request is driving frame's navigation.

Some navigation requests are issued before the corresponding frame is created, and therefore do not have Request#frame available.

method​

def method

Request's method (GET, POST, etc.)

post_data​

def post_data

Request's post body, if any.

post_data_buffer​

def post_data_buffer

Request's post body in a binary form, if any.

post_data_json​

def post_data_json

Returns parsed request's body for form-urlencoded and JSON as a fallback if any.

When the response is application/x-www-form-urlencoded then a key/value object of the values will be returned. Otherwise it will be parsed as JSON.

redirected_from​

def redirected_from

Request that was redirected by the server to this one, if any.

When the server responds with a redirect, Playwright creates a new Request object. The two requests are connected by redirected_from and redirected_to methods. When multiple server redirects has happened, it is possible to construct the whole redirect chain by repeatedly calling redirected_from.

Usage

For example, if the website http://github.com redirects to https://github.com:

response = page.goto("http://github.com")
puts response.url # => "https://github.com"
puts response.request.redirected_from&.url # => "http://github.com"

If the website https://google.com has no redirects:

response = page.goto("https://google.com")
puts response.request.redirected_from&.url # => nil

redirected_to​

def redirected_to

New request issued by the browser if the server responded with redirect.

Usage

This method is the opposite of Request#redirected_from:

request.redirected_from.redirected_to # equals to request

resource_type​

def resource_type

Contains the request's resource type as it was perceived by the rendering engine. ResourceType will be one of the following: document, stylesheet, image, media, font, script, texttrack, xhr, fetch, eventsource, websocket, manifest, other.

response​

def response

Returns the matching Response object, or null if the response was not received due to error.

sizes​

def sizes

Returns resource size information for given request.

timing​

def timing

Returns resource timing information for given request. Most of the timing values become available upon the response, responseEnd becomes available when request finishes. Find more information at Resource Timing API.

Usage

request = page.expect_event("requestfinished") do
  page.goto("https://example.com")
end
puts request.timing

url​

def url

URL of the request.