specbandit 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9444599b748d46d177475926a3b5f3740a6534c54a0e540c7663ee4eb4208d40
-  data.tar.gz: f7e5787ee93b270c2ba121d7edae8a2ccac5881f1bc873d65e5afcb481958e35
+  metadata.gz: 70efc56f9de13cd1e141cbb1ad39ff22cf1a07cdfbcd2c1257cefc55f5cb73fe
+  data.tar.gz: 6070e8b72aec64162a3e37190e787abbd23bf464faf74d06212e401c7c312fed
 SHA512:
-  metadata.gz: 147b0eb446363ece19f086bbdedc375f6f6a15afc8d128628cdb64881396bd7c0ad01b8fc04b2af72b8db47aa89d83af0b48c86772ea57615582e412ec80a0d6
-  data.tar.gz: ae4357cd2cfcb1a12f539c5a7f43dacfa838a5810540ca41270c8e8fb1efb672189d898d0b4182106bb2719308b0f0ecf74495aade0f904f25d7253c48c96ed9
+  metadata.gz: c7fc604a65cba2387b1177fef33ad2994e13677777d6d87b53f68aa29a00616c864dc874b5571947c4e837d0c3e25b24cc4d99d0841c94b79433258e8f5faba7
+  data.tar.gz: 7c6acd6833e1f082e2c764de7d32ab67407726d6905cc6246cbbe0921410f2ad3db4a503ee5932240414ebf413538830db54e8275adb4cd6c1f3d9bc71a195e4

data/lib/specbandit/cli.rb

@@ -131,6 +131,10 @@ module Specbandit
           Specbandit.configuration.report = v
         end
 
+        opts.on('--redis-max-attempts N', Integer, 'Redis connection retry attempts (default: 5)') do |v|
+          Specbandit.configuration.redis_max_attempts = v
+        end
+
         opts.on('--verbose', 'Show per-batch file list and full command output (default: quiet)') do
           Specbandit.configuration.verbose = true
         end

data/lib/specbandit/configuration.rb

@@ -5,7 +5,9 @@ module Specbandit
     attr_accessor :redis_url, :batch_size, :key, :rspec_opts, :key_ttl,
                   :key_rerun, :verbose,
                   :adapter, :command, :command_opts,
-                  :key_failed, :report
+                  :key_failed, :report,
+                  :redis_max_attempts, :redis_connect_timeout, :redis_timeout,
+                  :redis_reconnect_attempts
 
     DEFAULT_REDIS_URL = 'redis://localhost:6379'
     DEFAULT_BATCH_SIZE = 5
@@ -16,6 +18,17 @@ module Specbandit
     DEFAULT_KEY_TTL = 604_800 # 1 week in seconds
     DEFAULT_ADAPTER = 'cli'
 
+    # Redis connection resilience. Redis is a best-effort coordination store for
+    # a distributed test run, and CI runners can sit a WAN hop away from it
+    # (e.g. cross-datacenter mesh), so a transient blip must not red the build.
+    # We retry a handful of times with capped exponential backoff, and give the
+    # underlying client explicit connect/read/write timeouts + reconnects rather
+    # than relying on library defaults.
+    DEFAULT_REDIS_MAX_ATTEMPTS = 5
+    DEFAULT_REDIS_CONNECT_TIMEOUT = 3.0
+    DEFAULT_REDIS_TIMEOUT = 5.0
+    DEFAULT_REDIS_RECONNECT_ATTEMPTS = 3
+
     def initialize
       @redis_url = ENV.fetch('SPECBANDIT_REDIS_URL', DEFAULT_REDIS_URL)
       @batch_size = Integer(ENV.fetch('SPECBANDIT_BATCH_SIZE', DEFAULT_BATCH_SIZE))
@@ -29,12 +42,18 @@ module Specbandit
       @command_opts = parse_space_separated(ENV.fetch('SPECBANDIT_COMMAND_OPTS', nil))
       @key_failed = ENV.fetch('SPECBANDIT_KEY_FAILED', nil)
       @report = ENV.fetch('SPECBANDIT_REPORT', nil)
+
+      @redis_max_attempts = Integer(ENV.fetch('SPECBANDIT_REDIS_MAX_ATTEMPTS', DEFAULT_REDIS_MAX_ATTEMPTS))
+      @redis_connect_timeout = Float(ENV.fetch('SPECBANDIT_REDIS_CONNECT_TIMEOUT', DEFAULT_REDIS_CONNECT_TIMEOUT))
+      @redis_timeout = Float(ENV.fetch('SPECBANDIT_REDIS_TIMEOUT', DEFAULT_REDIS_TIMEOUT))
+      @redis_reconnect_attempts = Integer(ENV.fetch('SPECBANDIT_REDIS_RECONNECT_ATTEMPTS', DEFAULT_REDIS_RECONNECT_ATTEMPTS))
     end
 
     def validate!
       raise Error, 'key is required (set via --key or SPECBANDIT_KEY)' if key.nil? || key.empty?
       raise Error, 'batch_size must be a positive integer' unless batch_size.positive?
       raise Error, 'key_ttl must be a positive integer' unless key_ttl.positive?
+      raise Error, 'redis_max_attempts must be a positive integer' unless redis_max_attempts.positive?
     end
 
     private

data/lib/specbandit/redis_queue.rb

@@ -6,12 +6,28 @@ module Specbandit
   class RedisQueue
     attr_reader :redis
 
-    def initialize(redis_url: Specbandit.configuration.redis_url)
-      @redis = Redis.new(url: redis_url)
+    # Cap the exponential backoff so a real outage degrades/fails within a
+    # bounded window instead of sleeping for minutes on the last attempts.
+    MAX_BACKOFF_SECONDS = 10
+
+    def initialize(
+      redis_url: Specbandit.configuration.redis_url,
+      connect_timeout: Specbandit.configuration.redis_connect_timeout,
+      read_timeout: Specbandit.configuration.redis_timeout,
+      write_timeout: Specbandit.configuration.redis_timeout,
+      reconnect_attempts: Specbandit.configuration.redis_reconnect_attempts,
+      max_attempts: Specbandit.configuration.redis_max_attempts
+    )
+      @max_attempts = max_attempts
+      @redis = Redis.new(
+        url: redis_url,
+        connect_timeout: connect_timeout,
+        read_timeout: read_timeout,
+        write_timeout: write_timeout,
+        reconnect_attempts: reconnect_attempts
+      )
     end
 
-    MAX_ATTEMPTS = 3
-
     # Push file paths onto the queue and set an expiry on the key.
     # Returns the new length of the list.
     def push(key, files, ttl: nil)
@@ -83,7 +99,7 @@ module Specbandit
       "#{key}:published"
     end
 
-    def with_retries(attempts: MAX_ATTEMPTS)
+    def with_retries(attempts: @max_attempts)
       retries = 0
       begin
         yield
@@ -91,7 +107,7 @@ module Specbandit
         retries += 1
         raise if retries >= attempts
 
-        delay = 2**retries
+        delay = [2**retries, MAX_BACKOFF_SECONDS].min
         warn "[specbandit] Redis connection failed (attempt #{retries}/#{attempts}): #{e.message}. Retrying in #{delay}s..."
         sleep(delay)
         retry

data/lib/specbandit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Specbandit
-  VERSION = '1.0.1'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: specbandit
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Ferran Basora
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Distributed test runner using Redis as a work queue
 test_files: []