async-redis 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 846a8f4d10913acf2d43343efb35a4ca9306db6a5fda6d9794774181939e6535
-  data.tar.gz: 0d25f58941fc326a9500e50a63ead3ac017d734f8292e4ebcf63f1cad3ff6280
+  metadata.gz: 8a141b089c56a3e62a5e5f70d811127514105be73c208b1efec282e16427ba86
+  data.tar.gz: 28568c52ef21f29dcfdad24c2dd8f9460e558546de16e0599fc970b9d6581c1e
 SHA512:
-  metadata.gz: d8881dfb830d61c74b55415d693f2eda5a5caf04daf789400df7d8e7229468c929300264d305b5182a706b44cca1677ae930ea757ca139dcfe2b7b639f0bc6c0
-  data.tar.gz: b51195073ead610e2b95e67b9280c1b13472d51156985624782de72e9b3e57764ba2ad53b5758cedd9617e3ffc11a0668f89d6ee476e118f3300a600051c5973
+  metadata.gz: 69a6e6fb59f64444356f82a89ed3525e86ae0f465568265e4ff5b7103cefb0ff4433d41b3c7c8d325d3911649dc451dfe8fd82315ac94c4de47158d19da402de
+  data.tar.gz: 4ec4f9d4744508643cd01f9fcc4d4a937a74daca6ea7e61353e73d73e408490f8b501c0ee6434cf4127b1350eae279f1d49005515c6f9f86e940307ad757e3dc

data/lib/async/redis.rb

@@ -22,3 +22,4 @@
 
 require_relative 'redis/version'
 require_relative 'redis/client'
+require_relative 'redis/sentinels'

data/lib/async/redis/client.rb

@@ -37,14 +37,14 @@ module Async
 		# Legacy.
 		ServerError = ::Protocol::Redis::ServerError
 		
-		def self.local_endpoint
-			Async::IO::Endpoint.tcp('localhost', 6379)
+		def self.local_endpoint(port: 6379)
+			Async::IO::Endpoint.tcp('localhost', port)
 		end
 		
 		class Client
 			include ::Protocol::Redis::Methods
 			
-			def initialize(endpoint = Redis.local_endpoint, protocol = Protocol::RESP2, **options)
+			def initialize(endpoint = Redis.local_endpoint, protocol: Protocol::RESP2, **options)
 				@endpoint = endpoint
 				@protocol = protocol
 				
@@ -74,10 +74,6 @@ module Async
 				@pool.close
 			end
 			
-			def publish(channel, message)
-				call('PUBLISH', channel, message)
-			end
-			
 			def subscribe(*channels)
 				context = Context::Subscribe.new(@pool, channels)
 				
@@ -90,18 +86,6 @@ module Async
 				end
 			end
 			
-			def multi(&block)
-				context = Context::Multi.new(@pool)
-				
-				return context unless block_given?
-				
-				begin
-					yield context
-				ensure
-					context.close
-				end
-			end
-			
 			def transaction(&block)
 				context = Context::Transaction.new(@pool)
 				
@@ -113,12 +97,14 @@ module Async
 					context.close
 				end
 			end
-
+			
+			alias multi transaction
+			
 			def pipeline(&block)
 				context = Context::Pipeline.new(@pool)
-
+				
 				return context unless block_given?
-
+				
 				begin
 					yield context
 				ensure
@@ -145,7 +131,8 @@ module Async
 				Async::Pool::Controller.wrap(**options) do
 					peer = @endpoint.connect
 					
-					peer.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+					# We will manage flushing ourselves:
+					peer.sync = true
 					
 					stream = IO::Stream.new(peer)
 					

data/lib/async/redis/context/subscribe.rb

@@ -27,48 +27,35 @@ module Async
 	module Redis
 		module Context
 			class Subscribe < Generic
+				MESSAGE = 'message'
+				
 				def initialize(pool, channels)
 					super(pool)
 					
-					@channels = channels
-					
 					subscribe(channels)
 				end
 				
-				def listen
-					return @connection.read_response
+				def close
+					# There is no way to reset subscription state. On Redis v6+ you can use RESET, but this is not supported in <= v6.
+					@connection&.close
+					
+					super
 				end
 				
-				private
+				def listen
+					while response = @connection.read_response
+						return response if response.first == MESSAGE
+					end
+				end
 				
 				def subscribe(channels)
 					@connection.write_request ['SUBSCRIBE', *channels]
 					@connection.flush
