support for manual setting the timing key that will be updated

Author: ctrochalakis

README.md

@@ -69,6 +69,7 @@ OPTIONS:
         --redis-host HOST            Redis host to connect to (default: 127.0.0.1).
         --redis-url URL              Redis URL to connect to (e.g.: redis://127.0.0.1:6379/0).
         --update-timings             Update the global job timings key with the timings of this build. Note: This key is used as the basis for job scheduling.
+        --timings-key KEY            Update KEY instead of the default global timings key.
         --file-split-threshold N     Split spec files slower than N seconds and schedule them as individual examples.
         --early-push-max-jobs N      Only emit up to N jobs early
         --graceful-shutdown-signal   Graceful shutdown worker on signal.
@@ -100,6 +101,7 @@ $ RSPECQ_BUILD=123 RSPECQ_WORKER=foo1 rspecq spec/
 | `RSPECQ_SEED` | RSpec seed |
 | `RSPECQ_REDIS` | Redis HOST |
 | `RSPECQ_UPDATE_TIMINGS` | Timings |
+| `RSPECQ_TIMINGS_KEY` | Timings key to update (reporter only) |
 | `RSPECQ_FILE_SPLIT_THRESHOLD` | File split threshold |
 | `RSPECQ_EARLY_PUSH_MAX_JOBS` | Push jobs early up to a certain number |
 | `RSPECQ_GRACEFUL_SHUTDOWN_SIGNAL` | Graceful worker shutdown signal |

bin/rspecq

@@ -70,6 +70,10 @@ OptionParser.new do |o|
     opts[:update_timings] = v
   end
 
+  o.on("--timings-key KEY", "Update KEY instead of the default global job timings key.") do |v|
+    opts[:timings_key] = v
+  end
+
   o.on("--file-split-threshold N", Integer, "Split spec files slower than N " \
        "seconds and schedule them as individual examples.") do |v|
     opts[:file_split_threshold] = v
@@ -147,6 +151,7 @@ opts[:worker] ||= ENV.fetch("RSPECQ_WORKER", nil)
 opts[:seed] ||= ENV.fetch("RSPECQ_SEED", nil)
 opts[:redis_host] ||= ENV["RSPECQ_REDIS"] || DEFAULT_REDIS_HOST
 opts[:update_timings] ||= env_set?("RSPECQ_UPDATE_TIMINGS")
+opts[:timings_key] ||= ENV.fetch("RSPECQ_TIMINGS_KEY", nil)
 opts[:file_split_threshold] ||= Integer(ENV["RSPECQ_FILE_SPLIT_THRESHOLD"] || 9_999_999)
 opts[:early_push_max_jobs] ||= Integer(ENV["RSPECQ_EARLY_PUSH_MAX_JOBS"]) if ENV["RSPECQ_EARLY_PUSH_MAX_JOBS"]
 opts[:graceful_shutdown_signal] ||= ENV.fetch("RSPECQ_GRACEFUL_SHUTDOWN_SIGNAL", DEFAULT_GRACEFUL_SHUTDOWN_SIGNAL)
@@ -181,6 +186,7 @@ if opts[:report]
     timeout: opts[:report_timeout],
     redis_opts: redis_opts,
     update_timings: opts[:update_timings],
+    timings_key: opts[:timings_key],
     queue_wait_timeout: opts[:queue_wait_timeout]
   )
 

lib/rspecq/queue.rb

@@ -239,8 +239,8 @@ def record_build_timing(job, duration)
 
     # Persist build timings to the global timings key, so that they can be
     # used for scheduling future builds.
-    def update_global_timings
-      @redis.copy(key_build_timings, key_timings, replace: true)
+    def update_global_timings(dst = key_timings)
+      @redis.copy(key_build_timings, dst, replace: true)
     end
 
     def record_build_time(duration)

lib/rspecq/reporter.rb

@@ -14,12 +14,16 @@ class Reporter
     # Defaults to false
     attr_accessor :update_timings
 
-    def initialize(build_id:, timeout:, redis_opts:, queue_wait_timeout: 30, update_timings: false)
+    def initialize(build_id:, timeout:, redis_opts:,
+                   queue_wait_timeout: 30,
+                   update_timings: false,
+                   timings_key: nil)
       @build_id = build_id
       @timeout = timeout
       @queue = Queue.new(build_id, "reporter", redis_opts)
       @queue_wait_timeout = queue_wait_timeout
       @update_timings = update_timings
+      @timings_key = timings_key
 
       # We want feedback to be immediattely printed to CI users, so
       # we disable buffering.
@@ -62,8 +66,13 @@ def report
       @queue.record_build_time(build_duration) if build_duration
 
       if update_timings && @queue.build_successful?
-        puts "Updating global job timings"
-        @queue.update_global_timings
+        if @timings_key
+          puts "Updating job timings @ #{@timings_key}"
+          @queue.update_global_timings(@timings_key)
+        else
+          puts "Updating global job timings"
+          @queue.update_global_timings
+        end
       end
 
       flaky_jobs = @queue.flaky_jobs

test/test_e2e.rb

@@ -91,6 +91,25 @@ def test_build_timings_update
     ], queue.build_timings.sort_by { |_, v| v }.map(&:first)
   end
 
+  def test_global_timings_update_different_key
+    queue = exec_build("timings")
+
+    custom_key = "timings-#{rand_id}"
+    exec_reporter("--update-timings --timings-key=#{custom_key}", build_id: queue.build_id)
+
+    assert queue.build_successful?
+
+    redis = Redis.new(REDIS_OPTS)
+    assert_equal [
+      "./spec/very_fast_spec.rb",
+      "./spec/fast_spec.rb",
+      "./spec/medium_spec.rb",
+      "./spec/slow_spec.rb",
+      "./spec/very_slow_spec.rb",
+    ], redis.zrevrange(custom_key, 0, -1, withscores: true).to_h
+            .sort_by { |_, v| v }.map(&:first)
+  end
+
   def test_global_timings_update
     queue = exec_build("timings")
     exec_reporter("--update-timings", build_id: queue.build_id)