-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
.pr_agent_accepted_suggestions
| PR 15978 (2025-06-29) |
[general] Convert field to property
✅ Convert field to property
The Nodes field should be a property with a getter to maintain consistency with other similar classes in the codebase. This ensures proper encapsulation and follows C# conventions.
dotnet/src/webdriver/BiDi/BrowsingContext/LocateNodesCommand.cs [47]
-public readonly IReadOnlyList<Script.NodeRemoteValue> Nodes;
+public IReadOnlyList<Script.NodeRemoteValue> Nodes { get; }Suggestion importance[1-10]: 6
__
Why: The suggestion correctly points out that Nodes is a public field, while other similar classes in the PR use properties, and changing it improves consistency.
| PR 15959 (2025-06-25) |
[possible issue] Fix incorrect macOS key mapping
✅ Fix incorrect macOS key mapping
The key mappings appear incorrect for macOS. The Options key should map to Alt/Option functionality, not right_shift, and the Function key has its own distinct behavior that shouldn't be aliased to right_control.
rb/lib/selenium/webdriver/common/keys.rb [98-99]
-options: "\ue050", # macOS Options key, same as right_shift
+options: "\ue052", # macOS Options key, same as right_alt
function: "\ue051", # macOS Function key, same as right_controlSuggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies that the macOS Options key is equivalent to the Alt key and should be mapped to right_alt (\ue052), not right_shift (\ue050). This is a valid and important correction to the key mapping logic.
| PR 15948 (2025-06-24) |
[possible issue] Fix duplicate Unicode key mappings
✅ Fix duplicate Unicode key mappings
The OPTIONS and FUNCTION keys use Unicode values that conflict with the right-side modifier keys defined above. This creates duplicate Unicode mappings which could cause unexpected behavior when these keys are used.
py/selenium/webdriver/common/keys.py [99-100]
-OPTIONS = "\uE050" # TODO: verify Unicode value with WebDriver spec
-FUNCTION = "\uE051" # TODO: symbolic only; confirm or remove in future
+OPTIONS = "\uE054" # TODO: verify Unicode value with WebDriver spec
+FUNCTION = "\uE055" # TODO: symbolic only; confirm or remove in futureSuggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies that the Unicode values for OPTIONS (\uE050) and FUNCTION (\uE051) conflict with the newly added RIGHT_SHIFT (\ue050) and RIGHT_CONTROL (\ue051). This duplication could cause unexpected behavior and is a critical issue to fix. The proposed change resolves this conflict.
| PR 15942 (2025-06-23) |
[general] Add fallback for None reason
✅ Add fallback for None reason
The response.reason might be None in some cases, which would result in "None" being displayed. Add a fallback to handle cases where the reason is not available.
py/selenium/webdriver/remote/remote_connection.py [443]
-return {"status": statuscode, "value": f"{response.reason}" if not data else data.strip()}
+return {"status": statuscode, "value": f"{response.reason or statuscode}" if not data else data.strip()}Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that response.reason could be None and provides a sensible fallback to using the statuscode, similar to the original behavior. This improves the robustness of the error handling.
| PR 15924 (2025-06-20) |
[possible issue] Add missing null check validation
✅ Add missing null check validation
Add null check for clientConfig parameter to maintain consistency with other parameter validations. The method handles null options and service but doesn't validate clientConfig which could cause issues downstream.
java/src/org/openqa/selenium/ie/InternetExplorerDriver.java [111-119]
public InternetExplorerDriver(
@Nullable InternetExplorerDriverService service,
@Nullable InternetExplorerOptions options,
@Nullable ClientConfig clientConfig) {
if (options == null) {
options = new InternetExplorerOptions();
}
if (service == null) {
service = InternetExplorerDriverService.createDefaultService();
+ }
+ if (clientConfig == null) {
+ clientConfig = ClientConfig.defaultConfig();
+ }Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies that while the clientConfig parameter was annotated as @Nullable in the PR, the corresponding null-handling logic was missed. Adding this check prevents a potential NullPointerException and makes the constructor's behavior consistent with the other nullable parameters.
| PR 15923 (2025-06-20) |
[general] Reduce code duplication in paths
✅ Reduce code duplication in paths
Consider storing the base path in a variable to avoid code duplication and make the path easier to maintain. This reduces the risk of typos and makes future path changes simpler.
dotnet/test/common/Environment/TestWebServer.cs [56-63]
+var basePath = @"_main/java/test/org/openqa/selenium/environment/appserver";
if (OperatingSystem.IsWindows())
{
- standaloneAppserverPath = runfiles.Rlocation(@"_main/java/test/org/openqa/selenium/environment/appserver.exe");
+ standaloneAppserverPath = runfiles.Rlocation(basePath + ".exe");
}
else
{
- standaloneAppserverPath = runfiles.Rlocation(@"_main/java/test/org/openqa/selenium/environment/appserver");
+ standaloneAppserverPath = runfiles.Rlocation(basePath);
}Suggestion importance[1-10]: 5
__
Why: The suggestion correctly identifies a duplicated string literal for the application path and proposes a valid refactoring. Extracting the common base path into a variable improves code readability and maintainability, which is a good practice.
| PR 15916 (2025-06-19) |
[possible issue] Fix incorrect event subscription name
✅ Fix incorrect event subscription name
The OnHistoryUpdatedAsync methods are subscribing to the wrong event name. They should subscribe to "browsingContext.historyUpdated" instead of "browsingContext.fragmentNavigated" to match their intended functionality.
dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextModule.cs [137-145]
public async Task<Subscription> OnHistoryUpdatedAsync(Func<HistoryUpdatedEventArgs, Task> handler, BrowsingContextsSubscriptionOptions? options = null)
{
- return await Broker.SubscribeAsync("browsingContext.fragmentNavigated", handler, options).ConfigureAwait(false);
+ return await Broker.SubscribeAsync("browsingContext.historyUpdated", handler, options).ConfigureAwait(false);
}
public async Task<Subscription> OnHistoryUpdatedAsync(Action<HistoryUpdatedEventArgs> handler, BrowsingContextsSubscriptionOptions? options = null)
{
- return await Broker.SubscribeAsync("browsingContext.fragmentNavigated", handler, options).ConfigureAwait(false);
+ return await Broker.SubscribeAsync("browsingContext.historyUpdated", handler, options).ConfigureAwait(false);
}Suggestion importance[1-10]: 10
__
Why: The suggestion correctly identifies a critical bug. The OnHistoryUpdatedAsync methods subscribe to the wrong event name, "browsingContext.fragmentNavigated", which would cause the new feature to not work as intended. The proposed fix to use "browsingContext.historyUpdated" is correct and essential for the functionality.
| PR 15910 (2025-06-18) |
[general] Verify Unicode key code standards
✅ Verify Unicode key code standards
The Unicode code points \uE050 and \uE051 appear to be in the Private Use Area which may not be standardized across WebDriver implementations. Consider using established WebDriver protocol key codes or verify these values align with W3C WebDriver specification for macOS keys.
java/src/org/openqa/selenium/Keys.java [101-102]
-OPTION('\uE050'),
-FN('\uE051'),
+OPTION('\uE050'), // TODO: Verify Unicode value with WebDriver spec
+FN('\uE051'), // TODO: Verify Unicode value with WebDriver specSuggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that the new Unicode values \uE050 and \uE051 are in the Private Use Area. This raises a valid concern about standardization and potential inconsistencies across different WebDriver implementations, which is a crucial consideration for a library like Selenium.
| PR 15900 (2025-06-15) |
[possible issue] Fix incomplete variable assignment
✅ Fix incomplete variable assignment
The else branch assigns None to nothing, which is a no-op. This should assign None to remote_server_addr or handle the case where command_executor doesn't have the expected attributes.
py/selenium/webdriver/remote/webdriver.py [126-129]
if hasattr(command_executor, "client_config") and command_executor.client_config:
remote_server_addr = command_executor.client_config.remote_server_addr
else:
- None
+ remote_server_addr = command_executorSuggestion importance[1-10]: 10
__
Why: The suggestion correctly identifies a critical bug. The else: None statement is a no-op, which would cause a NameError for remote_server_addr on line 132 if the if condition is false. The proposed fix correctly restores the original behavior for the else case.
| PR 15889 (2025-06-11) |
[possible issue] Fix string validation logic
✅ Fix string validation logic
The validation logic incorrectly rejects strings because strings are sequences in Python. The condition should use isinstance(value, str) first to exclude strings, then check if it's a sequence. This prevents valid non-string sequences from being rejected.
py/selenium/webdriver/chrome/service.py [61-65]
@service_args.setter
def service_args(self, value: Sequence[str]):
- if not isinstance(value, Sequence) or isinstance(value, str):
+ if isinstance(value, str) or not isinstance(value, Sequence):
raise TypeError("service_args must be a sequence")
self._service_args = list(value)Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that the original validation logic not isinstance(value, Sequence) or isinstance(value, str) is flawed because a string is a sequence, causing the first part of the or to be false and the second to be true, thus always raising an error for strings. The proposed change isinstance(value, str) or not isinstance(value, Sequence) correctly handles this by checking for strings first.
[general] Convert sequence to list consistently
✅ Convert sequence to list consistently
The setter should convert the sequence to a list to maintain consistency with the internal storage format. The current implementation stores the sequence directly, which could lead to issues if a non-list sequence is provided.
py/selenium/webdriver/chromium/service.py [75-79]
@service_args.setter
def service_args(self, value: Sequence[str]):
if not isinstance(value, Sequence) or isinstance(value, str):
raise TypeError("service_args must be a sequence")
- self._service_args = value
+ self._service_args = list(value)Suggestion importance[1-10]: 7
__
Why: The suggestion correctly points out an inconsistency. The __init__ method initializes self._service_args as a list and uses .append(), but the setter allows any Sequence to be assigned. This could lead to runtime errors if a non-list sequence (like a tuple) is assigned and subsequent code expects a list. Converting to a list in the setter ensures type consistency for the internal attribute.
[general] Add string exclusion validation consistency
✅ Add string exclusion validation consistency
The setter validation is inconsistent with other service classes. It should also exclude strings from being accepted as valid sequences, since strings are sequences but not the intended type for service arguments.
py/selenium/webdriver/chrome/service.py [61-65]
@service_args.setter
def service_args(self, value: Sequence[str]):
- if not isinstance(value, Sequence):
+ if not isinstance(value, Sequence) or isinstance(value, str):
raise TypeError("service_args must be a sequence")
- self._service_args = value
+ self._service_args = list(value)Suggestion importance[1-10]: 9
__
Why: This suggestion correctly points out two issues: the inconsistent validation that allows strings, and the need to convert the input to a list. Fixing this prevents potential errors and aligns the chrome service's behavior with all other service classes modified in this PR, improving overall consistency and robustness.
[general] Convert sequence to list consistently
✅ Convert sequence to list consistently
The setter should convert the sequence to a list to maintain consistency with the internal storage format. The current implementation directly assigns the sequence, which could lead to type inconsistencies since _service_args is expected to be a list.
py/selenium/webdriver/chromium/service.py [75-79]
@service_args.setter
def service_args(self, value: Sequence[str]):
if not isinstance(value, Sequence) or isinstance(value, str):
raise TypeError("service_args must be a sequence")
- self._service_args = value
+ self._service_args = list(value)Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies that _service_args should consistently be a list, as it is initialized as one and other parts of the codebase may rely on its mutability (e.g., using .append()). Assigning a generic Sequence like a tuple could lead to runtime errors.
[incremental [*]] Convert sequence to list assignment
✅ Convert sequence to list assignment
Convert the sequence to a list before assignment to maintain consistency with the internal storage format and avoid potential issues with immutable sequences
py/selenium/webdriver/edge/service.py [64-68]
@service_args.setter
def service_args(self, value: Sequence[str]):
if not isinstance(value, Sequence) or isinstance(value, str):
raise TypeError("service_args must be a sequence")
- self._service_args = value
+ self._service_args = list(value)Suggestion importance[1-10]: 6
__
Why: The suggestion correctly points out a potential issue. The __init__ method initializes _service_args as a list, and other methods in related classes mutate it using methods like .append(). The setter should also convert the incoming sequence to a list to maintain internal type consistency and prevent potential AttributeError if an immutable sequence (like a tuple) is passed.
[general] Add string exclusion validation consistency
✅ Add string exclusion validation consistency
The setter validation is inconsistent with other service classes. It should also exclude strings from being accepted as valid sequences, since strings are sequences but not the intended type.
py/selenium/webdriver/chrome/service.py [61-65]
@service_args.setter
def service_args(self, value: Sequence[str]):
- if not isinstance(value, Sequence):
+ if not isinstance(value, Sequence) or isinstance(value, str):
raise TypeError("service_args must be a sequence")
- self._service_args = value
+ self._service_args = list(value)Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies two issues: the validation for service_args is incomplete as it allows strings, and the assigned value is not converted to a list. The proposed change aligns the implementation with other service classes in the PR, improving both robustness and consistency.
[general] Improve validation and conversion consistency
✅ Improve validation and conversion consistency
The setter validation should exclude strings and convert the sequence to a list for consistency with other service classes and internal storage format.
py/selenium/webdriver/edge/service.py [64-68]
@service_args.setter
def service_args(self, value: Sequence[str]):
- if not isinstance(value, Sequence):
+ if not isinstance(value, Sequence) or isinstance(value, str):
raise TypeError("service_args must be a sequence")
- self._service_args = value
+ self._service_args = list(value)Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies that the service_args setter is missing validation to exclude strings and does not convert the input sequence to a list. Applying this change makes the setter more robust and consistent with other service classes modified in this PR.
[incremental [*]] Convert sequence to list
✅ Convert sequence to list
Convert the value to a list before assignment to ensure the internal storage is mutable and consistent with the initialization pattern used elsewhere in the codebase.
py/selenium/webdriver/chromium/service.py [77-79]
if not isinstance(value, Sequence) or isinstance(value, str):
raise TypeError("service_args must be a sequence")
-self._service_args = value
+self._service_args = list(value)Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies that self._service_args should be a mutable list, as it's modified in the __init__ method. Converting the assigned value to a list in the setter ensures this, improving robustness and consistency with the initialization logic.
[general] Ensure service args mutability
✅ Ensure service args mutability
Convert the input sequence to a list to ensure mutability for operations like append() used elsewhere in the code. This prevents potential issues when immutable sequences are passed.
py/selenium/webdriver/chromium/service.py [48]
-self._service_args = service_args or []
+self._service_args = list(service_args or [])Suggestion importance[1-10]: 8
__
Why: This is a valuable suggestion. The code later appends to self._service_args, which requires a mutable sequence. If an immutable sequence like a tuple is passed for service_args, it would cause a runtime AttributeError. Converting to a list ensures mutability and prevents this bug.
[general] Prevent strings as sequence arguments
✅ Prevent strings as sequence arguments
The type check should exclude strings since they are sequences but shouldn't be treated as argument lists. Add a check to prevent strings from being accepted as valid sequences.
py/selenium/webdriver/chromium/service.py [75-79]
@service_args.setter
def service_args(self, value: Sequence[str]):
- if not isinstance(value, Sequence):
+ if not isinstance(value, Sequence) or isinstance(value, str):
raise TypeError("service_args must be a sequence")
self._service_args = valueSuggestion importance[1-10]: 7
__
Why: The suggestion correctly points out that a string, being a sequence, would pass the isinstance(value, Sequence) check but is likely not the intended input for a list of arguments. Adding a check for isinstance(value, str) makes the validation more robust and prevents potential runtime errors.
[possible issue] Fix inconsistent attribute assignment
✅ Fix inconsistent attribute assignment
The service_args assignment should use the private attribute _service_args to be consistent with the property implementation. This ensures the getter/setter pattern works correctly.
py/selenium/webdriver/wpewebkit/service.py [40-49]
def __init__(
self,
executable_path: str = DEFAULT_EXECUTABLE_PATH,
port: int = 0,
log_output: Optional[str] = None,
service_args: Optional[Sequence[str]] = None,
env: Optional[Mapping[str, str]] = None,
**kwargs,
):
- self.service_args = service_args or []
+ self._service_args = service_args or []Suggestion importance[1-10]: 5
__
Why: The suggestion correctly identifies an inconsistency in py/selenium/webdriver/wpewebkit/service.py where self.service_args is used in __init__ instead of self._service_args. While functionally correct due to the setter, changing it improves consistency with other modified files in the PR.
| PR 15887 (2025-06-10) |
[general] Handle negative numeric strings properly
✅ Handle negative numeric strings properly
The isdigit() method only checks for positive integers and doesn't handle negative numbers, floats, or other numeric formats. Use a more robust check to determine if the string represents a number that shouldn't be parsed as JSON.
py/selenium/webdriver/remote/errorhandler.py [165]
-if not value_json.isdigit():
+if not (value_json.isdigit() or (value_json.startswith('-') and value_json[1:].isdigit())):Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies that isdigit() doesn't handle negative numeric strings. The current code would raise an unhandled TypeError for a string like "-10", because json.loads() would succeed but subsequent operations on the resulting integer would fail. The proposed change makes the numeric check more robust and prevents this crash.
| PR 15880 (2025-06-09) |
[possible issue] Validate required JSON fields
✅ Validate required JSON fields
The from_json method should validate that required fields (realm, origin, type) are present in the JSON data. Currently, it allows None values for required fields which could cause issues downstream.
py/selenium/webdriver/common/bidi/script.py [57-75]
@classmethod
def from_json(cls, json: dict) -> "RealmInfo":
"""Creates a RealmInfo instance from a dictionary.
Parameters:
-----------
json: A dictionary containing the realm information.
Returns:
-------
RealmInfo: A new instance of RealmInfo.
"""
+ if not json.get("realm") or not json.get("origin") or not json.get("type"):
+ raise ValueError("Required fields 'realm', 'origin', and 'type' must be present")
+
return cls(
realm=json.get("realm"),
origin=json.get("origin"),
type=json.get("type"),
context=json.get("context"),
sandbox=json.get("sandbox"),
)Suggestion importance[1-10]: 7
__
Why: The suggestion correctly points out that the from_json method for RealmInfo does not validate the presence of required fields (realm, origin, type). The RealmInfo dataclass defines these as non-optional strings, so allowing None values from json.get() could lead to downstream errors. Adding validation improves robustness by ensuring the data conforms to the expected structure.
| PR 15853 (2025-06-04) |
[possible issue] Fix incorrect constructor parameter
✅ Fix incorrect constructor parameter
The super().init(KEY) call is incorrect. The parent class Interaction expects an input source object, not a string constant. You should pass source (or self.input_source) to the parent constructor instead of KEY.
py/selenium/webdriver/common/actions/key_actions.py [27-31]
def __init__(self, source: KeyInput | PointerInput | WheelInput | None = None) -> None:
if source is None:
source = KeyInput(KEY)
self.input_source = source
- super().__init__(KEY)
+ super().__init__(self.input_source)Suggestion importance[1-10]: 9
__
Why: This identifies a critical bug where super().__init__(KEY) passes a string constant instead of the expected input source object. This would likely cause runtime errors or incorrect behavior in the parent class.
| PR 15848 (2025-06-03) |
[incremental [*]] Prevent potential KeyError
✅ Prevent potential KeyError
**params))
-
del self.subscriptions[event_name]
-
if event_name in self.subscriptions: -
callbacks = self.subscriptions[event_name] -
if callback_id in callbacks: -
callbacks.remove(callback_id) -
if not callbacks: -
params = {"events": [event_name]} -
session = Session(self.conn) -
self.conn.execute(session.unsubscribe(**params)) -
del self.subscriptions[event_name]
**The code attempts to access self.subscriptions[event_name] after checking if event_name is in self.subscriptions, but then immediately accesses it again on the next line without checking. This could cause a KeyError if event_name is not in self.subscriptions.**
[py/selenium/webdriver/common/bidi/browsing_context.py [716-718]](https://github.com/SeleniumHQ/selenium/pull/15848/files#diff-a65d02c951aeb477672aa52e5eb0106645ba869aa186c0af6d2672c42cac95c6R716-R718)
```diff
+ self.conn.remove_callback(event_obj, callback_id)
+ if event_name in self.subscriptions and callback_id in self.subscriptions[event_name]:
+ self.subscriptions[event_name].remove(callback_id)
++ if len(self.subscriptions[event_name]) == 0:
++ params = {"events": [event_name]}
++ session = Session(self.conn)
++ self.conn.execute(session.unsubscribe(**params))
++ del self.subscriptions[event_name]
Suggestion importance[1-10]: 8
__
Why: This identifies a real bug where self.subscriptions[event_name] is accessed on line 719 without checking if event_name exists in self.subscriptions, which could cause a KeyError. The improved code correctly moves the length check inside the conditional block.
[general] Add warning for unexpected types
✅ Add warning for unexpected types
The current implementation may silently ignore non-dictionary items in the children list without any warning. Consider adding a warning or log message when encountering unexpected child types to help with debugging.
py/selenium/webdriver/common/bidi/browsing_context.py [111-113]
raw_children = json.get("children")
if raw_children is not None and isinstance(raw_children, list):
- children = [BrowsingContextInfo.from_json(child) for child in raw_children if isinstance(child, dict)]
+ children = []
+ for child in raw_children:
+ if isinstance(child, dict):
+ children.append(BrowsingContextInfo.from_json(child))
+ else:
+ import warnings
+ warnings.warn(f"Unexpected child type in browsing context: {type(child)}")Suggestion importance[1-10]: 4
__
Why: The suggestion adds debugging warnings for unexpected child types, which could be helpful but is not critical. The PR already improved safety by adding isinstance(child, dict) filtering.
[possible issue] Prevent ValueError on removal
✅ Prevent ValueError on removal
Check if the callback_id exists in the subscriptions before attempting to remove it. The current implementation will raise a ValueError if the callback_id is not in the list, which could happen if it was already removed or never added.
py/selenium/webdriver/common/bidi/browsing_context.py [716]
def remove_event_handler(self, event: str, callback_id: int) -> None:
"""Remove an event handler from the browsing context.
Parameters:
----------
event: The event to unsubscribe from.
callback_id: The callback id to remove.
"""
try:
event_name = self.EVENTS[event]
except KeyError:
raise Exception(f"Event {event} not found")
event_obj = BrowsingContextEvent(event_name)
self.conn.remove_callback(event_obj, callback_id)
- self.subscriptions[event_name].remove(callback_id)
+ if event_name in self.subscriptions and callback_id in self.subscriptions[event_name]:
+ self.subscriptions[event_name].remove(callback_id)Suggestion importance[1-10]: 7
__
Why: Valid suggestion that prevents potential ValueError when attempting to remove a non-existent callback_id from the subscriptions list, improving error handling robustness.
[possible issue] Validate dictionary type before processing
✅ Validate dictionary type before processing
Add type checking for each child element before calling from_json to prevent runtime errors. The current code assumes each child is a dictionary, but if any non-dictionary value is present in the list, it will cause a runtime error.
py/selenium/webdriver/common/bidi/browsing_context.py [111-113]
raw_children = json.get("children")
if raw_children is not None and isinstance(raw_children, list):
- children = [BrowsingContextInfo.from_json(child) for child in raw_children]
+ children = [BrowsingContextInfo.from_json(child) for child in raw_children if isinstance(child, dict)]Suggestion importance[1-10]: 6
__
Why: Valid suggestion to prevent runtime errors when non-dictionary values are in the children list, though this is likely an edge case in normal usage.
| PR 15847 (2025-06-03) |
[incremental [*]] Fix indentation error
✅ Fix indentation error
Fix the indentation error in line 142 where a tab character is used instead of spaces, which will cause a syntax error.
py/selenium/webdriver/common/bidi/browser.py [142-148]
+width = data["width"]
+if not isinstance(width, int) or width < 0:
+ raise ValueError(f"width must be a non-negative integer, got {width}")
+height = data["height"]
+if not isinstance(height, int) or height < 0:
+ raise ValueError(f"height must be a non-negative integer, got {height}")Suggestion importance[1-10]: 9
__
Why: This identifies a critical syntax error where tab characters are used instead of spaces on line 142, which will cause an IndentationError and prevent the code from running. This is a high-impact issue that must be fixed.
[incremental [*]] Fix indentation error
✅ Fix indentation error
Fix the indentation error on line 142. The line uses tabs instead of spaces, which is inconsistent with the rest of the code and will cause a Python indentation error.
py/selenium/webdriver/common/bidi/browser.py [142]
+width = data["width"]
+if not isinstance(width, int) or width < 0:
+ raise ValueError(f"width must be a non-negative integer, got {width}")
-Suggestion importance[1-10]: 9
__
Why: Critical indentation error using tabs instead of spaces that would cause Python IndentationError and prevent the code from running.
[possible issue] Consistent field access pattern
✅ Consistent field access pattern
Use data["height"] instead of data.get("height") for consistency with other required fields. The current implementation will accept None values, which contradicts the validation check.
py/selenium/webdriver/common/bidi/browser.py [146-148]
-height = data.get("height")
-if not isinstance(height, int):
- raise ValueError("height must be an integer")
+height = data["height"]
+if not isinstance(height, int) or height < 0:
+ raise ValueError(f"height must be a non-negative integer, got {height}")Suggestion importance[1-10]: 7
__
Why: Good suggestion for consistency with required fields like width and state, and adding non-negative validation improves robustness of the validation logic.
[possible issue] Check for missing fields
✅ Check for missing fields
The code uses data.get() which returns None for missing keys, but then checks types without checking for None values. This could lead to misleading error messages when fields are missing versus when they have incorrect types.
py/selenium/webdriver/common/bidi/browser.py [131-146]
try:
client_window = data.get("clientWindow")
+ if client_window is None:
+ raise ValueError("clientWindow is required")
if not isinstance(client_window, str):
raise ValueError("clientWindow must be a string")
state = data.get("state")
+ if state is None:
+ raise ValueError("state is required")
if not isinstance(state, str):
raise ValueError("state must be a string")
width = data.get("width")
+ if width is None:
+ raise ValueError("width is required")
if not isinstance(width, int):
raise ValueError("width must be an integer")
height = data.get("height")
+ if height is None:
+ raise ValueError("height is required")
if not isinstance(height, int):
raise ValueError("height must be an integer")Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that data.get() returns None for missing keys, and the current code would give misleading error messages. Adding explicit None checks provides clearer distinction between missing and invalid type errors.
| PR 15845 (2025-06-02) |
[possible issue] Fix missing package extra
✅ Fix missing package extra
The urllib3 package is specified without the [socks] extra in requirements.txt, but the pyproject.toml file specifies urllib3[socks]. This inconsistency could lead to missing dependencies when installing from requirements.txt directly.
typing_extensions==4.14.0
-urllib3==2.4.0
+urllib3[socks]==2.4.0Suggestion importance[1-10]: 8
__
Why: The suggestion identifies a real inconsistency where urllib3[socks] in pyproject.toml differs from urllib3 in requirements.txt, which could lead to missing socks functionality when installing directly from requirements.txt.
| PR 15841 (2025-06-01) |
[general] Fix inconsistent spacing
✅ Fix inconsistent spacing
Remove the unnecessary spaces around the equal signs in the parameter assignments. This inconsistent spacing style differs from the rest of the codebase and violates PEP 8 style guidelines for Python.
py/selenium/webdriver/common/bidi/storage.py [90-92]
-name = str(data.get("name") or ""),
-domain = str(data.get("domain") or ""),
+name=str(data.get("name") or ""),
+domain=str(data.get("domain") or ""),Suggestion importance[1-10]: 3
__
Why: The suggestion correctly identifies inconsistent spacing around equals signs in parameter assignments. While this is a minor style issue that doesn't affect functionality, it improves code consistency and PEP 8 compliance.
[general] Fix spacing in assignment
✅ Fix spacing in assignment
Remove the extra space before the equal sign. There are two spaces between the type annotation and the equal sign, which is inconsistent with Python style guidelines.
py/selenium/webdriver/common/bidi/storage.py [251]
-result: dict[str, Any] = {
+result: dict[str, Any] = {Suggestion importance[1-10]: 3
__
Why: The suggestion correctly identifies an extra space before the equals sign in the type-annotated assignment. This is a minor style inconsistency that should be fixed for better code formatting.
| PR 15789 (2025-05-24) |
[general] Add error handling
✅ Add error handling
Add error handling to the kill method similar to what was added to terminate. This ensures consistent behavior when trying to kill a process that no longer exists.
rb/lib/selenium/webdriver/common/child_process.rb [129-131]
def kill(pid)
Process.kill(SIGKILL, pid)
+rescue Errno::ECHILD, Errno::ESRCH
+ # Process does not exist, nothing to kill
endSuggestion importance[1-10]: 8
__
Why: Adding error handling for Errno::ECHILD and Errno::ESRCH in the kill method improves robustness and consistency, preventing unnecessary exceptions when attempting to kill a non-existent process, which is important for reliable process management.
| PR 15751 (2025-05-19) |
[learned best practice] Use specific exception types
✅ Use specific exception types
Use a more specific exception type instead of the generic Exception class. Consider using a custom exception or a more specific built-in exception that better represents the error condition from the WebSocket response.
py/selenium/webdriver/remote/websocket_connection.py [67-73]
if "error" in response:
error = response["error"]
if "message" in response:
error_msg = f"{error}: {response['message']}"
- raise Exception(error_msg)
+ raise WebDriverException(error_msg)
else:
- raise Exception(error)
+ raise WebDriverException(error)Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Fix inconsistent error messages and validation logic. Ensure error messages are clear, accurate, and provide specific information about the error condition.
| PR 15749 (2025-05-19) |
[general] Fix documentation example
✅ Fix documentation example
Fix the syntax error in the example code where there's an extra closing parenthesis. This will prevent confusion for users following the documentation.
py/selenium/webdriver/remote/webdriver.py [1348-1361]
@property
def webextension(self):
"""Returns a webextension module object for BiDi webextension commands.
Returns:
--------
WebExtension: an object containing access to BiDi webextension commands.
Examples:
---------
>>> extension_path = "/path/to/extension"
- >>> extension_result = driver.webextension.install(path=extension_path)))
+ >>> extension_result = driver.webextension.install(path=extension_path)
>>> driver.webextension.uninstall(extension_result)
"""Suggestion importance[1-10]: 6
__
Why: Correcting the extra parenthesis in the documentation example improves clarity and prevents user confusion, but it does not affect the functionality or correctness of the code itself. This is a minor but helpful documentation fix.
| PR 15746 (2025-05-16) |
[possible issue] Fix unbalanced parentheses
✅ Fix unbalanced parentheses
The parentheses in this example are not properly balanced. The closing parenthesis for the method call is placed on a new line but is not aligned with the opening parenthesis, which can lead to syntax errors or confusion.
py/selenium/webdriver/support/expected_conditions.py [391-393]
->>> is_text_in_element = WebDriverWait(driver, 10).until(EC.text_to_be_present_in_element(
- (By.CLASS_NAME, "foo"), "bar")
- )
+>>> is_text_in_element = WebDriverWait(driver, 10).until(
+... EC.text_to_be_present_in_element((By.CLASS_NAME, "foo"), "bar")
+... )Suggestion importance[1-10]: 5
__
Why: The suggestion correctly identifies a minor style/readability issue with the placement of parentheses in a docstring example, but it does not affect the actual functionality or correctness of the code. The improved code is clearer and more idiomatic, but the original would still work as a docstring example in most cases.
| PR 15696 (2025-05-03) |
[general] Fix duplicate variable assignment
✅ Fix duplicate variable assignment
There's a duplicate variable assignment with options = options =. This creates a redundant assignment that doesn't cause functional issues but is unnecessary and confusing. Remove the duplication.
-options = options = getattr(webdriver, f"{driver_class}Options")()
+options = getattr(webdriver, f"{driver_class}Options")()Suggestion importance[1-10]: 3
__
Why: The suggestion correctly identifies and fixes a redundant variable assignment (options = options =), improving code clarity.
[general] Fix duplicate variable assignment
✅ Fix duplicate variable assignment
There's a duplicate variable assignment with options = options =. This creates a redundant assignment that doesn't cause functional issues but is unnecessary and confusing. Remove the duplication.
-options = options = getattr(webdriver, f"{driver_class}Options")()
+options = getattr(webdriver, f"{driver_class}Options")()Suggestion importance[1-10]: 3
__
Why: The suggestion correctly identifies and fixes a redundant variable assignment (options = options =), improving code clarity.
| PR 15676 (2025-04-28) |
[possible issue] Fix inconsistent log message
✅ Fix inconsistent log message
The log message doesn't match the test expectation. The test expects a message containing "No valid process exit status" but the actual message uses "Invalid process exit status". Update the log message to match the test expectation.
rb/lib/selenium/webdriver/common/selenium_manager.rb [108-118]
def validate_command_result(command, status, result, stderr)
if status.nil? || status.exitstatus.nil?
- WebDriver.logger.info("Invalid process exit status for: #{command}. Assuming success if result is present.",
+ WebDriver.logger.info("No valid process exit status for: #{command}. Assuming success if result is present.",
id: :selenium_manager)
end
return unless status&.exitstatus&.positive? || result.nil?
raise Error::WebDriverError,
"Unsuccessful command executed: #{command} - Code #{status&.exitstatus}\n#{result}\n#{stderr}"
endSuggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies a mismatch between the log message in the validate_command_result method and the expectation in the corresponding new test in selenium_manager_spec.rb. Applying the fix ensures the test passes and maintains consistency.
| PR 15673 (2025-04-27) |
[general] Ensure proper resource cleanup
✅ Ensure proper resource cleanup
Ensure the driver is properly closed even if the test fails by using a try-finally block. Currently, if the test fails before reaching driver.quit(), the driver won't be properly cleaned up.
py/test/selenium/webdriver/remote/remote_connection_tests.py [38-53]
def test_remote_webdriver_with_http_timeout(firefox_options, webserver):
"""This test starts a remote webdriver with an http client timeout
set less than the implicit wait timeout, and verifies the http timeout
is triggered first when waiting for an element.
"""
http_timeout = 6
wait_timeout = 8
server_addr = f"http://{webserver.host}:{webserver.port}"
client_config = ClientConfig(remote_server_addr=server_addr, timeout=http_timeout)
assert client_config.timeout == http_timeout
driver = webdriver.Remote(options=firefox_options, client_config=client_config)
- driver.get(f"{server_addr}/simpleTest.html")
- driver.implicitly_wait(wait_timeout)
- with pytest.raises(ReadTimeoutError):
- driver.find_element(By.ID, "no_element_to_be_found")
- driver.quit()
+ try:
+ driver.get(f"{server_addr}/simpleTest.html")
+ driver.implicitly_wait(wait_timeout)
+ with pytest.raises(ReadTimeoutError):
+ driver.find_element(By.ID, "no_element_to_be_found")
+ finally:
+ driver.quit()Suggestion importance[1-10]: 8
__
Why: This suggestion addresses a potential resource leak by ensuring the driver is properly closed even if the test fails. This is an important improvement for test reliability and system resource management.
| PR 15666 (2025-04-25) |
[general] Close socket to prevent leaks
✅ Close socket to prevent leaks
The socket is not being closed after use, which can lead to resource leaks. Always close sockets after use, preferably using a context manager or explicitly calling close().
py/selenium/webdriver/remote/server.py [120-125]
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
host = self.host if self.host is not None else "localhost"
try:
sock.connect((host, self.port))
+ sock.close()
raise ConnectionError(f"Selenium server is already running, or something else is using port {self.port}")
except ConnectionRefusedError:
+ sock.close()Suggestion importance[1-10]: 8
__
Why: This is an important fix for a resource leak. The socket is created but never closed, which could lead to exhausting system resources if the code is called repeatedly. Properly closing sockets is a best practice for resource management.
[possible issue] Check process state before terminating
✅ Check process state before terminating
The stop() method should be more resilient by checking if the process is still running before attempting to terminate it. The current implementation could raise an exception if the process has already terminated.
py/selenium/webdriver/remote/server.py [134-142]
def stop(self):
"""Stop the server."""
if self.process is None:
raise RuntimeError("Selenium server isn't running")
else:
- self.process.terminate()
- self.process.wait()
+ if self.process.poll() is None: # Check if process is still running
+ self.process.terminate()
+ self.process.wait()
self.process = None
print("Selenium server has been terminated")Suggestion importance[1-10]: 7
__
Why: This suggestion adds important error handling by checking if the process is still running before attempting to terminate it. This prevents potential exceptions if the process has already terminated, making the code more robust.
[possible issue] Raise timeout error
✅ Raise timeout error
The error message is defined but not raised. Add a raise TimeoutError statement to properly handle the server startup timeout.
py/selenium/webdriver/remote/server.py [129-130]
if not self._wait_for_server():
- f"Timed out waiting for Selenium server at {self.status_url}"
+ raise TimeoutError(f"Timed out waiting for Selenium server at {self.status_url}")Suggestion importance[1-10]: 10
__
Why: This is a critical bug fix. The code creates an error message string but doesn't actually raise an exception, so the server would silently continue even when it fails to start properly. Adding the missing raise TimeoutError ensures the application fails appropriately when the server doesn't start within the expected time.
| PR 15643 (2025-04-19) |
[general] Add missing autoflake option
✅ Add missing autoflake option
Consider adding the remove-all-unused-imports option to the autoflake configuration to ensure all unused imports are removed, which aligns with the PR's goal of adding autoflake for linting.
[tool.autoflake]
exclude = "selenium/webdriver/common/devtools"
ignore-pass-after-docstring = true
in-place = true
quiet = true
recursive = true
remove-duplicate-keys = true
remove-unused-variables = true
+remove-all-unused-imports = trueSuggestion importance[1-10]: 6
__
Why: The suggestion adds the 'remove-all-unused-imports' option to autoflake configuration, which aligns with the PR's goal of enhancing linting capabilities. This is a relevant improvement that would make the autoflake tool more effective at removing unused imports.
[possible issue] Fix flake8 configuration
✅ Fix flake8 configuration
The flake8-pyproject package is added as a dependency in tox.ini, but the configuration in pyproject.toml might not work as expected. Flake8 traditionally doesn't read from pyproject.toml natively - it requires the flake8-pyproject plugin to be properly configured.
[tool.flake8]
exclude = "selenium/webdriver/common/devtools"
# Disable E501 once line length is better handled
extend-ignore = ["E501", "E203"]
# This does nothing for now as E501 is ignored
max-line-length = 120
-min-python-version = 3.9
+min_python_version = "3.9"Suggestion importance[1-10]: 5
__
Why: The suggestion correctly identifies a configuration issue with flake8 in pyproject.toml. The parameter should be min_python_version with an underscore instead of min-python-version with a hyphen, and the value should be a string "3.9" rather than a number.
[general] Remove only_modified isort option
✅ Remove only_modified isort option
The only_modified option in isort configuration will limit isort to only process modified files. This could lead to inconsistent formatting across the codebase. For a linting tool in a CI environment, it's better to ensure all files follow the same standard.
[tool.isort]
# isort is a common python tool for keeping imports nicely formatted.
# Automatically keep imports alphabetically sorted, on single lines in
# PEP recommended sections (https://peps.python.org/pep-0008/#imports)
# files or individual lines can be ignored via `# isort:skip|# isort:skip_file`.
force_single_line = true
profile = "black"
py_version = 39
-only_modified = trueSuggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a potential issue with the added "only_modified" option, which could lead to inconsistent formatting across the codebase. Removing this option would ensure consistent formatting standards are applied to all files.
| PR 15619 (2025-04-12) |
[general] Fix typo in function name
✅ Fix typo in function name
Fix the typo in the test function name. "paraeter" should be "parameter".
py/test/selenium/webdriver/remote/remote_tests.py [25]
-def test_remote_webdriver_requires_options_paraeter():
+def test_remote_webdriver_requires_options_parameter():Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies a typo in the test function name where "paraeter" should be "parameter". This is a valid improvement for code readability and maintainability, ensuring consistent and correct naming conventions.
[general] Rename test function
✅ Rename test function
The test function name test_remote_webdriver_requires_options_kwarg() implies that options is a keyword-only argument, but in the implementation it's a regular parameter. Consider renaming the test function to better reflect what's being tested.
py/test/selenium/webdriver/remote/remote_tests.py [25-32]
-def test_remote_webdriver_requires_options_kwarg():
+def test_remote_webdriver_requires_options_parameter():
msg = "missing 1 required keyword-only argument: 'options' (instance of driver `options.Options` class)"
with pytest.raises(TypeError, match=re.escape(msg)):
webdriver.Remote()
with pytest.raises(TypeError, match=re.escape(msg)):
webdriver.Remote(None)
with pytest.raises(TypeError, match=re.escape(msg)):
webdriver.Remote(options=None)Suggestion importance[1-10]: 5
__
Why: The suggestion correctly identifies a mismatch between the test function name and the error message. The error message refers to 'options' as a "keyword-only argument" while the function name implies it's a keyword argument, but the implementation treats it as a regular parameter. Renaming the function improves clarity and consistency.
| PR 15616 (2025-04-11) |
[possible issue] Prevent removing default context
✅ Prevent removing default context
Add validation to prevent removing the "default" user context. The docstring mentions that an exception will be raised if the user context ID is "default", but there's no actual validation in the code to prevent this operation.
py/selenium/webdriver/common/bidi/browser.py [168-180]
def remove_user_context(self, user_context_id: str) -> None:
"""Removes a user context.
Parameters:
-----------
user_context_id: The ID of the user context to remove.
Raises:
------
Exception: If the user context ID is "default" or does not exist.
"""
+ if user_context_id == "default":
+ raise Exception("Cannot remove the default user context")
+
params = {"userContext": user_context_id}
self.conn.execute(command_builder("browser.removeUserContext", params))Suggestion importance[1-10]: 9
__
Why: The suggestion adds critical validation to prevent removing the "default" user context, which aligns with the documented behavior in the docstring. Without this check, users could attempt to remove the default context, potentially causing system instability or unexpected behavior.
| PR 15615 (2025-04-11) |
[general] Move import to module level
✅ Move import to module level
Move the import statement to the top of the file with other imports rather than inside the method. Importing within a method can cause performance issues if the method is called frequently, as the import operation will be repeated each time.
py/selenium/webdriver/remote/webdriver.py [1289-1294]
def get_bidi_session_status(self):
"""
Get the session status using WebDriver BiDi.
Returns information about whether a remote end is in a state
in which it can create new sessions.
Returns:
-------
dict
Dictionary containing the ready state (bool), message (str) and metadata
Example:
--------
>>> status = driver.get_bidi_session_status()
>>> print(status["ready"])
>>> print(status["message"])
"""
if not self._websocket_connection:
self._start_bidi()
- from selenium.webdriver.common.bidi.session import session_status
-
return self._websocket_connection.execute(session_status())Suggestion importance[1-10]: 3
__
Why: Moving the import statement to the module level is a valid suggestion that follows Python best practices and could slightly improve performance if the method is called frequently. However, the impact is relatively minor as the performance difference would only be noticeable with frequent calls.
| PR 15614 (2025-04-11) |
[general] Fix grammatical errors
✅ Fix grammatical errors
There's a grammatical error in the instructions about staging files after running black and isort. The phrase "should staged again" is incorrect and could confuse contributors.
py/docs/source/index.rst [178-180]
- `flake8` requires manual fixes
-- `black` will rewrite the violations automatically, however the files are unstaged and should staged again
-- `isort` will rewrite the violations automatically, however the files are unstaged and should staged again
+- `black` will rewrite the violations automatically, however the files are unstaged and should be staged again
+- `isort` will rewrite the violations automatically, however the files are unstaged and should be staged againSuggestion importance[1-10]: 5
__
Why: The suggestion correctly identifies and fixes a grammatical error in the contributing instructions, changing "should staged again" to "should be staged again". While not affecting functionality, this improves clarity and professionalism of the documentation.
[general] Use specific Python version
✅ Use specific Python version
Using "latest" for Python version can lead to unexpected build failures when new Python versions are released. Specify a concrete Python version (like "3.11") to ensure build stability and reproducibility.
py/docs/.readthedocs.yaml [10-18]
build:
os: ubuntu-24.04
tools:
- python: "latest"
+ python: "3.11"
commands:
- pip install -r py/docs/requirements.txt
- pip install -r py/requirements.txt
- PYTHONPATH=py sphinx-autogen -o $READTHEDOCS_OUTPUT/html py/docs/source/api.rst
- PYTHONPATH=py sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/htmlSuggestion importance[1-10]: 7
__
Why: Using a specific Python version instead of "latest" is a good practice for build stability and reproducibility. This change would prevent potential issues when new Python versions are released that might introduce compatibility problems.
[possible issue] Add PYTHONPATH to sphinx-build
✅ Add PYTHONPATH to sphinx-build
The PYTHONPATH environment variable is set only for the sphinx-autogen command but not for the sphinx-build command. This could lead to import errors during documentation building if the Python modules need to be imported from the py directory.
py/docs/.readthedocs.yaml [10-18]
build:
os: ubuntu-24.04
tools:
python: "latest"
commands:
- pip install -r py/docs/requirements.txt
- pip install -r py/requirements.txt
- PYTHONPATH=py sphinx-autogen -o $READTHEDOCS_OUTPUT/html py/docs/source/api.rst
- - sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html
+ - PYTHONPATH=py sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/htmlSuggestion importance[1-10]: 8
__
Why: This suggestion addresses a potential build failure issue. Setting PYTHONPATH for sphinx-autogen but not for sphinx-build could cause import errors during documentation generation since sphinx-build also needs to access Python modules in the py directory.
| PR 15601 (2025-04-09) |
[possible issue] Ensure environment variable timing
✅ Ensure environment variable timing
Setting environment variables after the process has started may not affect Firefox's behavior. Environment variables should be set before Firefox is launched. Consider checking if this environment variable is being set early enough to affect Firefox's startup behavior.
# There are issues with window size/position when running Firefox
# under Wayland, so we use XWayland instead.
-os.environ['MOZ_ENABLE_WAYLAND'] = '0'
+# Set this before Firefox is launched to ensure it takes effect
+if 'MOZ_ENABLE_WAYLAND' not in os.environ:
+ os.environ['MOZ_ENABLE_WAYLAND'] = '0'Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies a potential issue with environment variable timing. Setting environment variables after process initialization may not affect Firefox's behavior, and the improved code adds a check to avoid overriding existing values, which is a good practice for environment configuration.
| PR 15579 (2025-04-05) |
[possible issue] Missing driver cleanup
✅ Missing driver cleanup
The test is missing cleanup for driver2. If driver2 is successfully created, it should be quit in the finally block to properly release resources.
py/test/selenium/webdriver/chrome/chrome_service_tests.py [53-54]
finally:
driver1.quit()
+ if driver2:
+ driver2.quit()Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a resource leak where driver2 is not being properly cleaned up in the finally block. This is a significant issue that could lead to resource leaks and potentially affect subsequent tests.
[possible issue] Handle undefined variable safely
✅ Handle undefined variable safely
The test is missing a reference to driver1 before quitting it in the finally block. Since driver1 is defined inside the try block, it might not exist if an exception occurs before its creation, causing a NameError.
py/test/selenium/webdriver/chrome/chrome_service_tests.py [54]
-driver1.quit()
+if 'driver1' in locals() and driver1:
+ driver1.quit()Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a critical issue where the test could fail with a NameError if an exception occurs before driver1 is created. The improved code safely checks if driver1 exists before attempting to quit it, preventing potential test failures.
| PR 15575 (2025-04-04) |
[possible issue] Check dictionary key exists
✅ Check dictionary key exists
The code doesn't check if the successId exists in the _pendingCommands dictionary before accessing it. This could lead to a KeyNotFoundException if a success message is received for a command ID that is not in the dictionary.
dotnet/src/webdriver/BiDi/Communication/Broker.cs [136-142]
try
{
var data = await _transport.ReceiveAsync(cancellationToken).ConfigureAwait(false);
Utf8JsonReader utfJsonReader = new(new ReadOnlySpan<byte>(data));
utfJsonReader.Read();
var messageType = utfJsonReader.GetDiscriminator("type");
switch (messageType)
{
case "success":
var successId = int.Parse(utfJsonReader.GetDiscriminator("id"));
- var successCommand = _pendingCommands[successId];
- var messageSuccess = JsonSerializer.Deserialize(ref utfJsonReader, successCommand.Item1.ResultType, _jsonSerializerContext);
+ if (_pendingCommands.TryGetValue(successId, out var successCommand))
+ {
+ var messageSuccess = JsonSerializer.Deserialize(ref utfJsonReader, successCommand.Item1.ResultType, _jsonSerializerContext);
- successCommand.Item2.SetResult(messageSuccess);
+ successCommand.Item2.SetResult(messageSuccess);
- _pendingCommands.TryRemove(successId, out _);
+ _pendingCommands.TryRemove(successId, out _);
+ }
break;Suggestion importance[1-10]: 8
__
Why: This suggestion addresses a potential runtime exception by checking if the key exists in the dictionary before accessing it. Without this check, the code could throw a KeyNotFoundException if a success message is received for a command ID that isn't in the pending commands dictionary.
[possible issue] Check event handlers exist
✅ Check event handlers exist
The code doesn't check if the method exists in the _eventHandlers dictionary or if there are any handlers for that method before accessing it. This could lead to a KeyNotFoundException or InvalidOperationException (when calling First() on an empty collection) if an event is received for a method that has no registered handlers.
dotnet/src/webdriver/BiDi/Communication/Broker.cs [145-159]
case "event":
utfJsonReader.Read();
utfJsonReader.Read();
var method = utfJsonReader.GetString();
utfJsonReader.Read();
- // TODO: Just get type info from existing subscribers, should be better
- var type = _eventHandlers[method].First().EventArgsType;
+ if (_eventHandlers.TryGetValue(method, out var handlers) && handlers.Count > 0)
+ {
+ // TODO: Just get type info from existing subscribers, should be better
+ var type = handlers.First().EventArgsType;
- var eventArgs = (EventArgs)JsonSerializer.Deserialize(ref utfJsonReader, type, _jsonSerializerContext);
+ var eventArgs = (EventArgs)JsonSerializer.Deserialize(ref utfJsonReader, type, _jsonSerializerContext);
- var messageEvent = new MessageEvent(method, eventArgs);
- _pendingEvents.Add(messageEvent);
+ var messageEvent = new MessageEvent(method, eventArgs);
+ _pendingEvents.Add(messageEvent);
+ }
break;Suggestion importance[1-10]: 8
__
Why: The suggestion prevents potential KeyNotFoundException and InvalidOperationException by checking if handlers exist for the event method before attempting to access them. This is an important defensive coding practice that improves error handling and robustness.
| PR 15559 (2025-04-03) |
[general] Missing verification after alert dismissal
✅ Missing verification after alert dismissal
The test is missing an assertion to verify that the alert was properly dismissed. After dismissing the alert, add an assertion to confirm that the alert is no longer present and that the page is in the expected state.
py/test/selenium/webdriver/common/alerts_tests.py [187-196]
@pytest.mark.xfail_safari
def test_should_throw_an_exception_if_an_alert_has_not_been_dealt_with_and_dismiss_the_alert(driver, pages):
pages.load("alerts.html")
driver.find_element(By.ID, "alert").click()
WebDriverWait(driver, 5).until(EC.alert_is_present())
with pytest.raises(UnexpectedAlertPresentException):
driver.find_element(By.ID, "select").click()
alert = _wait_for_alert(driver)
alert.dismiss()
+
+ # Verify alert is dismissed
+ assert "Testing Alerts" == driver.titleSuggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that the test lacks verification after dismissing the alert. Adding an assertion to check the page title is a good practice to ensure the alert was properly dismissed and the page returned to its expected state.
| PR 15555 (2025-04-02) |
[possible issue] Validate discriminator existence
✅ Validate discriminator existence
The method doesn't handle the case where the discriminator property isn't found in the JSON object. If the property doesn't exist, the method will return null, which could lead to unexpected behavior in the converters that use this method. Consider adding validation to throw a more descriptive exception when the discriminator property is missing.
dotnet/src/webdriver/BiDi/Communication/Json/Internal/JsonExtensions.cs [26-52]
public static string? GetDiscriminator(this ref Utf8JsonReader reader, string name)
{
Utf8JsonReader readerClone = reader;
if (readerClone.TokenType != JsonTokenType.StartObject)
throw new JsonException();
string? discriminator = null;
readerClone.Read();
while (readerClone.TokenType == JsonTokenType.PropertyName)
{
string? propertyName = readerClone.GetString();
readerClone.Read();
if (propertyName == name)
{
discriminator = readerClone.GetString();
break;
}
readerClone.Skip();
readerClone.Read();
}
+ if (discriminator == null)
+ throw new JsonException($"Required discriminator property '{name}' not found in JSON object.");
+
return discriminator;
}Suggestion importance[1-10]: 8
__
Why: The suggestion addresses a potential bug where missing discriminator properties would return null without error, causing silent failures in the converters. Adding validation with a descriptive exception improves error handling and debugging significantly.
| PR 15537 (2025-03-31) |
[possible issue] Fix incorrect browserName matching
✅ Fix incorrect browserName matching
The current implementation of browserNameMatch has a logical issue. When specificRelayCapabilitiesAppMatch returns true, it will always match regardless of the stereotype's browserName, which could lead to incorrect matching. The method should consider the stereotype's browserName value when making this decision.
java/src/org/openqa/selenium/grid/data/DefaultSlotMatcher.java [172-176]
private boolean browserNameMatch(Capabilities stereotype, Capabilities capabilities) {
return (capabilities.getBrowserName() == null || capabilities.getBrowserName().isEmpty())
|| Objects.equals(stereotype.getBrowserName(), capabilities.getBrowserName())
- || specificRelayCapabilitiesAppMatch(capabilities);
+ || (specificRelayCapabilitiesAppMatch(capabilities) &&
+ (stereotype.getBrowserName() == null || stereotype.getBrowserName().isEmpty()));
}Suggestion importance[1-10]: 9
__
Why: The current implementation has a critical logical flaw that could lead to incorrect matching. It unconditionally returns true when specificRelayCapabilitiesAppMatch is true, regardless of stereotype's browserName. The fix ensures proper matching by considering the stereotype's browserName value, preventing potential mismatches in Appium sessions.
[possible issue] Fix incorrect browserVersion matching
✅ Fix incorrect browserVersion matching
Similar to the browserNameMatch issue, the browserVersionMatch method unconditionally returns true when specificRelayCapabilitiesAppMatch is true, regardless of the stereotype's browserVersion. This could lead to incorrect matching when the stereotype has a specific browserVersion requirement.
java/src/org/openqa/selenium/grid/data/DefaultSlotMatcher.java [182-188]
private boolean browserVersionMatch(Capabilities stereotype, Capabilities capabilities) {
return (capabilities.getBrowserVersion() == null
|| capabilities.getBrowserVersion().isEmpty()
|| Objects.equals(capabilities.getBrowserVersion(), "stable"))
|| browserVersionMatch(stereotype.getBrowserVersion(), capabilities.getBrowserVersion())
- || specificRelayCapabilitiesAppMatch(capabilities);
+ || (specificRelayCapabilitiesAppMatch(capabilities) &&
+ (stereotype.getBrowserVersion() == null || stereotype.getBrowserVersion().isEmpty()));
}Suggestion importance[1-10]: 9
__
Why: Similar to the first issue, this method has a critical logical flaw that could lead to incorrect matching. It unconditionally returns true when specificRelayCapabilitiesAppMatch is true, regardless of stereotype's browserVersion. The fix ensures proper matching by considering the stereotype's browserVersion value.
| PR 15532 (2025-03-28) |
[general] Remove redundant array conversion
✅ Remove redundant array conversion
The method is converting the array twice unnecessarily. The convertedArray variable is created but never used, and then the conversion is performed again in the return statement.
dotnet/src/webdriver/BiDi/Modules/Script/LocalValue.cs [200-209]
public static LocalValue ConvertFrom(object?[]? values)
{
if (values is null)
{
return new NullLocalValue();
}
LocalValue[] convertedArray = Array.ConvertAll(values, ConvertFrom);
- return new ArrayLocalValue(Array.ConvertAll(values, ConvertFrom));
+ return new ArrayLocalValue(convertedArray);
}Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a significant bug where the array is converted twice unnecessarily. The code creates a convertedArray variable but then ignores it, performing the conversion again in the return statement. This wastes CPU cycles and memory, potentially impacting performance for large arrays.
| PR 15521 (2025-03-27) |
[learned best practice] Use safe type checking with the 'as' operator instead of direct casting to prevent potential InvalidCastException
✅ Use safe type checking with the 'as' operator instead of direct casting to prevent potential InvalidCastException
The current implementation of ThrowOnError() uses a direct cast to EvaluateResultException without checking if the object is actually of that type. If this is neither EvaluateResultSuccess nor EvaluateResultException, it will throw an InvalidCastException. Use the as operator with null checking to make the code more robust and prevent potential runtime exceptions.
dotnet/src/webdriver/BiDi/Modules/Script/EvaluateCommand.cs [44-52]
public EvaluateResultSuccess ThrowOnError()
{
if (this is EvaluateResultSuccess success)
{
return success;
}
- throw new ScriptEvaluateException((EvaluateResultException)this);
+ var exception = this as EvaluateResultException;
+ if (exception != null)
+ {
+ throw new ScriptEvaluateException(exception);
+ }
+
+ throw new InvalidOperationException($"Unexpected result type: {this.GetType().Name}");
}Suggestion importance[1-10]: 6
| PR 15495 (2025-03-23) |
[possible issue] Fix platform detection
✅ Fix platform detection
The property is storing the platform module instead of the platform name. It should call platform.system() to get the actual platform name.
@property
def exe_platform(self):
- self._platform = platform
+ self._platform = platform.system()
return self._platform[Suggestion has been applied]
Suggestion importance[1-10]: 10
__
Why: This fixes a critical bug where the platform module object is being stored instead of the actual platform name (string). This would cause platform-specific checks to fail, as seen in lines 212-217 where platform comparisons are made.
[possible issue] Return existing driver instance
✅ Return existing driver instance
The driver property doesn't return the driver instance when it's already initialized. It should return self._driver if it exists, otherwise initialize and return it.
@property
def driver(self):
if not self._driver:
return self._initialize_driver()
+ return self._driver[Suggestion has been applied]
Suggestion importance[1-10]: 9
__
Why: This is a critical bug fix. The current implementation only returns a value when initializing a new driver but doesn't return anything when the driver already exists, which would cause the property to return None in subsequent calls, breaking driver functionality.
[possible issue] Return None for missing executable
✅ Return None for missing executable
The service property doesn't return anything when executable is falsy, which could cause unexpected behavior. It should return None explicitly in this case.
@property
def service(self):
executable = self.driver_path
if executable:
module = getattr(webdriver, self._driver_class.lower())
self._service = module.service.Service(executable_path=executable)
return self._service
+ return None[Suggestion has been applied]
Suggestion importance[1-10]: 7
__
Why: This improves code clarity and prevents potential issues by explicitly returning None when no executable is provided. Without this fix, the property would return undefined, which could lead to unexpected behavior when the service property is accessed.
| PR 15467 (2025-03-21) |
[general] Improve error message clarity
✅ Improve error message clarity
The error message should be more specific about the expected types. Currently it mentions "PartitionDescriptor" which is a parent class, but the check is specifically for BrowsingContextPartitionDescriptor or StorageKeyPartitionDescriptor.
javascript/node/selenium-webdriver/bidi/storage.js [56-61]
if (
partition !== undefined &&
!(partition instanceof BrowsingContextPartitionDescriptor || partition instanceof StorageKeyPartitionDescriptor)
) {
- throw new Error(`Params must be an instance of PartitionDescriptor. Received:'${partition}'`)
+ throw new Error(`Params must be an instance of BrowsingContextPartitionDescriptor or StorageKeyPartitionDescriptor. Received:'${partition}'`)
}Suggestion importance[1-10]: 5
__
Why: The suggestion improves the error message by making it more specific about the expected types (BrowsingContextPartitionDescriptor or StorageKeyPartitionDescriptor) instead of the generic parent class (PartitionDescriptor). This enhances code clarity and debugging experience.
| PR 15466 (2025-03-20) |
[general] Fix incorrect docstring description
✅ Fix incorrect docstring description
The docstring for web_socket_url incorrectly states it's for accepting insecure certificates. It should describe WebSocket URL functionality instead.
py/selenium/webdriver/common/options.py [287-288]
web_socket_url = _BaseOptionsDescriptor("webSocketUrl")
-"""Gets and Set whether the session accepts insecure certificates.
+"""Gets and Sets WebSocket URL.Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a significant error in the docstring where the WebSocket URL property is incorrectly described as controlling insecure certificates acceptance. This is a clear documentation bug that could mislead developers.
[general] Fix incorrect parameter type
✅ Fix incorrect parameter type
The parameter and return type for web_socket_url are incorrectly documented as bool when they should be str based on the property name and its usage.
py/selenium/webdriver/common/options.py [421-439]
web_socket_url = _BaseOptionsDescriptor("webSocketUrl")
"""Gets and Sets WebSocket URL.
Usage:
------
- Get
- `self.web_socket_url`
- Set
- `self.web_socket_url` = `value`
Parameters:
-----------
-`value`: `bool`
+`value`: `str`
Returns:
--------
- Get
- - `bool`
+ - `str`
- Set
- `None`
"""Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that the parameter and return types for web_socket_url are incorrectly documented as boolean when they should be strings. This is an important documentation fix that prevents confusion about the expected data types.
[possible issue] Remove duplicate property declaration
✅ Remove duplicate property declaration
The web_socket_url property is duplicated in the BaseOptions class. There are two identical property declarations at lines 287 and 421, which could cause confusion or unexpected behavior.
py/selenium/webdriver/common/options.py [421-441]
-web_socket_url = _BaseOptionsDescriptor("webSocketUrl")
-"""Gets and Sets WebSocket URL.
+# Remove the duplicate declaration, keeping only one instance of web_socket_url
-Usage:
-------
-- Get
- - `self.web_socket_url`
-- Set
- - `self.web_socket_url` = `value`
-
-Parameters:
------------
-`value`: `bool`
-
-Returns:
---------
-- Get
- - `bool`
-- Set
- - `None`
-"""
-Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a duplicate declaration of the web_socket_url property in the BaseOptions class. This duplication (at lines 287-305 and 421-440) could lead to unexpected behavior as the second declaration would override the first one. Removing the duplicate is critical for proper class functionality.
[general] Fix inconsistent docstring formatting
✅ Fix inconsistent docstring formatting
The indentation in the docstring is inconsistent. The "Example:" section has one less dash than the "Parameters:" section, which could cause issues with Sphinx documentation generation.
py/selenium/webdriver/remote/webdriver.py [814-824]
def set_page_load_timeout(self, time_to_wait: float) -> None:
"""Sets the amount of time to wait for a page load to complete before
throwing an error.
Parameters:
-----------
time_to_wait : float
- The amount of time to wait (in seconds)
Example:
- -------
+ --------
>>> driver.set_page_load_timeout(30)
"""Suggestion importance[1-10]: 5
__
Why: The suggestion correctly identifies an inconsistency in the docstring formatting where the "Example:" section uses 7 dashes (-------) while the "Parameters:" section uses 9 dashes (-----------). This inconsistency could affect documentation generation with tools like Sphinx.
| PR 15458 (2025-03-19) |
[possible issue] Prevent redundant port allocation
✅ Prevent redundant port allocation
The current implementation assigns a new websocket port for every service instance, even when reusing the same service object. This could lead to port allocation issues and resource leaks. Store the allocated port as an instance variable to ensure consistent port usage throughout the service lifecycle.
rb/lib/selenium/webdriver/firefox/service.rb [29-36]
def initialize(path: nil, port: nil, log: nil, args: nil)
args ||= []
unless args.any? { |arg| arg.include?('--connect-existing') }
+ @websocket_port = Support::Sockets.free_port
args << '--websocket-port'
- args << Support::Sockets.free_port.to_s
+ args << @websocket_port.to_s
end
super
endSuggestion importance[1-10]: 7
__
Why: Storing the allocated port as an instance variable (@websocket_port) is a good practice that prevents potential resource leaks and ensures consistent port usage throughout the service lifecycle. This improves resource management and makes the port accessible for other methods.
| PR 15448 (2025-03-18) |
[general] Initialize registration state field
✅ Initialize registration state field
Initialize the registered field to false in the constructor to ensure it has a proper default value. Currently, it's declared but not initialized, which could lead to unexpected behavior.
java/src/org/openqa/selenium/grid/node/Node.java [134-138]
protected boolean registered;
protected Node(
Tracer tracer, NodeId id, URI uri, Secret registrationSecret, Duration sessionTimeout) {
this.tracer = Require.nonNull("Tracer", tracer);
+ this.registered = false;Suggestion importance[1-10]: 7
__
Why: The suggestion addresses a potential issue where the new 'registered' field is declared but not initialized in the constructor. Explicitly initializing it to false ensures consistent behavior across all Node instances and prevents potential bugs from uninitialized state.
| PR 15426 (2025-03-15) |
[possible issue] Handle potential null string
✅ Handle potential null string
The RemoteValue.String() method is called with a potentially null string value from GetString(), but the method doesn't appear to handle null values properly. This could lead to a NullReferenceException.
dotnet/src/webdriver/BiDi/Communication/Json/Converters/Polymorphic/RemoteValueConverter.cs [36]
-return RemoteValue.String(jsonDocument.RootElement.GetString());
+return RemoteValue.String(jsonDocument.RootElement.GetString() ?? string.Empty);Suggestion importance[1-10]: 7
__
Why: The suggestion addresses a potential NullReferenceException by handling the case where GetString() returns null. This is a valid defensive programming practice that improves code robustness.
| PR 15417 (2025-03-13) |
[possible issue] Fix driver initialization parameter
✅ Fix driver initialization parameter
The WebDriver::Driver.for method should receive the driver symbol, not the method symbol. You're passing method instead of driver, which will cause an error when trying to initialize non-private driver methods.
rb/spec/integration/selenium/webdriver/spec_support/test_environment.rb [166-176]
def create_driver!(listener: nil, **opts, █)
check_for_previous_error
chrome_beta(opts) if driver == :chrome_beta
method = :"#{driver}_driver"
instance = if private_methods.include?(method)
send(method, listener: listener, options: build_options(**opts))
else
- WebDriver::Driver.for(method, listener: listener, options: build_options(**opts))
+ WebDriver::Driver.for(driver, listener: listener, options: build_options(**opts))
end[Suggestion has been applied]
Suggestion importance[1-10]: 10
__
Why: This is a critical bug fix. The PR incorrectly changed the parameter from driver to method in the WebDriver::Driver.for call, which would cause the driver initialization to fail for non-private driver methods. The suggestion correctly restores the original parameter.
| PR 15416 (2025-03-13) |
[possible issue] Fix DevTools connections closure
✅ Fix DevTools connections closure
The current implementation of the quit method might not properly close all DevTools connections if @devtools is initialized but empty. Use each instead of map to ensure proper closure of all connections.
rb/lib/selenium/webdriver/common/driver.rb [187-192]
def quit
bridge.quit
ensure
@service_manager&.stop
- @devtools&.values&.map(&:close)
+ @devtools&.values&.each(&:close) if @devtools
endSuggestion importance[1-10]: 7
__
Why: The suggestion improves error handling by ensuring DevTools connections are properly closed even if @devtools is initialized but empty. Using each instead of map is more appropriate since we're not collecting return values, and adding the if @devtools check provides additional safety.
| PR 15395 (2025-03-09) |
[possible issue] Fix boolean assertion logic
✅ Fix boolean assertion logic
The JavaScript assertion for Boolean values is incorrect. The typeof operator returns the string "boolean" for boolean values, and you're comparing it directly to true/false. You should either remove the typeof or change the assertion to check the value directly.
dotnet/test/common/BiDi/Script/CallFunctionParameterTest.cs [275-282]
-//yield return new TestCaseData(new LocalValue.Boolean(true), new RemoteValue.Boolean(true), "typeof arg === true")
+//yield return new TestCaseData(new LocalValue.Boolean(true), new RemoteValue.Boolean(true), "arg === true")
//{
// TestName = nameof(CanCallFunctionAndRoundtrip_Five) + "(true)",
//};
-//yield return new TestCaseData(new LocalValue.Boolean(false), new RemoteValue.Boolean(false), "typeof arg === false")
+//yield return new TestCaseData(new LocalValue.Boolean(false), new RemoteValue.Boolean(false), "arg === false")
//{
// TestName = nameof(CanCallFunctionAndRoundtrip_Five) + "(false)",
//};Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a logical error in the commented-out test cases. The JavaScript assertion "typeof arg === true" is incorrect as typeof would return the string "boolean", not the boolean value itself. This would cause the tests to fail if uncommented.
| PR 15392 (2025-03-08) |
[general] Add Async suffix
✅ Add Async suffix
The method should be named with the "Async" suffix to follow the async method naming convention, as it returns a Task and calls an async method.
dotnet/src/webdriver/BiDi/Modules/BrowsingContext/BrowsingContextInputModule.cs [38-41]
-public Task SetFiles(Script.ISharedReference element, IEnumerable<string> files, SetFilesOptions? options = null)
+public Task SetFilesAsync(Script.ISharedReference element, IEnumerable<string> files, SetFilesOptions? options = null)
{
return inputModule.SetFilesAsync(context, element, files, options);
}Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies an inconsistency in method naming conventions. Methods that return Task should have the "Async" suffix according to C# conventions, especially since the method it calls (SetFilesAsync) follows this pattern. This improves code consistency and readability.
| PR 15379 (2025-03-05) |
[general] Add missing sealed modifier
✅ Add missing sealed modifier
The class should be explicitly marked as sealed since the implementation now prevents inheritance by removing the protected constructor and making all constructors private.
dotnet/src/webdriver/RelativeBy.cs [32-36]
-public class RelativeBy : By
+public sealed class RelativeBy : By
{
private readonly string wrappedAtom;
private readonly object root;
private readonly List<object> filters;Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that the class should be marked as sealed since the implementation prevents inheritance by removing the protected constructor and making all constructors private. This improves code clarity and prevents potential misuse.
[learned best practice] Use explicit collection initialization with new List() instead of collection expressions for better readability and consistency with .NET conventions
✅ Use explicit collection initialization with new List() instead of collection expressions for better readability and consistency with .NET conventions
The current implementation uses collection expressions [] to initialize an empty list when filters is null. While this works, it's better to use new List() or the collection initializer syntax new() for consistency with .NET conventions and to make the code more explicit about the type being created.
dotnet/src/webdriver/RelativeBy.cs [56]
-this.filters = filters is null ? [] : [.. filters]; // Clone filters
+this.filters = filters is null ? new List<object>() : new List<object>(filters); // Clone filtersSuggestion importance[1-10]: 6
| PR 15363 (2025-03-03) |
[possible issue] Add robust error handling
✅ Add robust error handling
Add error handling for the PowerShell command execution to handle cases where the command fails or returns unexpected output format.
let get_os_command = Command::new_single(PS_GET_OS_COMMAND.to_string());
-let ps_output = run_shell_command_by_os(self_os, get_os_command).unwrap_or_default();
+let ps_output = run_shell_command_by_os(self_os, get_os_command)
+ .map_err(|e| anyhow!("Failed to detect OS architecture: {}", e))?;
+if ps_output.trim().is_empty() {
+ return Err(anyhow!("Empty response from OS architecture detection"));
+}
if ps_output.contains("32") {
ARCH_X86.to_string()
} else if ps_output.contains("ARM") {
ARCH_ARM64.to_string()
} else {
ARCH_AMD64.to_string()
}[Suggestion has been applied]
Suggestion importance[1-10]: 8
__
Why: The suggestion adds critical error handling for OS architecture detection, replacing unwrap_or_default() with proper error propagation and empty output validation, which could prevent silent failures and improve system reliability.
| PR 15354 (2025-03-01) |
[general] Unify nullable reference type settings
✅ Unify nullable reference type settings
Consider using a single Nullable property setting for all target frameworks to maintain consistent null-checking behavior across the codebase.
dotnet/src/webdriver/WebDriver.csproj [45-54]
-<PropertyGroup Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))">
+<PropertyGroup>
<Nullable>enable</Nullable>
<!--TODO when AOT is ready https://github.com/SeleniumHQ/selenium/issues/14480-->
<!--<IsAotCompatible>true</IsAotCompatible>-->
</PropertyGroup>
-<PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard2.0'">
- <Nullable>annotations</Nullable>
-</PropertyGroup>
-Suggestion importance[1-10]: 2
__
Why: While the suggestion to unify nullable settings is technically valid, having different nullable settings for different target frameworks is intentional here, as netstandard2.0 may have compatibility constraints that make full nullable enforcement impractical. The current approach is more nuanced and appropriate.
[general] Standardize nullable settings across targets
✅ Standardize nullable settings across targets
Consider using consistent nullable settings across all library targets. Currently mixing "enable" and "annotations" which could lead to inconsistent null checking behavior.
dotnet/src/webdriver/BUILD.bazel [40-146]
-+ nullable="annotations"
++ nullable="enable"
...
+ nullable="enable"Suggestion importance[1-10]: 2
__
Why: The suggestion to standardize nullable settings to "enable" across all targets is incorrect. The PR intentionally uses different nullable settings ("annotations" for netstandard2.0 and "enable" for net8.0) to match the configuration in WebDriver.csproj, which shows this is a deliberate design choice.
| PR 15348 (2025-02-28) |
[general] Enhance logging with session ID
Enhance logging with session ID
Add missing session ID to the drain event message to improve traceability and debugging.
java/src/org/openqa/selenium/grid/node/local/LocalNode.java [1070-1071]
span.addEvent(
- String.format("%s session(s) pending before draining Node", currentSessionCount));
+ String.format("%s session(s) pending before draining Node %s", currentSessionCount, getId()));Suggestion importance[1-10]: 5
__
Why: Adding the node ID to the drain event message improves observability and debugging capabilities by making it easier to track which node is being drained. This is a useful enhancement for system monitoring.
| PR 15341 (2025-02-25) |
[learned best practice] Use explicit None checks instead of implicit truthiness checks when validating nullable parameters
✅ Use explicit None checks instead of implicit truthiness checks when validating nullable parameters
Add a null validation check for the source parameter at the start of the init method to make the code more defensive and prevent potential NullReferenceExceptions. The current code implicitly handles None but an explicit check would be clearer.
py/selenium/webdriver/common/actions/wheel_actions.py [25-28]
def __init__(self, source: Optional[WheelInput] = None):
- if not source:
+ if source is None:
source = WheelInput("wheel")
super().__init__(source)[Suggestion has been applied]
Suggestion importance[1-10]: 6
| PR 15283 (2025-02-13) |
[possible issue] Add null check for handler
✅ Add null check for handler
Add null check for the returned HttpClientHandler from CreateHttpClientHandler() before using it to avoid potential NullReferenceException
dotnet/src/webdriver/Remote/HttpCommandExecutor.cs [248-252]
protected virtual HttpClient CreateHttpClient()
{
var httpClientHandler = CreateHttpClientHandler();
+ if (httpClientHandler == null)
+ {
+ throw new InvalidOperationException("CreateHttpClientHandler() returned null");
+ }
HttpMessageHandler handler = httpClientHandler;Suggestion importance[1-10]: 8
__
Why: The suggestion addresses a potential null reference exception that could occur if CreateHttpClientHandler() returns null. This is a critical defensive programming practice for virtual methods that can be overridden by derived classes.
[learned best practice] Add null validation check for required class field to prevent potential NullReferenceException
✅ Add null validation check for required class field to prevent potential NullReferenceException
The CreateHttpClientHandler() method uses this.remoteServerUri without validating that it's not null. Since this is a required field for the class functionality, add a null check at the start of the method to fail fast with a clear error message.
dotnet/src/webdriver/Remote/HttpCommandExecutor.cs [229-233]
protected virtual HttpClientHandler CreateHttpClientHandler()
{
+ ArgumentNullException.ThrowIfNull(this.remoteServerUri, nameof(remoteServerUri));
HttpClientHandler httpClientHandler = new HttpClientHandler();
string userInfo = this.remoteServerUri.UserInfo;
if (!string.IsNullOrEmpty(userInfo) && userInfo.Contains(":"))Suggestion importance[1-10]: 6
| PR 15258 (2025-02-09) |
[possible issue] Initialize collection to prevent nulls
✅ Initialize collection to prevent nulls
Initialize the Headers dictionary in the parameterless constructor to prevent NullReferenceException when adding headers.
dotnet/src/webdriver/HttpRequestData.cs [34-39]
public HttpRequestData()
{
this.Method = null!;
this.Url = null!;
- this.Headers = null!;
+ this.Headers = new Dictionary<string, string>();
}Suggestion importance[1-10]: 8
__
Why: Initializing Headers with null! could lead to NullReferenceException at runtime. Using a new Dictionary instance is a safer approach that prevents potential crashes.
[general] Use meaningful defaults over nulls
✅ Use meaningful defaults over nulls
Avoid using null-forgiving operator (!) for required properties. Instead, initialize with meaningful default values.
dotnet/src/webdriver/HttpRequestData.cs [34-39]
public HttpRequestData()
{
- this.Method = null!;
- this.Url = null!;
- this.Headers = null!;
+ this.Method = "GET";
+ this.Url = string.Empty;
+ this.Headers = new Dictionary<string, string>();
}Suggestion importance[1-10]: 7
__
Why: Using meaningful default values instead of null-forgiving operators improves code safety and clarity. The suggestion provides sensible defaults that better represent the initial state of an HTTP request.
| PR 15257 (2025-02-09) |
[possible issue] Add null checks for nullable delegates
✅ Add null checks for nullable delegates
The FindElementMethod and FindElementsMethod properties are marked as nullable but used without null checks in FindElement and FindElements methods. Add null checks to prevent potential NullReferenceException.
dotnet/src/webdriver/By.cs [332-333]
public virtual IWebElement FindElement(ISearchContext context)
{
+ if (this.FindElementMethod == null)
+ {
+ throw new InvalidOperationException("FindElementMethod not set");
+ }
return this.FindElementMethod(context);
}Suggestion importance[1-10]: 9
__
Why: The suggestion addresses a critical potential NullReferenceException by adding necessary null checks for nullable delegate properties that are used directly. This is especially important since the code has #nullable enable.
[possible issue] Avoid null reference runtime exceptions
✅ Avoid null reference runtime exceptions
Initialize RequestMatcher in the constructor instead of using null! to avoid potential null reference exceptions at runtime.
dotnet/src/webdriver/NetworkRequestHandler.cs [35]
-public Func<HttpRequestData, bool> RequestMatcher { get; set; } = null!;
+public Func<HttpRequestData, bool> RequestMatcher { get; set; } = _ => false;Suggestion importance[1-10]: 8
__
Why: The suggestion provides a safer default implementation that prevents null reference exceptions at runtime, which is a critical improvement over using null! that could lead to runtime crashes.
[possible issue] Provide safe default function implementations
✅ Provide safe default function implementations
Initialize ResponseMatcher and ResponseTransformer in the constructor with safe default implementations instead of using null! to avoid potential null reference exceptions.
dotnet/src/webdriver/NetworkResponseHandler.cs [35-42]
-public Func<HttpResponseData, bool> ResponseMatcher { get; set; } = null!;
-public Func<HttpResponseData, HttpResponseData> ResponseTransformer { get; set; } = null!;
+public Func<HttpResponseData, bool> ResponseMatcher { get; set; } = _ => false;
+public Func<HttpResponseData, HttpResponseData> ResponseTransformer { get; set; } = response => response;Suggestion importance[1-10]: 8
__
Why: The suggestion replaces potentially dangerous null! assignments with safe default implementations for both ResponseMatcher and ResponseTransformer, preventing runtime exceptions and providing sensible default behavior.
[possible issue] Add safe default function implementation
✅ Add safe default function implementation
Initialize UriMatcher with a safe default implementation instead of using null! to avoid potential null reference exceptions.
dotnet/src/webdriver/NetworkAuthenticationHandler.cs [35]
-public Func<Uri, bool> UriMatcher { get; set; } = null!;
+public Func<Uri, bool> UriMatcher { get; set; } = _ => false;Suggestion importance[1-10]: 8
__
Why: The suggestion replaces the null! assignment with a safe default implementation for UriMatcher, preventing potential null reference exceptions and providing a reasonable default behavior.
[learned best practice] Add null validation checks for nullable delegate properties before invoking them to prevent NullReferenceExceptions
✅ Add null validation checks for nullable delegate properties before invoking them to prevent NullReferenceExceptions
The FindElement and FindElements methods should validate that their FindElementMethod and FindElementsMethod properties are not null before using them, since they are marked as nullable. Add ArgumentNullException checks at the start of these methods.
dotnet/src/webdriver/By.cs [330-344]
public virtual IWebElement FindElement(ISearchContext context)
{
+ ArgumentNullException.ThrowIfNull(this.FindElementMethod, nameof(FindElementMethod));
return this.FindElementMethod(context);
}
-public virtual ReadOnlyCollection<IWebElement> FindElements(ISearchContext context)
+public virtual ReadOnlyCollection<IWebElement> FindElements(ISearchContext context)
{
+ ArgumentNullException.ThrowIfNull(this.FindElementsMethod, nameof(FindElementsMethod));
return this.FindElementsMethod(context);
}| PR 15251 (2025-02-07) |
[possible issue] Add parameter validation
✅ Add parameter validation
Add null checks for the subscription ID and event handler parameters to prevent potential NullReferenceException when unsubscribing.
dotnet/src/webdriver/BiDi/Communication/Broker.cs [274-281]
public async Task UnsubscribeAsync(Modules.Session.Subscription subscription, EventHandler eventHandler)
{
+ ArgumentNullException.ThrowIfNull(subscription);
+ ArgumentNullException.ThrowIfNull(eventHandler);
+
var eventHandlers = _eventHandlers[eventHandler.EventName];
eventHandlers.Remove(eventHandler);
await _bidi.SessionModule.UnsubscribeAsync([subscription]).ConfigureAwait(false);
}Suggestion importance[1-10]: 8
__
Why: Adding null checks for parameters is crucial for preventing runtime NullReferenceExceptions, especially in an async method that handles critical subscription management.
| PR 15243 (2025-02-05) |
[general] Improve error message clarity
✅ Improve error message clarity
Add a more descriptive error message that includes the context of why the value was expected to be non-null, to help with debugging.
dotnet/src/webdriver/Response.cs [225]
-return Value ?? throw new WebDriverException("Expected not-null response");
+return Value ?? throw new WebDriverException("Response.Value was null when a non-null value was expected");Suggestion importance[1-10]: 6
__
Why: The improved error message provides more context about which property was null, making it easier to diagnose issues. While helpful, this is a minor improvement to error handling.
| PR 15241 (2025-02-05) |
[possible issue] Validate JSON property existence
✅ Validate JSON property existence
Add null check for the 'clientWindows' property existence in JSON to prevent potential JsonException
-var clientWindows = doc.RootElement.GetProperty("clientWindows").Deserialize<IReadOnlyList<ClientWindowInfo>>(options);
+if (!doc.RootElement.TryGetProperty("clientWindows", out JsonElement clientWindowsElement))
+ throw new JsonException("Missing required 'clientWindows' property");
+var clientWindows = clientWindowsElement.Deserialize<IReadOnlyList<ClientWindowInfo>>(options);Suggestion importance[1-10]: 8
__
Why: The suggestion adds crucial error handling to validate JSON structure before deserialization, preventing potential runtime exceptions and providing clearer error messages.
This wiki is not where you want to be! Visit the Wiki Home for more useful links
Getting Involved
Triaging Issues
Releasing Selenium
Ruby Development
Python Bindings
Ruby Bindings
WebDriverJs
This content is being evaluated for where it belongs
Architectural Overview
Automation Atoms
HtmlUnitDriver
Lift Style API
LoadableComponent
Logging
PageFactory
RemoteWebDriver
Xpath In WebDriver
Moved to Official Documentation
Bot Style Tests
Buck
Continuous Integration
Crazy Fun Build
Design Patterns
Desired Capabilities
Developer Tips
Domain Driven Design
Firefox Driver
Firefox Driver Internals
Focus Stealing On Linux
Frequently Asked Questions
Google Summer Of Code
Grid Platforms
History
Internet Explorer Driver
InternetExplorerDriver Internals
Next Steps
PageObjects
RemoteWebDriverServer
Roadmap
Scaling WebDriver
SeIDE Release Notes
Selenium Emulation
Selenium Grid 4
Selenium Help
Shipping Selenium 3
The Team
TLC Meetings
Untrusted SSL Certificates
WebDriver For Mobile Browsers
Writing New Drivers