testdriverai 7.8.0-test.0 → 7.8.0-test.10

package/docs/changelog.mdx

@@ -5,7 +5,64 @@ rss: true
 icon: "code-compare"
 ---
 
-<Update label="v7.8.0-canary.4" description="March 2026" tags={["canary"]}>
+<Update label="v7.8.0-test.9" description="March 2026" tags={["test"]}>
+
+🔧 Improvements
+
+- **Stable release promotion** — Fixed an issue where promoting a test or canary release to stable could be incorrectly skipped. Stable releases now proceed reliably regardless of the prior pre-release channel.
+- **Example docs sync** — Example documentation now updates more reliably, continuing even when individual example tests fail so that passing examples still get refreshed.
+
+</Update>
+
+<Update label="v7.8.0-test.8" description="March 2026" tags={["test"]}>
+
+🔧 Improvements
+
+- **VS Code environment switching** — The TestDriver VS Code extension now includes a status bar indicator and a new **TestDriver: Switch Environment** command. You can switch between stable, canary, and test environments directly from VS Code, and your MCP server configuration updates automatically.
+- **Plan rename: Starter → Pro** — The "Starter" plan has been renamed to **Pro**. No changes to pricing or features — just a clearer name. The "Self-Hosted" tier is now labeled **Enterprise**.
+- **SDK network resilience** — API requests now automatically retry on transient server errors (500, 502, 503, 504) with exponential backoff, reducing flaky test failures caused by brief infrastructure hiccups.
+- **Pricing page refresh** — The [hosted plans page](/v7/hosted) now shows plan cards with included minutes, concurrency limits, and pricing at a glance.
+
+📚 Docs updates
+
+- **Quickstart redesign** — The [quickstart](/v7/quickstart) now has tabbed setup paths for CLI, GitHub Copilot, and manual installation.
+- **Deployment section** — "Cloud" is now [Hosted](/v7/hosted) and the previous Enterprise page has been consolidated into [Self-Hosted](/v7/self-hosted), which covers both standard and air-gapped deployments.
+
+</Update>
+
+<Update label="v7.8.0-test.7" description="March 2026" tags={["test"]}>
+This release includes all changes from v7.8.0-test.6 with version bumps across all packages. No additional user-facing changes.
+</Update>
+
+<Update label="v7.8.0-test.6" description="March 2026" tags={["test"]}>
+
+🔧 Improvements
+
+- **Sandbox spawning reliability** — Sandbox creation now uses a 3-minute timeout to handle slow infrastructure, then immediately switches to a 60-second orphan timeout for fast cleanup. This reduces sandbox creation failures during high-traffic periods.
+- **Command deadline timeouts** — Sandbox commands now enforce a hard deadline that terminates execution if the connection drops mid-command, preventing tests from hanging indefinitely.
+- **Real-time channel cleanup** — Fixed a compatibility issue with the real-time messaging layer that could cause channel cleanup to fail during shutdown.
+- **Dashboard timestamp tooltips** — Extended UTC date tooltips to the test history sidebar. Hovering over any relative timestamp (e.g., "5 minutes ago") across the [dashboard](https://console.testdriver.ai) now shows the full UTC date and time.
+
+</Update>
+
+<Update label="v7.8.0-test.4" description="March 2026" tags={["test"]}>
+
+✨ New features
+
+- **[GitHub Copilot integration](/v7/copilot/setup)** — Use TestDriver directly from GitHub Copilot in VS Code. The new MCP server lets Copilot launch sandboxes, interact with elements, and run assertions through natural language. Includes guides for [creating tests](/v7/copilot/creating-tests), [running tests](/v7/copilot/running-tests), [GitHub Actions integration](/v7/copilot/github), and [auto-healing](/v7/copilot/auto-healing).
+
+🔧 Improvements
+
+- **Sandbox reliability** — Linux sandboxes now use a longer creation timeout to handle slow infrastructure, then immediately switch to a short orphan timeout for fast cleanup of disconnected sessions.
+- **Command execution timeouts** — Sandbox commands now have deadline timeouts that prevent hangs if the connection drops mid-execution.
+- **Real-time connection stability** — Updated the real-time messaging layer for better compatibility and more reliable channel cleanup during shutdown.
+- **Dashboard date display** — Hovering over relative timestamps (e.g., "5 minutes ago") now shows the full UTC date and time.
+
+</Update>
+
+<Update label="v7.8.0-canary.5" description="March 2026" tags={["canary"]}>
+This release includes all changes from v7.8.0-canary.4 with version bumps.
+
 ✨ New features
 
 - **[Cache API](/v7/cache)** — Speed up repeated test runs with screenshot-based caching. The system compares screenshots to cached results and reuses element positions when the screen hasn't changed, reducing AI calls.
@@ -21,27 +78,67 @@ icon: "code-compare"
 - [Exec PowerShell](/v7/examples/exec-pwsh) — Generate dynamic data with PowerShell
 - [Focus window](/v7/examples/focus-window) — Switch focus between application windows
 
+🔧 Improvements
+
+- Improved console URL mapping for canary and test environments
+- Enhanced Ably channel cleanup for better resource management
+- Updated release workflow with improved changelog generation
+</Update>
+
+<Update label="v7.5.26" description="March 2026" tags={["stable"]}>
+🚀 Stable release
+
+This release promotes v7.5.25 to stable with deployment channel improvements.
+
+✨ Features
+
+- **Deployment channels** — SDK now supports stable and canary release channels. Stable releases use the `latest` npm tag, while canary releases use the `canary` tag. Install canary with `npm install testdriverai@canary`.
+
+🔧 Improvements
+
+- Improved cache hit debugging and logging
+- Enhanced element location reliability
+- Better error handling during test execution
+
+🐛 Bug fixes
+
+- Fixed restart behavior during auto-updates
+- Fixed console URL routing for various environments
+
 <Note>
-This release includes changes from v7.8.0-test.7 and v7.8.0-test.8.
+This release includes changes from v7.5.17 through v7.5.25.
 </Note>
 </Update>
 
-<Update label="v7.8.0-test.8" description="March 2026" tags={["test"]}>
-✨ New features
+<Update label="v7.5.25" description="March 2026" tags={["stable"]}>
+🐛 Bug fixes
 
-- Added new AI skills for cache, errors, events, provision, redraw, and screenshots
-- Removed automated changelog generation from release workflow
+- Fixed restart update behavior
 </Update>
 
-<Update label="v7.8.0-test.7" description="March 2026" tags={["test"]}>
-🔧 Maintenance
+<Update label="v7.5.24" description="March 2026" tags={["stable"]}>
+🔧 Improvements
 
-- Version bump syntax improvements
+- Disabled auto-update restart to improve CI stability
 </Update>
 
-<Update label="v7.8.0-test.6" description="March 2026" tags={["test"]}>
-🔧 Maintenance
+<Update label="v7.5.22" description="March 2026" tags={["stable"]}>
+🔧 Improvements
+
+- Added markdown-to-HTML rendering for marketing content
+</Update>
+
+<Update label="v7.5.19" description="March 2026" tags={["stable"]}>
+🔧 Improvements
+
+- Enhanced debugging output for cache hits
+- Improved element location reliability
+</Update>
+
+<Update label="v7.5.17" description="March 2026" tags={["stable"]}>
+🔧 Improvements
 
-- Fix changelog generation in release workflow (04a789ec)
+- Improved codespace scaling and development environment setup
+- Updated VS Code extension version
 </Update>
 

package/docs/docs.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://mintlify.com/docs.json",
-  "theme": "palm",
+  "theme": "almond",
   "name": "TestDriver",
   "colors": {
     "primary": "#b3d334",
@@ -48,20 +48,31 @@
                   "/v7/examples/windows-installer"
                 ]
               },
