Skip to content

A platform for community discussion. Free, open, simple.

4.9 KB
Raw Blame
# frozen_string_literal: true

describe "Admin Dashboard Configure menu" do
  fab!(:admin)
  fab!(:moderator)

  let(:dashboard) { PageObjects::Pages::AdminDashboard.new }

  context "as an admin" do
    before { sign_in(admin) }

    it "applies toggles immediately, persists across reload, and shows an empty state when everything is hidden" do
      dashboard.visit
      expect(dashboard).to have_configure_button
      %w[highlights reports traffic engagement search system].each do |id|
        expect(dashboard).to have_section(id)
      end

      dashboard.open_configure_menu.toggle_section("traffic").toggle_section("engagement")

      # changes apply right away, while the menu is still open
      expect(dashboard).to have_section("highlights")
      expect(dashboard).to have_section("reports")
      expect(dashboard).to have_section("search")
      expect(dashboard).to have_no_section("traffic")
      expect(dashboard).to have_no_section("engagement")

      dashboard.close_configure_menu
      page.refresh

      expect(dashboard).to have_section("highlights")
      expect(dashboard).to have_section("reports")
      expect(dashboard).to have_section("search")
      expect(dashboard).to have_no_section("traffic")
      expect(dashboard).to have_no_section("engagement")

      dashboard
        .open_configure_menu
        .toggle_section("highlights")
        .toggle_section("reports")
        .toggle_section("search")
        .toggle_section("system")

      expect(dashboard).to have_empty_state
    end

    it "keeps a section's position when it is toggled off and back on" do
      dashboard.visit
      expect(dashboard.section_ids_in_order).to eq(
        %w[highlights reports traffic engagement search system],
      )

      dashboard.open_configure_menu.toggle_section("highlights")
      expect(dashboard).to have_no_section("highlights")

      dashboard.toggle_section("highlights")

      # it reappears in its original slot, not pushed to the bottom
      expect(dashboard).to have_first_section("highlights")
      expect(dashboard.section_ids_in_order).to eq(
        %w[highlights reports traffic engagement search system],
      )
    end

    it "reorders sections via the arrow buttons on mobile", mobile: true do
      dashboard.visit

      dashboard.open_configure_menu.move_section_up("reports")

      # reorder applies immediately, without closing the menu
      expect(dashboard).to have_first_section("reports")
      expect(dashboard.section_ids_in_order.first(2)).to eq(%w[reports highlights])
    end

    # TODO (ui-kit-reorderable-list-cleanup) fold these over the examples above
    # once the change ships and the arrow buttons are gone.
    context "when enable_new_reordering_controls is enabled" do
      before { SiteSetting.enable_new_reordering_controls = true }

      it "reorders sections via the move menu on mobile", mobile: true do
        dashboard.visit

        dashboard.open_configure_menu.move_section_up_via_list("reports")

        # reorder applies immediately, without closing the menu
        expect(dashboard).to have_first_section("reports")
        expect(dashboard.section_ids_in_order.first(2)).to eq(%w[reports highlights])
      end

      it "shows the drag handle on mobile", mobile: true do
        # The rendering test only proves the handle is in the DOM. A touch screen
        # reaches the menu as a modal rather than a popover, so this asserts it is
        # actually visible there, which is the only thing a finger can act on.
        dashboard.visit
        dashboard.open_configure_menu

        expect(page).to have_css(".d-reorderable-list__handle")
      end

      it "reorders sections with a real browser drag" do
        dashboard.visit
        dashboard.open_configure_menu

        # Asserted before the drag: without it, a run where the two are already
        # in the expected order passes whether or not the drag did anything.
        expect(dashboard.section_ids_in_order.first(2)).to eq(%w[highlights reports])

        dashboard.drag_section("reports", "highlights")

        try_until_success do
          expect(dashboard.section_ids_in_order.first(2)).to eq(%w[reports highlights])
        end
      end
    end
  end

  context "as a moderator" do
    before { sign_in(moderator) }

    it "does not show the Configure trigger" do
      dashboard.visit
      expect(dashboard).to have_no_configure_button
    end

    it "sees the same configured layout an admin set up" do
      AdminDashboardSectionConfiguration.update(
        [
          { id: "highlights", visible: true },
          { id: "reports", visible: true },
          { id: "traffic", visible: false },
          { id: "engagement", visible: false },
        ],
        actor: admin,
      )
      dashboard.visit

      expect(dashboard).to have_section("highlights")
      expect(dashboard).to have_section("reports")
      expect(dashboard).to have_no_section("traffic")
    end
  end
end