fix: improve API compatibility for next release #292
Merged
Conversation
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
Contributor
daniel-sanche
commented
May 11, 2021
- As aprt of the next release, I removed some fields in the http_request data (referer, remoteIp, requestSize), because they don't work consistently across all GCP environments yet. I realized this would be considered a breaking change for AppEngine users who may already be relying on these fields. Instead of removing the fields, non-appengine handlers now filter them out. We can re-consider the future of these fields for v3.0.0
- StructuredLogHandler formatting breaks if users log text with quotes in it. Now, the handler will add "" before each quote found in the message string
- The Flask request detection broke in the unit tests, so I also fixed that
…ing into extra-http-fields
freelerobot
reviewed
May 12, 2021
| overwritten using the `extras` argument when writing logs. | ||
| """ | ||
|
|
||
| # The subset of http_request fields have been tested to work consistently across GCP environments |
Contributor
There was a problem hiding this comment.
Great commenting throughout this PR.
freelerobot
reviewed
May 12, 2021
| import json | ||
|
|
||
| handler = self._make_one() | ||
| message = '"test"' |
Contributor
There was a problem hiding this comment.
Are other special chars escaped as well?
Contributor
Author
There was a problem hiding this comment.
I haven't seen any that need it. Let me know if you find others, I imagine it will be the same across languages
freelerobot
approved these changes
May 12, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.