render error fallback

vercel · Nov 14, 2024 · d99a6ec · d99a6ec
1 parent 8f91647
commit d99a6ec
Show file tree

Hide file tree

Showing 26 changed files with 157 additions and 407 deletions.
diff --git a/crates/next-core/src/app_structure.rs b/crates/next-core/src/app_structure.rs
@@ -864,7 +864,7 @@ fn directory_tree_to_loader_tree_internal(
     // the path).
     let is_root_layout = app_path.is_root() && modules.layout.is_some();
 
-    if (is_root_directory || is_root_layout) {
+    if is_root_directory || is_root_layout {
         if modules.not_found.is_none() {
             modules.not_found = Some(
                 get_next_package(app_dir).join("dist/client/components/not-found-error.js".into()),

diff --git a/packages/next/src/client/components/forbidden-error.tsx b/packages/next/src/client/components/forbidden-error.tsx
@@ -1,6 +1,6 @@
 import { HTTPAccessErrorFallback } from './http-access-fallback/error-fallback'
 
-export default function NotFound() {
+export default function Forbidden() {
   return (
     <HTTPAccessErrorFallback
       status={403}

diff --git a/packages/next/src/client/components/forbidden.ts b/packages/next/src/client/components/forbidden.ts
@@ -3,7 +3,6 @@ import {
   type HTTPAccessFallbackError,
 } from './http-access-fallback/http-access-fallback'
 
-
 // TODO: Add `forbidden` docs
 /**
  * @experimental
@@ -26,7 +25,9 @@ export function forbidden(): never {
     !process.env.__NEXT_TEST_MODE &&
     !process.env.NEXT_PRIVATE_SKIP_CANARY_CHECK
   ) {
-    throw new Error(`\`forbidden()\` is experimental and not allowed allowed to used in canary builds.`)
+    throw new Error(
+      `\`forbidden()\` is experimental and only allowed to be used in canary builds.`
+    )
   }
 
   // eslint-disable-next-line no-throw-literal

diff --git a/packages/next/src/client/components/http-access-fallback/error-boundary.tsx b/packages/next/src/client/components/http-access-fallback/error-boundary.tsx
@@ -13,10 +13,10 @@
 
 import React, { useContext } from 'react'
 import { useUntrackedPathname } from '../navigation-untracked'
-import { 
-  HTTPAccessErrorStatus, 
-  getAccessFallbackHTTPStatus, 
-  isHTTPAccessFallbackError
+import {
+  HTTPAccessErrorStatus,
+  getAccessFallbackHTTPStatus,
+  isHTTPAccessFallbackError,
 } from './http-access-fallback'
 import { warnOnce } from '../../../shared/lib/utils/warn-once'
 import { MissingSlotContext } from '../../../shared/lib/app-router-context.shared-runtime'
@@ -79,7 +79,6 @@ class HTTPAccessFallbackErrorBoundary extends React.Component<
   static getDerivedStateFromError(error: any) {
     if (isHTTPAccessFallbackError(error)) {
       const httpStatus = getAccessFallbackHTTPStatus(error)
-      console.log('get httpStatus', httpStatus)
       return {
         triggeredStatus: httpStatus,
       }
@@ -113,17 +112,23 @@ class HTTPAccessFallbackErrorBoundary extends React.Component<
   render() {
     const { notFound, forbidden, unauthorized } = this.props
     const { triggeredStatus } = this.state
-    console.log('render triggeredStatus', triggeredStatus, this.props)
     if (triggeredStatus) {
       return (
         <>
           <meta name="robots" content="noindex" />
           {process.env.NODE_ENV === 'development' && (
             <meta name="next-error" content="not-found" />
           )}
-          {(triggeredStatus === HTTPAccessErrorStatus.NOT_FOUND && notFound) ? notFound : null}
-          {(triggeredStatus === HTTPAccessErrorStatus.FORBIDDEN && forbidden) ? forbidden : null}
-          {(triggeredStatus === HTTPAccessErrorStatus.UNAUTHORIZED && unauthorized) ? unauthorized : null}
+          {triggeredStatus === HTTPAccessErrorStatus.NOT_FOUND && notFound
+            ? notFound
+            : null}
+          {triggeredStatus === HTTPAccessErrorStatus.FORBIDDEN && forbidden
+            ? forbidden
+            : null}
+          {triggeredStatus === HTTPAccessErrorStatus.UNAUTHORIZED &&
+          unauthorized
+            ? unauthorized
+            : null}
         </>
       )
     }

diff --git a/packages/next/src/client/components/layout-router.tsx b/packages/next/src/client/components/layout-router.tsx
@@ -498,6 +498,7 @@ export default function OuterLayoutRouter({
   template,
   notFound,
   forbidden,
+  unauthorized,
 }: {
   parallelRouterKey: string
   segmentPath: FlightSegmentPath
@@ -509,6 +510,7 @@ export default function OuterLayoutRouter({
   template: React.ReactNode
   notFound: React.ReactNode | undefined
   forbidden: React.ReactNode | undefined
+  unauthorized: React.ReactNode | undefined
 }) {
   const context = useContext(LayoutRouterContext)
   if (!context) {
@@ -570,7 +572,11 @@ export default function OuterLayoutRouter({
                     loadingStyles={loading?.[1]}
                     loadingScripts={loading?.[2]}
                   >
-                    <HTTPAccessFallbackBoundary notFound={notFound} forbidden={forbidden}>
+                    <HTTPAccessFallbackBoundary
+                      notFound={notFound}
+                      forbidden={forbidden}
+                      unauthorized={unauthorized}
+                    >
                       <RedirectBoundary>
                         <InnerLayoutRouter
                           parallelRouterKey={parallelRouterKey}

diff --git a/packages/next/src/client/components/unauthorized-error.tsx b/packages/next/src/client/components/unauthorized-error.tsx
@@ -1,10 +1,10 @@
 import { HTTPAccessErrorFallback } from './http-access-fallback/error-fallback'
 
-export default function NotFound() {
+export default function Unauthorized() {
   return (
     <HTTPAccessErrorFallback
       status={401}
-      message="This page is not authorized"
+      message="You're not authorized to access this page"
     />
   )
 }
diff --git a/packages/next/src/client/components/unauthorized.ts b/packages/next/src/client/components/unauthorized.ts
@@ -25,7 +25,9 @@ export function unauthorized(): never {
     !process.env.__NEXT_TEST_MODE &&
     !process.env.NEXT_PRIVATE_SKIP_CANARY_CHECK
   ) {
-    throw new Error(`\`unauthorized()\` is experimental and not allowed allowed to used in canary builds.`)
+    throw new Error(
+      `\`unauthorized()\` is experimental and only allowed to be used in canary builds.`
+    )
   }
 
   // eslint-disable-next-line no-throw-literal

diff --git a/packages/next/src/server/app-render/create-component-tree.tsx b/packages/next/src/server/app-render/create-component-tree.tsx
@@ -114,7 +114,15 @@ async function createComponentTreeInternal({
   const { page, layoutOrPagePath, segment, modules, parallelRoutes } =
     parseLoaderTree(tree)
 
-  const { layout, template, error, loading, 'not-found': notFound, forbidden } = modules
+  const {
+    layout,
+    template,
+    error,
+    loading,
+    'not-found': notFound,
+    forbidden,
+    unauthorized,
+  } = modules
 
   const injectedCSSWithCurrentLayout = new Set(injectedCSS)
   const injectedJSWithCurrentLayout = new Set(injectedJS)
@@ -194,7 +202,7 @@ async function createComponentTreeInternal({
         injectedJS: injectedJSWithCurrentLayout,
       })
     : []
-  
+
   const [Forbidden, forbiddenStyles] = forbidden
     ? await createComponentStylesAndScripts({
         ctx,
@@ -205,6 +213,16 @@ async function createComponentTreeInternal({
       })
     : []
 
+  const [Unauthorized, unauthorizedStyles] = unauthorized
+    ? await createComponentStylesAndScripts({
+        ctx,
+        filePath: unauthorized[1],
+        getComponent: unauthorized[0],
+        injectedCSS: injectedCSSWithCurrentLayout,
+        injectedJS: injectedJSWithCurrentLayout,
+      })
+    : []
+
   let dynamic = layoutOrPageMod?.dynamic
 
   if (nextConfigOutput === 'export') {
@@ -363,15 +381,23 @@ async function createComponentTreeInternal({
               <NotFound />
             </>
           ) : undefined
-        
-        const forbiddenComponent = 
+
+        const forbiddenComponent =
           Forbidden && isChildrenRouteKey ? (
             <>
               {forbiddenStyles}
               <Forbidden />
             </>
           ) : undefined
 
+        const unauthorizedComponent =
+          Unauthorized && isChildrenRouteKey ? (
+            <>
+              {unauthorizedStyles}
+              <Unauthorized />
+            </>
+          ) : undefined
+
         // if we're prefetching and that there's a Loading component, we bail out
         // otherwise we keep rendering for the prefetch.
         // We also want to bail out if there's no Loading component in the tree.
@@ -468,6 +494,7 @@ async function createComponentTreeInternal({
             templateScripts={templateScripts}
             notFound={notFoundComponent}
             forbidden={forbiddenComponent}
+            unauthorized={unauthorizedComponent}
           />,
           childCacheNodeSeedData,
         ]
@@ -640,6 +667,7 @@ async function createComponentTreeInternal({
         )
       }
 
+      // TODO: support forbidden and unauthorized in parallel routes
       if (isRootLayoutWithChildrenSlotAndAtLeastOneMoreSlot) {
         // TODO-APP: This is a hack to support unmatched parallel routes, which will throw `notFound()`.
         // This ensures that a `HTTPAccessFallbackBoundary` is available for when that happens,
@@ -662,20 +690,6 @@ async function createComponentTreeInternal({
               params={currentParams}
             />
           )
-          const forbiddenClientSegment = (
-            <ClientSegmentRoot
-              Component={SegmentComponent}
-              slots={{
-                children: (
-                  <>
-                    {forbiddenStyles}
-                    <Forbidden />
-                  </>
-                ),
-              }}
-              params={currentParams}
-            />
-          )
 
           segmentNode = (
             <HTTPAccessFallbackBoundary
@@ -717,6 +731,7 @@ async function createComponentTreeInternal({
         <SegmentComponent {...parallelRouteProps} params={params} />
       )
 
+      // TODO: support forbidden and unauthorized in parallel routes
       if (isRootLayoutWithChildrenSlotAndAtLeastOneMoreSlot) {
         // TODO-APP: This is a hack to support unmatched parallel routes, which will throw `notFound()`.
         // This ensures that a `HTTPAccessFallbackBoundary` is available for when that happens,

diff --git a/test/development/acceptance-app/hydration-error.test.ts b/test/development/acceptance-app/hydration-error.test.ts
@@ -457,8 +457,8 @@ describe('Error overlay for hydration errors in App router', () => {
               <InnerScrollAndFocusHandler segmentPath={[...]} focusAndScrollRef={{apply:false, ...}}>
                 <ErrorBoundary errorComponent={undefined} errorStyles={undefined} errorScripts={undefined}>
                   <LoadingBoundary hasLoading={false} loading={undefined} loadingStyles={undefined} loadingScripts={undefined}>
-                    <HTTPAccessFallbackBoundary notFound={[...]}>
-                      <HTTPAccessFallbackErrorBoundary pathname="/" notFound={[...]} missingSlots={Set}>
+                    <HTTPAccessFallbackBoundary notFound={[...]} forbidden={undefined} unauthorized={undefined}>
+                      <HTTPAccessFallbackErrorBoundary pathname="/" notFound={[...]} forbidden={undefined} ...>
                         <RedirectBoundary>
                           <RedirectErrorBoundary router={{...}}>
                             <InnerLayoutRouter parallelRouterKey="children" url="/" tree={[...]} childNodes={Map} ...>
@@ -927,7 +927,7 @@ describe('Error overlay for hydration errors in App router', () => {
     if (isTurbopack) {
       expect(fullPseudoHtml).toMatchInlineSnapshot(`
         "...
-          <HTTPAccessFallbackErrorBoundary pathname="/" notFound={[...]} missingSlots={Set}>
+          <HTTPAccessFallbackErrorBoundary pathname="/" notFound={[...]} forbidden={[...]} unauthorized={[...]} ...>
             <RedirectBoundary>
               <RedirectErrorBoundary router={{...}}>
                 <InnerLayoutRouter parallelRouterKey="children" url="/" tree={[...]} childNodes={Map} segmentPath={[...]} ...>
@@ -947,7 +947,7 @@ describe('Error overlay for hydration errors in App router', () => {
     } else {
       expect(fullPseudoHtml).toMatchInlineSnapshot(`
         "...
-          <HTTPAccessFallbackErrorBoundary pathname="/" notFound={[...]} missingSlots={Set}>
+          <HTTPAccessFallbackErrorBoundary pathname="/" notFound={[...]} forbidden={undefined} unauthorized={undefined} ...>
             <RedirectBoundary>
               <RedirectErrorBoundary router={{...}}>
                 <InnerLayoutRouter parallelRouterKey="children" url="/" tree={[...]} childNodes={Map} segmentPath={[...]} ...>

diff --git a/...mic-layout-without-not-found/[id]/page.js → ...mic-layout-without-forbidden/[id]/page.js b/...mic-layout-without-not-found/[id]/page.js → ...mic-layout-without-forbidden/[id]/page.js
diff --git a/...ynamic-layout-without-not-found/layout.js → ...ynamic-layout-without-forbidden/layout.js b/...ynamic-layout-without-not-found/layout.js → ...ynamic-layout-without-forbidden/layout.js
diff --git a/.../dynamic-layout-without-not-found/page.js → .../dynamic-layout-without-forbidden/page.js b/.../dynamic-layout-without-not-found/page.js → .../dynamic-layout-without-forbidden/page.js
diff --git a/test/e2e/app-dir/forbidden/basic/app/dynamic/[id]/forbidden.js b/test/e2e/app-dir/forbidden/basic/app/dynamic/[id]/forbidden.js
@@ -1,3 +1,3 @@
-export default function NotFound() {
+export default function Forbidden() {
   return <div id="forbidden">{`dynamic/[id] forbidden`}</div>
 }
diff --git a/test/e2e/app-dir/forbidden/basic/app/dynamic/[id]/page.js b/test/e2e/app-dir/forbidden/basic/app/dynamic/[id]/page.js
@@ -1,8 +1,5 @@
 import { forbidden } from 'next/navigation'
 
-// avoid static generation to fill the dynamic params
-export const dynamic = 'force-dynamic'
-
 export default async function Page(props) {
   const params = await props.params
 

diff --git a/test/e2e/app-dir/forbidden/basic/app/forbidden.js b/test/e2e/app-dir/forbidden/basic/app/forbidden.js
@@ -1,11 +1,9 @@
-export default function NotFound() {
+export default function Forbidden() {
   return (
     <>
-      <h1>Root Not Found</h1>
+      <h1>Root Forbidden</h1>
 
       <div id="timestamp">{Date.now()}</div>
     </>
   )
 }
-
-NotFound.displayName = 'NotFound'