Search indexing must now be explicit

Removes use of callbacks to reindex of on create/update

In production, this would typically only need to be done post-deploy
since we’re indexing static content

Touches indexed_at when Page is indexed

Author: rossta

app/models/page/searchable.rb

@@ -6,8 +6,6 @@ module Searchable
     ConfigurationError = Class.new(Error)
 
     included do
-      after_create_commit :create_in_search_index
-      after_update_commit :update_in_search_index
       after_destroy_commit :remove_from_search_index
 
       scope :search, ->(query) do
@@ -57,6 +55,7 @@ def update_in_search_index
       transaction do
         remove_from_search_index
         create_in_search_index
+        touch(:indexed_at)
       end
     end
 
@@ -65,10 +64,6 @@ def remove_from_search_index
     end
 
     class_methods do
-      def refresh_search_index
-        find_each(&:update_in_search_index)
-      end
-
       def create_search_index(page)
         id, title, body = [:id, :title, :body_text].map { |attr| page.send(attr) }
         Rails.logger.info "[#{self}] Creating search index: #{id} #{title}"

spec/factories/pages.rb

@@ -18,5 +18,17 @@
 FactoryBot.define do
   factory :page do
     request_path { "/" + Faker::Internet.slug }
+
+    trait :published do
+      published_at { 1.day.ago }
+    end
+
+    trait :unpublished do
+      published_at { 1.day.from_now }
+    end
+
+    trait :indexed do
+      indexed_at { 1.day.ago }
+    end
   end
 end

spec/jobs/pages/refresh_search_index_job_spec.rb

@@ -2,8 +2,13 @@
 
 RSpec.describe Pages::RefreshSearchIndexJob, type: :job do
   it "doesn’t blow up" do
-    Page.upsert_collection_from_sitepress!(limit: 2)
+    page_1 = FactoryBot.create(:page, :published, request_path: "/articles/introducing-joy-of-rails")
+    page_2 = FactoryBot.create(:page, :published, request_path: "/articles/custom-color-schemes-with-ruby-on-rails")
+    page_3 = FactoryBot.create(:page, :unpublished, request_path: "/articles/joy-of-rails-2")
 
     described_class.perform_now
+
+    expect(Page.join_search_index).to include(page_1, page_2)
+    expect(Page.join_search_index).not_to include(page_3)
   end
 end

spec/models/page_spec.rb

@@ -24,34 +24,29 @@
     expect(page.resource).to eq Sitepress.site.get("/")
   end
 
-  describe ".refresh_search_index" do
-    it "doesn’t blow up" do
-      Page.find_or_create_by!(request_path: "/")
-
-      Page.refresh_search_index
-    end
-  end
-
   describe ".search" do
     it "allows searching for pages" do
-      page = Page.find_or_create_by!(request_path: "/")
+      page = FactoryBot.create(:page, :published, request_path: "/")
+      Pages::RefreshSearchIndexJob.perform_now
 
       expect(Page.search("Joy of Rails")).to include page
     end
 
     it "works after rebuilding index" do
-      page = Page.find_or_create_by!(request_path: "/")
+      page = FactoryBot.create(:page, :published, request_path: "/")
+      Pages::RefreshSearchIndexJob.perform_now
 
-      Page.refresh_search_index
+      Page.find_each(&:update_in_search_index)
 
       expect(Page.search("Joy of Rails")).to include page
     end
   end
 
   describe ".rank" do
     it "orders search results by rank" do
-      page_1 = Page.find_or_create_by!(request_path: "/articles/custom-color-schemes-with-ruby-on-rails")
-      page_2 = Page.find_or_create_by!(request_path: "/articles/mastering-custom-configuration-in-rails")
+      page_1 = FactoryBot.create(:page, :published, request_path: "/articles/custom-color-schemes-with-ruby-on-rails")
+      page_2 = FactoryBot.create(:page, :published, request_path: "/articles/mastering-custom-configuration-in-rails")
+      Pages::RefreshSearchIndexJob.perform_now
 
       search = Page.search("custom con*")
 
@@ -61,7 +56,8 @@
 
   describe ".with_snippets" do
     it "orders search results by rank" do
-      Page.find_or_create_by!(request_path: "/articles/custom-color-schemes-with-ruby-on-rails")
+      FactoryBot.create(:page, :published, request_path: "/articles/custom-color-schemes-with-ruby-on-rails")
+      Pages::RefreshSearchIndexJob.perform_now
 
       page = Page.search("Color*").with_snippets.first
 

spec/requests/search_spec.rb

@@ -35,7 +35,8 @@
     end
 
     it "renders the search results without query" do
-      Page.create!(request_path: "/pwa-showcase")
+      FactoryBot.create(:page, :published, request_path: "/pwa-showcase")
+      Pages::RefreshSearchIndexJob.perform_now
 
       get search_path
 
@@ -45,8 +46,9 @@
     end
 
     it "renders the search results with query as turbo stream" do
-      Page.create!(request_path: "/pwa-showcase")
-      Page.create!(request_path: "/articles/introducing-joy-of-rails")
+      FactoryBot.create(:page, :published, request_path: "/pwa-showcase")
+      FactoryBot.create(:page, :published, request_path: "/articles/introducing-joy-of-rails")
+      Pages::RefreshSearchIndexJob.perform_now
 
       get search_path(format: :turbo_stream), params: {query: "Progressive Web Apps"}
 
@@ -61,8 +63,9 @@
     end
 
     it "renders the search results with query" do
-      Page.create!(request_path: "/pwa-showcase")
-      Page.create!(request_path: "/articles/introducing-joy-of-rails")
+      FactoryBot.create(:page, :published, request_path: "/pwa-showcase")
+      FactoryBot.create(:page, :published, request_path: "/articles/introducing-joy-of-rails")
+      Pages::RefreshSearchIndexJob.perform_now
 
       post search_path, params: {query: "Progressive Web Apps"}
 

spec/system/searches_spec.rb

@@ -2,7 +2,8 @@
 
 RSpec.describe "Searches", type: :system do
   it "show search results" do
-    Page.create!(request_path: "/pwa-showcase")
+    FactoryBot.create(:page, :published, request_path: "/pwa-showcase")
+    Pages::RefreshSearchIndexJob.perform_now
 
     visit root_path