-					
-					response = nil
-					
-					channels.length.times do |i|
-						response = @connection.read_response
-					end
-					
-					return response
 				end
 				
-				def unsubscribe(*channels)
-					if channels.empty? # unsubscribe from everything if no specific channels are given
-						@connection.write_request ['UNSUBSCRIBE']
-						
-						response = nil
-						
-						@channels.length.times do |i|
-							response = @connection.read_response
-						end
-						
-						return response
-					else
-						@channels.subtract(channels)
-						return call 'UNSUBSCRIBE', *channels
-					end
+				def unsubscribe(channels)
+					@connection.write_request ['UNSUBSCRIBE', *channels]
+					@connection.flush
 				end
 			end
 		end

data/lib/async/redis/sentinels.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Async
+	module Redis
+		class SentinelsClient < Client
+			def initialize(master_name, sentinels, role = :master, protocol = Protocol::RESP2, **options)
+				@master_name = master_name
+				@sentinel_endpoints = sentinels.map do |sentinel|
+					Async::IO::Endpoint.tcp(sentinel[:host], sentinel[:port])
+				end
+				@role = role
+
+				@protocol = protocol
+				@pool = connect(**options)
+			end
+
+			private
+
+			# Override the parent method. The only difference is that this one needs
+			# to resolve the master/slave address.
+			def connect(**options)
+				Async::Pool::Controller.wrap(**options) do
+					endpoint = resolve_address
+					peer = endpoint.connect
+					stream = IO::Stream.new(peer)
+
+					@protocol.client(stream)
+				end
+			end
+
+			def resolve_address
+				address = case @role
+									when :master then resolve_master
+									when :slave then resolve_slave
+									else raise ArgumentError, "Unknown instance role #{@role}"
+									end
+
+				address or raise RuntimeError, "Unable to fetch #{@role} via Sentinel."
+			end
+
+			def resolve_master
+				@sentinel_endpoints.each do |sentinel_endpoint|
+					client = Client.new(sentinel_endpoint)
+
+					begin
+						address = client.call('sentinel', 'get-master-addr-by-name', @master_name)
+					rescue Errno::ECONNREFUSED
+						next
+					end
+
+					return Async::IO::Endpoint.tcp(address[0], address[1]) if address
+				end
+
+				nil
+			end
+
+			def resolve_slave
+				@sentinel_endpoints.each do |sentinel_endpoint|
+					client = Client.new(sentinel_endpoint)
+
+					begin
+						reply = client.call('sentinel', 'slaves', @master_name)
+					rescue Errno::ECONNREFUSED
+						next
+					end
+
+					slaves = available_slaves(reply)
+					next if slaves.empty?
+
+					slave = select_slave(slaves)
+					return Async::IO::Endpoint.tcp(slave['ip'], slave['port'])
+				end
+
+				nil
+			end
+
+			def available_slaves(slaves_cmd_reply)
+				# The reply is an array with the format: [field1, value1, field2,
+				# value2, etc.].
+				# When a slave is marked as down by the sentinel, the "flags" field
+				# (comma-separated array) contains the "s_down" value.
+				slaves_cmd_reply.map { |s| s.each_slice(2).to_h }
+						            .reject { |s| s.fetch('flags').split(',').include?('s_down') }
+			end
+
+			def select_slave(available_slaves)
+				available_slaves.sample
+			end
+		end
+	end
+end

data/lib/async/redis/version.rb

@@ -22,6 +22,6 @@
 
 module Async
 	module Redis
-		VERSION = "0.4.3"
+		VERSION = "0.6.0"
 	end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: async-redis
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Williams
 - Huba Nagy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: hiredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,21 +138,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,35 +166,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hiredis
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '3.6'
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
-- 12huba@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
-- async-redis.gemspec
 - lib/async/redis.rb
 - lib/async/redis/client.rb
 - lib/async/redis/context/generic.rb
@@ -203,11 +193,13 @@ files:
 - lib/async/redis/context/transaction.rb
 - lib/async/redis/key.rb
 - lib/async/redis/protocol/resp2.rb
+- lib/async/redis/sentinels.rb
 - lib/async/redis/version.rb
 homepage: https://github.com/socketry/async-redis
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +214,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.0.dev
+signing_key:
 specification_version: 4
 summary: A Redis client library.
 test_files: []

data/.editorconfig

