discourse/plugins/chat/spec/system/sidebar_navigation_menu_spec.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

189 lines
5.3 KiB
Ruby
Raw Normal View History

DEV: start glimmer-ification and optimisations of chat plugin (#19531) Note this is a very large PR, and some of it could have been splited, but keeping it one chunk made it to merge conflicts and to revert if necessary. Actual new code logic is also not that much, as most of the changes are removing js tests, adding system specs or moving things around. To make it possible this commit is doing the following changes: - converting (and adding new) existing js acceptances tests into system tests. This change was necessary to ensure as little regressions as possible while changing paradigm - moving away from store. Using glimmer and tracked properties requires to have class objects everywhere and as a result works well with models. However store/adapters are suffering from many bugs and limitations. As a workaround the `chat-api` and `chat-channels-manager` are an answer to this problem by encapsulating backend calls and frontend storage logic; while still using js models. - dropping `appEvents` as much as possible. Using tracked properties and a better local storage of channel models, allows to be much more reactive and doesn’t require arbitrary manual updates everywhere in the app. - while working on replacing store, the existing work of a chat api (backend) has been continued to support more cases. - removing code from the `chat` service to separate concerns, `chat-subscriptions-manager` and `chat-channels-manager`, being the largest examples of where the code has been rewritten/moved. Future wok: - improve behavior when closing/deleting a channel, it's already slightly buggy on live, it's rare enough that it's not a big issue, but should be improved - improve page objects used in chat - move more endpoints to the API - finish temporarily skipped tests - extract more code from the `chat` service - use glimmer for `chat-messages` - separate concerns in `chat-live-pane` - eventually add js tests for `chat-api`, `chat-channels-manager` and `chat-subscriptions-manager`, they are indirectly heavy tested through system tests but it would be nice to at least test the public API <!-- NOTE: All pull requests should have tests (rspec in Ruby, qunit in JavaScript). If your code does not include test coverage, please include an explanation of why it was omitted. -->
2022-12-21 20:21:02 +08:00
# frozen_string_literal: true
RSpec.describe "Sidebar navigation menu", type: :system, js: true do
fab!(:current_user) { Fabricate(:user) }
before do
SiteSetting.navigation_menu = "sidebar"
chat_system_bootstrap
sign_in(current_user)
end
context "when displaying the public channels section" do
fab!(:channel_1) { Fabricate(:chat_channel) }
before { channel_1.add(current_user) }
it "displays correct channels section title" do
visit("/")
expect(page).to have_css(
".sidebar-section-chat-channels .sidebar-section-header-text",
text: I18n.t("js.chat.chat_channels"),
)
end
it "displays the correct hash icon prefix" do
visit("/")
expect(page).to have_css(
".sidebar-section-chat-channels .sidebar-section-link-#{channel_1.slug} .sidebar-section-link-prefix svg.prefix-icon.d-icon-hashtag",
)
end
it "channel link has the correct href" do
visit("/")
expect(page).to have_link(
channel_1.name,
href: "/chat/channel/#{channel_1.id}/#{channel_1.slug}",
)
end
context "when the category is private" do
fab!(:group_1) { Fabricate(:group) }
fab!(:private_channel_1) { Fabricate(:private_category_channel, group: group_1) }
before do
group_1.add(current_user)
private_channel_1.add(current_user)
end
it "has a lock badge" do
visit("/")
expect(page).to have_css(
".sidebar-section-chat-channels .sidebar-section-link-#{private_channel_1.slug} .sidebar-section-link-prefix svg.prefix-badge.d-icon-lock",
)
end
end
context "when the channel has an emoji in the title" do
fab!(:channel_1) { Fabricate(:chat_channel, name: "test :heart:") }
before { channel_1.add(current_user) }
it "unescapes the emoji" do
visit("/")
expect(page).to have_css(
".sidebar-section-chat-channels .sidebar-section-link-#{channel_1.slug} .emoji",
)
end
end
context "when the channel is muted" do
fab!(:channel_2) { Fabricate(:chat_channel) }
before do
Fabricate(
:user_chat_channel_membership,
user: current_user,
chat_channel: channel_2,
muted: true,
)
end
it "has a muted class" do
visit("/")
expect(page).to have_css(
".sidebar-section-chat-channels .sidebar-section-link-#{channel_2.slug}.sidebar-section-link--muted",
)
end
end
context "when channel description contains malicious content" do
before { channel_1.update!(description: "<script>alert('hello')</script>") }
it "escapes the title attribute using it" do
visit("/")
expect(
page.find(".sidebar-section-chat-channels .sidebar-section-link-#{channel_1.slug}")[
"title"
],
).to eq("&lt;script&gt;alert(&#x27;hello&#x27;)&lt;/script&gt;")
end
end
end
context "when displaying the direct message channels section" do
context "when the channel has two participants" do
fab!(:other_user) { Fabricate(:user) }
fab!(:dm_channel_1) { Fabricate(:direct_message_channel, users: [current_user, other_user]) }
it "displays other user avatar in prefix when two participants" do
visit("/")
expect(
page.find(
".sidebar-section-chat-dms a.sidebar-section-link:nth-child(1) .sidebar-section-link-prefix img",
)[
"src"
],
).to include(other_user.username)
end
it "displays other user username as link text" do
visit("/")
expect(
page.find(".sidebar-section-chat-dms a.sidebar-section-link:nth-child(1)"),
).to have_content(other_user.username)
end
context "when other user has status" do
before do
SiteSetting.enable_user_status = true
other_user.set_status!("online", "heart")
end
it "displays the status" do
visit("/")
expect(
page.find(".sidebar-section-chat-dms a.sidebar-section-link:nth-child(1)"),
).to have_css(".user-status")
end
end
end
context "when channel has more than 2 participants" do
fab!(:user_1) { Fabricate(:user) }
fab!(:user_2) { Fabricate(:user) }
fab!(:dm_channel_1) do
Fabricate(:direct_message_channel, users: [current_user, user_1, user_2])
end
it "displays all participants names" do
visit("/")
DEV: start glimmer-ification and optimisations of chat plugin (#19531) Note this is a very large PR, and some of it could have been splited, but keeping it one chunk made it to merge conflicts and to revert if necessary. Actual new code logic is also not that much, as most of the changes are removing js tests, adding system specs or moving things around. To make it possible this commit is doing the following changes: - converting (and adding new) existing js acceptances tests into system tests. This change was necessary to ensure as little regressions as possible while changing paradigm - moving away from store. Using glimmer and tracked properties requires to have class objects everywhere and as a result works well with models. However store/adapters are suffering from many bugs and limitations. As a workaround the `chat-api` and `chat-channels-manager` are an answer to this problem by encapsulating backend calls and frontend storage logic; while still using js models. - dropping `appEvents` as much as possible. Using tracked properties and a better local storage of channel models, allows to be much more reactive and doesn’t require arbitrary manual updates everywhere in the app. - while working on replacing store, the existing work of a chat api (backend) has been continued to support more cases. - removing code from the `chat` service to separate concerns, `chat-subscriptions-manager` and `chat-channels-manager`, being the largest examples of where the code has been rewritten/moved. Future wok: - improve behavior when closing/deleting a channel, it's already slightly buggy on live, it's rare enough that it's not a big issue, but should be improved - improve page objects used in chat - move more endpoints to the API - finish temporarily skipped tests - extract more code from the `chat` service - use glimmer for `chat-messages` - separate concerns in `chat-live-pane` - eventually add js tests for `chat-api`, `chat-channels-manager` and `chat-subscriptions-manager`, they are indirectly heavy tested through system tests but it would be nice to at least test the public API <!-- NOTE: All pull requests should have tests (rspec in Ruby, qunit in JavaScript). If your code does not include test coverage, please include an explanation of why it was omitted. -->
2022-12-21 20:21:02 +08:00
expect(
page.find(
".sidebar-section-chat-dms a.sidebar-section-link:nth-child(1) .sidebar-section-link-content-text",
),
).to have_content("#{user_1.username}, #{user_2.username}")
end
end
context "when username contains malicious content" do
fab!(:other_user) { Fabricate(:user) }
fab!(:dm_channel_1) { Fabricate(:direct_message_channel, users: [current_user, other_user]) }
before do
other_user.username = "<script>alert('hello')</script>"
other_user.save!(validate: false)
end
it "escapes the title attribute using it" do
visit("/")
expect(page.find(".sidebar-section-chat-dms .channel-#{dm_channel_1.id}")["title"]).to eq(
"Chat with @&lt;script&gt;alert(&#x27;hello&#x27;)&lt;/script&gt;",
)
end
end
end
end