Class: Playwright::Request

Inherits:
PlaywrightApi show all
Defined in:
lib/playwright_api/request.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from PlaywrightApi

#==, #initialize, wrap

Constructor Details

This class inherits a constructor from Playwright::PlaywrightApi

Instance Method Details

#failure ⇒ Object

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

Example of logging of all the failed requests:

“‘js page.on(’requestfailed’, request => 

console.log(request.url() + ' ' + request.failure().errorText);

); “‘

“‘java page.onRequestFailed(request -> 

System.out.println(request.url() + " " + request.failure());

); “‘

“‘py page.on(“requestfailed”, lambda request: print(request.url + “ ” + request.failure)) “`



37
38
39
 
# File 'lib/playwright_api/request.rb', line 37

def failure
  wrap_impl(@impl.failure)
end

#frame ⇒ Object

Returns the ‘Frame` that initiated this request.



42
43
44
 
# File 'lib/playwright_api/request.rb', line 42

def frame
  wrap_impl(@impl.frame)
end

#headers ⇒ Object

An object with HTTP headers associated with the request. All header names are lower-case.



47
48
49
 
# File 'lib/playwright_api/request.rb', line 47

def headers
  wrap_impl(@impl.headers)
end

#method ⇒ Object

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



57
58
59
 
# File 'lib/playwright_api/request.rb', line 57

def method
  wrap_impl(@impl.method)
end

#navigation_request? ⇒ Boolean

Whether this request is driving frame’s navigation.

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/playwright_api/request.rb', line 52

def navigation_request?
  wrap_impl(@impl.navigation_request?)
end

#off(event, callback) ⇒ Object

– inherited from EventEmitter –



223
224
225
 
# File 'lib/playwright_api/request.rb', line 223

def off(event, callback)
  event_emitter_proxy.off(event, callback)
end

#on(event, callback) ⇒ Object

– inherited from EventEmitter –



217
218
219
 
# File 'lib/playwright_api/request.rb', line 217

def on(event, callback)
  event_emitter_proxy.on(event, callback)
end

#once(event, callback) ⇒ Object

– inherited from EventEmitter –



211
212
213
 
# File 'lib/playwright_api/request.rb', line 211

def once(event, callback)
  event_emitter_proxy.once(event, callback)
end

#post_data ⇒ Object

Request’s post body, if any.



62
63
64
 
# File 'lib/playwright_api/request.rb', line 62

def post_data
  wrap_impl(@impl.post_data)
end

#post_data_buffer ⇒ Object

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



67
68
69
 
# File 'lib/playwright_api/request.rb', line 67

def post_data_buffer
  wrap_impl(@impl.post_data_buffer)
end

#post_data_json ⇒ Object

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.



75
76
77
 
# File 'lib/playwright_api/request.rb', line 75

def post_data_json
  wrap_impl(@impl.post_data_json)
end

#redirected_from ⇒ Object

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 ‘example.com` redirects to `example.com`:

“‘js const response = await page.goto(’example.com’); console.log(response.request().redirectedFrom().url()); // ‘example.com’ “‘

“‘java Response response = page.navigate(“example.com”); System.out.println(response.request().redirectedFrom().url()); // “example.com” “`

“‘python async response = await page.goto(“example.com”) print(response.request.redirected_from.url) # “example.com” “`

“‘python sync response = page.goto(“example.com”) print(response.request.redirected_from.url) # “example.com” “`

If the website ‘google.com` has no redirects:

“‘js const response = await page.goto(’google.com’); console.log(response.request().redirectedFrom()); // null “‘

“‘java Response response = page.navigate(“google.com”); System.out.println(response.request().redirectedFrom()); // null “`

“‘python async response = await page.goto(“google.com”) print(response.request.redirected_from) # None “`

“‘python sync response = page.goto(“google.com”) print(response.request.redirected_from) # None “`



130
131
132
 
# File 'lib/playwright_api/request.rb', line 130

def redirected_from
  wrap_impl(@impl.redirected_from)
end

#redirected_to ⇒ Object

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

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

“‘js console.log(request.redirectedFrom().redirectedTo() === request); // true “`

“‘java System.out.println(request.redirectedFrom().redirectedTo() == request); // true “`

“‘py assert request.redirected_from.redirected_to == request “`



150
151
152
 
# File 'lib/playwright_api/request.rb', line 150

def redirected_to
  wrap_impl(@impl.redirected_to)
end

#resource_type ⇒ Object

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`.



157
158
159
 
# File 'lib/playwright_api/request.rb', line 157

def resource_type
  wrap_impl(@impl.resource_type)
end

#response ⇒ Object

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



162
163
164
 
# File 'lib/playwright_api/request.rb', line 162

def response
  wrap_impl(@impl.response)
end

#timing ⇒ Object

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](developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).

“‘js const [request] = await Promise.all([

page.waitForEvent('requestfinished'),
page.goto('http://example.com')

]); console.log(request.timing()); “‘

“‘java page.onRequestFinished(request -> 

Timing timing = request.timing();
System.out.println(timing.responseEnd - timing.startTime);

); page.navigate(“example.com”); “‘

“‘python async async with page.expect_event(“requestfinished”) as request_info:

await page.goto("http://example.com")

request = await request_info.value print(request.timing) “‘

“‘python sync with page.expect_event(“requestfinished”) as request_info:

page.goto("http://example.com")

request = request_info.value print(request.timing) “‘



200
201
202
 
# File 'lib/playwright_api/request.rb', line 200

def timing
  wrap_impl(@impl.timing)
end

#url ⇒ Object

URL of the request.



205
206
207
 
# File 'lib/playwright_api/request.rb', line 205

def url
  wrap_impl(@impl.url)
end