Return batch statuses even when some timeout #1815
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
ameliabradley
requested review from
agunde406,
Caleb-Hill,
davececchi,
dnewh,
isabeltomb,
jsmitchell,
peterschwarz,
rbuysse,
shannynalayna and
vaporos
as code owners
github-actions
bot
added
backport-triage
ameliabradley
force-pushed
the
return-batch-statuses-even-when-some-timeout
branch
from
bcfbf5b
to
89cbae3
Compare
ameliabradley
force-pushed
the
return-batch-statuses-even-when-some-timeout
branch
from
08bc9b2
to
6330c00
Compare
vaporos
previously approved these changes
Feb 22, 2022
peterschwarz
suggested changes
Feb 22, 2022
ameliabradley
force-pushed
the
return-batch-statuses-even-when-some-timeout
branch
3 times, most recently
from
37571d1
to
6439fc9
Compare
peterschwarz
previously approved these changes
Mar 2, 2022
added 2 commits
March 3, 2022 11:10
This change modifies the Splinter /batch_statuses endpoint so that it will return batch statuses, even if some of them time out. Batch statuses that time out are returned as "Unknown". Previously, if a single batch status were to timeout, the endpoint would return none at all. The endpoint result would be a non-parsable string error containing the problem batch ids. This change should give users of this endpoint maximal information. Users can use the successful ids, and they can determine programatically which ones timed out. Also updated several tests to validate the new expected responses. Signed-off-by: Lee Bradley <bradley@bitwise.io>
This change updates the wait_for_batches function in the Reqwest client so that it will identify Unknown batches and return an error. Signed-off-by: Lee Bradley <bradley@bitwise.io>
ameliabradley
force-pushed
the
return-batch-statuses-even-when-some-timeout
branch
from
6439fc9
to
11131b5
Compare
Previously, if a batch status response was "Unknown" or "Pending", the message field would not be returned (unlike "Invalid", "Valid" and "Committed"). The OpenAPI spec states that message is not an optional return value. This change modifies the serde serialization so that both the "Unknown" and "Pending" enum variants are serialized as empty sequences, and thus message is never empty. This change also adds tests to validate the resulting JSON output. To ensure that the string ouput for tests is deterministic, the preserve_order feature is enabled in development builds. Signed-off-by: Lee Bradley <bradley@bitwise.io>
ameliabradley
force-pushed
the
return-batch-statuses-even-when-some-timeout
branch
from
11131b5
to
1ebca2a
Compare
peterschwarz
approved these changes
Mar 4, 2022
vaporos
approved these changes
Apr 29, 2022
peterschwarz
added
backport-0-4
ameliabradley
added
the
backport-complete
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.
This change modifies the Splinter /batch_statuses endpoint so that it
will return batch statuses, even if some of them time out. Batch
statuses that time out are returned as "Unknown".
Previously, if a single batch status were to timeout, the endpoint would
return none at all. The endpoint result would be a non-parsable string
error containing the problem batch ids.
This change should give users of this endpoint maximal information.
Users can use the successful ids, and they can determine programatically
which ones timed out.
Also updated several tests to validate the new expected responses.
Signed-off-by: Lee Bradley bradley@bitwise.io