bitfab 0.18.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4401b0c7aa47516909e636557ab23f325fb0cbbd4ca8564f3d8864078e58f975
-  data.tar.gz: 2b11fbfee500e0e03ec7b4b61772d623e2c236479965441b659aafbed4a687a6
+  metadata.gz: cd571926bd40dc39f337e87f9977bfb0fe3219c21532dc1cf7be382c175a4559
+  data.tar.gz: 17ff724ae1a42f97fa6eae82c97404de8dc9cef738a18674d76da48ba9ea762d
 SHA512:
-  metadata.gz: e720bb8dd79d572f4671b5f891cb1528dac2b610d2357d1f16ec5a7e04656fff0969f434e5e683be991d8745865bacbbe1e37993380e1a09d2cc9377e221eda5
-  data.tar.gz: c197da185d7966cd9861213c49f0db4e3246a5eab0bdb70e800d8a4a5a4e8f174b5294d833511232555d43f0ca026a7988297fa3660743a8fef94b05b17a7ca9
+  metadata.gz: 012d3433d2d59200c812557a95b4f2b7cb8d93d7885d9495f59b7e21d89a892ffcc3c0bb83200f4c9f324320d5a1153f4c59bd2facac2dc1924174a7f184d81f
+  data.tar.gz: 69aaffc897238560ebecf6fedbd81509eda58fd082126107585a913cc74a025456a32111356902251a0c5b3439ff2b84ef7ea5aac4325a10e531c93a5d460334

data/lib/bitfab/client.rb

@@ -50,6 +50,8 @@ module Bitfab
     #   each as { path:, before:, after: } (use "" for new/deleted files)
     # @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
+    #   runs against, stored on the resulting experiment for durable attribution
     # @param mock [String] mock strategy for child spans: "none" (default),
     #   "all", or "marked". "all" mocks every child span; "marked" only mocks
     #   spans declared with mock_on_replay: true.
@@ -59,12 +61,12 @@ module Bitfab
     #   { trace_id:, source_span_id: }, and returns [new_args, new_kwargs].
     # @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,
-      code_change_description: nil, code_change_files: nil, experiment_group_id: nil, mock: "none",
+      code_change_description: nil, code_change_files: nil, experiment_group_id: nil, dataset_id: nil, mock: "none",
       adapt_inputs: nil, environment: nil)
       Replay.run(
         self, receiver, method_name,
         trace_function_key:, limit:, trace_ids:, max_concurrency:,
-        code_change_description:, code_change_files:, experiment_group_id:, mock:, adapt_inputs:, environment:
+        code_change_description:, code_change_files:, experiment_group_id:, dataset_id:, mock:, adapt_inputs:, environment:
       )
     end
 

data/lib/bitfab/http_client.rb

@@ -106,8 +106,10 @@ module Bitfab
     #   each as { path:, before:, after: } (use "" for new/deleted files)
     # @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
+    #   runs against, stored on the resulting experiment for durable attribution
     def start_replay(trace_function_key, limit, trace_ids: nil, code_change_description: nil,
-      code_change_files: nil, experiment_group_id: nil, include_db_branch_lease: false)
+      code_change_files: nil, experiment_group_id: nil, include_db_branch_lease: false, dataset_id: nil)
       payload = {
         "traceFunctionKey" => trace_function_key
       }
@@ -119,6 +121,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["datasetId"] = dataset_id unless dataset_id.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

@@ -2,6 +2,7 @@
 
 require_relative "constants"
 require_relative "serialize"
+require_relative "traceable"
 
 module Bitfab
   # Replay mock strategies. Mirrors the Python and TypeScript SDKs.
@@ -88,6 +89,8 @@ module Bitfab
     #   each as { path:, before:, after: } (empty string for new/deleted files)
     # @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
+    #   runs against, stored on the resulting experiment for durable attribution
     # @param mock [String] mock strategy for child spans: "none" (default),
     #   "all", or "marked". "all" mocks every child span; "marked" only mocks
     #   spans declared with mock_on_replay: true.
@@ -99,7 +102,7 @@ module Bitfab
     #   that item's :error rather than crashing 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, max_concurrency: 10,
