source-braintree-native: run synchronous API calls in separate threads #2195
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Braintree SDK make synchronous HTTP requests, which was blocking the main thread and preventing separate streams from sending concurrent API calls. Any HTTP requests made by the Braintree SDK are now wrapped in `asyncio.to_thread`, which runs the function in a separate thread. This unblocks the main thread and lets separate streams make concurrent API calls.
…rough results The Braintree SDK exposes a `maximum_size` property for `ResourceCollection`s that indicate how many results were found in a specific date window. This can be used to throw search limit errors sooner. The `disputes` stream cannot use the `maximum_size` property because the Braintree SDK returns a `PaginatedCollection` instead of a `ResourceCollection` for `disputes`, and `PaginatedCollection`s don't have a `maximum_size` property. Note: Braintree states that `maximum_size` is an approximation due to race conditions between the first API call to get all matching resource IDs and the subsequent API calls to paginate through the actual resources; if a resource no longer matches the original seach criteria during the subsequent calls, it won't be returned. However, this shouldn't be an issue for the connector since our search criteria is only based on the `created_at` field, and I don't anticipate that field would change after being set.
Alex-Bair
added
the
change:unplanned
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
The Braintree SDK makes synchronous HTTP requests, which was blocking the main thread and preventing separate streams from sending concurrent API calls. Any HTTP requests made by the Braintree SDK are now wrapped in
asyncio.to_thread, which runs the function in a separate thread. This unblocks the main thread and lets separate streams make concurrent API calls.The
maximum_sizeproperty that indicates how many results are found in a specific date window is now used to throw search limit errors sooner instead of after we iterate through & count up all results.Note: The
disputesstream cannot use themaximum_sizeproperty because the Braintree SDK returns aPaginatedCollectioninstead of aResourceCollectionfordisputes, andPaginatedCollections don't have amaximum_sizeproperty.Workflow steps:
(How does one use this feature, and how has it changed)
Documentation links affected:
(list any documentation links that you created, or existing ones that you've identified as needing updates, along with a brief description)
Notes for reviewers:
Tested on a local stack. Confirmed:
This change is