ci-queue 0.65.0 → 0.67.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bd235c5c9a18d43b30d5fc614e960e297b60fbaa3391a47db9eaa07cfa1bb4f
-  data.tar.gz: 9f61f75c48456aaac0abb2b25e3cb200a22f00baf5c5612828bd61b54a59ed46
+  metadata.gz: d3a701add5867e968b8dcc2c8d9fe301f88b54ede5b0f2f615171fa1d620e6bd
+  data.tar.gz: 401f2f2c45c09edbd609c177a077b1aec2fe361f376439d6f5b8a29770d7e488
 SHA512:
-  metadata.gz: 640842ac7e07b54184cab3a9881ec5f0401f3c128b6d8bf0011d576650e94c4f85864664fcc51b3fac6d6028b4fd95a7943364aa397e060acc3ddc56647662f6
-  data.tar.gz: 4d8aa80210424460498cb29bee6fb7d18db2f1a9c453550c98e4133f34862d7a9882df5c60bf0b0f88e245210af7b6be943cf811c20d3e0f5a53d5ab2bf8e8dd
+  metadata.gz: f32ff8fa093d89df2194ac043943de43acfedbc5cbcf942c3638d0cc6ccf9659eb107dbf87ef04b3f19ba8329adf1b1275cb2125b8bc9c3cafd7072b49de3e5c
+  data.tar.gz: 01c75cfae762cb874df2160b04c7b96d14d7665631dfaaf642553587b14f7e86bd4d093aad6b9feefa3bee67b6626c3b2a143f3695f50b942579c59949eb16ed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ci-queue (0.65.0)
+    ci-queue (0.67.0)
       logger
 
 GEM

data/lib/ci/queue/redis/acknowledge.lua

@@ -2,9 +2,18 @@
 local zset_key = KEYS[1]
 local processed_key = KEYS[2]
 local owners_key = KEYS[3]
+local error_reports_key = KEYS[4]
 
 local test = ARGV[1]
-
+local error = ARGV[2]
+local ttl = ARGV[3]
 redis.call('zrem', zset_key, test)
 redis.call('hdel', owners_key, test)  -- Doesn't matter if it was reclaimed by another workers
-return redis.call('sadd', processed_key, test)
+local acknowledged = redis.call('sadd', processed_key, test)
+
+if acknowledged and error ~= "" then
+  redis.call('hset', error_reports_key, test, error)
+  redis.call('expire', error_reports_key, ttl)
+end
+
+return acknowledged

data/lib/ci/queue/redis/base.rb

@@ -11,6 +11,8 @@ module CI
           ::SocketError, # https://github.com/redis/redis-rb/pull/631
         ].freeze
 
+        DEFAULT_TIMEOUT = 2
+
         module RedisInstrumentation
           def call(command, redis_config)
             logger = redis_config.custom[:debug_log]
@@ -45,9 +47,10 @@ module CI
               # ci-queue should not contain any sensitive data, so we can just disable the verification.
               ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE },
               custom: custom_config,
+              timeout: DEFAULT_TIMEOUT,
             )
           else
-            @redis = ::Redis.new(url: redis_url)
+            @redis = ::Redis.new(url: redis_url, timeout: DEFAULT_TIMEOUT)
           end
         end
 
@@ -178,8 +181,8 @@ module CI
           master_status == 'setup'
         end
 
-        def increment_test_failed
-          redis.incr(key('test_failed_count'))
+        def increment_test_failed(pipeline: redis)
+          pipeline.incr(key('test_failed_count'))
         end
 
         def test_failed
@@ -222,8 +225,8 @@ module CI
           redis.get(key('master-status'))
         end
 
-        def eval_script(script, *args)
-          redis.evalsha(load_script(script), *args)
+        def eval_script(script, keys:, argv:, pipeline: redis)
+          pipeline.evalsha(load_script(script), keys: keys, argv: argv)
         end
 
         def load_script(script)

data/lib/ci/queue/redis/build_record.rb

