Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RUMM-3475: Fix memory leak in JankStats usage #1553

Merged
merged 1 commit into from
Jul 24, 2023
Merged

RUMM-3475: Fix memory leak in JankStats usage #1553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions detekt_custom.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -750,6 +750,7 @@ datadog:
- "kotlin.collections.MutableList.forEachIndexed(kotlin.Function2)"
- "kotlin.collections.MutableList.isEmpty()"
- "kotlin.collections.MutableList.isNotEmpty()"
- "kotlin.collections.MutableList.isNullOrEmpty()"
- "kotlin.collections.MutableList.iterator()"
- "kotlin.collections.MutableList.joinToString(kotlin.CharSequence, kotlin.CharSequence, kotlin.CharSequence, kotlin.Int, kotlin.CharSequence, kotlin.Function1?)"
- "kotlin.collections.MutableList.remove(java.io.File)"
Expand Down
8 changes: 6 additions & 2 deletions ...main/kotlin/com/datadog/android/rum/internal/vitals/JankStatsActivityLifecycleListener.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ internal class JankStatsActivityLifecycleListener(
private val jankStatsProvider: JankStatsProvider = JankStatsProvider.DEFAULT
) : ActivityLifecycleCallbacks, JankStats.OnFrameListener {

private val activeWindowsListener = WeakHashMap<Window, JankStats>()
private val activeActivities = WeakHashMap<Window, MutableList<WeakReference<Activity>>>()
internal val activeWindowsListener = WeakHashMap<Window, JankStats>()
internal val activeActivities = WeakHashMap<Window, MutableList<WeakReference<Activity>>>()

// region ActivityLifecycleCallbacks
@MainThread
Expand Down Expand Up @@ -106,6 +106,10 @@ internal class JankStatsActivityLifecycleListener(

@MainThread
override fun onActivityDestroyed(activity: Activity) {
if (activeActivities[activity.window].isNullOrEmpty()) {
activeWindowsListener.remove(activity.window)
activeActivities.remove(activity.window)
}
}

// endregion
Expand Down
36 changes: 35 additions & 1 deletion .../kotlin/com/datadog/android/rum/internal/vitals/JankStatsActivityLifecycleListenerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import fr.xgouchet.elmyr.annotation.BoolForgery
import fr.xgouchet.elmyr.annotation.LongForgery
import fr.xgouchet.elmyr.junit5.ForgeConfiguration
import fr.xgouchet.elmyr.junit5.ForgeExtension
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
Expand Down Expand Up @@ -142,7 +143,40 @@ internal class JankStatsActivityLifecycleListenerTest {
}

@Test
fun `𝕄 foNothing 𝕎 onActivityStopped() {}`() {
fun `𝕄 remove window 𝕎 onActivityDestroyed() { no more activities for window }`() {
// Given

// When
testedJankListener.onActivityStarted(mockActivity)
testedJankListener.onActivityStopped(mockActivity)
testedJankListener.onActivityDestroyed(mockActivity)

// Then
assertThat(testedJankListener.activeActivities).isEmpty()
assertThat(testedJankListener.activeWindowsListener).isEmpty()
}

@Test
fun `𝕄 not remove window 𝕎 onActivityDestroyed() { there are activities for window }`() {
// Given
val anotherActivity = mock<Activity>().apply {
whenever(window) doReturn mockWindow
whenever(display) doReturn mockDisplay
}

// When
testedJankListener.onActivityStarted(mockActivity)
testedJankListener.onActivityStopped(mockActivity)
testedJankListener.onActivityStarted(anotherActivity)
testedJankListener.onActivityDestroyed(mockActivity)

// Then
assertThat(testedJankListener.activeActivities).isNotEmpty
assertThat(testedJankListener.activeWindowsListener).isNotEmpty
}

@Test
fun `𝕄 do nothing 𝕎 onActivityStopped() {}`() {
// Given

// When
Expand Down