Skip to content

Fix prefetch for links with data-turbo-frame=_self #1500

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
4lllex wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix prefetch for links with data-turbo-frame=_self #1500

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
6 changes: 5 additions & 1 deletion src/observers/link_prefetch_observer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,11 @@ export class LinkPrefetchObserver {
request.headers["X-Sec-Purpose"] = "prefetch"

const turboFrame = link.closest("turbo-frame")
const turboFrameTarget = link.getAttribute("data-turbo-frame") || turboFrame?.getAttribute("target") || turboFrame?.id
let turboFrameTarget = link.getAttribute("data-turbo-frame") || turboFrame?.getAttribute("target") || turboFrame?.id

if (turboFrameTarget === "_self") {
turboFrameTarget = turboFrame?.id
}

if (turboFrameTarget && turboFrameTarget !== "_top") {
request.headers["Turbo-Frame"] = turboFrameTarget
Expand Down
5 changes: 5 additions & 0 deletions src/tests/fixtures/hover_to_prefetch.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,10 @@
<turbo-frame id="frame_for_prefetch_top" target="_top">
<a href="/src/tests/fixtures/prefetched.html" id="anchor_for_prefetch_in_frame_target_top">Hover to prefetch me</a>
</turbo-frame>

<a href="/src/tests/fixtures/prefetched.html" id="anchor_for_prefetch_out_of_frame_target_self" data-turbo-frame="_self">Hover to prefetch me</a>
<turbo-frame id="frame_for_prefetch_self">
<a href="/src/tests/fixtures/prefetched.html" id="anchor_for_prefetch_in_frame_target_self" data-turbo-frame="_self">Hover to prefetch me</a>
</turbo-frame>
</body>
</html>
18 changes: 18 additions & 0 deletions src/tests/functional/link_prefetch_observer_tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,24 @@ test("doesn't include a turbo-frame header when the link is inside a turbo frame
}})
})

test("includes turbo-frame header when the link with a data-turbo-frame=_self is inside a turbo frame", async ({ page}) => {
await goTo({ page, path: "/hover_to_prefetch.html" })

await assertPrefetchedOnHover({ page, selector: "#anchor_for_prefetch_in_frame_target_self", callback: (request) => {
const turboFrameHeader = request.headers()["turbo-frame"]
expect(turboFrameHeader).toEqual("frame_for_prefetch_self")
}})
})

test("doesn't include turbo-frame header when the link with a data-turbo-frame=_self is outside of a turbo frame", async ({ page}) => {
await goTo({ page, path: "/hover_to_prefetch.html" })

await assertPrefetchedOnHover({ page, selector: "#anchor_for_prefetch_out_of_frame_target_self", callback: (request) => {
const turboFrameHeader = request.headers()["turbo-frame"]
expect(turboFrameHeader).toEqual(undefined)
}})
})

test("it prefetches links with a delay", async ({ page }) => {
await goTo({ page, path: "/hover_to_prefetch.html" })

Expand Down