@@ -56,23 +56,22 @@ module CI
           redis.rpush(key('warnings'), Marshal.dump([type, attributes]))
         end
 
+        Test = Struct.new(:id) # Hack
+
         def record_error(id, payload, stats: nil)
           redis.pipelined do |pipeline|
-            pipeline.hset(
-              key('error-reports'),
-              id.dup.force_encoding(Encoding::BINARY),
-              payload.dup.force_encoding(Encoding::BINARY),
-            )
-            pipeline.expire(key('error-reports'), config.redis_ttl)
+            @queue.acknowledge(id, error: payload, pipeline: pipeline)
             record_stats(stats, pipeline: pipeline)
+            @queue.increment_test_failed(pipeline: pipeline)
           end
           nil
         end
 
-        def record_success(id, stats: nil, skip_flaky_record: false)
+        def record_success(id, stats: nil, skip_flaky_record: false, acknowledge: true)
+          @queue.acknowledge(id) if acknowledge
           error_reports_deleted_count, requeued_count, _ = redis.pipelined do |pipeline|
-            pipeline.hdel(key('error-reports'), id.dup.force_encoding(Encoding::BINARY))
-            pipeline.hget(key('requeues-count'), id.b)
+            pipeline.hdel(key('error-reports'), id)
+            pipeline.hget(key('requeues-count'), id)
             record_stats(stats, pipeline: pipeline)
           end
           record_flaky(id) if !skip_flaky_record && (error_reports_deleted_count.to_i > 0 || requeued_count.to_i > 0)

data/lib/ci/queue/redis/grind_record.rb

@@ -14,7 +14,7 @@ module CI
           redis.pipelined do |pipeline|
             pipeline.lpush(
               key('error-reports'),
-              payload.force_encoding(Encoding::BINARY),
+              payload,
             )
             pipeline.expire(key('error-reports'), config.redis_ttl)
             record_stats(stats, pipeline: pipeline)

data/lib/ci/queue/redis/test_time_record.rb

@@ -22,7 +22,7 @@ module CI
           redis.pipelined do |pipeline|
             pipeline.lpush(
               test_time_key(test_name),
-              duration.to_s.force_encoding(Encoding::BINARY),
+              duration.to_s,
             )
             pipeline.expire(test_time_key(test_name), config.redis_ttl)
           end
@@ -33,7 +33,7 @@ module CI
           redis.pipelined do |pipeline|
             pipeline.lpush(
               all_test_names_key,
-              test_name.dup.force_encoding(Encoding::BINARY),
+              test_name,
             )
             pipeline.expire(all_test_names_key, config.redis_ttl)
           end
@@ -53,11 +53,11 @@ module CI
         end
 
         def all_test_names_key
-          "build:#{config.build_id}:list_of_test_names".dup.force_encoding(Encoding::BINARY)
+          "build:#{config.build_id}:list_of_test_names"
         end
 
         def test_time_key(test_name)
-          "build:#{config.build_id}:#{test_name}".dup.force_encoding(Encoding::BINARY)
+          "build:#{config.build_id}:#{test_name}"
         end
       end
     end

data/lib/ci/queue/redis/worker.rb

@@ -97,13 +97,13 @@ module CI
           build.report_worker_error(error)
         end
 
-        def acknowledge(test)
-          test_key = test.id
+        def acknowledge(test_key, error: nil, pipeline: redis)
           raise_on_mismatching_test(test_key)
           eval_script(
             :acknowledge,
-            keys: [key('running'), key('processed'), key('owners')],
-            argv: [test_key],
+            keys: [key('running'), key('processed'), key('owners'), key('error-reports')],
+            argv: [test_key, error.to_s, config.redis_ttl],
+            pipeline: pipeline,
           ) == 1
         end
 
@@ -146,11 +146,11 @@ module CI
           config.worker_id
         end
 
