Add refresh visit action

pfeiffer · Feb 15, 2024 · b4cf069 · b4cf069
1 parent 617e6d0
commit b4cf069
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 5 deletions.
diff --git a/src/core/drive/page_view.js b/src/core/drive/page_view.js
@@ -16,7 +16,7 @@ export class PageView extends View {
   }
 
   renderPage(snapshot, isPreview = false, willRender = true, visit) {
-    const shouldMorphPage = this.isPageRefresh(visit) && this.snapshot.shouldMorphPage
+    const shouldMorphPage = this.isMorphable(visit) && this.snapshot.shouldMorphPage
     const rendererClass = shouldMorphPage ? MorphRenderer : PageRenderer
 
     const renderer = new rendererClass(this.snapshot, snapshot, PageRenderer.renderElement, isPreview, willRender)
@@ -55,12 +55,20 @@ export class PageView extends View {
     return this.snapshotCache.get(location)
   }
 
-  isPageRefresh(visit) {
+  isReplacingSamePage(visit) {
     return !visit || (this.lastRenderedLocation.pathname === visit.location.pathname && visit.action === "replace")
   }
 
+  isPageRefresh(visit) {
+    return visit && visit.action === "refresh"
+  }
+
+  isMorphable(visit) {
+    return this.isPageRefresh(visit) || this.isReplacingSamePage(visit)
+  }
+
   shouldPreserveScrollPosition(visit) {
-    return this.isPageRefresh(visit) && this.snapshot.shouldPreserveScrollPosition
+    return this.isMorphable(visit) && this.snapshot.shouldPreserveScrollPosition
   }
 
   get snapshot() {

diff --git a/src/core/drive/visit.js b/src/core/drive/visit.js
@@ -39,7 +39,8 @@ export const SystemStatusCode = {
 export const Direction = {
   advance: "forward",
   restore: "back",
-  replace: "none"
+  replace: "none",
+  refresh: "none"
 }
 
 export class Visit {
@@ -388,6 +389,7 @@ export class Visit {
   getHistoryMethodForAction(action) {
     switch (action) {
       case "replace":
+      case "refresh":
         return history.replaceState
       case "advance":
       case "restore":

diff --git a/src/core/session.js b/src/core/session.js
@@ -107,9 +107,11 @@ export class Session {
 
   refresh(url, requestId) {
     const isRecentRequest = requestId && this.recentRequests.has(requestId)
+    const refreshUrl = url || document.baseURI
+
     if (!isRecentRequest) {
       this.cache.exemptPageFromPreview()
-      this.visit(url, { action: "replace" })
+      this.visit(refreshUrl, { action: "refresh" })
     }
   }
 

diff --git a/src/tests/functional/page_refresh_tests.js b/src/tests/functional/page_refresh_tests.js
@@ -203,3 +203,10 @@ async function assertPageScroll(page, top, left) {
   expect(scrollTop).toEqual(top)
   expect(scrollLeft).toEqual(left)
 }
+
+test("Turbo.session.refresh() will refresh current page", async ({ page }) => {
+  await page.goto("/src/tests/fixtures/page_refresh.html")
+  await page.evaluate(() => window.Turbo.session.refresh())
+
+  await nextEventNamed(page, "turbo:render", { renderMethod: "morph" })
+})
diff --git a/src/tests/functional/visit_tests.js b/src/tests/functional/visit_tests.js
@@ -256,6 +256,13 @@ test("Visit direction attribute on a replace visit", async ({ page }) => {
   await assertVisitDirectionAttribute(page, "none")
 })
 
+test("Visit direction when refreshing", async ({ page }) => {
+  page.evaluate(() => window.Turbo.session.refresh())
+
+  await assertVisitDirectionAttribute(page, "none")
+})
+
+
 test("Turbo history state after a reload", async ({ page }) => {
   await page.click("#same-origin-link")
   await nextEventNamed(page, "turbo:load")