Guard search indexing with searchable? check

Only index cards if they are `published?`, using a new method
`searchable?` that is implemented on both Card and Comment. This
prevents draft cards from being indexed.

Note that comments can only be created on published cards, so
`Comment#searchable` returns `true`.

When drafts are published, the existing `update_in_search_index`
callback creates the record via `upsert!`, or else ensures unpublished
records are removed from the index.

Author: flavorjones

app/models/card/searchable.rb

@@ -25,4 +25,8 @@ def search_card_id
   def search_board_id
     board_id
   end
+
+  def searchable?
+    published?
+  end
 end

app/models/comment/searchable.rb

@@ -20,4 +20,8 @@ def search_card_id
   def search_board_id
     card.board_id
   end
+
+  def searchable?
+    true
+  end
 end

app/models/concerns/searchable.rb

@@ -15,11 +15,17 @@ def reindex
 
   private
     def create_in_search_index
-      search_record_class.create!(search_record_attributes)
+      if searchable?
+        search_record_class.create!(search_record_attributes)
+      end
     end
 
     def update_in_search_index
-      search_record_class.upsert!(search_record_attributes)
+      if searchable?
+        search_record_class.upsert!(search_record_attributes)
+      else
+        remove_from_search_index
+      end
     end
 
     def remove_from_search_index

test/models/card/searchable_test.rb

@@ -78,4 +78,46 @@ class Card::SearchableTest < ActiveSupport::TestCase
       assert_equal 0, fts_count, "FTS entry should be deleted"
     end
   end
+
+  test "updating a draft card does not index it" do
+    search_record_class = Search::Record.for(@user.account_id)
+
+    card = @board.cards.create!(title: "Draft card", creator: @user, status: "drafted")
+    assert_nil search_record_class.find_by(searchable_type: "Card", searchable_id: card.id)
+
+    card.update!(title: "Updated draft card")
+    assert_nil search_record_class.find_by(searchable_type: "Card", searchable_id: card.id),
+      "Draft card should not be indexed after update"
+
+    results = Card.mentioning("Updated", user: @user)
+    assert_not_includes results, card
+  end
+
+  test "publishing a draft card indexes it" do
+    search_record_class = Search::Record.for(@user.account_id)
+
+    card = @board.cards.create!(title: "Draft to publish", creator: @user, status: "drafted")
+    assert_nil search_record_class.find_by(searchable_type: "Card", searchable_id: card.id)
+
+    card.publish
+    search_record = search_record_class.find_by(searchable_type: "Card", searchable_id: card.id)
+    assert_not_nil search_record, "Published card should be indexed"
+    assert_equal card.id, search_record.card_id
+
+    results = Card.mentioning("publish", user: @user)
+    assert_includes results, card
+  end
+
+  test "unpublishing a draft card removes it from the search index" do
+    search_record_class = Search::Record.for(@user.account_id)
+
+    card = @board.cards.create!(title: "Draft to publish", creator: @user, status: "published")
+    assert_not_nil search_record_class.find_by(searchable_type: "Card", searchable_id: card.id)
+
+    card.update!(status: "drafted")
+
+    assert_nil search_record_class.find_by(searchable_type: "Card", searchable_id: card.id)
+    results = Card.mentioning("publish", user: @user)
+    assert_not_includes results, card
+  end
 end

test/models/search_test.rb

@@ -15,6 +15,11 @@ class SearchTest < ActiveSupport::TestCase
     results = Search::Record.for(@user.account_id).search("overflowing", user: @user)
     assert results.find { |it| it.card_id == comment_card.id && it.searchable_type == "Comment" }
 
+    # Drafted cards are excluded from search results
+    drafted_card = @board.cards.create!(title: "drafted searchable content", creator: @user, status: "drafted")
+    results = Search::Record.for(@user.account_id).search("drafted", user: @user)
+    assert_not results.find { |it| it.card_id == drafted_card.id }
+
     # Don't include inaccessible boards
     other_user = User.create!(name: "Other User", account: @account)
     inaccessible_board = Board.create!(name: "Inaccessible Board", account: @account, creator: other_user)