Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Issue 5719 - remove Pretty JSON and make it user configurable #5766

Merged
merged 9 commits into from Aug 21, 2023
Merged

Issue 5719 - remove Pretty JSON and make it user configurable #5766

merged 9 commits into from Aug 21, 2023

Conversation

gtebrean
Copy link
Contributor

@gtebrean gtebrean commented Aug 17, 2023 •
edited

PR description

Added --pretty-json-enabled as CLI option as it was asked in the issue mentioned bellow.

Here I attached an example with the output of a RPC request when Besu was ran with --pretty-json-enabled (first case) and without the argument in second case:
Screenshot 2023-08-17 at 16 44 00

Fixed Issue(s)

Fixes #5712

@github-actions
Copy link

github-actions bot commented Aug 17, 2023 •
edited by gtebrean

  • I thought about documentation and added the doc-change-required label to this PR if updates are required.
  • I thought about the changelog and included a changelog update if required.
  • If my PR includes database changes (e.g. KeyValueSegmentIdentifier) I have thought about compatibility and performed forwards and backwards compatibility tests

gtebrean and others added 2 commits August 17, 2023 17:02
@gtebrean
update changelog
fc4f189 
Signed-off-by: George Tebrean <george@web3labs.com>
@gtebrean
Merge branch 'main' into issue_5719
53ae8c4
macfarla
macfarla reviewed Aug 18, 2023
View reviewed changes
Copy link
Contributor

@macfarla macfarla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this CLI option cover both HTTP and websockets?

besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java Outdated Show resolved Hide resolved
@gtebrean
fix comments
7b989ec 
Signed-off-by: George Tebrean <george@web3labs.com>
@gtebrean
Copy link
Contributor Author

does this CLI option cover both HTTP and websockets?

Yes because is setting the format in JsonRpcConfiguration which is used by both. But anyway the websockets it returns the response without pretty print, unless jq,as example, is not specified as option.

@gtebrean
fix spotless
1266b76 
Signed-off-by: George Tebrean <george@web3labs.com>
@gtebrean
fix unit test
02800c5 
Signed-off-by: George Tebrean <george@web3labs.com>
@gtebrean gtebrean requested a review from macfarla August 18, 2023 07:23
@macfarla macfarla added the doc-change-required Indicates an issue or PR that requires doc to be updated label Aug 20, 2023
macfarla
macfarla approved these changes Aug 20, 2023
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
@macfarla
Update CLI option name in CHANGELOG.md
4f74a15 
Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
@macfarla
Merge branch 'main' into issue_5719
48534b8
@macfarla
Copy link
Contributor

Docs change required - add a note to docs that all HTTP and Websockets responses will be compact JSON by default, and the --json-pretty-print-enabled can be used to pretty-print the output if desired.

@macfarla macfarla enabled auto-merge (squash) August 21, 2023 00:11
@macfarla macfarla merged commit 92a3c5b into hyperledger:main Aug 21, 2023
18 of 19 checks passed
This was referenced Aug 22, 2023
Closed
Merged
garyschulte pushed a commit to garyschulte/besu that referenced this pull request Aug 28, 2023
@gtebrean @macfarla @garyschulte
Issue 5719 - remove Pretty JSON and make it user configurable (hyperl…
3cbddaa 
…edger#5766)

* add --pretty-json-enabled

* update changelog

Signed-off-by: George Tebrean <george@web3labs.com>

* Update CLI option name in CHANGELOG.md

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>

---------

Signed-off-by: George Tebrean <george@web3labs.com>
Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
garyschulte pushed a commit to garyschulte/besu that referenced this pull request Aug 28, 2023
@gtebrean @macfarla @garyschulte
Issue 5719 - remove Pretty JSON and make it user configurable (hyperl…
892c340 
…edger#5766)

* add --pretty-json-enabled

* update changelog

Signed-off-by: George Tebrean <george@web3labs.com>

* Update CLI option name in CHANGELOG.md

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>

---------

Signed-off-by: George Tebrean <george@web3labs.com>
Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
garyschulte pushed a commit to garyschulte/besu that referenced this pull request Aug 28, 2023
@gtebrean @macfarla @garyschulte
Issue 5719 - remove Pretty JSON and make it user configurable (hyperl…
97f052f 
…edger#5766)

* add --pretty-json-enabled

* update changelog

Signed-off-by: George Tebrean <george@web3labs.com>

* Update CLI option name in CHANGELOG.md

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>

---------

Signed-off-by: George Tebrean <george@web3labs.com>
Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
Signed-off-by: garyschulte <garyschulte@gmail.com>
@bgravenorst bgravenorst removed the doc-change-required Indicates an issue or PR that requires doc to be updated label Aug 31, 2023
@bgravenorst bgravenorst mentioned this pull request Aug 31, 2023
Closed
@non-fungible-nelson non-fungible-nelson added doc-change-required Indicates an issue or PR that requires doc to be updated and removed doc-change-required Indicates an issue or PR that requires doc to be updated labels Sep 11, 2023
eum602 pushed a commit to lacchain/besu that referenced this pull request Nov 3, 2023
@gtebrean @macfarla @eum602
Issue 5719 - remove Pretty JSON and make it user configurable (hyperl…
646b1b3 
…edger#5766)

* add --pretty-json-enabled

* update changelog

Signed-off-by: George Tebrean <george@web3labs.com>

* Update CLI option name in CHANGELOG.md

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>

---------

Signed-off-by: George Tebrean <george@web3labs.com>
Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@macfarla macfarla macfarla approved these changes

Assignees
No one assigned
Labels
mainnet RPC ux
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Change default to remove Pretty JSON and make it user configurable
4 participants
@gtebrean @macfarla @bgravenorst @non-fungible-nelson