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

fix(hash): force navigation restore on manual navigation #921

Merged
merged 4 commits into from Jun 14, 2021
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
83 changes: 83 additions & 0 deletions __tests__/hash-manual-navigation.spec.ts
@@ -0,0 +1,83 @@
import { createMemoryHistory, createRouter, RouterHistory } from '../src'
import { tick } from './utils'

const component = {}

interface RouterHistory_Test extends RouterHistory {
changeURL(url: string): void
}

describe('hash history edge cases', () => {
it('correctly sets the url when it is manually changed but aborted with a redirect in guard', async () => {
const history = createMemoryHistory() as RouterHistory_Test
const router = createRouter({
history,
routes: [
{ path: '/', component },
{ path: '/foo', component },
],
})

await router.push('/foo?step=1')
await router.push('/foo?step=2')
await router.push('/foo?step=3')
router.back()
await tick() // wait for router listener on history
expect(router.currentRoute.value.fullPath).toBe('/foo?step=2')

// force a redirect next time
const removeListener = router.beforeEach(to => {
if (to.path === '/') {
removeListener()
return '/foo?step=2'
}
return
})

// const spy = jest.spyOn(history, 'go')

history.changeURL('/')
await tick()
expect(router.currentRoute.value.fullPath).toBe('/foo?step=2')
expect(history.location).toBe('/foo?step=2')
// expect(spy).toHaveBeenCalledTimes(1)
// expect(spy).toHaveBeenCalledWith(-1)
})

it('correctly sets the url when it is manually changed but aborted with guard', async () => {
const history = createMemoryHistory() as RouterHistory_Test
const router = createRouter({
history,
routes: [
{ path: '/', component },
{ path: '/foo', component },
],
})

await router.push('/foo?step=1')
await router.push('/foo?step=2')
await router.push('/foo?step=3')
router.back()
await tick() // wait for router listener on history
expect(router.currentRoute.value.fullPath).toBe('/foo?step=2')

// force a redirect next time
const removeListener = router.beforeEach(to => {
if (to.path === '/') {
removeListener()
return false
}

return
})

// const spy = jest.spyOn(history, 'go')

history.changeURL('/')
await tick()
expect(router.currentRoute.value.fullPath).toBe('/foo?step=2')
expect(history.location).toBe('/foo?step=2')
// expect(spy).toHaveBeenCalledTimes(1)
// expect(spy).toHaveBeenCalledWith(-1)
})
})
39 changes: 35 additions & 4 deletions src/router.ts
Expand Up @@ -13,7 +13,7 @@ import {
RouteLocationOptions,
MatcherLocationRaw,
} from './types'
import { RouterHistory, HistoryState } from './history/common'
import { RouterHistory, HistoryState, NavigationType } from './history/common'
import {
ScrollPosition,
getSavedScrollPosition,
Expand Down Expand Up @@ -689,7 +689,7 @@ export function createRouter(options: RouterOptions): Router {
) &&
// and we have done it a couple of times
redirectedFrom &&
// @ts-expect-error
// @ts-expect-error: added only in dev
(redirectedFrom._count = redirectedFrom._count
? // @ts-expect-error
redirectedFrom._count + 1
Expand Down Expand Up @@ -980,7 +980,24 @@ export function createRouter(options: RouterOptions): Router {
(error as NavigationRedirectError).to,
toLocation
// avoid an uncaught rejection, let push call triggerError
).catch(noop)
)
.then(failure => {
// manual change in hash history #916 ending up in the URL not
// changing but it was changed by the manual url change, so we
// need to manually change it ourselves
if (
isNavigationFailure(
failure,
ErrorTypes.NAVIGATION_ABORTED |
ErrorTypes.NAVIGATION_DUPLICATED
) &&
!info.delta &&
info.type === NavigationType.pop
) {
routerHistory.go(-1, false)
}
})
.catch(noop)
// avoid the then branch
return Promise.reject()
}
Expand All @@ -1000,7 +1017,21 @@ export function createRouter(options: RouterOptions): Router {
)

// revert the navigation
if (failure && info.delta) routerHistory.go(-info.delta, false)
if (failure) {
if (info.delta) {
routerHistory.go(-info.delta, false)
} else if (
info.type === NavigationType.pop &&
isNavigationFailure(
failure,
ErrorTypes.NAVIGATION_ABORTED | ErrorTypes.NAVIGATION_DUPLICATED
)
) {
// manual change in hash history #916
// it's like a push but lacks the information of the direction
routerHistory.go(-1, false)
}
}

triggerAfterEach(
toLocation as RouteLocationNormalizedLoaded,
Expand Down