next
Version:
The React Framework
1,049 lines • 78.7 kB
JavaScript
// tslint:disable:no-console
import { removeTrailingSlash } from "./utils/remove-trailing-slash";
import { getClientBuildManifest, isAssetError, markAssetError } from "../../../client/route-loader";
import { handleClientScriptLoad } from "../../../client/script";
import isError, { getProperError } from "../../../lib/is-error";
import { denormalizePagePath } from "../page-path/denormalize-page-path";
import { normalizeLocalePath } from "../i18n/normalize-locale-path";
import mitt from "../mitt";
import { getLocationOrigin, getURL, loadGetInitialProps, ST } from "../utils";
import { isDynamicRoute } from "./utils/is-dynamic";
import { parseRelativeUrl } from "./utils/parse-relative-url";
import resolveRewrites from "./utils/resolve-rewrites";
import { getRouteMatcher } from "./utils/route-matcher";
import { getRouteRegex } from "./utils/route-regex";
import { formatWithValidation } from "./utils/format-url";
import { detectDomainLocale } from "../../../client/detect-domain-locale";
import { parsePath } from "./utils/parse-path";
import { addLocale } from "../../../client/add-locale";
import { removeLocale } from "../../../client/remove-locale";
import { removeBasePath } from "../../../client/remove-base-path";
import { addBasePath } from "../../../client/add-base-path";
import { hasBasePath } from "../../../client/has-base-path";
import { isAPIRoute } from "../../../lib/is-api-route";
import { getNextPathnameInfo } from "./utils/get-next-pathname-info";
import { formatNextPathnameInfo } from "./utils/format-next-pathname-info";
import { compareRouterStates } from "./utils/compare-states";
import { isLocalURL } from "./utils/is-local-url";
import { isBot } from "./utils/is-bot";
import { omit } from "./utils/omit";
import { resolveHref } from "./utils/resolve-href";
import { interpolateAs } from "./utils/interpolate-as";
import { handleSmoothScroll } from "./utils/handle-smooth-scroll";
function buildCancellationError() {
return Object.assign(new Error("Route Cancelled"), {
cancelled: true
});
}
export async function matchesMiddleware(options) {
const matchers = await Promise.resolve(options.router.pageLoader.getMiddleware());
if (!matchers) return false;
const { pathname: asPathname } = parsePath(options.asPath);
// remove basePath first since path prefix has to be in the order of `/${basePath}/${locale}`
const cleanedAs = hasBasePath(asPathname) ? removeBasePath(asPathname) : asPathname;
const asWithBasePathAndLocale = addBasePath(addLocale(cleanedAs, options.locale));
// Check only path match on client. Matching "has" should be done on server
// where we can access more info such as headers, HttpOnly cookie, etc.
return matchers.some((m)=>new RegExp(m.regexp).test(asWithBasePathAndLocale));
}
function stripOrigin(url) {
const origin = getLocationOrigin();
return url.startsWith(origin) ? url.substring(origin.length) : url;
}
function prepareUrlAs(router, url, as) {
// If url and as provided as an object representation,
// we'll format them into the string version here.
let [resolvedHref, resolvedAs] = resolveHref(router, url, true);
const origin = getLocationOrigin();
const hrefWasAbsolute = resolvedHref.startsWith(origin);
const asWasAbsolute = resolvedAs && resolvedAs.startsWith(origin);
resolvedHref = stripOrigin(resolvedHref);
resolvedAs = resolvedAs ? stripOrigin(resolvedAs) : resolvedAs;
const preparedUrl = hrefWasAbsolute ? resolvedHref : addBasePath(resolvedHref);
const preparedAs = as ? stripOrigin(resolveHref(router, as)) : resolvedAs || resolvedHref;
return {
url: preparedUrl,
as: asWasAbsolute ? preparedAs : addBasePath(preparedAs)
};
}
function resolveDynamicRoute(pathname, pages) {
const cleanPathname = removeTrailingSlash(denormalizePagePath(pathname));
if (cleanPathname === "/404" || cleanPathname === "/_error") {
return pathname;
}
// 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)) {
pathname = page;
return true;
}
});
}
return removeTrailingSlash(pathname);
}
function getMiddlewareData(source, response, options) {
const nextConfig = {
basePath: options.router.basePath,
i18n: {
locales: options.router.locales
},
trailingSlash: Boolean(process.env.__NEXT_TRAILING_SLASH)
};
const rewriteHeader = response.headers.get("x-nextjs-rewrite");
let rewriteTarget = rewriteHeader || response.headers.get("x-nextjs-matched-path");
const matchedPath = response.headers.get("x-matched-path");
if (matchedPath && !rewriteTarget && !matchedPath.includes("__next_data_catchall") && !matchedPath.includes("/_error") && !matchedPath.includes("/404")) {
// leverage x-matched-path to detect next.config.js rewrites
rewriteTarget = matchedPath;
}
if (rewriteTarget) {
if (rewriteTarget.startsWith("/") || process.env.__NEXT_EXTERNAL_MIDDLEWARE_REWRITE_RESOLVE) {
const parsedRewriteTarget = parseRelativeUrl(rewriteTarget);
const pathnameInfo = getNextPathnameInfo(parsedRewriteTarget.pathname, {
nextConfig,
parseData: true
});
let fsPathname = removeTrailingSlash(pathnameInfo.pathname);
return Promise.all([
options.router.pageLoader.getPageList(),
getClientBuildManifest()
]).then((param)=>{
let [pages, { __rewrites: rewrites }] = param;
let as = addLocale(pathnameInfo.pathname, pathnameInfo.locale);
if (isDynamicRoute(as) || !rewriteHeader && pages.includes(normalizeLocalePath(removeBasePath(as), options.router.locales).pathname)) {
const parsedSource = getNextPathnameInfo(parseRelativeUrl(source).pathname, {
nextConfig: process.env.__NEXT_HAS_REWRITES ? undefined : nextConfig,
parseData: true
});
as = addBasePath(parsedSource.pathname);
parsedRewriteTarget.pathname = as;
}
if (process.env.__NEXT_HAS_REWRITES) {
const result = resolveRewrites(as, pages, rewrites, parsedRewriteTarget.query, (path)=>resolveDynamicRoute(path, pages), options.router.locales);
if (result.matchedPage) {
parsedRewriteTarget.pathname = result.parsedAs.pathname;
as = parsedRewriteTarget.pathname;
Object.assign(parsedRewriteTarget.query, result.parsedAs.query);
}
} else if (!pages.includes(fsPathname)) {
const resolvedPathname = resolveDynamicRoute(fsPathname, pages);
if (resolvedPathname !== fsPathname) {
fsPathname = resolvedPathname;
}
}
const resolvedHref = !pages.includes(fsPathname) ? resolveDynamicRoute(normalizeLocalePath(removeBasePath(parsedRewriteTarget.pathname), options.router.locales).pathname, pages) : fsPathname;
if (isDynamicRoute(resolvedHref)) {
const matches = getRouteMatcher(getRouteRegex(resolvedHref))(as);
Object.assign(parsedRewriteTarget.query, matches || {});
}
return {
type: "rewrite",
parsedAs: parsedRewriteTarget,
resolvedHref
};
});
}
const src = parsePath(source);
const pathname = formatNextPathnameInfo({
...getNextPathnameInfo(src.pathname, {
nextConfig,
parseData: true
}),
defaultLocale: options.router.defaultLocale,
buildId: ""
});
return Promise.resolve({
type: "redirect-external",
destination: "" + pathname + src.query + src.hash
});
}
const redirectTarget = response.headers.get("x-nextjs-redirect");
if (redirectTarget) {
if (redirectTarget.startsWith("/")) {
const src = parsePath(redirectTarget);
const pathname = formatNextPathnameInfo({
...getNextPathnameInfo(src.pathname, {
nextConfig,
parseData: true
}),
defaultLocale: options.router.defaultLocale,
buildId: ""
});
return Promise.resolve({
type: "redirect-internal",
newAs: "" + pathname + src.query + src.hash,
newUrl: "" + pathname + src.query + src.hash
});
}
return Promise.resolve({
type: "redirect-external",
destination: redirectTarget
});
}
return Promise.resolve({
type: "next"
});
}
async function withMiddlewareEffects(options) {
const matches = await matchesMiddleware(options);
if (!matches || !options.fetchData) {
return null;
}
try {
const data = await options.fetchData();
const effect = await getMiddlewareData(data.dataHref, data.response, options);
return {
dataHref: data.dataHref,
json: data.json,
response: data.response,
text: data.text,
cacheKey: data.cacheKey,
effect
};
} catch (e) {
/**
* TODO: Revisit this in the future.
* For now we will not consider middleware data errors to be fatal.
* maybe we should revisit in the future.
*/ return null;
}
}
const manualScrollRestoration = process.env.__NEXT_SCROLL_RESTORATION && typeof window !== "undefined" && "scrollRestoration" in window.history && !!function() {
try {
let v = "__next";
// eslint-disable-next-line no-sequences
return sessionStorage.setItem(v, v), sessionStorage.removeItem(v), true;
} catch (n) {}
}();
const SSG_DATA_NOT_FOUND = Symbol("SSG_DATA_NOT_FOUND");
function fetchRetry(url, attempts, options) {
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",
method: options.method || "GET",
headers: Object.assign({}, options.headers, {
"x-nextjs-data": "1"
})
}).then((response)=>{
return !response.ok && attempts > 1 && response.status >= 500 ? fetchRetry(url, attempts - 1, options) : response;
});
}
function tryToParseAsJSON(text) {
try {
return JSON.parse(text);
} catch (error) {
return null;
}
}
function fetchNextData(param) {
let { dataHref , inflightCache , isPrefetch , hasMiddleware , isServerRender , parseJSON , persistCache , isBackground , unstable_skipClientCache } = param;
const { href: cacheKey } = new URL(dataHref, window.location.href);
var _params_method;
const getData = (params)=>{
return fetchRetry(dataHref, isServerRender ? 3 : 1, {
headers: Object.assign({}, isPrefetch ? {
purpose: "prefetch"
} : {}, isPrefetch && hasMiddleware ? {
"x-middleware-prefetch": "1"
} : {}),
method: (_params_method = params == null ? void 0 : params.method) != null ? _params_method : "GET"
}).then((response)=>{
if (response.ok && (params == null ? void 0 : params.method) === "HEAD") {
return {
dataHref,
response,
text: "",
json: {},
cacheKey
};
}
return response.text().then((text)=>{
if (!response.ok) {
/**
* When the data response is a redirect because of a middleware
* we do not consider it an error. The headers must bring the
* mapped location.
* TODO: Change the status code in the handler.
*/ if (hasMiddleware && [
301,
302,
307,
308
].includes(response.status)) {
return {
dataHref,
response,
text,
json: {},
cacheKey
};
}
if (response.status === 404) {
var _tryToParseAsJSON;
if ((_tryToParseAsJSON = tryToParseAsJSON(text)) == null ? void 0 : _tryToParseAsJSON.notFound) {
return {
dataHref,
json: {
notFound: SSG_DATA_NOT_FOUND
},
response,
text,
cacheKey
};
}
}
const error = new Error("Failed to load static props");
/**
* 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) {
markAssetError(error);
}
throw error;
}
return {
dataHref,
json: parseJSON ? tryToParseAsJSON(text) : null,
response,
text,
cacheKey
};
});
}).then((data)=>{
if (!persistCache || process.env.NODE_ENV !== "production" || data.response.headers.get("x-middleware-cache") === "no-cache") {
delete inflightCache[cacheKey];
}
return data;
}).catch((err)=>{
if (!unstable_skipClientCache) {
delete inflightCache[cacheKey];
}
if (// chrome
err.message === "Failed to fetch" || // firefox
err.message === "NetworkError when attempting to fetch resource." || // safari
err.message === "Load failed") {
markAssetError(err);
}
throw err;
});
};
// when skipping client cache we wait to update
// inflight cache until successful data response
// this allows racing click event with fetching newer data
// without blocking navigation when stale data is available
if (unstable_skipClientCache && persistCache) {
return getData({}).then((data)=>{
inflightCache[cacheKey] = Promise.resolve(data);
return data;
});
}
if (inflightCache[cacheKey] !== undefined) {
return inflightCache[cacheKey];
}
return inflightCache[cacheKey] = getData(isBackground ? {
method: "HEAD"
} : {});
}
export function createKey() {
return Math.random().toString(36).slice(2, 10);
}
function handleHardNavigation(param) {
let { url , router } = param;
// ensure we don't trigger a hard navigation to the same
// URL as this can end up with an infinite refresh
if (url === addBasePath(addLocale(router.asPath, router.locale))) {
throw new Error("Invariant: attempted to hard navigate to the same URL " + url + " " + location.href);
}
window.location.href = url;
}
const getCancelledHandler = (param)=>{
let { route , router } = param;
let cancelled = false;
const cancel = router.clc = ()=>{
cancelled = true;
};
const handleCancelled = ()=>{
if (cancelled) {
const error = new Error('Abort fetching component for route: "' + route + '"');
error.cancelled = true;
throw error;
}
if (cancel === router.clc) {
router.clc = null;
}
};
return handleCancelled;
};
class Router {
reload() {
window.location.reload();
}
/**
* Go back in history
*/ back() {
window.history.back();
}
/**
* Go forward in history
*/ forward() {
window.history.forward();
}
/**
* 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, as, options) {
if (options === void 0) options = {};
if (process.env.__NEXT_SCROLL_RESTORATION) {
// TODO: remove in the future when we update history before route change
// is complete, as the popstate event should handle this capture.
if (manualScrollRestoration) {
try {
// Snapshot scroll position right before navigating to a new page:
sessionStorage.setItem("__next_scroll_" + this._key, JSON.stringify({
x: self.pageXOffset,
y: self.pageYOffset
}));
} catch (e) {}
}
}
({ 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, as, options) {
if (options === void 0) options = {};
({ url , as } = prepareUrlAs(this, url, as));
return this.change("replaceState", url, as, options);
}
async _bfl(as, resolvedAs, locale, skipNavigate) {
if (process.env.__NEXT_CLIENT_ROUTER_FILTER_ENABLED) {
let matchesBflStatic = false;
let matchesBflDynamic = false;
for (const curAs of [
as,
resolvedAs
]){
if (curAs) {
const asNoSlash = removeTrailingSlash(new URL(curAs, "http://n").pathname);
const asNoSlashLocale = addBasePath(addLocale(asNoSlash, locale || this.locale));
if (asNoSlash !== removeTrailingSlash(new URL(this.asPath, "http://n").pathname)) {
var _this__bfl_s, _this__bfl_s1;
matchesBflStatic = matchesBflStatic || !!((_this__bfl_s = this._bfl_s) == null ? void 0 : _this__bfl_s.contains(asNoSlash)) || !!((_this__bfl_s1 = this._bfl_s) == null ? void 0 : _this__bfl_s1.contains(asNoSlashLocale));
for (const normalizedAS of [
asNoSlash,
asNoSlashLocale
]){
// if any sub-path of as matches a dynamic filter path
// it should be hard navigated
const curAsParts = normalizedAS.split("/");
for(let i = 0; !matchesBflDynamic && i < curAsParts.length + 1; i++){
var _this__bfl_d;
const currentPart = curAsParts.slice(0, i).join("/");
if (currentPart && ((_this__bfl_d = this._bfl_d) == null ? void 0 : _this__bfl_d.contains(currentPart))) {
matchesBflDynamic = true;
break;
}
}
}
// if the client router filter is matched then we trigger
// a hard navigation
if (matchesBflStatic || matchesBflDynamic) {
if (skipNavigate) {
return true;
}
handleHardNavigation({
url: addBasePath(addLocale(as, locale || this.locale, this.defaultLocale)),
router: this
});
return new Promise(()=>{});
}
}
}
}
}
return false;
}
async change(method, url, as, options, forcedScroll) {
var _this_components_pathname;
if (!isLocalURL(url)) {
handleHardNavigation({
url,
router: this
});
return false;
}
// 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.
const isQueryUpdating = options._h === 1;
if (!isQueryUpdating && !options.shallow) {
await this._bfl(as, undefined, options.locale);
}
let shouldResolveHref = isQueryUpdating || options._shouldResolveHref || parsePath(url).pathname === parsePath(as).pathname;
const nextState = {
...this.state
};
// for static pages with query params in the URL we delay
// marking the router ready until after the query is updated
// or a navigation has occurred
const readyStateChange = this.isReady !== true;
this.isReady = true;
const isSsr = this.isSsr;
if (!isQueryUpdating) {
this.isSsr = false;
}
// if a route transition is already in progress before
// the query updating is triggered ignore query updating
if (isQueryUpdating && this.clc) {
return false;
}
const prevLocale = nextState.locale;
if (process.env.__NEXT_I18N_SUPPORT) {
nextState.locale = options.locale === false ? this.defaultLocale : options.locale || nextState.locale;
if (typeof options.locale === "undefined") {
options.locale = nextState.locale;
}
const parsedAs = parseRelativeUrl(hasBasePath(as) ? removeBasePath(as) : as);
const localePathResult = normalizeLocalePath(parsedAs.pathname, this.locales);
if (localePathResult.detectedLocale) {
nextState.locale = localePathResult.detectedLocale;
parsedAs.pathname = addBasePath(parsedAs.pathname);
as = formatWithValidation(parsedAs);
url = addBasePath(normalizeLocalePath(hasBasePath(url) ? removeBasePath(url) : url, this.locales).pathname);
}
let didNavigate = false;
// we need to wrap this in the env check again since regenerator runtime
// moves this on its own due to the return
if (process.env.__NEXT_I18N_SUPPORT) {
var _this_locales;
// if the locale isn't configured hard navigate to show 404 page
if (!((_this_locales = this.locales) == null ? void 0 : _this_locales.includes(nextState.locale))) {
parsedAs.pathname = addLocale(parsedAs.pathname, nextState.locale);
handleHardNavigation({
url: formatWithValidation(parsedAs),
router: this
});
// this was previously a return but was removed in favor
// of better dead code elimination with regenerator runtime
didNavigate = true;
}
}
const detectedDomain = detectDomainLocale(this.domainLocales, undefined, nextState.locale);
// we need to wrap this in the env check again since regenerator runtime
// moves this on its own due to the return
if (process.env.__NEXT_I18N_SUPPORT) {
// if we are navigating to a domain locale ensure we redirect to the
// correct domain
if (!didNavigate && detectedDomain && this.isLocaleDomain && self.location.hostname !== detectedDomain.domain) {
const asNoBasePath = removeBasePath(as);
handleHardNavigation({
url: "http" + (detectedDomain.http ? "" : "s") + "://" + detectedDomain.domain + addBasePath("" + (nextState.locale === detectedDomain.defaultLocale ? "" : "/" + nextState.locale) + (asNoBasePath === "/" ? "" : asNoBasePath) || "/"),
router: this
});
// this was previously a return but was removed in favor
// of better dead code elimination with regenerator runtime
didNavigate = true;
}
}
if (didNavigate) {
return new Promise(()=>{});
}
}
// marking route changes as a navigation start entry
if (ST) {
performance.mark("routeChange");
}
const { shallow =false , scroll =true } = options;
const routeProps = {
shallow
};
if (this._inFlightRoute && this.clc) {
if (!isSsr) {
Router.events.emit("routeChangeError", buildCancellationError(), this._inFlightRoute, routeProps);
}
this.clc();
this.clc = null;
}
as = addBasePath(addLocale(hasBasePath(as) ? removeBasePath(as) : as, options.locale, this.defaultLocale));
const cleanedAs = removeLocale(hasBasePath(as) ? removeBasePath(as) : as, nextState.locale);
this._inFlightRoute = as;
const localeChange = prevLocale !== nextState.locale;
// If the url change is only related to a hash change
// We should not proceed. We should only change the state.
if (!isQueryUpdating && this.onlyAHashChange(cleanedAs) && !localeChange) {
nextState.asPath = cleanedAs;
Router.events.emit("hashChangeStart", as, routeProps);
// TODO: do we need the resolved href when only a hash change?
this.changeState(method, url, as, {
...options,
scroll: false
});
if (scroll) {
this.scrollToHash(cleanedAs);
}
try {
await this.set(nextState, this.components[nextState.route], null);
} catch (err) {
if (isError(err) && err.cancelled) {
Router.events.emit("routeChangeError", err, cleanedAs, routeProps);
}
throw err;
}
Router.events.emit("hashChangeComplete", as, routeProps);
return true;
}
let parsed = parseRelativeUrl(url);
let { pathname , query } = parsed;
// if we detected the path as app route during prefetching
// trigger hard navigation
if ((_this_components_pathname = this.components[pathname]) == null ? void 0 : _this_components_pathname.__appRouter) {
handleHardNavigation({
url: as,
router: this
});
return new Promise(()=>{});
}
// 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
let pages, rewrites;
try {
[pages, { __rewrites: rewrites }] = await Promise.all([
this.pageLoader.getPageList(),
getClientBuildManifest(),
this.pageLoader.getMiddleware()
]);
} catch (err) {
// If we fail to resolve the page list or client-build manifest, we must
// do a server-side transition:
handleHardNavigation({
url: as,
router: this
});
return false;
}
// 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) && !localeChange) {
method = "replaceState";
}
// we need to resolve the as value using rewrites for dynamic SSG
// pages to allow building the data URL correctly
let resolvedAs = as;
// 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 ? removeTrailingSlash(removeBasePath(pathname)) : pathname;
let route = removeTrailingSlash(pathname);
const parsedAsPathname = as.startsWith("/") && parseRelativeUrl(as).pathname;
const isMiddlewareRewrite = !!(parsedAsPathname && route !== parsedAsPathname && (!isDynamicRoute(route) || !getRouteMatcher(getRouteRegex(route))(parsedAsPathname)));
// we don't attempt resolve asPath when we need to execute
// middleware as the resolving will occur server-side
const isMiddlewareMatch = !options.shallow && await matchesMiddleware({
asPath: as,
locale: nextState.locale,
router: this
});
if (isQueryUpdating && isMiddlewareMatch) {
shouldResolveHref = false;
}
if (shouldResolveHref && pathname !== "/_error") {
options._shouldResolveHref = true;
if (process.env.__NEXT_HAS_REWRITES && as.startsWith("/")) {
const rewritesResult = resolveRewrites(addBasePath(addLocale(cleanedAs, nextState.locale), true), pages, rewrites, query, (p)=>resolveDynamicRoute(p, pages), this.locales);
if (rewritesResult.externalDest) {
handleHardNavigation({
url: as,
router: this
});
return true;
}
if (!isMiddlewareMatch) {
resolvedAs = rewritesResult.asPath;
}
if (rewritesResult.matchedPage && rewritesResult.resolvedHref) {
// if this directly matches a page we need to update the href to
// allow the correct page chunk to be loaded
pathname = rewritesResult.resolvedHref;
parsed.pathname = addBasePath(pathname);
if (!isMiddlewareMatch) {
url = formatWithValidation(parsed);
}
}
} else {
parsed.pathname = resolveDynamicRoute(pathname, pages);
if (parsed.pathname !== pathname) {
pathname = parsed.pathname;
parsed.pathname = addBasePath(pathname);
if (!isMiddlewareMatch) {
url = formatWithValidation(parsed);
}
}
}
}
if (!isLocalURL(as)) {
if (process.env.NODE_ENV !== "production") {
throw new Error('Invalid href: "' + url + '" and as: "' + as + '", received relative href and external as' + "\nSee more info: https://nextjs.org/docs/messages/invalid-relative-url-external-as");
}
handleHardNavigation({
url: as,
router: this
});
return false;
}
resolvedAs = removeLocale(removeBasePath(resolvedAs), nextState.locale);
route = removeTrailingSlash(pathname);
let routeMatch = false;
if (isDynamicRoute(route)) {
const parsedAs = parseRelativeUrl(resolvedAs);
const asPathname = parsedAs.pathname;
const routeRegex = getRouteRegex(route);
routeMatch = getRouteMatcher(routeRegex)(asPathname);
const shouldInterpolate = route === asPathname;
const interpolatedAs = shouldInterpolate ? interpolateAs(route, asPathname, query) : {};
if (!routeMatch || shouldInterpolate && !interpolatedAs.result) {
const missingParams = Object.keys(routeRegex.groups).filter((param)=>!query[param] && !routeRegex.groups[param].optional);
if (missingParams.length > 0 && !isMiddlewareMatch) {
if (process.env.NODE_ENV !== "production") {
console.warn("" + (shouldInterpolate ? "Interpolating href" : "Mismatching `as` and `href`") + " failed to manually provide " + ("the params: " + missingParams.join(", ") + " in the `href`'s `query`"));
}
throw new Error((shouldInterpolate ? "The provided `href` (" + url + ") value is missing query values (" + missingParams.join(", ") + ") to be interpolated properly. " : "The provided `as` value (" + asPathname + ") is incompatible with the `href` value (" + route + "). ") + ("Read more: https://nextjs.org/docs/messages/" + (shouldInterpolate ? "href-interpolation-failed" : "incompatible-href-as")));
}
} else if (shouldInterpolate) {
as = formatWithValidation(Object.assign({}, parsedAs, {
pathname: interpolatedAs.result,
query: omit(query, interpolatedAs.params)
}));
} else {
// Merge params into `query`, overwriting any specified in search
Object.assign(query, routeMatch);
}
}
if (!isQueryUpdating) {
Router.events.emit("routeChangeStart", as, routeProps);
}
const isErrorRoute = this.pathname === "/404" || this.pathname === "/_error";
try {
var _self___NEXT_DATA___props, _self___NEXT_DATA___props_pageProps, _routeInfo_props;
let routeInfo = await this.getRouteInfo({
route,
pathname,
query,
as,
resolvedAs,
routeProps,
locale: nextState.locale,
isPreview: nextState.isPreview,
hasMiddleware: isMiddlewareMatch,
unstable_skipClientCache: options.unstable_skipClientCache,
isQueryUpdating: isQueryUpdating && !this.isFallback,
isMiddlewareRewrite
});
if (!isQueryUpdating && !options.shallow) {
await this._bfl(as, "resolvedAs" in routeInfo ? routeInfo.resolvedAs : undefined, nextState.locale);
}
if ("route" in routeInfo && isMiddlewareMatch) {
pathname = routeInfo.route || route;
route = pathname;
if (!routeProps.shallow) {
query = Object.assign({}, routeInfo.query || {}, query);
}
const cleanedParsedPathname = hasBasePath(parsed.pathname) ? removeBasePath(parsed.pathname) : parsed.pathname;
if (routeMatch && pathname !== cleanedParsedPathname) {
Object.keys(routeMatch).forEach((key)=>{
if (routeMatch && query[key] === routeMatch[key]) {
delete query[key];
}
});
}
if (isDynamicRoute(pathname)) {
const prefixedAs = !routeProps.shallow && routeInfo.resolvedAs ? routeInfo.resolvedAs : addBasePath(addLocale(new URL(as, location.href).pathname, nextState.locale), true);
let rewriteAs = prefixedAs;
if (hasBasePath(rewriteAs)) {
rewriteAs = removeBasePath(rewriteAs);
}
if (process.env.__NEXT_I18N_SUPPORT) {
const localeResult = normalizeLocalePath(rewriteAs, this.locales);
nextState.locale = localeResult.detectedLocale || nextState.locale;
rewriteAs = localeResult.pathname;
}
const routeRegex = getRouteRegex(pathname);
const curRouteMatch = getRouteMatcher(routeRegex)(new URL(rewriteAs, location.href).pathname);
if (curRouteMatch) {
Object.assign(query, curRouteMatch);
}
}
}
// If the routeInfo brings a redirect we simply apply it.
if ("type" in routeInfo) {
if (routeInfo.type === "redirect-internal") {
return this.change(method, routeInfo.newUrl, routeInfo.newAs, options);
} else {
handleHardNavigation({
url: routeInfo.destination,
router: this
});
return new Promise(()=>{});
}
}
const component = routeInfo.Component;
if (component && component.unstable_scriptLoader) {
const scripts = [].concat(component.unstable_scriptLoader());
scripts.forEach((script)=>{
handleClientScriptLoad(script.props);
});
}
// handle redirect on client-transition
if ((routeInfo.__N_SSG || routeInfo.__N_SSP) && routeInfo.props) {
if (routeInfo.props.pageProps && routeInfo.props.pageProps.__N_REDIRECT) {
// Use the destination from redirect without adding locale
options.locale = false;
const destination = routeInfo.props.pageProps.__N_REDIRECT;
// check if destination is internal (resolves to a page) and attempt
// client-navigation if it is falling back to hard navigation if
// it's not
if (destination.startsWith("/") && routeInfo.props.pageProps.__N_REDIRECT_BASE_PATH !== false) {
const parsedHref = parseRelativeUrl(destination);
parsedHref.pathname = resolveDynamicRoute(parsedHref.pathname, pages);
const { url: newUrl , as: newAs } = prepareUrlAs(this, destination, destination);
return this.change(method, newUrl, newAs, options);
}
handleHardNavigation({
url: destination,
router: this
});
return new Promise(()=>{});
}
nextState.isPreview = !!routeInfo.props.__N_PREVIEW;
// handle SSG data 404
if (routeInfo.props.notFound === SSG_DATA_NOT_FOUND) {
let notFoundRoute;
try {
await this.fetchComponent("/404");
notFoundRoute = "/404";
} catch (_) {
notFoundRoute = "/_error";
}
routeInfo = await this.getRouteInfo({
route: notFoundRoute,
pathname: notFoundRoute,
query,
as,
resolvedAs,
routeProps: {
shallow: false
},
locale: nextState.locale,
isPreview: nextState.isPreview,
isNotFound: true
});
if ("type" in routeInfo) {
throw new Error("Unexpected middleware effect on /404");
}
}
}
if (isQueryUpdating && this.pathname === "/_error" && ((_self___NEXT_DATA___props = self.__NEXT_DATA__.props) == null ? void 0 : (_self___NEXT_DATA___props_pageProps = _self___NEXT_DATA___props.pageProps) == null ? void 0 : _self___NEXT_DATA___props_pageProps.statusCode) === 500 && ((_routeInfo_props = routeInfo.props) == null ? void 0 : _routeInfo_props.pageProps)) {
// ensure statusCode is still correct for static 500 page
// when updating query information
routeInfo.props.pageProps.statusCode = 500;
}
var _routeInfo_route;
// shallow routing is only allowed for same page URL changes.
const isValidShallowRoute = options.shallow && nextState.route === ((_routeInfo_route = routeInfo.route) != null ? _routeInfo_route : route);
var _options_scroll;
const shouldScroll = (_options_scroll = options.scroll) != null ? _options_scroll : !isQueryUpdating && !isValidShallowRoute;
const resetScroll = shouldScroll ? {
x: 0,
y: 0
} : null;
const upcomingScrollState = forcedScroll != null ? forcedScroll : resetScroll;
// the new state that the router gonna set
const upcomingRouterState = {
...nextState,
route,
pathname,
query,
asPath: cleanedAs,
isFallback: false
};
// When the page being rendered is the 404 page, we should only update the
// query parameters. Route changes here might add the basePath when it
// wasn't originally present. This is also why this block is before the
// below `changeState` call which updates the browser's history (changing
// the URL).
if (isQueryUpdating && isErrorRoute) {
var _self___NEXT_DATA___props1, _self___NEXT_DATA___props_pageProps1, _routeInfo_props1;
routeInfo = await this.getRouteInfo({
route: this.pathname,
pathname: this.pathname,
query,
as,
resolvedAs,
routeProps: {
shallow: false
},
locale: nextState.locale,
isPreview: nextState.isPreview,
isQueryUpdating: isQueryUpdating && !this.isFallback
});
if ("type" in routeInfo) {
throw new Error("Unexpected middleware effect on " + this.pathname);
}
if (this.pathname === "/_error" && ((_self___NEXT_DATA___props1 = self.__NEXT_DATA__.props) == null ? void 0 : (_self___NEXT_DATA___props_pageProps1 = _self___NEXT_DATA___props1.pageProps) == null ? void 0 : _self___NEXT_DATA___props_pageProps1.statusCode) === 500 && ((_routeInfo_props1 = routeInfo.props) == null ? void 0 : _routeInfo_props1.pageProps)) {
// ensure statusCode is still correct for static 500 page
// when updating query information
routeInfo.props.pageProps.statusCode = 500;
}
try {
await this.set(upcomingRouterState, routeInfo, upcomingScrollState);
} catch (err) {
if (isError(err) && err.cancelled) {
Router.events.emit("routeChangeError", err, cleanedAs, routeProps);
}
throw err;
}
return true;
}
Router.events.emit("beforeHistoryChange", as, routeProps);
this.changeState(method, url, as, options);
// for query updates we can skip it if the state is unchanged and we don't
// need to scroll
// https://github.com/vercel/next.js/issues/37139
const canSkipUpdating = isQueryUpdating && !upcomingScrollState && !readyStateChange && !localeChange && compareRouterStates(upcomingRouterState, this.state);
if (!canSkipUpdating) {
try {
await this.set(upcomingRouterState, routeInfo, upcomingScrollState);
} catch (e) {
if (e.cancelled) routeInfo.error = routeInfo.error || e;
else throw e;
}
if (routeInfo.error) {
if (!isQueryUpdating) {
Router.events.emit("routeChangeError", routeInfo.error, cleanedAs, routeProps);
}
throw routeInfo.error;
}
if (process.env.__NEXT_I18N_SUPPORT) {
if (nextState.locale) {
document.documentElement.lang = nextState.locale;
}
}
if (!isQueryUpdating) {
Router.events.emit("routeChangeComplete", as, routeProps);
}
// A hash mark # is the optional last part of a URL
const hashRegex = /#.+$/;
if (shouldScroll && hashRegex.test(as)) {
this.scrollToHash(as);
}
}
return true;
} catch (err) {
if (isError(err) && err.cancelled) {
return false;
}
throw err;
}
}
changeState(method, url, as, options) {
if (options === void 0) options = {};
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,
key: this._key = method !== "pushState" ? this._key : createKey()
}, // 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, pathname, query, as, routeProps, loadErrorFail) {
console.error(err);
if (err.cancelled) {
// bubble up cancellation errors
throw err;
}
if (isAssetError(err) || loadErrorFail) {
Router.events.emit("routeChangeError", err, as, routeProps);
// 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.
handleHardNavigation({
url: as,
router: this
});
// 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 {
let props;
const { page: Component , styleSheets } = await this.fetchComponent("/_error");
const routeInfo = {
props,
Component,
styleSheets,
err,
error: err
};
if (!routeInfo.props) {
try {
routeInfo.props = await this.getInitialProps(Component, {
err,
pathname,
query
});
} catch (gipErr) {
console.error("Error in error page `getInitialProps`: ", gipErr);
routeInfo.props = {};
}
}
return routeInfo;
} catch (routeInfoErr) {
return this.handleRouteInfoError(isError(routeInfoErr) ? routeInfoErr : new Error(routeInfoErr + ""), pathname, query, as, routeProps, true);
}
}
async getRouteInfo(param) {
let { route: requestedRoute , pathname , query , as , resolvedAs , routeProps , locale , hasMiddleware , isPreview , unstable_skipClientCache , isQueryUpdating , isMiddlewareRewrite , isNotFound } = param;
/**
* This `route` binding can change if there's a rewrite
* so we keep a reference to the original requested route
* so we can store th