Skip to main content

url

Overview​

Opens a URL. In Testplane, omitting the argument or passing an empty string returns the current URL without navigation. Navigating to the same URL again reloads the page.

With baseUrl, the address is resolved using url.resolve(baseUrl, url). For baseUrl equal to http://example.com/site/, relative opens /site/relative, while /rootRelative opens /rootRelative. An absolute URL does not depend on baseUrl. The trailing / in the base address affects relative path resolution.

Usage​

await browser.url(url, options); await browser.url()

Command parameters​

ParameterDescription
urlAbsolute or relative address string. Omit it to read the current address.
options.waitBiDi: none, interactive, complete or networkIdle. Defaults to the session page-load strategy; normally complete. See the networkIdle limitation below.
options.timeoutBiDi: timeout for networkIdle only, default 5000 ms. Does not replace Testplane or page-load timeouts.
options.headersBiDi: headers for the navigation request, not persistent headers for every page resource.
options.authBiDi: { user, pass } for HTTP Basic Auth. Replaces Authorization from headers. Use HTTPS and keep secrets out of test files.
options.onBeforeLoadBiDi: function run before the new document scripts. It is serialized and cannot access Node.js closures.

Limitations​

Options apply only to HTTP(S) navigation in BiDi. The Testplane wrapper ignores the second argument in Classic. After successful navigation, the temporary init script is removed; its changes in the loaded document remain until the next navigation.

In the verified Testplane 9.3.2 / WDIO 9.6.2 / Chrome 150 combination, networkIdle fails with Couldn't find request for navigation with id ...: the implementation looks up a navigation request using a context ID. Use complete, then explicitly wait for the required application state. complete alone does not mean that background application requests have finished.

Result​

Without an address, returns the current URL string. Navigation returns undefined in Classic; in BiDi it may return navigation request data or undefined. To read the address, use getUrl() or url() without an argument.

Example​

The example uses Chrome/BiDi and a test HTTP server in baseUrl. At /navigation, a page script records window.initialSeed = window.navigationSeed ?? null, and the server embeds the received x-example header in window.receivedHeader. The root path serves a regular HTML page.

const assert = require("node:assert/strict");

it("url: navigate with BiDi options and read the current URL", async ({ browser }) => {
    await browser.url("/");
    const target = new URL("/navigation", await browser.getUrl()).href;
    await browser.sessionSubscribe({
        events: ["network.beforeRequestSent", "network.responseStarted"],
    });
    await browser.url(target, {
        wait: "complete",
        headers: { "x-example": "navigation" },
        onBeforeLoad: () => {
            window.navigationSeed = 42;
        },
    });
    assert.equal(await browser.url(), target);
    assert.deepEqual(await browser.execute(() => [window.initialSeed, window.receivedHeader]), [
        42,
        "navigation",
    ]);
    await browser.execute(() => {
        window.unsavedValue = "temporary";
    });
    await browser.url(target);
    assert.equal(await browser.execute(() => typeof window.unsavedValue), "undefined");
    assert.equal(await browser.execute(() => window.initialSeed), null);
});

References​

This page draws on the original WebdriverIO article.

On this page