search-engine-for-typesense 30.1.6.13 → 30.1.6.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 687864490764b552a2e0a30095711766c1ce073dcb0de9538ecc710ae142aa31
-  data.tar.gz: 48aa2e8cdcc750685264e432e8bf3d74b6b61fb11a0e0220d42bd393d90a4e97
+  metadata.gz: 751fec345b2fe0e2e9290ffba4af92639a58fc7663d6cd78e09527ace07d5104
+  data.tar.gz: 3332605b4afa0d24b66c4f4f0ab5f7be4a6676765213bf9441b508fddc1c8f9f
 SHA512:
-  metadata.gz: 67a000ce3cfa475b57d6059c640ba42682747e32ed3f2ca680bd64f5b4f08f0def7aa205e5d1ba44df9004fc76899734602f0f395542af211962290706dfeb3e
-  data.tar.gz: 1aa9dab69f9daad382d32e9d291d0d3226b057363a0da981e77b6b595a92f516257f8776518813d01a6616c0ac823c6d5efe7f0d148473ef52d3043c37afb31d
+  metadata.gz: bdc7e4250b406a06004d532cd379a597866a1a5419c90697fd177692f6b8a31c682e7dbc1c1f3727a823190d95c6612022a64520bc88e3dd3cec9a98e555e7c9
+  data.tar.gz: 68f460a120e7763bb2353531b0fadbc3f1b4f642eafebcc6cecd2af6ec1423db936159f6cce586f74d47f4e10782e0e02dfaf3673caa1e94d037f0628dcd9844

data/lib/search_engine/errors.rb

@@ -131,7 +131,8 @@ module SearchEngine
     # returns a non-ok status. Aborting the block prevents the alias swap,
     # keeping the previous (fully-indexed) physical collection active.
     #
-    # The partially-indexed new physical is left intact for inspection.
+    # The partially-indexed new physical is automatically cleaned up by
+    # the +ensure+ block in {Schema.apply!}.
     class IndexationAborted < Error
       # @return [Hash] the indexation result hash (:status, :docs_total, etc.)
       attr_reader :result

data/lib/search_engine/schema.rb

@@ -156,9 +156,10 @@ module SearchEngine
       # The reindexing step can be provided via an optional block (yielded with the new
       # physical name). If no block is given, and the klass responds to
       # `reindex_all_to(physical_name)`, that method will be called. If neither is available,
-      # an ArgumentError is raised and no alias swap occurs. If reindexing fails, the
-      # newly created physical is left intact for inspection; retention cleanup only runs
-      # after a successful alias swap.
+      # an ArgumentError is raised and no alias swap occurs. If reindexing fails or
+      # is interrupted, the newly created physical collection is automatically deleted
+      # to prevent orphan accumulation. Retention cleanup only runs after a successful
+      # alias swap.
       #
       # @param klass [Class] model class inheriting from {SearchEngine::Base}
       # @param client [SearchEngine::Client] optional client wrapper (for tests)
@@ -168,8 +169,12 @@ module SearchEngine
       # @raise [SearchEngine::Errors::Api, ArgumentError]
       # @see `https://nikita-shkoda.mintlify.app/projects/search-engine-for-typesense/v30.1/schema#lifecycle`
       # @see `https://typesense.org/docs/latest/api/collections.html`
-      def apply!(klass, client: nil, force_rebuild: false)
+      def apply!(klass, client: nil, force_rebuild: false) # rubocop:disable Metrics/MethodLength
         client ||= SearchEngine.client
+        new_physical = nil
+        physical_created = false
+        apply_succeeded = false
+
         # Optimization: Try in-place update first if not forced to rebuild.
         # If update! returns true, the schema is synced (either no changes or successfully patched).
         if !force_rebuild && update!(klass, client: client)
@@ -178,6 +183,7 @@ module SearchEngine
           # Resolve current physical to return consistent result
           physical = client.resolve_alias(logical) || logical
 
+          apply_succeeded = true
           return update_result_payload(logical, physical)
         end
 
@@ -203,6 +209,7 @@ module SearchEngine
         end
 
         client.create_collection(create_schema)
+        physical_created = true
 
         if block_given?
           yield new_physical
@@ -216,6 +223,7 @@ module SearchEngine
         current_after_reindex = client.resolve_alias(logical)
         swapped = current_after_reindex != new_physical
         client.upsert_alias(logical, new_physical) if swapped
+        apply_succeeded = true
 
         # Retention cleanup
         _, dropped = enforce_retention!(logical, new_physical, client: client, keep_last: effective_keep_last(klass))
@@ -245,6 +253,8 @@ module SearchEngine
           dropped_physicals: dropped,
           action: :rebuild
         }
+      ensure
+        cleanup_interrupted_physical!(new_physical, client) if physical_created && !apply_succeeded
       end
 
       # Roll back the alias for the given klass to the previous retained physical collection.
@@ -390,6 +400,32 @@ module SearchEngine
 
       private
 
+      # Best-effort cleanup of a physical collection left behind by an interrupted
+      # or failed {.apply!}. Rescues all errors so it never masks the original
+      # exception. If the delete itself fails, a warning directs users to
+      # {.prune_orphans!} as a fallback.
+      #
+      # @param physical_name [String, nil] the physical collection to remove
+      # @param client [SearchEngine::Client, nil]
+      # @return [void]
+      def cleanup_interrupted_physical!(physical_name, client)
+        return if physical_name.nil? || client.nil?
+
+        client.delete_collection(physical_name, timeout_ms: 60_000)
+
+        if defined?(ActiveSupport::Notifications)
+          SearchEngine::Instrumentation.instrument(
+            'search_engine.schema.cleanup_interrupted',
+            physical: physical_name, status: :ok
+          ) {}
+        end
+      rescue StandardError => error
+        warn(
+          'SearchEngine::Schema — failed to clean up interrupted physical ' \
+          "'#{physical_name}': #{error.message}. Run prune_orphans! to remove it."
+        )
+      end
+
       # Generate a new physical name using UTC timestamp + 3-digit sequence.
       # Example: "products_20250131_235959_001"
       def generate_physical_name(logical, client:)

data/lib/search_engine/version.rb

@@ -3,5 +3,5 @@
 module SearchEngine
   # Current gem version.
   # @return [String]
-  VERSION = '30.1.6.13'
+  VERSION = '30.1.6.14'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: search-engine-for-typesense
 version: !ruby/object:Gem::Version
-  version: 30.1.6.13
+  version: 30.1.6.14
 platform: ruby
 authors:
 - Nikita Shkoda