+
               {
-                "group": "Plans & Pricing",
+                "group": "Deployment",
                 "icon": "server",
                 "pages": [
-                  "/v7/cloud",
-                  "/v7/self-hosted",
-                  "/v7/enterprise"
+                  "/v7/hosted",
+                  "/v7/self-hosted"
                 ]
               },
               "/changelog"
             ]
           },
+
           {
-            "group": "Creating Tests",
+            "group": "GitHub Copilot",
+            "pages": [
+              "/v7/copilot/setup",
+              "/v7/copilot/creating-tests",
+              "/v7/copilot/running-tests",
+              "/v7/copilot/github",
+              "/v7/copilot/auto-healing"
+            ]
+          },
+          {
+            "group": "Guide",
             "pages": [
               "/v7/generating-tests",
               "/v7/device-config",
@@ -95,35 +106,37 @@
             ]
           },
           {
-            "group": "Actions",
-            "pages": [
-              "/v7/ai",
-              "/v7/assert",
-              "/v7/captcha",
-              "/v7/click",
-              "/v7/double-click",
-              "/v7/exec",
-              "/v7/find",
-              "/v7/focus-application",
-              "/v7/hover",
-              "/v7/mouse-down",
-              "/v7/mouse-up",
-              "/v7/parse",
-              "/v7/press-keys",
-              "/v7/right-click",
-              "/v7/screenshot",
-              "/v7/type",
-              "/v7/scroll"
-            ]
-          },
-          {
-            "group": "SDK",
+            "group": "SDK Reference",
             "pages": [
-              "/v7/elements",
               "/v7/client",
+              "/v7/elements",
+              {
+                "group": "Actions",
+                "icon": "bolt",
+                "pages": [
+                  "/v7/ai",
+                  "/v7/assert",
+                  "/v7/captcha",
+                  "/v7/click",
+                  "/v7/double-click",
+                  "/v7/exec",
+                  "/v7/find",
+                  "/v7/focus-application",
+                  "/v7/hover",
+                  "/v7/mouse-down",
+                  "/v7/mouse-up",
+                  "/v7/parse",
+                  "/v7/press-keys",
+                  "/v7/right-click",
+                  "/v7/screenshot",
+                  "/v7/scroll",
+                  "/v7/type"
+                ]
+              },
               "/v7/dashcam"
             ]
-          }  ]
+          }
+        ]
       },
       {
         "version": "v6",

package/docs/v7/copilot/auto-healing.mdx

@@ -0,0 +1,265 @@
+---
+title: "Auto-Healing Tests"
+sidebarTitle: "Auto-Healing"
+description: "Set up automatic test repair in CI using GitHub Copilot and TestDriver"
+icon: "bandage"
+---
+
+Auto-healing tests automatically fix themselves when your application changes. By integrating GitHub Copilot with TestDriver in your CI pipeline, you can have AI investigate test failures and propose fixes.
+
+## How It Works
+
+When a test fails in CI:
+
+1. **GitHub Actions detects the failure**
+2. **Copilot spawns the TestDriver agent** with access to the MCP server
+3. **The agent investigates** by running the failing test and analyzing what changed
+4. **Copilot creates a fix** by updating the test code
+5. **A pull request is opened** with the proposed changes for review
+
+## Setting Up Auto-Healing
+
+<Steps>
+  <Step title="Add Repository Secrets">
+    Add your TestDriver API key to your repository secrets:
+
+    1. Go to **Settings → Secrets and variables → Actions**
+    2. Click **New repository secret**
+    3. Add `TD_API_KEY` with your API key value
+  </Step>
+
+  <Step title="Create the Auto-Heal Workflow">
+    Add a GitHub Actions workflow that triggers on test failures:
+
+    ```yaml .github/workflows/auto-heal.yml
+    name: Auto-Heal Tests
+
+    on:
+      workflow_run:
+        workflows: ["Tests"]  # Your main test workflow
+        types: [completed]
+        branches: [main]
+
+    jobs:
+      auto-heal:
+        if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+        runs-on: ubuntu-latest
+        permissions:
+          contents: write
+          pull-requests: write
+
+        steps:
+          - uses: actions/checkout@v4
+
+          - name: Setup Node.js
+            uses: actions/setup-node@v4
+            with:
+              node-version: "20"
+
+          - name: Install dependencies
+            run: npm ci
+
+          - name: Run failing tests and capture output
+            id: tests
+            continue-on-error: true
+            run: |
+              vitest run 2>&1 | tee test-output.txt
+              echo "output<<EOF" >> $GITHUB_OUTPUT
+              cat test-output.txt >> $GITHUB_OUTPUT
+              echo "EOF" >> $GITHUB_OUTPUT
+            env:
+              TD_API_KEY: ${{ secrets.TD_API_KEY }}
+
+          - name: Invoke Copilot to fix tests
+            uses: github/copilot-action@v1
+            with:
+              prompt: |
+                @testdriver The following tests failed:
+
+                ${{ steps.tests.outputs.output }}
+
+                Please investigate each failure by:
+                1. Running the failing test
+                2. Analyzing what changed in the UI or behavior
+                3. Updating the test code to fix the issue
+
+                Create a commit with your changes.
+            env:
+              TD_API_KEY: ${{ secrets.TD_API_KEY }}
+
+          - name: Create Pull Request
+            uses: peter-evans/create-pull-request@v5
+            with:
+              title: "Auto-heal: Fix failing tests"
+              body: |
+                This PR was automatically generated by the auto-heal workflow.
+
+                ## Changes
+                The following tests were updated to fix failures detected in CI.
+
+                ## Review
+                Please review the changes carefully before merging.
+              branch: auto-heal/${{ github.run_id }}
+              commit-message: "fix: auto-heal failing tests"
+    ```
+  </Step>
+
+  <Step title="Configure Test Workflow">
+    Make sure your main test workflow has a name that matches the `workflows` trigger:
+
+    ```yaml .github/workflows/tests.yml
+    name: Tests  # Must match the workflow_run trigger
+
+    on:
+      push:
+        branches: [main]
+      pull_request:
+
+    jobs:
+      test:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v4
+          - uses: actions/setup-node@v4
+            with:
+              node-version: "20"
+          - run: npm ci
+          - run: vitest run
+            env:
+              TD_API_KEY: ${{ secrets.TD_API_KEY }}
+    ```
+  </Step>
+</Steps>
+
+## Example: Button Text Change
+
+Here's what auto-healing looks like when a button's text changes:
+
+<Steps>
+  <Step title="Application Changes">
+    A developer changes a button's text from "Submit" to "Send":
+
+    ```html
+    <!-- Before -->
+    <button>Submit</button>
+
+    <!-- After -->
+    <button>Send</button>
+    ```
+  </Step>
+
+  <Step title="Test Fails">
+    The test fails because it's looking for the old text:
+
+    ```javascript
+    // This now fails
+    const submitButton = await testdriver.find("Submit button");
+    ```
+  </Step>
+
+  <Step title="Auto-Heal Triggers">
+    The auto-heal workflow runs, and Copilot investigates:
+
+    ```
+    The test is looking for a "Submit button" but I see a "Send button"
+    on the page. The button functionality is the same, just the text changed.
+    I'll update the test to use the new text.
+    ```
+  </Step>
+
+  <Step title="PR Created">
+    A pull request is opened with the fix:
+
+    ```javascript
+    // Updated by auto-heal
+    const submitButton = await testdriver.find("Send button");
+    ```
+  </Step>
+</Steps>
+
+## Configuration Options
+
+### Selective Auto-Healing
+
+You can limit auto-healing to specific test files or patterns:
+
+```yaml
+- name: Run failing tests
+  run: |
+    # Only heal tests in the e2e directory
+    vitest run tests/e2e/ 2>&1 | tee test-output.txt
+```
+
+### Manual Approval
+
+For safety, you can require manual approval before auto-heal runs:
+
+```yaml
+jobs:
+  auto-heal:
+    environment: auto-heal  # Requires approval
+```
+
+Configure the environment in **Settings → Environments** with required reviewers.
+
+### Limiting Changes
+
+Add instructions to constrain what the AI can change:
+
+```yaml
+- name: Invoke Copilot to fix tests
+  uses: github/copilot-action@v1
+  with:
+    prompt: |
+      @testdriver Fix the failing tests.
+
+      Rules:
+      - Only update element selectors and text matching
+      - Do not change test logic or assertions
+      - Do not add or remove tests
+      - Keep changes minimal
+```
+
+## Best Practices
+
+<AccordionGroup>
+  <Accordion title="Always review auto-heal PRs">
+    Auto-heal is a tool, not a replacement for human judgment. Review all changes before merging to ensure the test still validates what you intended.
+  </Accordion>
+
+  <Accordion title="Use descriptive element descriptions">
+    Tests with clear, semantic descriptions are easier for the AI to heal:
+    ```javascript
+    // ✅ Good - describes purpose
+    await testdriver.find("primary call-to-action button in the hero section");
+
+    // ❌ Bad - too vague
+    await testdriver.find("button");
+    ```
+  </Accordion>
+
+  <Accordion title="Set up notifications">
+    Configure GitHub notifications or Slack integration to be alerted when auto-heal PRs are created.
+  </Accordion>
+
+  <Accordion title="Track heal rate">
+    Monitor how often tests need healing. High heal rates may indicate:
+    - Tests are too brittle
+    - Application is changing rapidly
+    - Element descriptions need improvement
+  </Accordion>
+</AccordionGroup>
+
+## Limitations
+
+Auto-healing works best for:
+- Element text changes
+- Layout and styling updates
+- Minor UI restructuring
+
+It may struggle with:
+- Major workflow changes
+- New features requiring new assertions
+- Complex multi-step interactions
+
+For significant changes, create new tests manually using the [TestDriver agent](/v7/copilot/creating-tests).

package/docs/v7/copilot/creating-tests.mdx

@@ -0,0 +1,156 @@
+---
+title: "Creating Tests"
+sidebarTitle: "Creating Tests"
+description: "Use the TestDriver agent and MCP to create tests through natural language"
+icon: "wand-magic-sparkles"
+---
+
+With GitHub Copilot and TestDriver's MCP server, you can create tests by chatting with an AI agent. The agent spawns a virtual machine, executes actions, and writes test code for you.
+
+## Start a Conversation
+
+Open GitHub Copilot Chat in VS Code. If your project has no other agents configured, the TestDriver agent is used by default. Otherwise, select **testdriver** from the agent dropdown in the chat panel.
+
+Describe what you want to test:
+
+```
+Create a test that logs into my app at https://myapp.com
+```
+
+The agent will:
+1. Start a new session and spawn a Linux virtual machine
+2. Launch Chrome and navigate to your URL
+3. Execute actions based on your instructions
+4. Write the test code to a `.test.mjs` file
+
+<Note>
+  The TestDriver agent appears in the agent selection dropdown if you have other agents configured (like `copilot-instructions.md` or other `.agent.md` files). Make sure to select **testdriver** to use TestDriver's MCP tools.
+</Note>
+
+## Live Preview Panel
+
+When the agent starts a session, a **live preview panel** opens in VS Code. This lets you:
+
+- **Watch tests execute** in real-time
+- **Interact with the VM** — click, type, and navigate manually
+- **Debug issues** — see exactly what the AI sees
+
+<Note>
+  The live preview panel requires the TestDriver VS Code extension. Set `TD_PREVIEW=ide` in your MCP configuration to enable it. See the [device configuration docs](/v7/device-config) for all preview options.
+</Note>
+
+## Interactive Workflow
+
+The recommended workflow for creating tests:
+
+<Steps>
+  <Step title="Describe Your Test">
+    Tell the agent what you want to test:
+
+    ```
+    Test the checkout flow on https://shop.example.com
+    ```
+  </Step>
+
+  <Step title="Watch and Guide">
+    The agent will start executing. Watch the preview panel and provide guidance if needed:
+
+    ```
+    The login modal appeared. Use test@example.com and password123
+    ```
+  </Step>
+
+  <Step title="Add Assertions">
+    Ask the agent to verify specific conditions:
+
+    ```
+    Assert that the order confirmation page is shown with the order number
+    ```
+  </Step>
+
+  <Step title="Review the Code">
+    The agent writes test code as it works. Review the generated `.test.mjs` file and make any adjustments.
+  </Step>
+</Steps>
+
+## Example Conversation
+
+Here's a complete example of creating a login test:
+
+```
+You: Create a test for the login flow at https://console.testdriver.ai
+
+Agent: I'll create a test for the login flow. Starting a session...
+       [Screenshot: Login page loaded]
+
+       I can see the login page. Let me find the email input.
+       [Screenshot: Email input highlighted]
+
+       Now I'll type the email and find the password field...
+
+You: Use test@example.com for the email
+
+Agent: Got it. Typing test@example.com...
+       [Screenshot: Email entered]
+
+       Now entering the password and clicking Sign In...
+       [Screenshot: Dashboard loaded]
+
+       ✅ Login successful! I've written the test to tests/login.test.mjs
+```
+
+## Generated Test Code
+
+The agent generates standard Vitest test files:
+
+```javascript tests/login.test.mjs
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "testdriverai/vitest/hooks";
+
+describe("Login Flow", () => {
+  it("should log in successfully", async (context) => {
+    const testdriver = TestDriver(context);
+
+    await testdriver.provision.chrome({
+      url: "https://console.testdriver.ai"
+    });
+
+    const emailInput = await testdriver.find("email input field");
+    await emailInput.click();
+    await testdriver.type("test@example.com");
+
+    const passwordInput = await testdriver.find("password input field");
+    await passwordInput.click();
+    await testdriver.type("password123");
+
+    const signInButton = await testdriver.find("Sign In button");
+    await signInButton.click();
+
+    const result = await testdriver.assert("dashboard is visible");
+    expect(result).toBeTruthy();
+  });
+});
+```
+
+## Tips for Better Tests
+
+<AccordionGroup>
+  <Accordion title="Be specific with element descriptions">
+    Instead of "click the button", say "click the blue Sign In button in the header". More context helps the AI find the right element.
+  </Accordion>
+  <Accordion title="Add waits for dynamic content">
+    If your app has animations or loading states, tell the agent to wait:
+    ```
+    Wait for the loading spinner to disappear before continuing
+    ```
+  </Accordion>
+  <Accordion title="Use assertions liberally">
+    Add assertions after each major action to catch regressions early:
+    ```
+    Assert that the product was added to the cart
+    ```
+  </Accordion>
+  <Accordion title="Break complex flows into steps">
+    For long workflows, create the test incrementally and verify each step works before moving on.
+  </Accordion>
+</AccordionGroup>