Skip to content

[java] Deprecate methods to avoid internal BiDi connection surfacing on driver #17751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pujagani merged 1 commit into from
Jul 6, 2026
+10 −0
Merged

[java] Deprecate methods to avoid internal BiDi connection surfacing on driver #17751

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions java/src/org/openqa/selenium/bidi/HasBiDi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,20 @@

@Beta
public interface HasBiDi {
/**
* @deprecated BiDi is an internal implementation detail. Direct access to the BiDi object from
* drivers will be removed in a future release.
*/
@Deprecated(since = "4.46", forRemoval = true)
default BiDi getBiDi() {
return maybeGetBiDi()
.orElseThrow(() -> new BiDiException("Unable to create a BiDi connection"));
}

/**
* @deprecated BiDi is an internal implementation detail. Direct access to the BiDi object from
* drivers will be removed in a future release.
*/
@Deprecated(since = "4.46", forRemoval = true)
Comment on lines +25 to +39

@qodo-code-review qodo-code-review Bot Jul 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

2. Deprecated methods lack alternative guidance 📘 Rule violation ☼ Reliability

The new @deprecated Javadoc text explains removal intent but does not name a recommended
alternative or explicitly state there is no replacement. This violates the requirement that
deprecated public APIs include guidance before removal.
Agent Prompt 
## Issue description
The `@deprecated` Javadoc for `getBiDi()` and `maybeGetBiDi()` does not provide guidance on what callers should use instead, nor does it explicitly state "no replacement".

## Issue Context
The checklist requires deprecated public APIs to include a human-readable message that names or links to the recommended alternative, or explicitly states there is no replacement.

## Fix Focus Areas
- java/src/org/openqa/selenium/bidi/HasBiDi.java[25-29]
- java/src/org/openqa/selenium/bidi/HasBiDi.java[35-39]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Optional<BiDi> maybeGetBiDi();
Comment on lines +25 to 40

@qodo-code-review qodo-code-review Bot Jul 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

1. getbidi() javadoc missing @return 📘 Rule violation ✧ Quality

The new Javadoc for public methods getBiDi() and maybeGetBiDi() contains only an @deprecated
tag and omits required documentation, including a free-text description and @return tags. This
reduces API documentation quality and violates the requirement for complete Javadoc on public
methods.
Agent Prompt 
## Issue description
Public methods `getBiDi()` and `maybeGetBiDi()` have new Javadoc that only includes an `@deprecated` tag, but is missing (a) at least one free-text sentence describing the method and (b) an `@return` tag.

## Issue Context
These methods are part of a `public interface` and therefore need complete Javadoc per the checklist.

## Fix Focus Areas
- java/src/org/openqa/selenium/bidi/HasBiDi.java[25-40]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

}
Loading