Vitest instead of Jest

[crummy]

Hi,

I'm introducing tests to a package we have that uses express-zod-api. Elsewhere we use Vitest so I tried to use it here too with testEndpoint - but discovered that Jest is expected instead. So I took the file from express-zod-api and replaced references to Jest with ones to Vitest.

I can't say this works perfectly but in my limited testing this functions as a drop-in replacement for express-zod-api's testEndpoint call.

import { Request, Response } from "express";
import http from "node:http";
import { Logger } from "winston";
import {AbstractEndpoint} from "express-zod-api";
import {CommonConfig} from "express-zod-api/dist/config-type";
import {vi, Mock} from "vitest";

const mimeJson = "application/json"

interface TestEndpointProps<REQ, RES, LOG> {
    endpoint: AbstractEndpoint;
    requestProps?: REQ;
    responseProps?: RES;
    configProps?: Partial<CommonConfig>;
    loggerProps?: LOG;
}

export const makeRequestMock = <REQ>(requestProps?: REQ) =>
    <
        { method: string } & Record<"header", Mock> &
        (REQ extends undefined ? {} : REQ)
        >{
        method: "GET",
        header: vi.fn(() => mimeJson),
        ...requestProps,
    };

export const makeResponseMock = <RES>(responseProps?: RES) => {
    const responseMock = <
        {
            writableEnded: boolean;
            statusCode: number;
            statusMessage: string;
        } & Record<
        "set" | "setHeader" | "header" | "status" | "json" | "send" | "end",
        Mock
    > &
        (RES extends undefined ? {} : RES)
        >{
        writableEnded: false,
        statusCode: 200,
        statusMessage: http.STATUS_CODES[200],
        set: vi.fn(() => responseMock),
        setHeader: vi.fn(() => responseMock),
        header: vi.fn(() => responseMock),
        status: vi.fn((code: number) => {
            responseMock.statusCode = code;
            responseMock.statusMessage = http.STATUS_CODES[code]!;
            return responseMock;
        }),
        json: vi.fn(() => responseMock),
        send: vi.fn(() => responseMock),
        end: vi.fn(() => {
            responseMock.writableEnded = true;
            return responseMock;
        }),
        ...responseProps,
    };
    return responseMock;
};

/**
 * @description You need to install Jest and probably @types/jest to use this method
 */
export const testEndpoint = async <
    REQ extends Partial<Record<keyof Request, any>> | undefined = undefined,
    RES extends Partial<Record<keyof Response, any>> | undefined = undefined,
    LOG extends Partial<Record<keyof Logger, any>> | undefined = undefined,
>({
      endpoint,
      requestProps,
      responseProps,
      configProps,
      loggerProps,
  }: TestEndpointProps<REQ, RES, LOG>) => {
    const requestMock = makeRequestMock(requestProps);
    const responseMock = makeResponseMock(responseProps);
    const loggerMock = <
        Record<"info" | "warn" | "error" | "debug", Mock> &
        (LOG extends undefined ? {} : LOG)
        >{
        info: vi.fn(),
        warn: vi.fn(),
        error: vi.fn(),
        debug: vi.fn(),
        ...loggerProps,
    };
    const configMock = {
        cors: false,
        logger: loggerMock,
        ...configProps,
    };
    await endpoint.execute({
        request: requestMock as unknown as Request,
        response: responseMock as unknown as Response,
        config: configMock as CommonConfig,
        logger: loggerMock as unknown as Logger,
    });
    return { requestMock, responseMock, loggerMock };
};

[RobinTail]

Awesome! Thank you for sharing this.
Perhaps I could include this solution into the distribution later, but I need to figure out how to make it generic. Meanwhile it should be helpful for those using vitest.

[RobinTail]

@crummy , I'm glad to inform you, that version 15 now supports vitest.

[crummy]

Thanks so much!

[crummy]

Just wanted to say I rolled out v15 today and really appreciated the MockOverrides functionality. Thank you again!

[RobinTail]

I'm super glad to read it.
Thank you for letting me know, @crummy :)

[RobinTail]

v20 detached from any testing frameworks — released 🚀