Fix: Use weak reference in ReaderCardService #22644
Merged
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.
Fixes #22640
The
ReaderCardsStreamViewController
may be already deallocated once the service object completes fetching, causing it to access an invalidunowned
reference toself
.This fixes the issue by using a
weak
reference. With this, when the view controller deallocates early, we'll returnError.noInterests
instead of crashing. For more investigation notes, refer to the description in #22640.To test
Unfortunately, there's no sure way to reproduce the issue. However, based on the breadcrumbs available in Sentry, and the notes from the description in #22640, we can deduce a possible "path" to the crash:
Case 1: Trigger the Reader onboarding screen
Case 2: Spam-switch the Reader stream
Regression Notes
Potential unintended areas of impact
Should be none. Change is minimal.
What I did to test those areas of impact (or what existing automated tests I relied on)
Manually tested the changes.
What automated tests I added (or what prevented me from doing so)
N/A.
ReaderCardService
is retained inReaderCardsStreamViewController
, and this bug happens on a race condition where the view controller is deallocated (for example because of switching to a different stream) before the fetch completes. This makes it rather tricky to unit test. Refactoring it now is also not feasible as this is part of a legacy code.PR submission checklist:
RELEASE-NOTES.txt
if necessary.Testing checklist: