bitfab 0.58.3 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 959d7652dd7c6e3fdfea18c79e759300b2ebf826401f0e0601ea3642eae84034
-  data.tar.gz: bc7820f643314689a9440247edf0e81d4c234208ce1c903db7a9cb904da685fe
+  metadata.gz: 0f71ead77c070efe05df2af12495ef411048fd0164655e0f1fbe11a5457b518c
+  data.tar.gz: 4e9a222f559e2977366ecf411f97429db22f89d1aca6b8b6de767b982594f8ce
 SHA512:
-  metadata.gz: a92544b809ea07e087e55b031d82130baf820f636cf41b4d90f4d1a0d1d3513024d733c6cdbe57e74dd7832552c0029816424f25c0fe65e1e585168b8908221e
-  data.tar.gz: 691217d535f95027773b65454c40470901a393aef97906283fe9f33ea38a05bd21b70105dbc8d0344c9fffaa1fb6839ecc99fc5b7480c879761189ca343e0b0d
+  metadata.gz: 406d7de1521d252c335432fa44c04fd7f3e11f0992281388d8939140ab05b5b055cb3cd5a4dc6bf30cfba15a40795f7c1f21782d989bbbebd1abeac62e5ff7fc
+  data.tar.gz: 9e80632bfc746766ffd6011ceb45848a2875590e29b2f9c983b4c4ed344b722c310a15a760b6d4bd99045357f9def49b08904bb53618ad0dedbf5b33c2c4cffe

data/lib/bitfab/client.rb

@@ -425,6 +425,13 @@ module Bitfab
         span_id = SecureRandom.uuid
         parent_span_id = parent&.dig(:span_id)
         is_root_span = parent_span_id.nil?
+        ancestor_span_id = nearest_captured_ancestor_span_id
+        open_instrumentation = (surface == :trace) ? "trace" : "span"
+        sends_on_completion = lambda do
+          is_root_span || declared_node || !content_off_by_simulation_plan?(
+            trace_id:, trace_function_key:, span_name:, instrumentation: open_instrumentation
+          )
+        end
         started_at = Bitfab.now_iso_timestamp
         resolved_test_run_id = replay_ctx ? replay_ctx[:test_run_id] : test_run_id
         resolved_input_source_span_id = replay_ctx&.dig(:input_source_span_id)
@@ -550,6 +557,7 @@ module Bitfab
             span_data: content_off ? span_data.merge("content_off_by_simulation_plan" => true) : span_data,
             instrumentation: recorded_instrumentation,
             declared_node:,
+            nearest_captured_ancestor_span_id: ancestor_span_id,
             trace_function_key:,
             trace_id:,
             span_id:,
@@ -618,7 +626,8 @@ module Bitfab
             span_id:,
             explicit_span_receiver:,
             explicit_span_method_name: explicit_span_method_name&.to_sym,
-            surface:, recording_override:, content_withheld:
+            surface:, recording_override:, content_withheld:,
+            sends_on_completion: sends_on_completion
           ) do
             invoke = -> { around_body ? around_body.call { yield } : yield }
             result = if explicit_span_receiver
@@ -683,6 +692,14 @@ module Bitfab
       raise ArgumentError, "id must be a valid Bitfab span ID" unless id.is_a?(String) && UUID_PATTERN.match?(id)
     end
 
+    def nearest_captured_ancestor_span_id
+      SpanContext.stack.reverse_each do |entry|
+        sends = entry[:sends_on_completion]
+        return entry[:span_id] if sends.nil? || sends.call
+      end
+      nil
+    end
+
     def content_off_by_simulation_plan?(trace_id:, trace_function_key:, span_name:, instrumentation: "span")
       return false if SimulationPlan::FRAMEWORKS.include?(instrumentation)
 
@@ -927,7 +944,8 @@ module Bitfab
     def send_span(trace_function_key:, trace_id:, span_id:, parent_span_id:,
       span_name:, span_type:, function_name:, contexts:, prompt:, args:, kwargs:, result:, error:,
       started_at:, ended_at:, test_run_id: nil, input_source_span_id: nil, mocked: false,
-      mock_target: nil, mock_source: nil, span_data: {}, instrumentation: "span", declared_node: false)
+      mock_target: nil, mock_source: nil, span_data: {}, instrumentation: "span", declared_node: false,
+      nearest_captured_ancestor_span_id: nil)
       extra_span_data = span_data
       # If drop() was called on this trace, suppress the span PAYLOAD upload for
       # every span that completes after the flag was set. The trace completion
@@ -983,6 +1001,9 @@ module Bitfab
         "span_origin" => Bitfab.make_span_origin(instrumentation)
       }
       raw_span["parent_id"] = parent_span_id if parent_span_id
