-
Notifications
You must be signed in to change notification settings - Fork 991
/
router.tsx
269 lines (239 loc) · 7.93 KB
/
router.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
import type { ReactNode, ReactElement } from 'react'
import React, { useMemo, memo } from 'react'
import { ActiveRouteLoader } from './active-route-loader'
import { AuthenticatedRoute } from './AuthenticatedRoute'
import { Redirect } from './links'
import { LocationProvider, useLocation } from './location'
import { PageLoadingContextProvider } from './PageLoadingContext'
import { ParamsProvider } from './params'
import type {
NotFoundRouteProps,
RedirectRouteProps,
RenderMode,
} from './route-validators'
import { isValidRoute, PageType } from './route-validators'
import type { RouterContextProviderProps } from './router-context'
import { RouterContextProvider } from './router-context'
import { SplashPage } from './splash-page'
import {
analyzeRoutes,
matchPath,
normalizePage,
parseSearch,
replaceParams,
validatePath,
} from './util'
import type { Wrappers, TrailingSlashesTypes } from './util'
import type { AvailableRoutes } from './index'
// namedRoutes is populated at run-time by iterating over the `<Route />`
// components, and appending them to this object.
// Has to be `const`, or there'll be a race condition with imports in users'
// projects
const namedRoutes: AvailableRoutes = {}
export interface RouteProps {
path: string
page: PageType
name: string
prerender?: boolean
renderMode?: RenderMode
whileLoadingPage?: () => ReactElement | null
}
/**
* Route is now a "virtual" component
* it is actually never rendered. All the page loading logic happens in active-route-loader
* and all the validation happens within utility functions called from the Router
*/
function Route(props: RouteProps): JSX.Element
function Route(props: RedirectRouteProps): JSX.Element
function Route(props: NotFoundRouteProps): JSX.Element
function Route(_props: RouteProps | RedirectRouteProps | NotFoundRouteProps) {
return <></>
}
export interface RouterProps extends RouterContextProviderProps {
trailingSlashes?: TrailingSlashesTypes
pageLoadingDelay?: number
children: ReactNode
}
const Router: React.FC<RouterProps> = ({
useAuth,
paramTypes,
pageLoadingDelay,
trailingSlashes = 'never',
children,
}) => {
return (
// Level 1/3 (outer-most)
// Wrap it in the provider so that useLocation can be used
<LocationProvider trailingSlashes={trailingSlashes}>
<LocationAwareRouter
useAuth={useAuth}
paramTypes={paramTypes}
pageLoadingDelay={pageLoadingDelay}
>
{children}
</LocationAwareRouter>
</LocationProvider>
)
}
const LocationAwareRouter: React.FC<RouterProps> = ({
useAuth,
paramTypes,
pageLoadingDelay,
children,
}) => {
const location = useLocation()
const {
pathRouteMap,
hasHomeRoute,
namedRoutesMap,
NotFoundPage,
activeRoutePath,
} = useMemo(() => {
return analyzeRoutes(children, {
currentPathName: location.pathname,
// @TODO We haven't handled this with SSR/Streaming yet.
// May need a babel plugin to extract userParamTypes from Routes.tsx
userParamTypes: paramTypes,
})
}, [location.pathname, children, paramTypes])
// Assign namedRoutes so it can be imported like import {routes} from 'rwjs/router'
// Note that the value changes at runtime
Object.assign(namedRoutes, namedRoutesMap)
// The user has not generated routes if the only route that exists is the
// not found page, and that page is not part of the namedRoutes object
const hasGeneratedRoutes = Object.keys(namedRoutes).length > 0
const shouldShowSplash =
(!hasHomeRoute && location.pathname === '/') || !hasGeneratedRoutes
if (shouldShowSplash && typeof SplashPage !== 'undefined') {
return (
<SplashPage
hasGeneratedRoutes={hasGeneratedRoutes}
allStandardRoutes={pathRouteMap}
/>
)
}
// Render 404 page if no route matches
if (!activeRoutePath) {
if (NotFoundPage) {
return (
<RouterContextProvider useAuth={useAuth} paramTypes={paramTypes}>
<ParamsProvider>
<PageLoadingContextProvider delay={pageLoadingDelay}>
<ActiveRouteLoader
spec={normalizePage(NotFoundPage)}
path={location.pathname}
/>
</PageLoadingContextProvider>
</ParamsProvider>
</RouterContextProvider>
)
}
return null
}
const { path, page, name, redirect, whileLoadingPage, sets } =
pathRouteMap[activeRoutePath]
if (!path) {
throw new Error(`Route "${name}" needs to specify a path`)
}
// Check for issues with the path.
validatePath(path, name || path)
const { params: pathParams } = matchPath(path, location.pathname, {
userParamTypes: paramTypes,
})
const searchParams = parseSearch(location.search)
const allParams = { ...searchParams, ...pathParams }
// Level 2/3 (LocationAwareRouter)
return (
<RouterContextProvider useAuth={useAuth} paramTypes={paramTypes}>
<ParamsProvider allParams={allParams}>
<PageLoadingContextProvider delay={pageLoadingDelay}>
{redirect && <Redirect to={replaceParams(redirect, allParams)} />}
{!redirect && page && (
<WrappedPage
sets={sets}
routeLoaderElement={
<ActiveRouteLoader
path={path}
spec={normalizePage(page as any)}
params={allParams}
whileLoadingPage={whileLoadingPage as any}
/>
}
/>
)}
</PageLoadingContextProvider>
</ParamsProvider>
</RouterContextProvider>
)
}
interface WrappedPageProps {
routeLoaderElement: ReactNode
sets: Array<{
id: string
wrappers: Wrappers
isPrivate: boolean
props: {
private?: boolean
[key: string]: unknown
}
}>
}
/**
* This is effectively a Set (without auth-related code)
*
* This means that the <Set> and <PrivateSet> components become "virtual"
* i.e. they are never actually Rendered, but their props are extracted by the
* analyze routes function.
*
* This is so that we can have all the information up front in the routes-manifest
* for SSR, but also so that we only do one loop of all the Routes.
*/
const WrappedPage = memo(({ routeLoaderElement, sets }: WrappedPageProps) => {
// @NOTE: don't mutate the wrappers array, it causes full page re-renders
// Instead just create a new array with the AuthenticatedRoute wrapper
if (!sets || sets.length === 0) {
return routeLoaderElement
}
return sets.reduceRight<ReactNode | undefined>((acc, set) => {
// For each set in `sets`, if you have `<Set wrap={[a,b,c]} p="p" />` then
// this will return
// <a p="p"><b p="p"><c p="p"><routeLoaderElement /></c></b></a>
// If you have `<PrivateSet wrap={[a,b,c]} p="p" />` instead it will return
// <AuthenticatedRoute>
// <a p="p"><b p="p"><c p="p"><routeLoaderElement /></c></b></a>
// </AuthenticatedRoute>
// Bundle up all the wrappers into a single element with each wrapper as a
// child of the previous (that's why we do reduceRight)
let wrapped = set.wrappers.reduceRight((acc, Wrapper, index) => {
return React.createElement(
Wrapper,
{ ...set.props, key: set.id + '-' + index },
acc
)
}, acc)
// If set is private, wrap it in AuthenticatedRoute
if (set.isPrivate) {
const unauthenticated = set.props.unauthenticated
if (!unauthenticated || typeof unauthenticated !== 'string') {
throw new Error(
'You must specify an `unauthenticated` route when using PrivateSet'
)
}
// We do this last, to make sure that none of the wrapper elements are
// rendered if the user isn't authenticated
wrapped = (
<AuthenticatedRoute {...set.props} unauthenticated={unauthenticated}>
{wrapped}
</AuthenticatedRoute>
)
}
return wrapped
}, routeLoaderElement)
})
export {
Router,
Route,
namedRoutes as routes,
isValidRoute as isRoute,
PageType,
}