[bidi] [java] Add browser module

[pujagani]

User description

Thanks for contributing to Selenium!
A PR well described will help maintainers to quickly review and merge it

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, help reviewers by making them as simple and short as possible.

Description

Add Browser module as described in https://w3c.github.io/webdriver-bidi/#module-browser

Motivation and Context

To land BiDi in Selenium incrementally

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• I have read the contributing document.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

---

Type

enhancement

---

Description

• Implemented the Browser module as per the WebDriver BiDi specification, including methods for user context management.
• Added a comprehensive test suite to validate the functionality of the Browser module commands.
• Updated Bazel build configurations to include the new test suite.

---

Changes walkthrough

	Relevant files
Enhancement	Browser.java Implementation of Browser Module for BiDi Protocol              java/src/org/openqa/selenium/bidi/Browser.java Added a new Browser class to handle browser-related commands in the BiDi protocol. Implemented methods for creating, getting, and removing user contexts. +71/-0
Tests	BrowserCommandsTest.java Test Suite for Browser Module Commands                                      java/test/org/openqa/selenium/bidi/browser/BrowserCommandsTest.java Added tests for the newly implemented Browser class methods. Tests cover creating, getting, and removing user contexts. Utilized @NotYetImplemented annotations for browsers where functionality is pending. +106/-0
Configuration changes	BUILD.bazel Bazel Build Configuration for Browser Module Tests              java/test/org/openqa/selenium/bidi/browser/BUILD.bazel Defined a new java_selenium_test_suite for the browser module tests. Included dependencies necessary for the test suite. +28/-0

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-pro]

PR Description updated to latest commit (36be14e)

• Copy walkthrough table to "Files Changed" Tab

[codiumai-pr-agent-pro]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the PR introduces a new module with a moderate amount of code. The logic seems straightforward, focusing on user context management within a browser, which is a new feature but not overly complex. The added tests cover basic functionalities, making the review process easier.
🧪 Relevant tests	Yes
🔍 Possible issues	Possible Bug: There's no explicit handling or mention of potential exceptions that might be thrown during the execution of the new methods. It might be beneficial to include error handling or at least document expected failure cases.
	Code Duplication: The mapping functions userContextInfoMapper and userContextsInfoMapper have similar structures and could potentially be refactored to reduce redundancy.
🔒 Security concerns	No

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, and more.

Auto-approve PRs By invoking: /review auto_approve The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: [pr_reviewer] enable_auto_approval = true (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag: [pr_reviewer] maximal_review_effort = 5

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-pro]

PR Code Suggestions

Category	Suggestions
Enhancement	Use a more specific type than Map for JSON response deserialization. Consider using a more specific type than Map<String, Object> for the response in userContextInfoMapper and userContextsInfoMapper to ensure type safety and clarity. If the structure of the response is known and consistent, defining a class to represent the response can help with deserialization and make the code more readable. java/src/org/openqa/selenium/bidi/Browser.java [32-39] -Map<String, Object> response = jsonInput.read(Map.class); +ResponseType response = jsonInput.read(ResponseType.class);
Best practice	Add type checking before casting in userContextsInfoMapper. Instead of casting the result of response.get("userContexts") directly in userContextsInfoMapper, consider checking if the result is an instance of List<Map<String, String>> to avoid potential ClassCastException. java/src/org/openqa/selenium/bidi/Browser.java [39-40] -List<Map<String, String>> userContextsResponse = - (List<Map<String, String>>) response.get("userContexts"); +Object userContextsResponseObj = response.get("userContexts"); +if (!(userContextsResponseObj instanceof List)) { + throw new IllegalArgumentException("userContexts is not a List"); +} +List<Map<String, String>> userContextsResponse = (List<Map<String, String>>) userContextsResponseObj;
	Add null checks for response.get calls to prevent NullPointerException. For better error handling, consider checking if response.get("userContext") and response.get("userContexts") return null in userContextInfoMapper and userContextsInfoMapper, respectively, and throw a custom exception if they do. This can prevent NullPointerException and provide a clearer error message to the caller. java/src/org/openqa/selenium/bidi/Browser.java [33] -return (String) response.get("userContext"); +String userContext = (String) response.get("userContext"); +if (userContext == null) { + throw new IllegalStateException("userContext is missing in the response"); +} +return userContext;
	Wrap jsonInput.read in a try-catch block for better error handling. To ensure that resources are properly released and to improve error handling, consider wrapping the jsonInput.read(Map.class) call in a try-catch block. This can help catch IOException or other exceptions that may occur during the reading process and allow for proper resource management. java/src/org/openqa/selenium/bidi/Browser.java [32-38] -Map<String, Object> response = jsonInput.read(Map.class); +Map<String, Object> response; +try { + response = jsonInput.read(Map.class); +} catch (IOException e) { + throw new RuntimeException("Failed to read json input", e); +}
Performance	Make userContextInfoMapper and userContextsInfoMapper static if possible. Consider making userContextInfoMapper and userContextsInfoMapper static if they do not access instance variables of Browser. This can improve the performance slightly by reducing the overhead of creating function objects for each Browser instance. java/src/org/openqa/selenium/bidi/Browser.java [30] -private final Function<JsonInput, String> userContextInfoMapper = +private static final Function<JsonInput, String> userContextInfoMapper = jsonInput -> {

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.48%. Comparing base (739f5ec) to head (492a596).
Report is 5 commits behind head on trunk.

❗ Current head 492a596 differs from pull request most recent head 1b40d18. Consider uploading reports for the commit 1b40d18 to get more accurate results

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##            trunk   #13677   +/-   ##
=======================================
  Coverage   58.48%   58.48%           
=======================================
  Files          86       86           
  Lines        5270     5270           
  Branches      220      220           
=======================================
  Hits         3082     3082           
  Misses       1968     1968           
  Partials      220      220           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.