bitfab 0.36.0 → 0.36.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b5fdfbac8e62c59768ba554cd7c68b6fb7de3f1a37befd01a66cc6097821499
-  data.tar.gz: 31bb825d1fcde3c946c5467bb6e1ccbd56816815b38ba4f3eb5395bdb5061907
+  metadata.gz: 44af81a548095fe4bf8a347b6e58bb1c3bdcf2726becd78f029ec5c7c9507ca9
+  data.tar.gz: 4a00a95452cf45e5992e7eee4754850923eed8767713368a063fa1fed84d4b7c
 SHA512:
-  metadata.gz: efd78672cf98417507533b22bc0d4783ad7c29a18c4e9f419d95e328831275c26b4d15888642f07e19cd7a85b62babe55e223576d6a4885228fea4243ab84607
-  data.tar.gz: 83dc9683122eefbe92fc747d783fb81351acc6ccef94e1c31f5ae2b391adac9d775832d9f56818cde2541817a4b8cde475cda44021b93a5f23bcbac9a010904a
+  metadata.gz: 9043c05ffb79c8830299127c39de0dc77b77dc3fa1fd2a573813696bcd9a7ba3fa95d7a06a7371ff596ed04781f439311f773bdff24afe055b252b36e0d36bb5
+  data.tar.gz: d73327657254114a22c091bb58503c17f1f8d0fcc19f0179c283b452df4c7240d446ff8d36962b16fcc47ea13e0315c80f554280b79f47b684f24ba50b11ce23

data/lib/bitfab/client.rb

