Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove unstable_ prefix from unstable_notFound #18283

Merged
merged 6 commits into from Oct 27, 2020
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 11 additions & 7 deletions packages/next/next-server/server/render.tsx
Expand Up @@ -625,7 +625,7 @@ export async function renderToHTML(
key !== 'revalidate' &&
key !== 'props' &&
key !== 'redirect' &&
key !== 'unstable_notFound'
key !== 'notFound'
)

if (invalidKeys.includes('unstable_revalidate')) {
Expand All @@ -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!`
)
}

Expand Down Expand Up @@ -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}`
Expand All @@ -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!`
)
}

Expand Down
4 changes: 2 additions & 2 deletions packages/next/types/index.d.ts
Expand Up @@ -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 },
Expand Down Expand Up @@ -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 },
Expand Down
Expand Up @@ -22,7 +22,7 @@ export default function Page(props) {
export const getServerSideProps = ({ query }) => {
if (query.hiding) {
return {
unstable_notFound: true,
notFound: true,
}
}

Expand Down
Expand Up @@ -22,7 +22,7 @@ export default function Page(props) {
export const getServerSideProps = ({ query }) => {
if (query.hiding) {
return {
unstable_notFound: true,
notFound: true,
}
}

Expand Down
Expand Up @@ -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,
}
}

Expand Down
2 changes: 1 addition & 1 deletion test/integration/i18n-support/pages/not-found/index.js
Expand Up @@ -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,
}
}

Expand Down