Streaming requests #1207
Streaming requests #1207
Conversation
richardm-stripe
force-pushed
the
richardm-binary-streaming
branch
from
a953964 to
304aa7e
Compare
| this.bodyStream = bodyStream; | ||
| } | ||
|
|
||
| public StripeResponse unstream() throws IOException { |
There was a problem hiding this comment.
Bikeshedding on this name encouraged.
There was a problem hiding this comment.
readStream? readFromStream?
| public StripeResponse requestWithTelemetry(StripeRequest request) throws StripeException { | ||
| public StripeResponseStream requestStream(StripeRequest request) throws StripeException { | ||
| throw new UnsupportedOperationException( | ||
| "streamingRequest is unimplemented for this HttpClient"); |
There was a problem hiding this comment.
streamingRequest -> requestStream?
| this.bodyStream = bodyStream; | ||
| } | ||
|
|
||
| public StripeResponse unstream() throws IOException { |
There was a problem hiding this comment.
readStream? readFromStream?
| import java.time.Instant; | ||
|
|
||
| /** Common interface representing an HTTP response from Stripe. */ | ||
| interface StripeResponseInterface { |
There was a problem hiding this comment.
It seems like the majority of this implementation would be shared right (ie. all the header extraction)? If so, I think we could make some abstract class with the shared implementation to avoid duplicating the code and have both implementations extend this instead of (or along with) the interface. This might be nice for testing as well.
richardm-stripe
force-pushed
the
richardm-binary-streaming
branch
from
92c9ff3 to
9b16a15
Compare
richardm-stripe
force-pushed
the
richardm-binary-streaming
branch
from
5310d7e to
001fdc0
Compare
richardm-stripe
force-pushed
the
richardm-binary-streaming
branch
from
001fdc0 to
6d2b0dc
Compare
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
|
|
||
| public class StripeResponseStream extends AbstractStripeResponse<InputStream> { |
There was a problem hiding this comment.
Nit: StripeResponseStream -> StripeStreamResponse for consistency with other libraries?
Notify
r? @dcr-stripe
cc @stripe/api-libraries
Summary
Adds
ApiResource.requestStream, which is likeApiResource.requestexcept does not buffer the response body into memory and makes no attempt to deserialize the body. Instead, returns anInputStream.Motivation: a
/pdfendpoint is coming soon to the Stripe API, which returns the bytes of a pdf. Users will want to e.g. pipe these bytes to a file, or pipe them to an email API. This is unlike all previous Stripe methods, which return JSON and are buffered into memory and parsed.Similar to https://github.com/stripe/stripe-node/pull/1157/files
I ran japi-compliance-checker and got the following
report -- no incompatible changes.