Add memory leak examples for Android documentation#920
Open
sudeshim3 wants to merge 5 commits into
Open
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive set of code snippets demonstrating common memory leak patterns in Android and Compose, such as retained UI callbacks, improper lifecycle management for Flow collection, and uncleared view bindings. Feedback includes a recommendation to use repeatOnLifecycle for Flow collection in the Activity example to ensure efficiency and consistency with best practices. Additionally, it was suggested to re-categorize the fragment view binding example under Pattern 1 for improved documentation accuracy.
* Add Pattern 1: UI Objects Retained Beyond Lifecycle examples * Add Pattern 2: Background Work Outlives the UI examples * Add Pattern 3: Unreleased External Registrations examples * Include Compose and Fragment-specific memory management best practices * Ensure snippets are idiomatic and comply with Spotless formatting These examples illustrate common architectural pitfalls and their corresponding lifecycle-aware resolutions using Coroutines, Flows, and DisposableEffect.
sudeshim3
force-pushed
the
feature/memory-leak-snippets
branch
from
671a754 to
8e3a6cc
Compare
AliceYuan
reviewed
May 15, 2026
* Refactor Repository examples to use actual ViewModel implementations instead of commented-out pseudo-code. * Split the recommended Repository callback snippet into pt1 and pt2. * Add explanatory comments to delay() calls clarifying their purpose to emulate network/processing.
AliceYuan
approved these changes
May 15, 2026
AliceYuan
left a comment
AliceYuan
left a comment
There was a problem hiding this comment.
There's still an open question about removing the last view binding example but approving
* Align snippet structure and names with original document's retention chains. * Rename ImageLoader examples to ImagePickerRecommended and ImageCacheRecommended for clarity. * Replace delay() in delayed work examples with api.getUser() for realism. * Add missing Pattern 3 comment in Compose snippets file. * Use repeatOnLifecycle in Activity flow collection.
sudeshim3
force-pushed
the
feature/memory-leak-snippets
branch
from
ffe85be to
535b120
Compare
yrezgui
approved these changes
May 18, 2026
kkuan2011
approved these changes
May 18, 2026
kkuan2011
approved these changes
May 18, 2026
| } | ||
| } | ||
|
|
||
| class MainActivityWithLeak : AppCompatActivity() { |
Contributor
There was a problem hiding this comment.
can you make this ComponentActivity to make the example more compose-friendly? and below as well
| @@ -0,0 +1,72 @@ | |||
| /* | |||
| * Copyright 2024 The Android Open Source Project | |||
Contributor
There was a problem hiding this comment.
nit: 2026 and same for next file too
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
These examples illustrate common architectural pitfalls and their corresponding lifecycle-aware resolutions using Coroutines, Flows, and DisposableEffect.