Skip to content

Commit

Permalink
Test that we don't leak CodeListeners
Browse files Browse the repository at this point in the history
  • Loading branch information
squarejesse committed May 29, 2024
1 parent a39d079 commit 5065e25
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ class LeaksTest {
val view = tester.view()

content.bind(view)
content.awaitContent(untilChangeCount = 1)
content.awaitContent()

val eventListenerLeakWatcher = LeakWatcher {
(tester.eventListenerFactory as RetainEverythingEventListenerFactory)
Expand Down Expand Up @@ -156,6 +156,36 @@ class LeaksTest {
treehouseApp.stop()
}

@Test
fun codeListenerNotLeaked() = runTest {
val tester = TreehouseTester(this)
val treehouseApp = tester.loadApp()
val view = tester.view()

var codeListener: CodeListener? = RetainEverythingCodeListener(tester.eventLog)
val content = treehouseApp.createContent(
source = { app -> app.launchForTester() },
codeListener = codeListener!!,
)
val codeListenerLeakWatcher = LeakWatcher { codeListener }

// Stop referencing the CodeListener from our test harness.
codeListener = null

// One a view is bound, the code listener is in a reference cycle.
content.bind(view)
tester.eventLog.takeEvent("onCodeLoaded", skipOthers = true)
codeListenerLeakWatcher.assertObjectInReferenceCycle()

// When the view is unbound, the code listener is no longer reachable.
content.unbind()
tester.eventLog.takeEvent("onCodeDetached", skipOthers = true)
treehouseApp.dispatchers.awaitLaunchedTasks()
codeListenerLeakWatcher.assertNotLeaked()

treehouseApp.stop()
}

/**
* This is unfortunate. Some cleanup functions launch jobs on another dispatcher and we don't have
* a natural way to wait for those jobs to complete. So we launch empty jobs on each dispatcher,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/*
* Copyright (C) 2024 Square, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package app.cash.redwood.treehouse

class RetainEverythingCodeListener(
private val eventLog: EventLog,
) : CodeListener() {
private var app: TreehouseApp<*>? = null
private var view: TreehouseView<*>? = null

override fun onInitialCodeLoading(app: TreehouseApp<*>, view: TreehouseView<*>) {
this.app = app
this.view = view
}

override fun onCodeLoaded(app: TreehouseApp<*>, view: TreehouseView<*>, initial: Boolean) {
this.app = app
this.view = view
eventLog += "onCodeLoaded"
}

override fun onCodeDetached(app: TreehouseApp<*>, view: TreehouseView<*>, exception: Throwable?) {
this.app = app
this.view = view
eventLog += "onCodeDetached"
}
}

0 comments on commit 5065e25

Please sign in to comment.