WebDriver BiDI: Collect browser logs

[labkey-tchad]

Rationale

Related Pull Requests

• Roll back Selenium upgrade #1190 (Need to address Windows problems before merging this)

Changes

• Use Selenium Bidi API to collect browser logs
• Update Selenium to 4.4

[labkey-tchad]

PR Code Suggestions

Category	Suggestions
Enhancement	Use more specific logger names for granular logging control. Consider using a more specific logger name rather than the generic "org.openqa.selenium". This change would allow for more granular control over logging levels for different parts of Selenium, improving the ability to debug issues or reduce log noise in specific areas of Selenium interactions. src/org/labkey/test/WebDriverWrapper.java [181] -Logger.getLogger("org.openqa.selenium").setLevel(java.util.logging.Level.WARNING); +Logger.getLogger("org.openqa.selenium.remote.ProtocolHandshake").setLevel(java.util.logging.Level.WARNING); +Logger.getLogger("org.openqa.selenium.interactions.Actions").setLevel(java.util.logging.Level.WARNING);
Bug	Add type check before using BiDi features to prevent ClassCastException. It's recommended to check if the WebDriver instance is of type that supports BiDi (e.g., FirefoxDriver) before casting and using BiDi features. This prevents ClassCastException when the WebDriver instance does not support BiDi. src/org/labkey/test/WebDriverWrapper.java [394-395] -BiDi biDi = ((FirefoxDriver) newWebDriver).getBiDi(); -biDi.addListener(Log.entryAdded(), BrowserConsoleLog::log); +if (newWebDriver instanceof FirefoxDriver) { + BiDi biDi = ((FirefoxDriver) newWebDriver).getBiDi(); + biDi.addListener(Log.entryAdded(), BrowserConsoleLog::log); +}
Best practice	Use FirefoxDriverLogLevel enum directly instead of hardcoding preferences. Instead of hardcoding the preference "--log" with "WARN", consider using the FirefoxDriverLogLevel enum directly with the setLogLevel method. This approach ensures consistency with the API and avoids potential issues with incorrect preference keys or values. src/org/labkey/test/WebDriverWrapper.java [350] -firefoxOptions.addPreference("--log", "WARN"); +firefoxOptions.setLogLevel(FirefoxDriverLogLevel.WARN);
Possible issue	Verify and correct the use of non-standard WebDriver capability. The setCapability("webSocketUrl", true) method call seems to be intended to enable WebSocket communication for the driver, but this capability is not standard and may not work as expected. Verify if this is the correct capability to set for your needs, or if it was intended to enable BiDi features, ensure that the correct capability is used according to the WebDriver documentation. src/org/labkey/test/WebDriverWrapper.java [351] -firefoxOptions.setCapability("webSocketUrl", true); +// If enabling BiDi, use the correct capability +// firefoxOptions.setCapability("SOME_CORRECT_BiDi_CAPABILITY", true);
Maintainability	Encapsulate property retrieval in a method for cleaner code. For consistency and to avoid potential future errors, consider using a common method for retrieving boolean properties from System.getProperty. This method would encapsulate the "true".equals(...) check and make the code cleaner and more maintainable. src/org/labkey/test/TestProperties.java [197] -return "true".equals(System.getProperty("webtest.devtools.console.log")); +private static boolean getBooleanSystemProperty(String propertyName) { + return "true".equals(System.getProperty(propertyName)); +} +// And then use it like: +// return getBooleanSystemProperty("webtest.devtools.console.log");

---

✨ 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.

[labkey-tchad]

PR Review

⏱️ Estimated effort to review [1-5]	3, because the PR involves integrating a new feature using the Selenium BiDi API for log collection, updating dependencies, and adding new methods. The complexity lies in understanding the Selenium BiDi API, ensuring compatibility with existing test infrastructure, and verifying that the log collection works as expected across different browsers.
🧪 Relevant tests	No
🔍 Possible issues	Possible Bug: The BiDi listener setup in WebDriverWrapper.java is only applied to Firefox. If the intention is to collect browser logs across all supported browsers, this implementation might not work for Chrome or other browsers.
	Compatibility Issue: The update to Selenium version 4.4.0 might introduce compatibility issues with existing tests or browser drivers not yet supporting this version.
🔒 Security concerns	No

Code feedback:

---

relevant file	src/org/labkey/test/WebDriverWrapper.java
suggestion	Consider implementing browser log collection for browsers other than Firefox to ensure the feature works across all supported browsers. This might involve checking the browser type and applying a similar BiDi setup for Chrome and other browsers if supported by their respective WebDriver implementations. [important]
relevant line	BiDi biDi = ((FirefoxDriver) newWebDriver).getBiDi();

---

relevant file	src/org/labkey/test/WebDriverWrapper.java
suggestion	Ensure compatibility with the updated Selenium version (4.4.0) across all browser drivers and tests. This might involve testing with different browser versions and driver executables to catch any compatibility issues early. [important]
relevant line	seleniumVersion=4.4.0

---

relevant file	src/org/labkey/test/WebDriverWrapper.java
suggestion	Refactor the log level mapping in BrowserConsoleLog to handle unexpected log levels gracefully, perhaps by defaulting to a standard log level if the logEntry.getLevel() does not match any key in LOG_ENTRY_LEVELS. [medium]
relevant line	Level logLevel = LOG_ENTRY_LEVELS.get(String.valueOf(logEntry.getLevel()));

---

relevant file	src/org/labkey/test/TestProperties.java
suggestion	Add a method or documentation on how to enable the webtest.devtools.console.log system property for users or developers who wish to use this new log collection feature. This will improve usability and adoption of the feature. [medium]
relevant line	return "true".equals(System.getProperty("webtest.devtools.console.log"));

---

---

✨ 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, require_can_be_split_review, 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.