[Core] Avoid NPEs on creating events #179
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
When creating trace event format events, the code used to throw NullPointerExceptions when trying to construct an event from a JsonObject that was missing required members. This change adds static `fromJson` methods, which check the members exist, or otherwise throw an IllegalArgumentException. It also adds some basic tests for the Event classes. Signed-off-by: Sara Adams <sara.e.adams@gmail.com>
iamricard
approved these changes
May 23, 2024
laszlocsomor
approved these changes
May 23, 2024
Comment on lines
+45
to
+54
| List<String> missingMembers = Lists.newArrayList(); | ||
| for (String requiredMember : REQUIRED_JSON_MEMBERS) { | ||
| if (!event.has(requiredMember)) { | ||
| missingMembers.add(requiredMember); | ||
| } | ||
| } | ||
| if (!missingMembers.isEmpty()) { | ||
| throw new IllegalArgumentException( | ||
| "Missing members: " + Arrays.toString(missingMembers.toArray())); | ||
| } |
There was a problem hiding this comment.
In a follow-up, this could become a generic helper method.
| @@ -0,0 +1,26 @@ | |||
| /* | |||
| * Copyright 2022 EngFlow Inc. | |||
Signed-off-by: Sara Adams <sara.e.adams@gmail.com>
Done. Although throwing NPE vs IAE can also be seen as a matter of preference. |
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.
When creating trace event format events, the code used to throw NullPointerExceptions when trying to construct an event from a JsonObject that was missing required members.
This change adds static
fromJsonmethods, which check the members exist, or otherwise throw an IllegalArgumentException. This better communicates the kind of error that occurred - the provided Json did not have the expected form.This change also adds some basic documentation and tests for the Event classes.