feat(python): validate and clean up the result of the grouping function #272
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
erunion
approved these changes
Jul 8, 2021
Co-authored-by: Jon Ursenbach <[email protected]>
domharrington
pushed a commit
that referenced
this pull request
Apr 19, 2022
…on (#272) * feat(python): validate and clean up the result of the grouping function * Update packages/python/readme_metrics/PayloadBuilder.py Co-authored-by: Jon Ursenbach <[email protected]> Co-authored-by: Jon Ursenbach <[email protected]>
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.
🧰 What's being changed?
PayloadBuilder now validates the output of the grouping function. If the output isn't a dict or doesn't include
api_keyorid, we log an error and don't send the request to ReadMe. If the output is missing other expected fieldsemailandlabel, we log a warning but send the request anyway. And if the output includes any unexpected fields, we log a warning and remove them before sending the request to ReadMe.Note that by default the logger is set to log level
CRITICALso users won't typically see these warnings and errors unless they modify the logger in theMetricsApiConfigobject. I actually think that's fine—we want the metrics clients to be pretty transparent and not pollute our users' logs when they haven't opted in for that.🧪 Testing
New unit tests.