drift-node-sdk

Node.js Tusk Drift SDK 通过捕获并重放进出您服务的 API 调用来实现快速、确定性的 API 测试。自动记录真实世界的 API 调用，然后使用 Tusk CLI 将它们作为测试进行重放，以发现回归问题。在重放过程中，所有出站请求都会使用记录的数据进行拦截，以确保行为一致且无副作用。

文档

如需全面的指南和 API 参考，请访问我们的完整文档。

SDK 指南

• 初始化指南 - 在您的 Node.js 应用程序中设置 SDK
• 环境变量 - 环境变量参考
• 快速入门指南 - 记录并重放您的第一个追踪记录
• 故障排除指南 - 常见问题及解决方案

要求

Tusk Drift 目前支持以下软件包和版本：

• HTTP/HTTPS：所有版本（Node.js 内置）
• GRPC：@grpc/[email protected]（仅出站请求）
• PG：[email protected]、[email protected]
• Firestore：@google-cloud/[email protected]
• Postgres：[email protected]
• MySQL：[email protected]、[email protected]
• MongoDB：[email protected]
• Redis：[email protected]（@redis/[email protected],5.x）
• IORedis：[email protected]
• Upstash Redis：@upstash/[email protected]

如果您使用的软件包或版本未列在上述列表中，请创建一个 issue，并注明您希望为其提供插桩支持的软件包和版本。

安装

第 1 步：安装 CLI

首先，按照我们的 CLI 安装指南 安装并配置 Tusk Drift CLI。CLI 可帮助您设置 Tusk 配置文件并重放测试。

在需要设置 SDK 时，向导最终会引导您回到此处。

第 2 步：安装 SDK

完成 CLI 向导后，安装 SDK：

npm install @use-tusk/drift-node-sdk

第 3 步：为您的服务初始化 SDK

请参阅我们的初始化指南为您的服务设置 SDK。

第 4 步：运行您的第一个测试

按照我们的快速入门指南记录并重放您的第一个测试！

故障排除

遇到问题了吗？

• 阅读我们的故障排除文档
• 创建 issue 或通过 [email protected] 联系我们。

社区

加入我们在 Slack 上的开源社区。

贡献

我们感谢反馈和贡献。请参阅 CONTRIBUTING.md。

许可证

本项目采用 Apache License 2.0 许可 - 详情请参阅 LICENSE 文件。