discourse/plugins/chat/spec/system/single_thread_spec.rb
Alan Guo Xiang Tan 6e9fbb5bab
DEV: Do not process requests initiated by browser in a different example (#25809)
Why this change?

We noticed that running `LOAD_PLUGINS=1 rspec --seed=38855 plugins/chat/spec/system/chat_new_message_spec.rb` locally
results in the system tests randomly failing. When we inspected the
request logs closely, we noticed that a `/presence/get` request from a
previous rspec example was being processed when a new rspec example is
already being run. We know it was from the previous rspec example
because inspecting the auth token showed the request using the auth
token of a user from the previous example. However, when a request using
an auth token from a previous example is used it ends up logging out the
same user on the server side because the user id in the cookie is the same
due to the use of `fab!`.

I did some research and there is apparently no way to wait until all
inflight requests by the browser has completed through capybara or
selenium. Therefore, we will add an identifier by attaching a cookie to all non-xhr requests so that
xhr requests which are triggered subsequently will contain the cookie in the request.

In the `BlockRequestsMiddleware` middleware, we will then reject any
requests when the value of the identifier in the cookie does not match the current rspec's example
location.

To see the problem locally, change `Auth::DefaultCurrentUserProvider.find_v1_auth_cookie` to the following:

```
  def self.find_v1_auth_cookie(env)
    return env[DECRYPTED_AUTH_COOKIE] if env.key?(DECRYPTED_AUTH_COOKIE)

    env[DECRYPTED_AUTH_COOKIE] = begin
      request = ActionDispatch::Request.new(env)
      cookie = request.cookies[TOKEN_COOKIE]

      # don't even initialize a cookie jar if we don't have a cookie at all
      if cookie&.valid_encoding? && cookie.present?
        puts "#{env["REQUEST_PATH"]} #{request.cookie_jar.encrypted[TOKEN_COOKIE]&.with_indifferent_access}"
        request.cookie_jar.encrypted[TOKEN_COOKIE]&.with_indifferent_access
      end
    end
  end
```

After which run the following command: `LOAD_PLUGINS=1 rspec --format documentation --seed=38855 plugins/chat/spec/system/chat_new_message_spec.rb`

It takes a few tries but the last spec should fail and you should see something like this:

```
assets/chunk.c16f6ba8b6824baa47ac.d41d8cd9.js {"token"=>"37d995a4b65395d3b343ec70fff915b4", "user_id"=>3382, "username"=>"bruce0", "trust_level"=>1, "issued_at"=>1708591735}
/assets/chunk.050148142e1d2dc992dd.d41d8cd9.js {"token"=>"37d995a4b65395d3b343ec70fff915b4", "user_id"=>3382, "username"=>"bruce0", "trust_level"=>1, "issued_at"=>1708591735}
/chat/api/channels/527/messages {"token"=>"37d995a4b65395d3b343ec70fff915b4", "user_id"=>3382, "username"=>"bruce0", "trust_level"=>1, "issued_at"=>1708591735}
/uploads/default/test_0/optimized/1X/_129430568242d1b7f853bb13ebea28b3f6af4e7_2_512x512.png {"token"=>"37d995a4b65395d3b343ec70fff915b4", "user_id"=>3382, "username"=>"bruce0", "trust_level"=>1, "issued_at"=>1708591735}
    redirects to existing chat channel
    redirects to chat channel if recipients param is missing (PENDING: Temporarily skipped with xit)
  with multiple users
/favicon.ico {"token"=>"9a75c114c4d3401509a23d240f0a46d4", "user_id"=>3382, "username"=>"bruce0", "trust_level"=>1, "issued_at"=>1708591736}
/chat/new-message {"token"=>"9a75c114c4d3401509a23d240f0a46d4", "user_id"=>3382, "username"=>"bruce0", "trust_level"=>1, "issued_at"=>1708591736}
/presence/get {"token"=>"37d995a4b65395d3b343ec70fff915b4", "user_id"=>3382, "username"=>"bruce0", "trust_level"=>1, "issued_at"=>1708591735}
 ```
 
 Note how the `/presence/get` request is using a token from the previous example. 

Co-authored-by: David Taylor <david@taylorhq.com>
2024-02-22 19:41:10 +08:00

231 lines
8.0 KiB
Ruby

# frozen_string_literal: true
describe "Single thread in side panel", type: :system do
fab!(:current_user) { Fabricate(:user) }
let(:chat_page) { PageObjects::Pages::Chat.new }
let(:channel_page) { PageObjects::Pages::ChatChannel.new }
let(:side_panel) { PageObjects::Pages::ChatSidePanel.new }
let(:thread_page) { PageObjects::Pages::ChatThread.new }
let(:chat_drawer_page) { PageObjects::Pages::ChatDrawer.new }
let(:sidebar_page) { PageObjects::Pages::Sidebar.new }
before do
chat_system_bootstrap(current_user, [channel])
sign_in(current_user)
end
context "when threading is disabled for the channel" do
fab!(:channel) { Fabricate(:chat_channel) }
before { channel.update!(threading_enabled: false) }
it "does not open the side panel for a single thread" do
thread =
chat_thread_chain_bootstrap(channel: channel, users: [current_user, Fabricate(:user)])
chat_page.visit_channel(channel)
channel_page.hover_message(thread.original_message)
expect(page).not_to have_css(".chat-message-thread-btn")
end
end
context "when threading is enabled for the channel" do
fab!(:user_2) { Fabricate(:user) }
fab!(:channel) { Fabricate(:chat_channel, threading_enabled: true) }
fab!(:thread) { chat_thread_chain_bootstrap(channel: channel, users: [current_user, user_2]) }
context "when in full page" do
context "when switching channel" do
fab!(:channel_2) { Fabricate(:chat_channel, threading_enabled: true) }
before { channel_2.add(current_user) }
it "closes the opened thread" do
chat_page.visit_thread(thread)
expect(side_panel).to have_open_thread(thread)
sidebar_page.open_channel(channel_2)
expect(side_panel).to have_no_open_thread
end
end
context "when closing the thread" do
it "closes it" do
chat_page.visit_thread(thread)
expect(side_panel).to have_open_thread(thread)
thread_page.close
expect(side_panel).to have_no_open_thread
end
end
end
it "opens the single thread in the drawer using the indicator" do
visit("/latest")
chat_page.open_from_header
chat_drawer_page.open_channel(channel)
channel_page.message_thread_indicator(thread.original_message).click
expect(chat_drawer_page).to have_open_thread(thread)
end
it "navigates back to the channel when clicking back button from a thread" do
visit("/latest")
chat_page.open_from_header
chat_drawer_page.open_channel(channel)
channel_page.message_thread_indicator(thread.original_message).click
expect(chat_drawer_page).to have_open_thread(thread)
chat_drawer_page.back
expect(chat_drawer_page).to have_open_channel(channel)
end
it "highlights the message in the channel when clicking original message link" do
chat_page.visit_thread(thread)
find(".chat-message-info__original-message").click
expect(channel_page.messages).to have_message(
id: thread.original_message.id,
highlighted: true,
)
end
it "opens the side panel for a single thread from the indicator" do
chat_page.visit_channel(channel)
channel_page.message_thread_indicator(thread.original_message).click
expect(side_panel).to have_open_thread(thread)
end
describe "sending a message" do
it "shows the message in the thread pane and links it to the correct channel" do
chat_page.visit_channel(channel)
channel_page.message_thread_indicator(thread.original_message).click
expect(side_panel).to have_open_thread(thread)
thread_page.send_message("new thread message")
expect(thread_page.messages).to have_message(
thread_id: thread.id,
text: "new thread message",
)
thread_message = thread.last_message
expect(thread_message.chat_channel_id).to eq(channel.id)
expect(thread_message.thread.channel_id).to eq(channel.id)
end
it "does not echo the message in the channel pane" do
chat_page.visit_channel(channel)
channel_page.message_thread_indicator(thread.original_message).click
expect(side_panel).to have_open_thread(thread)
thread_page.send_message("new thread message")
expect(thread_page.messages).to have_message(
thread_id: thread.id,
text: "new thread message",
)
thread_message = thread.reload.replies.last
expect(channel_page).not_to have_css(channel_page.message_by_id_selector(thread_message.id))
end
it "changes the tracking bell to be Tracking level in the thread panel" do
new_thread = Fabricate(:chat_thread, channel: channel, with_replies: 1, use_service: true)
chat_page.visit_channel(channel)
channel_page.message_thread_indicator(new_thread.original_message).click
expect(side_panel).to have_open_thread(new_thread)
expect(thread_page).to have_notification_level("normal")
thread_page.send_message("new thread message")
expect(thread_page).to have_notification_level("tracking")
end
it "handles updates from multiple users sending messages in the thread" do
using_session(:tab_1) do
sign_in(current_user)
chat_page.visit_channel(channel)
channel_page.message_thread_indicator(thread.original_message).click
end
other_user = Fabricate(:user)
chat_system_user_bootstrap(user: other_user, channel: channel)
sign_in(other_user)
chat_page.visit_channel(channel)
channel_page.message_thread_indicator(thread.original_message).click
expect(side_panel).to have_open_thread(thread)
thread_page.send_message("the other user message")
expect(thread_page.messages).to have_message(
thread_id: thread.id,
text: "the other user message",
)
using_session(:tab_1) do
expect(side_panel).to have_open_thread(thread)
expect(thread_page.messages).to have_message(
thread_id: thread.id,
text: "the other user message",
)
thread_page.send_message("this is a test message")
expect(thread_page.messages).to have_message(
thread_id: thread.id,
text: "this is a test message",
)
end
expect(thread_page.messages).to have_message(
thread_id: thread.id,
text: "this is a test message",
)
end
it "does not mark the channel unread if another user sends a message in the thread" do
other_user = Fabricate(:user)
chat_system_user_bootstrap(user: other_user, channel: channel)
Fabricate(
:chat_message,
thread: thread,
user: other_user,
message: "Hello world!",
use_service: true,
)
sign_in(current_user)
chat_page.visit_channel(channel)
expect(page).not_to have_css(
".sidebar-section-link.channel-#{channel.id} .sidebar-section-link-suffix.unread",
)
end
end
context "when using mobile" do
it "opens the side panel for a single thread using the indicator", mobile: true do
chat_page.visit_channel(channel)
channel_page.message_thread_indicator(thread.original_message).click
expect(side_panel).to have_open_thread(thread)
end
it "navigates back to channel when clicking original message link", mobile: true do
chat_page.visit_thread(thread)
find(".chat-message-info__original-message").click
expect(page).to have_current_path("/chat/c/#{channel.slug}/#{channel.id}")
end
end
context "when messages are separated by a day" do
before do
Fabricate(:chat_message, chat_channel: channel, thread: thread, created_at: 2.days.ago)
end
it "shows a date separator" do
chat_page.visit_thread(thread)
expect(page).to have_selector(".chat-thread .chat-message-separator__text", text: "Today")
end
end
end
end