module Playwright::Request
Overview
Whenever the page sends a request for a network resource the following sequence of events are emitted by Page:
page.on('request') emitted when the request is issued by the page. page.on('response') emitted when/if the response status and headers are received for the request. page.on('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 page.on('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.
Defined in:
playwright/request.crInstance Method Summary
-
#failure : RequestFailure | Nil
The method returns
nullunless this request has failed, as reported byrequestfailedevent. -
#frame : Frame
Returns the Frame that initiated this request.
-
#headers : Hash(String, String)
An object with HTTP headers associated with the request.
-
#is_navigation_request : Bool
Whether this request is driving frame's navigation.
-
#method : String
Request's method (GET, POST, etc.)
-
#post_data : String | Nil
Request's post body, if any.
-
#post_data_buffer : Bytes | Nil
Request's post body in a binary form, if any.
-
#redirected_from : Request | Nil
Request that was redirected by the server to this one, if any.
-
#redirected_to : Request | Nil
New request issued by the browser if the server responded with redirect.
-
#resource_type : String
Contains the request's resource type as it was perceived by the rendering engine.
-
#response : Response | Nil
Returns the matching Response object, or
nullif the response was not received due to error. -
#timing : RequestTiming
Returns resource timing information for given request.
-
#url : String
URL of the request.
Instance Method Detail
The method returns null unless this request has failed, as reported by requestfailed event.
Example of logging of all the failed requests:
An object with HTTP headers associated with the request. All header names are lower-case.
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 redirectedFrom() and redirectedTo() methods. When multiple server redirects has happened, it is possible to construct the whole redirect chain by repeatedly calling redirectedFrom().
For example, if the website http://example.com redirects to https://example.com:
If the website https://google.com has no redirects:
New request issued by the browser if the server responded with redirect.
This method is the opposite of request.redirectedFrom():
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.
Returns the matching Response object, or null if the response was not received due to error.
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.