Repository navigation
Make raw data optional in API Requests - #996
Merged
PaulBernier merged 4 commits intoAug 21, 2020
Merged
Conversation
PaulSnow
reviewed
Jun 3, 2020
PaulSnow
previously approved these changes
Jun 3, 2020
PaulSnow
left a comment
Contributor
There was a problem hiding this comment.
Low level request to clarify the negative boolean, but not a blocking issue.
Member
Author
|
Added both suggestions |
Contributor
|
This is looking good, can you rebase the PR against wax rollup @WhoSoup |
WhoSoup
force-pushed
the
WhoSoup-no_raw
branch
from
August 19, 2020 08:00
49e49bb to
682efc2
Compare
Member
Author
|
It's rebased. The test that fails is in the p2p package and unrelated to this PR. I have run the wsapi package test locally and it passed. Edit: #1023 |
PaulBernier
reviewed
Aug 20, 2020
This was referenced Oct 20, 2020
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
I was analyzing D/EC blocks for an unrelated issue and noticed that the API will always send both the json data and the raw message, even if you don't need both. This wastes quite a bit of bandwidth particularly for EC blocks (they're huge due to PegNet). There already is a "get-raw" endpoint for those that only need the raw data but no way to get just the json without the raw.
This changes the following endpoints:
("directory-block" itself doesn't even have a raw option, oddly enough)
It adds an optional "noraw" argument to the json call that accepts either "true" or "false". If "noraw" is not present, everything works as before. If "noraw" is true, the API won't return the raw data.
Benchmarked on a LAN copy of factomd, trying to download 3,000 ecblocks (240650 to 243650):
A ~44% reduction in size and 26% reduction in transfer duration.