+      if nearest_captured_ancestor_span_id && nearest_captured_ancestor_span_id != parent_span_id
+        raw_span["nearest_captured_ancestor_id"] = nearest_captured_ancestor_span_id
+      end
       raw_span["input_source_span_id"] = input_source_span_id if input_source_span_id
 
       payload = {

data/lib/bitfab/datasets.rb

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
 
 module Bitfab
+  class GraderRerunError < StandardError
+    attr_reader :run
+
+    def initialize(message, run:)
+      super(message)
+      @run = run
+    end
+  end
+
+  class GraderRerunTimeoutError < GraderRerunError; end
+
   # Dataset operations for the authenticated organization, reached as
   # `client.datasets`. A dataset is a named bucket of traces scoped to one
   # trace function. Experiments replay against it and its graders score its
@@ -8,7 +19,8 @@ module Bitfab
   # string keys matching the HTTP API ("traceCount", "addedTraceIds", ...).
   class Datasets
     DEFAULT_RERUN_TIMEOUT_SECONDS = 90
-    DEFAULT_RERUN_POLL_INTERVAL_SECONDS = 1
+    RERUN_POLL_INTERVAL_SECONDS = 1.0
+    private_constant :RERUN_POLL_INTERVAL_SECONDS
     TERMINAL_RERUN_STATUSES = ["completed", "errored"].freeze
 
     def initialize(http_client)
@@ -86,22 +98,21 @@ module Bitfab
     end
 
     # Re-run graders over every trace in the dataset. Defaults to every
-    # assigned grader, and an unassigned id is rejected. Waits for the run to
-    # finish (up to `timeout` seconds) unless `wait:` is false, and returns the
-    # last run state seen either way. A request matching an in-flight run
-    # joins it.
-    def rerun_graders(dataset_id, grader_ids: nil, wait: true,
-      timeout: DEFAULT_RERUN_TIMEOUT_SECONDS, poll_interval: DEFAULT_RERUN_POLL_INTERVAL_SECONDS)
+    # assigned grader, and an unassigned id is rejected. Blocks until the run
+    # completes and returns it. Raises GraderRerunError when the run errors and
+    # GraderRerunTimeoutError when it is still going after `timeout` seconds.
+    # The run keeps going on Bitfab after a timeout. A request matching an
+    # in-flight run joins it.
+    def rerun_graders(dataset_id, grader_ids: nil, timeout: DEFAULT_RERUN_TIMEOUT_SECONDS)
       payload = grader_ids.nil? ? {} : {"graderIds" => grader_ids}
       started = @http_client.request(dataset_path(dataset_id, "/rerunGraders"), payload)
-      return started unless wait
-
       deadline = monotonic_now + timeout
       run = started["run"]
       while !TERMINAL_RERUN_STATUSES.include?(run["status"]) && monotonic_now < deadline
-        sleep(poll_interval)
+        sleep(RERUN_POLL_INTERVAL_SECONDS)
         run = get_grader_rerun(dataset_id, run_id: run["id"]) || run
       end
+      settle_grader_rerun(dataset_id, run, timeout)
       {"run" => run, "joinedExisting" => started["joinedExisting"]}
     end
 
@@ -114,6 +125,24 @@ module Bitfab
 
     private
 
+    def settle_grader_rerun(dataset_id, run, timeout)
+      case run["status"]
+      when "completed"
+        nil
+      when "errored"
+        raise GraderRerunError.new(
+          "Grader re-run on dataset #{dataset_id} errored: #{run["error"] || "no reason recorded"}",
+          run:
+        )
+      else
+        raise GraderRerunTimeoutError.new(
+          "Grader re-run #{run["id"]} on dataset #{dataset_id} is still #{run["status"]} after #{timeout} seconds. " \
+          "It keeps going on Bitfab. Read it later with get_grader_rerun(#{dataset_id.inspect}, run_id: #{run["id"].inspect}).",
+          run:
+        )
+      end
+    end
+
     def dataset_path(dataset_id, suffix = "")
       "/api/sdk/datasets/#{URI.encode_www_form_component(dataset_id)}#{suffix}"
     end

data/lib/bitfab/span_context.rb

@@ -150,8 +150,9 @@ module Bitfab
 
     # Execute a block with a new span pushed onto the stack.
     # The span is automatically popped when the block completes.
-    def with_span(trace_id:, span_id:, explicit_span_receiver: nil, explicit_span_method_name: nil, surface: nil, recording_override: nil, content_withheld: nil)
+    def with_span(trace_id:, span_id:, explicit_span_receiver: nil, explicit_span_method_name: nil, surface: nil, recording_override: nil, content_withheld: nil, sends_on_completion: nil)
       entry = {trace_id:, span_id:}
+      entry[:sends_on_completion] = sends_on_completion if sends_on_completion
       entry[:surface] = surface if surface
       entry[:recording_override] = recording_override if recording_override
       entry[:content_withheld] = content_withheld if content_withheld

data/lib/bitfab/version.rb

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

metadata

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