async-redis 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31704f6caaeffba85223e9917ac746128c05862b53738ab42d03f0c91bd808c3
-  data.tar.gz: 72afd9739ce773d441870c238e9f2600a6ac3e3d46b13bb66c3a7f3febf3f4d6
+  metadata.gz: da847e343c291506a20337eec6170867a0e0bf295b713ece60fd7f48928d873f
+  data.tar.gz: 2ea6e2720f556084f57415501a1964c0bb2a93a411a9cb52138dbb8ed141c45b
 SHA512:
-  metadata.gz: 5b12190eab39bba378d6ca1793abd3e56ab513a13af4bedfbb332d3d7e869d5b61c9d3958eaa96f22987e341e50b6acdc018c84c1d88effea3fee72fd132a7fe
-  data.tar.gz: '086307e4ec9c27d407cce2e61e99c6b4712e1d1fb3b8bca660c7e1a4270a9aa9061c36dd5a801e3edfa42eb52a6f41a41c858830ccc7e673e38917d0a4f9e700'
+  metadata.gz: 9ac74325525a0dc00b06aaee1fa505566bce74f4806c07f26a8581ac7b20db79f11cbb052d6d598d02b7eec94aae6a142d88da00eb01e4b0a8d72e134ef5a798
+  data.tar.gz: 2b873fd8ee1cfffda74d301265ec9477a34dfe571d30d4c36d195cf39b089c22635bc74c07ade143ca46a5e169d0db226470a6149ce912be3b3da0db96e26b49

data/changes.md

@@ -0,0 +1,46 @@
+# v0.10.0
+
+## Cluster Client
+
+`Async::Redis::ClusterClient` is a new class that provides a high-level interface to a Redis Cluster. Due to the way clustering works, it does not provide the same interface as the `Async::Redis::Client` class. Instead, you must request an appropriate client for the key you are working with.
+
+```ruby
+endpoints = [
+	Async::Redis::Endpoint.parse("redis://redis-a"),
+	Async::Redis::Endpoint.parse("redis://redis-b"),
+	Async::Redis::Endpoint.parse("redis://redis-c"),
+]
+
+cluster_client = Async::Redis::ClusterClient.new(endpoints)
+
+cluster_client.clients_for("key") do |client|
+	puts client.get("key")
+end
+```
+
+## Sentinel Client
+
+The previous implementation `Async::Redis::SentinelsClient` has been replaced with `Async::Redis::SentinelClient`. This new class uses `Async::Redis::Endpoint` objects to represent the sentinels and the master.
+
+```ruby
+sentinels = [
+	Async::Redis::Endpoint.parse("redis://redis-sentinel-a"),
+	Async::Redis::Endpoint.parse("redis://redis-sentinel-b"),
+	Async::Redis::Endpoint.parse("redis://redis-sentinel-c"),
+]
+
+master_client = Async::Redis::SentinelClient.new(sentinels)
+slave_client = Async::Redis::SentinelClient.new(sentinels, role: :slave)
+
+master_client.session do |session|
+	session.set("key", "value")
+end
+
+slave_client.session do |session|
+	puts session.get("key")
+end
+```
+
+## Integration Tests
+
+Integration tests for Redis Cluster and Sentinel have been added, using `docker-compose` to start the required services and run the tests. These tests are not part of the default test suite and must be run separately. See the documentation in the `sentinel/` and `cluster/` directories for more information.

data/lib/async/redis/cluster_client.rb

@@ -13,6 +13,9 @@ module Async
 			class ReloadError < StandardError
 			end
 			
+			class SlotError < StandardError
+			end
+			
 			Node = Struct.new(:id, :endpoint, :role, :health, :client)
 			
 			class RangeMap
@@ -84,9 +87,11 @@ module Async
 					reload_cluster!
 				end
 				
-				nodes = @shards.find(slot)
-				
-				nodes = nodes.select{|node| node.role == role}
+				if nodes = @shards.find(slot)
+					nodes = nodes.select{|node| node.role == role}
+				else
+					raise SlotError, "No nodes found for slot #{slot}"
+				end
 				
 				if node = nodes.sample
 					return (node.client ||= Client.new(node.endpoint))
@@ -106,7 +111,7 @@ module Async
 						shard = shard.each_slice(2).to_h
 						
 						slots = shard['slots']
-						range = Range.new(*slots, exclude_end: false)
+						range = Range.new(*slots)
 						
 						nodes = shard['nodes'].map do |node|
 							node = node.each_slice(2).to_h
@@ -179,10 +184,10 @@ module Async
 				return sum
 			end
 			
-			HASH_SLOTS = 16_384
-			
 			public
 			
+			HASH_SLOTS = 16_384
+			
 			# Return Redis::Client for a given key.
 			# Modified from https://github.com/antirez/redis-rb-cluster/blob/master/cluster.rb#L104-L117
 			def slot_for(key)

data/lib/async/redis/endpoint.rb

@@ -44,7 +44,7 @@ module Async
 			#
 			# @parameter scheme [String] The scheme to use, e.g. "redis" or "rediss".
 			# @parameter hostname [String] The hostname to connect to (or bind to).
-			# @parameter *options [Hash] Additional options, passed to {#initialize}.
+			# @parameter options [Hash] Additional options, passed to {#initialize}.
 			def self.for(scheme, hostname, credentials: nil, port: nil, database: nil, **options)
 				uri_klass = SCHEMES.fetch(scheme.downcase) do
 					raise ArgumentError, "Unsupported scheme: #{scheme.inspect}"
@@ -74,9 +74,10 @@ module Async
 			#
 			# @parameter url [URI] The URL to connect to.
 			# @parameter endpoint [Endpoint] The underlying endpoint to use.
-			# @parameter scheme [String] The scheme to use, e.g. "redis" or "rediss".
-			# @parameter hostname [String] The hostname to connect to (or bind to), overrides the URL hostname (used for SNI).
-			# @parameter port [Integer] The port to bind to, overrides the URL port.
+			# @option scheme [String] The scheme to use, e.g. "redis" or "rediss".
+			# @option hostname [String] The hostname to connect to (or bind to), overrides the URL hostname (used for SNI).
+			# @option port [Integer] The port to bind to, overrides the URL port.
+			# @option ssl_context [OpenSSL::SSL::SSLContext] The SSL context to use for secure connections.
 			def initialize(url, endpoint = nil, **options)
 				super(**options)
 				

data/lib/async/redis/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module Redis
-		VERSION = "0.10.0"
+		VERSION = "0.10.1"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-redis
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -48,7 +48,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-16 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -126,6 +126,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- changes.md
 - lib/async/redis.rb
 - lib/async/redis/client.rb
 - lib/async/redis/cluster_client.rb