Mocking data in tests in Remix

Introduction

Mocking data helps you test your Remix app without needing real servers or databases. It makes tests faster and more reliable.

When you want to test a Remix loader without calling a real API.

When you need to simulate user data in your tests.

When your test should not depend on external services.

When you want to check how your component behaves with different data.

When you want to isolate parts of your app to find bugs easily.

Syntax

Remix

import { vi } from 'vitest';

// Mock a fetch call
vi.stubGlobal('fetch', vi.fn(() =>
  Promise.resolve({ json: () => Promise.resolve(mockData) })
));

Use vi.stubGlobal to replace global functions like fetch.

Return a Promise that resolves to the mocked data to mimic real fetch behavior.

Examples

This mocks fetch to always return a user named Alice.

Remix

import { vi } from 'vitest';

const mockData = { name: 'Alice' };

vi.stubGlobal('fetch', vi.fn(() =>
  Promise.resolve({ json: () => Promise.resolve(mockData) })
));

This mocks fetch to simulate a network error.

Remix

import { vi } from 'vitest';

const mockError = new Error('Network error');

vi.stubGlobal('fetch', vi.fn(() =>
  Promise.reject(mockError)
));

Sample Program

This test mocks the global fetch function so the Remix loader returns the mocked data instead of calling a real API.

Remix

import { vi, describe, it, expect } from 'vitest';
import { loader } from '~/routes/example';

const mockData = { message: 'Hello from mock!' };

vi.stubGlobal('fetch', vi.fn(() =>
  Promise.resolve({ json: () => Promise.resolve(mockData) })
));

describe('loader test with mocked fetch', () => {
  it('returns mocked data', async () => {
    const response = await loader();
    expect(response).toEqual(mockData);
  });
});

Important Notes

Always reset mocks after tests to avoid side effects.

Mock only what you need to keep tests simple and clear.

Summary

Mocking replaces real data calls with fake data for testing.

Use vi.stubGlobal in Remix tests to mock fetch.

Mocking makes tests faster and more reliable.

Practice

1. What is the main purpose of mocking data in Remix tests?

easy

A. To simulate API responses without calling real servers

B. To speed up the Remix app in production

C. To permanently store test data in the database

D. To create user interface animations

Solution

1. Step 1: Understand mocking in tests

   Mocking means creating fake data or responses to test without real external calls.

2. Step 2: Identify the purpose in Remix tests

   Mocking API responses lets tests run fast and reliably without depending on real servers.

3. Final Answer:

   To simulate API responses without calling real servers -> Option A

4. Quick Check:

   Mocking = Simulate API responses [OK]

Hint: Mocking fakes server data so tests run offline [OK]

Common Mistakes:

• Thinking mocking speeds up production apps
• Confusing mocking with saving data permanently
• Assuming mocking creates UI effects

2. Which code snippet correctly sets up a mock server using msw in a Remix test?

easy

A. import { createServer } from 'http'; const server = createServer(); server.start(); server.stop();

B. import { setupServer } from 'msw/node'; const server = setupServer(...handlers); beforeAll(() => server.listen()); afterAll(() => server.close());

C. import { setupMock } from 'msw'; const server = setupMock(); server.run();

D. const server = new Server(); server.open(); server.shutdown();

Solution

1. Step 1: Recognize msw setup syntax

   msw uses setupServer from 'msw/node' with handlers, then calls server.listen() and server.close() in test lifecycle.

2. Step 2: Compare options

   Only import { setupServer } from 'msw/node'; const server = setupServer(...handlers); beforeAll(() => server.listen()); afterAll(() => server.close()); uses correct msw functions and lifecycle calls for mocking in Remix tests.

3. Final Answer:

   import { setupServer } from 'msw/node'; const server = setupServer(...handlers); beforeAll(() => server.listen()); afterAll(() => server.close()); -> Option B

4. Quick Check:

   msw setupServer + listen/close = correct [OK]

Hint: Look for msw/node and server.listen/close calls [OK]

Common Mistakes:

• Using non-msw server setup functions
• Missing server.listen() or server.close() calls
• Incorrect import or method names

3. Given this test code snippet, what will be the output when the mocked API returns { message: 'Hello' }?

import { rest } from 'msw';
import { setupServer } from 'msw/node';

const server = setupServer(
  rest.get('/api/greet', (req, res, ctx) => {
    return res(ctx.json({ message: 'Hello' }));
  })
);

beforeAll(() => server.listen());
afterAll(() => server.close());

// Test function
async function fetchGreeting() {
  const response = await fetch('/api/greet');
  const data = await response.json();
  return data.message;
}

fetchGreeting().then(console.log);

medium

A. 'Hello'

B. 'Hi there!'

C. undefined

D. Error: Network request failed

Solution

1. Step 1: Analyze the mock handler

   The mock intercepts GET '/api/greet' and returns JSON { message: 'Hello' }.

2. Step 2: Trace fetchGreeting function

   fetchGreeting fetches '/api/greet', parses JSON, and returns data.message which is 'Hello'.

3. Final Answer:

   'Hello' -> Option A

4. Quick Check:

   Mock returns 'Hello' so output = 'Hello' [OK]

Hint: Mock returns JSON with message 'Hello' so output matches [OK]

Common Mistakes:

• Expecting different message than mocked
• Forgetting to parse JSON before accessing message
• Assuming network error without server.listen()

4. In a Remix test using msw, the mock server is not intercepting requests and real network calls happen. What is the likely cause?

medium

A. The test file is missing import of React

B. The mock handlers return incorrect JSON format

C. The fetch function is not awaited

D. server.listen() was not called before tests

Solution

1. Step 1: Identify why mocks don't intercept

   msw requires server.listen() to start intercepting requests before tests run.

2. Step 2: Check other options

   Incorrect JSON or missing await won't stop interception; missing React import is unrelated.

3. Final Answer:

   server.listen() was not called before tests -> Option D

4. Quick Check:

   Missing server.listen() = no interception [OK]

Hint: Always call server.listen() before tests start [OK]

Common Mistakes:

• Assuming JSON format affects interception
• Ignoring need for server.listen()
• Confusing fetch await with mocking setup

5. You want to test a Remix loader that fetches user data from '/api/user'. How do you mock the API to return different user names for two tests without restarting the server each time?

hard

A. Change the global handlers array and rerun setupServer() once

B. Call server.close() and server.listen() before each test with new handlers

C. Use server.use() with new handlers inside each test to override responses

D. Mock fetch globally with jest.fn() instead of msw

Solution

1. Step 1: Understand dynamic mocking in msw

   msw allows overriding handlers per test using server.use() without restarting the server.

2. Step 2: Compare options for best practice

   Use server.use() with new handlers inside each test to override responses uses server.use() to add new handlers dynamically; other options restart server or use different mocking tools.

3. Final Answer:

   Use server.use() with new handlers inside each test to override responses -> Option C

4. Quick Check:

   server.use() overrides handlers dynamically [OK]

Hint: Use server.use() inside tests to change mocks on the fly [OK]

Common Mistakes:

• Restarting server unnecessarily each test
• Modifying global handlers without reinitializing
• Confusing msw with jest fetch mocks