Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
N
next.js
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Alex
next.js
Commits
7dd61b47
Unverified
Commit
7dd61b47
authored
Jul 20, 2020
by
Jan Potoms
Committed by
GitHub
Jul 20, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix basepath router events (#14848)
Co-authored-by:
Joe Haddad
<
joe.haddad@zeit.co
>
parent
5a00d622
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
9 changed files
with
315 additions
and
114 deletions
+315
-114
router.md
docs/api-reference/next/router.md
+2
-0
router.ts
packages/next/next-server/lib/router/router.ts
+118
-111
_app.js
test/integration/basepath/pages/_app.js
+52
-0
error-route.js
test/integration/basepath/pages/error-route.js
+8
-0
hello.js
test/integration/basepath/pages/hello.js
+17
-0
index.js
test/integration/basepath/pages/index.js
+2
-1
slow-route.js
test/integration/basepath/pages/slow-route.js
+10
-0
index.test.js
test/integration/basepath/test/index.test.js
+101
-0
index.test.js
test/integration/dynamic-routing/test/index.test.js
+5
-2
No files found.
docs/api-reference/next/router.md
View file @
7dd61b47
...
...
@@ -318,6 +318,8 @@ You can listen to different events happening inside the Next.js Router. Here's a
-
`hashChangeComplete(url)`
- Fires when the hash has changed but not the page
> Here `url` is the URL shown in the browser. If you call `router.push(url, as)` (or similar), then the value of `url` will be `as`.
>
> **Note:** If you [configure a `basePath`](/docs/api-reference/next.config.js/basepath.md) then the value of `url` will be `basePath + as`.
#### Usage
...
...
packages/next/next-server/lib/router/router.ts
View file @
7dd61b47
This diff is collapsed.
Click to expand it.
test/integration/basepath/pages/_app.js
0 → 100644
View file @
7dd61b47
import
{
useEffect
}
from
'react'
import
{
useRouter
}
from
'next/router'
// We use session storage for the event log so that it will survive
// page reloads, which happen for instance during routeChangeError
const
EVENT_LOG_KEY
=
'router-event-log'
function
getEventLog
()
{
const
data
=
sessionStorage
.
getItem
(
EVENT_LOG_KEY
)
return
data
?
JSON
.
parse
(
data
)
:
[]
}
function
clearEventLog
()
{
sessionStorage
.
removeItem
(
EVENT_LOG_KEY
)
}
function
addEvent
(
data
)
{
const
eventLog
=
getEventLog
()
eventLog
.
push
(
data
)
sessionStorage
.
setItem
(
EVENT_LOG_KEY
,
JSON
.
stringify
(
eventLog
))
}
if
(
typeof
window
!==
'undefined'
)
{
// global functions introduced to interface with the test infrastructure
window
.
_clearEventLog
=
clearEventLog
window
.
_getEventLog
=
getEventLog
}
function
useLoggedEvent
(
event
,
serializeArgs
=
(...
args
)
=>
args
)
{
const
router
=
useRouter
()
useEffect
(()
=>
{
const
logEvent
=
(...
args
)
=>
{
addEvent
([
event
,
...
serializeArgs
(...
args
)])
}
router
.
events
.
on
(
event
,
logEvent
)
return
()
=>
router
.
events
.
off
(
event
,
logEvent
)
},
[
event
,
router
.
events
,
serializeArgs
])
}
function
serializeErrorEventArgs
(
err
,
url
)
{
return
[
err
.
message
,
err
.
cancelled
,
url
]
}
export
default
function
MyApp
({
Component
,
pageProps
})
{
useLoggedEvent
(
'routeChangeStart'
)
useLoggedEvent
(
'routeChangeComplete'
)
useLoggedEvent
(
'routeChangeError'
,
serializeErrorEventArgs
)
useLoggedEvent
(
'beforeHistoryChange'
)
useLoggedEvent
(
'hashChangeStart'
)
useLoggedEvent
(
'hashChangeComplete'
)
return
<
Component
{...
pageProps
}
/
>
}
test/integration/basepath/pages/error-route.js
0 → 100644
View file @
7dd61b47
export
async
function
getServerSideProps
()
{
// We will use this route to simulate a route change errors
throw
new
Error
(
'KABOOM!'
)
}
export
default
function
Page
()
{
return
null
}
test/integration/basepath/pages/hello.js
View file @
7dd61b47
...
...
@@ -58,6 +58,23 @@ export default () => (
>
click
me
for
error
<
/div
>
<
br
/>
<
div
id
=
"as-path"
>
{
useRouter
().
asPath
}
<
/div
>
<
Link
href
=
"/slow-route"
>
<
a
id
=
"slow-route"
>
<
h1
>
Slow
route
<
/h1
>
<
/a
>
<
/Link
>
<
Link
href
=
"/error-route"
>
<
a
id
=
"error-route"
>
<
h1
>
Error
route
<
/h1
>
<
/a
>
<
/Link
>
<
Link
href
=
"/hello#some-hash"
>
<
a
id
=
"hash-change"
>
<
h1
>
Hash
change
<
/h1
>
<
/a
>
<
/Link
>
<
Link
href
=
"/something-else"
as
=
"/hello"
>
<
a
id
=
"something-else-link"
>
to
something
else
<
/a
>
<
/Link
>
...
...
test/integration/basepath/pages/index.js
View file @
7dd61b47
...
...
@@ -11,7 +11,7 @@ export const getStaticProps = () => {
}
export
default
function
Index
({
hello
,
nested
})
{
const
{
query
,
pathname
}
=
useRouter
()
const
{
query
,
pathname
,
asPath
}
=
useRouter
()
return
(
<>
<
h1
id
=
"index-page"
>
index
page
<
/h1
>
...
...
@@ -19,6 +19,7 @@ export default function Index({ hello, nested }) {
<
p
id
=
"prop"
>
{
hello
}
world
<
/p
>
<
p
id
=
"query"
>
{
JSON
.
stringify
(
query
)}
<
/p
>
<
p
id
=
"pathname"
>
{
pathname
}
<
/p
>
<
p
id
=
"as-path"
>
{
asPath
}
<
/p
>
<
Link
href
=
"/hello"
>
<
a
id
=
"hello-link"
>
to
/
hello
<
/a
>
<
/Link
>
...
...
test/integration/basepath/pages/slow-route.js
0 → 100644
View file @
7dd61b47
export
async
function
getServerSideProps
()
{
// We will use this route to simulate a route cancellation error
// by clicking its link twice in rapid succession
await
new
Promise
((
resolve
)
=>
setTimeout
(
resolve
,
5000
))
return
{
props
:
{}
}
}
export
default
function
Page
()
{
return
null
}
test/integration/basepath/test/index.test.js
View file @
7dd61b47
...
...
@@ -406,6 +406,24 @@ const runTests = (context, dev = false) => {
}
})
it
(
'should have correct router paths on first load of /'
,
async
()
=>
{
const
browser
=
await
webdriver
(
context
.
appPort
,
'/docs'
)
await
browser
.
waitForElementByCss
(
'#pathname'
)
const
pathname
=
await
browser
.
elementByCss
(
'#pathname'
).
text
()
expect
(
pathname
).
toBe
(
'/'
)
const
asPath
=
await
browser
.
elementByCss
(
'#as-path'
).
text
()
expect
(
asPath
).
toBe
(
'/'
)
})
it
(
'should have correct router paths on first load of /hello'
,
async
()
=>
{
const
browser
=
await
webdriver
(
context
.
appPort
,
'/docs/hello'
)
await
browser
.
waitForElementByCss
(
'#pathname'
)
const
pathname
=
await
browser
.
elementByCss
(
'#pathname'
).
text
()
expect
(
pathname
).
toBe
(
'/hello'
)
const
asPath
=
await
browser
.
elementByCss
(
'#as-path'
).
text
()
expect
(
asPath
).
toBe
(
'/hello'
)
})
it
(
'should fetch data for getStaticProps without reloading'
,
async
()
=>
{
const
browser
=
await
webdriver
(
context
.
appPort
,
'/docs/hello'
)
await
browser
.
eval
(
'window.beforeNavigate = true'
)
...
...
@@ -490,6 +508,89 @@ const runTests = (context, dev = false) => {
}
})
it
(
'should use urls with basepath in router events'
,
async
()
=>
{
const
browser
=
await
webdriver
(
context
.
appPort
,
'/docs/hello'
)
try
{
await
browser
.
eval
(
'window._clearEventLog()'
)
await
browser
.
elementByCss
(
'#other-page-link'
)
.
click
()
.
waitForElementByCss
(
'#other-page-title'
)
const
eventLog
=
await
browser
.
eval
(
'window._getEventLog()'
)
expect
(
eventLog
).
toEqual
([
[
'routeChangeStart'
,
'/docs/other-page'
],
[
'beforeHistoryChange'
,
'/docs/other-page'
],
[
'routeChangeComplete'
,
'/docs/other-page'
],
])
}
finally
{
await
browser
.
close
()
}
})
it
(
'should use urls with basepath in router events for hash changes'
,
async
()
=>
{
const
browser
=
await
webdriver
(
context
.
appPort
,
'/docs/hello'
)
try
{
await
browser
.
eval
(
'window._clearEventLog()'
)
await
browser
.
elementByCss
(
'#hash-change'
).
click
()
const
eventLog
=
await
browser
.
eval
(
'window._getEventLog()'
)
expect
(
eventLog
).
toEqual
([
[
'hashChangeStart'
,
'/docs/hello#some-hash'
],
[
'hashChangeComplete'
,
'/docs/hello#some-hash'
],
])
}
finally
{
await
browser
.
close
()
}
})
it
(
'should use urls with basepath in router events for cancelled routes'
,
async
()
=>
{
const
browser
=
await
webdriver
(
context
.
appPort
,
'/docs/hello'
)
try
{
await
browser
.
eval
(
'window._clearEventLog()'
)
await
browser
.
elementByCss
(
'#slow-route'
)
.
click
()
.
elementByCss
(
'#other-page-link'
)
.
click
()
.
waitForElementByCss
(
'#other-page-title'
)
const
eventLog
=
await
browser
.
eval
(
'window._getEventLog()'
)
expect
(
eventLog
).
toEqual
([
[
'routeChangeStart'
,
'/docs/slow-route'
],
[
'routeChangeError'
,
'Route Cancelled'
,
true
,
'/docs/slow-route'
],
[
'routeChangeStart'
,
'/docs/other-page'
],
[
'beforeHistoryChange'
,
'/docs/other-page'
],
[
'routeChangeComplete'
,
'/docs/other-page'
],
])
}
finally
{
await
browser
.
close
()
}
})
it
(
'should use urls with basepath in router events for failed route change'
,
async
()
=>
{
const
browser
=
await
webdriver
(
context
.
appPort
,
'/docs/hello'
)
try
{
await
browser
.
eval
(
'window._clearEventLog()'
)
await
browser
.
elementByCss
(
'#error-route'
).
click
()
await
waitFor
(
2000
)
const
eventLog
=
await
browser
.
eval
(
'window._getEventLog()'
)
expect
(
eventLog
).
toEqual
([
[
'routeChangeStart'
,
'/docs/error-route'
],
[
'routeChangeError'
,
'Failed to load static props'
,
null
,
'/docs/error-route'
,
],
])
}
finally
{
await
browser
.
close
()
}
})
it
(
'should allow URL query strings without refresh'
,
async
()
=>
{
const
browser
=
await
webdriver
(
context
.
appPort
,
'/docs/hello?query=true'
)
try
{
...
...
test/integration/dynamic-routing/test/index.test.js
View file @
7dd61b47
...
...
@@ -98,8 +98,11 @@ function runTests(dev) {
it
(
'should allow calling Router.push on mount successfully'
,
async
()
=>
{
const
browser
=
await
webdriver
(
appPort
,
'/post-1/on-mount-redir'
)
waitFor
(
2000
)
expect
(
await
browser
.
elementByCss
(
'h3'
).
text
()).
toBe
(
'My blog'
)
try
{
expect
(
await
browser
.
waitForElementByCss
(
'h3'
).
text
()).
toBe
(
'My blog'
)
}
finally
{
browser
.
close
()
}
})
it
(
'should navigate optional dynamic page'
,
async
()
=>
{
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment