search-engine-for-typesense 30.1.6.12 → 30.1.6.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4596b142a6080ea8f9941f94611f32e9c461b3e9be51bb8e024e821c68ccd498
-  data.tar.gz: 0ea309bf811b27491de030021053c888d3c4fae0047292432a7f89a46f4ad722
+  metadata.gz: 687864490764b552a2e0a30095711766c1ce073dcb0de9538ecc710ae142aa31
+  data.tar.gz: 48aa2e8cdcc750685264e432e8bf3d74b6b61fb11a0e0220d42bd393d90a4e97
 SHA512:
-  metadata.gz: 3deec81bb58a05b8582c7081aa345cb4b1cc16b270d576ba22a0d03316590f1fdecbd885a7e5ed35842f909a3e0c278c77dce03232b81ec5091f33771fb5ec09
-  data.tar.gz: 5577de682690a81acb90e23563b5e7cdd26bfc4b90efe7c28b7d8bbe6224e5c804820829d2a7b9d5020e8941e6b022f5587c76675e5c871f6a660a4183cd23bc
+  metadata.gz: 67a000ce3cfa475b57d6059c640ba42682747e32ed3f2ca680bd64f5b4f08f0def7aa205e5d1ba44df9004fc76899734602f0f395542af211962290706dfeb3e
+  data.tar.gz: 1aa9dab69f9daad382d32e9d291d0d3226b057363a0da981e77b6b595a92f516257f8776518813d01a6616c0ac823c6d5efe7f0d148473ef52d3043c37afb31d

data/lib/search_engine/base/index_maintenance/schema.rb

@@ -129,6 +129,13 @@ module SearchEngine
             step&.close
           end
 
+          # Drop orphaned physical collections for this model's logical collection.
+          # @return [Hash] { dropped: Array<String>, kept: Array<String>, total_scanned: Integer }
+          def prune_orphans!
+            logical = respond_to?(:collection) ? collection.to_s : name.to_s
+            SearchEngine::Schema.prune_orphans!(logical: logical)
+          end
+
           def __se_retention_cleanup!(_logical:, _client:)
             SearchEngine::Schema.prune_history!(self)
           end

data/lib/search_engine/bulk.rb

@@ -60,6 +60,15 @@ module SearchEngine
         run!(mode: :reindex, targets: names, client: client)
       end
 
+      # Drop orphaned physical collections across all logical collections.
+      # Delegates to {SearchEngine::Schema.prune_orphans!}.
+      # @param client [SearchEngine::Client, nil]
+      # @param logical [String, nil] scope to a single logical collection
+      # @return [Hash] { dropped: Array<String>, kept: Array<String>, total_scanned: Integer }
+      def prune_orphans!(client: nil, logical: nil)
+        SearchEngine::Schema.prune_orphans!(client: client, logical: logical)
+      end
+
       private
 
       # @param mode [Symbol] :index | :reindex

data/lib/search_engine/client/services/collections.rb

@@ -57,6 +57,21 @@ module SearchEngine
           instrument(:get, path, (start ? (current_monotonic_ms - start) : 0.0), {}, request_token: start)
         end
 
+        # @return [Array<Hash>] list of aliases, each with :name and :collection_name
+        def list_aliases
+          start = current_monotonic_ms
+          path = '/aliases'
+
+          result = with_exception_mapping(:get, path, {}, start) do
+            typesense.aliases.retrieve
+          end
+
+          raw = symbolize_keys_deep(result)
+          Array(raw[:aliases])
+        ensure
+          instrument(:get, path, (start ? (current_monotonic_ms - start) : 0.0), {}, request_token: start)
+        end
+
         # @param alias_name [String]
         # @return [Hash] Typesense delete response, or { status: 404 } when alias not found
         def delete_alias(alias_name)

data/lib/search_engine/client.rb

@@ -61,6 +61,13 @@ module SearchEngine
       services.fetch(:collections).retrieve_schema(collection_name, timeout_ms: timeout_ms)
     end
 
+    # List all aliases defined on the Typesense server.
+    # @return [Array<Hash>] list of aliases, each with :name and :collection_name
+    # @see `https://typesense.org/docs/latest/api/aliases.html#list-all-aliases`
+    def list_aliases
+      services.fetch(:collections).list_aliases
+    end
+
     # Delete an alias by name. Returns { status: 404 } when alias not found.
     # @param alias_name [String]
     # @return [Hash]

