Skip to content
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.

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

Disabling Drive keeps Frames default behaviour #648

Merged
merged 1 commit into from
Jul 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions src/core/frames/frame_controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -431,11 +431,11 @@ export class FrameController
}
}

if (!session.elementDriveEnabled(element)) {
if (!session.elementIsNavigatable(element)) {
return false
}

if (submitter && !session.elementDriveEnabled(submitter)) {
if (submitter && !session.elementIsNavigatable(submitter)) {
return false
}

Expand Down
21 changes: 11 additions & 10 deletions src/core/session.ts
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ export class Session

willFollowLinkToLocation(link: Element, location: URL, event: MouseEvent) {
return (
this.elementDriveEnabled(link) &&
this.elementIsNavigatable(link) &&
locationIsVisitable(location, this.snapshot.rootLocation) &&
this.applicationAllowsFollowingLinkToLocation(link, location, event)
)
Expand Down Expand Up @@ -222,8 +222,8 @@ export class Session
const action = getAction(form, submitter)

return (
this.elementDriveEnabled(form) &&
(!submitter || this.formElementDriveEnabled(submitter)) &&
this.elementIsNavigatable(form) &&
(!submitter || this.formElementIsNavigatable(submitter)) &&
locationIsVisitable(expandURL(action), this.snapshot.rootLocation)
)
}
Expand Down Expand Up @@ -375,30 +375,31 @@ export class Session

// Helpers

formElementDriveEnabled(element?: Element) {
formElementIsNavigatable(element?: Element) {
if (this.formMode == "off") {
return false
}
if (this.formMode == "optin") {
const form = element?.closest("form[data-turbo]")
return form?.getAttribute("data-turbo") == "true"
}
return this.elementDriveEnabled(element)
return this.elementIsNavigatable(element)
}

elementDriveEnabled(element?: Element) {
elementIsNavigatable(element?: Element) {
const container = element?.closest("[data-turbo]")
const withinFrame = element?.closest("turbo-frame")

// Check if Drive is enabled on the session.
if (this.drive) {
// Drive should be enabled by default, unless `data-turbo="false"`.
// Check if Drive is enabled on the session or we're within a Frame.
if (this.drive || withinFrame) {
// Element is navigatable by default, unless `data-turbo="false"`.
if (container) {
return container.getAttribute("data-turbo") != "false"
} else {
return true
}
} else {
// Drive should be disabled by default, unless `data-turbo="true"`.
// Element isn't navigatable by default, unless `data-turbo="true"`.
if (container) {
return container.getAttribute("data-turbo") == "true"
} else {
Expand Down
9 changes: 9 additions & 0 deletions src/tests/fixtures/drive_disabled.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,14 @@ <h1>Drive (Disabled by Default)</h1>
<input type="hidden" name="greeting" value="Hello from a redirect">
<a href="#" id="requestSubmit">Drive enabled submit via JS</a>
</form>

<turbo-frame id="frame">
<h2>Hello from a frame</h2>

<a href="/src/tests/fixtures/drive_disabled.html">Navigate #frame</a>
<form action="/src/tests/fixtures/drive_disabled.html">
<button>Navigate #frame</button>
</form>
</turbo-frame>
</body>
</html>
11 changes: 11 additions & 0 deletions src/tests/functional/drive_disabled_tests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { assert } from "chai"
import {
getFromLocalStorage,
nextBody,
nextEventOnTarget,
pathname,
searchParams,
setLocalStorageFromEvent,
Expand Down Expand Up @@ -42,3 +43,13 @@ test("test drive disabled by default; submit form inside data-turbo='true'", asy
assert.equal(await visitAction(page), "advance")
assert.equal(await searchParams(page.url()).get("greeting"), "Hello from a redirect")
})

test("test drive disabled by default; links within <turbo-frame> navigate with Turbo", async ({ page }) => {
await page.click("#frame a")
await nextEventOnTarget(page, "frame", "turbo:frame-render")
})

test("test drive disabled by default; forms within <turbo-frame> navigate with Turbo", async ({ page }) => {
await page.click("#frame button")
await nextEventOnTarget(page, "frame", "turbo:frame-render")
})