[dotnet] Support setting timeouts in capabilities

[nvborisenko]

User description

New properties in driver options:

• ScriptTimeout
• PageLoadTimeout
• ImplicitWaitTimeout

Description

var options = new ChromeOptions()
{
  PageLoadTimeout = TimeSpan.FromSecods(66),
};

var driver = new ChromeDriver(options);

Motivation and Context

Fixes #10183

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, tests

---

Description

• Introduced a new internal Timeout class to handle script, page load, and implicit wait timeouts.
• Added properties ScriptTimeout, PageLoadTimeout, and ImplicitWaitTimeout to DriverOptions to allow setting these timeouts.
• Updated Timeouts documentation to reflect the ability to manage timeouts via DriverOptions.
• Extended DriverFactory to support the new timeout options.
• Added a new test class TimeoutDriverOptionsTest to validate the functionality of the new timeout settings.

---

Changes walkthrough

	Relevant files
Enhancement	DriverOptions.cs Add Timeout Settings to Driver Options                                      dotnet/src/webdriver/DriverOptions.cs Introduced internal Timeout class with Script, PageLoad, and ImplicitWait properties. Added public properties ScriptTimeout, PageLoadTimeout, and ImplicitWaitTimeout in DriverOptions class. Implemented capability setting for script, page load, and implicit wait timeouts. +79/-0    DriverFactory.cs Extend Driver Factory with Timeout Options                              dotnet/test/common/Environment/DriverFactory.cs Extended driver options setup to include script, page load, and implicit wait timeouts. +7/-3
Documentation	Timeouts.cs Update Timeouts Documentation                                                        dotnet/src/webdriver/Timeouts.cs Updated documentation to mention managing timeouts via DriverOptions. +13/-0
Tests	TimeoutDriverOptionsTest.cs Add Tests for Timeout Settings in Driver Options                  dotnet/test/common/TimeoutDriverOptionsTest.cs Added TimeoutDriverOptionsTest class with tests for script, page load, and implicit wait timeout settings. +123/-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 (5a7e9cb)

• 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 feature with a moderate amount of changes across several files, including the addition of new properties to manage timeouts and updates to existing classes to support these properties. The changes are well-scoped and focused on a specific functionality, making the review process straightforward.
🧪 Relevant tests	Yes
🔍 Possible issues	Typo in Example Code: The example code provided in the PR description contains a typo "FromSecods" instead of "FromSeconds". This should be corrected in the documentation or example usage to avoid confusion.
	Null Handling: The ToCapabilities method in the Timeout class does not explicitly handle the case where all properties (Script, PageLoad, ImplicitWait) are null. While this scenario might not cause a runtime error due to how dictionaries are handled, it could lead to generating an empty capabilities object. It might be beneficial to document this behavior or handle this scenario explicitly.
🔒 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	Make the Timeout class public and add XML documentation. Consider making the Timeout class public and providing XML documentation for its properties and methods. This change would allow users of your library to create and manipulate timeout settings more flexibly. dotnet/src/webdriver/DriverOptions.cs [92-97] -internal class Timeout +/// <summary> +/// Represents the timeouts configuration for a WebDriver. +/// </summary> +public class Timeout { + /// <summary> + /// Gets or sets the maximum time to wait for a script to execute. + /// </summary> public TimeSpan? Script { get; set; } + + /// <summary> + /// Gets or sets the maximum time to wait for a page to load. + /// </summary> public TimeSpan? PageLoad { get; set; } + + /// <summary> + /// Gets or sets the maximum time to wait when searching for elements. + /// </summary> public TimeSpan? ImplicitWait { get; set; }
	Validate timeout values to be non-negative. Consider validating the timeout values in the Timeout class to ensure they are within an acceptable range (e.g., non-negative). This can prevent potential runtime errors or misconfigurations. dotnet/src/webdriver/DriverOptions.cs [94-96] -public TimeSpan? Script { get; set; } -public TimeSpan? PageLoad { get; set; } -public TimeSpan? ImplicitWait { get; set; } +private TimeSpan? script; +public TimeSpan? Script +{ + get => script; + set + { + if (value < TimeSpan.Zero) throw new ArgumentOutOfRangeException(nameof(Script), "Timeout must be non-negative."); + script = value; + } +} +// Repeat for PageLoad and ImplicitWait with similar property patterns.
Maintainability	Refactor ToCapabilities method to dynamically add timeouts. To improve the maintainability and readability of the ToCapabilities method, consider using a loop or a more dynamic approach to add the timeouts to the dictionary. This would reduce the repetitive code and make it easier to add or remove timeouts in the future. dotnet/src/webdriver/DriverOptions.cs [102-104] -if (Script.HasValue) timeoutCapabilities.Add("script", Script.Value.TotalMilliseconds); -if (PageLoad.HasValue) timeoutCapabilities.Add("pageLoad", PageLoad.Value.TotalMilliseconds); -if (ImplicitWait.HasValue) timeoutCapabilities.Add("implicit", ImplicitWait.Value.TotalMilliseconds); +var timeouts = new Dictionary<string, TimeSpan?> +{ + { "script", Script }, + { "pageLoad", PageLoad }, + { "implicit", ImplicitWait } +}; +foreach (var timeout in timeouts) +{ + if (timeout.Value.HasValue) + { + timeoutCapabilities.Add(timeout.Key, timeout.Value.Value.TotalMilliseconds); + } +} +
Best practice	Use ConcurrentDictionary for thread safety in ToCapabilities. To ensure thread safety and consistency of timeout settings, consider using ConcurrentDictionary instead of Dictionary for timeoutCapabilities in the ToCapabilities method. dotnet/src/webdriver/DriverOptions.cs [100] -var timeoutCapabilities = new Dictionary<string, object>(); +var timeoutCapabilities = new ConcurrentDictionary<string, object>();
	Add a method to validate all timeout properties in Timeout. Consider adding a method to the Timeout class that validates all timeout properties at once. This method could be called before converting to capabilities to ensure all timeouts are correctly set. dotnet/src/webdriver/DriverOptions.cs [94-96] -public TimeSpan? Script { get; set; } -public TimeSpan? PageLoad { get; set; } -public TimeSpan? ImplicitWait { get; set; } +public void ValidateTimeouts() +{ + var properties = new[] { Script, PageLoad, ImplicitWait }; + foreach (var property in properties) + { + if (property.HasValue && property.Value < TimeSpan.Zero) + { + throw new ArgumentOutOfRangeException("Timeout values must be non-negative."); + } + } +} +// Call ValidateTimeouts() in ToCapabilities before adding to the dictionary.

---

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