Add ability to star/bookmark topics

This is a quicker way to watch something than adding proper/notes tags,
and gmail similarly supports both. Basically allows users to follow
something simply with 1 click.

Author: dutow

app/assets/stylesheets/components/topics.css

@@ -193,6 +193,20 @@
   }
 }
 
+.activity-star {
+  background-color: var(--color-bg-activity-team);
+  .topic-icon-badge {
+    background-color: var(--color-bg-activity-team);
+  }
+}
+
+.activity-star.is-starred {
+  background-color: var(--color-bg-activity-user);
+  .topic-icon-badge {
+    background-color: var(--color-bg-activity-user);
+  }
+}
+
 .is-hidden {
   display: none !important;
 }

app/assets/stylesheets/layouts/topic-view.css

@@ -282,3 +282,9 @@
   color: var(--color-text-muted);
   font-size: var(--font-size-sm);
 }
+
+.topic-title-with-star {
+  display: flex;
+  align-items: center;
+  gap: var(--spacing-3);
+}

app/controllers/topics_controller.rb

@@ -1,6 +1,6 @@
 class TopicsController < ApplicationController
-  before_action :set_topic, only: [:show, :aware, :read_all]
-  before_action :require_authentication, only: [:aware, :aware_bulk, :aware_all, :read_all]
+  before_action :set_topic, only: [:show, :aware, :read_all, :star, :unstar]
+  before_action :require_authentication, only: [:aware, :aware_bulk, :aware_all, :read_all, :star, :unstar]
   before_action :require_team_membership, only: [:index, :new_topics_count]
 
   def index
@@ -45,7 +45,10 @@ def show
     build_participants_sidebar_data(messages_scope)
     build_thread_outline(messages_scope)
     load_commitfest_sidebar
-    load_notes if user_signed_in?
+    if user_signed_in?
+      load_notes
+      load_star_state
+    end
   end
 
   def aware
@@ -93,6 +96,30 @@ def read_all
     end
   end
 
+  def star
+    TopicStar.create!(user: current_user, topic: @topic)
+    respond_to do |format|
+      format.turbo_stream { render :update_star_state }
+      format.json { render json: { starred: true } }
+      format.html { redirect_to topic_path(@topic) }
+    end
+  rescue ActiveRecord::RecordNotUnique
+    respond_to do |format|
+      format.turbo_stream { render :update_star_state }
+      format.json { render json: { starred: true } }
+      format.html { redirect_to topic_path(@topic) }
+    end
+  end
+
+  def unstar
+    TopicStar.where(user: current_user, topic: @topic).destroy_all
+    respond_to do |format|
+      format.turbo_stream { render :update_star_state }
+      format.json { render json: { starred: false } }
+      format.html { redirect_to topic_path(@topic) }
+    end
+  end
+
   def search
     @search_query = params[:q].to_s.strip
 
@@ -123,6 +150,7 @@ def user_state
     preload_topic_states
     preload_note_counts
     preload_participation_flags
+    preload_star_counts
 
     payload = topic_ids.index_with do |tid|
       state = @topic_states[tid] || {}
@@ -139,6 +167,7 @@ def user_state
         team: participation[:team],
         aliases_count: Array(participation[:aliases]).size
       }
+      star_data = @topic_star_data&.dig(tid) || { starred_by_me: false, team_starrers: [] }
       {
         status: state[:status],
         progress: state[:progress],
@@ -147,7 +176,8 @@ def user_state
         aware_until: state[:aware_until],
         team_readers: readers,
         note_count: @topic_note_counts&.dig(tid).to_i,
-        participation: participation_payload
+        participation: participation_payload,
+        star: star_data
       }
     end
 
@@ -164,6 +194,7 @@ def user_state_frame
     preload_note_counts
     preload_participation_flags
     preload_commitfest_summaries
+    preload_star_counts
 
     respond_to do |format|
       format.turbo_stream
@@ -360,6 +391,44 @@ def preload_note_counts
                               .count
   end
 
