Remove unstable_ prefix from unstable_notFound (#18283)

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> Co-authored-by: Joe Haddad <joe.haddad@zeit.co>
vercel · Oct 27, 2020 · 11fce3a · 11fce3a
1 parent 7cb68f7
commit 11fce3a
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 13 deletions.
diff --git a/packages/next/next-server/server/render.tsx b/packages/next/next-server/server/render.tsx
@@ -625,7 +625,7 @@ export async function renderToHTML(
           key !== 'revalidate' &&
           key !== 'props' &&
           key !== 'redirect' &&
-          key !== 'unstable_notFound'
+          key !== 'notFound'
       )
 
       if (invalidKeys.includes('unstable_revalidate')) {
@@ -636,10 +636,10 @@ export async function renderToHTML(
         throw new Error(invalidKeysMsg('getStaticProps', invalidKeys))
       }
 
-      if ('unstable_notFound' in data && data.unstable_notFound) {
+      if ('notFound' in data && data.notFound) {
         if (pathname === '/404') {
           throw new Error(
-            `The /404 page can not return unstable_notFound in "getStaticProps", please remove it to continue!`
+            `The /404 page can not return notFound in "getStaticProps", please remove it to continue!`
           )
         }
 
@@ -759,10 +759,14 @@ export async function renderToHTML(
       }
 
       const invalidKeys = Object.keys(data).filter(
-        (key) =>
-          key !== 'props' && key !== 'redirect' && key !== 'unstable_notFound'
+        (key) => key !== 'props' && key !== 'redirect' && key !== 'notFound'
       )
 
+      if ((data as any).unstable_notFound) {
+        throw new Error(
+          `unstable_notFound has been renamed to notFound, please update the field to continue. Page: ${pathname}`
+        )
+      }
       if ((data as any).unstable_redirect) {
         throw new Error(
           `unstable_redirect has been renamed to redirect, please update the field to continue. Page: ${pathname}`
@@ -773,10 +777,10 @@ export async function renderToHTML(
         throw new Error(invalidKeysMsg('getServerSideProps', invalidKeys))
       }
 
-      if ('unstable_notFound' in data) {
+      if ('notFound' in data) {
         if (pathname === '/404') {
           throw new Error(
-            `The /404 page can not return unstable_notFound in "getStaticProps", please remove it to continue!`
+            `The /404 page can not return notFound in "getStaticProps", please remove it to continue!`
           )
         }
 

diff --git a/packages/next/types/index.d.ts b/packages/next/types/index.d.ts
@@ -88,7 +88,7 @@ export type GetStaticPropsContext<Q extends ParsedUrlQuery = ParsedUrlQuery> = {
 export type GetStaticPropsResult<P> =
   | { props: P; revalidate?: number | boolean }
   | { redirect: Redirect; revalidate?: number | boolean }
-  | { unstable_notFound: true }
+  | { notFound: true }
 
 export type GetStaticProps<
   P extends { [key: string]: any } = { [key: string]: any },
@@ -133,7 +133,7 @@ export type GetServerSidePropsContext<
 export type GetServerSidePropsResult<P> =
   | { props: P }
   | { redirect: Redirect }
-  | { unstable_notFound: true }
+  | { notFound: true }
 
 export type GetServerSideProps<
   P extends { [key: string]: any } = { [key: string]: any },

diff --git a/test/integration/getserversideprops/pages/not-found/[slug].js b/test/integration/getserversideprops/pages/not-found/[slug].js
@@ -22,7 +22,7 @@ export default function Page(props) {
 export const getServerSideProps = ({ query }) => {
   if (query.hiding) {
     return {
-      unstable_notFound: true,
+      notFound: true,
     }
   }
 

diff --git a/test/integration/getserversideprops/pages/not-found/index.js b/test/integration/getserversideprops/pages/not-found/index.js
@@ -22,7 +22,7 @@ export default function Page(props) {
 export const getServerSideProps = ({ query }) => {
   if (query.hiding) {
     return {
-      unstable_notFound: true,
+      notFound: true,
     }
   }
 

diff --git a/test/integration/i18n-support/pages/not-found/fallback/[slug].js b/test/integration/i18n-support/pages/not-found/fallback/[slug].js
@@ -26,7 +26,7 @@ export default function Page(props) {
 export const getStaticProps = ({ params, locale, locales }) => {
   if (locale === 'en' || locale === 'nl') {
     return {
-      unstable_notFound: true,
+      notFound: true,
     }
   }
 

diff --git a/test/integration/i18n-support/pages/not-found/index.js b/test/integration/i18n-support/pages/not-found/index.js
@@ -24,7 +24,7 @@ export default function Page(props) {
 export const getStaticProps = ({ locale, locales }) => {
   if (locale === 'en' || locale === 'nl') {
     return {
-      unstable_notFound: true,
+      notFound: true,
     }
   }