Menu
Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/browserbreadcrumb arrow Pagebreadcrumb arrow waitForURL(url[, options])
Open source

waitForURL(url[, options])

Waits for the page to navigate to the specified URL. This method is useful for ensuring that navigation to a particular URL has completed before proceeding with the test. This is especially useful if there are multiple redirects before hitting the end destination.

ParameterTypeDefaultDescription
urlstring|RegExp-Required. URL or URL pattern to match against. The method will wait until the page navigates to a URL that matches this parameter.
optionsobjectnull
options.timeoutnumber30000Maximum time in milliseconds. Pass 0 to disable the timeout. Default is overridden by the setDefaultTimeout option on BrowserContext or Page.
options.waitUntilstringloadWhen to consider operation to have succeeded. See Events for more details.

Events

Caution

networkidle is DISCOURAGED. Don’t use this method for testing especially with chatty websites where the event may never fire, rely on web assertions to assess readiness instead.

Events can be either:

  • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
  • 'load' - consider operation to be finished when the load event is fired.
  • 'networkidle' - Consider operation to be finished when there are no network connections for at least 500 ms.

Returns

TypeDescription
PromiseA Promise that resolves when the page has navigated to the specified URL and the specified load state has been reached.

Examples

JavaScript 
import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    browser: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    await page.goto('https://quickpizza.grafana.com/test.k6.io/');

    // Wait for navigation to a specific URL
    await Promise.all([
      page.click('a[href="/my_messages.php"]'),
      page.waitForURL('https://quickpizza.grafana.com/my_messages.php'),
    ]);

    await page.goto('https://quickpizza.grafana.com/test.k6.io/');

    // Wait for navigation using URL pattern with RegExp
    await Promise.all([page.click('a[href="/browser.php"]'), page.waitForURL(/\/browser\.php$/)]);
  } finally {
    await page.close();
  }
}

Valid usage patterns for waitForURL

Use one of the following patterns to coordinate the action that triggers navigation with waiting for the final URL.

js 
await Promise.all([
  page.waitForURL('https://quickpizza.grafana.com/my_messages.php'),
  page.locator('a[href="/my_messages.php"]').click(),
]);

or

js 
const navPromise = page.waitForURL('https://quickpizza.grafana.com/my_messages.php');
await page.locator('a[href="/my_messages.php"]').click();
await navPromise;

Unlike waitForNavigation, waitForURL will first check whether it is already on the page with the given URL before proceeding to wait. If it is already there and the waitUntil condition has also been met, it will return straight away. This means that it is safe to do this:

js 
await page.locator('a[href="/my_messages.php"]').click();
await page.waitForURL('https://quickpizza.grafana.com/my_messages.php');

Best practices

  1. Use appropriate matching: Choose the right matching method based on your needs:

    • Exact strings for known, static URLs
    • RegExp for pattern-based matching and complex URL validation

  2. Handle dynamic content: For URLs with dynamic parts (IDs, timestamps), use regular expression patterns instead of exact matches.

  3. Set appropriate timeouts: Adjust timeouts based on expected navigation time and network conditions.

  4. Verify final state: After waiting for URL, verify that the page content matches your expectations.

Common use cases

  • Form submissions: Verify redirects after successful form submission
  • Authentication flows: Wait for login/logout redirects
  • E-commerce: Track progression through shopping and checkout flows
  • SPAs: Handle client-side routing changes
  • API redirects: Wait for server-side redirects after API calls