Skip to content

Commit 95d44c8

Browse files
posvaposva
authored
fix(guards): correctly reuse guards (#616)
Fix #614
1 parent 6448a14 commit 95d44c8

File tree

8 files changed

+32
-26
lines changed

8 files changed

+32
-26
lines changed

‎__tests__/matcher/records.spec.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ describe('normalizeRouteRecord', () => {
1111
children: [],
1212
aliasOf: undefined,
1313
components: { default: {} },
14-
leaveGuards: [],
15-
updateGuards: [],
14+
leaveGuards: expect.any(Set),
15+
updateGuards: expect.any(Set),
1616
instances: {},
1717
meta: {},
1818
name: undefined,
@@ -35,8 +35,8 @@ describe('normalizeRouteRecord', () => {
3535
beforeEnter,
3636
children: [{ path: '/child' }],
3737
components: { default: {} },
38-
leaveGuards: [],
39-
updateGuards: [],
38+
leaveGuards: expect.any(Set),
39+
updateGuards: expect.any(Set),
4040
instances: {},
4141
meta: { foo: true },
4242
name: 'name',
@@ -77,8 +77,8 @@ describe('normalizeRouteRecord', () => {
7777
beforeEnter,
7878
children: [{ path: '/child' }],
7979
components: { one: {} },
80-
leaveGuards: [],
81-
updateGuards: [],
80+
leaveGuards: expect.any(Set),
81+
updateGuards: expect.any(Set),
8282
instances: {},
8383
meta: { foo: true },
8484
name: 'name',

‎e2e/guards-instances/index.ts

+6-2
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ const state = reactive({
4747
*/
4848
function createTestComponent(key: string) {
4949
return defineComponent({
50+
name: key,
5051
template: `
5152
<div :id="key">
5253
{{ key }}
@@ -196,12 +197,12 @@ leaves: {{ state.leave }}
196197
</router-view>
197198
</template>
198199
<template v-else-if="testCase === 'keyed'">
199-
<router-view :key="$route.query.foo" class="view" />
200+
<router-view :key="$route.query.foo || undefined" class="view" />
200201
</template>
201202
<template v-else-if="testCase === 'keepalivekeyed'">
202203
<router-view v-slot="{ Component }" >
203204
<keep-alive>
204-
<component :is="Component" :key="$route.query.foo" class="view" />
205+
<component :is="Component" :key="$route.query.foo || undefined" class="view" />
205206
</keep-alive>
206207
</router-view>
207208
</template>
@@ -232,4 +233,7 @@ leaves: {{ state.leave }}
232233

233234
app.use(router)
234235

236+
// @ts-ignore
237+
window.r = router
238+
235239
app.mount('#app')

‎e2e/specs/guards-instances.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ module.exports = {
158158
.expect.element('#logs')
159159
.text.to.equal(
160160
[
161-
// lol
161+
// to force new lines formatting
162162
`${name}: update /f/2 - /f/2`,
163163
`${name}: setup:update /f/2 - /f/2`,
164164
].join('\n')

‎src/RouterView.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ export const RouterViewImpl = /*#__PURE__*/ defineComponent({
6969
to.instances[name] = instance
7070
// the component instance is reused for a different route or name so
7171
// we copy any saved update or leave guards
72-
if (from && instance === oldInstance) {
72+
if (from && from !== to && instance && instance === oldInstance) {
7373
to.leaveGuards = from.leaveGuards
7474
to.updateGuards = from.updateGuards
7575
}

‎src/matcher/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -342,8 +342,8 @@ export function normalizeRouteRecord(
342342
props: normalizeRecordProps(record),
343343
children: record.children || [],
344344
instances: {},
345-
leaveGuards: [],
346-
updateGuards: [],
345+
leaveGuards: new Set(),
346+
updateGuards: new Set(),
347347
enterCallbacks: {},
348348
components:
349349
'components' in record

‎src/matcher/types.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ export interface RouteRecordNormalized {
4949
*
5050
* @internal
5151
*/
52-
leaveGuards: NavigationGuard[]
52+
leaveGuards: Set<NavigationGuard>
5353
/**
5454
* Registered update guards
5555
*
5656
* @internal
5757
*/
58-
updateGuards: NavigationGuard[]
58+
updateGuards: Set<NavigationGuard>
5959
/**
6060
* Registered beforeRouteEnter callbacks passed to `next` or returned in guards
6161
*

‎src/navigationGuards.ts

+10-8
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,23 @@ import { RouteRecordNormalized } from './matcher/types'
2424
import { isESModule } from './utils'
2525
import { warn } from './warning'
2626

27-
function registerGuard(list: NavigationGuard[], guard: NavigationGuard) {
27+
function registerGuard(
28+
record: RouteRecordNormalized,
29+
name: 'leaveGuards' | 'updateGuards',
30+
guard: NavigationGuard
31+
) {
2832
const removeFromList = () => {
29-
const index = list.indexOf(guard)
30-
if (index > -1) list.splice(index, 1)
33+
record[name].delete(guard)
3134
}
3235

3336
onUnmounted(removeFromList)
3437
onDeactivated(removeFromList)
3538

3639
onActivated(() => {
37-
const index = list.indexOf(guard)
38-
if (index < 0) list.push(guard)
40+
record[name].add(guard)
3941
})
4042

41-
list.push(guard)
43+
record[name].add(guard)
4244
}
4345

4446
/**
@@ -65,7 +67,7 @@ export function onBeforeRouteLeave(leaveGuard: NavigationGuard) {
6567
return
6668
}
6769

68-
registerGuard(activeRecord.leaveGuards, leaveGuard)
70+
registerGuard(activeRecord, 'leaveGuards', leaveGuard)
6971
}
7072

7173
/**
@@ -92,7 +94,7 @@ export function onBeforeRouteUpdate(updateGuard: NavigationGuard) {
9294
return
9395
}
9496

95-
registerGuard(activeRecord.updateGuards, updateGuard)
97+
registerGuard(activeRecord, 'updateGuards', updateGuard)
9698
}
9799

98100
export function guardToPromiseFn(

‎src/router.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -728,9 +728,9 @@ export function createRouter(options: RouterOptions): Router {
728728

729729
// leavingRecords is already reversed
730730
for (const record of leavingRecords) {
731-
for (const guard of record.leaveGuards) {
731+
record.leaveGuards.forEach(guard => {
732732
guards.push(guardToPromiseFn(guard, to, from))
733-
}
733+
})
734734
}
735735

736736
const canceledNavigationCheck = checkCanceledNavigationAndReject.bind(
@@ -764,9 +764,9 @@ export function createRouter(options: RouterOptions): Router {
764764
)
765765

766766
for (const record of updatingRecords) {
767-
for (const guard of record.updateGuards) {
767+
record.updateGuards.forEach(guard => {
768768
guards.push(guardToPromiseFn(guard, to, from))
769-
}
769+
})
770770
}
771771
guards.push(canceledNavigationCheck)
772772

0 commit comments

Comments
 (0)