discourse/spec/requests/user_badges_controller_spec.rb
Bianca Nenciu a22aa7562a
FIX: Make favorite work with multiple grant badges (#13492)
Badges that are awarded multiple times can be favorite and not favorite
at the same time. This caused few problems when users tried to favorite
them as they were counted multiple times or their state was incorrectly
displayed.
2021-06-23 14:41:23 +03:00

340 lines
10 KiB
Ruby

# frozen_string_literal: true
require 'rails_helper'
describe UserBadgesController do
fab!(:user) { Fabricate(:user) }
fab!(:badge) { Fabricate(:badge) }
context 'index' do
fab!(:badge) { Fabricate(:badge, target_posts: true, show_posts: false) }
it 'does not leak private info' do
p = create_post
UserBadge.create!(badge: badge, user: user, post_id: p.id, granted_by_id: -1, granted_at: Time.now)
get "/user_badges.json", params: { badge_id: badge.id }
expect(response.status).to eq(200)
parsed = response.parsed_body
expect(parsed["topics"]).to eq(nil)
expect(parsed["badges"].length).to eq(1)
expect(parsed["user_badge_info"]["user_badges"][0]["post_id"]).to eq(nil)
end
it "fails when badges are disabled" do
SiteSetting.enable_badges = false
get "/user_badges.json", params: { badge_id: badge.id }
expect(response.status).to eq(404)
end
end
context 'index' do
let!(:user_badge) { UserBadge.create(badge: badge, user: user, granted_by: Discourse.system_user, granted_at: Time.now) }
it 'requires username or badge_id to be specified' do
get "/user_badges.json"
expect(response.status).to eq(400)
end
it 'returns user_badges for a user' do
get "/user-badges/#{user.username}.json"
expect(response.status).to eq(200)
parsed = response.parsed_body
expect(parsed["user_badges"].length).to eq(1)
end
it 'returns user_badges for a user with period in username' do
user.update!(username: "myname.test")
get "/user-badges/#{user.username}", xhr: true
expect(response.status).to eq(200)
parsed = response.parsed_body
expect(parsed["user_badges"].length).to eq(1)
end
it 'returns user_badges for a badge' do
get "/user_badges.json", params: { badge_id: badge.id }
expect(response.status).to eq(200)
parsed = response.parsed_body
expect(parsed["user_badge_info"]["user_badges"].length).to eq(1)
end
it 'includes counts when passed the aggregate argument' do
get "/user-badges/#{user.username}.json", params: {
grouped: true
}
expect(response.status).to eq(200)
parsed = response.parsed_body
expect(parsed["user_badges"].first.has_key?('count')).to eq(true)
end
context 'hidden profiles' do
before do
user.user_option.update_columns(hide_profile_and_presence: true)
end
it "returns 404 if `hide_profile_and_presence` user option is checked" do
get "/user-badges/#{user.username}.json"
expect(response.status).to eq(404)
end
it "returns user_badges if `allow_users_to_hide_profile` is false" do
SiteSetting.allow_users_to_hide_profile = false
get "/user-badges/#{user.username}.json"
expect(response.status).to eq(200)
end
end
end
context 'create' do
it 'requires username to be specified' do
post "/user_badges.json", params: { badge_id: badge.id }
expect(response.status).to eq(400)
end
it 'does not allow regular users to grant badges' do
sign_in(Fabricate(:user))
post "/user_badges.json", params: {
badge_id: badge.id, username: user.username
}
expect(response.status).to eq(403)
end
it 'grants badges from staff' do
admin = Fabricate(:admin)
post_1 = create_post
sign_in(admin)
post "/user_badges.json", params: {
badge_id: badge.id,
username: user.username,
reason: Discourse.base_url + post_1.url
}
expect(response.status).to eq(200)
user_badge = UserBadge.find_by(user: user, badge: badge)
expect(user_badge).to be_present
expect(user_badge.granted_by).to eq(admin)
expect(user_badge.post_id).to eq(post_1.id)
expect(UserHistory.where(acting_user: admin, target_user: user).count).to eq(1)
end
it 'does not grant badges from regular api calls' do
api_key = Fabricate(:api_key, user: user)
post "/user_badges.json", params: {
badge_id: badge.id, username: user.username, api_key: api_key.key
}
expect(response.status).to eq(403)
end
it 'grants badges from master api calls' do
api_key = Fabricate(:api_key)
post "/user_badges.json",
params: {
badge_id: badge.id, username: user.username
},
headers: {
HTTP_API_KEY: api_key.key, HTTP_API_USERNAME: "system"
}
expect(response.status).to eq(200)
user_badge = UserBadge.find_by(user: user, badge: badge)
expect(user_badge).to be_present
expect(user_badge.granted_by).to eq(Discourse.system_user)
expect(UserHistory.where(acting_user: Discourse.system_user, target_user: user).count).to eq(0)
end
it 'will trigger :user_badge_granted' do
sign_in(Fabricate(:admin))
events = DiscourseEvent.track_events do
post "/user_badges.json", params: {
badge_id: badge.id, username: user.username
}
end.map { |event| event[:event_name] }
expect(events).to include(:user_badge_granted)
end
it 'does not grant badge when external link is used in reason' do
admin = Fabricate(:admin)
post = create_post
sign_in(admin)
post "/user_badges.json", params: {
badge_id: badge.id,
username: user.username,
reason: "http://example.com/" + post.url
}
expect(response.status).to eq(400)
end
it 'does not grant badge if invalid discourse post/topic link is used in reason' do
admin = Fabricate(:admin)
post = create_post
sign_in(admin)
post "/user_badges.json", params: {
badge_id: badge.id,
username: user.username,
reason: Discourse.base_url + "/random_url/" + post.url
}
expect(response.status).to eq(400)
end
it 'grants badge when valid post/topic link is given in reason' do
admin = Fabricate(:admin)
post = create_post
sign_in(admin)
post "/user_badges.json", params: {
badge_id: badge.id,
username: user.username,
reason: Discourse.base_url + post.url
}
expect(response.status).to eq(200)
end
describe 'with relative_url_root' do
it 'grants badge when valid post/topic link is given in reason' do
set_subfolder "/discuss"
admin = Fabricate(:admin)
post = create_post
sign_in(admin)
post "/user_badges.json", params: {
badge_id: badge.id,
username: user.username,
reason: "#{Discourse.base_url}#{post.url}"
}
expect(response.status).to eq(200)
expect(UserBadge.exists?(
badge_id: badge.id,
post_id: post.id,
granted_by: admin.id)
).to eq(true)
end
end
end
context 'destroy' do
let!(:user_badge) { UserBadge.create(badge: badge, user: user, granted_by: Discourse.system_user, granted_at: Time.now) }
it 'checks that the user is authorized to revoke a badge' do
delete "/user_badges/#{user_badge.id}.json"
expect(response.status).to eq(403)
end
it 'revokes the badge' do
admin = Fabricate(:admin)
sign_in(admin)
delete "/user_badges/#{user_badge.id}.json"
expect(response.status).to eq(200)
expect(UserBadge.find_by(id: user_badge.id)).to eq(nil)
expect(UserHistory.where(acting_user: admin, target_user: user).count).to eq(1)
end
it 'will trigger :user_badge_removed' do
sign_in(Fabricate(:admin))
events = DiscourseEvent.track_events do
delete "/user_badges/#{user_badge.id}.json"
end.map { |event| event[:event_name] }
expect(events).to include(:user_badge_removed)
end
end
context "favorite" do
let!(:user_badge) { UserBadge.create(badge: badge, user: user, granted_by: Discourse.system_user, granted_at: Time.now) }
it "checks that the user is authorized to favorite the badge" do
sign_in(Fabricate(:admin))
put "/user_badges/#{user_badge.id}/toggle_favorite.json"
expect(response.status).to eq(403)
end
it "checks that the user has less than max_favorites_badges favorited badges" do
sign_in(user)
UserBadge.create(badge: Fabricate(:badge), user: user, granted_by: Discourse.system_user, granted_at: Time.now, is_favorite: true)
UserBadge.create(badge: Fabricate(:badge), user: user, granted_by: Discourse.system_user, granted_at: Time.now, is_favorite: true)
put "/user_badges/#{user_badge.id}/toggle_favorite.json"
expect(response.status).to eq(400)
SiteSetting.max_favorite_badges = 3
put "/user_badges/#{user_badge.id}/toggle_favorite.json"
expect(response.status).to eq(200)
end
it "favorites a badge" do
sign_in(user)
put "/user_badges/#{user_badge.id}/toggle_favorite.json"
expect(response.status).to eq(200)
user_badge = UserBadge.find_by(user: user, badge: badge)
expect(user_badge.is_favorite).to be true
end
it "unfavorites a badge" do
sign_in(user)
user_badge.toggle!(:is_favorite)
put "/user_badges/#{user_badge.id}/toggle_favorite.json"
expect(response.status).to eq(200)
user_badge = UserBadge.find_by(user: user, badge: badge)
expect(user_badge.is_favorite).to be false
end
it "works with multiple grants" do
SiteSetting.max_favorite_badges = 2
sign_in(user)
badge = Fabricate(:badge, multiple_grant: true)
user_badge = UserBadge.create(badge: badge, user: user, granted_by: Discourse.system_user, granted_at: Time.now, seq: 0, is_favorite: true)
user_badge2 = UserBadge.create(badge: badge, user: user, granted_by: Discourse.system_user, granted_at: Time.now, seq: 1, is_favorite: true)
other_badge = Fabricate(:badge)
other_user_badge = UserBadge.create(badge: other_badge, user: user, granted_by: Discourse.system_user, granted_at: Time.now)
put "/user_badges/#{user_badge.id}/toggle_favorite.json"
expect(response.status).to eq(200)
expect(user_badge.reload.is_favorite).to eq(false)
expect(user_badge2.reload.is_favorite).to eq(false)
put "/user_badges/#{user_badge.id}/toggle_favorite.json"
expect(response.status).to eq(200)
expect(user_badge.reload.is_favorite).to eq(true)
expect(user_badge2.reload.is_favorite).to eq(true)
put "/user_badges/#{other_user_badge.id}/toggle_favorite.json"
expect(response.status).to eq(200)
expect(other_user_badge.reload.is_favorite).to eq(true)
end
end
end