Unverified Commit 24345c9d authored by Joe Haddad's avatar Joe Haddad Committed by GitHub

Correctly Dedupe Prefetching (#10758)

* Correctly Dedupe Prefetching

* add test
parent b7f77905
...@@ -57,7 +57,7 @@ let observer: IntersectionObserver ...@@ -57,7 +57,7 @@ let observer: IntersectionObserver
const listeners = new Map() const listeners = new Map()
const IntersectionObserver = const IntersectionObserver =
typeof window !== 'undefined' ? (window as any).IntersectionObserver : null typeof window !== 'undefined' ? (window as any).IntersectionObserver : null
const prefetched: { [href: string]: boolean } = {} const prefetched: { [cacheKey: string]: boolean } = {}
function getObserver() { function getObserver() {
// Return shared instance of IntersectionObserver if already created // Return shared instance of IntersectionObserver if already created
...@@ -139,10 +139,16 @@ class Link extends Component<LinkProps> { ...@@ -139,10 +139,16 @@ class Link extends Component<LinkProps> {
} }
handleRef(ref: Element) { handleRef(ref: Element) {
const isPrefetched = prefetched[this.getPaths()[0]]
if (this.p && IntersectionObserver && ref && ref.tagName) { if (this.p && IntersectionObserver && ref && ref.tagName) {
this.cleanUpListeners() this.cleanUpListeners()
const isPrefetched =
prefetched[
this.getPaths().join(
// Join on an invalid URI character
'%'
)
]
if (!isPrefetched) { if (!isPrefetched) {
this.cleanUpListeners = listenToIntersections(ref, () => { this.cleanUpListeners = listenToIntersections(ref, () => {
this.prefetch() this.prefetch()
...@@ -208,17 +214,24 @@ class Link extends Component<LinkProps> { ...@@ -208,17 +214,24 @@ class Link extends Component<LinkProps> {
prefetch(options?: PrefetchOptions) { prefetch(options?: PrefetchOptions) {
if (!this.p || typeof window === 'undefined') return if (!this.p || typeof window === 'undefined') return
// Prefetch the JSON page if asked (only in the client) // Prefetch the JSON page if asked (only in the client)
const [href, asPath] = this.getPaths() const paths = this.getPaths()
// We need to handle a prefetch error here since we may be // We need to handle a prefetch error here since we may be
// loading with priority which can reject but we don't // loading with priority which can reject but we don't
// want to force navigation since this is only a prefetch // want to force navigation since this is only a prefetch
Router.prefetch(href, asPath, options).catch(err => { Router.prefetch(paths[/* href */ 0], paths[/* asPath */ 1], options).catch(
if (process.env.NODE_ENV !== 'production') { err => {
// rethrow to show invalid URL errors if (process.env.NODE_ENV !== 'production') {
throw err // rethrow to show invalid URL errors
throw err
}
} }
}) )
prefetched[href] = true prefetched[
paths.join(
// Join on an invalid URI character
'%'
)
] = true
} }
render() { render() {
......
import Link from 'next/link'
export default () => {
return (
<p>
<Link href="/first" as="/first#different">
<a>to /first</a>
</Link>
</p>
)
}
...@@ -228,4 +228,20 @@ describe('Prefetching Links in viewport', () => { ...@@ -228,4 +228,20 @@ describe('Prefetching Links in viewport', () => {
const calledPrefetch = await browser.eval(`window.calledPrefetch`) const calledPrefetch = await browser.eval(`window.calledPrefetch`)
expect(calledPrefetch).toBe(false) expect(calledPrefetch).toBe(false)
}) })
it('should prefetch with a different asPath for a prefetched page', async () => {
// info: both `/` and `/not-de-duped` ref the `/first` page, which we want
// to see prefetched twice.
const browser = await webdriver(appPort, '/')
await browser.eval(`(function() {
window.calledPrefetch = false
window.next.router.prefetch = function() {
window.calledPrefetch = true
}
window.next.router.push('/not-de-duped')
})()`)
await waitFor(2 * 1000)
const calledPrefetch = await browser.eval(`window.calledPrefetch`)
expect(calledPrefetch).toBe(true)
})
}) })
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