Skip to content

Commit 10a071c

Browse files
posvaposva
committed
refactor(history): simplify location as a string
BREAKING CHANGE: HistoryLocation is just a string now. It was pretty much an internal property but it could be used inside `history.state`. It used to be an object `{ fullPath: '/the-url' }`. And it's now just the `fullPath` property.
1 parent c6274ae commit 10a071c

File tree

8 files changed

+73
-181
lines changed

8 files changed

+73
-181
lines changed

‎__tests__/history/memory.spec.ts

+12-28
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
11
import { createMemoryHistory } from '../../src/history/memory'
2-
import {
3-
START,
4-
HistoryLocationNormalized,
5-
RawHistoryLocation,
6-
} from '../../src/history/common'
2+
import { START, HistoryLocation } from '../../src/history/common'
73

8-
const loc: RawHistoryLocation = '/foo'
4+
const loc: HistoryLocation = '/foo'
95

10-
const loc2: RawHistoryLocation = '/bar'
11-
12-
const normalizedLoc: HistoryLocationNormalized = {
13-
fullPath: '/foo',
14-
}
15-
16-
const normalizedLoc2: HistoryLocationNormalized = {
17-
fullPath: '/bar',
18-
}
6+
const loc2: HistoryLocation = '/bar'
197

208
describe('Memory history', () => {
219
it('starts in nowhere', () => {
@@ -26,18 +14,14 @@ describe('Memory history', () => {
2614
it('can push a location', () => {
2715
const history = createMemoryHistory()
2816
history.push('/somewhere?foo=foo#hey')
29-
expect(history.location).toEqual({
30-
fullPath: '/somewhere?foo=foo#hey',
31-
})
17+
expect(history.location).toEqual('/somewhere?foo=foo#hey')
3218
})
3319

3420
it('can replace a location', () => {
3521
const history = createMemoryHistory()
3622
// partial version
3723
history.replace('/somewhere?foo=foo#hey')
38-
expect(history.location).toEqual({
39-
fullPath: '/somewhere?foo=foo#hey',
40-
})
24+
expect(history.location).toEqual('/somewhere?foo=foo#hey')
4125
})
4226

4327
it('does not trigger listeners with push', () => {
@@ -61,7 +45,7 @@ describe('Memory history', () => {
6145
history.push(loc)
6246
history.push(loc2)
6347
history.go(-1)
64-
expect(history.location).toEqual(normalizedLoc)
48+
expect(history.location).toEqual(loc)
6549
history.go(-1)
6650
expect(history.location).toEqual(START)
6751
})
@@ -86,9 +70,9 @@ describe('Memory history', () => {
8670
history.go(-1)
8771
expect(history.location).toEqual(START)
8872
history.go(1)
89-
expect(history.location).toEqual(normalizedLoc)
73+
expect(history.location).toEqual(loc)
9074
history.go(1)
91-
expect(history.location).toEqual(normalizedLoc2)
75+
expect(history.location).toEqual(loc2)
9276
})
9377

9478
it('can push in the middle of the history', () => {
@@ -99,10 +83,10 @@ describe('Memory history', () => {
9983
history.go(-1)
10084
expect(history.location).toEqual(START)
10185
history.push(loc2)
102-
expect(history.location).toEqual(normalizedLoc2)
86+
expect(history.location).toEqual(loc2)
10387
// does nothing
10488
history.go(1)
105-
expect(history.location).toEqual(normalizedLoc2)
89+
expect(history.location).toEqual(loc2)
10690
})
10791

10892
it('can listen to navigations', () => {
@@ -112,14 +96,14 @@ describe('Memory history', () => {
11296
history.push(loc)
11397
history.go(-1)
11498
expect(spy).toHaveBeenCalledTimes(1)
115-
expect(spy).toHaveBeenCalledWith(START, normalizedLoc, {
99+
expect(spy).toHaveBeenCalledWith(START, loc, {
116100
direction: 'back',
117101
delta: -1,
118102
type: 'pop',
119103
})
120104
history.go(1)
121105
expect(spy).toHaveBeenCalledTimes(2)
122-
expect(spy).toHaveBeenLastCalledWith(normalizedLoc, START, {
106+
expect(spy).toHaveBeenLastCalledWith(loc, START, {
123107
direction: 'forward',
124108
delta: 1,
125109
type: 'pop',

‎__tests__/initialNavigation.spec.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ describe('Initial Navigation', () => {
5050

5151
it('handles initial navigation with redirect', async () => {
5252
const { history, router } = newRouter('/home')
53-
expect(history.location.fullPath).toBe('/home')
53+
expect(history.location).toBe('/home')
5454
// this is done automatically on install but there is none here
55-
await router.push(history.location.fullPath)
55+
await router.push(history.location)
5656
expect(router.currentRoute.value).toMatchObject({ path: '/' })
5757
await router.push('/foo')
5858
expect(router.currentRoute.value).toMatchObject({ path: '/foo' })
@@ -63,9 +63,9 @@ describe('Initial Navigation', () => {
6363

6464
it('handles initial navigation with beforEnter', async () => {
6565
const { history, router } = newRouter('/home-before')
66-
expect(history.location.fullPath).toBe('/home-before')
66+
expect(history.location).toBe('/home-before')
6767
// this is done automatically on mount but there is no mount here
68-
await router.push(history.location.fullPath)
68+
await router.push(history.location)
6969
expect(router.currentRoute.value).toMatchObject({ path: '/' })
7070
await router.push('/foo')
7171
expect(router.currentRoute.value).toMatchObject({ path: '/foo' })

‎__tests__/location.spec.ts

-15
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import { normalizeHistoryLocation as normalizeLocation } from '../src/history/common'
21
import { parseQuery, stringifyQuery } from '../src/query'
32
import {
43
parseURL as originalParseURL,
@@ -208,20 +207,6 @@ describe('stringifyURL', () => {
208207
})
209208
})
210209

211-
describe('normalizeLocation', () => {
212-
it('works with string', () => {
213-
expect(normalizeLocation('/foo')).toEqual({ fullPath: '/foo' })
214-
})
215-
216-
it('works with objects', () => {
217-
expect(
218-
normalizeLocation({
219-
fullPath: '/foo',
220-
})
221-
).toEqual({ fullPath: '/foo' })
222-
})
223-
})
224-
225210
describe('stripBase', () => {
226211
it('returns the pathname if no base', () => {
227212
expect(stripBase('', '')).toBe('')

‎__tests__/router.spec.ts

+6-54
Original file line numberDiff line numberDiff line change
@@ -102,15 +102,7 @@ describe('Router', () => {
102102
jest.spyOn(history, 'push')
103103
await router.push('/foo')
104104
expect(history.push).toHaveBeenCalledTimes(1)
105-
expect(history.push).toHaveBeenCalledWith(
106-
expect.objectContaining({
107-
fullPath: '/foo',
108-
path: '/foo',
109-
query: {},
110-
hash: '',
111-
}),
112-
undefined
113-
)
105+
expect(history.push).toHaveBeenCalledWith('/foo', undefined)
114106
})
115107

116108
it('calls history.replace with router.replace', async () => {
@@ -119,15 +111,7 @@ describe('Router', () => {
119111
jest.spyOn(history, 'replace')
120112
await router.replace('/foo')
121113
expect(history.replace).toHaveBeenCalledTimes(1)
122-
expect(history.replace).toHaveBeenCalledWith(
123-
expect.objectContaining({
124-
fullPath: '/foo',
125-
path: '/foo',
126-
query: {},
127-
hash: '',
128-
}),
129-
expect.anything()
130-
)
114+
expect(history.replace).toHaveBeenCalledWith('/foo', expect.anything())
131115
})
132116

133117
it('replaces if a guard redirects', async () => {
@@ -138,15 +122,7 @@ describe('Router', () => {
138122
jest.spyOn(history, 'replace')
139123
await router.replace('/home-before')
140124
expect(history.replace).toHaveBeenCalledTimes(1)
141-
expect(history.replace).toHaveBeenCalledWith(
142-
expect.objectContaining({
143-
fullPath: '/',
144-
path: '/',
145-
query: {},
146-
hash: '',
147-
}),
148-
expect.anything()
149-
)
125+
expect(history.replace).toHaveBeenCalledWith('/', expect.anything())
150126
})
151127

152128
it('allows to customize parseQuery', async () => {
@@ -226,47 +202,23 @@ describe('Router', () => {
226202
jest.spyOn(history, 'replace')
227203
await router.push({ path: '/foo', replace: true })
228204
expect(history.replace).toHaveBeenCalledTimes(1)
229-
expect(history.replace).toHaveBeenCalledWith(
230-
expect.objectContaining({
231-
fullPath: '/foo',
232-
path: '/foo',
233-
query: {},
234-
hash: '',
235-
}),
236-
expect.anything()
237-
)
205+
expect(history.replace).toHaveBeenCalledWith('/foo', expect.anything())
238206
})
239207

240208
it('can replaces current location with a string location', async () => {
241209
const { router, history } = await newRouter()
242210
jest.spyOn(history, 'replace')
243211
await router.replace('/foo')
244212
expect(history.replace).toHaveBeenCalledTimes(1)
245-
expect(history.replace).toHaveBeenCalledWith(
246-
expect.objectContaining({
247-
fullPath: '/foo',
248-
path: '/foo',
249-
query: {},
250-
hash: '',
251-
}),
252-
expect.anything()
253-
)
213+
expect(history.replace).toHaveBeenCalledWith('/foo', expect.anything())
254214
})
255215

256216
it('can replaces current location with an object location', async () => {
257217
const { router, history } = await newRouter()
258218
jest.spyOn(history, 'replace')
259219
await router.replace({ path: '/foo' })
260220
expect(history.replace).toHaveBeenCalledTimes(1)
261-
expect(history.replace).toHaveBeenCalledWith(
262-
expect.objectContaining({
263-
fullPath: '/foo',
264-
path: '/foo',
265-
query: {},
266-
hash: '',
267-
}),
268-
expect.anything()
269-
)
221+
expect(history.replace).toHaveBeenCalledWith('/foo', expect.anything())
270222
})
271223

272224
it('navigates if the location does not exist', async () => {

‎src/history/common.ts

+10-31
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
11
import { isBrowser } from '../utils'
22
import { removeTrailingSlash } from '../location'
33

4-
interface HistoryLocation {
5-
fullPath: string
6-
state?: HistoryState
7-
}
8-
9-
export type RawHistoryLocation = HistoryLocation | string
10-
export type HistoryLocationNormalized = Pick<HistoryLocation, 'fullPath'>
4+
export type HistoryLocation = string
115
// pushState clones the state passed and do not accept everything
126
// it doesn't accept symbols, nor functions as values. It also ignores Symbols as keys
137
type HistoryStateValue =
@@ -44,19 +38,16 @@ export interface NavigationInformation {
4438

4539
export interface NavigationCallback {
4640
(
47-
to: HistoryLocationNormalized,
48-
from: HistoryLocationNormalized,
41+
to: HistoryLocation,
42+
from: HistoryLocation,
4943
information: NavigationInformation
5044
): void
5145
}
5246

5347
/**
5448
* Starting location for Histories
5549
*/
56-
const START_PATH = ''
57-
export const START: HistoryLocationNormalized = {
58-
fullPath: START_PATH,
59-
}
50+
export const START: HistoryLocation = ''
6051

6152
export type ValueContainer<T> = { value: T }
6253

@@ -76,7 +67,7 @@ export interface RouterHistory {
7667
/**
7768
* Current History location
7869
*/
79-
readonly location: HistoryLocationNormalized
70+
readonly location: HistoryLocation
8071
/**
8172
* Current History state
8273
*/
@@ -91,7 +82,7 @@ export interface RouterHistory {
9182
* @param data - optional {@link HistoryState} to be associated with the
9283
* navigation entry
9384
*/
94-
push(to: RawHistoryLocation, data?: HistoryState): void
85+
push(to: HistoryLocation, data?: HistoryState): void
9586
/**
9687
* Same as {@link RouterHistory.push} but performs a `history.replaceState`
9788
* instead of `history.pushState`
@@ -100,7 +91,7 @@ export interface RouterHistory {
10091
* @param data - optional {@link HistoryState} to be associated with the
10192
* navigation entry
10293
*/
103-
replace(to: RawHistoryLocation, data?: HistoryState): void
94+
replace(to: HistoryLocation, data?: HistoryState): void
10495

10596
/**
10697
* Traverses history in a given direction.
@@ -134,7 +125,7 @@ export interface RouterHistory {
134125
*
135126
* @param location - history location that should create an href
136127
*/
137-
createHref(location: HistoryLocationNormalized): string
128+
createHref(location: HistoryLocation): string
138129

139130
/**
140131
* Clears any event listener attached by the history implementation.
@@ -144,15 +135,6 @@ export interface RouterHistory {
144135

145136
// Generic utils
146137

147-
export function normalizeHistoryLocation(
148-
location: RawHistoryLocation
149-
): HistoryLocationNormalized {
150-
return {
151-
// to avoid doing a typeof or in that is quite long
152-
fullPath: (location as HistoryLocation).fullPath || (location as string),
153-
}
154-
}
155-
156138
/**
157139
* Normalizes a base by removing any trailing slash and reading the base tag if
158140
* present.
@@ -184,9 +166,6 @@ export function normalizeBase(base?: string): string {
184166

185167
// remove any character before the hash
186168
const BEFORE_HASH_RE = /^[^#]+#/
187-
export function createHref(
188-
base: string,
189-
location: HistoryLocationNormalized
190-
): string {
191-
return base.replace(BEFORE_HASH_RE, '#') + location.fullPath
169+
export function createHref(base: string, location: HistoryLocation): string {
170+
return base.replace(BEFORE_HASH_RE, '#') + location
192171
}

0 commit comments

Comments
 (0)