Skip to content

Latest commit

 

History

History
287 lines (215 loc) · 10.1 KB

class-request.md

File metadata and controls

287 lines (215 loc) · 10.1 KB
Raw

class: 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.

async method: Request.allHeaders

  • returns: <[Object]<[string], [string]>>

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

method: Request.failure

  • returns: <[null]|[string]>

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

Example of logging of all the failed requests:

page.on('requestfailed', request => {
  console.log(request.url() + ' ' + request.failure().errorText);
});
page.onRequestFailed(request -> {
  System.out.println(request.url() + " " + request.failure());
});
page.on("requestfailed", lambda request: print(request.url + " " + request.failure))
page.RequestFailed += (_, request) =>
{
    Console.WriteLine(request.Failure);
};

method: Request.frame

  • returns: <[Frame]>

Returns the [Frame] that initiated this request.

method: Request.headers

  • returns: <[Object]<[string], [string]>>

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 [method: Request.allHeaders] for complete list of headers that include cookie information.

async method: Request.headersArray

  • returns: <[Array]<[Object]>>
    • name <[string]> Name of the header.
    • value <[string]> Value of the header.

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

async method: Request.headerValue

  • returns: <[null]|[string]>

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

param: Request.headerValue.name

  • name <[string]>

Name of the header.

method: Request.isNavigationRequest

  • returns: <[boolean]>

Whether this request is driving frame's navigation.

method: Request.method

  • returns: <[string]>

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

method: Request.postData

  • returns: <[null]|[string]>

Request's post body, if any.

method: Request.postDataBuffer

  • returns: <[null]|[Buffer]>

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

method: Request.postDataJSON

  • langs: js, python
  • returns: <[null]|[Serializable]>

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.

method: Request.redirectedFrom

  • returns: <[null]|[Request]>

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:

const response = await page.goto('http://example.com');
console.log(response.request().redirectedFrom().url()); // 'http://example.com'
Response response = page.navigate("http://example.com");
System.out.println(response.request().redirectedFrom().url()); // "http://example.com"
response = await page.goto("http://example.com")
print(response.request.redirected_from.url) # "http://example.com"
response = page.goto("http://example.com")
print(response.request.redirected_from.url) # "http://example.com"
var response = await page.GotoAsync("http://www.microsoft.com");
Console.WriteLine(response.Request.RedirectedFrom?.Url); // http://www.microsoft.com

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

const response = await page.goto('https://google.com');
console.log(response.request().redirectedFrom()); // null
Response response = page.navigate("https://google.com");
System.out.println(response.request().redirectedFrom()); // null
response = await page.goto("https://google.com")
print(response.request.redirected_from) # None
response = page.goto("https://google.com")
print(response.request.redirected_from) # None
var response = await page.GotoAsync("https://www.google.com");
Console.WriteLine(response.Request.RedirectedFrom?.Url); // null

method: Request.redirectedTo

  • returns: <[null]|[Request]>

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

This method is the opposite of [method: Request.redirectedFrom]:

console.log(request.redirectedFrom().redirectedTo() === request); // true
System.out.println(request.redirectedFrom().redirectedTo() == request); // true
assert request.redirected_from.redirected_to == request
Console.WriteLine(request.RedirectedFrom?.RedirectedTo == request); // True

method: Request.resourceType

  • returns: <[string]>

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.

async method: Request.response

  • returns: <[null]|[Response]>

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

async method: Request.sizes

  • returns: <[Object]>
    • requestBodySize <[int]> Size of the request body (POST data payload) in bytes. Set to 0 if there was no body.
    • requestHeadersSize <[int]> Total number of bytes from the start of the HTTP request message until (and including) the double CRLF before the body.
    • responseBodySize <[int]> Size of the received response body (encoded) in bytes.
    • responseHeadersSize <[int]> Total number of bytes from the start of the HTTP response message until (and including) the double CRLF before the body.

Returns resource size information for given request.

method: Request.timing

  • returns: <[Object]>
    • startTime <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
    • domainLookupStart <[float]> Time immediately before the browser starts the domain name lookup for the resource. The value is given in milliseconds relative to startTime, -1 if not available.
    • domainLookupEnd <[float]> Time immediately after the browser starts the domain name lookup for the resource. The value is given in milliseconds relative to startTime, -1 if not available.
    • connectStart <[float]> Time immediately before the user agent starts establishing the connection to the server to retrieve the resource. The value is given in milliseconds relative to startTime, -1 if not available.
    • secureConnectionStart <[float]> Time immediately before the browser starts the handshake process to secure the current connection. The value is given in milliseconds relative to startTime, -1 if not available.
    • connectEnd <[float]> Time immediately before the user agent starts establishing the connection to the server to retrieve the resource. The value is given in milliseconds relative to startTime, -1 if not available.
    • requestStart <[float]> Time immediately before the browser starts requesting the resource from the server, cache, or local resource. The value is given in milliseconds relative to startTime, -1 if not available.
    • responseStart <[float]> Time immediately after the browser starts requesting the resource from the server, cache, or local resource. The value is given in milliseconds relative to startTime, -1 if not available.
    • responseEnd <[float]> Time immediately after the browser receives the last byte of the resource or immediately before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to startTime, -1 if not available.

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.

const [request] = await Promise.all([
  page.waitForEvent('requestfinished'),
  page.goto('http://example.com')
]);
console.log(request.timing());
page.onRequestFinished(request -> {
  Timing timing = request.timing();
  System.out.println(timing.responseEnd - timing.startTime);
});
page.navigate("http://example.com");
async with page.expect_event("requestfinished") as request_info:
    await page.goto("http://example.com")
request = await request_info.value
print(request.timing)
with page.expect_event("requestfinished") as request_info:
    page.goto("http://example.com")
request = request_info.value
print(request.timing)
var request = await page.RunAndWaitForRequestFinishedAsync(async () =>
{
    await page.GotoAsync("https://www.microsoft.com");
});
Console.WriteLine(request.Timing.ResponseEnd);

method: Request.url

  • returns: <[string]>

URL of the request.