Change the resumable query API #32
Merged
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
There were couple of problems with it: - We don't use the async prefix in async method names in the public API - We don't return the result for APIs that returns Success string only So, I have changed the implementation to fix these problems. Also, I think it is much better to return the first batch of the results directly to the user, along with an handle to fetch more or stop. This is more similar to API we have in JS SDK, makes the possible misuses impossible (you can't call stop before the start anymore etc.), and makes more sense for the async version. For the async version, we previously marked the function async but did not call any async functions, which was weird. ALso, I have changed the tests a bit to make them more resillient to failures due to potentially delayed indexing, which might happen from time to time.
|
Yeah I kinda agree with this interface. Within the first PR, this was the interface that I was going with, but I changed it to be able to use |
fahreddinozcan
approved these changes
Sep 27, 2024
CahidArda
approved these changes
Sep 27, 2024
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.
There were couple of problems with it:
So, I have changed the implementation to fix these problems.
Also, I think it is much better to return the first batch of the results directly to the user, along with an handle to fetch more or stop. This is more similar to API we have in JS SDK, makes the possible misuses impossible (you can't call stop before the start anymore etc.), and makes more sense for the async version. For the async version, we previously marked the function async but did not call any async functions, which was weird.
Also, I have changed the tests a bit to make them more resillient to failures due to potentially delayed indexing, which might happen from time to time.