bitfab 0.51.5 → 0.51.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bf8a9d45207caf1c5a6ef62a0e9ad6af43e5ccd904a25c8b8cd1fefd73795b9
-  data.tar.gz: 684d7a18b4dc4cde5df27bce58e9be1a7ed3dbd8a644638148d81746cd9e7683
+  metadata.gz: 64f734e03ef657b17437062d8827ba0ab1532cb244f0c2bc7ae46e1f599015a0
+  data.tar.gz: bef9e05e622daada74cf66907f6fe6f9cc3ecac4447af7b6590936c4dc85ba39
 SHA512:
-  metadata.gz: f3ffe75284ce984a57b524746a640ad8b51a10b32d4835d35a1d692415a23cfd09a7730105825713919c519e5dc256b444ba329c4bd0783f24a07e933315cb87
-  data.tar.gz: c9da6e278539c0fe49d5192d05624ce0e1ba0f36ce0e9e8bf23511fd336bc39a3b58427d1196fee0418a7569f2920aefa5c9f456c57d246d1d01ebabb0306b21
+  metadata.gz: 979725c68118f1bd070da152c1d4ec607957dc771d3c39d021c68b2bc5f06d1315c49d33c13eae1ce99a1f16e6e0f7b2486dd3051286d3d8016bb552c3f0d14c
+  data.tar.gz: 2a71770f9f72528093ed229bd2505dcc7a515fc5ffa9c682933fb5802e65ffa7cc46de7538f077e896f8ad01ea13820253fe781ed2b92477ad8ab8c9cadabeeb

data/lib/bitfab/client.rb

@@ -34,6 +34,9 @@ module Bitfab
     # Dataset operations for the authenticated organization.
     attr_reader :datasets
 
+    # Trace lookup operations for the authenticated organization.
+    attr_reader :traces
+
     def initialize(api_key: nil, service_url: nil, enabled: true, strict: false)
       @api_key_config = api_key
       @service_url = service_url || DEFAULT_SERVICE_URL
@@ -48,6 +51,7 @@ module Bitfab
       # at send time, after any env loading has run.
       @http_client = HttpClient.new(api_key: -> { resolve_api_key }, service_url: @service_url)
       @datasets = Datasets.new(@http_client)
+      @traces = Traces.new(@http_client)
       # Mock overrides registered via register_mock_override, applied to every
       # replay on this client (after any per-call mock_override). Instance
       # state, no global; clear_mock_overrides resets it.
@@ -470,6 +474,7 @@ module Bitfab
       span_contexts = nil
       span_prompt = nil
       completed = false
+      @http_client.trace_completion.start(trace_id, span_id)
 
       complete = lambda do |final_result, final_error|
         # Never crash the host app due to span building/sending. Idempotent:
@@ -549,6 +554,8 @@ module Bitfab
           # Silently ignore: user's result/exception takes priority
           # Catches Exception (not just StandardError) to handle SystemStackError
           # from deeply nested serialization
+        ensure
+          @http_client.trace_completion.finish(trace_id, span_id)
         end
       end
 

data/lib/bitfab/http_client.rb

@@ -9,6 +9,7 @@ require_relative "compress"
 require_relative "constants"
 require_relative "serialize"
 require_relative "transport"
+require_relative "trace_completion"
 require_relative "version"
 require_relative "warn_once"
 
@@ -27,7 +28,7 @@ module Bitfab
     REPLAY_DB_BRANCH_REQUEST_TIMEOUT_SECONDS = 300
     private_constant :REPLAY_DB_BRANCH_REQUEST_TIMEOUT_SECONDS
 
-    attr_reader :service_url
+    attr_reader :service_url, :trace_completion
 
     def initialize(api_key:, service_url: nil, timeout: 120)
       @api_key = api_key
@@ -38,6 +39,7 @@ module Bitfab
       # the export threads recording acks would hand each a different mutex.
       @delivery_mutex = Mutex.new
       @trace_deliveries = {}
+      @trace_completion = TraceCompletion.new
       @delivery_pid = Process.pid
       @carrier_seq_mutex = Mutex.new
       @carrier_seq = 0
@@ -126,6 +128,8 @@ module Bitfab
 
     # Queue an external span on this client's trace transport (fire-and-forget).
     def send_external_span(payload)
+      ref = carrier_ref(payload)
+      @trace_completion.record(ref.trace_id, ref.span_id) if ref&.span_id
       trace_transport&.submit(
         "external_span",
         payload.merge("sdkVersion" => VERSION),
@@ -287,6 +291,18 @@ module Bitfab
 
     # Queue an external trace on this client's trace transport (fire-and-forget).
     def send_external_trace(payload)
+      ref = carrier_ref(payload)
+      if payload["completed"] == true && ref
+        @trace_completion.close(ref.trace_id, dropped: payload["dropped"] == true) do |count|
+          submit_external_trace(payload.merge("expectedSpanCount" => count))
+        end
+      else
+        @trace_completion.open(ref.trace_id) if ref
+        submit_external_trace(payload)
+      end
+    end
+
+    def submit_external_trace(payload)
       trace_transport&.submit(
         "external_trace",
         payload.merge("sdkVersion" => VERSION),
@@ -296,6 +312,8 @@ module Bitfab
           (payload["completed"] == true) ? carrier_ref(payload) : nil
         )
       )
