bitfab 0.20.2 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2428cc39dcd97d154e36ba9792628478e86a4b4dde5101c79d37ebb1635378f
-  data.tar.gz: effa0dba40674696ad3d9155615d9d9e2e40a3fe7f9aed9c8ee97516985e13c6
+  metadata.gz: 7536f774b491c131b04a135a41c5f753c7c507615e54aa675c314cff785b08df
+  data.tar.gz: 47e7804161bc40563f5aca99147ef43d2af1af6d73d22f6ad3ae3402ea4b51f4
 SHA512:
-  metadata.gz: 5f172f0178829a08315ae1caf3de6ff4a22389b2f83dbf449721ca53ca3a466580af00c15bd5279dffc2c9d074aee2afd0e157733f9257987460ef8d101350c9
-  data.tar.gz: 9c6af19d4ebac35d13280aeaa89ac6104cbff3020e24813e292e4170c6524016a0df943025f3ced5510345c863e4b86f9f027fe281912e99a6438f863dde9d28
+  metadata.gz: 4aed7d077e6aa0ca89e8130b526578276591e60b41ae10670dc14db4eaca6221c30481dcad84acb8d7dfd7e549b2b92aa2c5a750efa36c4df85224b01360fe19
+  data.tar.gz: d73a3933eceba9c705fdab9f8b38f9f46766e026e59cdf61ee0ca2ea49a01ec4e5029fcbc87161a0a16602a2365ef3eeddba1acff27e659bf8fcf69b08d85138

data/lib/bitfab/client.rb

@@ -59,14 +59,21 @@ module Bitfab
     #   onto the method's current signature when its shape changed after the
     #   traces were captured. Receives (args, kwargs, ctx) where ctx is
     #   { trace_id:, source_span_id: }, and returns [new_args, new_kwargs].
+    # @param on_progress [#call, nil] optional callback invoked once per item as
+    #   it finishes, with a running-totals hash { completed:, total:, succeeded:,
+    #   errored: }. Use it to render replay progress (e.g. a terminal progress
+    #   bar). Replay does not know pass/fail yet, so the totals only distinguish
+    #   items whose method ran (:succeeded) from items that raised (:errored).
+    #   A raising callback never crashes the run.
     # @return [Hash] with :items, :test_run_id, :test_run_url
     def replay(receiver, method_name, trace_function_key:, limit: nil, trace_ids: nil, max_concurrency: 10,
       code_change_description: nil, code_change_files: nil, experiment_group_id: nil, dataset_id: nil, mock: "none",
-      adapt_inputs: nil, environment: nil)
+      adapt_inputs: nil, environment: nil, on_progress: nil)
       Replay.run(
         self, receiver, method_name,
         trace_function_key:, limit:, trace_ids:, max_concurrency:,
-        code_change_description:, code_change_files:, experiment_group_id:, dataset_id:, mock:, adapt_inputs:, environment:
+        code_change_description:, code_change_files:, experiment_group_id:, dataset_id:, mock:, adapt_inputs:, environment:,
+        on_progress:
       )
     end
 

data/lib/bitfab/replay.rb

@@ -100,10 +100,14 @@ module Bitfab
     #   { trace_id:, source_span_id: }, and returns [new_args, new_kwargs]. Runs
     #   per item inside the same rescue as the method, so a raising adapter sets
     #   that item's :error rather than crashing the run.
+    # @param on_progress [#call, nil] optional callback invoked once per item as
+    #   it finishes, with a running-totals hash { completed:, total:, succeeded:,
+    #   errored: }. Use it to render replay progress (e.g. a terminal progress
+    #   bar). A raising callback never crashes the run.
     # @return [Hash] with :items, :test_run_id, :test_run_url
     def run(client, receiver, method_name, trace_function_key:, limit: nil, trace_ids: nil, max_concurrency: 10,
       code_change_description: nil, code_change_files: nil, experiment_group_id: nil, dataset_id: nil, mock: "none",
-      adapt_inputs: nil, environment: nil)
+      adapt_inputs: nil, environment: nil, on_progress: nil)
       unless MOCK_STRATEGIES.include?(mock.to_s)
         raise ArgumentError, "Invalid mock strategy '#{mock}'. Must be one of: #{MOCK_STRATEGIES.join(", ")}"
       end
@@ -157,7 +161,7 @@ module Bitfab
 
       result_items = if server_items.any?
         process_items(http_client, server_items, receiver, method_name, test_run_id, max_concurrency, mock.to_s,
-          adapt_inputs, include_db_branch_lease)
+          adapt_inputs, include_db_branch_lease, on_progress:)
       else
         []
       end
@@ -237,13 +241,39 @@ module Bitfab
 
     # Process all replay items, optionally in parallel using threads.
     def process_items(http_client, server_items, receiver, method_name, test_run_id, max_concurrency, mock_strategy,
-      adapt_inputs = nil, include_db_branch_lease = false)
+      adapt_inputs = nil, include_db_branch_lease = false, on_progress: nil)
       concurrency = max_concurrency || server_items.length
 
+      # Reports running totals once per item as it settles. In the parallel
+      # path it runs from worker threads, so the mutex both makes the counter
+      # updates safe and serializes the user's callback (never called
+      # concurrently). A raising callback is swallowed: progress UI must never
+      # crash the run.
+      total = server_items.length
+      progress_mutex = Mutex.new
+      completed = 0
+      succeeded = 0
+      errored = 0
+      report = lambda do |result|
+        return unless on_progress
+
+        progress_mutex.synchronize do
+          completed += 1
+          result[:error].nil? ? (succeeded += 1) : (errored += 1)
+          begin
+            on_progress.call({completed:, total:, succeeded:, errored:})
+          rescue => e
+            warn "Bitfab: replay on_progress callback raised: #{e.message}"
+          end
+        end
+      end
+
       if concurrency <= 1
         server_items.map do |item|
-          process_single_item(http_client, item, receiver, method_name, test_run_id, mock_strategy, adapt_inputs,
-            include_db_branch_lease)
+          result = process_single_item(http_client, item, receiver, method_name, test_run_id, mock_strategy,
+            adapt_inputs, include_db_branch_lease)
+          report.call(result)
+          result
         end
       else
         results_mutex = Mutex.new
@@ -260,6 +290,7 @@ module Bitfab
               result = process_single_item(http_client, item, receiver, method_name, test_run_id, mock_strategy,
                 adapt_inputs, include_db_branch_lease)
               results_mutex.synchronize { results[idx] = result }
+              report.call(result)
             end
           end
         end

data/lib/bitfab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bitfab
-  VERSION = "0.20.2"
+  VERSION = "0.21.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitfab
 version: !ruby/object:Gem::Version
-  version: 0.20.2
+  version: 0.21.0
 platform: ruby
 authors:
 - Harvest Team