discourse/plugins/chat/spec/system/shortcuts/sidebar_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

203 lines
6.8 KiB
Ruby
Vendored

# frozen_string_literal: true
RSpec.describe "Shortcuts | sidebar", type: :system do
fab!(:current_user) { Fabricate(:admin) }
let(:chat) { PageObjects::Pages::Chat.new }
let(:sidebar_page) { PageObjects::Pages::Sidebar.new }
before do
SiteSetting.navigation_menu = "sidebar"
chat_system_bootstrap
sign_in(current_user)
end
context "when using Alt+Up/Down arrows" do
fab!(:channel_1) { Fabricate(:chat_channel) }
fab!(:dm_channel_1) { Fabricate(:direct_message_channel, users: [current_user]) }
before { channel_1.add(current_user) }
context "when on homepage" do
it "does nothing" do
visit("/")
find("body").send_keys(%i[alt down])
expect(sidebar_page).to have_no_active_channel(channel_1)
expect(sidebar_page).to have_no_active_channel(dm_channel_1)
end
end
context "when on chat page" do
it "navigates through the channels" do
chat.visit_channel(channel_1)
expect(sidebar_page).to have_active_channel(channel_1)
find("body").send_keys(%i[alt down])
expect(sidebar_page).to have_active_channel(dm_channel_1)
find("body").send_keys(%i[alt down])
expect(sidebar_page).to have_active_channel(channel_1)
find("body").send_keys(%i[alt up])
expect(sidebar_page).to have_active_channel(dm_channel_1)
end
end
end
context "when using Alt+Shift+Up/Down arrows" do
fab!(:channel_1) { Fabricate(:chat_channel, name: "Channel 1") }
fab!(:channel_2) { Fabricate(:chat_channel, name: "Channel 2") }
fab!(:channel_3) { Fabricate(:chat_channel, name: "Channel 3") }
fab!(:channel_4) { Fabricate(:chat_channel, name: "Channel 4") }
fab!(:dm_channel_1) { Fabricate(:direct_message_channel, users: [current_user]) }
fab!(:other_user) { Fabricate(:user) }
fab!(:dm_channel_2) { Fabricate(:direct_message_channel, users: [current_user, other_user]) }
before do
channel_1.add(current_user)
channel_2.add(current_user)
channel_3.add(current_user)
channel_4.add(current_user)
end
context "when on homepage" do
it "does nothing" do
visit("/")
find("body").send_keys(%i[alt shift down])
expect(sidebar_page).to have_no_active_channel(channel_1)
expect(sidebar_page).to have_no_active_channel(channel_2)
expect(sidebar_page).to have_no_active_channel(dm_channel_1)
expect(sidebar_page).to have_no_active_channel(dm_channel_2)
end
end
context "when on chat page" do
it "does nothing when no channels have activity" do
chat.visit_channel(channel_1)
expect(sidebar_page).to have_active_channel(channel_1)
find("body").send_keys(%i[alt shift down])
expect(sidebar_page).to have_active_channel(channel_1)
find("body").send_keys(%i[alt shift down])
expect(sidebar_page).to have_active_channel(channel_1)
find("body").send_keys(%i[alt shift up])
expect(sidebar_page).to have_active_channel(channel_1)
end
it "navigates through the channels with activity" do
chat.visit_channel(channel_1)
expect(sidebar_page).to have_active_channel(channel_1)
Fabricate(:chat_message, chat_channel: channel_2, message: "hello!", use_service: true)
expect(sidebar_page).to have_unread_channel(channel_2)
Fabricate(
:chat_message,
chat_channel: dm_channel_2,
message: "hello here!",
use_service: true,
)
expect(sidebar_page).to have_unread_channel(dm_channel_2)
find("body").send_keys(%i[alt shift down])
expect(sidebar_page).to have_active_channel(channel_2)
expect(sidebar_page).to have_no_unread_channel(channel_2)
find("body").send_keys(%i[alt shift down])
expect(sidebar_page).to have_active_channel(dm_channel_2)
expect(sidebar_page).to have_no_unread_channel(dm_channel_2)
Fabricate(
:chat_message,
chat_channel: channel_1,
message: "hello again!",
use_service: true,
)
expect(sidebar_page).to have_unread_channel(channel_1)
find("body").send_keys(%i[alt shift up])
expect(sidebar_page).to have_active_channel(channel_1)
expect(sidebar_page).to have_no_unread_channel(channel_1)
Fabricate(:chat_message, chat_channel: dm_channel_1, message: "bye now!", use_service: true)
expect(sidebar_page).to have_unread_channel(dm_channel_1)
find("body").send_keys(%i[alt shift up])
expect(sidebar_page).to have_active_channel(dm_channel_1)
expect(sidebar_page).to have_no_unread_channel(dm_channel_1)
end
it "remembers where the current channel is, even if that channel is unread" do
chat.visit_channel(channel_3)
expect(sidebar_page).to have_active_channel(channel_3)
Fabricate(:chat_message, chat_channel: channel_2, message: "hello!", use_service: true)
expect(sidebar_page).to have_unread_channel(channel_2)
Fabricate(:chat_message, chat_channel: channel_4, message: "yes, hello!", use_service: true)
expect(sidebar_page).to have_unread_channel(channel_4)
find("body").send_keys(%i[alt shift down])
expect(sidebar_page).to have_active_channel(channel_4)
expect(sidebar_page).to have_no_unread_channel(channel_4)
Fabricate(
:chat_message,
chat_channel: channel_3,
message: "hello, here, too!",
use_service: true,
)
expect(sidebar_page).to have_unread_channel(channel_3)
find("body").send_keys(%i[alt shift up])
expect(sidebar_page).to have_active_channel(channel_3)
expect(sidebar_page).to have_no_unread_channel(channel_3)
Fabricate(
:chat_message,
chat_channel: channel_4,
message: "okay, byebye!",
use_service: true,
)
expect(sidebar_page).to have_unread_channel(channel_4)
find("body").send_keys(%i[alt shift up])
expect(sidebar_page).to have_active_channel(channel_2)
expect(sidebar_page).to have_no_unread_channel(channel_2)
end
it "handles the shortcut being pressed quickly" do
chat.visit_channel(channel_2)
expect(sidebar_page).to have_active_channel(channel_2)
Fabricate(:chat_message, chat_channel: channel_1, message: "hello!", use_service: true)
expect(sidebar_page).to have_unread_channel(channel_1)
Fabricate(:chat_message, chat_channel: channel_4, message: "howdy!", use_service: true)
expect(sidebar_page).to have_unread_channel(channel_4)
find("body").send_keys(%i[alt shift up])
find("body").send_keys(%i[alt shift down])
expect(sidebar_page).to have_active_channel(channel_4)
end
end
end
end