load integrations by default when possible

this way, one can document a less special migration path, and even
change integration dirs if so desired.
This commit is contained in:
HoneyryderChuck 2022-12-28 15:31:14 +00:00
parent ee5c94a113
commit 1205c6964f
4 changed files with 123 additions and 117 deletions

View File

@ -1,8 +1,8 @@
# frozen_string_literal: true
require "ddtrace"
require "test_helper"
require "support/http_helpers"
require "ddtrace"
require "httpx/adapters/datadog"
class DatadogTest < Minitest::Test

View File

@ -1,118 +1,118 @@
# frozen_string_literal: true
require "logger"
require "stringio"
require "test_helper"
require "support/http_helpers"
begin
if RUBY_VERSION >= "2.4.0"
require "logger"
require "stringio"
require "sentry-ruby"
require "test_helper"
require "support/http_helpers"
require "httpx/adapters/sentry"
rescue LoadError
class SentryTest < Minitest::Test
include HTTPHelpers
DUMMY_DSN = "http://12345:67890@sentry.localdomain/sentry/42"
def test_sentry_send_yes_pii
before_pii = Sentry.configuration.send_default_pii
begin
Sentry.configuration.send_default_pii = true
transaction = Sentry.start_transaction
Sentry.get_current_scope.set_span(transaction)
uri = build_uri("/get")
response = HTTPX.get(uri, params: { "foo" => "bar" })
verify_status(response, 200)
verify_spans(transaction, response, description: "GET #{uri}?foo=bar")
ensure
Sentry.configuration.send_default_pii = before_pii
end
end
def test_sentry_send_no_pii
before_pii = Sentry.configuration.send_default_pii
begin
Sentry.configuration.send_default_pii = false
transaction = Sentry.start_transaction
Sentry.get_current_scope.set_span(transaction)
uri = build_uri("/get")
response = HTTPX.get(uri, params: { "foo" => "bar" })
verify_status(response, 200)
verify_spans(transaction, response, description: "GET #{uri}")
ensure
Sentry.configuration.send_default_pii = before_pii
end
end
def test_sentry_post_request
before_pii = Sentry.configuration.send_default_pii
begin
Sentry.configuration.send_default_pii = true
transaction = Sentry.start_transaction
Sentry.get_current_scope.set_span(transaction)
response = HTTPX.post(build_uri("/post"), form: { foo: "bar" })
verify_status(response, 200)
verify_spans(transaction, response, verb: "POST")
ensure
Sentry.configuration.send_default_pii = before_pii
end
end
def test_sentry_multiple_requests
transaction = Sentry.start_transaction
Sentry.get_current_scope.set_span(transaction)
responses = HTTPX.get(build_uri("/status/200"), build_uri("/status/404"))
verify_status(responses[0], 200)
verify_status(responses[1], 404)
verify_spans(transaction, *responses)
end
private
def verify_spans(transaction, *responses, verb: nil, description: nil)
assert transaction.span_recorder.spans.count == responses.size + 1
assert transaction.span_recorder.spans[0] == transaction
response_spans = transaction.span_recorder.spans[1..-1]
responses.each_with_index do |response, idx|
request_span = response_spans[idx]
assert request_span.op == "httpx.client"
assert !request_span.start_timestamp.nil?
assert !request_span.timestamp.nil?
assert request_span.start_timestamp != request_span.timestamp
assert request_span.description == (description || "#{verb || "GET"} #{response.uri}")
assert request_span.data == { status: response.status }
end
end
def setup
super
mock_io = StringIO.new
mock_logger = Logger.new(mock_io)
Sentry.init do |config|
config.traces_sample_rate = 1.0
config.logger = mock_logger
config.dsn = DUMMY_DSN
config.transport.transport_class = Sentry::DummyTransport
# so the events will be sent synchronously for testing
config.background_worker_threads = 0
end
end
def origin
"https://#{httpbin}"
end
end
end
class SentryTest < Minitest::Test
include HTTPHelpers
DUMMY_DSN = "http://12345:67890@sentry.localdomain/sentry/42"
def test_sentry_send_yes_pii
before_pii = Sentry.configuration.send_default_pii
begin
Sentry.configuration.send_default_pii = true
transaction = Sentry.start_transaction
Sentry.get_current_scope.set_span(transaction)
uri = build_uri("/get")
response = HTTPX.get(uri, params: { "foo" => "bar" })
verify_status(response, 200)
verify_spans(transaction, response, description: "GET #{uri}?foo=bar")
ensure
Sentry.configuration.send_default_pii = before_pii
end
end
def test_sentry_send_no_pii
before_pii = Sentry.configuration.send_default_pii
begin
Sentry.configuration.send_default_pii = false
transaction = Sentry.start_transaction
Sentry.get_current_scope.set_span(transaction)
uri = build_uri("/get")
response = HTTPX.get(uri, params: { "foo" => "bar" })
verify_status(response, 200)
verify_spans(transaction, response, description: "GET #{uri}")
ensure
Sentry.configuration.send_default_pii = before_pii
end
end
def test_sentry_post_request
before_pii = Sentry.configuration.send_default_pii
begin
Sentry.configuration.send_default_pii = true
transaction = Sentry.start_transaction
Sentry.get_current_scope.set_span(transaction)
response = HTTPX.post(build_uri("/post"), form: { foo: "bar" })
verify_status(response, 200)
verify_spans(transaction, response, verb: "POST")
ensure
Sentry.configuration.send_default_pii = before_pii
end
end
def test_sentry_multiple_requests
transaction = Sentry.start_transaction
Sentry.get_current_scope.set_span(transaction)
responses = HTTPX.get(build_uri("/status/200"), build_uri("/status/404"))
verify_status(responses[0], 200)
verify_status(responses[1], 404)
verify_spans(transaction, *responses)
end
private
def verify_spans(transaction, *responses, verb: nil, description: nil)
assert transaction.span_recorder.spans.count == responses.size + 1
assert transaction.span_recorder.spans[0] == transaction
response_spans = transaction.span_recorder.spans[1..-1]
responses.each_with_index do |response, idx|
request_span = response_spans[idx]
assert request_span.op == "httpx.client"
assert !request_span.start_timestamp.nil?
assert !request_span.timestamp.nil?
assert request_span.start_timestamp != request_span.timestamp
assert request_span.description == (description || "#{verb || "GET"} #{response.uri}")
assert request_span.data == { status: response.status }
end
end
def setup
super
mock_io = StringIO.new
mock_logger = Logger.new(mock_io)
Sentry.init do |config|
config.traces_sample_rate = 1.0
config.logger = mock_logger
config.dsn = DUMMY_DSN
config.transport.transport_class = Sentry::DummyTransport
# so the events will be sent synchronously for testing
config.background_worker_threads = 0
end
end
def origin
"https://#{httpbin}"
end
end if RUBY_VERSION >= "2.4.0"

View File

@ -1,9 +1,9 @@
# frozen_string_literal: true
require "test_helper"
require "support/http_helpers"
require "webmock/minitest"
require "httpx/adapters/webmock"
require "test_helper"
require "support/http_helpers"
class WebmockTest < Minitest::Test
include HTTPHelpers

View File

@ -67,3 +67,9 @@ end
require "httpx/session"
require "httpx/session_extensions"
# load integrations when possible
require "httpx/adapters/datadog" if defined?(DDTrace) || defined?(Datadog)
require "httpx/adapters/sentry" if defined?(Sentry)
require "httpx/adapters/webmock" if defined?(WebMock)