Compare commits

..

1 Commits

Author SHA1 Message Date
Annie Li
e03fa884f4 Codegen for openapi v217 2023-01-05 10:17:24 -08:00
9 changed files with 38 additions and 117 deletions

View File

@ -1,8 +1,5 @@
# Changelog
## 8.1.0 - 2023-01-12
* [#1162](https://github.com/stripe/stripe-ruby/pull/1162) Improve request events instrumentation
## 8.0.0 - 2022-11-16
* [#1144](https://github.com/stripe/stripe-ruby/pull/1144) Next major release changes

View File

@ -1 +1 @@
v219
v217

View File

@ -253,11 +253,7 @@ a success or error. Receives `RequestEndEvent` with the following properties:
- `path`: Request path. (`String`)
- `user_data`: A hash on which users may have set arbitrary data in
`request_begin`. See above for more information. (`Hash`)
- `request_id`: HTTP request identifier. (`String`)
- `response_header`: The response headers. (`Hash`)
- `response_body` = The response body. (`String`)
- `request_header` = The request headers. (`Hash`)
- `request_body` = The request body. (`String`)
- `request_id`. HTTP request identifier.
#### Example

View File

@ -1 +1 @@
8.1.0
8.0.0

View File

@ -33,10 +33,6 @@ module Stripe
attr_reader :num_retries
attr_reader :path
attr_reader :request_id
attr_reader :response_header
attr_reader :response_body
attr_reader :request_header
attr_reader :request_body
# Arbitrary user-provided data in the form of a Ruby hash that's passed
# from subscribers on `request_begin` to subscribers on `request_end`.
@ -44,50 +40,16 @@ module Stripe
# in `request_end`.
attr_reader :user_data
def initialize(request_context:, response_context:,
num_retries:, user_data: nil)
@duration = request_context.duration
@http_status = response_context.http_status
@method = request_context.method
@num_retries = num_retries
@path = request_context.path
@request_id = request_context.request_id
@user_data = user_data
@response_header = response_context.header
@response_body = response_context.body
@request_header = request_context.header
@request_body = request_context.body
freeze
end
end
class RequestContext
attr_reader :duration
attr_reader :method
attr_reader :path
attr_reader :request_id
attr_reader :body
attr_reader :header
def initialize(duration:, context:, header:)
def initialize(duration:, http_status:, method:, num_retries:, path:,
request_id:, user_data: nil)
@duration = duration
@method = context.method
@path = context.path
@request_id = context.request_id
@body = context.body
@header = header
end
end
class ResponseContext
attr_reader :http_status
attr_reader :body
attr_reader :header
def initialize(http_status:, response:)
@http_status = http_status
@header = response ? response.to_hash : nil
@body = response ? response.body : nil
@method = method
@num_retries = num_retries
@path = path
@request_id = request_id
@user_data = user_data
freeze
end
end

View File

@ -494,16 +494,15 @@ module Stripe
end
end
http_resp =
execute_request_with_rescues(method, api_base, headers, context) do
self.class
.default_connection_manager(config)
.execute_request(method, url,
body: body,
headers: headers,
query: query,
&response_block)
end
http_resp = execute_request_with_rescues(method, api_base, context) do
self.class
.default_connection_manager(config)
.execute_request(method, url,
body: body,
headers: headers,
query: query,
&response_block)
end
[http_resp, api_key]
end
@ -565,7 +564,7 @@ module Stripe
http_status >= 400
end
private def execute_request_with_rescues(method, api_base, headers, context)
private def execute_request_with_rescues(method, api_base, context)
num_retries = 0
begin
@ -588,7 +587,7 @@ module Stripe
log_response(context, request_start, http_status, resp.body, resp)
notify_request_end(context, request_duration, http_status,
num_retries, user_data, resp, headers)
num_retries, user_data)
if config.enable_telemetry? && context.request_id
request_duration_ms = (request_duration * 1000).to_i
@ -615,7 +614,7 @@ module Stripe
log_response_error(error_context, request_start, e)
end
notify_request_end(context, request_duration, http_status, num_retries,
user_data, resp, headers)
user_data)
if self.class.should_retry?(e,
method: method,
@ -658,24 +657,17 @@ module Stripe
end
private def notify_request_end(context, duration, http_status, num_retries,
user_data, resp, headers)
user_data)
return if !Instrumentation.any_subscribers?(:request_end) &&
!Instrumentation.any_subscribers?(:request)
request_context = Stripe::Instrumentation::RequestContext.new(
duration: duration,
context: context,
header: headers
)
response_context = Stripe::Instrumentation::ResponseContext.new(
http_status: http_status,
response: resp
)
event = Instrumentation::RequestEndEvent.new(
request_context: request_context,
response_context: response_context,
duration: duration,
http_status: http_status,
method: context.method,
num_retries: num_retries,
path: context.path,
request_id: context.request_id,
user_data: user_data || {}
)
Stripe::Instrumentation.notify(:request_end, event)

