Testing server components in NextJS - Mini Project: Build & Apply

Testing server components

📖 Scenario: You are building a Next.js app that uses server components to fetch and display user data from a simple data source.To ensure your server component works correctly, you want to write a test that checks the rendered output matches the expected user name.

🎯 Goal: Create a server component that fetches user data and renders the user's name. Then write a test to verify the component output contains the correct user name.

📋 What You'll Learn

Create a server component named UserProfile that returns a heading with the user's name.

Use a simple user data object with name property set to 'Alice'.

Write a test using @testing-library/react and @testing-library/jest-dom to check the rendered output.

Ensure the test imports and renders the UserProfile server component correctly.

💡 Why This Matters

🌍 Real World

Testing server components ensures your Next.js app renders correct data before deployment, preventing bugs in production.

💼 Career

Knowing how to test server components is essential for Next.js developers to maintain reliable and maintainable codebases.

1

Create user data object

Create a constant called user with an object containing the key name set to the string 'Alice'.

NextJS

# Create a constant user with name 'Alice'
# Your code here

Hint

Use const user = { name: 'Alice' } to create the user object.

2

Create UserProfile server component

Create a server component named UserProfile that returns a JSX heading <h1> containing the user's name from the user object.

NextJS

const user = { name: 'Alice' }

// Create UserProfile server component that returns {user.name}
// Your code here

Hint

Define a function named UserProfile that returns <h1>{user.name}</h1>.

3

Write test for UserProfile component

Write a test named 'renders user name' that imports UserProfile and uses @testing-library/react to render it. Then use screen.getByRole('heading') and expect with toHaveTextContent('Alice') to verify the heading text.

NextJS

const user = { name: 'Alice' }

export default function UserProfile() {
  return {user.name}
}

// Write a test named 'renders user name' to check the heading text
// Your code here

Hint

Use render to render <UserProfile /> and screen.getByRole('heading') to find the heading. Then check text content with expect(...).toHaveTextContent('Alice').

4

Export UserProfile and finalize test file

Ensure the UserProfile component is exported as default and the test is included in the same file. The file should import @testing-library/react, @testing-library/jest-dom, and export UserProfile as default.

NextJS

import { render, screen } from '@testing-library/react'
import '@testing-library/jest-dom'
import UserProfile from './UserProfile'

const user = { name: 'Alice' }

export default function UserProfile() {
  return {user.name}
}

// Confirm export default and test are present
// Your code here

Hint

Make sure UserProfile is exported as default and the test is included in the file.

Practice

1. What is the main reason to write tests for Next.js server components?

easy

A. To catch errors early and keep the app stable

B. To improve client-side rendering speed

C. To reduce the size of the JavaScript bundle sent to the browser

D. To enable hot module replacement during development

Solution

1. Step 1: Understand the purpose of testing server components

   Testing server components helps find bugs before the app runs in production, ensuring stability.

2. Step 2: Compare options with testing goals

   Only catching errors early and keeping the app stable matches the main goal of testing server components.

3. Final Answer:

   To catch errors early and keep the app stable -> Option A

4. Quick Check:

   Testing purpose = catch errors early [OK]

Hint: Testing server components mainly prevents bugs early [OK]

Common Mistakes:

• Confusing testing with client-side performance optimization
• Thinking tests reduce bundle size
• Mixing testing with development tooling features

2. Which of the following is the correct way to import the render function for testing a Next.js server component using @testing-library/react?

easy

A. import { renderComponent } from '@testing-library/react';

B. import render from '@testing-library/react';

C. import { renderServer } from '@testing-library/react';

D. import { render } from '@testing-library/react';

Solution

1. Step 1: Recall the correct import syntax

   The official way to import render is using named import: { render } from '@testing-library/react'.

2. Step 2: Check other options for correctness

   Options A, B, and D use incorrect import names or default import which is not supported.

3. Final Answer:

   import { render } from '@testing-library/react'; -> Option D

