feat: migrate rover config whoami output to stdout and add json format
#1560
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
scombat
changed the title
rover config whoami output to stdout and add json formatrover config whoami output to stdout and add json format
EverlastingBugstopper
suggested changes
Apr 10, 2023
|
@scombat thanks so much for this PR. It's looking really good already and I really appreciate the level of detail that you've included when filing this. I don't think you need to add any more tests than you already have, and I also don't think we need to update documentation because base functionality isn't changing. We'll just make sure to call this out as a breaking change in the changelog - since Rover is still pre-1.0 this is reasonable. |
refactor(whoami): extract conditions in helper methods to improve tests, lisibility and maintenability test(whoami): add unit tests for actor type guard test(whoami): add unit tests for masked or unmasked api key test(whoami): add unit tests for graph title helper test(whoami): add unit tests for uniq graph id test(whoami): add uni tests for user id
feat(RoverOutput)!: add config whoami json output feat(RoverOuput): add WhoAmI variant
to improve whoami command output readability
in RoverOuput::ConfigWhoAmIOuput variant refactor(output): move the graph title below the graph ID for diplay refactor(output): reorder ConfigWhoAmIOutput fields alphabetically refactor(output): replace "Unique Graph ID" displayed key by "Graph ID" for the human readable format output. refactor(output): replace "uniq_graph_id" property name with "graph_id" for the json format output.
refactor(whoami): rename uniq_graph_id field to graph_id in command output refactor(whoami): reorder command output fields alphabetically
scombat
force-pushed
the
fix/1380-migrate-whoami-output-to-stdout
branch
from
a2c4ea7
to
426670b
Compare
scombat
changed the title
rover config whoami output to stdout and add json formatrover config whoami output to stdout and add json format
|
I wanted to thank you for taking the time to review this PR and for providing such helpful feedback. Your message was really encouraging and I appreciate the level of detail you've given in your comments. I'm glad to hear that the current tests and documentation are sufficient for this change. Once again, thank you for your support and valuable time. Please don't hesitate to let me know if there are any further changes or improvements that you think would be useful or if I need to remove the Best regards, Steve. |
EverlastingBugstopper
changed the title
rover config whoami output to stdout and add json formatrover config whoami output to stdout and add json format
EverlastingBugstopper
added
the
BREAKING ❗
EverlastingBugstopper
added
the
feature 🎉
Merged
EverlastingBugstopper
added a commit
that referenced
this pull request
Apr 19, 2023
# [0.14.0] - 2023-04-19 > Important: 1 potentially breaking changes below, indicated by **❗ BREAKING ❗** ## ❗ BREAKING ❗ - **`rover config whoami` outputs to `stdout` instead of `stderr` and using `--format json` includes more information than success or failure - @scombat, #1560 fixes #1380** When running `rover config whoami`, the output will print to `stdout` instead of `stderr`. This may break scripts that relied on parsing the output from `stderr`. The good news is that these scripts should be easier to write because passing `--format json` to `rover config whoami` will print structured output that can be parsed with a tool like [`jq`](https://stedolan.github.io/jq/tutorial/). ## 🚀 Features - **ALlow custom headers when running introspection with `rover supergraph compose` - @dbanty, #1574 fixes #615** A new field is available in `supergraph.yaml` files that allows sending headers along with introspection. This value also supports environment variable interpolation for sensitive values like authentication tokens. - **Print a wanring when attempting to publish a subgraph with an invalid routing URL - @trevor-scheer, #1543 fixes #1477** When running `rover subgraph publish`, if the `--routing-url` you specify or the routing URL stored in GraphOS is unroutable, a warning will be printed. If you are not in CI, you will need to manually confirm the publish to continue. You can dismiss the warning by passing `--allow-invalid-routing-url`. **Note:** This warning will become a hard error in the future. ## 🐛 Fixes - **Spawn a thread to avoid a rare deadlock in `rover dev` - @EverlastingBugstopper, #1548 fixes #1544** ## 🛠 Maintenance - **Updates dependencies - @EverlastingBugstopper, #1562** `apollo-parser` 0.4 -> 0.5 `git2` 0.16 -> 0.17 `opener` 0.5 -> 0.6 `predicates` 2 -> 3 `serial_test` 1 -> 2 `toml` 0.5 -> 0.7 ~`crossterm`~ - **Use Apple Silicon in CI - @EverlastingBugstopper, #1557 fixes #1555** There should be no user facing change here, we just run builds in CI much faster. ## 📚 Documentation - **Adds Apollo CLI migration guide to Rover docs - @StephenBarlow, #1568** The (deprecated) Apollo CLI documentation and the migration guide for Rover now live in Rover's docset. - **Cleans up nomenclature and links in Rover docs - @StephenBarlow, #1571 and #1573** Rover's documentation has been updated to refer to the [new GraphOS documentation](https://www.apollographql.com/docs/graphos) along with updating some terminology. - **Mention community-maintained installation methods - @dbanty, #1542** Rover's documentation now mentions the unofficial installation methods `nix` and `brew`.
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.
Hello everyone,
I am open to collaborating with you to improve this project. I welcome feedback and suggestions on how to make the code more efficient and effective. Please let me know if you have any thoughts or ideas for improvement. I understood that not all changes may be accepted or merged due to the
triagelabel, and that's perfectly fine. I'm open to feedback and willing to make changes as needed to improve the codebase.I would like to add functional tests for common user use cases, as well as for graphs with valid and invalid profiles for each case. However, I am not sure if it is relevant or if you have already implemented functional tests.
Description
BREAKING CHANGE: This pr fixes #1380 by using a RoverOutput
whoamivariant to print the output of therover config whoamicommand to stdout instead of stderr. It also adds the capability to print the output as json with the--jsonflag.This PR migrates the output of rover config whoami command from stderr to stdout and fixes #1380. Additionally, this PR adds the --json flag to allow users to retrieve the output in JSON format. This change improves the usability of the rover CLI and enhances the user experience.
Related Issues & discussions
rover config whoamishould print tostdoutinstead ofstderrand return JSON data #1380 Rover config whoami should print to stdout instead of stderr and return JSON dataRelated PRs
WIP :
RoverOutput::ConfigWhoAmIOutputvariantAdd functional tests for error cases and different output formatsAdd documentationChecklist
I have added or updated necessary documentation.cargo test --workspaceand all tests passed locally.cargo clippyto check for common mistakes and code style issues.cargo fmt --allto format my code.Outputs :
User Actor :
Human readable output (Keys are displayed in
Style::WhoAmIKeygreen but not in images below) [updated]Json format (with
--format jsonflag) [updated]Graph Actor :
Human readable output (Keys are displayed in
Style::WhoAmIKeygreen but not in images below) [updated]Json format (with
--format jsonflag) [updated]