Attachments can be manipulated via hints #2046
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,108 @@ | ||
| package io.sentry.hints; | ||
|
|
||
| import io.sentry.Attachment; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.concurrent.CopyOnWriteArrayList; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| public final class Hints { | ||
|
|
||
| private final @NotNull Map<String, Object> internalStorage = new HashMap<String, Object>(); | ||
| private final @NotNull List<Attachment> attachments = new CopyOnWriteArrayList<>(); | ||
| private @Nullable Attachment screenshot = null; | ||
|
There was a problem hiding this comment. do we need some kind of synchronization around this field (looking at There was a problem hiding this comment. Ah no, I don't think it needs to be synchronized, can replace with a different implementation. |
||
|
|
||
| public static @NotNull Hints withAttachment(@Nullable Attachment attachment) { | ||
| @NotNull final Hints hints = new Hints(); | ||
| hints.addAttachment(attachment); | ||
| return hints; | ||
| } | ||
|
|
||
| public static @NotNull Hints withAttachments(@Nullable List<Attachment> attachments) { | ||
| @NotNull final Hints hints = new Hints(); | ||
| hints.addAttachments(attachments); | ||
| return hints; | ||
| } | ||
|
|
||
| public Hints() { | ||
| primitiveMappings = new HashMap<>(); | ||
|
There was a problem hiding this comment. can this be done in a |
||
| primitiveMappings.put("boolean", Boolean.class); | ||
| primitiveMappings.put("char", Character.class); | ||
| primitiveMappings.put("byte", Byte.class); | ||
| primitiveMappings.put("short", Short.class); | ||
| primitiveMappings.put("int", Integer.class); | ||
| primitiveMappings.put("long", Long.class); | ||
| primitiveMappings.put("float", Float.class); | ||
| primitiveMappings.put("double", Double.class); | ||
| } | ||
|
|
||
philipphofmann marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| public void set(@NotNull String name, @Nullable Object hint) { | ||
| internalStorage.put(name, hint); | ||
| } | ||
|
|
||
| public @Nullable Object get(@NotNull String name) { | ||
| return internalStorage.get(name); | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| public <T extends Object> @Nullable T getAs(@NotNull String name, @NotNull Class<T> clazz) { | ||
| Object hintValue = internalStorage.get(name); | ||
|
|
||
| if (clazz.isInstance(hintValue)) { | ||
adinauer marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return (T) hintValue; | ||
| } else if (isCastablePrimitive(hintValue, clazz)) { | ||
| return (T) hintValue; | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| public void remove(@NotNull String name) { | ||
| internalStorage.remove(name); | ||
| } | ||
|
|
||
| public void addAttachment(@Nullable Attachment attachment) { | ||
| if (attachment != null) { | ||
| attachments.add(attachment); | ||
| } | ||
| } | ||
|
|
||
| public void addAttachments(@Nullable List<Attachment> attachments) { | ||
| if (attachments != null) { | ||
| this.attachments.addAll(attachments); | ||
| } | ||
| } | ||
|
|
||
| public @NotNull List<Attachment> getAttachments() { | ||
| return new CopyOnWriteArrayList<>(attachments); | ||
| } | ||
|
|
||
| public void replaceAttachments(@Nullable List<Attachment> attachments) { | ||
| clearAttachments(); | ||
| addAttachments(attachments); | ||
| } | ||
|
|
||
| public void clearAttachments() { | ||
| attachments.clear(); | ||
philipphofmann marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| public void setScreenshot(@Nullable Attachment screenshot) { | ||
| this.screenshot = screenshot; | ||
| } | ||
|
|
||
| public @Nullable Attachment getScreenshot() { | ||
| return screenshot; | ||
| } | ||
|
|
||
| private final Map<String, Class<?>> primitiveMappings; | ||
|
|
||
| private boolean isCastablePrimitive(@Nullable Object hintValue, @NotNull Class<?> clazz) { | ||
| Class<?> nonPrimitiveClass = primitiveMappings.get(clazz.getCanonicalName()); | ||
| return hintValue != null | ||
| && clazz.isPrimitive() | ||
| && nonPrimitiveClass != null | ||
| && nonPrimitiveClass.isInstance(hintValue); | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have to prevent manipulation of attachments if
!shouldApplyScopeData?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What you did makes sense to only get the attachments from the scope into the hints with this condition.
If we're not applying the scope to the event/hint, an attachment still could show up in the hint because the user added it directly while calling capture. And that's totally fine.