Skip to content

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

19.9 KB
Raw Blame
# frozen_string_literal: true

RSpec.describe AdminUserIndexQuery do
  def real_users(query)
    query.find_users_query.where("users.id > 0")
  end

  describe "sql order" do
    it "has default" do
      query = ::AdminUserIndexQuery.new({})
      expect(query.find_users_query.to_sql).to match("created_at DESC")
    end

    it "has active order" do
      query = ::AdminUserIndexQuery.new(query: "active")
      expect(query.find_users_query.to_sql).to match("last_seen_at")
    end

    it "can't be injected" do
      query = ::AdminUserIndexQuery.new(order: "wat, no")
      expect(query.find_users_query.to_sql).not_to match("wat, no")
    end

    it "allows custom ordering" do
      query = ::AdminUserIndexQuery.new(order: "trust_level")
      expect(query.find_users_query.to_sql).to match("trust_level DESC")
    end

    it "allows custom ordering asc" do
      query = ::AdminUserIndexQuery.new(order: "trust_level", asc: true)
      expect(query.find_users_query.to_sql).to match("trust_level ASC")
    end

    it "allows custom ordering for stats with default direction" do
      query = ::AdminUserIndexQuery.new(order: "topics_viewed")
      expect(query.find_users_query.to_sql).to match("topics_entered DESC")
    end

    it "allows custom ordering and direction for stats" do
      query = ::AdminUserIndexQuery.new(order: "topics_viewed", asc: true)
      expect(query.find_users_query.to_sql).to match("topics_entered ASC")
    end
  end

  describe "pagination" do
    it "defaults to the first page" do
      query = ::AdminUserIndexQuery.new({})
      expect(query.find_users.to_sql).to match("OFFSET 0")
    end

    it "offsets by 100 by default for page 2" do
      query = ::AdminUserIndexQuery.new(page: "2")
      expect(query.find_users.to_sql).to match("OFFSET 100")
    end

    it "offsets by limit for page 2" do
      query = ::AdminUserIndexQuery.new(page: "2")
      expect(query.find_users(10).to_sql).to match("OFFSET 10")
    end

    it "ignores negative pages" do
      query = ::AdminUserIndexQuery.new(page: "-2")
      expect(query.find_users.to_sql).to match("OFFSET 0")
    end
  end

  describe "no users with trust level" do
    TrustLevel.levels.each do |key, value|
      it "#{key} returns no records" do
        query = ::AdminUserIndexQuery.new(query: key.to_s)
        expect(real_users(query)).to eq([])
      end
    end
  end

  describe "users with trust level" do
    TrustLevel.levels.each do |key, value|
      it "finds user with trust #{key}" do
        user = Fabricate(:user, trust_level: value)

        next if !TrustLevel.valid?(value + 1)
        Fabricate(:user, trust_level: value + 1)

        query = ::AdminUserIndexQuery.new(query: key.to_s)
        expect(real_users(query).to_a).to eq([user])
      end
    end
  end

  describe "with a pending user" do
    fab!(:user) { Fabricate(:user, active: true, approved: false) }
    fab!(:inactive_user) { Fabricate(:user, approved: false, active: false) }

    it "finds the unapproved user" do
      query = ::AdminUserIndexQuery.new(query: "pending")
      expect(query.find_users).to include(user)
      expect(query.find_users).not_to include(inactive_user)
    end

    context "with a suspended pending user" do
      fab!(:suspended_user) do
        Fabricate(
          :user,
          approved: false,
          suspended_at: 1.hour.ago,
          suspended_till: 20.years.from_now,
        )
      end
      it "doesn't return the suspended user" do
        query = ::AdminUserIndexQuery.new(query: "pending")
        expect(query.find_users).not_to include(suspended_user)
      end
    end
  end

  describe "correct order with nil values" do
    before(:each) { Fabricate(:user, email: "[email protected]", last_emailed_at: 1.hour.ago) }

    it "shows nil values first with asc" do
      users = ::AdminUserIndexQuery.new(order: "last_emailed", asc: true).find_users

      expect(users.where("users.id > -2").count).to eq(2)
      expect(users.where("users.id > -2").order("users.id asc").first.username).to eq("system")
      expect(users.first.last_emailed_at).to eq(nil)
    end

    it "shows nil values last with desc" do
      users = ::AdminUserIndexQuery.new(order: "last_emailed").find_users

      expect(users.where("users.id > -2").count).to eq(2)
      expect(users.first.last_emailed_at).to_not eq(nil)
    end
  end

  describe "with an admin user" do
    fab!(:user) { Fabricate(:user, admin: true) }
    fab!(:user2) { Fabricate(:user, admin: false) }

    it "finds the admin" do
      query = ::AdminUserIndexQuery.new(query: "admins")
      expect(real_users(query)).to eq([user])
    end
  end

  describe "bots" do
    fab!(:bot) do
      Fabricate(:user, id: -100, username: "searchable_bot", email: "[email protected]")
    end
    fab!(:human) do
      Fabricate(:user, username: "searchable_human", email: "[email protected]")
    end
    fab!(:zero_id_user) { Fabricate(:user, id: 0) }

    it "lists bot accounts using the bot scope, including non-staff bots" do
      users = described_class.new(query: "bots").find_users

      expect(users).to match_array(User.bot_users)
      expect(users).to include(bot, Discourse.system_user, zero_id_user)
      expect(users).not_to include(human)
    end

    it "sorts bot activity and creation dates in both directions" do
      other_bot = Fabricate(:user, id: -102, username: "other_bot", created_at: 2.days.ago)
      bot.update!(created_at: 1.day.ago)
      bot.user_stat.update!(topics_entered: 2, posts_read_count: 4, post_count: 6)
      other_bot.user_stat.update!(topics_entered: 1, posts_read_count: 3, post_count: 5)

      %w[topics_viewed posts_read posts created].each do |order|
        params = { query: "bots", filter: "#{bot.username},#{other_bot.username}", order: }

        expect(described_class.new(params).find_users).to eq([bot, other_bot])
        expect(described_class.new(params.merge(asc: true)).find_users).to eq([other_bot, bot])
      end
    end

    it "searches within bot accounts" do
      expect(described_class.new(query: "bots", filter: bot.username).find_users).to eq([bot])
      expect(described_class.new(query: "bots", filter: human.username).find_users).to be_empty
    end
  end

  describe "staff account types" do
    fab!(:admin) { Fabricate(:admin, created_at: 2.days.ago) }
    fab!(:moderator) { Fabricate(:moderator, created_at: 1.day.ago) }
    fab!(:bot) { Fabricate(:admin, id: -100, created_at: Time.zone.now) }
    fab!(:user)

    it "defaults missing or unknown account types to human staff before paginating" do
      query = described_class.new(query: "staff")

      expect(query.find_users).to eq([moderator, admin])
      expect(
        described_class.new(query: "staff", account_type: "unknown").find_users,
      ).to contain_exactly(admin, moderator)
      expect(query.find_users(1)).to eq([moderator])
      expect(described_class.new(query: "staff", page: 2).find_users(1)).to eq([admin])
    end

    it "includes bots and system accounts when selected" do
      users = described_class.new(query: "staff", account_type: "bot").find_users

      expect(users).to include(bot, Discourse.system_user)
      expect(users).not_to include(admin, moderator, user)
    end

    it "includes all staff accounts when selected" do
      users = described_class.new(query: "staff", account_type: "all").find_users

      expect(users).to include(admin, moderator, bot, Discourse.system_user)
      expect(users).not_to include(user)
    end

    it "keeps search and sorting within the selected account type" do
      query = described_class.new(query: "staff", order: "created", asc: true)

      expect(query.find_users).to eq([admin, moderator])
      expect(described_class.new(query: "staff", filter: bot.username).find_users).to be_empty
      expect(
        described_class.new(query: "staff", account_type: "all", filter: bot.username).find_users,
      ).to eq([bot])
    end

    it "leaves other user lists unfiltered" do
      users = described_class.new(query: "new", account_type: "human").find_users

      expect(users).to include(admin, moderator, bot, user, Discourse.system_user)
    end
  end

  describe "#bot_creators" do
    fab!(:admin)
    fab!(:creator, :admin)
    fab!(:bot) { Fabricate(:user, id: -1300, username: "creator_page_bot_a") }

    let!(:query) { described_class.new(query: "bots", guardian: admin.guardian) }

    it "selects the earliest exact creation event deterministically when timestamps match" do
      freeze_time
      UserHistory.create!(
        action: UserHistory.actions[:custom_staff],
        custom_type: "another_event",
        target_user_id: bot.id,
        acting_user_id: admin.id,
      )
      UserHistory.create!(
        action: UserHistory.actions[:custom],
        custom_type: "create_bot",
        target_user_id: bot.id,
        acting_user_id: admin.id,
      )
      StaffActionLogger.new(creator).log_bot_creation(bot)
      StaffActionLogger.new(admin).log_bot_creation(bot)

      expect(query.bot_creators([bot.id])).to eq(
        bot.id => {
          id: creator.id,
          username: creator.username,
          uploaded_avatar_id: creator.uploaded_avatar_id,
        },
      )
    end

    it "omits unknown bots and deleted first actors rather than attributing a later duplicate" do
      unknown_bot = Fabricate(:user, id: -1301)
      StaffActionLogger.new(creator).log_bot_creation(bot)
      StaffActionLogger.new(admin).log_bot_creation(bot)
      creator.delete

      expect(query.bot_creators([bot.id, unknown_bot.id])).to eq({})
    end

    it "returns an empty result without querying for empty pages or non-admin guardians" do
      StaffActionLogger.new(creator).log_bot_creation(bot)
      moderator = Fabricate(:moderator)

      queries = track_sql_queries { expect(query.bot_creators([])).to eq({}) }
      expect(queries).to be_empty

      [nil, moderator.guardian].each do |guardian|
        non_admin_query = described_class.new(query: "bots", guardian: guardian)
        queries = track_sql_queries { expect(non_admin_query.bot_creators([bot.id])).to eq({}) }

        expect(queries).to be_empty
      end
    end

    it "returns only creators for the requested filtered page" do
      page_bot = Fabricate(:user, id: -1301, username: "creator_page_bot_b")
      excluded_bot = Fabricate(:user, id: -1302, username: "excluded_bot")
      [bot, page_bot, excluded_bot].each do |target|
        StaffActionLogger.new(creator).log_bot_creation(target)
      end
      page_query =
        described_class.new(
          query: "bots",
          filter: "creator_page_bot",
          order: "username",
          asc: true,
          page: 2,
          guardian: admin.guardian,
        )
      page_ids = page_query.find_users(1).map(&:id)

      expect(page_ids).to eq([page_bot.id])
      expect(page_query.bot_creators(page_ids)).to eq(
        page_bot.id => {
          id: creator.id,
          username: creator.username,
          uploaded_avatar_id: creator.uploaded_avatar_id,
        },
      )
    end

    it "materializes creator data in one query regardless of the number of bots" do
      StaffActionLogger.new(creator).log_bot_creation(bot)
      queries_for_one =
        track_sql_queries do
          expect(query.bot_creators([bot.id])).to eq(
            bot.id => {
              id: creator.id,
              username: creator.username,
              uploaded_avatar_id: creator.uploaded_avatar_id,
            },
          )
        end
      expected_creators = {
        bot.id => {
          id: creator.id,
          username: creator.username,
          uploaded_avatar_id: creator.uploaded_avatar_id,
        },
      }
      4.times do |index|
        additional_bot = Fabricate(:user, id: -1301 - index)
        additional_creator = Fabricate(:admin)
        StaffActionLogger.new(additional_creator).log_bot_creation(additional_bot)
        expected_creators[additional_bot.id] = {
          id: additional_creator.id,
          username: additional_creator.username,
          uploaded_avatar_id: additional_creator.uploaded_avatar_id,
        }
      end

      queries_for_many =
        track_sql_queries do
          expect(query.bot_creators(expected_creators.keys)).to eq(expected_creators)
        end

      expect(queries_for_one.size).to eq(1)
      expect(queries_for_many.size).to eq(1)
    end
  end

  describe "with a moderator" do
    fab!(:user) { Fabricate(:user, moderator: true) }
    fab!(:user2) { Fabricate(:user, moderator: false) }

    it "finds the moderator" do
      query = ::AdminUserIndexQuery.new(query: "moderators")
      expect(real_users(query)).to eq([user])
    end
  end

  describe "with a silenced user" do
    fab!(:user) { Fabricate(:user, silenced_till: 1.year.from_now) }
    fab!(:user2, :user)

    it "finds the silenced user" do
      query = ::AdminUserIndexQuery.new(query: "silenced")
      expect(real_users(query)).to eq([user])
    end
  end

  describe "sorting by a penalty reason" do
    fab!(:user_a) { Fabricate(:user, suspended_till: 1.year.from_now, suspended_at: Time.zone.now) }
    fab!(:user_z) { Fabricate(:user, suspended_till: 1.year.from_now, suspended_at: Time.zone.now) }

    before do
      UserHistory.create!(
        action: UserHistory.actions[:suspend_user],
        target_user_id: user_a.id,
        acting_user_id: Discourse.system_user.id,
        details: "aaa reason",
      )
      UserHistory.create!(
        action: UserHistory.actions[:suspend_user],
        target_user_id: user_z.id,
        acting_user_id: Discourse.system_user.id,
        details: "zzz reason",
      )
    end

    it "orders by the suspend reason (joining only when sorting by it)" do
      query = ::AdminUserIndexQuery.new(query: "suspended", order: "suspend_reason", asc: "true")
      expect(real_users(query).map(&:id)).to eq([user_a.id, user_z.id])
    end
  end

  describe "with a staged user" do
    fab!(:user) { Fabricate(:user, staged: true) }
    fab!(:user2) { Fabricate(:user, staged: false) }

    it "finds the staged user" do
      query = ::AdminUserIndexQuery.new(query: "staged")
      expect(real_users(query)).to eq([user])
    end
  end

  describe "with the activation filter" do
    fab!(:activated_user) { Fabricate(:user, active: true) }
    fab!(:not_activated_user) { Fabricate(:user, active: false) }

    it "finds only not activated users" do
      query = ::AdminUserIndexQuery.new(query: "new", activation: "not_activated")
      expect(real_users(query)).to contain_exactly(not_activated_user)
    end

    it "finds only activated users" do
      query = ::AdminUserIndexQuery.new(query: "new", activation: "activated")
      expect(real_users(query)).to contain_exactly(activated_user)
    end

    it "finds all users when no activation filter is provided" do
      query = ::AdminUserIndexQuery.new(query: "new")
      expect(real_users(query)).to contain_exactly(activated_user, not_activated_user)
    end
  end

  describe "filtering" do
    context "with exact email bypass" do
      it "matches an exact email filter without ILIKE" do
        user = Fabricate(:user, email: "[email protected]")

        query = AdminUserIndexQuery.new(filter: "[email protected]").find_users_query
        expect(query.count).to eq(1)
        expect(query.first.id).to eq(user.id)

        expect(query.to_sql.downcase).not_to include("ilike")
      end

      it "matches the email parameter exactly without ILIKE" do
        user = Fabricate(:user, email: "[email protected]")

        query = AdminUserIndexQuery.new(email: "[email protected]").find_users_query
        expect(query.count).to eq(0)
        expect(query.to_sql.downcase).not_to include("ilike")

        query = AdminUserIndexQuery.new(email: "[email protected]").find_users_query
        expect(query.first.id).to eq(user.id)
        expect(query.count).to eq(1)
        expect(query.to_sql.downcase).not_to include("ilike")
      end
    end

    context "with email fragment" do
      before(:each) { Fabricate(:user, email: "[email protected]") }

      it "matches the email" do
        query = ::AdminUserIndexQuery.new(filter: " est1")
        expect(query.find_users.count()).to eq(1)
      end

      it "matches the email using any case" do
        query = ::AdminUserIndexQuery.new(filter: "Test1\t")
        expect(query.find_users.count()).to eq(1)
      end
    end

    context "with username fragment" do
      before(:each) { Fabricate(:user, username: "test_user_1") }

      it "matches the username" do
        query = ::AdminUserIndexQuery.new(filter: "user\n")
        expect(query.find_users.count).to eq(1)
      end

      it "matches the username using any case" do
        query = ::AdminUserIndexQuery.new(filter: "\r\nUser")
        expect(query.find_users.count).to eq(1)
      end
    end

    context "with ip address fragment" do
      fab!(:user) { Fabricate(:user, ip_address: "117.207.94.9") }

      it "matches the ip address" do
        query =
          ::AdminUserIndexQuery.new(filter: " 117.207.94.9 ", guardian: Fabricate(:admin).guardian)
        expect(query.find_users.count()).to eq(1)
      end
    end

    context "with multiple terms" do
      fab!(:user_one) { Fabricate(:user, username: "bulk_user_1", email: "[email protected]") }
      fab!(:user_two) { Fabricate(:user, username: "bulk_user_2", email: "[email protected]") }

      it "matches usernames separated by commas" do
        query = ::AdminUserIndexQuery.new(filter: "bulk_user_1,bulk_user_2")
        expect(query.find_users).to contain_exactly(user_one, user_two)
      end

      it "matches usernames separated by whitespace" do
        query = ::AdminUserIndexQuery.new(filter: "bulk_user_1 bulk_user_2")
        expect(query.find_users).to contain_exactly(user_one, user_two)

        query = ::AdminUserIndexQuery.new(filter: "bulk_user_1\nbulk_user_2")
        expect(query.find_users).to contain_exactly(user_one, user_two)
      end

      it "matches a mix of usernames and emails" do
        query = ::AdminUserIndexQuery.new(filter: "bulk_user_1, [email protected]")
        expect(query.find_users).to contain_exactly(user_one, user_two)
      end

      it "matches a list of emails" do
        query = ::AdminUserIndexQuery.new(filter: "[email protected],[email protected]")
        expect(query.find_users).to contain_exactly(user_one, user_two)

        query = ::AdminUserIndexQuery.new(filter: "[email protected] [email protected]")
        expect(query.find_users).to contain_exactly(user_one, user_two)
      end

      it "matches secondary emails exactly" do
        Fabricate(:secondary_email, user: user_two, email: "[email protected]")

        query = ::AdminUserIndexQuery.new(filter: "bulk_user_1,[email protected]")
        expect(query.find_users).to contain_exactly(user_one, user_two)
      end

      it "ignores blank tokens" do
        query = ::AdminUserIndexQuery.new(filter: "bulk_user_1, ,,  bulk_user_2,")
        expect(query.find_users).to contain_exactly(user_one, user_two)
      end

      it "treats like and regex metacharacters literally" do
        query = ::AdminUserIndexQuery.new(filter: "bulk_user_1,foo(")
        expect(query.find_users).to contain_exactly(user_one)

        query = ::AdminUserIndexQuery.new(filter: "a|b,zzz%")
        expect(query.find_users).to be_empty
      end

      it "still uses the exact email bypass for a single term with a trailing comma" do
        query = ::AdminUserIndexQuery.new(filter: "[email protected],").find_users_query
        expect(query.to_sql.downcase).not_to include("ilike")
        expect(query).to contain_exactly(user_one)
      end

      it "does not search by ip address when multiple terms are given" do
        Fabricate(:user, ip_address: "117.207.94.9")

        query =
          ::AdminUserIndexQuery.new(
            filter: "117.207.94.9,117.207.94.10",
            guardian: Fabricate(:admin).guardian,
          )
        expect(query.find_users).to be_empty
      end

      it "raises when there are too many terms" do
        filter = (0..AdminUserIndexQuery::MAX_FILTER_TERMS).map { |i| "user#{i}" }.join(",")

        expect { ::AdminUserIndexQuery.new(filter: filter).find_users }.to raise_error(
          Discourse::InvalidParameters,
        )
      end
    end
  end
end