Vaadin TestBench升级至24.3.x后ElementQuery无法识别元素求助

问题描述 #

我们将Jenkins、Java/JDK升级至17，同步把Vaadin TestBench版本升到24.3.x，针对部分废弃内容做了少量重构。此前使用Java 1.8+Vaadin TestBench 15.0.2时一切正常，升级后现有ElementQuery类/元素无法被识别，执行代码时抛出报错：

java.lang.IllegalStateException: Context cannot be null at com.vaadin.testbench.ElementQuery.executeSearch(ElementQuery.java:403)

相关依赖配置 #

<groupId>com.vaadin</groupId>
<artifactId>vaadin-testbench</artifactId>
<version>24.3.8</version>

代码示例 #

报错触发代码 #

navigateToPaynow(payNowUrl); // 可正常启动应用
SignInPage signInPage = $(SignInPage.class).first(); // 此处触发报错
signInPage.clickGuestCheckoutButton();

SignInPage类定义 #

@Element("sign-in")
public class SignInPage extends TestBenchElement {
    @Step("Clicking Guest Checkout button")
    public void clickGuestCheckoutButton() {
        try {
            guestCheckOutButton().click();
        } catch (Exception e) {
            // 原代码未展示异常处理逻辑
        }
    }

    protected ButtonElement guestCheckOutButton() {
        return $(ButtonElement.class).last();
    }
}

问题原因与解决办法 #

1. 上下文绑定丢失
   TestBench 24.x基于Selenium 4+构建，对元素查询的上下文绑定要求更严格，全局$(...)查询需要确保当前WebDriver上下文已正确关联。
   解决：确保查询前WebDriver实例已初始化并绑定到TestBench上下文，可显式指定上下文查询：

// 方式1：通过驱动实例直接查找元素
SignInPage signInPage = getDriver().findElement(SignInPage.class);
// 方式2：创建带驱动上下文的ElementQuery
SignInPage signInPage = new ElementQuery<>(SignInPage.class, getDriver()).first();

2. 元素加载时机未等待
   升级后页面元素加载逻辑可能变化，原代码未等待元素就绪就执行查询，导致上下文未初始化。
   解决：添加显式等待，确保目标元素加载完成后再执行查询：

WebDriverWait wait = new WebDriverWait(getDriver(), Duration.ofSeconds(10));
wait.until(ExpectedConditions.presenceOfElementLocated(By.tagName("sign-in")));
SignInPage signInPage = $(SignInPage.class).first();

3. 元素类注解与父类兼容性
   检查@Element注解的使用是否符合TestBench 24.x规范，确保自定义元素类继承的TestBenchElement来自com.vaadin.testbench.elementbase包，避免包导入错误导致的上下文异常。

内容的提问来源于stack exchange，提问作者SamVaadin