A platform for community discussion. Free, open, simple.
DEV: Improve vote queries (#39394)
Martin Brennan062b112e5152
diff --git a/plugins/discourse-topic-voting/app/controllers/discourse_topic_voting/votes_controller.rb b/plugins/discourse-topic-voting/app/controllers/discourse_topic_voting/votes_controller.rbindex 808fe58a14a..7e0639d22a4 100644--- a/plugins/discourse-topic-voting/app/controllers/discourse_topic_voting/votes_controller.rb+++ b/plugins/discourse-topic-voting/app/controllers/discourse_topic_voting/votes_controller.rb@@ -11,7 +11,7 @@ module DiscourseTopicVotingtopic = Topic.find(params[:topic_id].to_i)guardian.ensure_can_see!(topic)- render json: MultiJson.dump(who_voted(topic))+ render json: MultiJson.dump(who_voted(topic, limit: who_voted_limit))enddef vote@@ -83,14 +83,21 @@ module DiscourseTopicVoting}end- def who_voted(topic)+ def who_voted(topic, limit: DiscourseTopicVoting::VOTER_PREVIEW_LIMIT)return nil unless SiteSetting.topic_voting_show_who_votedActiveModel::ArraySerializer.new(- topic.who_voted,+ topic.who_voted(limit:),scope: guardian,each_serializer: BasicUserSerializer,)end++ def who_voted_limit+ limit = params[:limit].presence&.to_i+ return DiscourseTopicVoting::VOTER_PREVIEW_LIMIT if limit.blank? || limit <= 0++ [limit, DiscourseTopicVoting::VOTER_PREVIEW_LIMIT].min+ endendenddiff --git a/plugins/discourse-topic-voting/app/models/discourse_topic_voting/topic_vote_count.rb b/plugins/discourse-topic-voting/app/models/discourse_topic_voting/topic_vote_count.rbindex c94b4226d69..ba30e13cabd 100644--- a/plugins/discourse-topic-voting/app/models/discourse_topic_voting/topic_vote_count.rb+++ b/plugins/discourse-topic-voting/app/models/discourse_topic_voting/topic_vote_count.rb@@ -4,7 +4,7 @@ module DiscourseTopicVotingclass TopicVoteCount < ActiveRecord::Baseself.table_name = "topic_voting_topic_vote_count"- belongs_to :topic+ belongs_to :topic, -> { with_deleted }endenddiff --git a/plugins/discourse-topic-voting/app/models/discourse_topic_voting/vote.rb b/plugins/discourse-topic-voting/app/models/discourse_topic_voting/vote.rbindex 79e957a6537..aa7da874f4d 100644--- a/plugins/discourse-topic-voting/app/models/discourse_topic_voting/vote.rb+++ b/plugins/discourse-topic-voting/app/models/discourse_topic_voting/vote.rb@@ -5,7 +5,10 @@ module DiscourseTopicVotingself.table_name = "topic_voting_votes"belongs_to :user- belongs_to :topic+ belongs_to :topic, -> { with_deleted }++ scope :active, -> { where(archive: false) }+ scope :archived, -> { where(archive: true) }endenddiff --git a/plugins/discourse-topic-voting/assets/javascripts/discourse/components/vote-count.gjs b/plugins/discourse-topic-voting/assets/javascripts/discourse/components/vote-count.gjsindex f5b37b5b76c..4acdc79bcfd 100644--- a/plugins/discourse-topic-voting/assets/javascripts/discourse/components/vote-count.gjs+++ b/plugins/discourse-topic-voting/assets/javascripts/discourse/components/vote-count.gjs@@ -8,7 +8,7 @@ import { ajax } from "discourse/lib/ajax";import { popupAjaxError } from "discourse/lib/ajax-error";import { bind } from "discourse/lib/decorators";import getURL from "discourse/lib/get-url";-import { eq, gt } from "discourse/truth-helpers";+import { eq } from "discourse/truth-helpers";import { i18n } from "discourse-i18n";import VoteCountTrigger from "./vote-count-trigger";@@ -21,8 +21,6 @@ export default class VoteCount extends Component {@tracked totalVoters = 0;@tracked isLoading = false;- maxDisplayedVoters = 104;-get showVoterMenu() {return this.siteSettings.topic_voting_show_who_voted && this.currentUser;}@@ -37,7 +35,11 @@ export default class VoteCount extends Component {}get remainingVoters() {- return this.totalVoters - this.maxDisplayedVoters;+ return Math.max(this.totalVoters - (this.voters?.length || 0), 0);+ }++ get hasOverflowVoters() {+ return this.remainingVoters > 0;}@bind@@ -63,8 +65,8 @@ export default class VoteCount extends Component {data: { topic_id: this.args.topic.id },});- this.totalVoters = users.length;- this.voters = users.slice(0, this.maxDisplayedVoters).map((user) => ({+ this.totalVoters = this.args.topic.vote_count;+ this.voters = users.map((user) => ({template: user.avatar_template,username: user.username,url: getURL("/u/") + user.username.toLowerCase(),@@ -112,7 +114,7 @@ export default class VoteCount extends Component {{{avatar voter.template "small"}}</a>{{/each}}- {{#if (gt this.totalVoters this.maxDisplayedVoters)}}+ {{#if this.hasOverflowVoters}}<div class="voting-voters__overflow">{{i18n"topic_voting.and_more_voters"diff --git a/plugins/discourse-topic-voting/lib/discourse_topic_voting/topic_extension.rb b/plugins/discourse-topic-voting/lib/discourse_topic_voting/topic_extension.rbindex 64e6e630a7c..f8e7007866f 100644--- a/plugins/discourse-topic-voting/lib/discourse_topic_voting/topic_extension.rb+++ b/plugins/discourse-topic-voting/lib/discourse_topic_voting/topic_extension.rb@@ -46,10 +46,10 @@ module DiscourseTopicVotingSQLend- def who_voted+ def who_voted(limit: DiscourseTopicVoting::VOTER_PREVIEW_LIMIT)return if !SiteSetting.topic_voting_show_who_voted- self.votes.map(&:user)+ votes.active.includes(:user).order(created_at: :desc).limit(limit).filter_map(&:user)endendenddiff --git a/plugins/discourse-topic-voting/lib/discourse_topic_voting/topic_query_extension.rb b/plugins/discourse-topic-voting/lib/discourse_topic_voting/topic_query_extension.rbindex 283c890b9e0..b62fc055078 100644--- a/plugins/discourse-topic-voting/lib/discourse_topic_voting/topic_query_extension.rb+++ b/plugins/discourse-topic-voting/lib/discourse_topic_voting/topic_query_extension.rb@@ -14,7 +14,7 @@ module DiscourseTopicVotingcreate_list(:user_topics) do |topics|topics.joins("INNER JOIN topic_voting_votes ON topic_voting_votes.topic_id = topics.id",- ).where("topic_voting_votes.user_id = ?", user.id)+ ).where("topic_voting_votes.user_id = ? AND topic_voting_votes.archive = FALSE", user.id)endenddiff --git a/plugins/discourse-topic-voting/plugin.rb b/plugins/discourse-topic-voting/plugin.rbindex b5babec5988..03604cc4adc 100755--- a/plugins/discourse-topic-voting/plugin.rb+++ b/plugins/discourse-topic-voting/plugin.rb@@ -23,6 +23,7 @@ Discourse.anonymous_filters.push(:votes)module ::DiscourseTopicVotingPLUGIN_NAME = "discourse-topic-voting"ENABLE_TOPIC_VOTING_SETTING = "enable_topic_voting"+ VOTER_PREVIEW_LIMIT = 104endrequire_relative "lib/discourse_topic_voting/engine"@@ -64,7 +65,7 @@ after_initialize doif options[:state] == "my_votes"result =result.joins(- "INNER JOIN topic_voting_votes ON topic_voting_votes.topic_id = topics.id AND topic_voting_votes.user_id = #{user.id}",+ "INNER JOIN topic_voting_votes ON topic_voting_votes.topic_id = topics.id AND topic_voting_votes.user_id = #{user.id} AND topic_voting_votes.archive = FALSE",)endenddiff --git a/plugins/discourse-topic-voting/spec/lib/topic_extension_spec.rb b/plugins/discourse-topic-voting/spec/lib/topic_extension_spec.rbindex 167368d6baa..6ba4107238d 100644--- a/plugins/discourse-topic-voting/spec/lib/topic_extension_spec.rb+++ b/plugins/discourse-topic-voting/spec/lib/topic_extension_spec.rb@@ -36,4 +36,32 @@ describe DiscourseTopicVoting::TopicExtension doexpect(topic2.reload.topic_vote_count.votes_count).to eq(1)endend++ describe "#who_voted" do+ it "returns recent active voters up to the requested limit" do+ DiscourseTopicVoting::Vote.create!(user: user, topic: topic, created_at: 2.hours.ago)+ DiscourseTopicVoting::Vote.create!(user: user2, topic: topic, created_at: 1.hour.ago)+ archived_user = Fabricate(:user)+ DiscourseTopicVoting::Vote.create!(+ user: archived_user,+ topic: topic,+ archive: true,+ created_at: Time.zone.now,+ )++ expect(topic.who_voted(limit: 1)).to eq([user2])+ end+ end++ describe "topic associations" do+ it "keeps soft-deleted topics available from votes and vote counts" do+ vote = DiscourseTopicVoting::Vote.create!(user: user, topic: topic)+ topic_vote_count = DiscourseTopicVoting::TopicVoteCount.create!(topic: topic, votes_count: 1)++ topic.trash!++ expect(vote.reload.topic).to eq(topic)+ expect(topic_vote_count.reload.topic).to eq(topic)+ end+ endenddiff --git a/plugins/discourse-topic-voting/spec/lib/topic_query_spec.rb b/plugins/discourse-topic-voting/spec/lib/topic_query_spec.rbindex 4ad099f1148..bb9c48b0be2 100644--- a/plugins/discourse-topic-voting/spec/lib/topic_query_spec.rb+++ b/plugins/discourse-topic-voting/spec/lib/topic_query_spec.rb@@ -22,6 +22,13 @@ describe TopicQuery doendit "returns topics voted by user" do+ archived_topic = Fabricate(:topic, category: category1)+ DiscourseTopicVoting::Vote.create!(+ topic_id: archived_topic.id,+ user_id: user0.id,+ archive: true,+ )+expect(TopicQuery.new(user0, { state: "my_votes" }).list_latest.topics.map(&:id)).to eq([topic1.id],)diff --git a/plugins/discourse-topic-voting/spec/requests/lists_controller_spec.rb b/plugins/discourse-topic-voting/spec/requests/lists_controller_spec.rbindex 300988b166b..95ffddc4a96 100644--- a/plugins/discourse-topic-voting/spec/requests/lists_controller_spec.rb+++ b/plugins/discourse-topic-voting/spec/requests/lists_controller_spec.rb@@ -7,12 +7,14 @@ describe ListController dobefore { SiteSetting.topic_voting_enabled = true }it "allow anons to view votes" do+ archived_topic = Fabricate(:topic)DiscourseTopicVoting::Vote.create!(user: user, topic: topic)+ DiscourseTopicVoting::Vote.create!(user: user, topic: archived_topic, archive: true)get "/topics/voted-by/#{user.username}.json"- topic_json = response.parsed_body.dig("topic_list", "topics").first+ topic_ids = response.parsed_body.dig("topic_list", "topics").pluck("id")- expect(topic_json["id"]).to eq(topic.id)+ expect(topic_ids).to eq([topic.id])endit "returns a 404 when we don't show votes on profiles" dodiff --git a/plugins/discourse-topic-voting/spec/requests/votes_controller_spec.rb b/plugins/discourse-topic-voting/spec/requests/votes_controller_spec.rbindex fbbd90a8f9a..81b0470d934 100644--- a/plugins/discourse-topic-voting/spec/requests/votes_controller_spec.rb+++ b/plugins/discourse-topic-voting/spec/requests/votes_controller_spec.rb@@ -99,4 +99,37 @@ describe DiscourseTopicVoting::VotesController doexpect(payload["voter_id"]).to eq(user.id)expect(payload["vote_count"]).to eq(0)end++ it "limits who-voted previews to VOTE_PREVIEW_LIMIT users by default" do+ stub_const(DiscourseTopicVoting, "VOTER_PREVIEW_LIMIT", 10) do+ Fabricate+ .times(11, :user)+ .each { |voter| DiscourseTopicVoting::Vote.create!(user: voter, topic: topic) }++ get "/voting/who.json", params: { topic_id: topic.id }++ expect(response.status).to eq(200)+ expect(response.parsed_body.length).to eq(DiscourseTopicVoting::VOTER_PREVIEW_LIMIT)+ end+ end++ it "excludes archived votes and honors a smaller who-voted limit" do+ older_voter = Fabricate(:user)+ newer_voter = Fabricate(:user)+ archived_voter = Fabricate(:user)++ DiscourseTopicVoting::Vote.create!(user: older_voter, topic: topic, created_at: 2.hours.ago)+ DiscourseTopicVoting::Vote.create!(user: newer_voter, topic: topic, created_at: 1.hour.ago)+ DiscourseTopicVoting::Vote.create!(+ user: archived_voter,+ topic: topic,+ archive: true,+ created_at: Time.zone.now,+ )++ get "/voting/who.json", params: { topic_id: topic.id, limit: 1 }++ expect(response.status).to eq(200)+ expect(response.parsed_body.pluck("id")).to eq([newer_voter.id])+ endenddiff --git a/plugins/discourse-topic-voting/spec/system/voting_spec.rb b/plugins/discourse-topic-voting/spec/system/voting_spec.rbindex d8ae8146746..8254f4cf5e3 100644--- a/plugins/discourse-topic-voting/spec/system/voting_spec.rb+++ b/plugins/discourse-topic-voting/spec/system/voting_spec.rb@@ -205,6 +205,22 @@ RSpec.describe "Topic voting" dofind(".title-voting .voting-wrapper__count").clickexpect(page).to have_css(".voting-voters__empty")end++ it "uses the topic vote count for overflow text while only loading preview rows" do+ stub_const(DiscourseTopicVoting, "VOTER_PREVIEW_LIMIT", 10) do+ Fabricate+ .times(11, :user)+ .each { |user| DiscourseTopicVoting::Vote.create!(user: user, topic: voting_topic1) }+ voting_topic1.update_vote_count++ sign_in(admin)+ visit("/t/#{voting_topic1.slug}/#{voting_topic1.id}")++ find(".title-voting .voting-wrapper__count").click+ expect(page).to have_css(".voting-voters__avatar", count: 10)+ expect(page).to have_css(".voting-voters__overflow", text: "and 2 more...")+ end+ endendcontext "when viewing navigation tooltips" do