How to set cookie header?

[janhesters]

I'm trying to set a cookie header so that my handler can access request.cookies, but can't figure out how to do it.

I want the equivalent of this:

const response = await supertest(app)
  .get(PATH)
  .set('Cookie', `magic-auth-token=${token}`)
  .expect(200);

I tried:

requestPatcher: request =>
  (request.headers = { 'set-cookie': [`magic-auth-token=${token}`] }),

and

requestPatcher: request =>
  (request.headers = { cookie: `magic-auth-token=${token}` }),

both of which do not work. How can I set a cookie?

[Xunnamius]

The following test is currently passing. What behavior are you experiencing/expecting (see the issue template for an example)?

it('respects setting cookie using request patcher', async () => {
      expect.hasAssertions();

      const token = 'my-token';

      await testApiHandler({
        requestPatcher: (req) => (req.headers = { cookie: `magic-auth-token=${token}` }),

        handler: async (req: NextApiRequest, res: NextApiResponse) => {
          res.status(200).send({ data: req.headers.cookie });
        },

        test: async ({ fetch }) => {
          expect((await fetch()).status).toBe(200);
          expect(await (await fetch()).json()).toStrictEqual({
            data: `magic-auth-token=${token}`
          });
        }
      });
    });

[janhesters]

Apparently the latter with cookie is working, thanks! 🙏 What threw me off is that you have to do this:

test: async ({ fetch }) => {
  expect((await fetch()).status).toBe(200);
  expect(await (await fetch()).json()).toStrictEqual({
    data: `magic-auth-token=${token}`
  });
}

And can't do something like:

test: async ({ fetch }) => {
  const response = await fetch();
  const json = await response.json();
  
  expect(response.status).toBe(200);
  expect(json).toStrictEqual({ data: `magic-auth-token=${token}` });
}

[Xunnamius]

Just per my curiosity, I threw this into a test and it also passed:

it('respects setting cookie header using request patcher', async () => {
      expect.hasAssertions();

      const token = 'my-token';

      await testApiHandler({
        requestPatcher: (req) => (req.headers = { cookie: `magic-auth-token=${token}` }),

        handler: async (req: NextApiRequest, res: NextApiResponse) => {
          res.status(200).send({ data: req.headers.cookie });
        },

        test: async ({ fetch }) => {
          const response = await fetch();
          const json = await response.json();

          expect(response.status).toBe(200);
          expect(json).toStrictEqual({ data: `magic-auth-token=${token}` });
        }
      });
    });

Most of the really weird issues I've encountered with fetch and Next are usually because I forgot to await a promise somewhere 😁

[janhesters]

Thank you for investigating! ❤️

This is verbatim the code I'm tyring to run with your assertions 😕

import type { WithConfig } from '@ergodark/next-types';
import { testApiHandler } from 'next-test-api-route-handler';
import * as GetCurrentUserHandler from 'pages/api/user';
import { encryptSession } from 'utils/sessions';

const getCurrentUserHandler: WithConfig<typeof GetCurrentUserHandler.default> =
  GetCurrentUserHandler.default;

describe('get current user handler', () => {
  it('returns the user when the user is logged in', async () => {
    expect.hasAssertions();

    const session = {
      issuer: 'did:example:123456789abcdefghi',
      publicAddress: '0xDC25EF3F5B8A186998338A2ADA83795FBA2D695E',
      email: '[email protected]',
    };
    const token = await encryptSession(session);

    await testApiHandler({
      handler: getCurrentUserHandler,
      requestPatcher: request =>
        (request.headers = { cookie: `magic-auth-token=${token}` }),
      test: async ({ fetch }) => {
        expect((await fetch()).status).toBe(200);
        expect(await (await fetch()).json()).toStrictEqual({ user: session });
      },
    });
  });
  
  it('returns undefined for the user if the user is logged out', async () => {
    expect.hasAssertions();

    await testApiHandler({
      handler: getCurrentUserHandler,
      test: async ({ fetch }) => {
        expect((await fetch()).status).toBe(200);
        expect(await (await fetch()).json()).toStrictEqual({ user: undefined });
      },
    });
  });
});

[Xunnamius]

Can you create a MRE repo that demonstrates the wrong behavior?

[janhesters]

Sorry, I switched back to using express with supertest and don't have the code anymore.

Love the idea of this package though!

[janhesters]

PS: a small TS issue that handler doesn't know NextApiHandler and TS doesn't compile when you use that instead of (req: NextApiRequest, res: NextApiResponse).