如何用Jest mock AWS SDK V3的DynamoDBDocumentClient构造方法

错误原因 #

DynamoDBDocumentClient.from是类的静态方法，直接挂载在构造函数本身，你之前的写法将from放到了类实例的属性中，调用DynamoDBDocumentClient.from时自然找不到对应方法。

正确Mock代码 #

1. Mock @aws-sdk/lib-dynamodb #

优先用兼容写法，同时支持静态from调用和直接new DynamoDBDocumentClient的场景：

jest.mock("@aws-sdk/lib-dynamodb", () => ({
  DynamoDBDocumentClient: Object.assign(
    // 兼容直接new的场景
    jest.fn(() => ({
      get: jest.fn(),
      put: jest.fn(),
      send: jest.fn()
    })),
    {
      // 静态from方法直接挂载在构造函数上
      from: jest.fn((client, config) => ({
        // 这里返回document client实例，根据你的业务需求写对应的方法mock
        get: (params) => console.log("In DynamoDBDocumentClient get", params),
        put: (params) => mockAwsResponse("DynamoDBDocumentClient", "PutCommand", params),
        // 如果你的业务用SDK v3标准的send + Command写法，保留这个即可
        send: jest.fn((command) => {
          switch(command.constructor.name) {
            case "GetCommand":
              return mockAwsResponse("DynamoDBDocumentClient", "GetCommand", command.input)
            case "PutCommand":
              return mockAwsResponse("DynamoDBDocumentClient", "PutCommand", command.input)
            default:
              return Promise.resolve({})
          }
        })
      }))
    }
  )
}))

2. 优化@aws-sdk/client-dynamodb的Mock #

你之前的写法重复定义了两次put，且原生DynamoDBClient没有get/put快捷方法，默认用send配合Command执行操作，优化后写法如下：

jest.mock("@aws-sdk/client-dynamodb", () => ({
  DynamoDBClient: jest.fn(() => ({
    send: jest.fn((command) => {
      return mockAwsResponse("DynamoDBClient", command.constructor.name, command.input)
    })
  })),
  // 如果业务代码中导入了对应的Command，需要在这里同步导出Mock
  GetCommand: jest.fn((params) => ({ input: params })),
  PutCommand: jest.fn((params) => ({ input: params })),
}))

修改后运行测试即可解决from is not a function的报错。

内容的提问来源于stack exchange，提问作者Fares