Merge pull request #1250 from klevo/issue-622

Fix stale refresh URL caused by debouncing

src/core/session.js

@@ -107,7 +107,8 @@ export class Session {
 
   refresh(url, requestId) {
     const isRecentRequest = requestId && this.recentRequests.has(requestId)
-    if (!isRecentRequest && !this.navigator.currentVisit) {
+    const isCurrentUrl = url === document.baseURI
+    if (!isRecentRequest && !this.navigator.currentVisit && isCurrentUrl) {
       this.visit(url, { action: "replace", shouldCacheSnapshot: false })
     }
   }

src/tests/fixtures/page_refresh_stream_action.html

@@ -14,6 +14,7 @@
 
   <div id="content">
     <span>Hello</span>
+    <a id="regular-link" href="/src/tests/fixtures/one.html">Regular link</a>
   </div>
 </body>
 </html>

src/tests/functional/page_refresh_stream_action_tests.js

@@ -1,6 +1,6 @@
 import { test } from "@playwright/test"
 import { assert } from "chai"
-import { nextPageRefresh, readEventLogs } from "../helpers/page"
+import { nextPageRefresh, readEventLogs, pathname } from "../helpers/page"
 
 test.beforeEach(async ({ page }) => {
   await page.goto("/src/tests/fixtures/page_refresh_stream_action.html")
@@ -54,6 +54,20 @@ test("debounce stream page refreshes", async ({ page }) => {
   assert.equal(requestLogs.length, 2)
 })
 
+test("debounced refresh of stale URL does not hijack new location navigated to", async ({ page }) => {
+  await setLongerPageRefreshDebouncePeriod(page)
+  const urlBeforeVisit = page.url()
+
+  await page.click("#refresh button")
+  await page.click("#regular-link")
+  await nextPageRefresh(page)
+
+  const urlAfterVisit = page.url()
+  assert.notEqual(urlBeforeVisit, urlAfterVisit)
+  const expectedPath = "/src/tests/fixtures/one.html"
+  assert.equal(pathname(urlAfterVisit), expectedPath)
+})
+
 async function textContent(page) {
   const messages = await page.locator("#content")
   return await messages.textContent()
@@ -65,3 +79,7 @@ async function fetchRequestId(page) {
     return response.text()
   })
 }
+
+async function setLongerPageRefreshDebouncePeriod(page, period = 500) {
+  return page.evaluate((period) => window.Turbo.session.pageRefreshDebouncePeriod = period, period)
+}