Common mistakes with the Next.js App Router and how to fix them

Link to headingUsing Route Handlers with Server Components

Consider the following code for a Server Component:

1
export default async function Page() {
2
  let res = await fetch('http://localhost:3000/api/data');
3
  let data = await res.json();
4
  return <h1>{JSON.stringify(data)}</h1>;
5
}

This async component makes a request to a Route Handler to retrieve some JSON data:

1
export async function GET(request: Request) {
2
  return Response.json({ data: 'Next.js' });
3
}

There's two main issues with this approach:

1. Both Route Handlers and Server Components run securely on the server. You don't need the additional network hop. Instead, you can call whatever logic you intended to place inside the Route Handler directly in the Server Component. This might be an external API or any Promise.

2. Since this code is running on the server with Node.js, we need to provide the absolute URL for the fetch versus a relative URL. In reality, we wouldn't hardcode localhost here, but instead need to have some conditional check based on the environment we're in. This is unnecessary since you can call the logic directly.

Instead, prefer to do the following:

1
export default async function Page() {
2
  // call your async function directly
3
  let data = await getData(); // { data: 'Next.js' }
4
  // or call an external API directly
5
  let data = await fetch('https://api.vercel.app/blog')
6
  // ...
7
}

Link to headingStatic or dynamic Route Handlers

Route Handlers are cached by default when using the GET method. This can often be confusing for existing Next.js developers moving from the Pages Router and API Routes.

For example, the following code will be prerendered during next build:

1
export async function GET(request: Request) {
2
  return Response.json({ data: 'Next.js' });
3
}

This JSON data will not change until another build has completed. Why is that?

You can consider Route Handlers the building blocks of pages. For a given request to a route, you want to handle it. Next.js has further abstractions on top of Route Handlers like pages and layouts. This is why Route Handlers are static by default (like pages) and share the same route segment configuration options.

This functionality unlocks some new features previously not possible with API Routes in the Pages Router. For example, you can have Route Handlers that produce JSON, or txt files, or really any file, which can be computed and prerendered during the build. The statically generated file is then automatically cached, and even periodically updated if desired.

1
export async function GET(request: Request) {
2
  let res = await fetch('https://api.vercel.app/blog');
3
  let data = await res.json();
4
  return Response.json(data);
5
}

Further, this means the Route Handlers are compatible with Static Exports where you can deploy your Next.js application anywhere that supports static file hosting.

Link to headingRoute Handlers and Client Components

You might think you need to use Route Handlers with Client Components, since they cannot be marked async and fetch or mutate data. Rather than needing to write a fetch and create a Route Handler, you can instead call Server Actions directly from Client Components.

1
'use client';
2
import { save } from './actions';
3
export function UserForm() {
4
  return (
5
    <form action={save}>
6
      <input type="text" name="username" />
7
      <button>Save</button>
8
    </form>
9
  );
10
}

This works with both forms as well as event handlers:

1
'use client';
2
import { save } from './actions';
3
export function UserForm({ username }) {
4
  async function onSave(event) {
5
    event.preventDefault();
6
    await save(username);
7
  }
8
  return <button onClick={onSave}>Save</button>;
9
}

Link to headingUsing Suspense with Server Components

Consider the following Server Component. Where should Suspense be placed to define what fallback UI will be shown while the data is being fetched?

1
async function BlogPosts() {
2
  let data = await fetch('https://api.vercel.app/blog');
3
  let posts = await data.json();
4
  return (
5
    <ul>
6
      {posts.map((post) => (
7
        <li key={post.id}>{post.title}</li>
8
      ))}
9
    </ul>
10
  );
11
}
12
export default function Page() {
13
  return (
14
    <section>
15
      <h1>Blog Posts</h1>
16
      <BlogPosts />
17
    </section>
18
  );
19
}

If you guessed inside of the Page component, you were correct. The Suspense boundary needs to be placed higher than the async component doing the data fetching. It will not work if the boundary is inside of the async component.

