bitfab 0.33.2 → 0.33.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3dd02ac43d3ed65f11a6dcf52aa0d0d3a331fa428fb568a74147f5007fc9e22
-  data.tar.gz: 94b0cc1645fc42ce929a4fd1363de7ededc908f20dd411d3e7f8fd68d3bed0f8
+  metadata.gz: 44ebaac53c01dd84f179de5559eb3f00836c6c1a51f15520b8f10085bcfd6021
+  data.tar.gz: b7255113aef3706aefd3a1017520f24e6127503418965a0db23e70573fdd3d0e
 SHA512:
-  metadata.gz: b3a07fecf4731278963e8db381a0bfc6b4677d17bd2464f36f1d5ccfd455a8d3f066273502674158c3ac3b99a180f3017b0c5185f8e6ff3795c87b7fd2c612cb
-  data.tar.gz: 38e33c8a2dc6ab7e2e6a4c416bea15828a81724eb8ffe4b0fb440088e3b05fea53abaded2fa46bf2e852f7fd307cd5216d149b296b321a5399861861b08bd8d1
+  metadata.gz: de1b1c86dc8660477b87632d766e6f8fdf858d682248c9bd53d024fb3b423acc18d02d877ff567344e5a80aa686d0ad3e72bb02e8cc7dd099612e28ccdc02ad2
+  data.tar.gz: bb0ea7013f448acffa4644a359c0c38198ce9c74caf2b77c3d4d4c80a3f5b6f6f0bd73591ffd653b97c99af6518bc0c12460d69ac65314faf5d047541d731d1c

data/lib/bitfab/client.rb

@@ -76,9 +76,14 @@ module Bitfab
     # @param trace_ids [Array<String>, nil] optional list of trace IDs to replay (max 100)
     # @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)
+    #   code change being tested in this replay (stored on the experiment).
+    #   When supplied without code_change_files, this text is preserved while
+    #   the SDK automatically captures the files.
+    #   Pass nil when the replay should have no description; use
+    #   code_change_files: nil to suppress automatic file capture.
     # @param code_change_files [Array<Hash>, nil] optional list of edited files,
-    #   each as { path:, before:, after: } (use "" for new/deleted files)
+    #   each as { path:, before:, after: } (use "" for new/deleted files).
+    #   Omit to capture automatically, or pass nil to suppress file capture.
     # @param experiment_group_id [String, nil] optional UUID grouping multiple
     #   replay runs into a single experiment batch
     # @param dataset_id [String, nil] optional UUID of the dataset this replay
@@ -118,7 +123,7 @@ module Bitfab
     #   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,
-      name: nil, code_change_description: nil, code_change_files: nil, experiment_group_id: nil, dataset_id: nil, grader_ids: nil, mock: "marked",
+      name: nil, code_change_description: Replay::CODE_CHANGE_UNSET, code_change_files: Replay::CODE_CHANGE_UNSET, experiment_group_id: nil, dataset_id: nil, grader_ids: nil, mock: "marked",
       adapt_inputs: nil, mock_override: nil, db_branch: nil, on_progress: nil)
       Replay.run(
         self, receiver, method_name,

data/lib/bitfab/replay.rb

@@ -81,6 +81,8 @@ module Bitfab
 
   # Replay historical traces through a traced method and create a test run.
   module Replay
+    CODE_CHANGE_UNSET = Object.new.freeze
+
     module_function
 
     # Replay historical traces through a method and create a test run.
@@ -99,9 +101,14 @@ module Bitfab
     # @param name [String, nil] optional display name for the resulting experiment/test run
     # @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)
+    #   code change being tested in this replay (stored on the experiment).
+    #   When supplied without code_change_files, this text is preserved while
+    #   the SDK automatically captures the files.
+    #   Pass nil when the replay should have no description; use
+    #   code_change_files: nil to suppress automatic file capture.
     # @param code_change_files [Array<Hash>, nil] optional list of edited files,
-    #   each as { path:, before:, after: } (empty string for new/deleted files)
+    #   each as { path:, before:, after: } (empty string for new/deleted files).
+    #   Omit to capture automatically, or pass nil to suppress file capture.
     # @param experiment_group_id [String, nil] optional UUID grouping multiple
     #   replay runs into a single experiment batch
     # @param dataset_id [String, nil] optional UUID of the dataset this replay
@@ -140,7 +147,7 @@ module Bitfab
     #   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, name: nil,
-      max_concurrency: 10, code_change_description: nil, code_change_files: nil, experiment_group_id: nil,
+      max_concurrency: 10, code_change_description: CODE_CHANGE_UNSET, code_change_files: CODE_CHANGE_UNSET, experiment_group_id: nil,
       dataset_id: nil, grader_ids: nil, mock: "marked",
       adapt_inputs: nil, mock_override: nil, db_branch: nil, on_progress: nil)
       unless MOCK_STRATEGIES.include?(mock.to_s)
@@ -187,18 +194,18 @@ module Bitfab
 
       include_db_branch_lease = !db_branch.nil?
 
-      # An explicit code change always wins; only when the caller passed neither
-      # field do we fall back to the payload the replay wrapper captured from git
-      # and handed over via BITFAB_CODE_CHANGE_PATH. This is what makes an
-      # experiment show its diff even when the run happened outside the
-      # assistant's make-change rails.
-      if code_change_description.nil? && code_change_files.nil?
+      # code_change_files controls capture: omitted auto-captures, an array
+      # wins, and explicit nil opts out. Preserve a caller-supplied description
+      # while filling only the omitted files.
+      if code_change_files.equal?(CODE_CHANGE_UNSET)
         captured = resolve_auto_code_change(name)
         unless captured.nil?
-          code_change_description = captured[0]
           code_change_files = captured[1]
+          code_change_description = captured[0] if code_change_description.equal?(CODE_CHANGE_UNSET)
         end
       end
+      code_change_description = nil if code_change_description.equal?(CODE_CHANGE_UNSET)
+      code_change_files = nil if code_change_files.equal?(CODE_CHANGE_UNSET)
 
       resolved_db_branch_settings = db_branch_settings(db_branch)
       replay_data = http_client.start_replay(

data/lib/bitfab/version.rb

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

metadata

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