/* global __NEXT_DATA__ */ // tslint:disable:no-console import { ParsedUrlQuery } from 'querystring' import { ComponentType } from 'react' import { UrlObject } from 'url' import { normalizePathTrailingSlash, removePathTrailingSlash, } from '../../../client/normalize-trailing-slash' import { GoodPageCache, StyleSheetTuple } from '../../../client/page-loader' import { denormalizePagePath } from '../../server/denormalize-page-path' import mitt, { MittEmitter } from '../mitt' import { AppContextType, formatWithValidation, getLocationOrigin, getURL, loadGetInitialProps, NextPageContext, ST, } from '../utils' import { isDynamicRoute } from './utils/is-dynamic' import { parseRelativeUrl } from './utils/parse-relative-url' import { searchParamsToUrlQuery } from './utils/querystring' import resolveRewrites from './utils/resolve-rewrites' import { getRouteMatcher } from './utils/route-matcher' import { getRouteRegex } from './utils/route-regex' import escapePathDelimiters from './utils/escape-path-delimiters' interface TransitionOptions { shallow?: boolean } interface NextHistoryState { url: string as: string options: TransitionOptions } type HistoryState = null | { __N: false } | ({ __N: true } & NextHistoryState) const basePath = (process.env.__NEXT_ROUTER_BASEPATH as string) || '' function buildCancellationError() { return Object.assign(new Error('Route Cancelled'), { cancelled: true, }) } export function hasBasePath(path: string): boolean { return path === basePath || path.startsWith(basePath + '/') } export function addBasePath(path: string): string { // we only add the basepath on relative urls return basePath && path.startsWith('/') ? path === '/' ? normalizePathTrailingSlash(basePath) : basePath + path : path } export function delBasePath(path: string): string { return path.slice(basePath.length) || '/' } /** * Detects whether a given url is routable by the Next.js router (browser only). */ export function isLocalURL(url: string): boolean { if (url.startsWith('/')) return true try { // absolute urls can be local if they are on the same origin const locationOrigin = getLocationOrigin() const resolved = new URL(url, locationOrigin) return resolved.origin === locationOrigin && hasBasePath(resolved.pathname) } catch (_) { return false } } type Url = UrlObject | string export function interpolateAs( route: string, asPathname: string, query: ParsedUrlQuery ) { let interpolatedRoute = '' const dynamicRegex = getRouteRegex(route) const dynamicGroups = dynamicRegex.groups const dynamicMatches = // Try to match the dynamic route against the asPath (asPathname !== route ? getRouteMatcher(dynamicRegex)(asPathname) : '') || // Fall back to reading the values from the href // TODO: should this take priority; also need to change in the router. query interpolatedRoute = route if ( !Object.keys(dynamicGroups).every((param) => { let value = dynamicMatches[param] || '' const { repeat, optional } = dynamicGroups[param] // support single-level catch-all // TODO: more robust handling for user-error (passing `/`) let replaced = `[${repeat ? '...' : ''}${param}]` if (optional) { replaced = `${!value ? '/' : ''}[${replaced}]` } if (repeat && !Array.isArray(value)) value = [value] return ( (optional || param in dynamicMatches) && // Interpolate group into data URL if present (interpolatedRoute = interpolatedRoute!.replace( replaced, repeat ? (value as string[]).map(escapePathDelimiters).join('/') : escapePathDelimiters(value as string) ) || '/') ) }) ) { interpolatedRoute = '' // did not satisfy all requirements // n.b. We ignore this error because we handle warning for this case in // development in the `` component directly. } return interpolatedRoute } /** * Resolves a given hyperlink with a certain router state (basePath not included). * Preserves absolute urls. */ export function resolveHref( currentPath: string, href: Url, resolveAs?: boolean ): string { // we use a dummy base url for relative urls const base = new URL(currentPath, 'http://n') const urlAsString = typeof href === 'string' ? href : formatWithValidation(href) try { const finalUrl = new URL(urlAsString, base) finalUrl.pathname = normalizePathTrailingSlash(finalUrl.pathname) let interpolatedAs = '' if ( isDynamicRoute(finalUrl.pathname) && finalUrl.searchParams && resolveAs ) { const query = searchParamsToUrlQuery(finalUrl.searchParams) interpolatedAs = interpolateAs( finalUrl.pathname, finalUrl.pathname, query ) } // if the origin didn't change, it means we received a relative href const resolvedHref = finalUrl.origin === base.origin ? finalUrl.href.slice(finalUrl.origin.length) : finalUrl.href return (resolveAs ? [resolvedHref, interpolatedAs] : resolvedHref) as string } catch (_) { return (resolveAs ? [urlAsString] : urlAsString) as string } } const PAGE_LOAD_ERROR = Symbol('PAGE_LOAD_ERROR') export function markLoadingError(err: Error): Error { return Object.defineProperty(err, PAGE_LOAD_ERROR, {}) } function prepareUrlAs(router: NextRouter, url: Url, as: Url) { // If url and as provided as an object representation, // we'll format them into the string version here. return { url: addBasePath(resolveHref(router.pathname, url)), as: as ? addBasePath(resolveHref(router.pathname, as)) : as, } } export type BaseRouter = { route: string pathname: string query: ParsedUrlQuery asPath: string basePath: string } export type NextRouter = BaseRouter & Pick< Router, | 'push' | 'replace' | 'reload' | 'back' | 'prefetch' | 'beforePopState' | 'events' | 'isFallback' > export type PrefetchOptions = { priority?: boolean } export type PrivateRouteInfo = { Component: ComponentType styleSheets: StyleSheetTuple[] __N_SSG?: boolean __N_SSP?: boolean props?: Record err?: Error error?: any } export type AppProps = Pick & { router: Router } & Record export type AppComponent = ComponentType type Subscription = (data: PrivateRouteInfo, App: AppComponent) => Promise type BeforePopStateCallback = (state: NextHistoryState) => boolean type ComponentLoadCancel = (() => void) | null type HistoryMethod = 'replaceState' | 'pushState' const manualScrollRestoration = process.env.__NEXT_SCROLL_RESTORATION && typeof window !== 'undefined' && 'scrollRestoration' in window.history function fetchRetry(url: string, attempts: number): Promise { return fetch(url, { // Cookies are required to be present for Next.js' SSG "Preview Mode". // Cookies may also be required for `getServerSideProps`. // // > `fetch` won’t send cookies, unless you set the credentials init // > option. // https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch // // > For maximum browser compatibility when it comes to sending & // > receiving cookies, always supply the `credentials: 'same-origin'` // > option instead of relying on the default. // https://github.com/github/fetch#caveats credentials: 'same-origin', }).then((res) => { if (!res.ok) { if (attempts > 1 && res.status >= 500) { return fetchRetry(url, attempts - 1) } throw new Error(`Failed to load static props`) } return res.json() }) } function fetchNextData(dataHref: string, isServerRender: boolean) { return fetchRetry(dataHref, isServerRender ? 3 : 1).catch((err: Error) => { // We should only trigger a server-side transition if this was caused // on a client-side transition. Otherwise, we'd get into an infinite // loop. if (!isServerRender) { markLoadingError(err) } throw err }) } export default class Router implements BaseRouter { route: string pathname: string query: ParsedUrlQuery asPath: string basePath: string /** * Map of all components loaded in `Router` */ components: { [pathname: string]: PrivateRouteInfo } // Static Data Cache sdc: { [asPath: string]: object } = {} sub: Subscription clc: ComponentLoadCancel pageLoader: any _bps: BeforePopStateCallback | undefined events: MittEmitter _wrapApp: (App: AppComponent) => any isSsr: boolean isFallback: boolean _inFlightRoute?: string _shallow?: boolean static events: MittEmitter = mitt() constructor( pathname: string, query: ParsedUrlQuery, as: string, { initialProps, pageLoader, App, wrapApp, Component, initialStyleSheets, err, subscription, isFallback, }: { subscription: Subscription initialProps: any pageLoader: any Component: ComponentType initialStyleSheets: StyleSheetTuple[] App: AppComponent wrapApp: (App: AppComponent) => any err?: Error isFallback: boolean } ) { // represents the current component key this.route = removePathTrailingSlash(pathname) // set up the component cache (by route keys) this.components = {} // We should not keep the cache, if there's an error // Otherwise, this cause issues when when going back and // come again to the errored page. if (pathname !== '/_error') { this.components[this.route] = { Component, styleSheets: initialStyleSheets, props: initialProps, err, __N_SSG: initialProps && initialProps.__N_SSG, __N_SSP: initialProps && initialProps.__N_SSP, } } this.components['/_app'] = { Component: App as ComponentType, styleSheets: [ /* /_app does not need its stylesheets managed */ ], } // Backwards compat for Router.router.events // TODO: Should be remove the following major version as it was never documented this.events = Router.events this.pageLoader = pageLoader this.pathname = pathname this.query = query // if auto prerendered and dynamic route wait to update asPath // until after mount to prevent hydration mismatch this.asPath = // @ts-ignore this is temporarily global (attached to window) isDynamicRoute(pathname) && __NEXT_DATA__.autoExport ? pathname : as this.basePath = basePath this.sub = subscription this.clc = null this._wrapApp = wrapApp // make sure to ignore extra popState in safari on navigating // back from external site this.isSsr = true this.isFallback = isFallback if (typeof window !== 'undefined') { // make sure "as" doesn't start with double slashes or else it can // throw an error as it's considered invalid if (as.substr(0, 2) !== '//') { // in order for `e.state` to work on the `onpopstate` event // we have to register the initial route upon initialization this.changeState( 'replaceState', formatWithValidation({ pathname: addBasePath(pathname), query }), getURL() ) } window.addEventListener('popstate', this.onPopState) // enable custom scroll restoration handling when available // otherwise fallback to browser's default handling if (process.env.__NEXT_SCROLL_RESTORATION) { if (manualScrollRestoration) { window.history.scrollRestoration = 'manual' let scrollDebounceTimeout: undefined | NodeJS.Timeout const debouncedScrollSave = () => { if (scrollDebounceTimeout) clearTimeout(scrollDebounceTimeout) scrollDebounceTimeout = setTimeout(() => { const { url, as: curAs, options } = history.state this.changeState( 'replaceState', url, curAs, Object.assign({}, options, { _N_X: window.scrollX, _N_Y: window.scrollY, }) ) }, 10) } window.addEventListener('scroll', debouncedScrollSave) } } } } onPopState = (e: PopStateEvent): void => { const state = e.state as HistoryState if (!state) { // We get state as undefined for two reasons. // 1. With older safari (< 8) and older chrome (< 34) // 2. When the URL changed with # // // In the both cases, we don't need to proceed and change the route. // (as it's already changed) // But we can simply replace the state with the new changes. // Actually, for (1) we don't need to nothing. But it's hard to detect that event. // So, doing the following for (1) does no harm. const { pathname, query } = this this.changeState( 'replaceState', formatWithValidation({ pathname: addBasePath(pathname), query }), getURL() ) return } if (!state.__N) { return } const { url, as, options } = state const { pathname } = parseRelativeUrl(url) // Make sure we don't re-render on initial load, // can be caused by navigating back from an external site if (this.isSsr && as === this.asPath && pathname === this.pathname) { return } // If the downstream application returns falsy, return. // They will then be responsible for handling the event. if (this._bps && !this._bps(state)) { return } this.change( 'replaceState', url, as, Object.assign({}, options, { shallow: options.shallow && this._shallow, }) ) } reload(): void { window.location.reload() } /** * Go back in history */ back() { window.history.back() } /** * Performs a `pushState` with arguments * @param url of the route * @param as masks `url` for the browser * @param options object you can define `shallow` and other options */ push(url: Url, as: Url = url, options: TransitionOptions = {}) { ;({ url, as } = prepareUrlAs(this, url, as)) return this.change('pushState', url, as, options) } /** * Performs a `replaceState` with arguments * @param url of the route * @param as masks `url` for the browser * @param options object you can define `shallow` and other options */ replace(url: Url, as: Url = url, options: TransitionOptions = {}) { ;({ url, as } = prepareUrlAs(this, url, as)) return this.change('replaceState', url, as, options) } async change( method: HistoryMethod, url: string, as: string, options: TransitionOptions ): Promise { if (!isLocalURL(url)) { window.location.href = url return false } if (!(options as any)._h) { this.isSsr = false } // marking route changes as a navigation start entry if (ST) { performance.mark('routeChange') } if (this._inFlightRoute) { this.abortComponentLoad(this._inFlightRoute) } const cleanedAs = hasBasePath(as) ? delBasePath(as) : as this._inFlightRoute = as // If the url change is only related to a hash change // We should not proceed. We should only change the state. // WARNING: `_h` is an internal option for handing Next.js client-side // hydration. Your app should _never_ use this property. It may change at // any time without notice. if (!(options as any)._h && this.onlyAHashChange(cleanedAs)) { this.asPath = cleanedAs Router.events.emit('hashChangeStart', as) // TODO: do we need the resolved href when only a hash change? this.changeState(method, url, as, options) this.scrollToHash(cleanedAs) this.notify(this.components[this.route]) Router.events.emit('hashChangeComplete', as) return true } // The build manifest needs to be loaded before auto-static dynamic pages // get their query parameters to allow ensuring they can be parsed properly // when rewritten to const pages = await this.pageLoader.getPageList() const { __rewrites: rewrites } = await this.pageLoader.promisedBuildManifest let parsed = parseRelativeUrl(url) let { pathname, query } = parsed parsed = this._resolveHref(parsed, pages) as typeof parsed if (parsed.pathname !== pathname) { pathname = parsed.pathname url = formatWithValidation(parsed) } // url and as should always be prefixed with basePath by this // point by either next/link or router.push/replace so strip the // basePath from the pathname to match the pages dir 1-to-1 pathname = pathname ? removePathTrailingSlash(delBasePath(pathname)) : pathname // If asked to change the current URL we should reload the current page // (not location.reload() but reload getInitialProps and other Next.js stuffs) // We also need to set the method = replaceState always // as this should not go into the history (That's how browsers work) // We should compare the new asPath to the current asPath, not the url if (!this.urlIsNew(cleanedAs)) { method = 'replaceState' } const route = removePathTrailingSlash(pathname) const { shallow = false } = options // we need to resolve the as value using rewrites for dynamic SSG // pages to allow building the data URL correctly let resolvedAs = as if (process.env.__NEXT_HAS_REWRITES) { resolvedAs = resolveRewrites( parseRelativeUrl(as).pathname, pages, basePath, rewrites, query, (p: string) => this._resolveHref({ pathname: p }, pages).pathname! ) } resolvedAs = delBasePath(resolvedAs) if (isDynamicRoute(route)) { const { pathname: asPathname } = parseRelativeUrl(resolvedAs) const routeRegex = getRouteRegex(route) const routeMatch = getRouteMatcher(routeRegex)(asPathname) if (!routeMatch) { const missingParams = Object.keys(routeRegex.groups).filter( (param) => !query[param] ) if (missingParams.length > 0) { if (process.env.NODE_ENV !== 'production') { console.warn( `Mismatching \`as\` and \`href\` failed to manually provide ` + `the params: ${missingParams.join( ', ' )} in the \`href\`'s \`query\`` ) } throw new Error( `The provided \`as\` value (${asPathname}) is incompatible with the \`href\` value (${route}). ` + `Read more: https://err.sh/vercel/next.js/incompatible-href-as` ) } } else if (route === asPathname) { as = interpolateAs(route, asPathname, query) } else { // Merge params into `query`, overwriting any specified in search Object.assign(query, routeMatch) } } Router.events.emit('routeChangeStart', as) try { const routeInfo = await this.getRouteInfo( route, pathname, query, as, shallow ) let { error } = routeInfo Router.events.emit('beforeHistoryChange', as) this.changeState(method, url, as, options) if (process.env.NODE_ENV !== 'production') { const appComp: any = this.components['/_app'].Component ;(window as any).next.isPrerendered = appComp.getInitialProps === appComp.origGetInitialProps && !(routeInfo.Component as any).getInitialProps } await this.set(route, pathname!, query, cleanedAs, routeInfo).catch( (e) => { if (e.cancelled) error = error || e else throw e } ) if (error) { Router.events.emit('routeChangeError', error, cleanedAs) throw error } if (process.env.__NEXT_SCROLL_RESTORATION) { if (manualScrollRestoration && '_N_X' in options) { window.scrollTo((options as any)._N_X, (options as any)._N_Y) } } Router.events.emit('routeChangeComplete', as) return true } catch (err) { if (err.cancelled) { return false } throw err } } changeState( method: HistoryMethod, url: string, as: string, options: TransitionOptions = {} ): void { if (process.env.NODE_ENV !== 'production') { if (typeof window.history === 'undefined') { console.error(`Warning: window.history is not available.`) return } if (typeof window.history[method] === 'undefined') { console.error(`Warning: window.history.${method} is not available`) return } } if (method !== 'pushState' || getURL() !== as) { this._shallow = options.shallow window.history[method]( { url, as, options, __N: true, } as HistoryState, // Most browsers currently ignores this parameter, although they may use it in the future. // Passing the empty string here should be safe against future changes to the method. // https://developer.mozilla.org/en-US/docs/Web/API/History/replaceState '', as ) } } async handleRouteInfoError( err: Error & { code: any; cancelled: boolean }, pathname: string, query: ParsedUrlQuery, as: string, loadErrorFail?: boolean ): Promise { if (err.cancelled) { // bubble up cancellation errors throw err } if (PAGE_LOAD_ERROR in err || loadErrorFail) { Router.events.emit('routeChangeError', err, as) // If we can't load the page it could be one of following reasons // 1. Page doesn't exists // 2. Page does exist in a different zone // 3. Internal error while loading the page // So, doing a hard reload is the proper way to deal with this. window.location.href = as // Changing the URL doesn't block executing the current code path. // So let's throw a cancellation error stop the routing logic. throw buildCancellationError() } try { const { page: Component, styleSheets } = await this.fetchComponent( '/_error' ) const routeInfo: PrivateRouteInfo = { Component, styleSheets, err, error: err, } try { routeInfo.props = await this.getInitialProps(Component, { err, pathname, query, } as any) } catch (gipErr) { console.error('Error in error page `getInitialProps`: ', gipErr) routeInfo.props = {} } return routeInfo } catch (routeInfoErr) { return this.handleRouteInfoError(routeInfoErr, pathname, query, as, true) } } async getRouteInfo( route: string, pathname: string, query: any, as: string, shallow: boolean = false ): Promise { try { const cachedRouteInfo = this.components[route] if (shallow && cachedRouteInfo && this.route === route) { return cachedRouteInfo } const routeInfo: PrivateRouteInfo = cachedRouteInfo ? cachedRouteInfo : await this.fetchComponent(route).then((res) => ({ Component: res.page, styleSheets: res.styleSheets, __N_SSG: res.mod.__N_SSG, __N_SSP: res.mod.__N_SSP, })) const { Component, __N_SSG, __N_SSP } = routeInfo if (process.env.NODE_ENV !== 'production') { const { isValidElementType } = require('react-is') if (!isValidElementType(Component)) { throw new Error( `The default export is not a React Component in page: "${pathname}"` ) } } let dataHref: string | undefined if (__N_SSG || __N_SSP) { dataHref = this.pageLoader.getDataHref( formatWithValidation({ pathname, query }), delBasePath(as), __N_SSG ) } const props = await this._getData(() => __N_SSG ? this._getStaticData(dataHref!) : __N_SSP ? this._getServerData(dataHref!) : this.getInitialProps( Component, // we provide AppTree later so this needs to be `any` { pathname, query, asPath: as, } as any ) ) routeInfo.props = props this.components[route] = routeInfo return routeInfo } catch (err) { return this.handleRouteInfoError(err, pathname, query, as) } } set( route: string, pathname: string, query: ParsedUrlQuery, as: string, data: PrivateRouteInfo ): Promise { this.isFallback = false this.route = route this.pathname = pathname this.query = query this.asPath = as return this.notify(data) } /** * Callback to execute before replacing router state * @param cb callback to be executed */ beforePopState(cb: BeforePopStateCallback) { this._bps = cb } onlyAHashChange(as: string): boolean { if (!this.asPath) return false const [oldUrlNoHash, oldHash] = this.asPath.split('#') const [newUrlNoHash, newHash] = as.split('#') // Makes sure we scroll to the provided hash if the url/hash are the same if (newHash && oldUrlNoHash === newUrlNoHash && oldHash === newHash) { return true } // If the urls are change, there's more than a hash change if (oldUrlNoHash !== newUrlNoHash) { return false } // If the hash has changed, then it's a hash only change. // This check is necessary to handle both the enter and // leave hash === '' cases. The identity case falls through // and is treated as a next reload. return oldHash !== newHash } scrollToHash(as: string): void { const [, hash] = as.split('#') // Scroll to top if the hash is just `#` with no value if (hash === '') { window.scrollTo(0, 0) return } // First we check if the element by id is found const idEl = document.getElementById(hash) if (idEl) { idEl.scrollIntoView() return } // If there's no element with the id, we check the `name` property // To mirror browsers const nameEl = document.getElementsByName(hash)[0] if (nameEl) { nameEl.scrollIntoView() } } urlIsNew(asPath: string): boolean { return this.asPath !== asPath } _resolveHref(parsedHref: UrlObject, pages: string[]) { const { pathname } = parsedHref const cleanPathname = removePathTrailingSlash( denormalizePagePath(delBasePath(pathname!)) ) if (cleanPathname === '/404' || cleanPathname === '/_error') { return parsedHref } // handle resolving href for dynamic routes if (!pages.includes(cleanPathname!)) { // eslint-disable-next-line array-callback-return pages.some((page) => { if ( isDynamicRoute(page) && getRouteRegex(page).re.test(cleanPathname!) ) { parsedHref.pathname = addBasePath(page) return true } }) } return parsedHref } /** * Prefetch page code, you may wait for the data during page rendering. * This feature only works in production! * @param url the href of prefetched page * @param asPath the as path of the prefetched page */ async prefetch( url: string, asPath: string = url, options: PrefetchOptions = {} ): Promise { let parsed = parseRelativeUrl(url) let { pathname } = parsed const pages = await this.pageLoader.getPageList() parsed = this._resolveHref(parsed, pages) as typeof parsed if (parsed.pathname !== pathname) { pathname = parsed.pathname url = formatWithValidation(parsed) } // Prefetch is not supported in development mode because it would trigger on-demand-entries if (process.env.NODE_ENV !== 'production') { return } const route = removePathTrailingSlash(pathname) await Promise.all([ this.pageLoader.prefetchData(url, asPath), this.pageLoader[options.priority ? 'loadPage' : 'prefetch'](route), ]) } async fetchComponent(route: string): Promise { let cancelled = false const cancel = (this.clc = () => { cancelled = true }) const componentResult = await this.pageLoader.loadPage(route) if (cancelled) { const error: any = new Error( `Abort fetching component for route: "${route}"` ) error.cancelled = true throw error } if (cancel === this.clc) { this.clc = null } return componentResult } _getData(fn: () => Promise): Promise { let cancelled = false const cancel = () => { cancelled = true } this.clc = cancel return fn().then((data) => { if (cancel === this.clc) { this.clc = null } if (cancelled) { const err: any = new Error('Loading initial props cancelled') err.cancelled = true throw err } return data }) } _getStaticData(dataHref: string): Promise { const { href: cacheKey } = new URL(dataHref, window.location.href) if (process.env.NODE_ENV === 'production' && this.sdc[cacheKey]) { return Promise.resolve(this.sdc[cacheKey]) } return fetchNextData(dataHref, this.isSsr).then((data) => { this.sdc[cacheKey] = data return data }) } _getServerData(dataHref: string): Promise { return fetchNextData(dataHref, this.isSsr) } getInitialProps( Component: ComponentType, ctx: NextPageContext ): Promise { const { Component: App } = this.components['/_app'] const AppTree = this._wrapApp(App as AppComponent) ctx.AppTree = AppTree return loadGetInitialProps>(App, { AppTree, Component, router: this, ctx, }) } abortComponentLoad(as: string): void { if (this.clc) { Router.events.emit('routeChangeError', buildCancellationError(), as) this.clc() this.clc = null } } notify(data: PrivateRouteInfo): Promise { return this.sub(data, this.components['/_app'].Component as AppComponent) } }