1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
|
# frozen_string_literal: true
require "redis_client/version"
require "redis_client/command_builder"
require "redis_client/url_config"
require "redis_client/config"
require "redis_client/pid_cache"
require "redis_client/sentinel_config"
require "redis_client/middlewares"
class RedisClient
@driver_definitions = {}
@drivers = {}
@default_driver = nil
class << self
def register_driver(name, &block)
@driver_definitions[name] = block
end
def driver(name)
return name if name.is_a?(Class)
name = name.to_sym
unless @driver_definitions.key?(name)
raise ArgumentError, "Unknown driver #{name.inspect}, expected one of: `#{@driver_definitions.keys.inspect}`"
end
@drivers[name] ||= @driver_definitions[name]&.call
end
def default_driver
unless @default_driver
@driver_definitions.each_key do |name|
if @default_driver = driver(name)
break
end
rescue LoadError
end
end
@default_driver
end
def default_driver=(name)
@default_driver = driver(name)
end
end
register_driver :ruby do
require "redis_client/ruby_connection"
RubyConnection
end
module Common
attr_reader :config, :id
attr_accessor :connect_timeout, :read_timeout, :write_timeout
def initialize(
config,
id: config.id,
connect_timeout: config.connect_timeout,
read_timeout: config.read_timeout,
write_timeout: config.write_timeout
)
@config = config
@id = id&.to_s
@connect_timeout = connect_timeout
@read_timeout = read_timeout
@write_timeout = write_timeout
@command_builder = config.command_builder
@pid = PIDCache.pid
end
def timeout=(timeout)
@connect_timeout = @read_timeout = @write_timeout = timeout
end
end
module HasConfig
attr_reader :config
def _set_config(config)
@config = config
end
def message
return super unless config&.resolved?
"#{super} (#{config.server_url})"
end
end
class Error < StandardError
include HasConfig
def self.with_config(message, config = nil)
new(message).tap do |error|
error._set_config(config)
end
end
end
ProtocolError = Class.new(Error)
UnsupportedServer = Class.new(Error)
ConnectionError = Class.new(Error)
CannotConnectError = Class.new(ConnectionError)
FailoverError = Class.new(ConnectionError)
TimeoutError = Class.new(ConnectionError)
ReadTimeoutError = Class.new(TimeoutError)
WriteTimeoutError = Class.new(TimeoutError)
CheckoutTimeoutError = Class.new(TimeoutError)
module HasCommand
attr_reader :command
def _set_command(command)
@command = command
end
end
class CommandError < Error
include HasCommand
class << self
def parse(error_message)
code = if error_message.start_with?("ERR Error running script")
# On older redis servers script errors are nested.
# So we need to parse some more.
if (match = error_message.match(/:\s-([A-Z]+) /))
match[1]
end
end
code ||= error_message.split(' ', 2).first
klass = ERRORS.fetch(code, self)
klass.new(error_message.strip)
end
end
end
AuthenticationError = Class.new(CommandError)
PermissionError = Class.new(CommandError)
WrongTypeError = Class.new(CommandError)
OutOfMemoryError = Class.new(CommandError)
ReadOnlyError = Class.new(ConnectionError)
ReadOnlyError.include(HasCommand)
MasterDownError = Class.new(ConnectionError)
MasterDownError.include(HasCommand)
CommandError::ERRORS = {
"WRONGPASS" => AuthenticationError,
"NOPERM" => PermissionError,
"READONLY" => ReadOnlyError,
"MASTERDOWN" => MasterDownError,
"WRONGTYPE" => WrongTypeError,
"OOM" => OutOfMemoryError,
}.freeze
class << self
def config(**kwargs)
Config.new(client_implementation: self, **kwargs)
end
def sentinel(**kwargs)
SentinelConfig.new(client_implementation: self, **kwargs)
end
def new(arg = nil, **kwargs)
if arg.is_a?(Config::Common)
super
else
super(config(**(arg || {}), **kwargs))
end
end
def register(middleware)
Middlewares.include(middleware)
end
end
include Common
def initialize(config, **)
super
@middlewares = config.middlewares_stack.new(self)
@raw_connection = nil
@disable_reconnection = false
end
def inspect
id_string = " id=#{id}" if id
"#<#{self.class.name} #{config.server_url}#{id_string}>"
end
def server_url
config.server_url
end
def id
config.id
end
def timeout
config.read_timeout
end
def db
config.db
end
def host
config.host unless config.path
end
def port
config.port unless config.path
end
def path
config.path
end
def username
config.username
end
def password
config.password
end
def size
1
end
def with(_options = nil)
yield self
end
alias_method :then, :with
def timeout=(timeout)
super
@raw_connection&.read_timeout = timeout
@raw_connection&.write_timeout = timeout
end
def read_timeout=(timeout)
super
@raw_connection&.read_timeout = timeout
end
def write_timeout=(timeout)
super
@raw_connection&.write_timeout = timeout
end
def pubsub
sub = PubSub.new(ensure_connected, @command_builder)
@raw_connection = nil
sub
end
def measure_round_trip_delay
ensure_connected do |connection|
@middlewares.call(["PING"], config) do
connection.measure_round_trip_delay
end
end
end
def call(*command, **kwargs)
command = @command_builder.generate(command, kwargs)
result = ensure_connected do |connection|
@middlewares.call(command, config) do
connection.call(command, nil)
end
end
if block_given?
yield result
else
result
end
end
def call_v(command)
command = @command_builder.generate(command)
result = ensure_connected do |connection|
@middlewares.call(command, config) do
connection.call(command, nil)
end
end
if block_given?
yield result
else
result
end
end
def call_once(*command, **kwargs)
command = @command_builder.generate(command, kwargs)
result = ensure_connected(retryable: false) do |connection|
@middlewares.call(command, config) do
connection.call(command, nil)
end
end
if block_given?
yield result
else
result
end
end
def call_once_v(command)
command = @command_builder.generate(command)
result = ensure_connected(retryable: false) do |connection|
@middlewares.call(command, config) do
connection.call(command, nil)
end
end
if block_given?
yield result
else
result
end
end
def blocking_call(timeout, *command, **kwargs)
command = @command_builder.generate(command, kwargs)
error = nil
result = ensure_connected do |connection|
@middlewares.call(command, config) do
connection.call(command, timeout)
end
rescue ReadTimeoutError => error
break
end
if error
raise error
elsif block_given?
yield result
else
result
end
end
def blocking_call_v(timeout, command)
command = @command_builder.generate(command)
error = nil
result = ensure_connected do |connection|
@middlewares.call(command, config) do
connection.call(command, timeout)
end
rescue ReadTimeoutError => error
break
end
if error
raise error
elsif block_given?
yield result
else
result
end
end
def scan(*args, **kwargs, &block)
unless block_given?
return to_enum(__callee__, *args, **kwargs)
end
args = @command_builder.generate(["SCAN", 0] + args, kwargs)
scan_list(1, args, &block)
end
def sscan(key, *args, **kwargs, &block)
unless block_given?
return to_enum(__callee__, key, *args, **kwargs)
end
args = @command_builder.generate(["SSCAN", key, 0] + args, kwargs)
scan_list(2, args, &block)
end
def hscan(key, *args, **kwargs, &block)
unless block_given?
return to_enum(__callee__, key, *args, **kwargs)
end
args = @command_builder.generate(["HSCAN", key, 0] + args, kwargs)
scan_pairs(2, args, &block)
end
def zscan(key, *args, **kwargs, &block)
unless block_given?
return to_enum(__callee__, key, *args, **kwargs)
end
args = @command_builder.generate(["ZSCAN", key, 0] + args, kwargs)
scan_pairs(2, args, &block)
end
def connected?
@raw_connection&.revalidate
end
def close
@raw_connection&.close
self
end
def disable_reconnection(&block)
ensure_connected(retryable: false, &block)
end
def pipelined(exception: true)
pipeline = Pipeline.new(@command_builder)
yield pipeline
if pipeline._size == 0
[]
else
results = ensure_connected(retryable: pipeline._retryable?) do |connection|
commands = pipeline._commands
@middlewares.call_pipelined(commands, config) do
connection.call_pipelined(commands, pipeline._timeouts, exception: exception)
end
end
pipeline._coerce!(results)
end
end
def multi(watch: nil, &block)
transaction = nil
results = if watch
# WATCH is stateful, so we can't reconnect if it's used, the whole transaction
# has to be redone.
ensure_connected(retryable: false) do |connection|
call("WATCH", *watch)
begin
if transaction = build_transaction(&block)
commands = transaction._commands
results = @middlewares.call_pipelined(commands, config) do
connection.call_pipelined(commands, nil)
end.last
else
call("UNWATCH")
[]
end
rescue
call("UNWATCH") if connected? && watch
raise
end
end
else
transaction = build_transaction(&block)
if transaction._empty?
[]
else
ensure_connected(retryable: transaction._retryable?) do |connection|
commands = transaction._commands
@middlewares.call_pipelined(commands, config) do
connection.call_pipelined(commands, nil)
end.last
end
end
end
if transaction
transaction._coerce!(results)
else
results
end
end
class PubSub
def initialize(raw_connection, command_builder)
@raw_connection = raw_connection
@command_builder = command_builder
end
def call(*command, **kwargs)
raw_connection.write(@command_builder.generate(command, kwargs))
nil
end
def call_v(command)
raw_connection.write(@command_builder.generate(command))
nil
end
def close
@raw_connection&.close
@raw_connection = nil # PubSub can't just reconnect
self
end
def next_event(timeout = nil)
unless raw_connection
raise ConnectionError, "Connection was closed or lost"
end
raw_connection.read(timeout)
rescue ReadTimeoutError
nil
end
private
attr_reader :raw_connection
end
class Multi
def initialize(command_builder)
@command_builder = command_builder
@size = 0
@commands = []
@blocks = nil
@retryable = true
end
def call(*command, **kwargs, &block)
command = @command_builder.generate(command, kwargs)
(@blocks ||= [])[@commands.size] = block if block_given?
@commands << command
nil
end
def call_v(command, &block)
command = @command_builder.generate(command)
(@blocks ||= [])[@commands.size] = block if block_given?
@commands << command
nil
end
def call_once(*command, **kwargs, &block)
command = @command_builder.generate(command, kwargs)
@retryable = false
(@blocks ||= [])[@commands.size] = block if block_given?
@commands << command
nil
end
def call_once_v(command, &block)
command = @command_builder.generate(command)
@retryable = false
(@blocks ||= [])[@commands.size] = block if block_given?
@commands << command
nil
end
def _commands
@commands
end
def _blocks
@blocks
end
def _size
@commands.size
end
def _empty?
@commands.size <= 2
end
def _timeouts
nil
end
def _retryable?
@retryable
end
def _coerce!(results)
results&.each_with_index do |result, index|
if result.is_a?(CommandError)
result._set_command(@commands[index + 1])
raise result
end
if @blocks && block = @blocks[index + 1]
results[index] = block.call(result)
end
end
results
end
end
class Pipeline < Multi
def initialize(_command_builder)
super
@timeouts = nil
end
def blocking_call(timeout, *command, **kwargs, &block)
command = @command_builder.generate(command, kwargs)
@timeouts ||= []
@timeouts[@commands.size] = timeout
(@blocks ||= [])[@commands.size] = block if block_given?
@commands << command
nil
end
def blocking_call_v(timeout, command, &block)
command = @command_builder.generate(command)
@timeouts ||= []
@timeouts[@commands.size] = timeout
(@blocks ||= [])[@commands.size] = block if block_given?
@commands << command
nil
end
def _timeouts
@timeouts
end
def _empty?
@commands.empty?
end
def _coerce!(results)
return results unless results
@blocks&.each_with_index do |block, index|
if block
results[index] = block.call(results[index])
end
end
results
end
end
private
def build_transaction
transaction = Multi.new(@command_builder)
transaction.call("MULTI")
yield transaction
transaction.call("EXEC")
transaction
end
def scan_list(cursor_index, command, &block)
cursor = 0
while cursor != "0"
command[cursor_index] = cursor
cursor, elements = call(*command)
elements.each(&block)
end
nil
end
def scan_pairs(cursor_index, command)
cursor = 0
while cursor != "0"
command[cursor_index] = cursor
cursor, elements = call(*command)
index = 0
size = elements.size
while index < size
yield elements[index], elements[index + 1]
index += 2
end
end
nil
end
def ensure_connected(retryable: true)
close if !config.inherit_socket && @pid != PIDCache.pid
if @disable_reconnection
if block_given?
yield @raw_connection
else
@raw_connection
end
elsif retryable
tries = 0
connection = nil
preferred_error = nil
begin
connection = raw_connection
if block_given?
yield connection
else
connection
end
rescue ConnectionError, ProtocolError => error
preferred_error ||= error
preferred_error = error unless error.is_a?(CircuitBreaker::OpenCircuitError)
close
if !@disable_reconnection && config.retry_connecting?(tries, error)
tries += 1
retry
else
raise preferred_error
end
end
else
previous_disable_reconnection = @disable_reconnection
connection = ensure_connected
begin
@disable_reconnection = true
yield connection
rescue ConnectionError, ProtocolError
close
raise
ensure
@disable_reconnection = previous_disable_reconnection
end
end
end
def raw_connection
if @raw_connection.nil? || !@raw_connection.revalidate
connect
end
@raw_connection
end
def connect
@pid = PIDCache.pid
if @raw_connection
@middlewares.connect(config) do
@raw_connection.reconnect
end
else
@raw_connection = @middlewares.connect(config) do
config.driver.new(
config,
connect_timeout: connect_timeout,
read_timeout: read_timeout,
write_timeout: write_timeout,
)
end
end
prelude = config.connection_prelude.dup
if id
prelude << ["CLIENT", "SETNAME", id]
end
# The connection prelude is deliberately not sent to Middlewares
if config.sentinel?
prelude << ["ROLE"]
role, = @middlewares.call_pipelined(prelude, config) do
@raw_connection.call_pipelined(prelude, nil).last
end
config.check_role!(role)
else
unless prelude.empty?
@middlewares.call_pipelined(prelude, config) do
@raw_connection.call_pipelined(prelude, nil)
end
end
end
rescue FailoverError, CannotConnectError => error
error._set_config(config)
raise error
rescue ConnectionError => error
connect_error = CannotConnectError.with_config(error.message, config)
connect_error.set_backtrace(error.backtrace)
raise connect_error
rescue CommandError => error
if error.message.match?(/ERR unknown command ['`]HELLO['`]/)
raise UnsupportedServer,
"redis-client requires Redis 6+ with HELLO command available (#{config.server_url})"
else
raise
end
end
end
require "redis_client/pooled"
require "redis_client/circuit_breaker"
RedisClient.default_driver
|