Module: Bitfab

Defined in:
lib/bitfab.rb,
lib/bitfab/client.rb,
lib/bitfab/replay.rb,
lib/bitfab/version.rb,
lib/bitfab/constants.rb,
lib/bitfab/serialize.rb,
lib/bitfab/traceable.rb,
lib/bitfab/warn_once.rb,
lib/bitfab/db_snapshot.rb,
lib/bitfab/http_client.rb,
lib/bitfab/span_context.rb,
lib/bitfab/replay_environment.rb

Defined Under Namespace

Modules: DbSnapshot, Replay, ReplayContext, Serialize, SpanContext, TraceState, Traceable Classes: BitfabFunction, Client, CurrentSpan, CurrentTrace, HttpClient, NoOpCurrentSpan, NoOpCurrentTrace, ReplayEnvironment

Constant Summary collapse

NO_OP_SPAN = 
NoOpCurrentSpan.new.freeze
NO_OP_TRACE = 
NoOpCurrentTrace.new.freeze
MOCK_STRATEGIES =

Replay mock strategies. Mirrors the Python and TypeScript SDKs.

  • “none” : every child span runs real code (default)

  • “all” : every child span returns its historical output

  • “marked” : only spans declared with mock_on_replay: true return historical

    output; everything else runs real code

%w[none all marked].freeze
VERSION = 
"0.22.1"
DEFAULT_SERVICE_URL = 
"https://bitfab.ai"
REPLAY_CONTEXT_KEY = 
:__bitfab_replay_context
BITFAB_PROGRESS_PREFIX =

Wire prefix the Bitfab plugin scans for on stderr to report live progress while a replay runs. One trailing space, then the progress object as JSON.

"@@bitfab:progress "

Class Method Summary collapse

Class Method Details

._reset_warn_once ⇒ Object

Test-only: clear the dedup set so a warning can fire again.



31
32
33
 
# File 'lib/bitfab/warn_once.rb', line 31

def _reset_warn_once
  @warn_once_mutex.synchronize { @warn_once_seen.clear }
end

._run_in_background(&block) ⇒ Object

Run a block in a background thread with tracking. Returns the thread for callers that need to join on it.



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/bitfab/http_client.rb', line 244

def _run_in_background(&block)
  thread = Thread.new do
    block.call
  rescue => e
    Bitfab.warn_once(
      "send-request-failed",
      "failed to send a request to the backend (further occurrences " \
      "suppressed): #{e.message}"
    )
  ensure
    @pending_threads_mutex.synchronize { @pending_threads.delete(Thread.current) }
  end

  @pending_threads_mutex.synchronize { @pending_threads << thread }
  thread
end

.client ⇒ Object

Returns the global client, raising if not configured.



67
68
69
 
# File 'lib/bitfab.rb', line 67

def client
  @client or raise "Bitfab not configured. Call Bitfab.configure(api_key: '...') first."
end

.client_or_nil ⇒ Object

Returns the global client, or nil if not configured. Used on the traced call path so a method invoked before Bitfab.configure runs untraced rather than crashing the host app with a “not configured” error.



74
75
76
 
# File 'lib/bitfab.rb', line 74

def client_or_nil
  @client
end

.configure(api_key:, service_url: nil, enabled: true) ⇒ Object

Configure the global Bitfab client.

Examples:

Bitfab.configure(api_key: ENV["BITFAB_API_KEY"])

Parameters:

  • api_key (String) —

    API key for authentication

  • service_url (String, nil) (defaults to: nil) —

    base URL (default: bitfab.ai)



62
63
64
 
# File 'lib/bitfab.rb', line 62

def configure(api_key:, service_url: nil, enabled: true)
  @client = Client.new(api_key:, service_url:, enabled:)
end

.current_span ⇒ CurrentSpan, NoOpCurrentSpan

Get a handle to the current active span.

Call this from inside a traced method to get a span handle that allows setting metadata at runtime.

Returns:



89
90
91
92
93
94
 
# File 'lib/bitfab.rb', line 89

def current_span
  entry = SpanContext.current
  return NO_OP_SPAN unless entry

  CurrentSpan.new(entry)
end

.current_trace ⇒ CurrentTrace, NoOpCurrentTrace

Get a handle to the current active trace.

Call this from inside a traced method to get a trace handle that allows setting trace-level context at runtime.

Returns:



102
103
104
105
106
107
 
# File 'lib/bitfab.rb', line 102

def current_trace
  entry = SpanContext.current
  return NO_OP_TRACE unless entry

  CurrentTrace.new(entry[:trace_id])
end

.flush_traces(timeout: 30) ⇒ Object

Wait for all pending background threads to complete.



262
263
264
265
 
# File 'lib/bitfab/http_client.rb', line 262

def flush_traces(timeout: 30)
  threads = @pending_threads_mutex.synchronize { @pending_threads.dup }
  threads.each { |t| t.join(timeout) }
end

.report_replay_progress(progress) ⇒ Object

A ready-made on_progress callback for replay: writes one @@bitfab:progress line per trace to stderr, which the Bitfab plugin polls to report live progress while the replay runs in the background, so replay scripts never hand-format the protocol. stdout stays the ReplayResult JSON. Never raises (progress must not crash a run). The progress hash’s item ({ trace_id:, error:, duration_ms: }) is forwarded verbatim through to_json, so the plugin sees the source trace id, error, and duration of the item that just settled.

Examples:

Bitfab.client.replay(..., on_progress: Bitfab.method(:report_replay_progress))

Parameters:

  • progress (Hash) —

    running totals with keys completed, total, succeeded, errored, and item (the object replay already passes to on_progress)



124
125
126
127
128
 
# File 'lib/bitfab.rb', line 124

def report_replay_progress(progress)
  warn "#{BITFAB_PROGRESS_PREFIX}#{progress.to_json}"
rescue
  nil
end

.reset! ⇒ Object

Reset the global client (primarily for testing).



79
80
81
 
# File 'lib/bitfab.rb', line 79

def reset!
  @client = nil
end

.warn_once(key, message) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/bitfab/warn_once.rb', line 17

def warn_once(key, message)
  @warn_once_mutex.synchronize do
    return if @warn_once_seen.include?(key)

    @warn_once_seen.add(key)
  end
  begin
    warn "Bitfab: #{message}"
  rescue Exception # rubocop:disable Lint/RescueException
    # Logging must never crash the host app (e.g. a closed $stderr).
  end
end