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

# frozen_string_literal: true

RSpec.describe "Starred channels" do
  fab!(:current_user, :user)

  let(:chat_page) { PageObjects::Pages::Chat.new }
  let(:sidebar) { PageObjects::Pages::Sidebar.new }

  before do
    chat_system_bootstrap
    SiteSetting.navigation_menu = "sidebar"
    sign_in(current_user)
  end

  context "when starring a channel" do
    fab!(:channel_1) { Fabricate(:category_channel, name: "Channel A") }
    fab!(:channel_2) { Fabricate(:category_channel, name: "Channel B") }

    before do
      channel_1.add(current_user)
      channel_2.add(current_user)
    end

    it "shows the starred channel in the Starred Channels section" do
      visit("/")

      expect(page).to have_no_css("#sidebar-section-content-chat-starred-channels")

      chat_page.visit_channel(channel_1)

      membership = channel_1.membership_for(current_user)

      expect(page).to have_css(".c-navbar__star-channel-button .d-icon-far-star")
      find(".c-navbar__star-channel-button").click
      expect(page).to have_css(".c-navbar__star-channel-button.--starred .d-icon-star")
      expect(membership.reload.starred).to eq(true)

      visit("/")

      expect(page).to have_css("#sidebar-section-content-chat-starred-channels")
      expect(
        page.find("#sidebar-section-content-chat-starred-channels li:nth-child(1)"),
      ).to have_css(".channel-#{channel_1.id}")
    end

    it "removes the starred channel from the regular Channels section" do
      visit("/")

      expect(page.find("#sidebar-section-content-chat-channels li:nth-child(1)")).to have_css(
        ".channel-#{channel_1.id}",
      )

      chat_page.visit_channel(channel_1)

      find(".c-navbar__star-channel-button").click
      expect(page).to have_css(".c-navbar__star-channel-button.--starred .d-icon-star")

      visit("/")

      expect(page.find("#sidebar-section-content-chat-starred-channels")).to have_css(
        ".channel-#{channel_1.id}",
      )
      expect(page.find("#sidebar-section-content-chat-channels")).to have_no_css(
        ".channel-#{channel_1.id}",
      )
      expect(page.find("#sidebar-section-content-chat-channels")).to have_css(
        ".channel-#{channel_2.id}",
      )
    end
  end

  context "when starring multiple channels" do
    fab!(:channel_1) { Fabricate(:category_channel, name: "Channel C") }
    fab!(:channel_2) { Fabricate(:category_channel, name: "Channel A") }
    fab!(:channel_3) { Fabricate(:category_channel, name: "Channel B") }

    before do
      channel_1.add(current_user)
      channel_2.add(current_user)
      channel_3.add(current_user)
    end

    it "sorts starred channels alphabetically by slug in the Starred Channels section" do
      channel_1.membership_for(current_user).update!(starred: true)
      channel_2.membership_for(current_user).update!(starred: true)
      channel_3.membership_for(current_user).update!(starred: true)

      visit("/")

      expect(
        page.find("#sidebar-section-content-chat-starred-channels li:nth-child(1)"),
      ).to have_css(".channel-#{channel_2.id}")
      expect(
        page.find("#sidebar-section-content-chat-starred-channels li:nth-child(2)"),
      ).to have_css(".channel-#{channel_3.id}")
      expect(
        page.find("#sidebar-section-content-chat-starred-channels li:nth-child(3)"),
      ).to have_css(".channel-#{channel_1.id}")
    end

    it "shows unstarred channels in the regular Channels section" do
      channel_1.membership_for(current_user).update!(starred: true)

      visit("/")

      expect(page.find("#sidebar-section-content-chat-starred-channels")).to have_css(
        ".channel-#{channel_1.id}",
      )

      expect(page.find("#sidebar-section-content-chat-channels")).to have_no_css(
        ".channel-#{channel_1.id}",
      )
      expect(page.find("#sidebar-section-content-chat-channels li:nth-child(1)")).to have_css(
        ".channel-#{channel_2.id}",
      )
      expect(page.find("#sidebar-section-content-chat-channels li:nth-child(2)")).to have_css(
        ".channel-#{channel_3.id}",
      )
    end
  end

  context "when unstarring a channel" do
    fab!(:channel_1) { Fabricate(:category_channel, name: "Channel A") }
    fab!(:channel_2) { Fabricate(:category_channel, name: "Channel B") }

    before do
      channel_1.add(current_user)
      channel_2.add(current_user)

      channel_1.membership_for(current_user).update!(starred: true)
    end

    it "moves the channel from Starred Channels to regular Channels section" do
      visit("/")

      expect(page.find("#sidebar-section-content-chat-starred-channels")).to have_css(
        ".channel-#{channel_1.id}",
      )
      expect(page.find("#sidebar-section-content-chat-channels")).to have_no_css(
        ".channel-#{channel_1.id}",
      )

      chat_page.visit_channel(channel_1)

      membership = channel_1.membership_for(current_user)

      expect(page).to have_css(".c-navbar__star-channel-button.--starred .d-icon-star")
      find(".c-navbar__star-channel-button").click
      expect(page).to have_css(".c-navbar__star-channel-button .d-icon-far-star")
      expect(page).to have_no_css(".c-navbar__star-channel-button.--starred")
      expect(membership.reload.starred).to eq(false)

      visit("/")

      expect(page).to have_no_css("#sidebar-section-content-chat-starred-channels")
      expect(page.find("#sidebar-section-content-chat-channels li:nth-child(1)")).to have_css(
        ".channel-#{channel_1.id}",
      )
    end
  end

  context "when all channels are starred" do
    fab!(:channel_1) { Fabricate(:category_channel, name: "Channel A") }
    fab!(:channel_2) { Fabricate(:category_channel, name: "Channel B") }

    before do
      channel_1.add(current_user)
      channel_2.add(current_user)

      channel_1.membership_for(current_user).update!(starred: true)
      channel_2.membership_for(current_user).update!(starred: true)
    end

    it "shows only the Starred Channels section" do
      visit("/")

      expect(page.find("#sidebar-section-content-chat-starred-channels")).to have_css(
        ".channel-#{channel_1.id}",
      )
      expect(page.find("#sidebar-section-content-chat-starred-channels")).to have_css(
        ".channel-#{channel_2.id}",
      )
    end
  end

  context "when starring direct message channels" do
    fab!(:user_1, :user)
    fab!(:user_2, :user)
    fab!(:user_3, :user)
    fab!(:dm_channel_1) { Fabricate(:direct_message_channel, users: [current_user, user_1]) }
    fab!(:dm_channel_2) { Fabricate(:direct_message_channel, users: [current_user, user_2]) }
    fab!(:dm_channel_3) { Fabricate(:direct_message_channel, users: [current_user, user_3]) }

    before do
      user_1.update!(username: "charlie")
      user_2.update!(username: "alice")
      user_3.update!(username: "bob")
    end

    it "shows the starred DM channel in the Starred Channels section" do
      visit("/")

      chat_page.visit_channel(dm_channel_1)

      membership = dm_channel_1.membership_for(current_user)

      expect(page).to have_css(".c-navbar__star-channel-button .d-icon-far-star")
      find(".c-navbar__star-channel-button").click
      expect(page).to have_css(".c-navbar__star-channel-button.--starred .d-icon-star")
      expect(membership.reload.starred).to eq(true)

      visit("/")

      expect(page.find("#sidebar-section-content-chat-starred-channels")).to have_css(
        ".channel-#{dm_channel_1.id}",
      )
    end

    it "removes the starred DM from the regular Direct Messages section" do
      dm_channel_1.membership_for(current_user).update!(starred: true)

      visit("/")

      expect(page.find("#sidebar-section-content-chat-starred-channels")).to have_css(
        ".channel-#{dm_channel_1.id}",
      )
      expect(page.find("#sidebar-section-content-chat-dms")).to have_no_css(
        ".channel-#{dm_channel_1.id}",
      )
    end

    it "sorts starred DM channels alphabetically by title in Starred Channels section" do
      dm_channel_1.membership_for(current_user).update!(starred: true)
      dm_channel_2.membership_for(current_user).update!(starred: true)
      dm_channel_3.membership_for(current_user).update!(starred: true)

      visit("/")

      starred_section = page.find("#sidebar-section-content-chat-starred-channels")
      expect(starred_section.find("li:nth-child(1)")).to have_css(".channel-#{dm_channel_2.id}")
      expect(starred_section.find("li:nth-child(2)")).to have_css(".channel-#{dm_channel_3.id}")
      expect(starred_section.find("li:nth-child(3)")).to have_css(".channel-#{dm_channel_1.id}")
    end
  end

  context "when starring both public channels and DMs" do
    fab!(:user_1, :user)
    fab!(:channel_1) { Fabricate(:category_channel, name: "Channel B") }
    fab!(:channel_2) { Fabricate(:category_channel, name: "Channel A") }
    fab!(:dm_channel_1) { Fabricate(:direct_message_channel, users: [current_user, user_1]) }

    before do
      user_1.update!(username: "alice")
      channel_1.add(current_user)
      channel_2.add(current_user)

      channel_1.membership_for(current_user).update!(starred: true)
      channel_2.membership_for(current_user).update!(starred: true)
      dm_channel_1.membership_for(current_user).update!(starred: true)
    end

    it "shows public channels first, then DMs in the Starred Channels section" do
      visit("/")

      starred_section = page.find("#sidebar-section-content-chat-starred-channels")
      expect(starred_section.find("li:nth-child(1)")).to have_css(".channel-#{channel_2.id}")
      expect(starred_section.find("li:nth-child(2)")).to have_css(".channel-#{channel_1.id}")
      expect(starred_section.find("li:nth-child(3)")).to have_css(".channel-#{dm_channel_1.id}")
    end
  end

  context "when using the navbar star button" do
    fab!(:channel_1) { Fabricate(:category_channel, name: "Channel A") }

    before { channel_1.add(current_user) }

    it "can star a channel from the navbar" do
      chat_page.visit_channel(channel_1)

      expect(page).to have_css(".c-navbar__star-channel-button .d-icon-far-star")

      find(".c-navbar__star-channel-button").click

      expect(page).to have_css(".c-navbar__star-channel-button.--starred .d-icon-star")
      expect(channel_1.membership_for(current_user).reload.starred).to eq(true)
    end

    it "can unstar a channel from the navbar" do
      channel_1.membership_for(current_user).update!(starred: true)

      chat_page.visit_channel(channel_1)

      expect(page).to have_css(".c-navbar__star-channel-button.--starred .d-icon-star")

      find(".c-navbar__star-channel-button").click

      expect(page).to have_css(".c-navbar__star-channel-button .d-icon-far-star")
      expect(page).to have_no_css(".c-navbar__star-channel-button.--starred")
      expect(channel_1.membership_for(current_user).reload.starred).to eq(false)
    end

    it "shows the correct tooltip when hovering over the star button" do
      chat_page.visit_channel(channel_1)

      find(".c-navbar__star-channel-button").hover

      expect(page).to have_css(
        ".fk-d-tooltip__content",
        text: I18n.t("js.chat.channel_settings.star_channel"),
      )
    end

    it "shows the correct tooltip when channel is already starred" do
      channel_1.membership_for(current_user).update!(starred: true)

      chat_page.visit_channel(channel_1)

      find(".c-navbar__star-channel-button").hover

      expect(page).to have_css(
        ".fk-d-tooltip__content",
        text: I18n.t("js.chat.channel_settings.unstar_channel"),
      )
    end

    it "updates tooltip after toggling starred state" do
      chat_page.visit_channel(channel_1)

      find(".c-navbar__star-channel-button").hover
      expect(page).to have_css(
        ".fk-d-tooltip__content",
        text: I18n.t("js.chat.channel_settings.star_channel"),
      )

      find(".c-navbar__star-channel-button").click
      expect(page).to have_css(".c-navbar__star-channel-button.--starred")

      find(".c-navbar__star-channel-button").hover
      expect(page).to have_css(
        ".fk-d-tooltip__content",
        text: I18n.t("js.chat.channel_settings.unstar_channel"),
      )
    end
  end

  context "when opening chat without a known last location" do
    fab!(:channel_1) { Fabricate(:category_channel, name: "Channel A") }

    before do
      channel_1.add(current_user)
      channel_1.membership_for(current_user).update!(starred: true)
    end

    it "defaults to starred channels on mobile", mobile: true do
      visit("/")
      chat_page.open_from_header

      expect(page).to have_current_path("/chat/starred-channels")
    end

    it "defaults to chat index on desktop fullscreen (starred channels in sidebar)" do
      visit("/")
      chat_page.prefers_full_page
      chat_page.open_from_header

      expect(page).to have_current_path("/chat/browse/open")
    end
  end

  context "when navigating back from a channel on mobile", mobile: true do
    fab!(:channel_1) { Fabricate(:category_channel, name: "Channel A") }

    before do
      channel_1.add(current_user)
      channel_1.membership_for(current_user).update!(starred: true)
    end

    it "returns to starred channels when starred channels exist" do
      visit("/")
      chat_page.open_from_header
      find("#c-footer-starred").click
      find(".chat-channel-row[data-chat-channel-id='#{channel_1.id}']").click

      find(".c-navbar__back-button").click
      expect(page).to have_current_path("/chat/starred-channels")
    end

    it "redirects to channels list after unstarring the last channel" do
      visit("/")
      chat_page.open_from_header
      find("#c-footer-starred").click
      find(".chat-channel-row[data-chat-channel-id='#{channel_1.id}']").click

      find(".c-navbar__star-channel-button").click
      expect(page).to have_no_css(".c-navbar__star-channel-button.--starred")

      find(".c-navbar__back-button").click
      expect(page).to have_current_path("/chat/channels")
    end
  end
end