Docs: Client side redirect() usage incompatible with error boundaries.

[staticshock]

What is the improvement or update you wish to see?

Right now the docs for the redirect() function say this:

redirect can be called in Client Components during the rendering process but not in event handlers.

Is there any context that might help us understand?

Since internally it's implemented as an exception, it's caught by error boundaries. I think that's worth calling out, because it almost completely negates the utility of ever using redirect() client-side.

I ran into this when I combined Sentry's ErrorBoundary with Next.js's redirect().

Does the docs page already exist? Please link to it.

https://nextjs.org/docs/app/building-your-application/routing/redirecting#redirect-function

[staticshock]

Actually, after some digging I see that Next.js internally uses an error boundary that is redirect-aware, but not in a way that I can re-use in my repo. Have you considered exporting RedirectBoundary so that devs can use it directly?

That would allow me to make an in-house error boundary in which the redirect always comes first:

export const MyErrorBoundary = ({
  children,
  ...props
}: SentryErrorBoundaryProps => (
  <SentryErrorBoundary {...props}>
    <NextRedirectBoundary>
      {children}
    </NextRedirectBoundary>
  </SentryErrorBoundary>
)

[AhmedBaset]

Have you considered exporting RedirectBoundary so that devs can use it directly?

Everything in next.js is importable. It's might not typed but it's still exported.

next.js/packages/next/package.json

Lines 11 to 12 in dcf8f04

	"files": [
	"dist",

Have you tried to import it?

[staticshock]

Oh, good call! This works:

import { RedirectBoundary } from 'next/dist/client/components/redirect-boundary'

[staticshock]

Ok, I've had a couple of days to play with it and I've come to the conclusion that even with the boundaries in place (as I've suggested above) this is still pretty error prone and should not be recommended as a pattern. I think the docs should discourage it.