bitfab 0.30.1 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a3e03384934c51dd57e27ac1213dca8f88b41ead5a0980c04bb10ba0ad464d8
-  data.tar.gz: da9c5574b00bd66ba481a78e0f1e0ce4f8e9336b35a7b2e9013498b475622237
+  metadata.gz: 8d85c35718e6138d5095d4d20278fdac5f3c6f31858684622cb3a68bad6b5416
+  data.tar.gz: 1de8519b600a8ea4a29593a82f938669d8aa9e9ec616c95102c0abe6d06045c6
 SHA512:
-  metadata.gz: 97f2755495103e92c94258f1763a1066bfc5a1944168e10dec1ad1e0bd24a58ca916791122cf3673f52326ca0d5b89b7ca8324071d40b6c408f3153167f6c95c
-  data.tar.gz: 61ba2d4b92cfa2c2665753319c6acf67dda2d48a547088d1ab47b2e9006835fe869185f3861d4e378f5c8e76167009f2580f385b5f6416467a24ae5b9dce8242
+  metadata.gz: 0c6d45ca5bbaedfd2a162e2d05c4bef6da21b31c482db91d5539fb46b79be936aa4600e2ea5d0875ecf0e608907ee92a028660edbcd08dc367ce942003658538
+  data.tar.gz: db3e762b1ce6b7cb60f4996f4642d6e2a3d5e6a7e6b886a14c319b98ae198f0f210e7af857fda35c53d4e2a49339283ae929f6338d1bae3f64f9be6b97023acc

data/lib/bitfab/client.rb

@@ -114,12 +114,12 @@ module Bitfab
     # @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",
-      adapt_inputs: nil, mock_override: nil, environment: nil, on_progress: nil)
+      adapt_inputs: nil, mock_override: nil, environment: nil, db_branch: nil, on_progress: nil)
       Replay.run(
         self, receiver, method_name,
         trace_function_key:, limit:, trace_ids:, name:, max_concurrency:,
         code_change_description:, code_change_files:, experiment_group_id:, dataset_id:, grader_ids:, mock:, adapt_inputs:,
-        mock_override:, environment:,
+        mock_override:, environment:, db_branch:,
         on_progress:
       )
     end

data/lib/bitfab/http_client.rb

@@ -118,7 +118,7 @@ module Bitfab
     #   same org and trace function or the server rejects the replay
     def start_replay(trace_function_key, limit, trace_ids: nil, code_change_description: nil,
       code_change_files: nil, experiment_group_id: nil, name: nil, include_db_branch_lease: false, dataset_id: nil,
-      grader_ids: nil)
+      grader_ids: nil, db_branch_settings: nil)
       payload = {
         "traceFunctionKey" => trace_function_key
       }
@@ -133,6 +133,7 @@ module Bitfab
       payload["includeDbBranchLease"] = 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?
 
       # When DB branching is on, the server resolves a Neon preview branch per
       # item (snapshot + restore + poll), which can run several seconds each.

data/lib/bitfab/replay.rb

@@ -136,7 +136,7 @@ module Bitfab
     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,
       dataset_id: nil, grader_ids: nil, mock: "marked",
-      adapt_inputs: nil, mock_override: nil, environment: nil, on_progress: nil)
+      adapt_inputs: nil, mock_override: nil, environment: nil, db_branch: 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
@@ -204,7 +204,8 @@ module Bitfab
         experiment_group_id:,
         include_db_branch_lease:,
         dataset_id:,
-        grader_ids:
+        grader_ids:,
+        db_branch_settings: db_branch_settings(db_branch)
       )
       test_run_id = replay_data["testRunId"]
       test_run_url = replay_data["testRunUrl"]
@@ -319,6 +320,31 @@ module Bitfab
     CC_MAX_FILE_BYTES = 500_000
     CC_MAX_TOTAL_BYTES = 2_000_000
 
+    # Convert the caller's +db_branch+ options to the wire shape, or nil when
+    # nothing was set. Dropping the key entirely keeps the request identical to
+    # what older SDKs send.
+    #
+    # Keys: :min_cu and :max_cu are the branch compute's autoscaling floor and
+    # ceiling in Neon Compute Units (equal values pin the size, keeping items
+    # comparable); :warmup_sql is appended to the branch's readiness check so it
+    # warms the cache before the replayed function sees the lease.
+    def db_branch_settings(db_branch)
+      return nil if db_branch.nil? || db_branch.empty?
+
+      # Symbol or string keys, matching normalize_code_change_files: a hash
+      # loaded from JSON or YAML would otherwise be read as empty, leaving the
+      # branch on the mirror's defaults with no error to notice.
+      min_cu = db_branch[:min_cu] || db_branch["min_cu"]
+      max_cu = db_branch[:max_cu] || db_branch["max_cu"]
+      warmup_sql = db_branch[:warmup_sql] || db_branch["warmup_sql"]
+
+      settings = {}
+      settings["minCu"] = min_cu unless min_cu.nil?
+      settings["maxCu"] = max_cu unless max_cu.nil?
+      settings["warmupSql"] = warmup_sql unless warmup_sql.nil?
+      settings.empty? ? nil : settings
+    end
+
     # Auto-capture the code change to attach when the caller passed none. Lives
     # in replay() (the one call guaranteed to run on every replay) so it works no
     # matter how the replay was launched. Precedence: a BITFAB_CODE_CHANGE_PATH
@@ -599,9 +625,19 @@ module Bitfab
       # (only when include_db_branch_lease was sent). Release it in the +ensure+
       # below so any raise (span fetch, mock-tree build, or the replayed
       # method) frees the Neon resource. Items whose source trace had no
-      # snapshot ref, or whose resolve failed server-side, arrive without a
-      # lease (env.active? is false for those).
+      # snapshot ref arrive without a lease (env.active? is false), and
+      # replaying those against the live database is correct.
       lease = include_db_branch_lease ? server_item["dbBranchLease"] : nil
+      # A resolve that was ATTEMPTED and failed is different: the caller asked
+      # 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
+      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"]}. " \
+          "The method was not run, because replaying it against the live database would " \
+          "produce a result that looks valid but did not use the historical data you asked for."
+      end
 
       span = http_client.get_external_span(original_span_id)
       item_data = extract_span_data(span)

data/lib/bitfab/replay_environment.rb

@@ -44,6 +44,13 @@ module Bitfab
       require_snapshot[:read_only]
     end
 
+    # The branch's region, e.g. "aws-us-east-1". A compute runs in its
+    # project's region, so a replay runner elsewhere pays that round trip on
+    # every query.
+    def region
+      require_snapshot[:region]
+    end
+
     # The historical trace ID that produced the input for this replay item.
     def trace_id
       require_snapshot.fetch(:trace_id)
@@ -95,6 +102,7 @@ module Bitfab
         expires_at: lease["expiresAt"],
         provider_console_url: lease["providerConsoleUrl"],
         read_only: lease["readOnly"],
+        region: lease["region"],
         trace_id:
       }
     end

data/lib/bitfab/version.rb

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

metadata

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