bitfab 0.17.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dd280a2cd6afdf47b2bbbf62508dd4918dccf42c83ed276845f592497168601
-  data.tar.gz: 224fc7cfe39e847f3bfd56e9876151ea356f7a8ad7bff66b529f9704ab360141
+  metadata.gz: 9624757032370e1e318121cabcf2bfa984c7bcdcd07c9ecd5dcee449fef57a7c
+  data.tar.gz: c3925bbae804c16d21c3f373ec6cde4de340ee645fc6423505fc0b5d5f5e638e
 SHA512:
-  metadata.gz: 4cba57762a9ae927ba34ac70fdd1d750d118a9f8f3cc47402f30d8a09c336337f27cef601f8b36e63140e01acaa410d1a58450f160cb1c3d7e7c2c5b1a198cb3
-  data.tar.gz: eaa0a0b2eed0c0f7c0e24a73e2128540c53a504e9a3dd4d6858355e8076aa2fa8a4913ea170b278ac1579c5e407d4333759e1bae345dbe575b9fa91b666275a1
+  metadata.gz: d2c33cd4a3432d79703685f00bb8c8278e2bebbd694b3a695f1dee646680a5af11370f233635f04590eeb0d5cedee850c496b40bee2fc176c34cf22fb721cde8
+  data.tar.gz: c64be06a07ca8ea807bca23e0f96acb15e1647945b33c3ea731f10c0b52759870b88637d86b680aee07caac7836e3818946f2fb85f0979d83b3ea89ef8ea1704

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

@@ -5,6 +5,7 @@ require "json"
 require "uri"
 
 require_relative "constants"
+require_relative "serialize"
 require_relative "version"
 
 module Bitfab
@@ -32,7 +33,7 @@ module Bitfab
         http.read_timeout = request_timeout
 
         req = Net::HTTP::Post.new(uri.path, headers)
-        req.body = JSON.generate(payload)
+        req.body = safe_generate(payload, endpoint)
 
         response = http.request(req)
 
@@ -105,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
       }
@@ -118,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.
@@ -166,6 +170,46 @@ module Bitfab
 
     private
 
+    # JSON-encode a request body without ever raising on a stray value.
+    #
+    # Upstream serialization (Serialize.serialize_value) should already have
+    # flattened user data. This is the boundary backstop: if anything
+    # non-serializable still slips through, it is run through serialize_value
+    # (which never raises and stubs strays) instead of letting JSON.generate
+    # raise and drop the whole span/trace silently. A degraded payload warns
+    # loudly so the trace isn't quietly left incomplete or not replayable.
+    def safe_generate(payload, endpoint)
+      JSON.generate(payload)
+    rescue => e
+      begin
+        warn "Bitfab: request body to #{endpoint} held a non-serializable " \
+             "value (#{e.message}); it was stubbed so the span still sends, " \
+             "but the trace may be incomplete or not replayable. Capture a " \
+             "JSON-safe projection of this input to make it replayable."
+      rescue
+        # Never crash the host app over a log line.
+      end
+
+      begin
+        JSON.generate(sanitize_payload(payload))
+      rescue
+        # Truly pathological. Still never drop silently: send a marker body.
+        JSON.generate({"error" => "payload_serialize_failed"})
+      end
+    end
+
+    # Serialize each top-level value so a bad or oversize value is stubbed in
+    # place while the payload keeps its object shape. Running serialize_value on
+    # the whole payload could collapse the entire body to a single stub string
+    # (oversize/cyclic), sending a JSON string instead of a span object.
+    def sanitize_payload(payload)
+      return {"error" => "payload_serialize_failed"} unless payload.is_a?(Hash)
+
+      payload.each_with_object({}) do |(k, v), acc|
+        acc[k.to_s] = Serialize.serialize_value(v)
+      end
+    end
+
     # Normalize each entry to a hash with stable string keys, accepting either
     # symbol-keyed or string-keyed hashes from callers.
     def normalize_code_change_files(files)

data/lib/bitfab/replay.rb

@@ -88,6 +88,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 +101,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(", ")}"
@@ -130,7 +132,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/version.rb

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

metadata

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