full_search 0.4.4 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99b631f72162065698bc187ad0b88cb7602cbead185b5c82209db713774e763d
-  data.tar.gz: 5e1dd5a0782e69cba81b0b2c8f32170046f4c0e3ad55debb063837117285a559
+  metadata.gz: ffdca4041a68a79686da2b8d636b3feadb88d39fd6ca2ff8f3c6ec955d52355c
+  data.tar.gz: 8438b904a538c0d8c8e0250bf751209b44f8a095aacfc1089cb180a5cbb21d8f
 SHA512:
-  metadata.gz: 146763f433fba78ed55b6a638b1d8a80bed0ea886daf294ff8e9389d09efef104b7ae6729d8897ee3ea267a4d38cf5d9956e691f4524da4a0861df6827c909ba
-  data.tar.gz: 65c5e59005e1730e12fadda9126b397a5fffdef462bcda088e7f14259b3635d1df7356d91dd23ebb312e6403489bf461b6088fc29a68b86b38fdbb80c4786ac2
+  metadata.gz: 447a5e7b51909e3098a38439935facf534ad7a97c84eb399af7fbd5e844c966787ac74651a58993000d12b0c18d3a6851fe3ea1e32b854629ff97b5c9e1906a0
+  data.tar.gz: d43d646f9e95ad6bc8d4425c8601b9c5f2695f106965cba1b53881cf8e155581a3421055f1b6babc0468aaf0a02c589e1e615f95dfecb42cd776adebae320bb5

data/lib/full_search/bulk_import.rb

@@ -19,6 +19,19 @@ module FullSearch
         models_in_bulk_import.delete(model)
         FullSearch::Index.create_triggers!(model)
         FullSearch::BackfillJob.perform_later(model.name)
+      rescue => e
+        # Triggers are still dropped at this point; the FTS index will rot on
+        # every subsequent write. Retry once, then raise loudly so the caller
+        # knows the index is compromised instead of failing silent.
+        retry_count = (Thread.current[:_fs_bulk_import_retry] ||= 0)
+        if retry_count < 1
+          Thread.current[:_fs_bulk_import_retry] = retry_count + 1
+          retry
+        end
+        raise FullSearch::TriggerRestoreError,
+          "Failed to restore FTS triggers for #{model.table_name} after bulk import: #{e.message}"
+      ensure
+        Thread.current[:_fs_bulk_import_retry] = nil
       end
 
       def bulk_importing?(model)

data/lib/full_search/errors.rb

@@ -10,4 +10,5 @@ module FullSearch
   class UnsupportedDatabaseError < Error; end
   class MissingTableError < Error; end
   class InvalidQueryError < Error; end
+  class TriggerRestoreError < Error; end
 end

data/lib/full_search/index.rb

@@ -184,6 +184,7 @@ module FullSearch
         drop_fts_table_safely!(fts_table_name(model))
         drop_fts_table_safely!(trigram_table_name(model))
       end
+
       # Drops an FTS5 virtual table, recovering from corruption where a bare
       # DROP TABLE IF EXISTS raises "invalid fts5 file format" because the
       # shadow tables were tampered with out-of-band. When that happens we
@@ -266,6 +267,22 @@ module FullSearch
         ).any?
       end
 
+      def missing_triggers?(model)
+        return false if FullSearch.bulk_importing?(model)
+        return false unless model_table_exists?(model)
+        return false unless table_exists?(model)
+
+        IndexCache.fetch("missing_triggers:#{model.table_name}") do
+          existing = connection.execute(
+            "SELECT name FROM sqlite_master WHERE type='trigger' AND tbl_name=#{q(model.table_name)}"
+          ).map { |r| r["name"] }
+
+          expected = trigger_names(model)
+          expected += trigram_trigger_names(model) if trigram_table_needed?(model)
+          (expected - existing).any?
+        end
+      end
+
       private
 
       def connection
@@ -289,9 +306,11 @@ module FullSearch
       end
 
       def model_table_exists?(model)
