如何使用 TypeScript Partials 测试 AWS Lambda？

Question

与Using partial shape for unit testing with typescript 非常相似，但我不明白为什么 Partial 类型被视为与完整版本不兼容。

我有一个单元测试，如果 AWS lambda 事件中的 body 无效，它会检查 lambda 是否返回 400。为了避免给我的同事制造噪音，我不想创建具有完整APIGatewayProxyEvent 的所有属性的invalidEvent。因此使用Partial<APIGatewayProxyEvent>。

  it("should return 400 when request event is invalid", async () => {
    const invalidEvent: Partial<APIGatewayProxyEvent> = {
      body: JSON.stringify({ foo: "bar" }),
    };
    const { statusCode } = await handler(invalidEvent);
    expect(statusCode).toBe(400);
  });

const { statusCode } = await handler(invalidEvent); 行编译失败：

Argument of type 'Partial<APIGatewayProxyEvent>' is not assignable to parameter of type 'APIGatewayProxyEvent'.
  Types of property 'body' are incompatible.
    Type 'string | null | undefined' is not assignable to type 'string | null'.
      Type 'undefined' is not assignable to type 'string | null'.ts(2345)

我知道APIGatewayProxyEvent 正文可以是string | null（通过查看类型）但string | null | undefined 来自哪里？为什么我的body（它是一个字符串）不是APIGatewayProxyEvent 的有效主体

如何使用 TypeScript Partials 测试 AWS Lambda？

我可以使用as to do type assertions，但我发现Partials 更明确。以下代码虽然有效：

    const invalidEvent = { body: JSON.stringify({ foo: "bar" }) } as APIGatewayProxyEvent;

更新：使用 Omit 和 Pick 创建新类型

  type TestingEventWithBody = Omit<Partial<APIGatewayProxyEvent>, "body"> & Pick<APIGatewayProxyEvent, "body">;

  it("should return 400 when request event is invalid", async () => {
    const invalidEvent: TestingEventWithBody = { body: JSON.stringify({ foo: "bar" }) };
    const { statusCode } = await handler(invalidEvent);
    expect(statusCode).toBe(400);
  });

失败：

Argument of type 'TestingEventWithBody' is not assignable to parameter of type 'APIGatewayProxyEvent'.
  Types of property 'headers' are incompatible.
    Type 'APIGatewayProxyEventHeaders | undefined' is not assignable to type 'APIGatewayProxyEventHeaders'.
      Type 'undefined' is not assignable to type 'APIGatewayProxyEventHeaders'.ts(2345)

Answer 1

我不明白为什么 Partial 类型被视为与完整版本不兼容

从根本上说，这是不可避免的 - 您从要求 body 属性为 string | null 的东西开始，并创建了具有较弱要求 string | null | undefined 的东西。在这种情况下，您确实提供了body，但这并不重要，因为handler 仅通过Partial<APIGatewayProxyEvent> 接口看到invalidEvent，并且编译器知道该属性可以 不见了。如您所见，如果您修补该属性以再次需要它，它只会抱怨下一个属性。

如果您没有handler API，您实际上只有三个选择，没有一个是理想的：

1. 实际上提供了一个完整的APIGatewayProxyEvent（见末尾的快捷方式）；
2. 向编译器声明您的测试对象是完整的APIGatewayProxyEvent 和type assertion；或
3. 用// @ts-ignore 注释告诉编译器根本不要检查它。

使用Partial通常只是选项2中的一个步骤，使用：

const thing: Partial<Thing> = { ... };
whatever(thing as Thing);

代替：

const thing = { ... } as Thing;
whatever(thing);

---

如果您拥有 handler 的 API，最好的方法是应用 interface segregation principle 并具体说明它实际需要做的工作。如果只是body，例如：

type HandlerEvent = Pick<APIGatewayProxyEvent, "body">;

function handler(event: HandlerEvent) { ... } 

一个完整的APIGatewayProxyEvent 仍然是handler 的有效参数，因为它肯定有一个body（事实上它还有其他属性是无关紧要的，它们无法通过HandlerEvent 访问）。这也可以作为内置文档，说明您从完整对象中实际使用的内容。

在您的测试中，您现在可以创建较小的对象：

it("should return 400 when request event is invalid", async () => {
  const invalidEvent: HandlerEvent = { body: JSON.stringify({ foo: "bar" }) };
  const { statusCode } = await handler(invalidEvent);
  expect(statusCode).toBe(400);
});

作为奖励，如果后来发现您需要访问 handler 内的更多事件属性，您可以更新类型：

type HandlerEvent = Pick<APIGatewayProxyEvent, "body" | "headers">;

并且在需​​要更新测试数据以考虑到这一点的任何地方都会出现错误。 const invalidEvent = { ... } as APIGatewayProxyEvent; 不会发生这种情况，您必须通过查看哪些测试在运行时失败来跟踪更改。

---

我见过的与选项 1 一起使用的另一个快捷方式是在部分周围包装一个函数，提供合理的默认值：

function createTestData(overrides: Partial<APIGatewayProxyEvent>): APIGatewayProxyEvent {
  return {
    body: null,
    headers: {},
    // etc.
    ...overrides,
  };
}

it("should return 400 when request event is invalid", async () => {
  const invalidEvent = createTestData({ body: JSON.stringify({ foo: "bar" }) });
  const { statusCode } = await handler(invalidEvent);
  expect(statusCode).toBe(400);
});

在这种情况下，您应该使默认值尽可能小（null、0、""、空对象和数组，...），以避免依赖于它们的任何特定行为。

Answer 2

这里的问题是分部类型将所有对象属性转换为可选：

type MyObj = { myKey: string | null };

type MyPartialObj = Partial<MyObj>;
// MyPartialObj is: { myKey?: string | null | undefined }

在MyObj 类型中，myKey 类型为string | null。当我们将其转换为MyPartialObj 时，myKey 类型变为可选，因此有可能成为undefined。所以现在它的类型是string | null | undefined

您的APIGatewayProxyEvent 类型期望body 为string | null，但是由于您已将其设为部分，您说body 可能 也可以是undefined。是的，您已经定义了它，但您从未使用type narrowing 来验证它确实是一个字符串。因此，TypeScript 所要做的就是你分配的类型，它又是 Partial。


更新： 扩展 @jonrsharpe 在 cmets 中所说的内容。我之前的解决方案似乎无法正常工作，它只是将错误推送到APIGatewayProxyEvent 中的下一个属性。 查看他们的答案。问题是您正在尝试模拟数据的一部分，并且该类型期望所有数据都存在。为每个属性创建一个具有最小值的对象而不是试图伪造它可能是最简单的。您可以使用as，但这首先破坏了使用类型系统的全部意义。


上一个答案： 一个解决方案可能是让所有值都是可选的，除了body：

const invalidEvent: Omit<Partial<APIGatewayProxyEvent>, 'body'> & Pick<APIGatewayProxyEvent, 'body'> = {
    body: JSON.stringify({ foo: "bar" }),
};

另外，避免像瘟疫一样使用as x，或者除非你完全确定自己在做什么。