Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## [Unreleased](https://github.com/rubycdp/cuprite/compare/v0.20.1...main) ##

### Added
- `browser.go_to` takes the keywords of Ferrum's `go_to`, like `referrer:` and `timeout:`, it accepted only the URL
- `:url_blocklist` and `:url_allowlist` driver options as aliases for `:url_blacklist` and `:url_whitelist` [#330]

### Changed
Expand Down
7 changes: 4 additions & 3 deletions docs/11-headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ headers.add({ "Accept-Language" => "de" })
headers.get # => { "User-Agent" => "Cuprite", "Accept-Language" => "de" }
```

`set` overwrites already set headers, `add` merges into them. With
`permanent: false` a `Referer` header is applied to the next navigation only:
`set` overwrites already set headers, `add` merges into them. A `Referer`
header is sent with every request, for the referrer of one navigation only pass
it to `go_to`:

```ruby
page.driver.browser.headers.add({ "Referer" => "https://example.com" }, permanent: false)
page.driver.browser.go_to("/landing", referrer: "https://example.com")
```
8 changes: 7 additions & 1 deletion lib/capybara/cuprite/page.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,13 @@ class Page < Ferrum::Page
include Frames
include Modals

def go_to(url = nil)
# Navigates the page to a URL, see `Ferrum::Page#go_to`.
#
# @param url [String, nil]
# @param options [Hash] the keywords of `Ferrum::Page#go_to`, like `referrer:` and `timeout:`
# @return [String, nil] the navigated frame's id
# @raise [PendingConnectionsError] with `pending_connection_errors` when the page doesn't load in time
def go_to(url = nil, **options)
frame_id = super
return frame_id if frame_id || !@options.raise_on_pending_connections

Expand Down
78 changes: 0 additions & 78 deletions spec/driver_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -1122,84 +1122,6 @@ def no_matches_message(description)

popup.close
end

context "with headers", skip: true do
it "persists headers across popup windows" do
@driver.browser.headers.set(
"Cookie" => "foo=bar",
"Host" => "foo.com",
"User-Agent" => "foo"
)
@session.visit("/cuprite/popup_headers")
@session.click_link "pop up"
@session.switch_to_window @session.windows.last
expect(@driver.html).to include("USER_AGENT: foo")
expect(@driver.html).to include("COOKIE: foo=bar")
expect(@driver.html).to include("HOST: foo.com")
end

it "sets headers in existing windows" do
@session.open_new_window
@driver.browser.headers.set(
"Cookie" => "foo=bar",
"Host" => "foo.com",
"User-Agent" => "foo"
)
@session.visit("/cuprite/headers")
expect(@driver.html).to include("USER_AGENT: foo")
expect(@driver.html).to include("COOKIE: foo=bar")
expect(@driver.html).to include("HOST: foo.com")

@session.switch_to_window @session.windows.last
@session.visit("/cuprite/headers")
expect(@driver.html).to include("USER_AGENT: foo")
expect(@driver.html).to include("COOKIE: foo=bar")
expect(@driver.html).to include("HOST: foo.com")
end

it "keeps temporary headers local to the current window" do
@session.open_new_window
@driver.browser.headers.add({ "X-Custom-Header" => "1" }, permanent: false)

@session.switch_to_window @session.windows.last
@session.visit("/cuprite/headers")
expect(@driver.html).not_to include("X_CUSTOM_HEADER: 1")

@session.switch_to_window @session.windows.first
@session.visit("/cuprite/headers")
expect(@driver.html).to include("X_CUSTOM_HEADER: 1")
end

it "does not mix temporary headers with permanent ones when propagating to other windows" do
@session.open_new_window
@driver.browser.headers.add({ "X-Custom-Header" => "1" }, permanent: false)
@driver.browser.headers.add({ "Host" => "foo.com" })

@session.switch_to_window @session.windows.last
@session.visit("/cuprite/headers")
expect(@driver.html).to include("HOST: foo.com")
expect(@driver.html).not_to include("X_CUSTOM_HEADER: 1")

@session.switch_to_window @session.windows.first
@session.visit("/cuprite/headers")
expect(@driver.html).to include("HOST: foo.com")
expect(@driver.html).to include("X_CUSTOM_HEADER: 1")
end

it "does not propagate temporary headers to new windows" do
@session.visit "/"
@driver.browser.headers.add({ "X-Custom-Header" => "1" }, permanent: false)
@session.open_new_window

@session.switch_to_window @session.windows.last
@session.visit("/cuprite/headers")
expect(@driver.html).not_to include("X_CUSTOM_HEADER: 1")

@session.switch_to_window @session.windows.first
@session.visit("/cuprite/headers")
expect(@driver.html).to include("X_CUSTOM_HEADER: 1")
end
end
end

describe "#switch_to_frame" do
Expand Down
24 changes: 24 additions & 0 deletions spec/page_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# frozen_string_literal: true

describe Capybara::Cuprite::Page do
around do |example|
@session = TestSessions::Cuprite
@driver = @session.driver
example.run
ensure
@driver.reset!
end

def session_url(path)
server = @session.server
"http://#{server.host}:#{server.port}#{path}"
end

describe "#go_to" do
it "passes the referrer to the navigation" do
@driver.browser.go_to(session_url("/cuprite/headers"), referrer: "http://example.com/")

expect(@driver.html).to include("REFERER: http://example.com/")
end
end
end
1 change: 0 additions & 1 deletion spec/support/views/popup_headers.erb

This file was deleted.

Loading