How do you unit test routes?

[seanng]

Hi! First off, awesome library! My question is re. unit tests - how do you write them? It's not mentioned anywhere in docs.

Previously, I used node-mocks-http to test my NextJS API routes, and it worked. However, it doesn't seem to work in this case. Here is my code:

donations.test.ts

import handler from 'pages/api/donations'
import { createMocks } from 'node-mocks-http'
import * as donationsService from 'backend/services/donations'

describe('api/donations', () => {
  describe('GET', () => {
    it('calls test', async () => {
      const { req, res } = createMocks({
        method: 'GET',
      })

      const spy = jest.spyOn(donationsService, 'test')

      await handler(req, res)

      expect(spy).toHaveBeenCalled()
    })
  })
})

pages/api/donations.ts

import { Get } from '@storyofams/next-api-decorators'
import * as donationsService from 'backend/services/donations'

class DonationsHandler {
  @Get()
  async test() {
    donationsService.test()
    return {}
  }
}

[ggurkal]

Hi!

You can do it in the same way! The only difference is to pass the url property correctly. This is a test that I sketched for /examples/route-matching/pages/api/users/[[...params]].ts:

import { createMocks } from 'node-mocks-http';
import handleUsers from './[[...params]]';

describe('/api/users/[[...params]]', () => {
  test('Fetches a user', async () => {
    const { req, res } = createMocks({
      method: 'GET',
      url: '/api/users/101',
    });

    await handleUsers(req, res);

    expect(res._getStatusCode()).toBe(200);
    expect(res._getData()).toEqual(
      expect.objectContaining({
        id: 101,
      }),
    );
  });

  test('Returns 404', async () => {
    const { req, res } = createMocks({
      method: 'GET',
      url: '/api/users/101111',
    });

    await handleUsers(req, res);

    expect(res._getStatusCode()).toBe(404);
    expect(JSON.parse(res._getData())).toEqual(
      expect.objectContaining({
        message: "No user found with ID '101111'.",
      }),
    );
  });
});