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

258 lines
8.3 KiB
Ruby
Vendored
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# frozen_string_literal: true
RSpec.describe "Visit channel", type: :system do
fab!(:category)
fab!(:topic)
fab!(:post) { Fabricate(:post, topic: topic) }
fab!(:current_user) { Fabricate(:user) }
fab!(:category_channel_1) { Fabricate(:category_channel) }
fab!(:private_category_channel_1) { Fabricate(:private_category_channel) }
fab!(:dm_channel_1) { Fabricate(:direct_message_channel, users: [current_user]) }
fab!(:inaccessible_dm_channel_1) { Fabricate(:direct_message_channel) }
let(:chat) { PageObjects::Pages::Chat.new }
let(:sidebar_page) { PageObjects::Pages::Sidebar.new }
let(:channel_page) { PageObjects::Pages::ChatChannel.new }
let(:dialog) { PageObjects::Components::Dialog.new }
before { chat_system_bootstrap }
context "when chat disabled" do
before do
SiteSetting.chat_enabled = false
sign_in(current_user)
end
it "shows a not found page" do
visit("/chat/c/-/#{category_channel_1.id}")
expect(page).to have_content(I18n.t("page_not_found.title"))
end
end
context "when chat enabled" do
context "when anonymous" do
it "redirects to homepage" do
visit("/chat/c/-/#{category_channel_1.id}")
expect(page).to have_current_path("/latest")
end
end
context "when regular user" do
before { sign_in(current_user) }
context "when chat is disabled" do
before { current_user.user_option.update!(chat_enabled: false) }
it "redirects to homepage" do
visit("/chat/c/-/#{category_channel_1.id}")
expect(page).to have_current_path("/latest")
end
end
context "when current user is not allowed to chat" do
before { SiteSetting.chat_allowed_groups = Group::AUTO_GROUPS[:staff] }
it "redirects homepage" do
visit("/chat/c/-/#{category_channel_1.id}")
expect(page).to have_current_path("/latest")
end
end
context "when channel is not found" do
it "shows an error" do
visit("/chat/c/-/999")
expect(page).to have_content("Not Found") # this is not a translated key
end
end
context "when loading a non existing message of a channel" do
it "shows an error" do
visit("/chat/c/-/#{category_channel_1.id}/-999")
expect(page).to have_content(I18n.t("not_found"))
end
end
context "when channel is not accessible" do
context "when category channel" do
it "shows an error" do
visit("/chat/c/-/#{private_category_channel_1.id}")
expect(page).to have_content(I18n.t("invalid_access"))
end
end
context "when direct message channel" do
it "shows an error" do
visit("/chat/c/-/#{inaccessible_dm_channel_1.id}")
expect(page).to have_content(I18n.t("invalid_access"))
end
end
end
context "when category channel is read-only" do
fab!(:restricted_category) { Fabricate(:category, read_restricted: true) }
fab!(:readonly_group_1) { Fabricate(:group, users: [current_user]) }
fab!(:readonly_category_channel_1) do
Fabricate(:category_channel, chatable: restricted_category)
end
fab!(:message_1) { Fabricate(:chat_message, chat_channel: readonly_category_channel_1) }
before do
Fabricate(
:category_group,
category: restricted_category,
group: readonly_group_1,
permission_type: CategoryGroup.permission_types[:readonly],
)
end
it "shows an error" do
chat.visit_channel(readonly_category_channel_1)
expect(page).to have_content(I18n.t("invalid_access"))
end
end
context "when current user is not member of the channel" do
context "when category channel" do
fab!(:message_1) { Fabricate(:chat_message, chat_channel: category_channel_1) }
it "allows to join it" do
chat.visit_channel(category_channel_1)
expect(page).to have_content(I18n.t("js.chat.channel_settings.join_channel"))
end
it "shows a preview of the channel" do
chat.visit_channel(category_channel_1)
expect(page).to have_content(category_channel_1.name)
expect(channel_page.messages).to have_message(id: message_1.id)
end
context "with a thread" do
fab!(:thread) do
Fabricate(
:chat_thread,
channel: category_channel_1,
original_message: message_1,
with_replies: 1,
)
end
before { category_channel_1.update(threading_enabled: true) }
it "allows to join it" do
chat.visit_thread(thread)
expect(page).to have_content(
I18n.t("js.chat.channel_settings.join_channel"),
count: 2,
)
end
end
end
context "when direct message channel" do
fab!(:message_1) { Fabricate(:chat_message, chat_channel: dm_channel_1) }
before { dm_channel_1.membership_for(current_user).destroy! }
it "allows to join it" do
chat.visit_channel(dm_channel_1)
expect(channel_page.composer).to be_enabled
end
end
end
context "when current user is member of the channel" do
context "when category channel" do
fab!(:message_1) { Fabricate(:chat_message, chat_channel: category_channel_1) }
before { category_channel_1.add(current_user) }
it "doesnt ask to join it" do
chat.visit_channel(category_channel_1)
expect(page).to have_no_content(I18n.t("js.chat.channel_settings.join_channel"))
end
it "shows a preview of the channel" do
chat.visit_channel(category_channel_1)
expect(page).to have_content(category_channel_1.name)
expect(channel_page.messages).to have_message(id: message_1.id)
end
context "when URL doesnt contain slug" do
it "redirects to correct URL" do
visit("/chat/c/-/#{category_channel_1.id}")
expect(page).to have_current_path(
"/chat/c/#{category_channel_1.slug}/#{category_channel_1.id}",
)
end
end
context "when visiting a specific channel message ID then navigating to another channel" do
fab!(:early_message) { Fabricate(:chat_message, chat_channel: category_channel_1) }
fab!(:other_channel) do
Fabricate(:category_channel, chatable: category_channel_1.chatable)
end
fab!(:other_channel_message) { Fabricate(:chat_message, chat_channel: other_channel) }
before do
30.times { Fabricate(:chat_message, chat_channel: category_channel_1) }
other_channel.add(current_user)
end
it "does not error" do
visit(early_message.url)
expect(channel_page).to have_no_loading_skeleton
expect(channel_page.messages).to have_message(id: early_message.id)
sidebar_page.open_channel(other_channel)
expect(dialog).to be_closed
expect(channel_page.messages).to have_message(id: other_channel_message.id)
end
end
end
context "when direct message channel" do
fab!(:message_1) do
Fabricate(:chat_message, chat_channel: dm_channel_1, user: current_user)
end
it "doesnt ask to join it" do
chat.visit_channel(dm_channel_1)
expect(page).to have_no_content(I18n.t("js.chat.channel_settings.join_channel"))
end
it "shows a preview of the channel" do
chat.visit_channel(dm_channel_1)
expect(channel_page.messages).to have_message(id: message_1.id)
end
context "when URL doesnt contain slug" do
it "redirects to correct URL" do
visit("/chat/c/-/#{dm_channel_1.id}")
expect(page).to have_current_path(
"/chat/c/#{Slug.for(dm_channel_1.title(current_user))}/#{dm_channel_1.id}",
)
end
end
end
end
end
end
end