-        def raise_on_mismatching_test(test)
-          if @reserved_test == test
+        def raise_on_mismatching_test(test_key)
+          if @reserved_test == test_key
             @reserved_test = nil
           else
-            raise ReservationError, "Acknowledged #{test.inspect} but #{@reserved_test.inspect} was reserved"
+            raise ReservationError, "Acknowledged #{test_key.inspect} but #{@reserved_test.inspect} was reserved"
           end
         end
 
@@ -201,7 +201,14 @@ module CI
         def push(tests)
           @total = tests.size
 
-          if @master = redis.setnx(key('master-status'), 'setup')
+          # We set a unique value (worker_id) and read it back to make "SET if Not eXists" idempotent in case of a retry.
+          value = key('setup', worker_id)
+          _, status = redis.pipelined do |pipeline|
+            pipeline.set(key('master-status'), value, nx: true)
+            pipeline.get(key('master-status'))
+          end
+
+          if @master = (value == status)
             puts "Worker electected as leader, pushing #{@total} tests to the queue."
             puts
 

data/lib/ci/queue/redis.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+gem "redis", "~> 5.0"
 require 'redis'
 require 'ci/queue/redis/build_record'
 require 'ci/queue/redis/base'

data/lib/ci/queue/static.rb

@@ -103,12 +103,12 @@ module CI
         @queue.empty?
       end
 
-      def acknowledge(test)
+      def acknowledge(...)
         @progress += 1
         true
       end
 
-      def increment_test_failed
+      def increment_test_failed(...)
         @test_failed = test_failed + 1
       end
 

data/lib/ci/queue/version.rb

@@ -2,7 +2,7 @@
 
 module CI
   module Queue
-    VERSION = '0.65.0'
+    VERSION = '0.67.0'
     DEV_SCRIPTS_ROOT = ::File.expand_path('../../../../../redis', __FILE__)
     RELEASE_SCRIPTS_ROOT = ::File.expand_path('../redis', __FILE__)
   end

data/lib/minitest/queue/build_status_recorder.rb

@@ -52,7 +52,7 @@ module Minitest
         if (test.failure || test.error?) && !test.skipped?
           build.record_error("#{test.klass}##{test.name}", dump(test), stats: stats)
         else
-          build.record_success("#{test.klass}##{test.name}", stats: stats, skip_flaky_record: test.skipped?)
+          build.record_success("#{test.klass}##{test.name}", stats: stats, skip_flaky_record: test.skipped?, acknowledge: !test.requeued?)
         end
       end
 

data/lib/minitest/queue.rb

@@ -150,6 +150,7 @@ module Minitest
     end
 
     class SingleExample
+      attr_reader :method_name
 
       def initialize(runnable, method_name)
         @runnable = runnable
@@ -250,15 +251,8 @@ module Minitest
 
         if failed && CI::Queue.requeueable?(result) && queue.requeue(example)
           result.requeue!
-          reporter.record(result)
-        elsif queue.acknowledge(example)
-          reporter.record(result)
-          queue.increment_test_failed if failed
-        elsif !failed
-          # If the test was already acknowledged by another worker (we timed out)
-          # Then we only record it if it is successful.
-          reporter.record(result)
         end
+        reporter.record(result)
       end
       queue.stop_heartbeat!
     rescue Errno::EPIPE

data/lib/rspec/queue.rb

@@ -224,13 +224,8 @@ module RSpec
             reporter.cancel_run!
             dup.mark_as_requeued!(reporter)
             return true
-          elsif reporter.acknowledge || !@exception
-            # If the test was already acknowledged by another worker (we timed out)
-            # Then we only record it if it is successful.
-            super(reporter)
           else
-            reporter.cancel_run!
-            return
+            super(reporter)
           end
         else
           super(reporter)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ci-queue
 version: !ruby/object:Gem::Version
-  version: 0.65.0
+  version: 0.67.0
 platform: ruby
 authors:
 - Jean Boussier
@@ -254,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Distribute tests over many workers using a queue
 test_files: []