Skip to content

Fix missing null check when removing lifecycle observer#2625

Merged
markushi merged 9 commits into
mainfrom
fix/npe-sentry-close-lifecycle-watcher
Mar 29, 2023
Merged

Fix missing null check when removing lifecycle observer#2625
markushi merged 9 commits into
mainfrom
fix/npe-sentry-close-lifecycle-watcher

Conversation

@markushi

@markushi markushi commented Mar 27, 2023

Copy link
Copy Markdown
Member

📜 Description

If Sentry.close is called off the main thread, the lifecycle watcher field is set to null, while de-registering is posted on the main thread, leading to a NPE in combination with some versions of android x lifecycle lib.

💡 Motivation and Context

Fixes #2601

💚 How did you test it?

Manual testing, the overhead of running a single test against different version of the androidx lifecycle library didn't seem to justify the efforts.

📝 Checklist

  • I reviewed the submitted code.
  • I added tests to verify the changes.
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • I updated the docs if needed.
  • Review from the native team if needed.
  • No breaking change or entry added to the changelog.
  • No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

@github-actions

github-actions Bot commented Mar 27, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Performance metrics 🚀

  Plain With Sentry Diff
Startup time 300.58 ms 357.22 ms 56.64 ms
Size 1.73 MiB 2.34 MiB 627.44 KiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
d81684e 235.73 ms 328.76 ms 93.03 ms
17ab223 427.65 ms 484.31 ms 56.65 ms

App size

Revision Plain With Sentry Diff
d81684e 1.73 MiB 2.26 MiB 547.78 KiB
17ab223 1.73 MiB 2.34 MiB 626.85 KiB

Previous results on branch: fix/npe-sentry-close-lifecycle-watcher

Startup times

Revision Plain With Sentry Diff
c8d5fe8 377.53 ms 442.44 ms 64.91 ms
49c4a8c 350.21 ms 380.89 ms 30.68 ms
456e642 356.06 ms 368.73 ms 12.67 ms
f1307d7 362.40 ms 397.60 ms 35.20 ms
a7e3859 314.22 ms 378.35 ms 64.13 ms

App size

Revision Plain With Sentry Diff
c8d5fe8 1.73 MiB 2.26 MiB 548.12 KiB
49c4a8c 1.73 MiB 2.34 MiB 626.94 KiB
456e642 1.73 MiB 2.26 MiB 548.12 KiB
f1307d7 1.73 MiB 2.26 MiB 548.03 KiB
a7e3859 1.73 MiB 2.26 MiB 548.12 KiB

@codecov

codecov Bot commented Mar 27, 2023 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Patch and project coverage have no change.

Comparison is base (6641771) 81.37% compared to head (febab27) 81.37%.

Additional details and impacted files 
@@            Coverage Diff            @@
##               main    #2625   +/-   ##
=========================================
  Coverage     81.37%   81.37%           
  Complexity     4219     4219           
=========================================
  Files           337      337           
  Lines         15599    15599           
  Branches       2037     2037           
=========================================
  Hits          12693    12693           
  Misses         2111     2111           
  Partials        795      795

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

stefanosiano
stefanosiano reviewed Mar 28, 2023
View reviewed changes

@stefanosiano stefanosiano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also add a test to verify the change? like verifying the watcher is not null after the close function is called in a background thread and it's null only after the main thread executes?

Comment thread sentry-android-core/src/main/java/io/sentry/android/core/AppLifecycleIntegration.java
@markushi
markushi requested a review from stefanosiano March 28, 2023 11:11
stefanosiano
stefanosiano approved these changes Mar 28, 2023
View reviewed changes

@stefanosiano stefanosiano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a minor comment, if possible.
Looks good for everything else!

Comment thread sentry-android-core/src/test/java/io/sentry/android/core/AppLifecycleIntegrationTest.kt Outdated
}.start()

latch.await()
InstrumentationRegistry.getInstrumentation().waitForIdleSync()

@stefanosiano stefanosiano Mar 28, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the main looper it should be possible to use shadowOf(Looper.getMainLooper()).idle() instead of creating a thread manually. It would be easier for readability if it works

@markushi
markushi merged commit c7ba91f into main Mar 29, 2023
@markushi
markushi deleted the fix/npe-sentry-close-lifecycle-watcher branch March 29, 2023 07:50
@krystofwoldrich krystofwoldrich mentioned this pull request Apr 25, 2023
Closed
8 tasks
@paolosanchi paolosanchi mentioned this pull request May 30, 2023
Merged
@krystofwoldrich krystofwoldrich mentioned this pull request Jun 19, 2023
Closed
9 tasks
@wif70068 wif70068 mentioned this pull request Dec 19, 2023
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adinauer adinauer Awaiting requested review from adinauer adinauer is a code owner
@romtsn romtsn Awaiting requested review from romtsn romtsn is a code owner
1 more reviewer
@stefanosiano stefanosiano stefanosiano approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Crash when closing sentry

2 participants

@markushi @stefanosiano