solrb 0.2.3 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9ae1ed7f5931da9955de331a59ca5c10598882b38e137136464a136c9b9b079
-  data.tar.gz: 91b33fad87d4bc4b286d591a0b2c91d1c51a63e59e9a53f9cc8e8891592fba87
+  metadata.gz: ea33f82de9a9b3bb71a87821df6be65e39e1156704ed713c556752781257012a
+  data.tar.gz: 8b06c57da1f0948858a1ea97c8adc9e318e53f5288549eb80236d1e1c6e54a88
 SHA512:
-  metadata.gz: 1539610c599f2493f8b3d6f0fd0c9b926b69032a2bffc0b0519aaf73c0e5175d63196657893452ce11b147a45243e648c683983049e0f685503be21ec6d60506
-  data.tar.gz: 8d059163628f2c9220a467d6cada61e7b26cb088cc2db82d6b02f14836875f6089e5eb001de0d9dea8f3a74f92eb498bd26ac84a54e85901b7feefadc17b7b62
+  metadata.gz: c7b5cd5683b89b389d9d39a8e026a0483a2f9daa6c435a967bc93723150d8fddfc3f804496fece068fb06d9fd2732892fbe9305ca2b3876180f8d8433f270a36
+  data.tar.gz: bf7ca512022d6edbf347c6d0d2697aa90b1d1fc610d6dd8674cc5d78c30ce7e513f463538877857624ae002826e0fa0c3582712c53cd46835c77170a0e960ada

data/.github/workflows/reviewdog.yml

@@ -0,0 +1,20 @@
+---
+name: reviewdog
+'on': [push]
+jobs:
+  rubocop:
+    name: runner / rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5.1
+          bundler-cache: true
+      - uses: reviewdog/action-rubocop@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          rubocop_version: '0.80.1'
+          rubocop_extensions: ''
+          reporter: github-check
+          fail_on_error: true

data/.github/workflows/tests.yaml

@@ -0,0 +1,37 @@
+---
+name: Tests
+'on': [push]
+
+env:
+  SOLR_URL: http://localhost:8983/solr/test-core
+
+jobs:
+  rspec:
+    name: Rspec on Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7', '3.0']
+    services:
+      solr:
+        image: solr:7.4.0
+        ports:
+          - 8983:8983
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Create a test core
+        run: |
+          curl 'http://localhost:8983/solr/admin/cores?action=CREATE&name=test-core&configSet=_default'
+
+      - name: Disable field type guessing
+        run: |
+          curl http://localhost:8983/solr/test-core/config -d '{"set-user-property": {"update.autoCreateFields":"false"}}'
+
+      - name: Rspec
+        run: bundle exec rspec --format progress

data/.gitignore

@@ -10,3 +10,5 @@
 # rspec failure tracking
 .rspec_status
 .ruby-version
+
+Gemfile.lock

data/.rubocop.yml

@@ -1,19 +1,20 @@
 AllCops:
   Exclude:
-    - db/schema.rb
-    - node_modules/**/*
     - bin/*
+    - vendor/**/*
+    - pkg/**/*
   TargetRubyVersion: '2.5'
-Metrics/LineLength:
+  DisabledByDefault: true
+Layout/LineLength:
   Max: 120
-Documentation:
+Style/Documentation:
   Enabled: false
-FrozenStringLiteralComment:
+Style/FrozenStringLiteralComment:
   Enabled: false
 Metrics/MethodLength:
   Max: 20
 Metrics/AbcSize:
-  Max: 20
+  Enabled: false
  # Removing Blocks Cop for RSpec
 Style/BlockDelimiters:
   Exclude:
@@ -28,3 +29,6 @@ Metrics/BlockLength:
     - '**/*.rake'
     - 'spec/**/*'
     - 'config/environments/**/*'
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'spec/**/*'

data/README.md

