full_search 0.4.3 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 894bce4229c00412829f531fbb35c78a3b9a3b4ac869ddc23e67421d1abc773b
-  data.tar.gz: 3a9504c246aced49dcef0b9991efddf53fdbff873c0ddf7e6781e6551550af71
+  metadata.gz: fccc79c0dbfc8eeb24424e156c9be822470e2bbc3ecfdb75539f8a70010b3d38
+  data.tar.gz: 3e50db78f978cb095834dd9f0d58802dfb1de69f9c80e04fc6c18cbdf1d9ccef
 SHA512:
-  metadata.gz: aea83a66af28bf651dd022c63725d012dea6783e57125c5febbf7e48582fe4ac8990cd30af6d9c72bc9544ae3fbf925e84c03a060c549a1b79aaf65668bb2705
-  data.tar.gz: 9d9d227f097f3c1b5629aa6ced3768e2cb99db6fdafa28ca15ce641afac2ed4af7f15892d6b7fc87316246eb1be7fd02cdd81db1d1f16407fcf2f8a574d20af6
+  metadata.gz: 239eb848fe5631b1a8212840246ccd6be8387642b8f269687ae5052dc765afd25ccb49bd55c395b760aa772eb2da696bf786a2155f451326dbd8908da4f95532
+  data.tar.gz: bd01ae3b672adc80f97c5ee70699444d773cb2a66c8ab2b98133f3528cba5099b3750fea9682cd6cdb4315e0fac17b7781b720a60f6c79519bf1857b78324aa4

data/lib/full_search/index.rb

@@ -71,8 +71,8 @@ module FullSearch
         with_rebuild_lock(model) do
           FullSearch::Instrumentation.instrument("rebuild", model: model.name) do
             drop_triggers!(model)
-            conn.execute("DROP TABLE IF EXISTS #{qt(fts_table_name(model))};")
-            conn.execute("DROP TABLE IF EXISTS #{qt(trigram_table_name(model))};")
+            drop_fts_table_safely!(fts_table_name(model))
+            drop_fts_table_safely!(trigram_table_name(model))
             conn.execute(create_virtual_table_sql(model))
             if trigram_table_needed?(model)
               FullSearch::Typo.warn_unsupported!(model) unless FullSearch::Typo.supported?(model)
@@ -181,8 +181,33 @@ module FullSearch
         verified_tables.delete(model.table_name)
         sqlite!(model)
         drop_triggers!(model)
-        connection.execute("DROP TABLE IF EXISTS #{qt(fts_table_name(model))};")
-        connection.execute("DROP TABLE IF EXISTS #{qt(trigram_table_name(model))};")
+        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
+      # drop the shadow tables directly, then drop the (now-empty) virtual
+      # table wrapper, so the caller can recreate a clean index.
+      def drop_fts_table_safely!(table_name)
+        connection.execute("DROP TABLE IF EXISTS #{qt(table_name)};")
+      rescue ActiveRecord::StatementInvalid => e
+        raise unless e.message.match?(/fts5: corruption|invalid fts5 file format|malformed database schema/i)
+
+        drop_shadow_tables!(table_name)
+        connection.execute("DROP TABLE IF EXISTS #{qt(table_name)};")
+      end
+
+      # FTS5 stores its index data in a fixed set of shadow tables named
+      # <table>_content, <table>_data, <table>_idx, <table>_docsize and
+      # <table>_config. Dropping these lets SQLite recover a virtual table
+      # that is otherwise undroppable due to internal corruption.
+      def drop_shadow_tables!(table_name)
+        %w[content data idx docsize config].each do |suffix|
+          shadow = "#{table_name}_#{suffix}"
+          connection.execute("DROP TABLE IF EXISTS #{qt(shadow)};")
+        end
       end
 
       def fts_table_name(model)

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/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.3"
+  VERSION = "0.4.5"
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: full_search
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.5
 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: []