cleanup(httpapi): remove optional logging-related complexity #1008
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
1. we don't care _this much_ about body logging that we need to have a specific test making sure we _actually_ log the bodies. If we break body logging by incident, that's annoying but not really bad. In exchange, we remove the most complex test of this package. 2. it's pointless to log that the content-type header is not the expected one when expecting JSON. In case of parsing failure, the user could use `-v` to turn on verbose mode and see logs. Hence, we don't need to be this picky and this also allows us to zap some extra code and testing complexity. 3. while there, avoid using `|foo|` in documentation comments because the proper form is actually `[foo]`. All this work is really just yak shaving to reduce the noise in a diff for ooni/probe#2372.
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.
Checklist
ooni/apiprobe#2372Description
we don't care this much about body logging that we need to have a specific test making sure we actually log the bodies. If we break body logging by incident, that's annoying but not really bad. In exchange, we remove the most complex test of this package.
it's pointless to log that the content-type header is not the expected one when expecting JSON. In case of parsing failure, the user could use
-vto turn on verbose mode and see logs. Hence, we don't need to be this picky and this also allows us to zap some extra code and testing complexity.while there, avoid using
|foo|in documentation comments because the proper form is actually[foo].All this work is really just yak shaving to reduce the noise in a diff for ooni/probe#2372.