bitfab 0.33.1 → 0.33.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42832c5915e35905df60dae19b3a619fbaa221940e540618897b569be3db9b05
-  data.tar.gz: 833c23b94c2a6fa1194056775798d0a8e26ec52436489193f96884a993805f65
+  metadata.gz: 44ebaac53c01dd84f179de5559eb3f00836c6c1a51f15520b8f10085bcfd6021
+  data.tar.gz: b7255113aef3706aefd3a1017520f24e6127503418965a0db23e70573fdd3d0e
 SHA512:
-  metadata.gz: 8e42d4c2c6392450ba1fd8f7cc3dd7ce5c3f8362859474dac1ed8bb4289db9db1ed968f05d524a3aa4110809510334e88df62cc161eff66e7965147b5098695a
-  data.tar.gz: b432abe485b5a331e750ef2203f2f9d6d8c16b5ff0d0804268218e0a82a3fcc2ea09104381aff75cc1bdb8d4fcb7a5e99708839b61cce8d449371331fa58f325
+  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/http_client.rb

@@ -11,6 +11,9 @@ require_relative "warn_once"
 
 module Bitfab
   class HttpClient
+    REPLAY_DB_BRANCH_REQUEST_TIMEOUT_SECONDS = 300
+    private_constant :REPLAY_DB_BRANCH_REQUEST_TIMEOUT_SECONDS
+
     attr_reader :service_url
 
     def initialize(api_key:, service_url: nil, timeout: 120)
@@ -131,6 +134,7 @@ module Bitfab
       payload["codeChangeFiles"] = normalize_code_change_files(code_change_files) unless code_change_files.nil?
       payload["experimentGroupId"] = experiment_group_id unless experiment_group_id.nil?
       payload["includeDbBranchLease"] = true if include_db_branch_lease
+      payload["lazyDbBranchLease"] = true if include_db_branch_lease
       payload["datasetId"] = dataset_id unless dataset_id.nil?
       payload["graderIds"] = grader_ids unless grader_ids.nil?
       payload["dbBranchSettings"] = db_branch_settings unless db_branch_settings.nil?
@@ -143,7 +147,7 @@ module Bitfab
       # sits above the server's own ceiling so the server's error is the one
       # callers see. Net::HTTP would otherwise default to 60s here, which the
       # branch creation alone can outlast.
-      timeout = include_db_branch_lease ? 300 : 30
+      timeout = include_db_branch_lease ? REPLAY_DB_BRANCH_REQUEST_TIMEOUT_SECONDS : 30
       request("/api/sdk/replay/start", payload, timeout:)
     end
 
@@ -194,6 +198,16 @@ module Bitfab
       request("/api/sdk/replay/releaseDbBranchLease", {"neonBranchId" => neon_branch_id}, timeout: 30)
     end
 
+    def resolve_db_branch_lease(test_run_id, trace_id, db_branch_settings = nil)
+      payload = {"testRunId" => test_run_id, "traceId" => trace_id}
+      payload["dbBranchSettings"] = db_branch_settings unless db_branch_settings.nil?
+      request(
+        "/api/sdk/replay/resolveDbBranchLease",
+        payload,
+        timeout: REPLAY_DB_BRANCH_REQUEST_TIMEOUT_SECONDS
+      )
+    end
+
     # Send an external trace (fire-and-forget in background thread).
     def send_external_trace(payload)
       merged = payload.merge("sdkVersion" => VERSION)

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,19 +194,20 @@ 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(
         trace_function_key,
         effective_limit,
@@ -211,7 +219,7 @@ module Bitfab
         include_db_branch_lease:,
         dataset_id:,
         grader_ids:,
-        db_branch_settings: db_branch_settings(db_branch)
+        db_branch_settings: resolved_db_branch_settings
       )
       test_run_id = replay_data["testRunId"]
       test_run_url = replay_data["testRunUrl"]
@@ -219,7 +227,8 @@ 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, on_progress:, mock_overrides: resolved_overrides)
+          adapt_inputs, include_db_branch_lease, resolved_db_branch_settings, on_progress:,
+          mock_overrides: resolved_overrides)
       else
         []
       end
@@ -528,7 +537,8 @@ 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, on_progress: nil, mock_overrides: [])
+      adapt_inputs = nil, include_db_branch_lease = false, db_branch_settings = nil, on_progress: nil,
+      mock_overrides: [])
       concurrency = max_concurrency || server_items.length
 
       # Reports running totals once per item as it settles. In the parallel
@@ -584,7 +594,7 @@ module Bitfab
       if concurrency <= 1
         server_items.map do |item|
           result = process_single_item(http_client, item, receiver, method_name, test_run_id, mock_strategy,
-            adapt_inputs, include_db_branch_lease, mock_overrides:)
+            adapt_inputs, include_db_branch_lease, db_branch_settings, mock_overrides:)
           report.call(result, original_trace_id_of(item), original_span_id_of(item), test_run_id)
           result
         end
@@ -601,7 +611,7 @@ module Bitfab
               break unless item
 
               result = process_single_item(http_client, item, receiver, method_name, test_run_id, mock_strategy,
-                adapt_inputs, include_db_branch_lease, mock_overrides:)
+                adapt_inputs, include_db_branch_lease, db_branch_settings, mock_overrides:)
               results_mutex.synchronize { results[idx] = result }
               report.call(result, original_trace_id_of(item), original_span_id_of(item), test_run_id)
             end
@@ -620,7 +630,7 @@ module Bitfab
     # than propagated, so one bad trace never aborts the whole replay run
     # (mirrors the TypeScript and Python SDKs' per-item rescue).
     def process_single_item(http_client, server_item, receiver, method_name, test_run_id, mock_strategy,
-      adapt_inputs = nil, include_db_branch_lease = false, mock_overrides: [])
+      adapt_inputs = nil, include_db_branch_lease = false, db_branch_settings = nil, mock_overrides: [])
       metrics = extract_server_item_metrics(server_item)
       # The ORIGINAL (historical) trace/span this item replays. Canonical
       # keys are originalTraceId/originalSpanId; older servers send them under
@@ -638,6 +648,13 @@ module Bitfab
       # for a branch, so running their method against live data would produce a
       # result that looks valid and is not. Fail the item instead, loudly.
       lease_error = include_db_branch_lease ? server_item["dbBranchLeaseError"] : nil
+      db_snapshot_ref = server_item["dbSnapshotRef"]
+      if include_db_branch_lease && lease.nil? && lease_error.nil?
+        resolved = http_client.resolve_db_branch_lease(test_run_id, original_trace_id, db_branch_settings)
+        lease = resolved["lease"]
+        lease_error = resolved["leaseError"]
+        db_snapshot_ref = resolved["dbSnapshotRef"] || db_snapshot_ref
+      end
       if lease_error
         raise "Replay requested a database branch for trace #{original_trace_id} but it " \
           "could not be resolved (#{lease_error["code"]}): #{lease_error["message"]}. " \
@@ -709,7 +726,7 @@ module Bitfab
         adapt_ctx:,
         db_branch_lease: lease,
         source_bitfab_trace_id: original_trace_id,
-        db_snapshot_ref: server_item["dbSnapshotRef"]
+        db_snapshot_ref:
       )
     rescue => e
       warn "Bitfab: replay item for span #{original_span_id} failed before execution: #{e.message}"
@@ -727,7 +744,7 @@ module Bitfab
         # Deprecated aliases for original_trace_id/original_span_id.
         source_trace_id: original_trace_id,
         source_span_id: original_span_id,
-        db_snapshot_ref: server_item["dbSnapshotRef"]
+        db_snapshot_ref:
       }
     ensure
       release_db_branch_lease(http_client, lease) if lease

data/lib/bitfab/version.rb

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

metadata

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