+    rescue => error
+      Bitfab.warn_once("trace-completion-submit", "trace completion could not be queued: #{error.message}")
     end
 
     # Read the replay traces the server has fully persisted so far.

data/lib/bitfab/trace_completion.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "set" # standard:disable Lint/RedundantRequireStatement -- Required on Ruby 3.4.
+
+module Bitfab
+  class TraceCompletion
+    def initialize
+      @pid = Process.pid
+      @mutex = Mutex.new
+      @traces = {}
+      @closed = {}
+    end
+
+    def start(trace_id, span_id)
+      synchronize do
+        next if @closed.key?(trace_id)
+
+        entry = state(trace_id)
+        entry[:span_ids].add(span_id)
+        entry[:active].add(span_id)
+      end
+    end
+
+    def open(trace_id)
+      synchronize { state(trace_id) unless @closed.key?(trace_id) }
+    end
+
+    def record(trace_id, span_id)
+      synchronize do
+        state(trace_id)[:span_ids].add(span_id) unless @closed.key?(trace_id)
+      end
+    end
+
+    def finish(trace_id, span_id)
+      ready = synchronize do
+        entry = @traces[trace_id]
+        next if entry.nil?
+
+        entry[:active].delete(span_id)
+        drain(trace_id, entry)
+      end
+      ready[0].call(ready[1]) unless ready.nil?
+    end
+
+    def close(trace_id, dropped: false, &complete)
+      ready = synchronize do
+        next [complete, @closed[trace_id]] if @closed.key?(trace_id)
+
+        entry = @traces[trace_id]
+        next if entry.nil?
+
+        entry[:complete] = complete
+        entry[:active].clear if dropped
+        drain(trace_id, entry)
+      end
+      ready[0].call(ready[1]) unless ready.nil?
+    end
+
+    private
+
+    def synchronize(&block)
+      if @pid != Process.pid
+        @pid = Process.pid
+        @mutex = Mutex.new
+        @traces = {}
+        @closed = {}
+      end
+      @mutex.synchronize(&block)
+    end
+
+    def state(trace_id)
+      @traces[trace_id] ||= {span_ids: Set.new, active: Set.new}
+    end
+
+    def drain(trace_id, entry)
+      return unless entry[:active].empty? && entry[:complete]
+
+      @traces.delete(trace_id)
+      count = entry[:span_ids].size
+      @closed[trace_id] = count
+      @closed.shift if @closed.size > 1024
+      [entry[:complete], count]
+    end
+  end
+end

data/lib/bitfab/traces.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bitfab
+  # Trace lookup operations for the authenticated organization.
+  class Traces
+    def initialize(http_client)
+      @http_client = http_client
+    end
+
+    # Search by up to 10 exact, case-insensitive caller metadata pairs. Every
+    # pair must match. Pass nextCursor from the result as cursor: for another page.
+    def search(caller_metadata:, trace_function_key: nil, cursor: nil, limit: nil)
+      payload = {"callerMetadata" => caller_metadata}
+      payload["traceFunctionKey"] = trace_function_key unless trace_function_key.nil?
+      payload["cursor"] = cursor unless cursor.nil?
+      payload["limit"] = limit unless limit.nil?
+      @http_client.request("/api/sdk/traces/search", payload)
+    end
+  end
+end

data/lib/bitfab/version.rb

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

data/lib/bitfab.rb

@@ -14,6 +14,7 @@ require_relative "bitfab/git_state"
 require_relative "bitfab/span_context"
 require_relative "bitfab/http_client"
 require_relative "bitfab/datasets"
+require_relative "bitfab/traces"
 require_relative "bitfab/mock_override"
 require_relative "bitfab/replay"
 require_relative "bitfab/replay_branch"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitfab
 version: !ruby/object:Gem::Version
-  version: 0.51.5
+  version: 0.51.7
 platform: ruby
 authors:
 - Harvest Team
@@ -159,7 +159,9 @@ files:
 - lib/bitfab/span_context.rb
 - lib/bitfab/subtree.rb
 - lib/bitfab/timestamp.rb
+- lib/bitfab/trace_completion.rb
 - lib/bitfab/traceable.rb
+- lib/bitfab/traces.rb
 - lib/bitfab/transport.rb
 - lib/bitfab/version.rb
 - lib/bitfab/warn_once.rb