@@ -1,6 +0,0 @@
-root = true
-
-[*]
-indent_style = tab
-indent_size = 2
-

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-.covered.db

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---warnings
---require spec_helper

data/.travis.yml

@@ -1,23 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-services:
-  - redis-server
-
-matrix:
-  include:
-    - rvm: 2.3
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.6
-      env: COVERAGE=BriefSummary,Coveralls
-    - rvm: ruby-head
-    - rvm: truffleruby
-    - rvm: jruby-head
-      env: JRUBY_OPTS="--debug -X+O"
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: truffleruby
-    - rvm: jruby-head

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in async-io.gemspec
-gemspec
-
-# gem "protocol-redis", path: "../protocol-redis"
-
-group :development do
-	gem 'pry'
-end

data/README.md

@@ -1,125 +0,0 @@
-# Async::Redis
-
-An asynchronous client for Redis including TLS. Support for streaming requests and responses. Built on top of [async] and [async-io].
-
-[![Build Status](https://secure.travis-ci.org/socketry/async-redis.svg)](https://travis-ci.org/socketry/async-redis)
-[![Code Climate](https://codeclimate.com/github/socketry/async-redis.svg)](https://codeclimate.com/github/socketry/async-redis)
-[![Coverage Status](https://coveralls.io/repos/socketry/async-redis/badge.svg)](https://coveralls.io/r/socketry/async-redis)
-
-[async]: https://github.com/socketry/async
-[async-io]: https://github.com/socketry/async-io
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'async-redis'
-```
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install async-redis
-
-## Usage
-
-### Basic Local Connection
-
-```ruby
-require 'async/redis'
-
-endpoint = Async::Redis.local_endpoint
-client = Async::Redis::Client.new(endpoint)
-
-Async do
-	pp client.info
-ensure
-	client.close
-end
-```
-
-### Variables
-
-```ruby
-require 'async'
-require 'async/redis'
-
-endpoint = Async::Redis.local_endpoint
-client = Async::Redis::Client.new(endpoint)
-
-Async do
-	client.set('X', 10)
-	pp client.get('X')
-ensure
-	client.close
-end
-```
-
-### Subscriptions
-
-```ruby
-require 'async'
-require 'async/redis'
-
-endpoint = Async::Redis.local_endpoint
-client = Async::Redis::Client.new(endpoint)
-
-Async do |task|
-	condition = Async::Condition.new
-	
-	publisher = task.async do
-		condition.wait
-		
-		client.publish 'status.frontend', 'good'
-	end
-	
-	subscriber = task.async do
-		client.subscribe 'status.frontend' do |context|
-			condition.signal # We are waiting for messages.
-			
-			type, name, message = context.listen
-			
-			pp type, name, message
-		end
-	end
-ensure
-	client.close
-end
-```
-
-## Contributing
-
-1. Fork it
-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 new Pull Request
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2018, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).  
-Copyright, 2018, by Huba Z. Nagy.  
-
-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/Rakefile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:test)
-
-task :default => :test
-
-task :client do
-	require 'irb'
-	require 'async/redis/client'
-	
-	endpoint = Async::Redis.local_endpoint
-	client = Async::Redis::Client.new(endpoint)
-	
-	Async do
-		binding.irb
-	end
-end

data/async-redis.gemspec

@@ -1,39 +0,0 @@
-
-require_relative 'lib/async/redis/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "async-redis"
-	spec.version       = Async::Redis::VERSION
-	spec.authors       = ["Samuel Williams", "Huba Nagy"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz", "12huba@gmail.com"]
-
-	spec.summary       = "A Redis client library."
-	spec.homepage      = "https://github.com/socketry/async-redis"
-
-	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-		f.match(%r{^(test|spec|features)/})
-	end
-	
-	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency("async", "~> 1.8")
-	spec.add_dependency("async-io", "~> 1.10")
-	spec.add_dependency("async-pool", "~> 0.2")
-	
-	spec.add_dependency("protocol-redis", "~> 0.4.0")
-	
-	spec.add_development_dependency "async-rspec", "~> 1.1"
-	spec.add_development_dependency "redis"
-	spec.add_development_dependency "benchmark-ips"
-
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rspec", "~> 3.6"
-	spec.add_development_dependency "rake"
-
-	# Dependencies with C extensions
-	if defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby"
-		spec.add_development_dependency "hiredis"
-	end
-end