next
Version:
The React Framework
165 lines (164 loc) • 6.67 kB
JavaScript
'use client';
import { jsx as _jsx } from "react/jsx-runtime";
import React, { startTransition, useContext } from 'react';
import { useUntrackedPathname } from './navigation-untracked';
import { isNextRouterError } from './is-next-router-error';
import { handleHardNavError } from './nav-failure-handler';
import { handleISRError } from './handle-isr-error';
import { isBot } from '../../shared/lib/router/utils/is-bot';
import { AppRouterContext } from '../../shared/lib/app-router-context.shared-runtime';
import { RouterContext as PagesRouterContext } from '../../shared/lib/router-context.shared-runtime';
const isBotUserAgent = typeof window !== 'undefined' && isBot(window.navigator.userAgent);
// This is forked from error-boundary.
// TODO: Extend it instead of forking to easily sync the behavior?
class CatchError extends React.Component {
static{
this.contextType = AppRouterContext;
}
static{
// `unstable_catchError()` is parsed as an HOC-style name and displays as
// a label (<name> [unstable_catchError]) in DevTools.
this.displayName = 'unstable_catchError(Next.CatchError)';
}
constructor(props){
super(props), this.reset = ()=>{
this.setState({
error: null
});
}, this.unstable_retry = ()=>{
if (this.props.isPagesRouter) {
throw Object.defineProperty(new Error('`unstable_retry()` can only be used in the App Router. Use `reset()` in the Pages Router.'), "__NEXT_ERROR_CODE", {
value: "E1138",
enumerable: false,
configurable: true
});
}
startTransition(()=>{
this.context?.refresh();
this.reset();
});
};
this.state = {
error: null,
previousPathname: this.props.pathname
};
}
static getDerivedStateFromError(error) {
if (isNextRouterError(error)) {
// Re-throw if an expected internal Next.js router error occurs
// this means it should be handled by a different boundary (such as a NotFound boundary in a parent segment)
throw error;
}
return {
error
};
}
static getDerivedStateFromProps(props, state) {
const { error } = state;
// if we encounter an error while
// a navigation is pending we shouldn't render
// the error boundary and instead should fallback
// to a hard navigation to attempt recovering
if (process.env.__NEXT_APP_NAV_FAIL_HANDLING) {
if (error && handleHardNavError(error)) {
// clear error so we don't render anything
return {
error: null,
previousPathname: props.pathname
};
}
}
/**
* Handles reset of the error boundary when a navigation happens.
* Ensures the error boundary does not stay enabled when navigating to a new page.
* Approach of setState in render is safe as it checks the previous pathname and then overrides
* it as outlined in https://react.dev/reference/react/useState#storing-information-from-previous-renders
*/ if (props.pathname !== state.previousPathname && state.error) {
return {
error: null,
previousPathname: props.pathname
};
}
return {
error: state.error,
previousPathname: props.pathname
};
}
// Explicit type is needed to avoid the generated `.d.ts` having a wide return type that could be specific to the `@types/react` version.
render() {
//When it's bot request, segment level error boundary will keep rendering the children,
// the final error will be caught by the root error boundary and determine wether need to apply graceful degrade.
if (this.state.error && !isBotUserAgent) {
handleISRError({
error: this.state.error
});
return /*#__PURE__*/ _jsx(this.props.fallback, {
props: this.props.props,
errorInfo: {
error: this.state.error,
reset: this.reset,
unstable_retry: this.unstable_retry
}
});
}
return this.props.children;
}
}
/**
* `unstable_catchError` is a counterpart to `error.js` that provides a granular
* control of error boundaries at the component level. It provides the `ErrorInfo`
* including `unstable_retry` for error recovery.
*
* Pass a Component-like fallback function that receives the props and `ErrorInfo`.
* The props omit `children` intentionally as it is the "fallback" of the error and
* is not expected to render the children.
*
* This API is must be used inside the client module graph and cannot be imported
* in `server-only` environments like proxy, instrumentation, etc.
*
* @example
* ```tsx
* // CustomErrorBoundary.tsx
* 'use client'
* import { unstable_catchError, type ErrorInfo } from 'next/error'
*
* function CustomErrorBoundary(props: Props, errorInfo: ErrorInfo) {
* return ...
* }
*
* export default unstable_catchError(CustomErrorBoundary)
*
* // page.tsx
* 'use client'
* import CustomErrorBoundary from './CustomErrorBoundary'
*
* export default function Page() {
* return (
* <CustomErrorBoundary>
* ...
* </CustomErrorBoundary>
* )
* }
* ```
*/ export function unstable_catchError(fallback) {
// Create Fallback component from the closure of `unstable_catchError`.
const Fallback = ({ props, errorInfo })=>fallback(props, errorInfo);
// Rename to match the user component name for DevTools.
Fallback.displayName = fallback.name || 'CatchErrorFallback';
return ({ children, ...props })=>{
// When we're rendering the missing params shell, this will return null. This
// is because we won't be rendering any not found boundaries or error
// boundaries for the missing params shell. When this runs on the client
// (where these errors can occur), we will get the correct pathname.
const pathname = useUntrackedPathname();
const isPagesRouter = useContext(PagesRouterContext) !== null;
return /*#__PURE__*/ _jsx(CatchError, {
pathname: pathname,
isPagesRouter: isPagesRouter,
fallback: Fallback,
props: props,
children: children
});
};
}
//# sourceMappingURL=catch-error.js.map