-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
[adr] BiDi is an implementation mechanism, not a public API #17670
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.
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
Open
titusfortner
wants to merge
5
commits into
SeleniumHQ:trunk
Choose a base branch
from
titusfortner:adr1
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+59
β0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
9288155
[docs] add design decision record process and template
titusfortner f32ab0f
[adr] BiDi is an implementation mechanism, not a public API
titusfortner 3d21495
add examples with details as requested
titusfortner 7b86053
Merge branch 'trunk' into adr1
diemol d5fcb13
Merge branch 'trunk' into adr1
diemol File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Index of Decisions | ||
|
|
||
| * 0001 - BiDi is an implementation mechanism, not a public API |
56 changes: 56 additions & 0 deletions
56
docs/decisions/0001-bidi-is-an-implementation-mechanism.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # 0001. BiDi is an implementation mechanism, not a public API | ||
|
|
||
| - Status: Proposed | ||
| - Date: 2026-06-11 | ||
| - Discussion: _PR pending_, https://github.com/SeleniumHQ/selenium/issues/17628 | ||
|
|
||
| ## Context | ||
|
|
||
| Bindings use WebDriver BiDi to implement and extend the Selenium API. This record | ||
| settles BiDi's relationship to the public API: what users program against, and where | ||
| protocol code lives. CDP was managed differently across the bindings, but all of them | ||
| resulted in users needing to understand CDP implementation details to work with it | ||
| to one extent or another. This is happening in BiDi the same way. | ||
|
|
||
| ## Decision | ||
|
|
||
| BiDi is an implementation mechanism, not a public API. New capabilities are exposed as | ||
| high-level, protocol-neutral APIs, idiomatic per language, subject to our standard | ||
| deprecation policy. Everything in a BiDi namespace is internal: still reachable for | ||
| anything not yet wrapped, but not documented and subject to change without warning. | ||
|
|
||
| A binding conforms when: | ||
|
|
||
| 1. The supported API never references BiDi β no types, methods, properties, or entry points. | ||
| 2. BiDi implementation code (including everything generated from CDDL) is visibly internal β marked per language convention as not intended for public consumption. | ||
|
|
||
| This includes removing/renaming: | ||
| * `HasBiDi` interface | ||
| * `bidi_connection`, `bidi`, `getBidi`, `AsBiDiAsync` methods | ||
| * `enable_bidi` methods in options | ||
|
|
||
| ## Considered options | ||
|
|
||
| 1. Expose the whole protocol as a public API (Rejected) | ||
| * not user-friendly syntax | ||
| 2. A supported-but-separate public protocol namespace (Rejected) | ||
| * multiple implementations are confusing | ||
| 3. Allow methods and classes to reference BiDi | ||
| * users shouldn't need to know the underlying implementation mechanism, things should just work without additional ceremony | ||
| 4. Internal implementation mechanism only (Accepted) | ||
|
|
||
| ## Consequences | ||
|
|
||
| - Users never need to know which protocol services a command. | ||
| - Each new capability requires API design work across bindings before it ships. | ||
| - Existing public surfaces that fail the conformance tests are brought in line per the deprecation policy, tracked below. | ||
|
|
||
| ## Binding status | ||
|
|
||
| | Binding | Status | Notes / tracking link | | ||
| |------------|---------|-----------------------| | ||
| | Java | pending | | | ||
| | Python | pending | | | ||
| | Ruby | pending | | | ||
| | .NET | pending | | | ||
| | JavaScript | pending | | | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Low-level API should be publicly available, it is power. But without warranties, spec is living doc. Not clear how to emphasize it per language. What I see: spec is trying to be not breaking changeable.
In .NET/C# we already funded a plan how to react on breaking changes. I really don't understand why low-level implementation should be
internal.. .NET is ready for changes.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This low-level api will be accessible through the
internalnamespace, as mentioned below: