Add support for a custom TTL of Redis keys, defaulting to 8 hours

Author: Doug Edey

README.md

@@ -37,6 +37,9 @@ Two implementations are provided, please refer to the respective documentations:
   - [Python](python/)
   - [Ruby](ruby/)
 
+## Redis Requirements
+
+`ci-queue` expects the Redis server to have an [eviction policy](https://redis.io/docs/manual/eviction/#eviction-policies) of `allkeys-lru`.
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/ci-queue.

ruby/README.md

@@ -70,3 +70,9 @@ rspec-queue --queue redis://example.com --timeout 600 --report
 #### Limitations
 
 Because of how `ci-queue` executes the examples, `before(:all)` and `after(:all)` hooks are not supported. `rspec-queue` will explicitly reject them.
+
+## Custom Redis Expiry
+
+`ci-queue` expects the Redis server to have an [eviction policy](https://redis.io/docs/manual/eviction/#eviction-policies) of `allkeys-lru`.
+
+You can also use `--report-expires-in` to set a custom expiration time for all CI Queue keys, this defaults to 8 hours (28,800 seconds)

ruby/lib/ci/queue/configuration.rb

@@ -5,7 +5,7 @@ class Configuration
       attr_accessor :timeout, :worker_id, :max_requeues, :grind_count, :failure_file
       attr_accessor :requeue_tolerance, :namespace, :failing_test, :statsd_endpoint
       attr_accessor :max_test_duration, :max_test_duration_percentile, :track_test_duration
-      attr_accessor :max_test_failed
+      attr_accessor :max_test_failed, :report_expires_in
       attr_reader :circuit_breakers
       attr_writer :seed, :build_id
       attr_writer :queue_init_timeout
@@ -34,7 +34,7 @@ def initialize(
         namespace: nil, seed: nil, flaky_tests: [], statsd_endpoint: nil, max_consecutive_failures: nil,
         grind_count: nil, max_duration: nil, failure_file: nil, max_test_duration: nil,
         max_test_duration_percentile: 0.5, track_test_duration: false, max_test_failed: nil,
-        queue_init_timeout: nil
+        queue_init_timeout: nil, report_expires_in: 8 * 60 * 60
       )
         @build_id = build_id
         @circuit_breakers = [CircuitBreaker::Disabled]
@@ -55,6 +55,7 @@ def initialize(
         @worker_id = worker_id
         self.max_consecutive_failures = max_consecutive_failures
         self.max_duration = max_duration
+        @report_expires_in = report_expires_in
       end
 
       def queue_init_timeout

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

@@ -41,6 +41,7 @@ def record_error(id, payload, stats: nil)
               id.dup.force_encoding(Encoding::BINARY),
               payload.dup.force_encoding(Encoding::BINARY),
             )
+            pipeline.expire(key('error-reports'), config.report_expires_in)
             record_stats(stats, pipeline: pipeline)
           end
           nil
@@ -90,6 +91,7 @@ def record_stats(stats, pipeline: redis)
           return unless stats
           stats.each do |stat_name, stat_value|
             pipeline.hset(key(stat_name), config.worker_id, stat_value)
+            pipeline.expire(key(stat-name), config.report_expires_in)
           end
         end
 

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

@@ -16,6 +16,7 @@ def record_error(payload, stats: nil)
               key('error-reports'),
               payload.force_encoding(Encoding::BINARY),
             )
+            pipeline.expire(key('error-reports'), config.report_expires_in)
             record_stats(stats, pipeline: pipeline)
           end
           nil
@@ -58,6 +59,7 @@ def record_stats(stats, pipeline: redis)
           return unless stats
           stats.each do |stat_name, stat_value|
             pipeline.hset(key(stat_name), config.worker_id, stat_value)
+            pipeline.expire(key(stat_name), config.report_expires_in)
           end
         end
       end

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

@@ -24,6 +24,7 @@ def record_test_time(test_name, duration)
               test_time_key(test_name),
               duration.to_s.force_encoding(Encoding::BINARY),
             )
+            pipeline.expire(test_time_key(test_name), config.report_expires_in)
           end
           nil
         end
@@ -34,6 +35,7 @@ def record_test_name(test_name)
               all_test_names_key,
               test_name.dup.force_encoding(Encoding::BINARY),
             )
+            pipeline.expire(all_test_names_key, config.report_expires_in)
           end
           nil
         end

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

@@ -53,6 +53,10 @@ def poll
               sleep 0.05
             end
           end
+          redis.pipelined do |pipeline|
+            pipeline.expire(key('worker', worker_id, 'queue'), config.report_expires_in)
+            pipeline.expire(key('processed'), config.report_expires_in)
+          end
         rescue *CONNECTION_ERRORS
         end
 
@@ -198,9 +202,14 @@ def push(tests)
               transaction.lpush(key('queue'), tests) unless tests.empty?
               transaction.set(key('total'), @total)
               transaction.set(key('master-status'), 'ready')
+
+              transaction.expire(key('queue'), config.report_expires_in)
+              transaction.expire(key('total'), config.report_expires_in)
+              transaction.expire(key('master-status'), config.report_expires_in)
             end
           end
           register
+          redis.expire(key('workers'), config.report_expires_in)
         rescue *CONNECTION_ERRORS
           raise if @master
         end

ruby/lib/minitest/queue/runner.rb

@@ -487,6 +487,14 @@ def parser
             end
           end
 
+          help = <<~EOS
+            Defines how long the test report remain after the test run, in seconds.
+            Defaults to 28,800 (8 hours)
+          EOS
+          opts.on("--report-expires-in SECONDS", Integer, help) do |time|
+            queue.config.report_expires_in = time
+          end
+
           opts.separator ""
           opts.separator "    retry: Replays a previous run in the same order."
 

ruby/lib/rspec/queue.rb

@@ -157,6 +157,15 @@ def parser(options)
           queue_config.max_consecutive_failures = Integer(max)
         end
 
+        help = <<~EOS
+          Defines how long the test report remain after the test run, in seconds.
+          Defaults to 28,800 (8 hours)
+        EOS
+        parsed.separator ""
+        parser.on("--report-expires-in SECONDS", Integer, help) do |time|
+          queue.config.report_expires_in = time
+        end
+
         parser
       end