使用正确类型使用 Jest 和 Typescript 模拟 Express 请求

Question

在 Jest 中获取正确的 Express Request 类型时遇到了一些问题。我有一个使用此代码传递的简单用户注册：

import { userRegister } from '../../controllers/user';
import { Request, Response, NextFunction } from 'express';

describe('User Registration', () => {
  test('User has an invalid first name', async () => {
    const mockRequest: any = {
      body: {
        firstName: 'J',
        lastName: 'Doe',
        email: 'jdoe@abc123.com',
        password: 'Abcd1234',
        passwordConfirm: 'Abcd1234',
        company: 'ABC Inc.',
      },
    };

    const mockResponse: any = {
      json: jest.fn(),
      status: jest.fn(),
    };

    const mockNext: NextFunction = jest.fn();

    await userRegister(mockRequest, mockResponse, mockNext);

    expect(mockNext).toHaveBeenCalledTimes(1);
    expect(mockNext).toHaveBeenCalledWith(
      new Error('First name must be between 2 and 50 characters')
    );
  });
});

但是，如果我改变：

    const mockRequest: any = {
      body: {
        firstName: 'J',
        lastName: 'Doe',
        email: 'jdoe@abc123.com',
        password: 'Abcd1234',
        passwordConfirm: 'Abcd1234',
        company: 'ABC Inc.',
      },
    };

到：

const mockRequest: Partial<Request> = {
  body: {
    firstName: 'J',
    lastName: 'Doe',
    email: 'jdoe@abc123.com',
    password: 'Abcd1234',
    passwordConfirm: 'Abcd1234',
    company: 'ABC Inc.',
  },
};

根据 TypeScript 文档 (https://www.typescriptlang.org/docs/handbook/utility-types.html#partialt)，这应该使 Request 对象上的所有字段都是可选的。

但是，我收到此错误：

Argument of type 'Partial<Request>' is not assignable to parameter of type 'Request'.
  Property '[Symbol.asyncIterator]' is missing in type 'Partial<Request>' but required in type 'Request'.ts(2345)
stream.d.ts(101, 13): '[Symbol.asyncIterator]' is declared here.

我希望有更多 TypeScript 经验的人可以发表评论并让我知道我做错了什么。

Answer 1

似乎@kschaer 说userRegister 是问题所在。如果您希望该功能采用Partial<Request>，您可以将userRegister 更改为：

const userRegister = async (req: Partial<Request>, res: Response, next: NextFunction) => { /* snippet */ }

但由于这仅用于测试，您也可以将 mockRequest 转换为 Request 类型，如下所示：

const mockRequest = <Request>{
  body: {
    /* snippet */
  }
};

希望对您有所帮助。

Answer 2

您的模拟数据类型不必完全适合实际数据。 好吧，它不是根据定义。这只是一个模拟，对吧？

您需要的是type assertion。这是一种告诉 TypeScript “好的兄弟，我知道我在这里做什么。”。

这不是生产代码，而是测试。您甚至可能在手表模式下运行它。我们可以在这里毫无问题地拒绝某些类型安全。 TypeScript 不知道这是一个模拟，但我们知道。

const mockRequest = {
    body: {
    firstName: 'J',
    lastName: 'Doe',
    email: 'jdoe@abc123.com',
    password: 'Abcd1234',
    passwordConfirm: 'Abcd1234',
    company: 'ABC Inc.',
    },
} as Request;

如果在测试期间发生崩溃，因为mockRequest 与 Request 不够相似，我们会知道并修复模拟，添加一些新属性等。

如果 as Request 不起作用，你可以告诉 TypeScript“我真的知道我在这里做什么”，首先声明 any 或 unknown，然后声明你的类型需要。它看起来像

const x: number = "not a number :wink:" as any as number;

当我们想测试我们的代码在输入错误的情况下不能很好地工作时，它很有用。

对于你的特殊情况——模拟快递请求——有jest-express可以帮助你，当然如果你可以节省 node_modules 的大小。