mongodb_meilisearch 1.3.0 → 2.0.0

data/lib/search/class_methods.rb

@@ -69,9 +69,15 @@ module Search
       class_index_name
     end
 
+    # @return [MeiliSearch::Index] the search-only search index for this class
+    def searchable_index
+      Search::Client.instance.search_client.index(search_index_name)
+    end
+
     # @return [MeiliSearch::Index] the search index for this class
-    def search_index
-      Search::Client.instance.index(search_index_name)
+    # in a form that can modify the index
+    def administratable_index
+      Search::Client.instance.admin_client.index(search_index_name)
     end
 
     # MeiliSearch allows you to define the ranking of search results. Alas, this is not based
@@ -96,7 +102,7 @@ module Search
     # @return [Hash] raw results directly from meilisearch-ruby gem
     #   This is a hash with paging information and more.
     def raw_search(search_string, options = search_options)
-      index = search_index
+      index = searchable_index
       index.search(search_string, options)
     end
 
@@ -251,9 +257,9 @@ module Search
     #      search_indexable_hash
     def update_documents(updated_documents, async: true)
       if async
-        search_index.update_documents(updated_documents, primary_search_key)
+        administratable_index.update_documents(updated_documents, primary_search_key)
       else
-        search_index.update_documents!(updated_documents, primary_search_key)
+        administratable_index.update_documents!(updated_documents, primary_search_key)
       end
     end
 
@@ -263,9 +269,9 @@ module Search
     def add_documents(new_documents, async: true)
       configure_attributes_and_index_if_needed!
       if async
-        search_index.add_documents(new_documents, primary_search_key)
+        administratable_index.add_documents(new_documents, primary_search_key)
       else
-        search_index.add_documents!(new_documents, primary_search_key)
+        administratable_index.add_documents!(new_documents, primary_search_key)
       end
     end
 
@@ -286,14 +292,14 @@ module Search
     # A convenience method that wraps MeiliSearch::Index#stats
     # See https://www.meilisearch.com/docs/reference/api/stats for more info
     def search_stats
-      search_index.stats
+      administratable_index.stats
     end
 
     # @return [Integer] the number of documents in the search index
     # as reported via stats.
     # See https://www.meilisearch.com/docs/reference/api/stats for more info
     def searchable_documents
-      search_index.number_of_documents
+      administratable_index.number_of_documents
     end
 
     # @return [Boolean] indicating if search ids should be prefixed with the class name
@@ -309,19 +315,19 @@ module Search
     # you should use this, you're probably mistaken.
     # @warning this will delete the index and all documents in it
     def delete_index!
-      search_index.delete_index
+      administratable_index.delete_index
     end
 
     # Asynchronously deletes all documents from the search index
     # regardless of what model they're associated with.
     def delete_all_documents
-      search_index.delete_all_documents
+      administratable_index.delete_all_documents
     end
 
     # Synchronously deletes all documents from the search index
     # regardless of what model they're associated with.
     def delete_all_documents!
-      search_index.delete_all_documents!
+      administratable_index.delete_all_documents!
     end
 
     # Asynchronously delete & reindex all instances of this class.
@@ -395,11 +401,11 @@ module Search
     # @return [Array] - an array of attributes configured as sortable
     # in the index.
     def meilisearch_sortable_attributes
-      @_meilisearch_sortable_attributes ||= search_index.get_sortable_attributes
+      @_meilisearch_sortable_attributes ||= administratable_index.get_sortable_attributes
     end
 
     def meilisearch_filterable_attributes
-      @_meilisearch_filterable_attributes ||= search_index.get_filterable_attributes
+      @_meilisearch_filterable_attributes ||= administratable_index.get_filterable_attributes
     end
 
     def reset_cached_data!
@@ -421,7 +427,7 @@ module Search
         # this is expected to happen the first time an instance
         # of a new model is saved.
         raise unless e.message.match?(/Index `\S+` not found\./)
-        Search::Client.instance.create_index(search_index_name)
+        Search::Client.instance.admin_client.create_index(search_index_name)
       end
 
       return if indexes_filterable_attributes.include?("object_class")
@@ -434,13 +440,13 @@ module Search
     # which may take time. Best to run this in a background job
     # for large datasets.
     def set_filterable_attributes(new_attributes = filterable_attributes)
-      search_index.update_filterable_attributes(new_attributes)
+      administratable_index.update_filterable_attributes(new_attributes)
     end
 
     def set_filterable_attributes!(new_attributes = filterable_attributes)
       # meilisearch-ruby doesn't provide a synchronous version of this
       task = set_filterable_attributes(new_attributes)
-      search_index.wait_for_task(task["taskUid"])
+      administratable_index.wait_for_task(task["taskUid"])
     end
 
     # Updates the sortable attributes in the search index.
@@ -448,13 +454,13 @@ module Search
     # which may take time. Best to run this in a background job
     # for large datasets.
     def set_sortable_attributes(new_attributes = sortable_attributes)