-        connection.execute(
-          "SELECT name FROM sqlite_master WHERE type='table' AND name=#{q(model.table_name)} LIMIT 1"
-        ).any?
+        IndexCache.fetch("model_table_exists:#{model.table_name}") do
+          connection.execute(
+            "SELECT name FROM sqlite_master WHERE type='table' AND name=#{q(model.table_name)} LIMIT 1"
+          ).any?
+        end
       end
 
       def table_exists?(model)
@@ -353,16 +372,7 @@ module FullSearch
 
       def ensure_triggers!(model)
         return if FullSearch.bulk_importing?(model)
-
-        existing = connection.execute(
-          "SELECT name FROM sqlite_master WHERE type='trigger' AND tbl_name=#{q(model.table_name)}"
-        ).map { |r| r["name"] }
-
-        expected = trigger_names(model)
-        expected += trigram_trigger_names(model) if trigram_table_needed?(model)
-        return if (expected - existing).empty? && (existing - expected).empty?
-
-        rebuild!(model)
+        rebuild!(model) if missing_triggers?(model)
       end
 
       def trigger_names(model)
@@ -377,6 +387,8 @@ module FullSearch
         %W[#{base}_ai #{base}_ad #{base}_au]
       end
 
+      private
+
       def insert_trigger_sql(model)
         dsl = model.full_search_dsl
         cols = dsl.fields + dsl.filters + extra_columns(model)

data/lib/full_search/multi_search.rb

@@ -12,40 +12,42 @@ module FullSearch
     end
 
     def call
-      searched = groups.map do |group|
-        model = fetch(group, :model)
-        raise FullSearch::NotConfiguredError, "#{model} is not full_search configured" unless model.full_search_dsl
+      IndexCache.with_cache do
+        searched = groups.map do |group|
+          model = fetch(group, :model)
+          raise FullSearch::NotConfiguredError, "#{model} is not full_search configured" unless model.full_search_dsl
 
-        filters = group[:filters] || {}
-        limit = positive_integer(group[:limit], 8)
-        offset = positive_integer(group[:offset], 0)
-        raw_limit = limit + 1
+          filters = group[:filters] || {}
+          limit = positive_integer(group[:limit], 8)
+          offset = positive_integer(group[:offset], 0)
+          raw_limit = limit + 1
 
-        relation = model.full_search(
-          query,
-          filters: filters,
-          limit: raw_limit,
-          offset: offset,
-          highlight: group[:highlight],
-          highlight_fields: group[:highlight_fields],
-          matching_strategy: group[:matching_strategy],
-          per_strategy_limit: group[:per_strategy_limit],
-          scope: group[:scope],
-          includes: group[:includes]
-        )
+          relation = model.full_search(
+            query,
+            filters: filters,
+            limit: raw_limit,
+            offset: offset,
+            highlight: group[:highlight],
+            highlight_fields: group[:highlight_fields],
+            matching_strategy: group[:matching_strategy],
+            per_strategy_limit: group[:per_strategy_limit],
+            scope: group[:scope],
+            includes: group[:includes]
+          )
 
-        records = relation.to_a
-        has_more = records.size > limit
-        records = records.first(limit) if has_more
+          records = relation.to_a
+          has_more = records.size > limit
+          records = records.first(limit) if has_more
 
-        group.slice(:key, :label, :icon, :model).merge(
-          results: records,
-          has_more: has_more,
-          total_count: records.size
-        )
-      end
+          group.slice(:key, :label, :icon, :model).merge(
+            results: records,
+            has_more: has_more,
+            total_count: records.size
+          )
+        end
 
-      {groups: searched, total_count: searched.sum { |g| g[:total_count] }}
+        {groups: searched, total_count: searched.sum { |g| g[:total_count] }}
+      end
     end
 
     private

data/lib/full_search/once_rebuilt.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module FullSearch
+  module OnceRebuilt
+    class << self
+      def per_test_case(*models)
+        models = FullSearch.models.to_a if models.empty?
+        unless already_rebuilt?(models)
+          rebuild_models!(models)
+          mark_rebuilt!(models)
+        end
+
+        yield if block_given?
+      end
+
+      def clear!
+        @rebuilt = Set.new
+      end
+
+      private
+
+      def already_rebuilt?(models)
+        keys = models.map { |model| cache_key(model) }
+        @rebuilt ||= Set.new
+        keys.all? { |key| @rebuilt.include?(key) }
+      end
+
+      def mark_rebuilt!(models)
+        @rebuilt ||= Set.new
+        models.each { |model| @rebuilt << cache_key(model) }
+      end
+
+      def cache_key(model)
+        [
+          model.connection_db_config.database,
+          model.table_name,
+          model.full_search_dsl&.config_hash,
+          model.connection_db_config.schema_cache_path
+        ].compact.join(":")
+      end
+
+      include FullSearch::TestHelpers
+
+      def rebuild_models!(models)
+        models.each { |model| rebuild_full_search_index(model) }
+      end
+    end
+  end
+end

data/lib/full_search/search.rb

@@ -92,6 +92,21 @@ module FullSearch
         raise MissingTableError, "FTS table `#{FullSearch::Index.fts_table_name(model)}` does not exist. Run `bin/rails full_search:prepare` to create it."
       end
 
+      if FullSearch::Index.missing_triggers?(model)
+        if FullSearch.config.auto_rebuild_on_stale_query
+          FullSearch::Index.rebuild!(model)
+          return
+        end
+
+        case FullSearch.config.stale_query_behavior
+        when :raise
+          raise ConfigChangedError, "FTS triggers for #{model.table_name} are missing; run full_search:rebuild"
+        when :log_and_fallback
+          Rails.logger.warn("[full_search] FTS triggers for #{model.table_name} are missing; results may be incomplete")
+        end
+        return
+      end
+
       stored = begin
         FullSearch::Index.stored_config_hash(model)
       rescue ActiveRecord::StatementInvalid

data/lib/full_search/test_helpers.rb

@@ -54,6 +54,10 @@ module FullSearch
       end
     end
 
+    def once_full_search_rebuilt(*models, &block)
+      FullSearch::OnceRebuilt.per_test_case(*models, &block)
+    end
+
     def with_full_search_rebuild(model)
       model = resolve_full_search_model(model)
       rebuild_full_search_index(model)

data/lib/full_search/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FullSearch
-  VERSION = "0.4.4"
+  VERSION = "0.4.6"
 end

data/lib/full_search.rb

@@ -30,6 +30,7 @@ require "full_search/backfill_job"
 require "full_search/test_helpers"
 require "full_search/multi_search"
 require "full_search/schema_dumper_patch"
+require "full_search/once_rebuilt"
 
 ActiveSupport.on_load(:active_record) do
   include FullSearch::Model

data/lib/tasks/full_search.rake

@@ -105,7 +105,9 @@ namespace :full_search do
         ""
       end
 
-      puts "#{model.table_name}: #{status}#{drift_info}"
+      trigger_info = FullSearch::Index.missing_triggers?(model) ? " | MISSING TRIGGERS" : ""
+
+      puts "#{model.table_name}: #{status}#{drift_info}#{trigger_info}"
     end
   end
 
@@ -120,6 +122,10 @@ namespace :full_search do
         next
       end
 
+      if FullSearch::Index.missing_triggers?(model)
+        unhealthy << "#{model.table_name}: missing FTS triggers"
+      end
+
       stored = FullSearch::Index.stored_config_hash(model)
       current = model.full_search_dsl.config_hash
       if stored != current

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: full_search
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.6
 platform: ruby
 authors:
 - Ben D'Angelo
@@ -155,6 +155,7 @@ files:
 - lib/full_search/instrumentation.rb
 - lib/full_search/model.rb
 - lib/full_search/multi_search.rb
+- lib/full_search/once_rebuilt.rb
 - lib/full_search/optimize_job.rb
 - lib/full_search/query_parser.rb
 - lib/full_search/quoting.rb
@@ -188,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.15
 specification_version: 4
 summary: SQLite FTS5 full-text search for Rails/ActiveRecord
 test_files: []