View File

@ -1,5 +1,5 @@
# frozen_string_literal: true
module Stripe
VERSION = "8.1.0"
VERSION = "8.0.0"
end

View File

@ -58,29 +58,13 @@ module Stripe
context "RequestEventEnd" do
should "return a frozen object" do
mock_context = stub(
event = Stripe::Instrumentation::RequestEndEvent.new(
duration: 0.1,
http_status: 200,
method: :get,
num_retries: 0,
path: "/v1/test",
request_id: "req_123",
body: ""
)
request_context = Stripe::Instrumentation::RequestContext.new(
duration: 0.1,
context: mock_context,
header: nil
)
response_context = Stripe::Instrumentation::ResponseContext.new(
http_status: 200,
response: nil
)
event = Stripe::Instrumentation::RequestEndEvent.new(
num_retries: 0,
request_context: request_context,
response_context: response_context,
user_data: nil
)

View File

@ -1443,25 +1443,19 @@ module Stripe
should "notify a subscriber of a successful HTTP request" do
events = []
Stripe::Instrumentation.subscribe(:request_end, :test) { |event| events << event }
stub_response_body = JSON.generate(object: "charge")
stub_request(:post, "#{Stripe.api_base}/v1/charges")
.with(body: { "amount" => "50", "currency" => "usd", "card" => "sc_token" })
.to_return(body: stub_response_body, headers: { "Request-ID": "req_123" })
Stripe::Charge.create(amount: 50, currency: "usd", card: "sc_token")
stub_request(:get, "#{Stripe.api_base}/v1/charges")
.to_return(body: JSON.generate(object: "charge"), headers: { "Request-ID": "req_123" })
Stripe::Charge.list
assert_equal(1, events.size)
event = events.first
assert_equal(:post, event.method)
assert_equal(:get, event.method)
assert_equal("/v1/charges", event.path)
assert_equal(200, event.http_status)
assert(event.duration.positive?)
assert_equal(0, event.num_retries)
assert_equal("req_123", event.request_id)
assert_equal(stub_response_body, event.response_body)
assert_equal("amount=50&currency=usd&card=sc_token", event.request_body)
assert(event.request_header)
end
should "notify a subscriber of a StripeError" do
@ -1490,7 +1484,6 @@ module Stripe
assert_equal(500, event.http_status)
assert(event.duration.positive?)
assert_equal(0, event.num_retries)
assert_equal(JSON.generate(error: error), event.response_body)
end
should "notify a subscriber of a network error" do
@ -1533,9 +1526,8 @@ module Stripe
events = []
Stripe::Instrumentation.subscribe(:request, :test) { |event| events << event }
stub_response_body = JSON.generate(object: "charge")
stub_request(:get, "#{Stripe.api_base}/v1/charges")
.to_return(body: stub_response_body)
.to_return(body: JSON.generate(object: "charge"))
Stripe::Charge.list
assert_equal(1, events.size)
@ -1545,8 +1537,6 @@ module Stripe
assert_equal(200, event.http_status)
assert(event.duration.positive?)
assert_equal(0, event.num_retries)
assert_equal(stub_response_body, event.response_body)
assert(event.request_header)
end
end
end