1
import { Suspense } from 'react';
2
async function BlogPosts() {
3
  let data = await fetch('https://api.vercel.app/blog');
4
  let posts = await data.json();
5
  return (
6
    <ul>
7
      {posts.map((post) => (
8
        <li key={post.id}>{post.title}</li>
9
      ))}
10
    </ul>
11
  );
12
}
13
export default function Page() {
14
  return (
15
    <section>
16
      <h1>Blog Posts</h1>
17
      <Suspense fallback={<p>Loading...</p>}>
18
        <BlogPosts />
19
      </Suspense>
20
    </section>
21
  );
22
}

In the future with Partial Prerendering, this pattern will start to become more common, including defining which components should be prerendered and which should run on-demand.

1
import { unstable_noStore as noStore } from 'next/cache';
2

3
async function BlogPosts() {
4
  noStore(); // This component should run dynamically
5
  let data = await fetch('https://api.vercel.app/blog');
6
  let posts = await data.json();
7
  return (
8
    <ul>
9
      {posts.map((post) => (
10
        <li key={post.id}>{post.title}</li>
11
      ))}
12
    </ul>
13
  );
14
}

Link to headingUsing the incoming request

Since the incoming request object is not able to be accessed from a Server Component, it might not be obvious how to read parts of the incoming request. This could lead to using client hooks like useSearchParams unnecessarily.

There are specific functions and props to the Server Component which allow you to access the incoming request. For example:

• cookies()

• headers()

• params

• searchParams

1
export default function Page({
2
  params,
3
  searchParams,
4
}: {
5
  params: { slug: string }
6
  searchParams: { [key: string]: string | string[] | undefined }
7
}) {
8
  return <h1>My Page</h1>
9
}

Link to headingUsing Context providers with App Router

You might want to use React Context or are using an external dependency which relies on context. Two common mistakes I've seen are trying to use context with Server Components (unsupported) and the placement of the provider in the App Router.

To allow for your Server and Client Components to interleave, it's important to make your provider (or multiple providers) be a separate Client Component which takes children as a prop and renders them. For example:

1
'use client';
2
import { createContext } from 'react';
3
export const ThemeContext = createContext({});
4
export default function ThemeProvider({
5
  children,
6
}: {
7
  children: React.ReactNode;
8
}) {
9
  return <ThemeContext.Provider value="dark">{children}</ThemeContext.Provider>;
10
}

Then, with your provider in a separate file as a Client Component, you can import and use this component inside of your layout:

1
import ThemeProvider from './theme-provider';
2
export default function RootLayout({
3
  children,
4
}: {
5
  children: React.ReactNode;
6
}) {
7
  return (
8
    <html>
9
      <body>
10
        <ThemeProvider>{children}</ThemeProvider>
11
      </body>
12
    </html>
13
  );
14
}

With the provider rendered at the root, all other Client Components throughout your app will be able to consume this context. And notably, this configuration still allows for other Server Components (including the page) lower in the tree.

Link to headingUsing Server and Client Components together

Many React and Next.js developers are learning how to use Server and Client Components for the first time. It's expected there might be some mistakes and opportunities to learn this new model!

For example, consider the following page:

1
export default function Page() {
2
  return (
3
    <section>
4
      <h1>My Page</h1>
5
    </section>
6
  );
7
}

This is a Server Component. While that comes with new functionality like being able to fetch data directly in the component, it also means certain client-side React functionalities aren't available.

For example, consider creating a button that is a counter. This would need to be a new Client Component file marked with the "use client" directive at the top:

1
'use client';
2
import { useState } from 'react';
3
export function Counter() {
4
  const [count, setCount] = useState(0);
5
  return (
6
    <div>
7
      <p>Count: {count}</p>
8
      <button onClick={() => setCount(count + 1)}>Increment</button>
9
    </div>
10
  );
11
}

You can then import and use this component in your page:

1
import { Counter } from './counter';
2
export default function Page() {
3
  return (
4
    <section>
5
      <h1>My Page</h1>
6
      <Counter />
7
    </section>
8
  );
9
}

The page is a Server Component and the <Counter> is a Client Component. Great! What about components lower in the tree than the counter? Can those be Server Components? Yes, through composition:

1
import { Counter } from './counter';
2
function Message() {
3
  return <p>This is a Server Component</p>;
4
}
5
export default function Page() {
6
  return (
7
    <section>
8
      <h1>My Page</h1>
9
      <Counter>
10
        <Message />
11
      </Counter>
12
    </section>
13
  );
14
}

