discourse/spec/system/page_objects/components/topic_list.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

104 lines
2.9 KiB
Ruby

# frozen_string_literal: true
module PageObjects
module Components
class TopicList < PageObjects::Components::Base
TOPIC_LIST_BODY_SELECTOR = ".topic-list-body"
TOPIC_LIST_ITEM_SELECTOR = "#{TOPIC_LIST_BODY_SELECTOR} .topic-list-item"
def topic_list
TOPIC_LIST_BODY_SELECTOR
end
def has_topics?(count: nil)
if count.nil?
page.has_css?(TOPIC_LIST_ITEM_SELECTOR)
else
page.has_css?(TOPIC_LIST_ITEM_SELECTOR, count: count)
end
end
def has_no_topics?
page.has_no_css?(TOPIC_LIST_ITEM_SELECTOR)
end
def has_topic?(topic)
page.has_css?(topic_list_item_class(topic))
end
def has_no_topic?(topic)
page.has_no_css?(topic_list_item_class(topic))
end
def has_highlighted_topic?(topic)
page.has_css?("#{topic_list_item_class(topic)}[data-test-was-highlighted]")
end
def has_topic_checkbox?(topic)
page.has_css?("#{topic_list_item_class(topic)} input#bulk-select-#{topic.id}")
end
def has_closed_status?(topic)
page.has_css?("#{topic_list_item_closed(topic)}")
end
def has_unread_badge?(topic)
page.has_css?("#{topic_list_item_unread_badge(topic)}")
end
def has_no_unread_badge?(topic)
page.has_no_css?("#{topic_list_item_unread_badge(topic)}")
end
def has_checkbox_selected_on_row?(n)
page.has_css?("#{TOPIC_LIST_ITEM_SELECTOR}:nth-child(#{n}) input.bulk-select:checked")
end
def has_no_checkbox_selected_on_row?(n)
page.has_no_css?("#{TOPIC_LIST_ITEM_SELECTOR}:nth-child(#{n}) input.bulk-select:checked")
end
def click_topic_checkbox(topic)
find("#{topic_list_item_class(topic)} input#bulk-select-#{topic.id}").click
end
def visit_topic_with_title(title)
find("#{TOPIC_LIST_BODY_SELECTOR} a", text: title).click
end
def visit_topic(topic)
find("#{topic_list_item_class(topic)} a.raw-topic-link").click
end
def visit_topic_last_reply_via_keyboard(topic)
find("#{topic_list_item_class(topic)} a.post-activity").send_keys(:return)
end
def visit_topic_first_reply_via_keyboard(topic)
find("#{topic_list_item_class(topic)} a.badge-posts").send_keys(:return)
end
def topic_list_item_class(topic)
"#{TOPIC_LIST_ITEM_SELECTOR}[data-topic-id='#{topic.id}']"
end
def had_new_topics_alert?
page.has_css?(".show-more.has-topics")
end
def click_new_topics_alert
find(".show-more.has-topics").click
end
private
def topic_list_item_closed(topic)
"#{topic_list_item_class(topic)} .topic-statuses .topic-status svg.d-icon-lock"
end
def topic_list_item_unread_badge(topic)
"#{topic_list_item_class(topic)} .topic-post-badges .unread-posts"
end
end
end
end