gatling-playwright-plugin

BrowserDsl JavaAPI

Browser Protocol

Used to configure the Gatling browser protocol.

ProtocolBuilder browserProtocol = BrowserDsl
        .gatlingBrowser()
        // Optional setup block
        .withLaunchOptions(new LaunchOptions().setHeadless(false))
        .withContextOptions(new NewContextOptions().setViewportSize(1920, 1080).setIsMobile(true))
        .enableUIMetrics()
        //
        .buildProtocol();

Action name

// with a static value
BrowserDsl.browserAction("HomePage")
// with a dynamic value computed from a Gatling Expression Language String
BrowserDsl.browserAction("#{actionName}")
// a dynamic value computed from a function
BrowserDsl.browserAction(session -> session.getString("actionName"))

Open action

// with an absolute static url
BrowserDsl.browserAction("name").open("https://docs.gatling.io/")
// with a dynamic value computed from a Gatling Expression Language String
BrowserDsl.browserAction("name").open("#{url}")
// a dynamic value computed from a function
BrowserDsl.browserAction("name").open(session -> session.getString("url")

It is possible to set additional navigation options or page load validation. See the NavigateOptions documentation here.

BrowserDsl.browserAction("name").open("https://docs.gatling.io/").withNavigateOptions(new Page.NavigateOptions().setWaitUntil(LOAD))

See the LoadValidations documentations here

String validationScript =
        """
                (function () {
                  const el = document.querySelector('[data-test-id="chat-widget-iframe"]');
                  return document.readyState === "complete" &&
                         el !== null &&
                         el.getBoundingClientRect().width > 0 &&
                         el.getBoundingClientRect().height > 0;
                })();
    """;
PageLoadValidator pageLoadValidator = new PageLoadValidator(validationScript, null, new Page.WaitForFunctionOptions().setPollingInterval(100).setTimeout(30000));

BrowserDsl.browserAction("name").open("https://docs.gatling.io/").withLoadValidations(pageLoadValidator))

You can use it with default script that check pageCompleteCheckByInactivity similar that make sitespeed tool

BrowserDsl.browserAction("name").open("https://docs.gatling.io/").withLoadValidations())

Flow Action

Sometimes, you need to verify that a page has loaded programmatically. In such cases, you can use a script.

Note: You should always return browserSession.

BrowserDsl.browserAction("test").executeFlow((page, browserSession) -> {
    page.navigate("https://docs.gatling.io/");
    page.locator("//*[@id=\"ai-initial-message\"]").isVisible();
    return browserSession;
});

For advanced example see this guide

Browser Session Function

Allows manipulation of a page without tracking it in reports.

Note: Typically used to extract data and store it in Gatling sessions.

BrowserDsl.browserSessionFunction((page, browserSession) -> {
    Session session = browserSession.getJavaSession().set("pageTitle", page.title());
    return browserSession.updateBrowserSession(session);
});

Clean Context

Provides a way to clean up the Playwright BrowserContext.

Note: Usually used at the end of a loop.

BrowserDsl.browserCleanContext()

This site is open source. Improve this page.