@@ -15,6 +15,8 @@ Object-Oriented approach to Solr in Ruby.
   * [Single core configuration](#single-core-configuration)
   * [Multiple core configuration](#multiple-core-configuration)
   * [Solr Cloud](#solr-cloud)
+  * [Master-slave](#master-slave)
+    * [Gray list](#gray-list)
   * [Basic Authentication](#basic-authentication)
 * [Indexing](#indexing)
 * [Querying](#querying)
@@ -164,6 +166,51 @@ on_worker_boot do
 end
 ```
 
+## Master-slave
+
+To enable master-slave mode you must define a master url and slave url on solr config block.
+In solr master-slave mode you don't need to provide a solr url (`config.url` or `ENV['SOLR_URL']`).
+
+```ruby
+Solr.configure do |config|
+  config.master_url = 'localhost:8983'
+  config.slave_url = 'localhost:8984'
+  # Disable select queries from master:
+  config.disable_read_from_master = true
+  # Specify Gray-list service
+  config.nodes_gray_list = Solr::MasterSlave::NodesGrayList::InMemory.new
+end
+```
+
+If you are using puma web server in clustered mode you must call `enable_master_slave!` on `on_worker_boot`
+callback to make each puma worker connect with zookeeper.
+
+
+```ruby
+on_worker_boot do
+  Solr.enable_master_slave!
+end
+```
+
+### Gray list
+
+Solrb provides two built-in services:
+- `Solr::MasterSlave::NodesGrayList::Disabled` — Disabled service (default). Just does nothing.
+- `Solr::MasterSlave::NodesGrayList::InMemory` — In memory service. It stores failed URLs in an instance variable, so it's not shared across threads/servers. URLs will be marked as "gray" for 5 minutes, but if all URLs are gray, the policy will try to send requests to these URLs earlier.
+
+You are able to implement your own services with corresponding API.
+
+## Force node URL
+
+You can force solrb to use a specific node URL with the `with_node_url` method:
+
+```ruby
+Solr.with_node_url('http://localhost:9000') do
+  Solr::Query::Request.new(search_term: 'example', query_fields: query_fields).run
+end
+```
+
+
 ## Basic Authentication
 
 Basic authentication is supported by solrb. You can enable it by providing `auth_user` and `auth_password`

data/lib/solr.rb

@@ -16,14 +16,19 @@ require 'solr/indexing/document'
 require 'solr/indexing/request'
 
 require 'solr/cloud/helper_methods'
+require 'solr/master_slave/helper_methods'
+require 'solr/helper_methods'
 require 'solr/commands'
 
 module Solr
   class << self
     include Solr::Commands
     include Solr::Cloud::HelperMethods
+    include Solr::MasterSlave::HelperMethods
+    include Solr::HelperMethods
 
     CURRENT_CORE_CONFIG_VARIABLE_NAME = :solrb_current_core_config
+    SOLR_NODE_URL_OVERRIDE_CONFIG = :solrb_node_url_override_config
 
     attr_accessor :configuration
 
@@ -32,7 +37,11 @@ module Solr
     def configure
       yield configuration
       configuration.validate!
-      enable_solr_cloud! unless configuration.zookeeper_url.nil?
+      if configuration.zookeeper_url
+        enable_solr_cloud!
+      elsif configuration.master_url
+        enable_master_slave!
+      end
       configuration
     end
 
@@ -49,6 +58,17 @@ module Solr
       Thread.current[CURRENT_CORE_CONFIG_VARIABLE_NAME] = old_core_config
     end
 
+    def with_node_url(url)
+      Thread.current[SOLR_NODE_URL_OVERRIDE_CONFIG] = url
+      yield
+    ensure
+      Thread.current[SOLR_NODE_URL_OVERRIDE_CONFIG] = nil
+    end
+
+    def node_url_override
+      Thread.current[SOLR_NODE_URL_OVERRIDE_CONFIG]
+    end
+
     def solr_url(path = '')
       Solr::Support::UrlHelper.solr_url(path)
     end

data/lib/solr/cloud/configuration.rb

@@ -18,7 +18,8 @@ module Solr
       end
 
       def build_zookeeper_connection
-        Solr::Cloud::ZookeeperConnection.new(zookeeper_url: zookeeper_url.is_a?(Array) ? zookeeper_url.join(',') : zookeeper_url,
+        zookeeper_url = zookeeper_url.is_a?(Array) ? zookeeper_url.join(',') : zookeeper_url
+        Solr::Cloud::ZookeeperConnection.new(zookeeper_url: zookeeper_url,
                                              zookeeper_auth_user: zookeeper_auth_user,
                                              zookeeper_auth_password: zookeeper_auth_password)
       end

data/lib/solr/cloud/helper_methods.rb

@@ -3,7 +3,7 @@ require 'solr/cloud/configuration'
 module Solr
   module Cloud
     module HelperMethods
-      def active_nodes_for(collection:)
+      def cloud_active_nodes_for(collection:)
         collections_state_manager.active_nodes_for(collection: collection)
       end
 

data/lib/solr/commands.rb

@@ -5,8 +5,9 @@ require 'solr/data_import/request'
 
 module Solr
   module Commands
-    def commit(open_searcher: true, runner_options: nil)
-      Solr::Commit::Request.new.run(open_searcher: open_searcher,
+    def commit(open_searcher: true, optimize: false, runner_options: nil)
+      Solr::Commit::Request.new.run(optimize: optimize,
+                                    open_searcher: open_searcher,
                                     runner_options: runner_options)
     end
 

data/lib/solr/commit/request.rb

@@ -3,8 +3,8 @@ module Solr
     class Request
       PATH = '/update'.freeze
 
-      def run(open_searcher: true, runner_options: nil)
-        http_request = build_http_request(open_searcher)
+      def run(open_searcher: true, optimize: false, runner_options: nil)
+        http_request = build_http_request(open_searcher, optimize)
         options = default_runner_options.merge(runner_options || {})
         Solr::Request::Runner.call(request: http_request, **options)
       end
@@ -12,12 +12,22 @@ module Solr
       private
 
       def default_runner_options
-        { node_selection_strategy: Solr::Request::LeaderNodeSelectionStrategy }
+        if Solr.cloud_enabled?
+          { node_selection_strategy: Solr::Request::Cloud::LeaderNodeSelectionStrategy }
+        elsif Solr.master_slave_enabled?
+          { node_selection_strategy: Solr::Request::MasterSlave::MasterNodeSelectionStrategy }
+        else
+          {}
+        end
       end
 
-      def build_http_request(open_searcher)
+      def build_http_request(open_searcher, optimize)
         Solr::Request::HttpRequest.new(path: PATH,
-                                       url_params: { commit: true, openSearcher: open_searcher },
+                                       url_params: {
+                                         commit: true,
+                                         optimize: optimize,
+                                         openSearcher: open_searcher
+                                       },
                                        method: :post)
       end
     end

data/lib/solr/configuration.rb

@@ -1,3 +1,4 @@
+require 'logger'
 require 'solr/core_configuration/dynamic_field'
 require 'solr/core_configuration/field'
 require 'solr/core_configuration/core_config'
@@ -10,21 +11,29 @@ module Solr
   class Configuration
     extend Forwardable
 
-    delegate [:zookeeper_url, :zookeeper_url=, :zookeeper_auth_user=, :zookeeper_auth_password=] => :@cloud_configuration
+    delegate [:zookeeper_url, :zookeeper_url=, :zookeeper_auth_user=,
+      :zookeeper_auth_password=] => :@cloud_configuration
+    delegate [:master_url, :master_url=, :slave_url, :slave_url=, :disable_read_from_master,
+      :disable_read_from_master=, :nodes_gray_list, :nodes_gray_list=] => :@master_slave_configuration
 
     SOLRB_USER_AGENT_HEADER = { user_agent: "Solrb v#{Solr::VERSION}" }.freeze
 
     attr_accessor :cores, :test_connection, :auth_user, :auth_password
 
-    attr_reader :url, :faraday_options, :cloud_configuration
+    attr_reader :url, :faraday_options, :faraday_configuration, :cloud_configuration,
+      :master_slave_configuration
+
+    attr_writer :url, :logger
 
     def initialize
       @faraday_options = {
         request: { timeout: 2, open_timeout: 8 },
         headers: SOLRB_USER_AGENT_HEADER
       }
+      @faraday_configuration = nil
       @cores = {}
       @cloud_configuration = Solr::Cloud::Configuration.new
+      @master_slave_configuration = Solr::MasterSlave::Configuration.new
     end
 
     def faraday_options=(options)
@@ -33,8 +42,8 @@ module Solr
       @faraday_options = options
     end
 
-    def url=(value)
-      @url = value
+    def faraday_configure(&block)
+      @faraday_configuration = block
     end
 
     def core_config_by_name(core)
@@ -87,9 +96,22 @@ module Solr
     end
 
     def validate!
-      if !(url || @cloud_configuration.zookeeper_url || ENV['SOLR_URL'])
+      if !(url ||
+           @cloud_configuration.zookeeper_url ||
+           (@master_slave_configuration.master_url && @master_slave_configuration.slave_url) ||
+           ENV['SOLR_URL'])
         raise Solr::Errors::SolrUrlNotDefinedError
       end
     end
+
+    def logger
+      @logger || null_logger
+    end
+
+    private
+
+    def null_logger
+      @null_logger ||= ::Logger.new(IO::NULL)
+    end
   end
 end

data/lib/solr/connection.rb

@@ -3,9 +3,11 @@ module Solr
   class Connection
     INSTRUMENT_KEY = 'request.solrb'.freeze
 
-    def initialize(url, faraday_options: Solr.configuration.faraday_options)
+    def initialize(url, faraday_options: Solr.configuration.faraday_options,
+        faraday_configuration: Solr.configuration.faraday_configuration)
       # Allow mock the connection for testing
-      @raw_connection = Solr.configuration.test_connection || build_faraday_connection(url, faraday_options)
+      @raw_connection = Solr.configuration.test_connection
+      @raw_connection ||= build_faraday_connection(url, faraday_options, faraday_configuration)
       freeze
     end
 
@@ -29,8 +31,8 @@ module Solr
 
     private
 
-    def build_faraday_connection(url, faraday_options)
-      connection = Faraday.new(url, faraday_options)
+    def build_faraday_connection(url, faraday_options, faraday_configuration)
+      connection = Faraday.new(url, faraday_options, &faraday_configuration)
       if Solr.configuration.auth_user && Solr.configuration.auth_password
         connection.basic_auth(Solr.configuration.auth_user, Solr.configuration.auth_password)
       end

data/lib/solr/data_import/request.rb

@@ -21,7 +21,13 @@ module Solr
       private
 
       def default_runner_options
-        { node_selection_strategy: Solr::Request::LeaderNodeSelectionStrategy }
+        if Solr.cloud_enabled?
+          { node_selection_strategy: Solr::Request::Cloud::LeaderNodeSelectionStrategy }
+        elsif Solr.master_slave_enabled?
+          { node_selection_strategy: Solr::Request::MasterSlave::MasterNodeSelectionStrategy }
+        else
+          {}
+        end
       end
     end
   end

data/lib/solr/delete/request.rb

@@ -21,7 +21,13 @@ module Solr
       private
 
       def default_runner_options
-        { node_selection_strategy: Solr::Request::LeaderNodeSelectionStrategy }
+        if Solr.cloud_enabled?
+          { node_selection_strategy: Solr::Request::Cloud::LeaderNodeSelectionStrategy }
+        elsif Solr.master_slave_enabled?
+          { node_selection_strategy: Solr::Request::MasterSlave::MasterNodeSelectionStrategy }
+        else
+          {}
+        end
       end
 
       def build_http_request(commit)

data/lib/solr/errors/solr_connection_failed_error.rb

@@ -1,10 +1,11 @@
 module Solr
   module Errors
     class SolrConnectionFailedError < StandardError
-      def initialize(solr_urls)
+      def initialize(solr_url_errors)
+        urls_message = solr_url_errors.map { |url, error| "[#{url}] #{error}" }.join("\n")
         message = <<~MESSAGE
           Could not connect to any available solr instance:
-          #{solr_urls.join(', ')}
+          #{urls_message}
         MESSAGE
         super(message)
       end

data/lib/solr/helper_methods.rb

@@ -0,0 +1,11 @@
+module Solr
+  module HelperMethods
+    def active_nodes_for(collection:)
+      if cloud_enabled?
+        cloud_active_nodes_for(collection: collection)
+      elsif master_slave_enabled?
+        master_slave_active_nodes_for(collection: collection)
+      end
+    end
+  end
+end