bitfab 0.10.4 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5d6df92ce06e91ff963c8dc0e78af3a0f591c51b53330c1c8630bb5d66e7663
-  data.tar.gz: 199d4883cfad921563b3b5786d2db5b017d4b618e000c7d259ed9f69be3eb7ba
+  metadata.gz: b789df310c91a7e9130f3bdb6a35e6237a8ddadede4df49a5f7dc4afc0525e91
+  data.tar.gz: 0cd79b9c9bc8bf15ef926625c0aa1aba8f3cf1798062c0d077e371d98b9f6aba
 SHA512:
-  metadata.gz: 02c87809df7f4039dd608d3e60ddc0ff85b791d834ea7dc5557a368987d5dba1a174705074a26a9df80d4a8bb7c4ff7493f4c8ac03beb457629d896768a70567
-  data.tar.gz: 579f94120498658ceeb5129b3a21a9d1477d816be9216963c168e0c8747aef0687298f632539f33ace2960db53a19a9ab7847f776d27d971e1b006ad1ebbc909
+  metadata.gz: fbf62eeabc5741c36ef1b867730f548039f20331d6591ccae7a66cc48882cd4638877edc1b80d57c3a326827edfbedff1d3ec226ed3b4e3358f9041e3405ea5f
+  data.tar.gz: 579cb384585a42160d5f1c9941cbf0762f53d35ffda7f109cb40c4c52a291a02d446e113ca664a2c84a08916481fe86912eb386a58956fb5651ff1a6dc108771

data/lib/bitfab/client.rb

@@ -36,9 +36,18 @@ module Bitfab
     # @param limit [Integer] maximum number of traces to replay (default: 5)
     # @param trace_ids [Array<String>, nil] optional list of trace IDs to filter
     # @param max_concurrency [Integer, nil] max threads for parallel replay (default: 10)
+    # @param code_change_description [String, nil] optional rationale for the
+    #   code change being tested in this replay (stored on the experiment)
+    # @param code_change_files [Array<Hash>, nil] optional list of edited files,
+    #   each as { path:, before:, after: } (use "" for new/deleted files)
     # @return [Hash] with :items, :test_run_id, :test_run_url
-    def replay(receiver, method_name, trace_function_key:, limit: 5, trace_ids: nil, max_concurrency: 10)
-      Replay.run(self, receiver, method_name, trace_function_key:, limit:, trace_ids:, max_concurrency:)
+    def replay(receiver, method_name, trace_function_key:, limit: 5, trace_ids: nil, max_concurrency: 10,
+      code_change_description: nil, code_change_files: nil)
+      Replay.run(
+        self, receiver, method_name,
+        trace_function_key:, limit:, trace_ids:, max_concurrency:,
+        code_change_description:, code_change_files:
+      )
     end
 
     # Execute a block inside a span context, sending trace data on completion.

data/lib/bitfab/http_client.rb

@@ -98,12 +98,19 @@ module Bitfab
 
     # Start a replay session by fetching historical traces.
     # Blocking call. Returns hash with testRunId, testRunUrl, and items array.
-    def start_replay(trace_function_key, limit, trace_ids: nil)
+    #
+    # @param code_change_description [String, nil] optional rationale for the
+    #   code change being tested in this replay
+    # @param code_change_files [Array<Hash>, nil] optional list of edited files,
+    #   each as { path:, before:, after: } (use "" for new/deleted files)
+    def start_replay(trace_function_key, limit, trace_ids: nil, code_change_description: nil, code_change_files: nil)
       payload = {
         "traceFunctionKey" => trace_function_key,
         "limit" => limit
       }
       payload["traceIds"] = trace_ids if trace_ids
+      payload["codeChangeDescription"] = code_change_description unless code_change_description.nil?
+      payload["codeChangeFiles"] = normalize_code_change_files(code_change_files) unless code_change_files.nil?
 
       request("/api/sdk/replay/start", payload, timeout: 30)
     end
@@ -129,6 +136,18 @@ module Bitfab
 
     private
 
+    # Normalize each entry to a hash with stable string keys, accepting either
+    # symbol-keyed or string-keyed hashes from callers.
+    def normalize_code_change_files(files)
+      files.map do |file|
+        {
+          "path" => file[:path] || file["path"],
+          "before" => file[:before] || file["before"],
+          "after" => file[:after] || file["after"]
+        }
+      end
+    end
+
     def headers
       {
         "Content-Type" => "application/json",

data/lib/bitfab/replay.rb

@@ -42,11 +42,22 @@ module Bitfab
     # @param limit [Integer] maximum number of traces to replay (default: 5)
     # @param trace_ids [Array<String>, nil] optional list of trace IDs to filter
     # @param max_concurrency [Integer, nil] max threads for parallel replay (default: 10)
+    # @param code_change_description [String, nil] optional rationale for the
+    #   code change being tested in this replay (stored on the experiment)
+    # @param code_change_files [Array<Hash>, nil] optional list of edited files,
+    #   each as { path:, before:, after: } (empty string for new/deleted files)
     # @return [Hash] with :items, :test_run_id, :test_run_url
-    def run(client, receiver, method_name, trace_function_key:, limit: 5, trace_ids: nil, max_concurrency: 10)
+    def run(client, receiver, method_name, trace_function_key:, limit: 5, trace_ids: nil, max_concurrency: 10,
+      code_change_description: nil, code_change_files: nil)
       http_client = client.instance_variable_get(:@http_client)
 
-      replay_data = http_client.start_replay(trace_function_key, limit, trace_ids:)
+      replay_data = http_client.start_replay(
+        trace_function_key,
+        limit,
+        trace_ids:,
+        code_change_description:,
+        code_change_files:
+      )
       test_run_id = replay_data["testRunId"]
       test_run_url = replay_data["testRunUrl"]
       server_items = replay_data["items"] || []

data/lib/bitfab/version.rb

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

metadata

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