discourse/spec/system/dev_tools_spec.rb
Joffrey JAFFEUX b6aad28ccf
DEV: replace selenium driver with playwright (#31977)
This commit is replacing the system specs driver (selenium) by
Playwright: https://playwright.dev/

We are still using Capybara to write the specs but they will now be run
by Playwright. To achieve this we are using the non official ruby
driver: https://github.com/YusukeIwaki/capybara-playwright-driver

### Notable changes

- `CHROME_DEV_TOOLS` has been removed, it's not working well with
playwright use `pause_test` and inspect browser for now.

- `fill_in` is not generating key events in playwright, use `send_keys`
if you need this.

### New spec options

#### trace

Allows to capture a trace in a zip file which you can load at
https://trace.playwright.dev or locally through `npx playwright
show-trace /path/to/trace.zip`

_Example usage:_

```ruby
it "shows bar", trace: true do
  visit("/")

  find(".foo").click

  expect(page).to have_css(".bar")
end
```

#### video

Allows to capture a video of your spec.

_Example usage:_

```ruby
it "shows bar", video: true do
  visit("/")

  find(".foo").click

  expect(page).to have_css(".bar")
end
```

### New env variable

#### PLAYWRIGHT_SLOW_MO_MS

Allow to force playwright to wait DURATION (in ms) at each action.

_Example usage:_

```
PLAYWRIGHT_SLOW_MO_MS=1000 rspec foo_spec.rb
```

#### PLAYWRIGHT_HEADLESS

Allow to be in headless mode or not. Default will be headless.

_Example usage:_

```
PLAYWRIGHT_HEADLESS=0 rspec foo_spec.rb # will show the browser
```

### New helpers

#### with_logs

Allows to access the browser logs and check if something specific has
been logged.

_Example usage:_

```ruby
with_logs do |logger|
  # do something

  expect(logger.logs.map { |log| log[:message] }).to include("foo")
end
```

#### add_cookie

Allows to add a cookie on the browser session.

_Example usage:_

```ruby
add_cookie(name: "destination_url", value: "/new")
```

#### get_style

Get the property style value of an element.

_Example usage:_

```ruby
expect(get_style(find(".foo"), "height")).to eq("200px")
```

#### get_rgb_color

Get the rgb color of an element.

_Example usage:_

```ruby
expect(get_rgb_color(find("html"), "backgroundColor")).to eq("rgb(170, 51, 159)")
```
2025-05-06 10:44:14 +02:00

42 lines
1.5 KiB
Ruby

# frozen_string_literal: true
describe "Discourse dev tools", type: :system do
it "works" do
# Open site and check it loads successfully, with no dev-tools
visit("/latest")
expect(page).to have_css("#site-logo")
expect(page).not_to have_css(".dev-tools-toolbar")
# Enable dev tools, and wait for page to reload
page.driver.with_playwright_page { |pw_page| pw_page.evaluate("window.enableDevTools()") }
expect(page).to have_css(".dev-tools-toolbar")
# Turn on plugin outlet debugging, and check they appear
find(".dev-tools-toolbar .toggle-plugin-outlets").click
expect(page).to have_css(".plugin-outlet-info", minimum: 10)
# Open a tooltip
find(".plugin-outlet-info[data-outlet-name=home-logo-contents__before]").hover
expect(page).to have_css(".plugin-outlet-info__wrapper")
# Check the outletArgs are shown
expect(page).to have_css(".plugin-outlet-info__wrapper .key", text: "title")
expect(page).to have_css(
".plugin-outlet-info__wrapper .value",
text: "\"#{SiteSetting.title}\"",
)
# Turn off plugin outlet debugging, and check they disappeared
find(".dev-tools-toolbar .toggle-plugin-outlets").click
expect(page).not_to have_css(".plugin-outlet-info")
# Disable dev tools
find(".dev-tools-toolbar .disable-dev-tools").click
# Check reloaded successfully
expect(page).not_to have_css(".dev-tools-toolbar")
expect(page).to have_css("#site-logo")
expect(page).not_to have_css(".dev-tools-toolbar")
end
end