3.0.0: Fix remaining REST untyped responses #882
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
…ined by request classes
| // eslint-disable-next-line class-methods-use-this | ||
| path() { | ||
| return '/health'; | ||
| } | ||
|
|
||
| async do(headers = {}) { |
There was a problem hiding this comment.
I'm I right and the overridden do was needed only becase jsonOptions: { intDecoding: IntDecoding.BIGINT } ?
There was a problem hiding this comment.
I believe the reason for it was so that an error could be thrown if the request failed. But it wasn't really effective, since if res.ok was false the underlying c.get method would already throw an error.
And since this method doesn't return any data, the bigint decoding doesn't really make a difference.
gmalouf
reviewed
Aug 13, 2024
gmalouf
reviewed
Aug 15, 2024
gmalouf
approved these changes
Aug 15, 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.
Prior to this PR, the following algod request classes still had untyped responses:
Genesis,GetLedgerStateDelta,GetLedgerStateDeltaForTransactionGroup,GetTransactionGroupLedgerStateDeltasForRound,HealthCheck,Ready,SetBlockOffsetTimestamp,SetSyncRound,UnsetSyncRound. These mostly fall into two categories: either they return no information, or they returned something related to state deltas and were passed over when #776 was merged.This PR resolves this and fixes a few other related issues/improvements:
HTTPClientno longer parses JSON responses. This simplifies thepreparemethod in request classes and no longer requires passing in JSON parsing options at the time of every request.domethod to implement their requests. That meant thedoRawmethod wasn't overridden and would produce incorrect results. Fixed by moving the override to a newexecuteRequestmethod which is called from bothdoanddoRaw.JSONRequestBlockHashSchemabecause JSON block hashes get b32 encoded and prefixed withblk-.LedgerStateDeltaand required subtypes. This comes with the caveat that the SDK does not currently support decoding maps with object keys (needed to support theTxleasesfield), so I've left that as anUntypedValuefor now. I'll open a separate issue to track that, but I don't view it as urgent/required for v3.Relies on algorand/generator#80