Children of a Client Component can be a Server Component! Here's the updated counter:

1
'use client';
2
import { useState } from 'react';
3
export function Counter({ children }: { children: React.ReactNode }) {
4
  const [count, setCount] = useState(0);
5
  return (
6
    <div>
7
      <p>Count: {count}</p>
8
      <button onClick={() => setCount(count + 1)}>Increment</button>
9
      {children}
10
    </div>
11
  );
12
}

Link to headingAdding “use client” unnecessarily

Building off the previous example, does that mean that we need to add the "use client" directive everywhere?

When the "use client" directive is added, you pass into the "client boundary" giving you the ability to run client-side JavaScript (i.e. using React hooks or state). Client Components are still prerendered on the server, similar to components in the Next.js Pages Router.

Since you're already in the client boundary, siblings of the <Counter> would become Client Components. You don't need to add "use client" to every file. This might be an approach taken for incremental adoption of the App Router, where a component high up the tree becomes a Client Component and it becomes weave child Server Components further down.

Link to headingNot revalidating data after mutations

The Next.js App Router includes a complete model for fetching, caching, and revalidating data. As developers are still learning this new model, and we're continuing to make improvements based on their feedback, one common mistake I've seen is forgetting to revalidate data after a mutation.

For example, consider the following Server Component. It displays a form, which uses a Server Action to handle the submission and create a new entry in a Postgres database.

1
export default function Page() {
2
  async function create(formData: FormData) {
3
    'use server';
4
    let name = formData.get('name');
5
    await sql`INSERT INTO users (name) VALUES (${name})`;
6
  }
7
  return (
8
    <form action={create}>
9
      <input name="name" type="text" />
10
      <button type="submit">Create</button>
11
    </form>
12
  );
13
}

After the form is submitted and the insertion happens successfully, would the data displaying the list of names automatically update? No, not unless we tell Next.js to. For example:

1
import { revalidatePath } from 'next/cache';
2
export default async function Page() {
3
  let names = await sql`SELECT * FROM users`;
4
  async function create(formData: FormData) {
5
    'use server';
6
    let name = formData.get('name');
7
    await sql`INSERT INTO users (name) VALUES (${name})`;
8
    revalidatePath('/');
9
  }
10
  return (
11
    <section>
12
      <form action={create}>
13
        <input name="name" type="text" />
14
        <button type="submit">Create</button>
15
      </form>
16
      <ul>
17
        {names.map((name) => (
18
          <li>{name}</li>
19
        ))}
20
      </ul>
21
    </section>
22
  );
23
}

Link to headingRedirects inside of try/catch blocks

When running server-side code, like a Server Component or a Server Action, you might want to redirect if a resource is not available or after a successful mutation.

The redirect() function does not require you to use return redirect() as it uses the TypeScript never type. Further, internally this function throws a Next.js specific error. This means you should handle redirecting outside of try/catch blocks.

For example, if you are trying to redirect inside of a Server Component, it might look like this:

1
import { redirect } from 'next/navigation';
2
async function fetchTeam(id) {
3
  const res = await fetch('https://...');
4
  if (!res.ok) return undefined;
5
  return res.json();
6
}
7
export default async function Profile({ params }) {
8
  const team = await fetchTeam(params.id);
9
  if (!team) {
10
    redirect('/login');
11
  }
12
  // ...
13
}

Alternatively, if you're trying to redirect from a Client Component, this should happen inside of a Server Action and not in an event handler:

1
'use client';
2
import { navigate } from './actions';
3
export function ClientRedirect() {
4
  return (
5
    <form action={navigate}>
6
      <input type="text" name="id" />
7
      <button>Submit</button>
8
    </form>
9
  );
10
}

1
'use server';
2
import { redirect } from 'next/navigation';
3
export async function navigate(data: FormData) {
4
  redirect('/posts');
5
}

Link to headingConclusion

The Next.js App Router is a new approach for building React applications and there's a handful of new concepts to learn. If you've made any of these mistakes, don't feel discouraged. I've made them as well learning how the model works.

If you want to keep learning more and apply this knowledge, check out our Next.js Learn course to build a real dashboard application with the App Router.