+  def preload_star_counts
+    topic_ids = @topics.map(&:id)
+    return if topic_ids.empty?
+    return unless user_signed_in?
+
+    my_stars = TopicStar.where(user: current_user, topic_id: topic_ids)
+                        .pluck(:topic_id)
+                        .to_set
+
+    team_ids = TeamMember.where(user_id: current_user.id).pluck(:team_id)
+    team_stars = {}
+
+    if team_ids.any?
+      teammate_ids = TeamMember.where(team_id: team_ids)
+                               .where.not(user_id: current_user.id)
+                               .pluck(:user_id)
+
+      if teammate_ids.any?
+        stars = TopicStar.where(user_id: teammate_ids, topic_id: topic_ids)
+                         .includes(user: { person: :default_alias })
+
+        stars.each do |star|
+          team_stars[star.topic_id] ||= []
+          alias_record = star.user.person&.default_alias || star.user.aliases&.first
+          team_stars[star.topic_id] << alias_record if alias_record
+        end
+      end
+    end
+
+    @topic_star_data = {}
+    @topics.each do |topic|
+      @topic_star_data[topic.id] = {
+        starred_by_me: my_stars.include?(topic.id),
+        team_starrers: team_stars[topic.id] || []
+      }
+    end
+  end
+
   def load_visible_tags
     @available_note_tags = NoteTag.joins(:note)
                                   .merge(Note.active.visible_to(current_user))
@@ -553,6 +622,18 @@ def apply_filters(base_query)
         member_alias_ids = Alias.where(person_id: member_person_ids).select(:id)
         base_query = base_query.where(id: Message.where(sender_id: member_alias_ids).select(:topic_id))
       end
+    when "starred_by_me"
+      if current_user_id
+        base_query = base_query.joins(:topic_stars)
+                               .where(topic_stars: { user_id: current_user_id })
+      end
+    when "starred_by_team"
+      if team_id && current_user_id
+        member_ids = TeamMember.where(team_id: team_id).select(:user_id)
+        base_query = base_query.joins(:topic_stars)
+                               .where(topic_stars: { user_id: member_ids })
+                               .distinct
+      end
     end
     base_query
   end
@@ -663,6 +744,10 @@ def load_notes
     end
   end
 
+  def load_star_state
+    @is_starred = TopicStar.exists?(user: current_user, topic: @topic)
+  end
+
   def load_cached_search_results
     @viewing_since = viewing_since_param
     longpage = params[:longpage].to_i

app/models/topic.rb

@@ -5,7 +5,9 @@ class Topic < ApplicationRecord
   has_many :notes, dependent: :destroy
   has_many :commitfest_patch_topics, dependent: :destroy
   has_many :commitfest_patches, through: :commitfest_patch_topics
-  
+  has_many :topic_stars, dependent: :destroy
+  has_many :starring_users, through: :topic_stars, source: :user
+
   validates :title, presence: true
 
   def participant_count

app/models/topic_star.rb

@@ -0,0 +1,21 @@
+class TopicStar < ApplicationRecord
+  belongs_to :user
+  belongs_to :topic
+
+  validates :user_id, uniqueness: { scope: :topic_id }
+
+  def self.toggle_star(user:, topic:)
+    existing = find_by(user: user, topic: topic)
+    if existing
+      existing.destroy
+      false
+    else
+      create!(user: user, topic: topic)
+      true
+    end
+  end
+
+  def self.starred_by_user?(user:, topic:)
+    exists?(user: user, topic: topic)
+  end
+end

app/models/user.rb

@@ -11,6 +11,8 @@ class User < ApplicationRecord
   has_many :notes, foreign_key: :author_id
   has_many :note_edits, foreign_key: :editor_id
   has_many :activities
+  has_many :topic_stars, dependent: :destroy
+  has_many :starred_topics, through: :topic_stars, source: :topic
 
   scope :active, -> { where(deleted_at: nil) }
 

app/views/topics/_sidebar.html.slim

@@ -26,7 +26,9 @@
             li = link_to "New for me", topics_path(filter: "new_for_me")
             li = link_to "Started by me", topics_path(filter: "started_by_me")
             li = link_to "I posted here", topics_path(filter: "messaged_by_me")
