bitfab 0.51.4 → 0.51.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b739123699ec796d304175df24d0ff07ffa098b95c31d878370a07c7b9cb34c6
-  data.tar.gz: 6895704bbaf7f045b704a2ac71a7502a5f5b205792abd80af1b9d4fa124879d7
+  metadata.gz: 208aed8da4ed9d2c748135161048c595f30507c946f3bb4086a560c55c1a2044
+  data.tar.gz: cfd965992d9304db89d53760c7e8ef8ea237394902aa33f5f0862a7388bf4c00
 SHA512:
-  metadata.gz: c4b895369cabdcec196d957e92bc2cf13dfe972efa3342ffbb0bc705f7670050cf60a7f85c4132dd92b394c59c338acc41c7bbb5597cb1a8aa160f501a5d3895
-  data.tar.gz: 810b845093e98709f56162422a9e87e1de46180e91224a0a60c67abc2f04f39ef1a3add5ac8f31e374c656920dc95c2aec79f6731c8160e0af98884791cf5450
+  metadata.gz: b76db7c1e008f877c79d6ab25eaacd2733f3e61564eb2211ac77418d050634503b31a4dd43ecd80bf7ea098fa4fec1975b36ec4c4b3125badbbc0a3ef61dfbba
+  data.tar.gz: '07281744cb252b83655686936532d9d58297537c35938c2eea468a5359005ba9c8ae97149e3465f990d005f5a80a2890d04662add468602e4ca9ddaaacd704e4'

data/lib/bitfab/client.rb

@@ -470,6 +470,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 +550,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/git_command.rb

@@ -8,8 +8,9 @@ module Bitfab
 
     module_function
 
-    def run(cwd, args, timeout:)
-      Open3.popen3("git", *args, chdir: cwd, **spawn_options) do |stdin, stdout, stderr, wait_thread|
+    def run(cwd, args, timeout:, env: nil)
+      command = env ? [env, "git", *args] : ["git", *args]
+      Open3.popen3(*command, chdir: cwd, **spawn_options) do |stdin, stdout, stderr, wait_thread|
         stdin.close
         out = +""
         reader = Thread.new { out = read_all(stdout) }

data/lib/bitfab/git_state.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "tmpdir"
+require_relative "git_command"
+
+module Bitfab
+  module GitState
+    DISABLE_ENV = "BITFAB_DISABLE_GIT_STATE"
+    GIT_TIMEOUT_SECONDS = 30
+    SHA_PATTERN = /\A[0-9a-f]{40}\z/
+
+    module_function
+
+    def git(cwd, *args, env: nil)
+      GitCommand.run(cwd, args, timeout: GIT_TIMEOUT_SECONDS, env: env)&.strip
+    end
+
+    def text(value)
+      trimmed = value&.strip
+      (trimmed.nil? || trimmed.empty?) ? nil : trimmed
+    end
+
+    def sha(value)
+      trimmed = text(value)
+      (trimmed && SHA_PATTERN.match?(trimmed)) ? trimmed : nil
+    end
+
+    def empty?(state)
+      state.values.all?(&:nil?)
+    end
+
+    def resolve_working_tree_sha(root)
+      Dir.mktmpdir("bitfab-git-") do |dir|
+        env = {"GIT_INDEX_FILE" => File.join(dir, "index")}
+        return nil if git(root, "read-tree", "HEAD", env: env).nil?
+        return nil if git(root, "add", "-A", "--", root, env: env).nil?
+
+        sha(git(root, "write-tree", env: env))
+      end
+    rescue
+      nil
+    end
+
+    def resolve(cwd)
+      refs = git(cwd, "rev-parse", "--show-toplevel", "HEAD", "HEAD^{tree}")
+      lines = refs.to_s.split("\n")
+      root = text(lines[0])
+      return nil if root.nil?
+
+      state = {
+        "githubEmail" => text(git(cwd, "config", "user.email")),
+        "branch" => text(git(cwd, "symbolic-ref", "--short", "-q", "HEAD")),
+        "commitSha" => sha(lines[1]),
+        "baseSha" => sha(lines[2]),
+        "experimentSha" => resolve_working_tree_sha(root)
+      }
+      empty?(state) ? nil : state
+    end
+
+    def resolved
+      return nil unless ENV[DISABLE_ENV].to_s.empty?
+
+      safe_resolve
+    end
+
+    def safe_resolve
+      resolve(Dir.pwd)
+    rescue
+      nil
+    end
+  end
+end

data/lib/bitfab/http_client.rb

@@ -4,10 +4,12 @@ require "net/http"
 require "json"
 require "uri"
 
+require_relative "git_state"
 require_relative "compress"
 require_relative "constants"
 require_relative "serialize"
 require_relative "transport"
+require_relative "trace_completion"
 require_relative "version"
 require_relative "warn_once"
 
@@ -26,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
@@ -37,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
@@ -125,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),
@@ -207,6 +212,8 @@ module Bitfab
       end
       payload["graderIds"] = grader_ids unless grader_ids.nil?
       payload["dbBranchSettings"] = db_branch_settings unless db_branch_settings.nil?
+      git_state = GitState.resolved
+      payload["git"] = git_state if git_state
 
       # When DB branching is on, the server resolves a Neon preview branch per
       # item (snapshot + restore + poll), which can run several seconds each,
@@ -284,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),
@@ -293,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/version.rb

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

data/lib/bitfab.rb

@@ -10,6 +10,7 @@ require_relative "bitfab/serialize"
 require_relative "bitfab/db_snapshot"
 require_relative "bitfab/git_command"
 require_relative "bitfab/commit_ref"
+require_relative "bitfab/git_state"
 require_relative "bitfab/span_context"
 require_relative "bitfab/http_client"
 require_relative "bitfab/datasets"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitfab
 version: !ruby/object:Gem::Version
-  version: 0.51.4
+  version: 0.51.6
 platform: ruby
 authors:
 - Harvest Team
@@ -146,6 +146,7 @@ files:
 - lib/bitfab/datasets.rb
 - lib/bitfab/db_snapshot.rb
 - lib/bitfab/git_command.rb
+- lib/bitfab/git_state.rb
 - lib/bitfab/http_client.rb
 - lib/bitfab/mock_override.rb
 - lib/bitfab/otel.rb
@@ -158,6 +159,7 @@ 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/transport.rb
 - lib/bitfab/version.rb