Class: Bitfab::HttpClient

Inherits:
Object
  • Object
show all
Defined in:
lib/bitfab/http_client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, service_url: nil, timeout: 120) ⇒ HttpClient

Returns a new instance of HttpClient.



19
20
21
22
23
 
# File 'lib/bitfab/http_client.rb', line 19

def initialize(api_key:, service_url: nil, timeout: 120)
  @api_key = api_key
  @service_url = (service_url || DEFAULT_SERVICE_URL).chomp("/")
  @timeout = timeout
end

Instance Attribute Details

#service_url ⇒ Object (readonly)

Returns the value of attribute service_url.



17
18
19
 
# File 'lib/bitfab/http_client.rb', line 17

def service_url
  @service_url
end

Instance Method Details

#complete_replay(test_run_id) ⇒ Object

Mark a replay test run as completed. Blocking call.



190
191
192
 
# File 'lib/bitfab/http_client.rb', line 190

def complete_replay(test_run_id)
  request("/api/sdk/replay/complete", {"testRunId" => test_run_id}, timeout: 30)
end

#get(endpoint, timeout: nil) ⇒ Object

Make a GET request to the Bitfab API. Returns parsed JSON response hash.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/bitfab/http_client.rb', line 77

def get(endpoint, timeout: nil)
  uri = URI("#{@service_url}#{endpoint}")
  request_timeout = timeout || @timeout

  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = uri.scheme == "https"
  http.open_timeout = request_timeout
  http.read_timeout = request_timeout

  # request_uri (not path) so any query string on the endpoint survives.
  req = Net::HTTP::Get.new(uri.request_uri, headers)
  response = http.request(req)

  unless response.is_a?(Net::HTTPSuccess)
    raise Net::HTTPError.new("HTTP #{response.code}: #{response.body}", response)
  end

  result = JSON.parse(response.body)

  if result["error"]
    msg = result["error"]
    msg = "#{msg} Configure it at: #{@service_url}#{result["url"]}" if result["url"]
    raise StandardError, msg
  end

  result
end

#get_external_span(span_id) ⇒ Object

Fetch an external span by ID. Blocking GET request.



155
156
157
 
# File 'lib/bitfab/http_client.rb', line 155

def get_external_span(span_id)
  get("/api/sdk/externalSpans/#{span_id}", timeout: 30)
end

#get_span_tree(external_span_id, include_outputs: true) ⇒ Object

Fetch the span tree rooted at an external span. Blocking GET request. Used by replay when a mock strategy is active so child spans can be matched against their historical outputs.

Returns a hash shaped { "root" => SpanTreeNode } where each node has sourceSpanId, externalSpanId, traceFunctionKey, spanName, type, and children. When include_outputs is true each node also carries its recorded output (and optional outputMeta); when false the server omits the output 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.



183
184
185
186
187
 
# File 'lib/bitfab/http_client.rb', line 183

def get_span_tree(external_span_id, include_outputs: true)
  endpoint = "/api/sdk/replay/spanTree/#{external_span_id}"
  endpoint += "?includeOutputs=false" unless include_outputs
  get(endpoint, timeout: 30)
end

#get_trace_span(trace_id, id: nil, name: nil, occurrence: "last") ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/bitfab/http_client.rb', line 159

def get_trace_span(trace_id, id: nil, name: nil, occurrence: "last")
  query = if id
    {id:}
  else
    {name:, occurrence: occurrence.to_s}
  end
  encoded_trace_id = URI.encode_www_form_component(trace_id)
  get(
    "/api/sdk/traces/#{encoded_trace_id}/span?#{URI.encode_www_form(query)}",
    timeout: 30
  )["span"]
end

#release_db_branch_lease(neon_branch_id) ⇒ Object

Release a previously-resolved DB branch by deleting its Neon branch. Blocking call. Idempotent server-side (a missing branch is treated as already released).



197
198
199
 
# File 'lib/bitfab/http_client.rb', line 197

def release_db_branch_lease(neon_branch_id)
  request("/api/sdk/replay/releaseDbBranchLease", {"neonBranchId" => neon_branch_id}, timeout: 30)
end

#request(endpoint, payload, timeout: nil, max_retries: 1, retry_delay: 0.1) ⇒ Object

Make a POST request to the Bitfab API. Returns parsed JSON response hash.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/bitfab/http_client.rb', line 27

