[🐛 Bug]: fields in generated classes are not accessible (Rectangle, ArrayOfStrings)

[m7Rahm]

Description

Fields of classes in devtools.v133 are not accessible. From the source code it seems like these classes are generated based on the CDP definition (ref).
Rectangle class has a private field rectangle, but it cannot be accessed, as it's not exposed.
The same issue exists for the ArrayOfStrings class, which has an inaccessible private field arrayOfStrings.
This issue probably exists in other generated classes, but currently these are the ones we are interested in.

Reproducible Code

import org.openqa.selenium.devtools.v133.domsnapshot.model.Rectangle
import org.openqa.selenium.devtools.v133.domsnapshot.model.ArrayOfStrings

You will see that fields of classes are not accessible.

[selenium-ci]

@m7Rahm, thank you for creating this issue. We will troubleshoot it as soon as we can.

Selenium Triage Team: remember to follow the Triage Guide

[github-actions]

⚠️ You reported using Selenium version 4.29.0, but the latest release is 4.34.

Please verify that this issue still occurs with the latest version. If it no longer applies, you can close this issue or update your comment.

This issue will be marked "awaiting answer" and may be closed automatically if no response is received.

[diemol]

What is the actual issue? Why do you need those?

[m7Rahm]

The issue is that fields of those classes are not available? They are returned in captureSnapshot call. How else can we access the coordinates of bounds which are defined here?

[diemol]

Can you provide the whole script to better understand what you are doing?

[m7Rahm]

This is how we are calling captureSnapshot method which is available here:

import org.openqa.selenium.devtools.v133.domsnapshot.model.Rectangle

fun captureLayoutTreeSnapshot(
        computedStyles: List<String>,
        includeDomRects: Boolean = false,
    ): DOMSnapshot.CaptureSnapshotResponse {
        return devTools.send(
            DOMSnapshot.captureSnapshot(
                computedStyles,
                Optional.empty(),
                Optional.of(includeDomRects),
                Optional.empty(),
                Optional.empty(),
            ),
        )
    }

val domSnapshotResponse = captureLayoutTreeSnapshot(emptyList(), includeDomRects = true)
val parentDocument = domSnapshotResponse.documents.first()
val secondNodeBounds: Rectangle = parentDocument.layout.bounds[1]

// Access coordinates of the second node in the document. 
// Cannot access, because Rectangle class does not expose underlying coordinates.

it returns a list of DocumentSnapshot objects. There's a layout property available on this type, which is of LayoutTreeSnapshot type.
IntelliJ decompiled code shows that there's a private field rectangle, but no method exposes its value:

package org.openqa.selenium.devtools.v133.domsnapshot.model;

import java.util.List;
import java.util.Objects;
import org.openqa.selenium.json.JsonInput;

public class Rectangle {
    private final List<Number> rectangle;

    public Rectangle(List<Number> rectangle) {
        this.rectangle = (List)Objects.requireNonNull(rectangle, "Missing value for Rectangle");
    }

    private static Rectangle fromJson(JsonInput input) {
        return new Rectangle(input.readArray(Number.class));
    }

    public String toString() {
        return this.rectangle.toString();
    }
}

LayoutTreeSnapshot contains multiple fields which exposes coordinates of nodes on the webpage (in the DOM).

• bounds
• offsetRects
• clientRects
• offsetRects

All of these fields are of Rectangle type. This class is a generated class in Selenium and is available in the org.openqa.selenium.devtools.v133.domsnapshot.model package.

There's no way to access coordinates of elements, because Rectangle class defined (generated) in org.openqa.selenium.devtools.v133.domsnapshot.model does not expose them.

I hope it explains the issue. I am not sure how I can create a script to reproduce the issue, since the issue is related to client package not exposing underlying fields.

[diemol]

Got it. Those classes are generated when the release is done by CdpClientGenerator.java.

You can have a look and send us a PR to make those fields accessible. I am suggesting this because our focus is to work on BiDi, and anything related to CDP won't be done, as in the mid-long term, this code will be deprecated.