+            li = link_to "Starred by me", topics_path(filter: "starred_by_me")
             - current_user.teams.each do |team|
+              li = link_to "#{team.name}: starred by team", topics_path(filter: "starred_by_team", team_id: team.id)
               li = link_to "#{team.name}: not yet read by team", topics_path(filter: "team_unread", team_id: team.id)
               li = link_to "#{team.name}: my teammates are reading", topics_path(filter: "team_reading_others", team_id: team.id)
               li = link_to "#{team.name}: my team is reading", topics_path(filter: "team_reading_any", team_id: team.id)

app/views/topics/_star_button.html.slim

@@ -0,0 +1,7 @@
+- starred = local_assigns[:starred] || false
+- star_path = starred ? unstar_topic_path(topic) : star_topic_path(topic)
+- method = starred ? :delete : :post
+- icon_class = starred ? "fa-solid fa-star" : "fa-regular fa-star"
+- tooltip = starred ? "Unstar" : "Star"
+= link_to star_path, method: method, data: { turbo_method: method, turbo_stream: true }, class: "topic-icon activity-star #{starred ? 'is-starred' : ''}", title: tooltip, id: dom_id(topic, "star_button") do
+  i class=icon_class

app/views/topics/_star_icon.html.slim

@@ -0,0 +1,24 @@
+- star_data = star_data || {}
+- starred_by_me = star_data[:starred_by_me] || false
+- team_starrers = star_data[:team_starrers] || []
+- total_count = (starred_by_me ? 1 : 0) + team_starrers.size
+- classes = ["topic-icon", "activity-star"]
+- classes << "is-hidden" if total_count.zero?
+- classes << "is-starred" if starred_by_me
+- icon_class = starred_by_me ? "fa-solid fa-star" : "fa-regular fa-star"
+div class=classes.join(" ") id=dom_id(topic, "stars") data-controller="hover-popover" data-hover-popover-delay-value="200" data-action="mouseenter->hover-popover#show mouseleave->hover-popover#scheduleHide"
+  i class=icon_class
+  - if total_count > 2
+    span.topic-icon-badge = total_count
+  - if starred_by_me || team_starrers.any?
+    .topic-icon-hover data-hover-popover-target="popover" data-action="mouseenter->hover-popover#show mouseleave->hover-popover#scheduleHide"
+      - if starred_by_me
+        - my_alias = current_user.person&.default_alias || current_user.aliases&.first
+        - if my_alias
+          - participant_stub = { alias: my_alias }
+          - role_label = my_alias.contributor_badge || "User"
+          = render partial: "participant_row", locals: { participant: participant_stub, avatar_size: 32, tooltip: "#{my_alias.name} (#{role_label})" }
+      - team_starrers.each do |alias_record|
+        - participant_stub = { alias: alias_record }
+        - role_label = alias_record.contributor_badge || "User"
+        = render partial: "participant_row", locals: { participant: participant_stub, avatar_size: 32, tooltip: "#{alias_record.name} (#{role_label})" }

app/views/topics/_status_cell.html.slim

@@ -1,5 +1,6 @@
 - status = state[:status] || "new"
 - status_class = "status-#{status}"
+- star_data = star_data || {}
 td.topic-title.status-border class=status_class id=dom_id(topic, "status_cell") data-label="Topic"
   - if status.to_s == "reading"
     - read_count = state[:read_count].to_i
@@ -9,6 +10,7 @@ td.topic-title.status-border class=status_class id=dom_id(topic, "status_cell")
       i.fa-solid.fa-envelope
       - if unread_count.positive?
         span.topic-icon-badge.topic-icon-badge-sup = unread_count
+  = render partial: "topics/star_icon", locals: { topic: topic, star_data: star_data }
   = render partial: "topics/note_icon", locals: { topic: topic, count: note_count.to_i }
   = render partial: "topics/team_readers_icon", locals: { topic: topic, readers: team_readers }
   - commitfest_summary = @commitfest_summaries&.dig(topic.id)