SeleniumHQ / selenium

A browser automation framework and ecosystem.
https://selenium.dev
Apache License 2.0
29.78k stars 8.02k forks source link

[🚀 Feature]: Transition .NET to Async library #14067

Open titusfortner opened 1 month ago

titusfortner commented 1 month ago

Feature and motivation

.NET libraries are increasingly moving to Async implementations. Selenium should move over to be a completely Asynchronous library, especially since we plan to implement current methods with BiDi that have to be Async.

It is possible to maintain backwards compatibility by implementing existing Synchronous methods by calling the Async methods wrapped in a Run Task, but this doubles the API surface, and is not best practice.

Proposal

  1. Add Async methods to all classes
  2. Rewrite Sync methods to use the Async methods
  3. Write Blog Post talking about the proposed changes
  4. Mark all Sync methods as deprecated

14051 is an example of doing the first 2 items for the Navigation methods

Question:

  1. Do we want to remove Sync methods for Selenium 5, knowing that Selenium 5 will be backwards incompatible with current Selenium code, or maintain both through Selenium 6?
  2. Need an answer to #14065 as part of this

attn: @jimevans / @nvborisenko / @YevgeniyShunevych

Usage example

await driver.FindElementAsync(By.Id("consoleLog"));
YevgeniyShunevych commented 1 month ago

I'm not sure which major version is better for removing sync API, but I think for WebDriver consumers, after adding async APIs, it will be good to keep deprecated (marked [Obsolete]) sync APIs for at least 3 minor version releases before removing. We'll need some time for such an upgrade.