def request(endpoint, payload, timeout: nil, max_retries: 1, retry_delay: 0.1)
  uri = URI("#{@service_url}#{endpoint}")
  request_timeout = timeout || @timeout

  last_error = nil

  max_retries.times do |attempt|
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = uri.scheme == "https"
    http.open_timeout = request_timeout
    http.read_timeout = request_timeout

    req = Net::HTTP::Post.new(uri.path, headers)
    req.body = safe_generate(payload, endpoint)

    response = http.request(req)

    unless response.is_a?(Net::HTTPSuccess)
      raise Net::HTTPError.new("HTTP #{response.code}: #{response.body}", response)
    end

    result = JSON.parse(response.body)

    if result["error"]
      msg = result["error"]
      msg = "#{msg} Configure it at: #{@service_url}#{result["url"]}" if result["url"]
      raise StandardError, msg
    end

    return result
  rescue => e
    last_error = e
    sleep(retry_delay) if attempt < max_retries - 1
  end

  raise last_error
end

#resolve_db_branch_lease(test_run_id, trace_id, db_branch_settings = nil) ⇒ Object 



201
202
203
204
205
206
207
208
209
 
# File 'lib/bitfab/http_client.rb', line 201

def resolve_db_branch_lease(test_run_id, trace_id, db_branch_settings = nil)
  payload = {"testRunId" => test_run_id, "traceId" => trace_id}
  payload["dbBranchSettings"] = db_branch_settings unless db_branch_settings.nil?
  request(
    "/api/sdk/replay/resolveDbBranchLease",
    payload,
    timeout: REPLAY_DB_BRANCH_REQUEST_TIMEOUT_SECONDS
  )
end

#send_external_span(payload) ⇒ Object

Send an external span in a background thread. Returns the thread for callers that need to await completion.



67
68
69
70
71
72
73
 
# File 'lib/bitfab/http_client.rb', line 67

def send_external_span(payload)
  merged = payload.merge("sdkVersion" => VERSION)

  Bitfab._run_in_background do
    request("/api/sdk/externalSpans", merged, timeout: 30)
  end
end

#send_external_trace(payload) ⇒ Object

Send an external trace (fire-and-forget in background thread).



212
213
214
215
216
217
218
 
# File 'lib/bitfab/http_client.rb', line 212

def send_external_trace(payload)
  merged = payload.merge("sdkVersion" => VERSION)

  Bitfab._run_in_background do
    request("/api/sdk/externalTraces", merged, timeout: 10)
  end
end

#start_replay(trace_function_key, limit, trace_ids: nil, code_change_description: nil, code_change_files: nil, experiment_group_id: nil, name: nil, include_db_branch_lease: false, dataset_id: nil, grader_ids: nil, db_branch_settings: nil) ⇒ Object

Start a replay session by fetching historical traces. Blocking call. Returns hash with testRunId, testRunUrl, and items array.

Parameters:

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

    optional rationale for the code change being tested in this replay

  • code_change_files (Array<Hash>, nil) (defaults to: nil) —

    optional list of edited files, each as { path:, before:, after: } (use "" for new/deleted files)

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

    optional UUID grouping multiple replay runs into a single experiment batch

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

    optional display name for the resulting experiment/test run

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

    optional UUID of the dataset this replay runs against, stored on the resulting experiment for durable attribution

  • grader_ids (Array<String>, nil) (defaults to: nil) —

    optional UUIDs of graders attached directly to this experiment, graded as the union with the dataset's runnable graders at completion; each must be an active/live grader in the same org and trace function or the server rejects the replay



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/bitfab/http_client.rb', line 122

def start_replay(trace_function_key, limit, trace_ids: nil, code_change_description: nil,
  code_change_files: nil, experiment_group_id: nil, name: nil, include_db_branch_lease: false, dataset_id: nil,
  grader_ids: nil, db_branch_settings: nil)
  payload = {
    "traceFunctionKey" => trace_function_key
  }
  # limit is only meaningful without trace_ids (an explicit ID list
  # already determines the count), so it's omitted when nil.
  payload["limit"] = limit unless limit.nil?
  payload["traceIds"] = trace_ids if trace_ids
  payload["name"] = name unless name.nil?
  payload["codeChangeDescription"] = code_change_description unless code_change_description.nil?
  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["lazyDbBranchLease"] = true if include_db_branch_lease
  payload["datasetId"] = dataset_id unless dataset_id.nil?
  payload["graderIds"] = grader_ids unless grader_ids.nil?
  payload["dbBranchSettings"] = db_branch_settings unless db_branch_settings.nil?

  # When DB branching is on, the server resolves a Neon preview branch per
  # item (snapshot + restore + poll), which can run several seconds each,
  # and runs any warm-up SQL against each branch on a 240s budget of its
  # own. The server gives up at 280s and answers, so this is a backstop for
  # a reply that never comes rather than the thing that normally fires; it
  # sits above the server's own ceiling so the server's error is the one
  # callers see. Net::HTTP would otherwise default to 60s here, which the
  # branch creation alone can outlast.
  timeout = include_db_branch_lease ? REPLAY_DB_BRANCH_REQUEST_TIMEOUT_SECONDS : 30
  request("/api/sdk/replay/start", payload, timeout:)
end