如何使用TypeScript部分测试AWS Lambda？

Question

非常类似于使用部分形状对typescript进行单元测试，但我无法理解为什么部分类型被视为与完整版本不兼容。

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

  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}=wait处理程序（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)

我理解APIGatewayProxyEventbody可以是string | null（从类型上看），但是string | null | undefined是从哪里来的？为什么我的正文（字符串）不是APIGatewayProxyEvent的有效正文

如何使用TypeScript部分测试AWS Lambda？

我可以使用作为来做类型断言，但是我发现部分更显式。下面的代码工作，虽然：

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

  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

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

type MyObj = { myKey: string | null };

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

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

您的APIGatewayProxyEvent类型要求body为string | null，但是由于您将其设置为部分，因此您所说的body也可能是未定义的。是的，您已经定义了它，但是您从未进行过类型缩小以验证它确实是一个字符串。因此，TypeScript必须关闭的所有类型都是您指定的类型，这也是部分类型
更新：扩展@jornsharpe在评论中所说的内容。我以前的解决方案似乎不起作用，它只是将错误推送到APIGatewayProxyEvent中的下一个属性。看看他们的答案。问题是您试图模拟数据的一部分，而该类型希望所有数据都存在。创建一个对象，使每个属性的值都最小，而不是试图伪造它，这可能是最简单的。您可以将用作，但这首先破坏了使用类型系统的全部意义
前面的答案：一个解决方案可能是使所有值都是可选的，除了body：

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

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

Answer 2

我无法理解为什么部分类型被视为与完整版本不兼容

从根本上说，这是不可避免的-您从要求body属性为string | null的内容开始，并创建了要求较弱的string | null | undefined的内容。在本例中，您确实提供了正文，但这并不重要，因为处理程序仅通过部分代码查看无效事件

在不拥有处理程序API的情况下，实际上只有三种选择，没有一种是理想的：

1. 实际提供完整的APIGatewayProxyEvent（有关此操作的快捷方式，请参见末尾）

使用部分代码通常只是选项2中的一个步骤，使用：

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

而不是：

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

如果您拥有处理程序的API，最好的方法是应用接口隔离原则，并具体说明它实际需要做什么工作。如果只是body，例如：

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

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

完整的APIGatewayProxyEvent仍然是处理程序的有效参数，因为它确实有一个主体（而且它还有其他属性这一事实与此无关，它们无法通过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);
});

作为奖励，如果稍后发现您需要访问处理程序中的更多事件属性，您可以更新类型：

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

你需要更新测试数据以考虑到这一点，你会在任何地方得到错误。这不会发生在const无效事件={...}作为APIGatewayProxy事件；，您必须通过查看哪些测试在运行时失败来跟踪更改。

我在选项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，”，空对象和数组，…），避免任何依赖于它们的特殊行为。