Hints are now used via a Hints object and passed into beforeSend and EventProcessor as @NotNull Hints object by adinauer · Pull Request #2045 · getsentry/sentry-java

adinauer · 2022-05-13T06:00:52Z

📜 Description

Replaces Map<String, Object> for hints with a Hints object. Also changed from @Nullable to @NotNull in beforeSend and EventProcessor.

💡 Motivation and Context

This makes it easier for developers to interact with hints without having to deal with certain cases (e.g. hints == null, hints not having an attachment entry, hints having a null attachment entry, ...)

See getsentry/sentry-javascript#5036

Here's another PR building on top of this to allow manipulation of attachments via beforeSend and eventProcessor: TODO

💚 How did you test it?

Unit Tests, see linked PR

📝 Checklist

I reviewed the submitted code
I added tests to verify the changes
I updated the docs if needed
No breaking changes

🔮 Next steps

Update docs

codecov-commenter · 2022-05-13T06:17:14Z

Codecov Report

❗ No coverage uploaded for pull request base (6.x.x@191ca19). Click here to learn what that means.
The diff coverage is n/a.

@@ Coverage Diff @@## 6.x.x #2045 +/- ##
========================================
Coverage ? 81.06% Complexity ? 3211 ========================================
Files ? 229 Lines ? 11804 Branches ? 1568 ========================================
Hits ? 9569 Misses ? 1650 Partials ? 585

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 191ca19...a7b0796. Read the comment docs.

philipphofmann

Thanks for doing this. I only gave it a high level API review.

* Store attachments in hints and allow manipulation in beforeSend and eventProcessor * Add changelog * Add tests for breadcrumbs and attachments via hints * Update CHANGELOG.md Co-authored-by: Philipp Hofmann <philipp.hofmann@sentry.io> * Rename AttachmentContainer to Attachments * Use long for test * Move attachments into Hints * Fix kotlin/java interop for Hints * Convert screenshot from map entry to property * Rename hint name param * Rename clear to clearAttachments * Use kotlin short version access for getScreenshot * Move AttachmentsTest into HintsTest; add param names * Make primitiveMapping table static * Use ArrayList as there should not be a synchronization issue for hints Co-authored-by: Philipp Hofmann <philipp.hofmann@sentry.io>

Replace hint Map with Hints object
ab2d082

adinauer requested review from marandaneto and romtsn as code owners May 13, 2022 06:00

Add changelog
48d1726

adinauer mentioned this pull request May 13, 2022
Attachments can be manipulated via hints #2046
Merged
4 tasks

adinauer changed the title ~~Replace hint Map with Hints object~~Hints are now used via a Hints object and passed into beforeSend and EventProcessor as @NotNull Hints objectMay 13, 2022

adinauer added 2 commits May 13, 2022 08:09

Fix typo in changelog
76696a1

Fix link in changelog
b0903ae

marandaneto mentioned this pull request May 13, 2022
(PR created) Allow attachments to be bound to exception more easily getsentry/sentry-dart#682
Closed

philipphofmann reviewed May 13, 2022
View reviewed changes

Comment threadsentry/src/main/java/io/sentry/hints/Hints.java Outdated
Comment threadsentry-samples/sentry-samples-console/src/main/java/io/sentry/samples/console/Main.java Outdated
Comment threadsentry/src/main/java/io/sentry/hints/Hints.java Outdated

romtsn approved these changes May 19, 2022
View reviewed changes

Comment threadsentry/src/main/java/io/sentry/util/LogUtils.java Outdated

adinauerand others added 3 commits May 20, 2022 07:32

Rename Hints to Hint
7c93603

Remove commented out code
df70121