4. Quick Check:

   Correct import = named render [OK]

Hint: Use named import { render } from testing-library [OK]

Common Mistakes:

• Using default import instead of named import
• Using wrong function names like renderComponent
• Assuming renderServer exists in the library

3. Given this server component test code, what will be the output of the test?

import { render } from '@testing-library/react';
import Greeting from './Greeting';

test('renders greeting message', () => {
  const { getByText } = render();
  getByText('Hello, Alice!');
});

Assuming Greeting renders Hello, {name}! correctly.

medium

A. Test fails because the component does not render

B. Test fails because getByText is not a function

C. Test passes because the text 'Hello, Alice!' is found

D. Test passes but does not check the text content

Solution

1. Step 1: Understand what getByText does

   getByText searches the rendered output for the exact text. If found, it returns the element; otherwise, it throws an error.

2. Step 2: Analyze the test code behavior

   The test renders Greeting with name 'Alice', so it should render 'Hello, Alice!'. getByText('Hello, Alice!') will find this text, so no error is thrown and test passes.

3. Final Answer:

   Test passes because the text 'Hello, Alice!' is found -> Option C

4. Quick Check:

   getByText finds text = test passes [OK]

Hint: getByText throws error if text missing, else test passes [OK]

Common Mistakes:

• Assuming getByText returns null instead of throwing error
• Thinking render does not work on server components
• Ignoring that test fails if text not found

4. You wrote this test for a server component but it fails with "TypeError: Cannot read property 'props' of undefined". What is the likely cause?

import { render } from '@testing-library/react';
import UserProfile from './UserProfile';

test('renders user name', () => {
  const { getByText } = render(UserProfile({ name: 'Bob' }));
  getByText('User: Bob');
});

medium

A. You forgot to import React in the test file

B. You called the component as a function instead of as JSX

C. You used getByText incorrectly without await

D. You passed props with wrong property name

Solution

1. Step 1: Identify how the component is rendered

   The test calls UserProfile({ name: 'Bob' }) directly as a function instead of using JSX syntax <UserProfile name="Bob" /> inside render.

2. Step 2: Understand why this causes error

   Server components expect JSX usage for rendering. Calling as function returns undefined or unexpected value, causing TypeError when render tries to access props.

3. Final Answer:

   You called the component as a function instead of as JSX -> Option B

4. Quick Check:

   Render needs JSX, not direct function call [OK]

Hint: Always render components as JSX, not function calls [OK]

Common Mistakes:

• Calling component as a plain function
• Forgetting JSX angle brackets in render
• Misunderstanding getByText usage

5. You want to test a server component that fetches data asynchronously before rendering. Which approach correctly tests the component's rendered output after data is loaded?

async function fetchUser() { return { name: 'Eve' }; }

function User() {
  const user = fetchUser();
  return <div>User: {user.name}</div>;
}

How should you write the test?

hard

A. Call fetchUser inside the test and pass data as prop to User component

B. Mock fetchUser to return data synchronously and render User component normally

C. Use async/await in the test and render User component with suspense fallback

D. Render User component directly without mocking or waiting

Solution

1. Step 1: Understand server component data fetching

   Server components can fetch data asynchronously but tests must control data to avoid real async calls.

2. Step 2: Choose testing approach

   Calling fetchUser in test and passing data as prop lets test run synchronously and check output reliably.

3. Step 3: Evaluate other options

   Mocking fetchUser synchronously inside component is complex; suspense fallback is for client components; rendering without waiting causes errors.

4. Final Answer:

   Call fetchUser inside the test and pass data as prop to User component -> Option A

5. Quick Check:

   Pass data as prop after fetching in test [OK]

Hint: Fetch data in test, pass as prop to component [OK]

Common Mistakes:

• Trying to test async fetch inside component directly
• Ignoring need to mock or control data in tests
• Using suspense fallback incorrectly in server component tests