@use-tusk/drift-node-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 Tusk AI, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,280 @@
+<p align="center">
+  <img src="images/tusk-banner.png" alt="Tusk Drift Banner">
+</p>
+
+<p align="center">
+  <a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License: Apache 2.0"></a>
+  <a href="https://github.com/Use-Tusk/tusk-drift-sdk/commits/main"><img src="https://img.shields.io/github/last-commit/Use-Tusk/tusk-drift-sdk" alt="GitHub last commit"></a>
+</p>
+
+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](https://github.com/Use-Tusk/tusk-drift-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](https://docs.usetusk.ai/automated-tests/installation#setup).
+
+## Requirements
+
+Tusk Drift currently supports the following packages and versions:
+
+- **HTTP/HTTPS**: All versions (Node.js built-in)
+- **PG**: `pg@8.x`, `pg-pool@2.x-3.x`
+- **Postgres**: `postgres@3.x`
+- **JSON Web Tokens**: `jsonwebtoken@5.x-9.x`
+- **JWKS RSA**: `jwks-rsa@1.x-3.x`
+- **GraphQL**: `graphql@15.x-16.x`
+
+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: CLI Setup
+
+First, install and configure the Tusk Drift CLI by following our [CLI installation guide](https://github.com/Use-Tusk/tusk-drift-cli?tab=readme-ov-file#install).
+
+The wizard will eventually direct you back here when it's time to set up the SDK.
+
+### Step 2: SDK Installation
+
+After completing the CLI wizard, install the SDK:
+
+```bash
+npm install @use-tusk/drift-node-sdk
+```
+
+## Initialization
+
+### Prerequisites
+
+Before setting up the SDK, ensure you have:
+
+- Completed the [CLI wizard](https://github.com/Use-Tusk/tusk-drift-cli?tab=readme-ov-file#quick-start)
+- Obtained an API key from the [Tusk Drift dashboard](https://usetusk.ai/app/settings/api-keysgoogle.com)
+
+Follow these steps in order to properly initialize the Tusk Drift SDK:
+
+### 1. Create SDK Initialization File
+
+Create a separate file (e.g. `tdInit.ts`) to initialize the Tusk Drift SDK. This ensures the SDK is initialized as early as possible before any other modules are loaded.
+
+```typescript
+// tdInit.ts
+import { TuskDrift } from "@use-tusk/drift-node-sdk";
+
+// Initialize SDK immediately
+TuskDrift.initialize({
+  apiKey: process.env.TUSK_DRIFT_API_KEY,
+  env: process.env.ENV,
+  logLevel: process.env.TUSK_DRIFT_LOG_LEVEL,
+});
+
+export { TuskDrift };
+```
+
+#### Configuration Options
+
+<table>
+  <thead>
+    <tr>
+      <th>Option</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>apiKey</code></td>
+      <td><code>string</code></td>
+      <td><b>Required.</b></td>
+      <td>Your Tusk Drift API key.</td>
+    </tr>
+    <tr>
+      <td><code>env</code></td>
+      <td><code>string</code></td>
+      <td><b>Required.</b></td>
+      <td>The environment name.</td>
+    </tr>
+    <tr>
+      <td><code>logLevel</code></td>
+      <td><code>'silent' | 'error' | 'warn' | 'info' | 'debug'</code></td>
+      <td><code>'info'</code></td>
+      <td>The logging level.</td>
+    </tr>
+  </tbody>
+</table>
+
+### 2. Import SDK at Application Entry Point
+
+In your main server file (e.g., `server.ts`, `index.ts`, `app.ts`), import the initialized SDK **at the very top**, before any other imports:
+
+```typescript
+// server.ts
+import { TuskDrift } from "./tdInit"; // MUST be the first import
+
+// ... other imports ...
+
+// Your application setup...
+```
+
+> **IMPORTANT**: Ensure NO require/import calls are made before importing the SDK initialization file. This guarantees proper instrumentation of all dependencies.
+
+### 3. Update Configuration File
+
+Update the configuration file `.tusk/config.yaml` to include a `recording` section. Example `recording` configuration:
+
+```yaml
+# ... existing configuration ...
+
+recording:
+  sampling_rate: 0.1
+  export_spans: true
+  enable_env_var_recording: true
+```
+
+#### Configuration Options
+
+<table>
+  <thead>
+    <tr>
+      <th>Option</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>sampling_rate</code></td>
+      <td><code>number</code></td>
+      <td><code>1.0</code></td>
+      <td>The sampling rate (0.0 - 1.0). 1.0 means 100% of requests are recorded, 0.0 means 0% of requests are recorded.</td>
+    </tr>
+    <tr>
+      <td><code>export_spans</code></td>
+      <td><code>boolean</code></td>
+      <td><code>false</code></td>
+      <td>Whether to export spans to Tusk backend or local files (<code>.tusk/traces</code>). If false, spans are only exported to local files.</td>
+    </tr>
+    <tr>
+      <td><code>enable_env_var_recording</code></td>
+      <td><code>boolean</code></td>
+      <td><code>false</code></td>
+      <td>Whether to enable environment variable recording and replaying. Recommended if your application's business logic depends on environment variables, as this ensures the most accurate replay behavior.</td>
+    </tr>
+  </tbody>
+</table>
+
+### 3. Mark App as Ready
+
+Once your application has completed initialization (database connections, middleware setup, etc.), mark it as ready:
+
+```typescript
+// server.ts
+import { TuskDrift } from "./tdInit";
+
+// ... other imports ...
+
+const app = express();
+
+// Your application setup...
+
+app.listen(8000, () => {
+  // Mark app as ready for recording/replay
+  TuskDrift.markAppAsReady();
+  console.log("Server started and ready for Tusk Drift");
+});
+```
+
+## Run Your First Test
+
+Let's walk through recording and replaying your first trace:
+
+### Step 1: Set sampling rate to 1.0
+
+Set the `sampling_rate` in `.tusk/config.yaml` to 1.0 to ensure that all requests are recorded.
+
+### Step 2: Start server in record mode
+
+Run your server in record mode using the `TUSK_DRIFT_MODE` environment variable:
+
+```bash
+TUSK_DRIFT_MODE=RECORD node server.js
+```
+
+You should see logs indicating Tusk Drift is active:
+
+```
+[TuskDrift] SDK initialized in RECORD mode
+[TuskDrift] App marked as ready
+```
+
+### Step 3: Generate Traffic
+
+Make a request to a simple endpoint that includes some database and/or network calls:
+
+```bash
+curl http://localhost:8000/api/test/weather
+```
+
+### Step 4: Stop Recording
+
+Wait for a few seconds and then stop your server with `Ctrl+C`. This will give time for traces to be exported.
+
+### Step 5: List Recorded Traces
+
+In your project directory, list the recorded traces:
+
+```bash
+tusk list
+```
+
+You should see output similar to:
+
+<img src="images/tusk-list-output.png">
+
+Press `ESC` to exit the list view.
+
+Need to install the Tusk CLI? See [CLI installation guide](https://github.com/Use-Tusk/tusk-drift-cli?tab=readme-ov-file#install).
+
+### Step 6: Replay the Trace
+
+Replay the recorded test:
+
+```bash
+tusk run
+```
+
+You should see output similar to:
+
+<img src="images/tusk-run-output.png">
+
+**Success!** You've recorded and replayed your first trace.
+
+## Troubleshooting
+
+### Common Issues
+
+#### No traces being recorded
+
+1. **Check sampling rate**: Ensure `sampling_rate` in `.tusk/config.yaml` is 1.0
+2. **Verify app readiness**: Make sure you're calling `TuskDrift.markAppAsReady()`
+3. **Check endpoint paths**: Ensure your endpoint isn't in `exclude_paths`
+
+#### Replay failures
+
+1. **Enable service and CLI logs**:
+
+   ```bash
+   tusk run --debug
+   ```
+
+   Logs will be written to `.tusk/logs/`
+
+2. **Test with simple endpoint**: Start with endpoints that only return static data
+
+3. **Check dependencies**: Verify you're using supported package versions
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.