drift-node-sdk

The Node.js Tusk Drift SDK enables fast and deterministic API testing by capturing and replaying API calls made to/from your service. Automatically record real-world API calls, then replay them as tests using the Tusk CLI to find regressions. During replay, all outbound requests are intercepted with recorded data to ensure consistent behavior without side-effects.

Documentation

For comprehensive guides and API reference, visit our full documentation.

SDK Guides

• Initialization Guide - Set up the SDK in your Node.js application
• Environment Variables - Environment variables reference
• Quick Start Guide - Record and replay your first trace
• Troubleshooting Guide - Common issues and solutions

Requirements

Tusk Drift currently supports the following packages and versions:

• HTTP/HTTPS: All versions (Node.js built-in)
• GRPC: @grpc/[email protected] (Outbound requests only)
• 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]

If you're using packages or versions not listed above, please create an issue with the package + version you'd like an instrumentation for.

Installation

Step 1: Install the CLI

First, install and configure the Tusk Drift CLI by following our CLI installation guide. The CLI helps set up your Tusk configuration file and replays tests.

The wizard will eventually direct you back here when it's time to set up the SDK.

Step 2: Install the SDK

After completing the CLI wizard, install the SDK:

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

Step 3: Initialize the SDK for your service

Refer to our initialization guide to set up the SDK for your service.

Step 4: Run Your First Test

Follow along our quick start guide to record and replay your first test!

Troubleshooting

Having issues?

• Read our troubleshooting doc
• Create an issue or reach us at [email protected].

Community

Join our open source community on Slack.

Contributing

We appreciate feedback and contributions. See CONTRIBUTING.md.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.