Handle an element that isn't found - TestDriver

This test looks for an element that isn’t on the page. Use this pattern when an element may not appear.

Watch it run

The test

element-not-found.test.mjs

import { describe, expect, it } from "vitest";
import { TestDriver } from "testdriverai/vitest/hooks";

describe("Element Not Found Test", () => {
  it("should handle non-existent element gracefully without timing out", async (context) => {
    const testdriver = TestDriver(context);
    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });

    // Try to find an element that definitely doesn't exist
    const element = await testdriver.find(
      "a purple unicorn dancing on the moon",
    );

    // Should return an element that is not found
    expect(element.found()).toBe(false);
    expect(element.coordinates).toBeNull();
  });
});

How it works

By default, find() checks the screen every 5 seconds for up to 10 seconds.
When nothing matches, find() doesn’t throw.
Instead, it returns an element whose found() is false and whose coordinates are null.
Calling click() on an unfound element throws an ElementNotFoundError.

Run it

The test is in the TestDriver SDK repository. Clone it, install dependencies, and run the file:

git clone https://github.com/testdriverai/testdriverai
cd testdriverai
npm install
npx vitest run examples/element-not-found.test.mjs

The test reads your API key from TD_API_KEY. Create a key at console.testdriver.ai/team/api-keys. Then set it in your environment or a .env file.