Skip to content

Maintain replace visit actions in the restore logic #176

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

Merged
jayohms merged 2 commits into from
Nov 6, 2025
Merged

Maintain replace visit actions in the restore logic #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb50a1d
Fix restorationIdentifier + "restore" logic so that "replace" visit a…
jayohms Nov 5, 2025
0fd1120
Add Session tests to cover visits with restorationIdentifier logic
jayohms Nov 6, 2025
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
20 changes: 11 additions & 9 deletions core/src/main/kotlin/dev/hotwire/core/turbo/session/Session.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -623,25 +623,27 @@ class Session(
// Private

private fun visitLocation(visit: Visit) {
val restorationIdentifier = when (visit.options.action) {
VisitAction.RESTORE -> restorationIdentifiers[visit.destinationIdentifier] ?: ""
VisitAction.ADVANCE -> ""
else -> ""
val restorationIdentifier = if (visit.options.action == VisitAction.RESTORE) {
restorationIdentifiers[visit.destinationIdentifier]
} else {
null
}

val options = when (restorationIdentifier) {
"" -> visit.options.copy(action = VisitAction.ADVANCE)
else -> visit.options
// Only initiate a restore visit if a restorationIdentifier is available
val options = if (visit.options.action == VisitAction.RESTORE && restorationIdentifier == null) {
visit.options.copy(action = VisitAction.ADVANCE)
} else {
visit.options
}

logEvent(
"visitLocation",
"location" to visit.location,
"options" to options,
"restorationIdentifier" to restorationIdentifier
"restorationIdentifier" to (restorationIdentifier ?: "")
)

webView.visitLocation(visit.location, options, restorationIdentifier)
webView.visitLocation(visit.location, options, restorationIdentifier ?: "")
}

private fun visitLocationAsColdBoot(visit: Visit) {
Expand Down
79 changes: 79 additions & 0 deletions core/src/test/kotlin/dev/hotwire/core/turbo/session/SessionTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import dev.hotwire.core.turbo.errors.LoadError
import dev.hotwire.core.turbo.errors.WebError
import dev.hotwire.core.turbo.util.toJson
import dev.hotwire.core.turbo.visit.Visit
import dev.hotwire.core.turbo.visit.VisitAction
import dev.hotwire.core.turbo.visit.VisitDestination
import dev.hotwire.core.turbo.visit.VisitOptions
import dev.hotwire.core.turbo.webview.HotwireWebView
Expand Down Expand Up @@ -290,6 +291,84 @@ class SessionTest : BaseRepositoryTest() {
verify(callback, times(1)).visitCompleted(false)
}

@Test
fun `restore visit with restoration identifier uses restore visit`() {
val visitIdentifier = "12345"
val restorationIdentifier = "67890"
val restoreVisit = visit.copy(
options = VisitOptions(action = VisitAction.RESTORE)
)

session.currentVisit = visit.copy(identifier = visitIdentifier)
session.turboIsReady(true)
session.pageLoaded(restorationIdentifier)
session.visit(restoreVisit)

verify(webView, times(1)).visitLocation(
location = restoreVisit.location,
options = restoreVisit.options,
restorationIdentifier = "67890"
)
}

@Test
fun `restore visit with no restoration identifier uses advance visit`() {
val visitIdentifier = "12345"
val restoreVisit = visit.copy(
options = VisitOptions(action = VisitAction.RESTORE)
)

session.currentVisit = visit.copy(identifier = visitIdentifier)
session.turboIsReady(true)
session.visit(restoreVisit)

verify(webView, times(1)).visitLocation(
location = restoreVisit.location,
options = restoreVisit.options.copy(action = VisitAction.ADVANCE),
restorationIdentifier = ""
)
}

@Test
fun `advance visit does not use restoration identifier`() {
val visitIdentifier = "12345"
val restorationIdentifier = "67890"
val advanceVisit = visit.copy(
options = VisitOptions(action = VisitAction.ADVANCE)
)

session.currentVisit = visit.copy(identifier = visitIdentifier)
session.turboIsReady(true)
session.pageLoaded(restorationIdentifier)
session.visit(advanceVisit)

verify(webView, times(1)).visitLocation(
location = advanceVisit.location,
options = advanceVisit.options,
restorationIdentifier = ""
)
}

@Test
fun `replace visit does not use restoration identifier`() {
val visitIdentifier = "12345"
val restorationIdentifier = "67890"
val replaceVisit = visit.copy(
options = VisitOptions(action = VisitAction.REPLACE)
)

session.currentVisit = visit.copy(identifier = visitIdentifier)
session.turboIsReady(true)
session.pageLoaded(restorationIdentifier)
session.visit(replaceVisit)

verify(webView, times(1)).visitLocation(
location = replaceVisit.location,
options = replaceVisit.options,
restorationIdentifier = ""
)
}

@Test
fun `restore current visit fails with session not ready`() {
val visitIdentifier = "12345"
Expand Down