[PROF-9821] Fix incorrect code provenance due to broken JSON monkey patch #3695
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
…atch **What does this PR do?** This PR tweaks the `Datadog::Profiling::Collectors::CodeProvenance::Library` class so that if it is encoded instance-filed-by-instance-field it results in a correct code provenance JSON file. Specifically, the `path` argument is now stored as a `paths` array, to match what we expect in the JSON file. **Motivation:** We've discovered that in a certain combination of the oj and activesupport libraries, when oj is used to replace the standard library JSON gem, it incorrectly encodes our `Library` instances instance-field-by-instance-field instead of calling `#to_json`. This resulted in incorrect code provenance files, which would be rejected by the backend. Since the change is trivial (`path` => `paths` array), I've opted to change the shape of `Library` so that it still encodes correctly in the presence of a buggy JSON encoder monkey patch. **Additional Notes:** N/A **How to test the change?** I've added coverage to this issue. I did it in a bit of a roundabout way (using YAML), see details for why, but I claim it's a reasonable proxy for any encoder that encodes field-by-field, including oj.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3695 +/- ##
=======================================
Coverage 98.11% 98.11%
=======================================
Files 1225 1225
Lines 72743 72755 +12
Branches 3479 3479
=======================================
+ Hits 71369 71382 +13
+ Misses 1374 1373 -1 ☔ View full report in Codecov by Sentry. |
p-datadog
approved these changes
Jun 10, 2024
| path: '/example/path/to/datadog/gem', | ||
| ) | ||
|
|
||
| serialized_without_to_json = YAML.dump(instance) |
There was a problem hiding this comment.
Is the reasoning here that YAML serialization is performed field by field, same as some JSON libraries would serialize, or that libraries like oj actually use YAML serialization logic? I am guessing it's the former and if so, a comment to this effect in the code would be helpful.
There was a problem hiding this comment.
Yes! I've added a comment above the spec stating this:
# So instead in this test we use YAML as an example of an encoder that doesn't use #to_json, and does it
# field-by-field. Thus if the Library class doesn't match exactly what we want in the output, this test will fail.
p-datadog
approved these changes
Jun 10, 2024
Merged
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 does this PR do?
This PR tweaks the
Datadog::Profiling::Collectors::CodeProvenance::Libraryclass so that if it is encoded instance-filed-by-instance-field it results in a correct code provenance JSON file.Specifically, the
pathargument is now stored as apathsarray, to match what we expect in the JSON file.Motivation:
We've discovered that in a certain combination of the oj and activesupport libraries, when oj is used to replace the standard library JSON gem, it incorrectly encodes our
Libraryinstances instance-field-by-instance-field instead of calling#to_json.This resulted in incorrect code provenance files, which would be rejected by the backend.
Since the change is trivial (
path=>pathsarray), I've opted to change the shape ofLibraryso that it still encodes correctly in the presence of a buggy JSON encoder monkey patch.Additional Notes:
N/A
How to test the change?
I've added coverage to this issue. I did it in a bit of a roundabout way (using YAML), see details for why, but I claim it's a reasonable proxy for any encoder that encodes field-by-field, including oj.