[rb] Add cross-browser Driver#install_web_extension - #17879
Draft
titusfortner wants to merge 1 commit into
Draft
Conversation
…Firefox classic install_addon methods
selenium-ci
added
C-rb
titusfortner
marked this pull request as ready for review
August 5, 2026 23:26
titusfortner
marked this pull request as draft
August 5, 2026 23:26
Contributor
PR Summary by QodoAdd cross-browser Driver#install_web_extension via BiDi with Firefox fallback
AI Description
Diagram
High-Level Assessment
Files changed (24)
|
Contributor
Code Review by Qodo
1. devtools raises under BiDi
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
Comment on lines
+32
to
+35
| if @bridge.bidi? | ||
| raise Error::WebDriverError, | ||
| 'CDP (DevTools) is disabled when BiDi is enabled; use the WebDriver BiDi APIs instead' | ||
| end |
Contributor
There was a problem hiding this comment.
1. devtools raises under bidi 📘 Rule violation ⚙ Maintainability
Calling driver.devtools now raises when @bridge.bidi? is true, which is a user-visible behavior change for BiDi users without an explicit deprecation/migration period. This can break downstream code that previously used CDP while experimenting with BiDi.
Agent Prompt
## Issue description
`Driver#devtools` now raises when BiDi is enabled, which is a breaking user-visible behavior change without an explicit deprecation/migration period.
## Issue Context
The PR introduces a hard failure path (`raise Error::WebDriverError`) for `devtools` when `@bridge.bidi?` is true. To maintain compatibility expectations, provide an explicit deprecation/migration path (or a documented compatibility switch) before enforcing this behavior.
## Fix Focus Areas
- rb/lib/selenium/webdriver/common/driver_extensions/has_devtools.rb[28-35]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Comment on lines
+239
to
+241
| if bidi? | ||
| options['args'] = options['args'].to_a | %w[--enable-unsafe-extension-debugging --remote-debugging-pipe] | ||
| end |
Contributor
There was a problem hiding this comment.
2. Bidi args nomethoderror 🐞 Bug ☼ Reliability
In Chromium::Options#process_browser_options, when BiDi is enabled it calls options['args'].to_a, which raises NoMethodError if args is a String (or other non-Array) that can be set via Options initialization/merge or add_option. This crashes option processing before session start, instead of producing a clear argument/type error.
Agent Prompt
### Issue description
When BiDi is enabled, Chromium options processing does `options['args'].to_a`, which can raise `NoMethodError` if `args` is not an Array (e.g., a String). This prevents session creation and yields an opaque error.
### Issue Context
`Chromium::Options#initialize` merges defaults with user-supplied `@options`, so `args:` provided as a non-Array can override the default `[]`. `Common::Options#add_option` also stores values without type validation.
### Fix Focus Areas
- rb/lib/selenium/webdriver/chromium/options.rb[227-241]
### Suggested change
- Replace `options['args'].to_a` with safer normalization, e.g.:
- `args = options['args']
args = args.nil? ? [] : Array(args)
options['args'] = args | %w[--enable-unsafe-extension-debugging --remote-debugging-pipe]`
- Alternatively, if you want strictness, explicitly raise a `WebDriverError` when `options['args']` is present and not an `Array`, with a clear message (`'args' must be an Array of Strings`).
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
🔗 Related Issues
Prototype implementation for proposed ADR: #17817
This PR will remain in Draft until that proposal is approved
💥 What does this PR do?
Implements the ADR decisions:
Driver#install_web_extensionandDriver#uninstall_web_extension, backed by thegenerated BiDi
webExtensionprotocol classes. Install accepts a directory, packed archive, or base64 bytes(plus Firefox's
permanent/allow_private_browsingoptions) and returns aWebExtensionhandle wrappingthe id; uninstall takes that handle.
moz/addonendpoint), andthe legacy
install_addon/uninstall_addonare deprecated toward the new methods — no routing.--remote-debugging-pipeand--enable-unsafe-extension-debugging(no user flags), and Selenium's CDP API raises while BiDi is on.over BiDi or the classic endpoint.
install_addon/uninstall_addonnow emit a deprecation warning.to the pipe transport and allows unsigned extensions with no user flags.
"enable BiDi" error rather than a
NoMethodError. On Firefox,allow_private_browsing: falsealso raises,since the classic endpoint always grants private-browsing access and cannot disable it.
🔧 Implementation Notes
encode_extension) lives on the base bridge: it zips a directory, base64-encodes a file, orpasses base64 through. Both the base BiDi path and
Firefox::Featuresuse it;Firefox::Featuresbrancheson
bidi?— BiDi uses themozvendor variant, classic uses themoz/addonendpoint.archivePath,so Chromium can only install an unpacked directory whose path resolves on the browser host (local sessions)
— no packed archive, no Grid. A temporary
Chromium::Featuresoverride sends that directory path directly;it is removed once chromium-bidi supports base64 ([🐛 Bug]: [python][Chrome] Webextension - no support for archived and base64 extensionData type in Chrome? #16541), at which point Chromium picks up archive/base64/Grid
support with no API change.
bidi,connection,web_extension,install_web_extension,uninstall_web_extension) share a single "enable BiDi" raiser via aliases, so a browser with no classicpath gets the same error everywhere.
🤖 AI assistance
💡 Additional Considerations
decisions process implementing PRs land after acceptance and are linked from the ADR tracking issue.
temporary override is removed then.
🔄 Types of changes