testdriverai 7.5.16 → 7.5.18

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 7.5.18 (2026-03-09)
+
+## 🔧 Maintenance
+
+- Optimize monitoring performance by reducing transaction sampling rate [Image Worker] (adb2a35d)
+
+## 7.5.17 (2026-03-07)
+
+## ✨ Features
+- Enhanced marketing website with new "How It Works" section and improved visual components (161c1c7b)
+- Added new brand assets and workflow illustrations for better user onboarding (161c1c7b)
+
+## 🐛 Bug Fixes
+- Fixed Stripe checkout pricing and authentication issues [API] (161c1c7b)
+- Resolved potential witness functionality issues [SDK] (161c1c7b)
+
+## 🔧 Maintenance
+- Updated SDK documentation examples with improved formatting and generation scripts [SDK] (161c1c7b)
+- Enhanced sandbox authentication and SDK functionality [SDK] (161c1c7b)
+- Improved development environment configuration and tooling (161c1c7b)
+
 ## 7.5.16 (2026-03-07)
 
 ## ✨ Features

package/agent/lib/sandbox.js

@@ -534,7 +534,17 @@ const createSandbox = function (emitter, analytics, sessionInstance) {
       }
 
       if (message.type === "direct") {
-        // If the API provisioned Ably credentials to the instance (reply.agent present),
+        // If the API returned agent config and we have an instanceId,
+        // provision the config to the instance via SSM (client-side).
+        // This runs from the user's infrastructure where AWS permissions exist,
+        // rather than from the API server.
+        if (reply.agentConfig && message.instanceId) {
+          logger.log('Provisioning agent config to instance ' + message.instanceId + ' via SSM...');
+          await this._provisionAgentConfig(message.instanceId, reply.agentConfig);
+          logger.log('Agent config provisioned successfully.');
+        }
+
+        // If the API returned agent credentials (reply.agent present),
         // wait for the runner agent to signal readiness before sending commands.
         // Without this gate, commands published before the agent subscribes are lost.
         var self = this;
@@ -934,6 +944,51 @@ const createSandbox = function (emitter, analytics, sessionInstance) {
       this._lastConnectParams = null;
       this.ps = {};
     }
+
+    /**
+     * Write the agent config JSON to an EC2 instance via AWS SSM.
+     * Runs client-side so the API doesn't need AWS permissions on user infra.
+     */
+    async _provisionAgentConfig(instanceId, agentConfig) {
+      const { execSync } = require('child_process');
+      const { writeFileSync, unlinkSync } = require('fs');
+      const { join } = require('path');
+      const { tmpdir } = require('os');
+
+      const configJson = JSON.stringify(agentConfig);
+      const region = process.env.AWS_REGION || 'us-east-2';
+
+      // Write SSM parameters to a temp file to avoid shell quoting issues
+      const paramsJson = JSON.stringify({
+        commands: [
+          "$config = '" + configJson.replace(/'/g, "''") + "'",
+          "[System.IO.File]::WriteAllText('C:\\Windows\\Temp\\testdriver-agent.json', $config)",
+          "Write-Host 'Config written for sandbox " + agentConfig.sandboxId + "'",
+        ],
+      });
+      const tmpFile = join(tmpdir(), 'td-provision-' + Date.now() + '.json');
+      writeFileSync(tmpFile, paramsJson);
+
+      try {
+        const output = execSync(
+          'aws ssm send-command --region "' + region + '" --instance-ids "' + instanceId + '" ' +
+          '--document-name "AWS-RunPowerShellScript" ' +
+          '--parameters file://' + tmpFile + ' --output json',
+          { encoding: 'utf-8', timeout: 30000 }
+        );
+        const cmdId = JSON.parse(output).Command.CommandId;
+        logger.log('SSM command sent: ' + cmdId);
+
+        // Wait for the command to complete
+        execSync(
+          'aws ssm wait command-executed --region "' + region + '" ' +
+          '--command-id "' + cmdId + '" --instance-id "' + instanceId + '"',
+          { encoding: 'utf-8', timeout: 60000 }
+        );
+      } finally {
+        try { unlinkSync(tmpFile); } catch (e) { /* ignore */ }
+      }
+    }
   }
 
   return new Sandbox();

package/agent/lib/sdk.js

@@ -218,6 +218,7 @@ const createSDK = (emitter, config, sessionInstance) => {
       method: "post",
       headers: {
         "Content-Type": "application/json",
+        "User-Agent": `TestDriverSDK/${version} (Node.js ${process.version})`,
       },
       timeout: 15000, // 15 second timeout for auth requests
       data: {
@@ -309,6 +310,18 @@ const createSDK = (emitter, config, sessionInstance) => {
       return rateLimitError;
     }
 
+    // Forbidden (403) - likely Cloudflare or WAF blocking the request
+    if (status === 403) {
+      const forbiddenError = new Error(
+        "Request blocked (HTTP 403). This may be caused by a firewall or bot protection. " +
+        "If this persists, please contact support."
+      );
+      forbiddenError.code = "REQUEST_BLOCKED";
+      forbiddenError.isForbiddenError = true;
+      forbiddenError.originalError = error;
+      return forbiddenError;
+    }
+
     // Other HTTP errors - return with context
     const url = error.config?.url || apiRoot;
     const genericError = new Error(
@@ -366,6 +379,7 @@ const createSDK = (emitter, config, sessionInstance) => {
           method: "post",
           headers: {
             "Content-Type": "application/json",
+            "User-Agent": `TestDriverSDK/${version} (Node.js ${process.version})`,
             ...(token && { Authorization: `Bearer ${token}` }),
           },
           timeout: 15000,
@@ -430,6 +444,7 @@ const createSDK = (emitter, config, sessionInstance) => {
       method: "post",
       headers: {
         "Content-Type": "application/json",
+        "User-Agent": `TestDriverSDK/${version} (Node.js ${process.version})`,
         ...(token && { Authorization: `Bearer ${token}` }), // Add the authorization bearer token only if token is set
         ...sentryHeaders, // Add Sentry distributed tracing headers
       },

package/docs/_scripts/generate-examples.js

@@ -82,9 +82,35 @@ function getExampleFiles() {
     .sort();
 }
 
+// Rewrite internal imports and helpers to their public equivalents
+function transformContentForDocs(content) {
+  let transformed = content;
+
+  // Rewrite internal relative import to the public package path
+  transformed = transformed.replace(
+    /from\s+["']\.\.\/lib\/vitest\/hooks\.mjs["']/g,
+    'from "testdriverai/vitest/hooks"'
+  );
+
+  // Remove internal config helper import
+  transformed = transformed.replace(
+    /import\s+\{[^}]*getDefaults[^}]*\}\s+from\s+["']\.\/config\.mjs["'];\n?/g,
+    ''
+  );
+
+  // Replace getDefaults(context) spread with inline defaults
+  transformed = transformed.replace(
+    /\{\s*\.\.\.getDefaults\(context\)\s*/g,
+    '{ ip: context.ip || process.env.TD_IP'
+  );
+
+  return transformed;
+}
+
 // Parse test file to extract metadata
 function parseTestFile(filePath) {
-  const content = fs.readFileSync(filePath, "utf-8");
+  const raw = fs.readFileSync(filePath, "utf-8");
+  const content = transformContentForDocs(raw);
   const filename = path.basename(filePath);
 
   // Extract JSDoc comment at top of file

package/docs/v7/examples/ai.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 describe("AI Test", () => {
   it("should use ai to search for testdriver on Google", async (context) => {

package/docs/v7/examples/assert.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 describe("Assert Test", () => {
   it("should assert the testdriver login page shows", async (context) => {

package/docs/v7/examples/captcha-api.mdx

@@ -26,7 +26,7 @@ Watch this test execute in a real sandbox environment:
  * TestDriver SDK - Captcha Test
  */
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 console.log("DEBUG: process.env.TD_OS:", process.env.TD_OS);
 

package/docs/v7/examples/chrome-extension.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 describe("Chrome Extension Test", () => {
   it("should load hello-world Chrome extension from local path", async (context) => {

package/docs/v7/examples/drag-and-drop.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 const isLinux = (process.env.TD_OS || "linux") === "linux";
 

package/docs/v7/examples/element-not-found.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 describe("Element Not Found Test", () => {
   it("should handle non-existent element gracefully without timing out", async (context) => {

package/docs/v7/examples/hover-image.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 /**
  * Perform login flow for SauceLabs demo app

package/docs/v7/examples/hover-text.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 describe("Hover Text Test", () => {
   it("should click Sign In and verify error message", async (context) => {

package/docs/v7/examples/installer.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 const isLinux = (process.env.TD_OS || "linux") === "linux";
 

package/docs/v7/examples/launch-vscode-linux.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 const isLinux = (process.env.TD_OS || "linux") === "linux";
 

package/docs/v7/examples/match-image.mdx

@@ -29,7 +29,7 @@ Watch this test execute in a real sandbox environment:
 import path, { dirname } from "path";
 import { fileURLToPath } from "url";
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 /**
  * Perform login flow for SauceLabs demo app

package/docs/v7/examples/press-keys.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 describe("Press Keys Test", () => {
   it("should create tabs and navigate using keyboard shortcuts", async (context) => {

package/docs/v7/examples/scroll-keyboard.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 describe("Scroll Keyboard Test", () => {
   it("should navigate to webhamster.com and scroll with keyboard", async (context) => {

package/docs/v7/examples/scroll-until-image.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 describe("Scroll Until Image Test", () => {
   it.skip("should scroll until brown colored house image appears", async (context) => {

package/docs/v7/examples/scroll-until-text.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 /**
  * Perform login flow for SauceLabs demo app

package/docs/v7/examples/scroll.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 describe("Scroll Test", () => {
   it("should navigate and scroll down the page", async (context) => {

package/docs/v7/examples/type.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, expect, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 describe("Type Test", () => {
   it("should enter standard_user in username field", async (context) => {

package/docs/v7/examples/windows-installer.mdx

@@ -27,7 +27,7 @@ Watch this test execute in a real sandbox environment:
  */
 
 import { describe, it } from "vitest";
-import { TestDriver } from "../lib/vitest/hooks.mjs";
+import { TestDriver } from "testdriverai/vitest/hooks";
 
 const isLinux = (process.env.TD_OS || "linux") === "linux";
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testdriverai",
-  "version": "7.5.16",
+  "version": "7.5.18",
   "description": "Next generation autonomous AI agent for end-to-end testing of web & desktop",
   "main": "sdk.js",
   "types": "sdk.d.ts",