Unverified Commit 5920e9db authored by Sam Selikoff's avatar Sam Selikoff Committed by GitHub

Adds a Start button to the Instant Navs panel to initiate inspection … (#91216)

…of client navs. Allows the initial screen to be dismissed without
reloading the app.


https://github.com/user-attachments/assets/56b08c57-bd78-4d38-875d-244a450b7325
parent b1db0269
...@@ -36,9 +36,9 @@ export function InstantNavsPanel() { ...@@ -36,9 +36,9 @@ export function InstantNavsPanel() {
} }
}, [dispatch]) }, [dispatch])
// Navigation detection: watch state.page for changes while in waiting state // Navigation detection: watch state.page for changes while in client-nav-waiting state
useEffect(() => { useEffect(() => {
if (status !== 'waiting') return if (status !== 'client-nav-waiting') return
if (!state.page) return if (!state.page) return
// Capture the first non-empty page as baseline (state.page starts as '') // Capture the first non-empty page as baseline (state.page starts as '')
...@@ -58,11 +58,20 @@ export function InstantNavsPanel() { ...@@ -58,11 +58,20 @@ export function InstantNavsPanel() {
}, [state.page, status, dispatch]) }, [state.page, status, dispatch])
function handleReload() { function handleReload() {
// Cookie is already set to '1' from when the panel opened. document.cookie = 'next-instant-navigation-testing=1; path=/'
// Just reload — the server will see the cookie and render the static shell.
window.location.reload() window.location.reload()
} }
function handleStartClientNav() {
document.cookie = 'next-instant-navigation-testing=1; path=/'
fromUrlRef.current = window.location.pathname + window.location.search
initialPageRef.current = state.page
dispatch({
type: ACTION_INSTANT_NAVS_SET_STATUS,
status: 'client-nav-waiting',
})
}
function handleContinueRendering() { function handleContinueRendering() {
document.cookie = 'next-instant-navigation-testing=; path=/; max-age=0' document.cookie = 'next-instant-navigation-testing=; path=/; max-age=0'
window.location.reload() window.location.reload()
...@@ -85,7 +94,7 @@ export function InstantNavsPanel() { ...@@ -85,7 +94,7 @@ export function InstantNavsPanel() {
<div className="instant-nav-section-header"> <div className="instant-nav-section-header">
<label>Page load</label> <label>Page load</label>
<p className="instant-nav-section-description"> <p className="instant-nav-section-description">
Reload to view the initial static UI for this page. View the initial static UI for this page.
</p> </p>
</div> </div>
<div className="instant-nav-section-control"> <div className="instant-nav-section-control">
...@@ -94,18 +103,7 @@ export function InstantNavsPanel() { ...@@ -94,18 +103,7 @@ export function InstantNavsPanel() {
onClick={handleReload} onClick={handleReload}
data-instant-nav-refresh data-instant-nav-refresh
> >
<svg <RotateClockwise />
width="14"
height="14"
viewBox="0 0 16 16"
fill="none"
xmlns="http://www.w3.org/2000/svg"
>
<path
d="M2.5 8a5.5 5.5 0 0 1 9.68-3.578L11.092 5.5H14.5V2.092l-1.395 1.395A7 7 0 1 0 15 8h-1.5A5.5 5.5 0 0 1 2.5 8Z"
fill="currentColor"
/>
</svg>
<span>Reload</span> <span>Reload</span>
</button> </button>
</div> </div>
...@@ -114,10 +112,33 @@ export function InstantNavsPanel() { ...@@ -114,10 +112,33 @@ export function InstantNavsPanel() {
<div className="instant-nav-section-header"> <div className="instant-nav-section-header">
<label>Client navigation</label> <label>Client navigation</label>
<p className="instant-nav-section-description"> <p className="instant-nav-section-description">
Click any link in your app to view the prefetched UI for that Freeze the next navigation to view the prefetched UI.
page.
</p> </p>
</div> </div>
<div className="instant-nav-section-control">
<button
className="action-button"
onClick={handleStartClientNav}
data-instant-nav-client
>
<span>Start</span>
</button>
</div>
</div>
</div>
)
}
if (panel.status === 'client-nav-waiting') {
return (
<div className="instant-nav-panel">
<div className="instant-nav-content">
<div className="instant-nav-section-header">
<label>Client navigation</label>
</div>
<p className="instant-nav-helper-description">
Click any link in your app to view the prefetched UI for that page.
</p>
</div> </div>
</div> </div>
) )
...@@ -229,3 +250,22 @@ function ShareButton({ getShareUrl }: { getShareUrl: () => string }) { ...@@ -229,3 +250,22 @@ function ShareButton({ getShareUrl }: { getShareUrl: () => string }) {
</button> </button>
) )
} }
function RotateClockwise() {
return (
<svg
width="14"
height="14"
strokeLinejoin="round"
viewBox="0 0 16 16"
fill="none"
>
<path
fillRule="evenodd"
clipRule="evenodd"
d="M2.5 8C2.5 4.96643 4.97431 2.5 8.03548 2.5C10.5716 2.5 12.7064 4.19393 13.3628 6.5H10.75H10V8H10.75H15.25C15.6642 8 16 7.66421 16 7.25V2.75V2H14.5V2.75V5.23347C13.4215 2.74164 10.9316 1 8.03548 1C4.1539 1 1 4.13001 1 8C1 11.87 4.1539 15 8.03548 15C10.3763 15 12.4513 13.8617 13.7295 12.1122L14.172 11.5066L12.9609 10.6217L12.5184 11.2273C11.5117 12.6051 9.87945 13.5 8.03548 13.5C4.97431 13.5 2.5 11.0336 2.5 8Z"
fill="currentColor"
/>
</svg>
)
}
...@@ -16,7 +16,6 @@ import { useDevOverlayContext } from '../../dev-overlay.browser' ...@@ -16,7 +16,6 @@ import { useDevOverlayContext } from '../../dev-overlay.browser'
import { createContext, useContext } from 'react' import { createContext, useContext } from 'react'
import { useRenderErrorContext } from '../dev-overlay' import { useRenderErrorContext } from '../dev-overlay'
import { import {
ACTION_INSTANT_NAVS_TOGGLE,
ACTION_DEV_INDICATOR_SET, ACTION_DEV_INDICATOR_SET,
ACTION_DEVTOOLS_POSITION, ACTION_DEVTOOLS_POSITION,
ACTION_DEVTOOLS_SCALE, ACTION_DEVTOOLS_SCALE,
...@@ -112,12 +111,6 @@ const MenuPanel = () => { ...@@ -112,12 +111,6 @@ const MenuPanel = () => {
label: 'Instant Navs', label: 'Instant Navs',
value: <ChevronRight />, value: <ChevronRight />,
onClick: () => { onClick: () => {
// Set cookie to activate the navigation lock (read by
// navigation-testing-lock.ts via CookieStore change event)
document.cookie = 'next-instant-navigation-testing=1; path=/'
if (!state.instantNavs) {
dispatch({ type: ACTION_INSTANT_NAVS_TOGGLE })
}
setPanel('instant-navs') setPanel('instant-navs')
}, },
attributes: { attributes: {
......
...@@ -73,6 +73,7 @@ export interface OverlayState { ...@@ -73,6 +73,7 @@ export interface OverlayState {
readonly instantNavs: boolean readonly instantNavs: boolean
readonly instantNavsPanel: readonly instantNavsPanel:
| { readonly status: 'waiting' } | { readonly status: 'waiting' }
| { readonly status: 'client-nav-waiting' }
| { readonly status: 'initial-load'; readonly toUrl: string } | { readonly status: 'initial-load'; readonly toUrl: string }
| { | {
readonly status: 'client-nav' readonly status: 'client-nav'
...@@ -234,6 +235,10 @@ interface CacheOnlyToggleAction { ...@@ -234,6 +235,10 @@ interface CacheOnlyToggleAction {
type InstantNavSetStatusAction = type InstantNavSetStatusAction =
| { type: typeof ACTION_INSTANT_NAVS_SET_STATUS; status: 'waiting' } | { type: typeof ACTION_INSTANT_NAVS_SET_STATUS; status: 'waiting' }
| {
type: typeof ACTION_INSTANT_NAVS_SET_STATUS
status: 'client-nav-waiting'
}
| { | {
type: typeof ACTION_INSTANT_NAVS_SET_STATUS type: typeof ACTION_INSTANT_NAVS_SET_STATUS
status: 'initial-load' status: 'initial-load'
...@@ -571,6 +576,8 @@ export function useErrorOverlayReducer( ...@@ -571,6 +576,8 @@ export function useErrorOverlayReducer(
instantNavsPanel: instantNavsPanel:
action.status === 'waiting' action.status === 'waiting'
? { status: 'waiting' } ? { status: 'waiting' }
: action.status === 'client-nav-waiting'
? { status: 'client-nav-waiting' }
: action.status === 'initial-load' : action.status === 'initial-load'
? { status: 'initial-load', toUrl: action.toUrl } ? { status: 'initial-load', toUrl: action.toUrl }
: { : {
......
...@@ -27,6 +27,17 @@ describe('instant-nav-panel', () => { ...@@ -27,6 +27,17 @@ describe('instant-nav-panel', () => {
}) })
} }
async function clickStartClientNav(browser: any) {
await browser.eval(() => {
const portal = [].slice
.call(document.querySelectorAll('nextjs-portal'))
.find((p: any) =>
p.shadowRoot.querySelector('[data-nextjs-toast]')
) as any
portal?.shadowRoot?.querySelector('[data-instant-nav-client]')?.click()
})
}
async function getBadgeStatus(browser: any): Promise<string> { async function getBadgeStatus(browser: any): Promise<string> {
return browser.eval(() => { return browser.eval(() => {
const portal = [].slice const portal = [].slice
...@@ -82,7 +93,7 @@ describe('instant-nav-panel', () => { ...@@ -82,7 +93,7 @@ describe('instant-nav-panel', () => {
await clickInstantNavMenuItem(browser) await clickInstantNavMenuItem(browser)
} }
it('should open panel in waiting state and set cookie', async () => { it('should open panel in waiting state without setting cookie', async () => {
const browser = await next.browser('/') const browser = await next.browser('/')
await clearInstantModeCookie(browser) await clearInstantModeCookie(browser)
await browser.waitForElementByCss('[data-testid="home-title"]') await browser.waitForElementByCss('[data-testid="home-title"]')
...@@ -102,15 +113,15 @@ describe('instant-nav-panel', () => { ...@@ -102,15 +113,15 @@ describe('instant-nav-panel', () => {
expect(text).toContain('Client navigation') expect(text).toContain('Client navigation')
}) })
// Cookie should be set to activate navigation lock // Cookie should NOT be set yet (only set when user clicks Reload or Start)
const cookie = await browser.eval(() => document.cookie) const cookie = await browser.eval(() => document.cookie)
expect(cookie).toContain('next-instant-navigation-testing=1') expect(cookie).not.toContain('next-instant-navigation-testing=')
// Clean up // Clean up
await clearInstantModeCookie(browser) await clearInstantModeCookie(browser)
}) })
it('should show client nav state after SPA navigation', async () => { it('should show client nav state after clicking Start and navigating', async () => {
const browser = await next.browser('/') const browser = await next.browser('/')
await clearInstantModeCookie(browser) await clearInstantModeCookie(browser)
await browser.waitForElementByCss('[data-testid="home-title"]') await browser.waitForElementByCss('[data-testid="home-title"]')
...@@ -128,6 +139,22 @@ describe('instant-nav-panel', () => { ...@@ -128,6 +139,22 @@ describe('instant-nav-panel', () => {
expect(await hasPanelOpen(browser)).toBe(true) expect(await hasPanelOpen(browser)).toBe(true)
}) })
// Click Start to enter client-nav-waiting state
await clickStartClientNav(browser)
// Cookie should now be set
await retry(async () => {
const cookie = await browser.eval(() => document.cookie)
expect(cookie).toContain('next-instant-navigation-testing=1')
})
// Panel should show client-nav-waiting state
await retry(async () => {
const text = await getPanelText(browser)
expect(text).toContain('Client navigation')
expect(text).toContain('Click any link')
})
// Navigate to target page via SPA (use eval to bypass overlay pointer interception) // Navigate to target page via SPA (use eval to bypass overlay pointer interception)
await browser.eval(() => { await browser.eval(() => {
document.querySelector<HTMLAnchorElement>('#link-to-target')!.click() document.querySelector<HTMLAnchorElement>('#link-to-target')!.click()
...@@ -145,18 +172,21 @@ describe('instant-nav-panel', () => { ...@@ -145,18 +172,21 @@ describe('instant-nav-panel', () => {
await clearInstantModeCookie(browser) await clearInstantModeCookie(browser)
}) })
it('should show loading skeleton during SPA navigation when panel is open', async () => { it('should show loading skeleton during SPA navigation after clicking Start', async () => {
const browser = await next.browser('/') const browser = await next.browser('/')
await clearInstantModeCookie(browser) await clearInstantModeCookie(browser)
await browser.waitForElementByCss('[data-testid="home-title"]') await browser.waitForElementByCss('[data-testid="home-title"]')
await openInstantNavPanel(browser) await openInstantNavPanel(browser)
// Wait for panel to be open (instant mode is active) // Wait for panel to be open
await retry(async () => { await retry(async () => {
expect(await hasPanelOpen(browser)).toBe(true) expect(await hasPanelOpen(browser)).toBe(true)
}) })
// Click Start to activate the navigation lock
await clickStartClientNav(browser)
// Navigate to target page via SPA (use eval to bypass overlay pointer interception) // Navigate to target page via SPA (use eval to bypass overlay pointer interception)
await browser.eval(() => { await browser.eval(() => {
document.querySelector<HTMLAnchorElement>('#link-to-target')!.click() document.querySelector<HTMLAnchorElement>('#link-to-target')!.click()
...@@ -174,26 +204,24 @@ describe('instant-nav-panel', () => { ...@@ -174,26 +204,24 @@ describe('instant-nav-panel', () => {
await clearInstantModeCookie(browser) await clearInstantModeCookie(browser)
}) })
it('should clear cookie when closing panel via X button', async () => { it('should not set cookie when closing panel from waiting state', async () => {
const browser = await next.browser('/') const browser = await next.browser('/')
await clearInstantModeCookie(browser) await clearInstantModeCookie(browser)
await browser.waitForElementByCss('[data-testid="home-title"]') await browser.waitForElementByCss('[data-testid="home-title"]')
await openInstantNavPanel(browser) await openInstantNavPanel(browser)
// Verify cookie is set // Verify cookie is NOT set (panel opened without activating lock)
await retry(async () => {
const cookie = await browser.eval(() => document.cookie) const cookie = await browser.eval(() => document.cookie)
expect(cookie).toContain('next-instant-navigation-testing=') expect(cookie).not.toContain('next-instant-navigation-testing=')
})
// Close panel via X button // Close panel via X button
await closePanelViaHeader(browser) await closePanelViaHeader(browser)
// Cookie should be cleared // Cookie should still not be set, and no reload should happen
await retry(async () => { await retry(async () => {
const cookie = await browser.eval(() => document.cookie) const cookieAfter = await browser.eval(() => document.cookie)
expect(cookie).not.toContain('next-instant-navigation-testing=') expect(cookieAfter).not.toContain('next-instant-navigation-testing=')
}) })
}) })
}) })
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment