Add format flag to listen cmd #615
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
The format flag is a string that currently only takes in JSON as a valid input option. It's inteded to replace the --print-json for the listen cmd. The difference in behavior between --format JSON and --print-json is that the new flag will stripe out all formatting in the payload.
vcheung-stripe
requested changes
Mar 17, 2021
Oh my goodness, thank you for catching these! |
There was a problem hiding this comment.
The messages look good to me. I can't speak for the rest of it so passing back r? @tomer-stripe
There was a problem hiding this comment.
This looks good! Two quick questions:
- is
JSONcase sensitive? It probably shouldn't be but I can't remember what we do in request logs - did you test this with piping into
jq? We should make sure that still works (and potentially mention that in the deprecation message too)
|
LGTM but same questions as @tomer-stripe for case sensitivity. As a user I think I'd default to |
|
|
Okay, I updated the flag check to be case insensitive for both
And the updated deprecation message:
ptal @tomer-stripe |
vcheung-stripe
approved these changes
Mar 18, 2021
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.
Reviewers
r? @tomer-stripe
cc @stripe/developer-products
Summary
The --format flag is a string that currently only takes in JSON as a valid input option, similar to the log tailing command.
It's intended to replace the --print-json for the listen cmd. The difference in behavior between --format JSON and --print-json is that the new flag will stripe out all formatting in the payload.
While working on the event streaming feature in VSCode, the stream was getting partial json because the json was being pretty-printed. This PR updates the listen cmd to behave the same way as the log tail command.
Testing
With the deprecated flag:
New flag:
No flag:
