bitfab 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d85c35718e6138d5095d4d20278fdac5f3c6f31858684622cb3a68bad6b5416
-  data.tar.gz: 1de8519b600a8ea4a29593a82f938669d8aa9e9ec616c95102c0abe6d06045c6
+  metadata.gz: 6c30821c7a2d174dacfae3c40d838cf9b37d2f71e07be3b95aa385507cd26867
+  data.tar.gz: f041e1f63eedc9397c55d70f635ca75d0f365c7b6a970f943b6a282bcc4b10e9
 SHA512:
-  metadata.gz: 0c6d45ca5bbaedfd2a162e2d05c4bef6da21b31c482db91d5539fb46b79be936aa4600e2ea5d0875ecf0e608907ee92a028660edbcd08dc367ce942003658538
-  data.tar.gz: db3e762b1ce6b7cb60f4996f4642d6e2a3d5e6a7e6b886a14c319b98ae198f0f210e7af857fda35c53d4e2a49339283ae929f6338d1bae3f64f9be6b97023acc
+  metadata.gz: 8427f0d34ca1fbafcbd1d8582da7d24fba552635e23fdc9cba0a5afe1198a3f0f712c1c7c3a25b4229abc441c8fc4057bc7bb284f6e830173213d4194410d699
+  data.tar.gz: e4472dd0149b0a604439da779a5bae825f8313b41f2270701ab77b1ee46baf286c636d6022ce0df65cbca995525a0a53418ba4f2d839db582be7a17be41c9c15

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, db_branch: nil, on_progress: nil)
+      adapt_inputs: nil, mock_override: nil, environment: 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:, db_branch:,
+        mock_override:, environment:,
         on_progress:
       )
     end

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, db_branch: nil, on_progress: nil)
+      adapt_inputs: nil, mock_override: 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
@@ -205,7 +205,7 @@ module Bitfab
         include_db_branch_lease:,
         dataset_id:,
         grader_ids:,
-        db_branch_settings: db_branch_settings(db_branch)
+        db_branch_settings: db_branch_settings(environment)
       )
       test_run_id = replay_data["testRunId"]
       test_run_url = replay_data["testRunUrl"]
@@ -320,7 +320,7 @@ 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
+    # Convert the environment's 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.
     #
@@ -328,12 +328,13 @@ module Bitfab
     # 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)
+    def db_branch_settings(environment)
+      db_branch = environment&.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.
+      # assembled 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"]

data/lib/bitfab/replay_environment.rb

@@ -16,10 +16,40 @@ module Bitfab
   # context, so each in-flight replay item sees its own per-trace values even
   # when the SDK runs items across worker threads.
   #
+  # The constructor takes how each branch should be sized and warmed. That
+  # lives here rather than on the replay arguments because the settings only
+  # mean anything for a replay that has an environment.
+  #
   # Internally the resolved per-item state is a DB branch lease (the SDK <->
   # server protocol term). We expose its useful fields directly here so
   # customer code never sees the word.
   class ReplayEnvironment
+    # The branch settings this environment was constructed with, as a
+    # symbol-keyed hash, readable anywhere. Every other reader reports the
+    # lease the server resolved and is therefore replay-only.
+    attr_reader :db_branch
+
+    # @param min_cu [Numeric, nil] autoscaling floor for the branch's compute,
+    #   in Neon Compute Units (0.25 to 56). Omit to keep the mirror project's
+    #   own default. Raise it when the mirror is provisioned smaller than the
+    #   database it stands in for, so replay latency reflects your code rather
+    #   than a cold, undersized branch.
+    # @param max_cu [Numeric, nil] autoscaling ceiling, in Neon Compute Units.
+    #   Equal to +min_cu+ pins the size, which keeps items comparable:
+    #   otherwise a later item can run against an endpoint that already scaled
+    #   up and post a better number for the same code.
+    # @param warmup_sql [String, nil] SQL that warms the branch's cache. The
+    #   server appends it to the branch's readiness check, so it runs BEFORE
+    #   your method sees the lease and its time is not charged to the replayed
+    #   call. Invalid SQL fails the lease rather than silently leaving the
+    #   branch cold.
+    def initialize(min_cu: nil, max_cu: nil, warmup_sql: nil)
+      @db_branch = {}
+      @db_branch[:min_cu] = min_cu unless min_cu.nil?
+      @db_branch[:max_cu] = max_cu unless max_cu.nil?
+      @db_branch[:warmup_sql] = warmup_sql unless warmup_sql.nil?
+    end
+
     # The per-trace branch URL for the item currently being replayed.
     # Raises if read outside a replay item.
     def database_url

data/lib/bitfab/version.rb

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

metadata

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