-      search_index.update_sortable_attributes(new_attributes)
+      administratable_index.update_sortable_attributes(new_attributes)
     end
 
     def set_sortable_attributes!(new_attributes = sortable_attributes)
       # meilisearch-ruby doesn't provide a synchronous version of this
       task = set_sortable_attributes(new_attributes)
-      search_index.wait_for_task(task["taskUid"])
+      administratable_index.wait_for_task(task["taskUid"])
     end
 
     private

data/lib/search/client.rb

@@ -1,42 +1,170 @@
 require "singleton"
+require "logger"
 
 module Search
   class Client
     include Singleton
-    attr_reader :client
+    attr_reader :admin_client, :search_client
+    attr_accessor :logger
 
     def initialize
+      @logger = default_logger
       if ENV.fetch("SEARCH_ENABLED", "true") == "true"
-        url = ENV.fetch("MEILISEARCH_URL")
-        # MEILISEARCH_API_KEY is for mongodb_meilisearch v1.2.1 & earlier
-        api_key = ENV.fetch("MEILI_MASTER_KEY") || ENV.fetch("MEILISEARCH_API_KEY")
-        timeout = ENV.fetch("MEILISEARCH_TIMEOUT", 10).to_i
-        max_retries = ENV.fetch("MEILISEARCH_MAX_RETRIES", 2).to_i
-        if url.present? && api_key.present?
-          @client = MeiliSearch::Client.new(url, api_key,
-                                            timeout: timeout,
-                                            max_retries: max_retries)
-        else
-          Rails.logger.warn("UNABLE TO CONFIGURE SEARCH. Check env vars.")
-          @client = nil
+        initialize_clients
+        # WARNING: ⚠ clients MAY be nil depending on what api keys were provided
+        # In this case rails logger warnings and/or errors will have already
+        # been created.
+        unless admin_client || search_client
+          raise Search::Errors::ConfigurationError.new(
+            "Unable to configure any MeliSearch clients. Check env vars."
+          )
         end
+      else
+        @logger.info("SEARCH_ENABLED is not \"true\" - mongodb_meilisearch NOT initialized")
       end
     end
 
+    # Indicates if there is a client available to
+    # administration OR searches.
     def enabled?
-      !@client.nil?
+      !@admin_client.nil? || !@search_client.nil?
+    end
+
+    # Indicates if there is a client available
+    # that has been configured with an admin key.
+    def admin_enabled?
+      !@admin_client.nil?
+    end
+
+    # @deprecated use search_client for searches
+    #   & admin_client for everything else
+    def client
+      @logger.info("Search::Client.instance.client is a deprecated method")
+      @admin_client || @search_client
     end
 
-    def method_missing(m, *args, &block)
-      if @client.respond_to? m.to_sym
-        @client.send(m, *args, &block)
+    def initialize_clients
+      # see what env vars they've configured
+      search_api_key = ENV.fetch("MEILISEARCH_SEARCH_KEY", nil)
+      admin_api_key  = ENV.fetch("MEILISEARCH_ADMIN_KEY", nil)
+      search_api_key = nil if search_api_key == ""
+      admin_api_key = nil if admin_api_key == ""
+
+      # if there is a master key (and it's valid) we're guaranteed to have
+      # default api keys we can use for search & admin
+      if search_api_key.nil? || admin_api_key.nil?
+        m_c = master_client
+        if m_c
+          default_keys = get_default_keys(m_c)
+          search_api_key ||= default_keys[:search]
+          admin_api_key ||= default_keys[:admin]
+        end
+      end
+
+      if !admin_api_key.nil?
+        @admin_client = initialize_new_client(
+          url: url,
+          api_key: admin_api_key,
+          timeout: timeout,
+          max_retries: max_retries
+        )
+        @logger.debug("initialized admin client with admin key: #{admin_api_key[0..5]}…")
       else
