Skip to content

Fix historyPoppedWithEmptyState on data-turbo=false pages (fixes #1496) #1519

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

Open
Danish-Belal wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix historyPoppedWithEmptyState on data-turbo=false pages (fixes #1496) #1519

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
10 changes: 10 additions & 0 deletions src/core/session.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,11 +217,21 @@ export class Session {
}

historyPoppedWithEmptyState(location) {
// Don't inject Turbo state on pages with data-turbo="false" — it would cause
// restore visits on subsequent back/forward, replacing the DOM despite Turbo being disabled
if (this.pageHasTurboDisabled()) return

this.history.replace(location)
this.view.lastRenderedLocation = location
this.view.cacheSnapshot()
}

pageHasTurboDisabled() {
const body = document.body?.getAttribute("data-turbo")
const html = document.documentElement?.getAttribute("data-turbo")
return body === "false" || html === "false"
}

// Scroll observer delegate

scrollPositionChanged(position) {
Expand Down
27 changes: 27 additions & 0 deletions src/tests/fixtures/data_turbo_false_hash_routing.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>data-turbo=false hash routing</title>
<script src="/dist/turbo.es2017-umd.js" data-turbo-track="reload"></script>
<script src="/src/tests/fixtures/test.js"></script>
</head>
<body data-turbo="false">
<h1>Hash routing with data-turbo="false"</h1>
<p>Current hash: <strong id="current-hash"></strong></p>
<nav>
<a href="#step1" id="link-step1">Step 1</a>
<a href="#step2" id="link-step2">Step 2</a>
<a href="#step3" id="link-step3">Step 3</a>
</nav>
<div id="content"></div>
<script>
function updateHash() {
const el = document.getElementById("current-hash")
if (el) el.textContent = location.hash || "(none)"
}
window.addEventListener("hashchange", updateHash)
updateHash()
</script>
</body>
</html>
19 changes: 19 additions & 0 deletions src/tests/functional/navigation_tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,25 @@ test("same-page anchor visits do not trigger visit events", async ({ page }) =>
}
})

test("history.back on data-turbo=false page with hash routing does not trigger restore visit", async ({ page }) => {
await page.goto("/src/tests/fixtures/data_turbo_false_hash_routing.html")
await readEventLogs(page)

await page.click("#link-step1")
await page.click("#link-step2")
await page.click("#link-step3")

await page.goBack()
await expect(page).toHaveURL(withPathname("/src/tests/fixtures/data_turbo_false_hash_routing.html"))
await expect(page).toHaveURL(withHash("#step2"))
expect(await noNextEventNamed(page, "turbo:visit")).toEqual(true)

await page.goBack()
await expect(page).toHaveURL(withPathname("/src/tests/fixtures/data_turbo_false_hash_routing.html"))
await expect(page).toHaveURL(withHash("#step1"))
expect(await noNextEventNamed(page, "turbo:visit")).toEqual(true)
})

test("correct referrer header", async ({ page }) => {
page.click("#headers-link")
await nextEventNamed(page, "turbo:load")
Expand Down