Remove unstable_ prefix from unstable_redirect (#18282)

Author: ijjk

packages/next/next-server/server/render.tsx

@@ -624,7 +624,7 @@ export async function renderToHTML(
         (key) =>
           key !== 'revalidate' &&
           key !== 'props' &&
-          key !== 'unstable_redirect' &&
+          key !== 'redirect' &&
           key !== 'unstable_notFound'
       )
 
@@ -649,11 +649,11 @@ export async function renderToHTML(
       }
 
       if (
-        'unstable_redirect' in data &&
-        data.unstable_redirect &&
-        typeof data.unstable_redirect === 'object'
+        'redirect' in data &&
+        data.redirect &&
+        typeof data.redirect === 'object'
       ) {
-        checkRedirectValues(data.unstable_redirect, req)
+        checkRedirectValues(data.redirect, req)
 
         if (isBuildTimeSSG) {
           throw new Error(
@@ -664,10 +664,10 @@ export async function renderToHTML(
 
         if (isDataReq) {
           ;(data as any).props = {
-            __N_REDIRECT: data.unstable_redirect.destination,
+            __N_REDIRECT: data.redirect.destination,
           }
         } else {
-          handleRedirect(res, data.unstable_redirect)
+          handleRedirect(res, data.redirect)
           return null
         }
       }
@@ -760,11 +760,15 @@ export async function renderToHTML(
 
       const invalidKeys = Object.keys(data).filter(
         (key) =>
-          key !== 'props' &&
-          key !== 'unstable_redirect' &&
-          key !== 'unstable_notFound'
+          key !== 'props' && key !== 'redirect' && key !== 'unstable_notFound'
       )
 
+      if ((data as any).unstable_redirect) {
+        throw new Error(
+          `unstable_redirect has been renamed to redirect, please update the field to continue. Page: ${pathname}`
+        )
+      }
+
       if (invalidKeys.length) {
         throw new Error(invalidKeysMsg('getServerSideProps', invalidKeys))
       }
@@ -780,18 +784,15 @@ export async function renderToHTML(
         return null
       }
 
-      if (
-        'unstable_redirect' in data &&
-        typeof data.unstable_redirect === 'object'
-      ) {
-        checkRedirectValues(data.unstable_redirect, req)
+      if ('redirect' in data && typeof data.redirect === 'object') {
+        checkRedirectValues(data.redirect, req)
 
         if (isDataReq) {
           ;(data as any).props = {
-            __N_REDIRECT: data.unstable_redirect.destination,
+            __N_REDIRECT: data.redirect.destination,
           }
         } else {
-          handleRedirect(res, data.unstable_redirect)
+          handleRedirect(res, data.redirect)
           return null
         }
       }

packages/next/types/index.d.ts

@@ -87,7 +87,7 @@ export type GetStaticPropsContext<Q extends ParsedUrlQuery = ParsedUrlQuery> = {
 
 export type GetStaticPropsResult<P> =
   | { props: P; revalidate?: number | boolean }
-  | { unstable_redirect: Redirect; revalidate?: number | boolean }
+  | { redirect: Redirect; revalidate?: number | boolean }
   | { unstable_notFound: true }
 
 export type GetStaticProps<
@@ -132,7 +132,7 @@ export type GetServerSidePropsContext<
 
 export type GetServerSidePropsResult<P> =
   | { props: P }
-  | { unstable_redirect: Redirect }
+  | { redirect: Redirect }
   | { unstable_notFound: true }
 
 export type GetServerSideProps<

test/integration/gssp-redirect/pages/gsp-blog/[post].js

@@ -26,7 +26,7 @@ export const getStaticProps = ({ params }) => {
     }
 
     return {
-      unstable_redirect: {
+      redirect: {
         destination,
         permanent: params.post.includes('permanent'),
       },

test/integration/gssp-redirect/pages/gssp-blog/[post].js

@@ -16,7 +16,7 @@ export const getServerSideProps = ({ params }) => {
     }
 
     return {
-      unstable_redirect: {
+      redirect: {
         destination,
         permanent: params.post.includes('permanent'),
       },

test/integration/gssp-redirect/test/index.test.js

@@ -320,7 +320,7 @@ describe('GS(S)P Redirect Support', () => {
 
         export const getStaticProps = ({ params }) => {
           return {
-            unstable_redirect: {
+            redirect: {
               permanent: true,
               destination: '/another'
             }