refactor: move redirect helpers into separate module (#73118)

Author: huozhi

packages/next/src/client/components/app-router.tsx

@@ -55,13 +55,8 @@ import { useNavFailureHandler } from './nav-failure-handler'
 import { useServerActionDispatcher } from '../app-call-server'
 import type { AppRouterActionQueue } from '../../shared/lib/router/action-queue'
 import { prefetch as prefetchWithSegmentCache } from '../components/segment-cache/prefetch'
-
-import {
-  getRedirectTypeFromError,
-  getURLFromRedirectError,
-  isRedirectError,
-  RedirectType,
-} from './redirect'
+import { getRedirectTypeFromError, getURLFromRedirectError } from './redirect'
+import { isRedirectError, RedirectType } from './redirect-error'
 
 const globalMutable: {
   pendingMpaPath?: string

packages/next/src/client/components/is-next-router-error.ts

@@ -2,7 +2,7 @@ import {
   isHTTPAccessFallbackError,
   type HTTPAccessFallbackError,
 } from './http-access-fallback/http-access-fallback'
-import { isRedirectError, type RedirectError } from './redirect'
+import { isRedirectError, type RedirectError } from './redirect-error'
 
 /**
  * Returns true if the error is a navigation signal error. These errors are

packages/next/src/client/components/navigation.react-server.ts

@@ -26,7 +26,8 @@ class ReadonlyURLSearchParams extends URLSearchParams {
   }
 }
 
-export { redirect, permanentRedirect, RedirectType } from './redirect'
+export { redirect, permanentRedirect } from './redirect'
+export { RedirectType } from './redirect-error'
 export { notFound } from './not-found'
 export { forbidden } from './forbidden'
 export { unauthorized } from './unauthorized'

packages/next/src/client/components/redirect-boundary.tsx

@@ -2,12 +2,8 @@
 import React, { useEffect } from 'react'
 import type { AppRouterInstance } from '../../shared/lib/app-router-context.shared-runtime'
 import { useRouter } from './navigation'
-import {
-  RedirectType,
-  getRedirectTypeFromError,
-  getURLFromRedirectError,
-  isRedirectError,
-} from './redirect'
+import { getRedirectTypeFromError, getURLFromRedirectError } from './redirect'
+import { RedirectType, isRedirectError } from './redirect-error'
 
 interface RedirectBoundaryProps {
   router: AppRouterInstance

packages/next/src/client/components/redirect-error.ts

@@ -0,0 +1,45 @@
+import { RedirectStatusCode } from './redirect-status-code'
+
+export const REDIRECT_ERROR_CODE = 'NEXT_REDIRECT'
+
+export enum RedirectType {
+  push = 'push',
+  replace = 'replace',
+}
+
+export type RedirectError = Error & {
+  digest: `${typeof REDIRECT_ERROR_CODE};${RedirectType};${string};${RedirectStatusCode};`
+}
+
+/**
+ * Checks an error to determine if it's an error generated by the
+ * `redirect(url)` helper.
+ *
+ * @param error the error that may reference a redirect error
+ * @returns true if the error is a redirect error
+ */
+export function isRedirectError(error: unknown): error is RedirectError {
+  if (
+    typeof error !== 'object' ||
+    error === null ||
+    !('digest' in error) ||
+    typeof error.digest !== 'string'
+  ) {
+    return false
+  }
+
+  const digest = error.digest.split(';')
+  const [errorCode, type] = digest
+  const destination = digest.slice(2, -2).join(';')
+  const status = digest.at(-2)
+
+  const statusCode = Number(status)
+
+  return (
+    errorCode === REDIRECT_ERROR_CODE &&
+    (type === 'replace' || type === 'push') &&
+    typeof destination === 'string' &&
+    !isNaN(statusCode) &&
+    statusCode in RedirectStatusCode
+  )
+}

packages/next/src/client/components/redirect.test.ts

@@ -1,4 +1,6 @@
-import { getURLFromRedirectError, isRedirectError, redirect } from './redirect'
+import { getURLFromRedirectError, redirect } from './redirect'
+import { isRedirectError } from './redirect-error'
+
 describe('test', () => {
   it('should throw a redirect error', () => {
     try {

packages/next/src/client/components/redirect.ts

@@ -1,16 +1,11 @@
 import { actionAsyncStorage } from '../../server/app-render/action-async-storage.external'
 import { RedirectStatusCode } from './redirect-status-code'
-
-const REDIRECT_ERROR_CODE = 'NEXT_REDIRECT'
-
-export enum RedirectType {
-  push = 'push',
-  replace = 'replace',
-}
-
-export type RedirectError = Error & {
-  digest: `${typeof REDIRECT_ERROR_CODE};${RedirectType};${string};${RedirectStatusCode};`
-}
+import {
+  RedirectType,
+  type RedirectError,
+  isRedirectError,
+  REDIRECT_ERROR_CODE,
+} from './redirect-error'
 
 export function getRedirectError(
   url: string,
@@ -68,39 +63,6 @@ export function permanentRedirect(
   throw getRedirectError(url, type, RedirectStatusCode.PermanentRedirect)
 }
 
-/**
- * Checks an error to determine if it's an error generated by the
- * `redirect(url)` helper.
- *
- * @param error the error that may reference a redirect error
- * @returns true if the error is a redirect error
- */
-export function isRedirectError(error: unknown): error is RedirectError {
-  if (
-    typeof error !== 'object' ||
-    error === null ||
-    !('digest' in error) ||
-    typeof error.digest !== 'string'
-  ) {
-    return false
-  }
-
-  const digest = error.digest.split(';')
-  const [errorCode, type] = digest
-  const destination = digest.slice(2, -2).join(';')
-  const status = digest.at(-2)
-
-  const statusCode = Number(status)
-
-  return (
-    errorCode === REDIRECT_ERROR_CODE &&
-    (type === 'replace' || type === 'push') &&
-    typeof destination === 'string' &&
-    !isNaN(statusCode) &&
-    statusCode in RedirectStatusCode
-  )
-}
-
 /**
  * Returns the encoded URL from the error if it's a RedirectError, null
  * otherwise. Note that this does not validate the URL returned.

packages/next/src/client/components/router-reducer/reducers/server-action-reducer.ts

@@ -47,7 +47,8 @@ import {
   normalizeFlightData,
   type NormalizedFlightData,
 } from '../../../flight-data-helpers'
-import { getRedirectError, RedirectType } from '../../redirect'
+import { getRedirectError } from '../../redirect'
+import { RedirectType } from '../../redirect-error'
 import { createSeededPrefetchCacheEntry } from '../prefetch-cache-utils'
 import { removeBasePath } from '../../../remove-base-path'
 import { hasBasePath } from '../../../has-base-path'

packages/next/src/server/app-render/action-handler.ts

@@ -18,9 +18,11 @@ import {
 import {
   getRedirectTypeFromError,
   getURLFromRedirectError,
+} from '../../client/components/redirect'
+import {
   isRedirectError,
   type RedirectType,
-} from '../../client/components/redirect'
+} from '../../client/components/redirect-error'
 import RenderResult from '../render-result'
 import type { WorkStore } from '../app-render/work-async-storage.external'
 import { FlightRenderResult } from './flight-render-result'

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

@@ -66,9 +66,9 @@ import {
 } from '../../client/components/http-access-fallback/http-access-fallback'
 import {
   getURLFromRedirectError,
-  isRedirectError,
   getRedirectStatusCodeFromError,
 } from '../../client/components/redirect'
+import { isRedirectError } from '../../client/components/redirect-error'
 import { getImplicitTags } from '../lib/implicit-tags'
 import { AppRenderSpan, NextNodeServerSpan } from '../lib/trace/constants'
 import { getTracer } from '../lib/trace/tracer'