rsolr-cloud-lw 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df8d5a6f0c5dc0b14ed1447b055ed562cf7862cd7ed9c3912bb6f662242159d0
+  data.tar.gz: 70260d0cb6d8565f5f55e393dc31e12fd3609e714ed59d4de52929315f17b00d
+SHA512:
+  metadata.gz: 16c47852e31bcb22e5c90e396faa04b7b5914959bf1fcc6115ddc4ffa24746859bce28b51e54e48edc8642454381c4906ae69732900d3ee1e1817a91023e42d4
+  data.tar.gz: 05222647c3f9e320452b8445cde36b96f63dc220d72577b27131f459ca181660a92f617fbe7c57886d5275856c10bee7c511f1a7232d3ba390adde7225d8e6be

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/zookeeper/

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-10 13:14:48 +0900 using RuboCop version 0.37.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+Metrics/LineLength:
+  Max: 100

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rsolr-cloud-lw.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kimura
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# Description
+Customized and simplified version of [rsolr-cloud](https://github.com/enigmo/rsolr-cloud) library.
+
+It watches SolrCloud's `/live_nodes` registry and sends every request to a random entry from that registry. It does not try to be smarter than that, i.e. be aware of collections states / cluster layouts / leaders / replicas, etc.
+
+# RSolr::Cloud
+
+A RSolr's connection adopter supporting SolrCloud.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rsolr-cloud-lw'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rsolr-cloud-lw
+
+## Example
+
+```ruby
+require 'zk'
+require 'rsolr/cloud'
+
+# Create Zookeeper client for the Zookeeper ensemble in SolrCloud.
+zk = ZK.new('localhost:2181,localhost:2182,localhost:2183')
+
+# Connecting the SolrCloud through the Zookeeper.
+cloud_connection = RSolr::Cloud::Connection.new(zk)
+
+# Get rsolr client for solr_cloud.
+solr_client  = RSolr::Client.new(cloud_connection,
+                                 read_timeout: 60,
+                                 open_timeout: 60)
+
+# You can use rsolr as usual but :collection option must be specified with the name of the collection.
+response = solr.get('select', collection: 'collection1', params: {q: '*:*'})
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rsolr-cloud/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Development
+
+To install gems which are necessary for development and testing:
+
+```
+$ bundle install
+```
+
+To run the test suite:
+
+```
+$ rake
+```
+
+The default rake task contains RuboCop and RSpec. Each task can be run separately:
+
+```
+$ rake rubocop
+```
+```
+$ rake spec
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+  task default: [:rubocop, :spec]
+rescue LoadError # rubocop:disable HandleExceptions
+end

data/lib/rsolr/cloud/connection.rb

@@ -0,0 +1,62 @@
+module RSolr
+  module Cloud
+    # RSolr connection adapter for SolrCloud
+    class Connection < RSolr::Connection
+      include MonitorMixin
+
+      ZNODE_LIVE_NODES = '/live_nodes'.freeze
+      ZNODE_CLUSTER_PROPS = '/clusterprops.json'.freeze
+
+      def initialize(zk)
+        super()
+        @zk = zk
+        init_url_scheme
+        init_live_node_watcher
+      end
+
+      def execute(client, request_context)
+        collection_name = request_context[:collection]
+        raise 'The :collection option must be specified.' unless collection_name
+        path  = request_context[:path].to_s
+        query = request_context[:query]
+        query = query ? "?#{query}" : ''
+        url   = select_node(collection_name)
+        raise RSolr::Cloud::Error::NotEnoughNodes unless url
+        request_context[:uri] = RSolr::Uri.create(url).merge(path + query)
+        super(client, request_context)
+      end
+
+      private
+
+      def init_url_scheme
+        @url_scheme = 'http'
+        if @zk.exists?(ZNODE_CLUSTER_PROPS)
+          json, _stat = @zk.get(ZNODE_CLUSTER_PROPS)
+          props = JSON.parse(json)
+          @url_scheme = props['urlScheme'] || 'http'
+        end
+      end
+
+      def select_node(collection)
+        synchronize { @live_nodes.sample + '/' + collection }
+      end
+
+      def init_live_node_watcher
+        @zk.register(ZNODE_LIVE_NODES) do
+          update_live_nodes
+        end
+        update_live_nodes
+      end
+
+      def update_live_nodes
+        synchronize do
+          @live_nodes = []
+          @zk.children(ZNODE_LIVE_NODES, watch: true).each do |node|
+            # "/" between host_and_port part of url and context is replaced with "_" in ZK
+            @live_nodes << @url_scheme + '://' + node.tr('_', '/')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rsolr/cloud/error.rb

@@ -0,0 +1,12 @@
+module RSolr
+  module Cloud
+    module Error
+      # This error occurs when all solr nodes aren't active.
+      class NotEnoughNodes < RuntimeError
+        def to_s
+          'Not enough nodes to handle the request.'
+        end
+      end
+    end
+  end
+end

data/lib/rsolr/cloud/version.rb

@@ -0,0 +1,5 @@
+module Rsolr
+  module Cloud
+    VERSION = '1.1.0'.freeze
+  end
+end

data/lib/rsolr/cloud.rb

@@ -0,0 +1,3 @@
+require 'rsolr/cloud/error'
+require 'rsolr/cloud/connection'
+require 'rsolr/cloud/version'

data/rsolr-cloud-lw.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rsolr/cloud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rsolr-cloud-lw'
+  spec.version       = Rsolr::Cloud::VERSION
+  spec.authors       = ['Shintaro Kimura', 'Alexey Serba']
+  spec.email         = ['aserba@gmail.com']
+  spec.summary       = 'The connection adopter supporting SolrCloud for RSolr'
+  spec.description   = 'The connection adopter supporting SolrCloud for RSolr'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'activesupport', '~> 4.2'
+  spec.add_development_dependency 'zk-server', '~> 1.1.7'
+  spec.add_development_dependency 'zk', '~> 1.9.5'
+  spec.add_development_dependency 'rsolr', '~> 1.0.12'
+  spec.add_development_dependency 'rubocop', '~> 0.37.1'
+end

data/spec/rsolr/cloud/connection_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper.rb'
+
+RSpec.describe RSolr::Cloud::Connection do
+  before do
+    @zk_in_solr = ZK.new
+    delete_with_children(@zk_in_solr, '/live_nodes')
+    wait_until(10) do
+      !@zk_in_solr.exists?('/live_nodes')
+    end
+    @zk_in_solr.create('/live_nodes')
+
+    ['192.168.1.21:8983_solr',
+     '192.168.1.22:8983_solr',
+     '192.168.1.23:8983_solr',
+     '192.168.1.24:8983_solr'
+    ].each do |node|
+      @zk_in_solr.create("/live_nodes/#{node}", '', mode: :ephemeral)
+    end
+    @zk = ZK.new
+    @subject = RSolr::Cloud::Connection.new @zk
+  end
+
+  let(:client) { double.as_null_object }
+
+  let(:http) { double(Net::HTTP).as_null_object }
+
+  it 'should configure Net::HTTP with one of live node in select or update request.' do
+    expect(@subject.instance_variable_get(:@live_nodes).sort).to eq(
+      ['http://192.168.1.21:8983/solr',
+       'http://192.168.1.22:8983/solr',
+       'http://192.168.1.23:8983/solr',
+       'http://192.168.1.24:8983/solr'].sort)
+    expect(Net::HTTP).to receive(:new) do |host, port|
+      expect(host).to be_one_of(['192.168.1.21', '192.168.1.22', '192.168.1.23', '192.168.1.24'])
+      expect(port).to eq(8983)
+      http
+    end
+
+    expect(http).to receive(:request) do |request|
+      expect(request.path).to eq('/solr/collection1/select?q=*:*')
+      double.as_null_object
+    end
+    @subject.execute client, collection: 'collection1', method: :get, path: 'select', query: 'q=*:*'
+
+    expect(http).to receive(:request) do |request|
+      expect(request.path).to eq('/solr/collection1/update')
+      expect(request.body).to eq('the data')
+      double.as_null_object
+    end
+    @subject.execute client, collection: 'collection1',
+                             method: :post,
+                             path: 'update',
+                             data: 'the data'
+  end
+
+  it 'should remove downed node and add recovered node.' do
+    @zk_in_solr.delete('/live_nodes/192.168.1.21:8983_solr')
+    expect { @subject.instance_variable_get(:@live_nodes).sort }.to become_soon(
+      ['http://192.168.1.22:8983/solr',
+       'http://192.168.1.23:8983/solr',
+       'http://192.168.1.24:8983/solr'].sort)
+    @zk_in_solr.create('/live_nodes/192.168.1.21:8983_solr', mode: :ephemeral)
+    expect { @subject.instance_variable_get(:@live_nodes).sort }.to become_soon(
+      ['http://192.168.1.21:8983/solr',
+       'http://192.168.1.22:8983/solr',
+       'http://192.168.1.23:8983/solr',
+       'http://192.168.1.24:8983/solr'].sort)
+  end
+
+  it 'should obey url scheme.' do
+    @zk_in_solr.create('/clusterprops.json', '{"urlScheme": "https"}')
+    @subject = RSolr::Cloud::Connection.new @zk
+    expect(@subject.instance_variable_get(:@url_scheme)).to eq('https')
+    expect(@subject.instance_variable_get(:@live_nodes).sort).to eq(
+      ['https://192.168.1.21:8983/solr',
+       'https://192.168.1.22:8983/solr',
+       'https://192.168.1.23:8983/solr',
+       'https://192.168.1.24:8983/solr'].sort)
+  end
+
+  after do
+    @zk_in_solr.close if @zk_in_solr
+    @zk.close         if @zk
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require 'rsolr'
+require 'rsolr/cloud'
+require 'active_support'
+require 'active_support/core_ext'
+require 'zk'
+require 'zk-server'
+require 'rspec/expectations'
+
+module Helpers
+  def delete_with_children(zk, path)
+    zk.children(path).each do |node|
+      delete_with_children(zk, File.join(path, node))
+    end
+    zk.delete(path)
+  rescue ZK::Exceptions::NoNode # rubocop:disable HandleExceptions
+    # don't care if it already exists or not.
+  end
+
+  def wait_until(timeout = 10)
+    started_on = Time.now
+    result = false
+    loop do
+      result = yield
+      break if result || started_on < timeout.second.ago
+      Thread.pass
+    end
+    raise 'Timed out' unless result
+  end
+end
+
+RSpec.configure do |config|
+  config.include Helpers
+  config.before(:suite) do
+    ZK::Server.run do |c|
+      c.force_sync = false
+    end
+  end
+  config.after(:suite) do
+    ZK::Server.server.clobber!
+  end
+end
+
+RSpec::Matchers.define :be_one_of do |expected|
+  match do |actual|
+    expected.include?(actual)
+  end
+end
+
+RSpec::Matchers.define :become_soon do |expected|
+  match do |actual|
+    begin
+      wait_until do
+        actual.call == expected
+      end
+    rescue
+      false
+    else
+      true
+    end
+  end
+
+  def supports_block_expectations?
+    true
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: rsolr-cloud-lw
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Shintaro Kimura
+- Alexey Serba
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2019-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  name: activesupport
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+  name: zk-server
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.5
+  name: zk
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.5
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+  name: rsolr
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.1
+  name: rubocop
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.1
+description: The connection adopter supporting SolrCloud for RSolr
+email:
+- aserba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rsolr/cloud.rb
+- lib/rsolr/cloud/connection.rb
+- lib/rsolr/cloud/error.rb
+- lib/rsolr/cloud/version.rb
+- rsolr-cloud-lw.gemspec
+- spec/rsolr/cloud/connection_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.13
+signing_key:
+specification_version: 4
+summary: The connection adopter supporting SolrCloud for RSolr
+test_files:
+- spec/rsolr/cloud/connection_spec.rb
+- spec/spec_helper.rb