data/lib/search_engine/schema.rb

@@ -345,6 +345,49 @@ module SearchEngine
         true
       end
 
+      # Drop orphaned physical collections that no alias points to.
+      #
+      # A physical collection is orphaned when it matches the timestamped naming
+      # pattern (`logical_YYYYMMDD_HHMMSS_###`) but is not the target of any
+      # alias. These typically accumulate from failed blue/green deployments
+      # where the alias swap never occurred.
+      #
+      # @param client [SearchEngine::Client, nil]
+      # @param logical [String, nil] scope to a single logical collection name; when nil, scans all
+      # @return [Hash] { dropped: Array<String>, kept: Array<String>, total_scanned: Integer }
+      def prune_orphans!(client: nil, logical: nil)
+        require 'set'
+        client ||= SearchEngine.client
+
+        meta_timeout = begin
+          t = SearchEngine.config.timeout_ms.to_i
+          [t, 10_000].max
+        rescue StandardError
+          10_000
+        end
+
+        all_collections = Array(client.list_collections(timeout_ms: meta_timeout))
+        all_names = all_collections.map { |c| (c[:name] || c['name']).to_s }
+
+        alias_targets = client.list_aliases.each_with_object(Set.new) do |a, set|
+          target = (a[:collection_name] || a['collection_name']).to_s
+          set.add(target) unless target.empty?
+        end
+
+        physical_re = if logical
+                        /\A#{Regexp.escape(logical)}_\d{8}_\d{6}_\d{3}\z/
+                      else
+                        /\A.+_\d{8}_\d{6}_\d{3}\z/
+                      end
+
+        physicals = all_names.select { |n| physical_re.match?(n) }
+        kept, orphaned = physicals.partition { |n| alias_targets.include?(n) }
+
+        orphaned.each { |name| client.delete_collection(name, timeout_ms: 60_000) }
+
+        { dropped: orphaned, kept: kept, total_scanned: all_names.size }
+      end
+
       private
 
       # Generate a new physical name using UTC timestamp + 3-digit sequence.

data/lib/search_engine/test/offline_client.rb

@@ -56,6 +56,10 @@ module SearchEngine
         nil
       end
 
+      def list_aliases
+        []
+      end
+
       def delete_alias(alias_name)
         {}
       end

data/lib/search_engine/version.rb

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

data/lib/tasks/search_engine.rake

@@ -132,6 +132,45 @@ namespace :search_engine do
       warn("schema:rollback failed: #{error.message}")
       Kernel.exit(1)
     end
+
+    desc "Prune orphaned physicals. Usage: rails 'search_engine:schema:prune_orphans[coll]'"
+    task :prune_orphans, [:collection] => :environment do |_t, args|
+      logical = nil
+      if args[:collection] && !args[:collection].to_s.strip.empty?
+        begin
+          klass = SearchEngine::Cli.resolve_collection!(args[:collection])
+          logical = klass.respond_to?(:collection) ? klass.collection.to_s : klass.name.to_s
+        rescue ArgumentError => error
+          warn("Error: #{error.message}")
+          print_schema_usage
+          Kernel.exit(1)
+        end
+      end
+
+      payload = { task: 'schema:prune_orphans', collection: logical || '(all)' }
+      result = nil
+      SearchEngine::Cli.with_task_instrumentation('schema:prune_orphans', payload) do
+        result = SearchEngine::Schema.prune_orphans!(logical: logical)
+      end
+
+      if SearchEngine::Cli.json_output?
+        puts(JSON.generate({ status: 'ok' }.merge(result)))
+      else
+        puts("Scanned: #{result[:total_scanned]} collections")
+        puts("Kept (alias targets): #{result[:kept].size}")
+        if result[:dropped].empty?
+          puts('No orphaned physicals found.')
+        else
+          puts("Dropped #{result[:dropped].size} orphaned physical(s):")
+          result[:dropped].each { |name| puts("  - #{name}") }
+        end
+      end
+
+      Kernel.exit(0)
+    rescue StandardError => error
+      warn("schema:prune_orphans failed: #{error.message}")
+      Kernel.exit(1)
+    end
   end
 
   # ------------------------- Index tasks -------------------------

metadata

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