-        raise ArgumentError.new("Method `#{m}` doesn't exist in #{@client.inspect}.")
+        @logger.error("UNABLE TO CONFIGURE MEILISEARCH ADMINISTRATION CLIENT. Check env vars.")
+        @admin_client = nil
+      end
+
+      if !search_api_key.nil?
+        @search_client = initialize_new_client(
+          url: url,
+          api_key: search_api_key,
+          timeout: timeout,
+          max_retries: max_retries
+        )
+        @logger.debug("initialized search client with search key: #{search_api_key[0..5]}…")
+      else
+        @logger.error("UNABLE TO CONFIGURE GENERAL MEILISEARCH SEARCH CLIENT. Check env vars.")
+        @search_client = nil
+      end
+    rescue MeiliSearch::ApiError => e
+      @logger.error("MeiliSearch Api Error when attempting to list keys: #{e}")
+    end
+
+    def initialize_new_client(api_key:, url:, timeout:, max_retries:)
+      MeiliSearch::Client.new(url, api_key,
+                              timeout: timeout,
+                              max_retries: max_retries)
+    end
+
+    def master_client(master_api_key = nil)
+      master_api_key = nil if master_api_key == ""
+      master_api_key ||= ENV.fetch("MEILI_MASTER_KEY", nil)
+      if !url || !master_api_key
+
+        unless master_api_key
+          @logger.error(
+            "MEILI_MASTER_KEY is not set. Cannot create master client."
+          )
+        end
+
+        return nil
+      end
+
+      initialize_new_client(
+        url: url,
+        api_key: ENV.fetch("MEILI_MASTER_KEY"),
+        timeout: timeout,
+        max_retries: max_retries
+      )
+    end
+
+    def url
+      maybe_url = ENV.fetch("MEILISEARCH_URL", nil)
+      unless maybe_url
+        @logger.error(
+          "MEILI_MASTER_KEY is not set. Cannot create master client."
+        )
+      end
+      maybe_url
+    end
+
+    def timeout
+      ENV.fetch("MEILISEARCH_TIMEOUT", 10).to_i
+    end
+
+    def max_retries
+      ENV.fetch("MEILISEARCH_MAX_RETRIES", 2).to_i
+    end
+
+    def get_default_keys(m_c)
+      # NOTE: master_client /can/ return nil
+      if m_c.nil?
+        m_c = master_client
+      elsif m_c.is_a?(String)
+        m_c = master_client(m_c)
+      end
+
+      unless m_c
+        raise Search::Errors::ConfigurationError.new(
+          "Can't retrieve default keys without Master API Key & URL configured."
+        )
+      end
+      keys = m_c.keys
+      response = {search: nil, admin: nil}
+
+      keys&.[]("results")&.each do |hash|
+        if hash["name"]   == "Default Search API Key"
+          response[:search] = hash["key"]
+        elsif hash["name"] == "Default Admin API Key"
+          response[:admin]  = hash["key"]
+        end
       end
+      response
     end
 
-    def respond_to_missing?(method_name, include_private = false)
-      @client.respond_to?(method_name.to_sym) || super
+    def default_logger
+      in_rails = Module.constants.include?(:Rails)
+      in_rails ? Rails.logger : Logger.new($stdout)
     end
   end
 end

data/lib/search/errors.rb

@@ -0,0 +1,7 @@
+# lib/errors.rb
+
+module Search
+  module Errors
+    class ConfigurationError < StandardError; end
+  end
+end

data/lib/search/instance_methods.rb

@@ -3,7 +3,7 @@ module Search
     # Adds this record to the search index asynchronously
     def add_to_search
       self.class.configure_attributes_and_index_if_needed!
-      search_index.add_documents(
+      administratable_index.add_documents(
         [search_indexable_hash],
         primary_search_key.to_s
       )
@@ -12,7 +12,7 @@ module Search
     # Adds this record to the search index synchronously
     def add_to_search!
       self.class.configure_attributes_and_index_if_needed!
-      index     = search_index
+      index     = administratable_index
       documents = [search_indexable_hash]
       pk        = primary_search_key.to_s
       index.add_documents!(documents, pk)
@@ -20,7 +20,7 @@ module Search
 
     # Updates this record in the search index asynchronously
     def update_in_search
-      search_index.update_documents(
+      administratable_index.update_documents(
         [search_indexable_hash],
         primary_search_key
       )
@@ -28,7 +28,7 @@ module Search
 
     # Updates this record in the search index synchronously
     def update_in_search!
-      search_index.update_documents!(
+      administratable_index.update_documents!(
         [search_indexable_hash],
         primary_search_key
       )
@@ -36,12 +36,12 @@ module Search
 
     # Removes this record from the search asynchronously
     def remove_from_search
-      search_index.delete_document(send(primary_search_key).to_s)
+      administratable_index.delete_document(send(primary_search_key).to_s)
     end
 
     # Removes this record from the search synchronously
     def remove_from_search!
-      search_index.delete_document!(send(primary_search_key).to_s)
+      administratable_index.delete_document!(send(primary_search_key).to_s)
     end
 
     def searchable_attributes
@@ -60,6 +60,7 @@ module Search
     # _unless_ one is already defined. This gem relies on "object_class" being present
     # in returned results
     def search_indexable_hash
+      return @_search_indexable_hash if defined?(@_search_indexable_hash)
       klass = self.class
       # the to_s & to_sym is just safety in case someone
       # defined searchable_attributes as an array of strings
@@ -83,13 +84,13 @@ module Search
 
       hash["object_class"] = klass.name unless hash.has_key?("object_class")
       hash["original_document_id"] = _id.to_s if klass.has_class_prefixed_search_ids?
-      hash
+      @_search_indexable_hash = hash
     end
 
-    # A convenience method to ease accessing the search index
+    # A convenience method to ease accessing the administratable index
     # from the ClassMethods
-    def search_index
-      self.class.search_index
+    def administratable_index
+      self.class.administratable_index
     end
 
     # A convenience method to ease accessing the primary search key

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongodb_meilisearch
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - masukomi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-12 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -156,13 +156,14 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.md
+- README.org
 - Rakefile
 - lefthook.yml
 - lib/mongodb_meilisearch.rb
 - lib/mongodb_meilisearch/version.rb
 - lib/search/class_methods.rb
 - lib/search/client.rb
+- lib/search/errors.rb
 - lib/search/instance_methods.rb
 - sig/mongodb_meilisearch.rbs
 homepage: https://github.com/masukomi/mongodb_meilisearch