-      code_change_description: nil, code_change_files: nil, experiment_group_id: nil, mock: "none",
+      code_change_description: nil, code_change_files: nil, experiment_group_id: nil, dataset_id: nil, mock: "none",
       adapt_inputs: nil, environment: nil)
       unless MOCK_STRATEGIES.include?(mock.to_s)
         raise ArgumentError, "Invalid mock strategy '#{mock}'. Must be one of: #{MOCK_STRATEGIES.join(", ")}"
@@ -115,6 +118,21 @@ module Bitfab
           "determines how many traces replay."
       end
 
+      # Reject a trace_function_key that contradicts the method's declared key.
+      # replay() fetches historical traces by trace_function_key but records the
+      # replayed spans under the method's own bitfab_span key (via send below),
+      # so a mismatch produces an incoherent test run (traces fetched for one
+      # function, recorded under another). Only fires when the method's key is
+      # introspectable; an untraced method falls through to the persistence
+      # check in complete_replay. Mirrors the TypeScript/Python SDKs.
+      declared_key = Traceable.trace_function_key_for(receiver, method_name)
+      if declared_key && declared_key != trace_function_key
+        raise ArgumentError,
+          "Method #{method_name} is traced under trace function key '#{declared_key}' but replay was " \
+          "called with '#{trace_function_key}'. Pass trace_function_key: '#{declared_key}' to replay it, " \
+          "or point at the method traced under '#{trace_function_key}'."
+      end
+
       http_client = client.instance_variable_get(:@http_client)
 
       # limit is meaningless with explicit trace_ids (the ID list determines
@@ -130,7 +148,8 @@ module Bitfab
         code_change_description:,
         code_change_files:,
         experiment_group_id:,
-        include_db_branch_lease:
+        include_db_branch_lease:,
+        dataset_id:
       )
       test_run_id = replay_data["testRunId"]
       test_run_url = replay_data["testRunUrl"]

data/lib/bitfab/traceable.rb

@@ -69,9 +69,43 @@ module Bitfab
         end
       end
 
+      wrapper.instance_variable_set(:@bitfab_span_method, method_name_str)
+      wrapper.instance_variable_set(:@bitfab_span_key, trace_function_key)
       klass.prepend(wrapper)
     end
 
+    # Resolve the trace function key a traced method records spans under, or
+    # nil if the method carries no Bitfab span wrapper. Walks the receiver's
+    # ancestor chain for the wrapper module that bitfab_span / Traceable.wrap
+    # prepended. Instances resolve via the class. A Class/Module receiver
+    # resolves either way: singleton-class ancestors first (class/module
+    # methods wrapped on the singleton class), then the class's own ancestors
+    # (methods whose wrapper was prepended onto the class itself), so a
+    # class-method replay is guarded regardless of which surface carries the
+    # wrapper. Singleton-first keeps the method actually dispatched by
+    # `receiver.send` (a class method shadows a same-named instance wrapper).
+    #
+    # replay() uses this to reject a trace_function_key that contradicts the
+    # method's declared key: a mismatch fetches one function's historical
+    # traces but re-records the replay under the method's own key, producing
+    # an incoherent test run. Mirrors the TypeScript and Python SDKs, which
+    # throw on the same key mismatch.
+    def self.trace_function_key_for(receiver, method_name)
+      name = method_name.to_s
+      ancestors = if receiver.is_a?(Module)
+        receiver.singleton_class.ancestors + receiver.ancestors
+      else
+        receiver.class.ancestors
+      end
+      ancestors.each do |mod|
+        next unless mod.instance_variable_defined?(:@bitfab_span_method)
+        next unless mod.instance_variable_get(:@bitfab_span_method) == name
+
+        return mod.instance_variable_get(:@bitfab_span_key)
+      end
+      nil
+    end
+
     module ClassMethods
       # Set the trace function key for this class.
       # All spans declared in this class will be grouped under this key.
@@ -152,6 +186,8 @@ module Bitfab
           end
         end
 
+        wrapper.instance_variable_set(:@bitfab_span_method, method_name_str)
+        wrapper.instance_variable_set(:@bitfab_span_key, trace_function_key)
         prepend(wrapper)
       end
     end

data/lib/bitfab/version.rb

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

metadata

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