@@ -407,6 +407,7 @@ module Bitfab
               {
                 neon_branch_id: lease["neonBranchId"],
                 snapshot_timestamp: lease["snapshotTimestamp"],
+                region: lease["region"],
                 original_trace_id: replay_ctx[:source_bitfab_trace_id],
                 # Deprecated wire alias, kept so this SDK still reports usage
                 # against servers that predate the rename.
@@ -593,6 +594,9 @@ module Bitfab
         if db_snapshot_usage[:snapshot_timestamp]
           usage["snapshot_timestamp"] = db_snapshot_usage[:snapshot_timestamp]
         end
+        if db_snapshot_usage[:region]
+          usage["region"] = db_snapshot_usage[:region]
+        end
         if db_snapshot_usage[:original_trace_id]
           usage["original_trace_id"] = db_snapshot_usage[:original_trace_id]
           # Deprecated wire alias, kept so this SDK still reports usage

data/lib/bitfab/http_client.rb

@@ -181,9 +181,11 @@ module Bitfab
       request("/api/sdk/replay/start", payload, timeout:)
     end
 
-    # Fetch an external span by ID. Blocking GET request.
-    def get_external_span(span_id)
-      get("/api/sdk/externalSpans/#{span_id}", timeout: 30)
+    # Fetch an external span by ID. Blocking GET request. The replay view keeps
+    # only the input/output serialization fields used by replay.
+    def get_external_span(span_id, replay_view: false)
+      query = replay_view ? "?view=replay" : ""
+      get("/api/sdk/externalSpans/#{span_id}#{query}", timeout: 30)
     end
 
     def get_trace_span(trace_id, id: nil, name: nil, occurrence: "last")
@@ -210,9 +212,12 @@ module Bitfab
     # payloads so only the spans actually mocked are fetched later (by
     # externalSpanId), avoiding dragging down every span's output when only a
     # few are mocked.
-    def get_span_tree(external_span_id, include_outputs: true)
+    def get_span_tree(external_span_id, include_outputs: true, include_root_output: true)
       endpoint = "/api/sdk/replay/spanTree/#{external_span_id}"
-      endpoint += "?includeOutputs=false" unless include_outputs
+      query = []
+      query << "includeOutputs=false" unless include_outputs
+      query << "includeRootOutput=false" unless include_root_output
+      endpoint += "?#{query.join("&")}" unless query.empty?
       get(endpoint, timeout: 30)
     end
 

data/lib/bitfab/replay.rb

@@ -62,10 +62,12 @@ module Bitfab
       # (via +database_url+). Reported on the trace
       # completion inside the +db_snapshot_usage+ record (its +accessed+
       # field) so the server can distinguish "branch was provisioned and
-      # exposed" from "branch URL was actually consumed". Any future
-      # consumption path that hands the URL to customer code by other means
-      # (e.g. a process-isolated runner writing an env overlay) must also
-      # set this.
+      # exposed" from "branch URL was actually consumed". Only an explicit
+      # +database_url+ read may set it. A path that hands the URL over by other
+      # means (e.g. a process-isolated runner writing an env overlay) must
+      # leave it alone: setting it there would make every such replay report
+      # accessed for free, and the flag would stop separating "branch was
+      # used" from "branch was offered".
       ctx[:db_branch_lease] = db_branch_lease if db_branch_lease
       ctx[:source_bitfab_trace_id] = source_bitfab_trace_id if source_bitfab_trace_id
       Thread.current[REPLAY_CONTEXT_KEY] = ctx
@@ -674,7 +676,7 @@ module Bitfab
           "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)
+      span = http_client.get_external_span(original_span_id, replay_view: true)
       item_data = extract_span_data(span)
 
       # Fetch the span tree when the base strategy needs recorded outputs
@@ -692,7 +694,11 @@ module Bitfab
       mock_tree = nil
       if mock_strategy == "all" || mock_strategy == "marked" || overrides_present
         begin
-          tree = http_client.get_span_tree(original_span_id, include_outputs:)
+          tree = http_client.get_span_tree(
+            original_span_id,
+            include_outputs:,
+            include_root_output: false
+          )
           mock_tree = build_mock_tree(tree["root"] || {})
         rescue Exception => e # rubocop:disable Lint/RescueException
           raise if e.is_a?(SystemExit) || e.is_a?(SignalException)
@@ -841,7 +847,7 @@ module Bitfab
       lambda do |external_span_id|
         return cache[external_span_id] if cache.key?(external_span_id)
 
-        span = http_client.get_external_span(external_span_id)
+        span = http_client.get_external_span(external_span_id, replay_view: true)
         span_data = (span["rawData"] || {})["span_data"] || {}
         # Prefer the Ruby Marshal payload (output_serialized) written by this
         # SDK; fall back to another SDK's output_meta, then the raw JSON output.

data/lib/bitfab/replay_branch.rb

@@ -17,9 +17,20 @@ module Bitfab
   # protocol term). Its useful fields are exposed directly here so customer code
   # never sees the word.
   class ReplayBranch
+    # The provider's own id for this branch, e.g. for correlating with its console.
+    attr_reader :neon_branch_id
+
+    # Env var name the customer's app reads, e.g. "DATABASE_URL".
+    attr_reader :env_key
+
     # When this branch's URL stops being valid. ISO-8601.
     attr_reader :expires_at
 
+    # The instant this branch is pinned to: the source trace's wall clock, read
+    # just before the traced method ran. Compare it against the trace you meant
+    # to replay to confirm the branch is the right point in history.
+    attr_reader :snapshot_timestamp
+
     # Deep link to the branch in the provider console, if available.
     attr_reader :provider_console_url
 
@@ -36,13 +47,28 @@ module Bitfab
 
     # Built by Bitfab.current_replay_branch; never constructed by callers.
     def initialize(lease, trace_id, context)
-      @expires_at = lease["expiresAt"]
-      @provider_console_url = lease["providerConsoleUrl"]
-      @read_only = lease["readOnly"]
-      @region = lease["region"]
+      # Copy the lease wholesale minus the connection string, so a field the
+      # server starts sending reaches customer code without an SDK release.
+      # Everything set here must stay plain data: #database_url is the only
+      # member allowed to mark the branch as accessed.
+      # The internals are underscore-prefixed because the loop below writes an
+      # ivar per lease key: snake_case never emits a leading underscore, so no
+      # field the server invents can collide with them. A plain @fields would
+      # be clobbered mid-loop by a key named "fields", corrupting #as_json.
+      fields = {}
+      lease.each do |key, value|
+        next if key == "databaseUrl"
+
+        name = snake_case(key)
+        fields[name] = value
+        instance_variable_set(:"@#{name}", value)
+        define_singleton_method(name) { value } unless respond_to?(name)
+      end
       @trace_id = trace_id
-      @url = lease["databaseUrl"]
-      @context = context
+      fields["trace_id"] = trace_id
+      @_fields = fields.freeze
+      @_url = lease["databaseUrl"]
+      @_context = context
       freeze
     end
 
@@ -54,15 +80,39 @@ module Bitfab
     # was actually used". The other readers inspect the lease without exposing
     # the connection string, so they deliberately do not record anything.
     def database_url
-      @context[:db_snapshot_accessed] = true
-      @url
+      @_context[:db_snapshot_accessed] = true
+      @_url
     end
 
     # Redact the connection string so a logged or inspected branch cannot leak it.
     def inspect
       "#<Bitfab::ReplayBranch trace_id=#{@trace_id.inspect} " \
         "expires_at=#{@expires_at.inspect} region=#{@region.inspect} " \
-        "read_only=#{@read_only.inspect}>"
+        "read_only=#{@read_only.inspect} " \
+        "snapshot_timestamp=#{@snapshot_timestamp.inspect}>"
+    end
+
+    # ActiveSupport gives every object a +to_json+ that serializes its instance
+    # variables, so under Rails a branch reaching a log line or an API response
+    # would carry the connection string and the whole replay context. Serialize
+    # the exposed fields only, the same set +inspect+ shows.
+    def as_json(_options = nil)
+      @_fields.dup
+    end
+
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+
+    private
+
+    # Two passes so a run of capitals stays one word: "dbURL" is "db_url", not
+    # "db_u_r_l". Must match the Python SDK's conversion exactly, or the same
+    # server field would arrive under different names in the two SDKs.
+    def snake_case(key)
+      key.gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .downcase
     end
   end
 end

data/lib/bitfab/version.rb

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

metadata

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