-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
.pr_agent_accepted_suggestions
| PR 16631 (2025-11-24) |
[learned best practice] Cleanup created user contexts
✅ Cleanup created user contexts
Ensure created user contexts are cleaned up after the test by deleting them in a finally block to prevent resource leaks.
java/test/org/openqa/selenium/bidi/emulation/SetScriptingEnabledTest.java [82-113]
String userContext = browser.createUserContext();
-BrowsingContext context =
- new BrowsingContext(
- driver, new CreateContextParameters(WindowType.TAB).userContext(userContext));
-String contextId = context.getId();
-...
-// Clear the scripting override
-emulation.setScriptingEnabled(
- new SetScriptingEnabledParameters(null).userContexts(List.of(userContext)));
+try {
+ BrowsingContext context =
+ new BrowsingContext(
+ driver, new CreateContextParameters(WindowType.TAB).userContext(userContext));
+ String contextId = context.getId();
+ ...
+ emulation.setScriptingEnabled(
+ new SetScriptingEnabledParameters(null).userContexts(List.of(userContext)));
+} finally {
+ browser.deleteUserContext(userContext);
+}Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Ensure test setup/teardown and resource cleanup to avoid leaking browser contexts or user contexts.
[general] Extract duplicated code into a helper
✅ Extract duplicated code into a helper
Extract the duplicated script evaluation logic for checking if 'foo' in window into a private helper method to reduce code repetition and improve test readability.
java/test/org/openqa/selenium/bidi/emulation/SetScriptingEnabledTest.java [57-74]
-EvaluateResult resultDisabled =
- script.evaluateFunctionInBrowsingContext(
- contextId, "'foo' in window", false, Optional.empty());
-Boolean valueDisabled =
- (Boolean) ((EvaluateResultSuccess) resultDisabled).getResult().getValue().get();
-assertThat(valueDisabled).isFalse();
+assertThat(isFooInWindow(contextId, script)).isFalse();
emulation.setScriptingEnabled(
new SetScriptingEnabledParameters(null).contexts(List.of(contextId)));
context.navigate(appServer.whereIs("script_page.html"), ReadinessState.COMPLETE);
-EvaluateResult resultEnabled =
- script.evaluateFunctionInBrowsingContext(
- contextId, "'foo' in window", false, Optional.empty());
-Boolean valueEnabled =
- (Boolean) ((EvaluateResultSuccess) resultEnabled).getResult().getValue().get();
-assertThat(valueEnabled).isTrue();
+assertThat(isFooInWindow(contextId, script)).isTrue();Suggestion importance[1-10]: 5
__
Why: The suggestion correctly identifies duplicated code in the test and proposes extracting it into a helper method, which improves code readability and maintainability.
[general] Simplify constructor logic for clarity
✅ Simplify constructor logic for clarity
Simplify the constructor logic by first checking for the invalid true case for the enabled parameter, then using a single map.put call for both null and false values.
java/src/org/openqa/selenium/bidi/emulation/SetScriptingEnabledParameters.java [22-30]
-// allow null
-if (enabled == null) {
- map.put("enabled", null);
-} else if (!enabled) {
- map.put("enabled", enabled);
-} else {
+if (enabled != null && enabled) {
throw new IllegalArgumentException(
"Only emulation of disabled JavaScript is supported (enabled must be false or null)");
}
+map.put("enabled", enabled);Suggestion importance[1-10]: 4
__
Why: The suggestion correctly simplifies the constructor's conditional logic, making the code more concise and readable without changing its behavior.
| PR 16624 (2025-11-21) |
[possible issue] Prevent unintended workflow cancellations
✅ Prevent unintended workflow cancellations
To prevent unintended cancellations between scheduled and push-triggered workflows, update the concurrency group to include the event type by adding ${{ github.event_name }}.
.github/workflows/ci.yml [13-15]
concurrency:
- group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+ group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: trueSuggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a subtle but important issue where scheduled and push-triggered workflows would cancel each other, and the proposed fix using ${{ github.event_name }} is the correct solution.
| PR 16623 (2025-11-21) |
[general] Align type hints with behavior
✅ Align type hints with behavior
Update the type hint for the device_pixel_ratio parameter in set_viewport to float | None | UNDEFINED to match the implementation that accepts None for resetting the value.
py/selenium/webdriver/common/bidi/browsing_context.py [984-990]
def set_viewport(
self,
context: str | None = None,
viewport: dict | None | UNDEFINED = UNDEFINED,
- device_pixel_ratio: float | UNDEFINED = UNDEFINED,
+ device_pixel_ratio: float | None | UNDEFINED = UNDEFINED,
user_contexts: list[str] | None = None,
) -> None:Suggestion importance[1-10]: 5
__
Why: The suggestion correctly identifies that the type hint for device_pixel_ratio is inconsistent with the implementation, which explicitly handles None as a valid input to reset the value.
[possible issue] Fix incorrect variable assignment bug
✅ Fix incorrect variable assignment bug
In set_viewport, fix the incorrect assignment to params["devicePixelRatio"] by using the device_pixel_ratio variable instead of viewport.
py/selenium/webdriver/common/bidi/browsing_context.py [1011-1016]
if device_pixel_ratio is UNDEFINED:
pass
elif device_pixel_ratio is None:
params["devicePixelRatio"] = None
else:
- params["devicePixelRatio"] = viewport
+ params["devicePixelRatio"] = device_pixel_ratioSuggestion importance[1-10]: 10
__
Why: The suggestion correctly identifies a critical copy-paste bug that assigns the wrong variable, breaking the set_viewport functionality for the device_pixel_ratio parameter.
[possible issue] Correct a test assertion typo
✅ Correct a test assertion typo
In test_set_viewport_back_to_default, correct the assertion for viewport height to compare against the default height (default_viewport_size[1]) instead of the default width.
py/test/selenium/webdriver/common/bidi_browsing_context_tests.py [402-404]
assert viewport_size[0] == default_viewport_size[0]
-assert viewport_size[1] == default_viewport_size[0]
+assert viewport_size[1] == default_viewport_size[1]
assert device_pixel_ratio == default_device_pixel_ratioSuggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a copy-paste error in a test assertion, which would cause the test to validate the wrong behavior and potentially pass incorrectly.
| PR 16620 (2025-11-20) |
[general] Improve filtering logic for performance
✅ Improve filtering logic for performance
Refactor the label filtering logic to use a Set for grouping keys instead of a List and multiple if conditions, improving lookup performance and code clarity.
java/src/org/openqa/selenium/grid/node/docker/DockerOptions.java [269-289]
// Get custom grouping labels from configuration
List<String> customLabelKeys =
config.getAll(DOCKER_SECTION, "grouping-labels").orElseGet(Collections::emptyList);
+
+Set<String> groupingKeys = new HashSet<>(customLabelKeys);
+groupingKeys.add("com.docker.compose.project");
+groupingKeys.add("io.podman.compose.project");
Map<String, String> allLabels = info.get().getLabels();
// Filter for project/grouping labels that work across orchestration systems
// Keep only project identifiers, exclude service-specific labels to prevent
// exit monitoring in Docker Compose, Podman Compose, etc.
return allLabels.entrySet().stream()
- .filter(
- entry -> {
- String key = entry.getKey();
- // Docker Compose project label
- if (key.equals("com.docker.compose.project")) return true;
- // Podman Compose project label
- if (key.equals("io.podman.compose.project")) return true;
- // Custom user-defined grouping labels
- if (customLabelKeys.contains(key)) return true;
- return false;
- })
+ .filter(entry -> groupingKeys.contains(entry.getKey()))
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));Suggestion importance[1-10]: 6
__
Why: The suggestion correctly proposes using a Set for more efficient lookups, which improves performance and code readability, aligning with best practices.
| PR 16616 (2025-11-20) |
[general] Avoid code duplication by linking files
✅ Avoid code duplication by linking files
Remove the duplicated StringSyntaxAttribute.cs file and instead link to the single source file from the project file to avoid code duplication.
dotnet/src/support/Internal/StringSyntaxAttribute.cs [1-88]
-// <copyright file="StringSyntaxAttribute.cs" company="Selenium Committers">
-// Licensed to the Software Freedom Conservancy (SFC) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The SFC licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-// </copyright>
+// This file should be deleted.
-#if !NET8_0_OR_GREATER
-
-namespace System.Diagnostics.CodeAnalysis;
-
-/// <summary>Specifies the syntax used in a string.</summary>
-[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
-internal sealed class StringSyntaxAttribute : Attribute
-{
- /// <summary>Initializes the <see cref="StringSyntaxAttribute"/> with the identifier of the syntax used.</summary>
- /// <param name="syntax">The syntax identifier.</param>
- public StringSyntaxAttribute(string syntax)
- {
- Syntax = syntax;
- Arguments = [];
- }
-
- /// <summary>Initializes the <see cref="StringSyntaxAttribute"/> with the identifier of the syntax used.</summary>
- /// <param name="syntax">The syntax identifier.</param>
- /// <param name="arguments">Optional arguments associated with the specific syntax employed.</param>
- public StringSyntaxAttribute(string syntax, params object?[] arguments)
- {
- Syntax = syntax;
- Arguments = arguments;
- }
-
- /// <summary>Gets the identifier of the syntax used.</summary>
- public string Syntax { get; }
-
- /// <summary>Optional arguments associated with the specific syntax employed.</summary>
- public object?[] Arguments { get; }
-
- /// <summary>The syntax identifier for strings containing composite formats for string formatting.</summary>
- public const string CompositeFormat = nameof(CompositeFormat);
-
- /// <summary>The syntax identifier for strings containing date format specifiers.</summary>
- public const string DateOnlyFormat = nameof(DateOnlyFormat);
-
- /// <summary>The syntax identifier for strings containing date and time format specifiers.</summary>
- public const string DateTimeFormat = nameof(DateTimeFormat);
-
- /// <summary>The syntax identifier for strings containing <see cref="Enum"/> format specifiers.</summary>
- public const string EnumFormat = nameof(EnumFormat);
-
- /// <summary>The syntax identifier for strings containing <see cref="Guid"/> format specifiers.</summary>
- public const string GuidFormat = nameof(GuidFormat);
-
- /// <summary>The syntax identifier for strings containing JavaScript Object Notation (JSON).</summary>
- public const string Json = nameof(Json);
-
- /// <summary>The syntax identifier for strings containing numeric format specifiers.</summary>
- public const string NumericFormat = nameof(NumericFormat);
-
- /// <summary>The syntax identifier for strings containing regular expressions.</summary>
- public const string Regex = nameof(Regex);
-
- /// <summary>The syntax identifier for strings containing time format specifiers.</summary>
- public const string TimeOnlyFormat = nameof(TimeOnlyFormat);
-
- /// <summary>The syntax identifier for strings containing <see cref="TimeSpan"/> format specifiers.</summary>
- public const string TimeSpanFormat = nameof(TimeSpanFormat);
-
- /// <summary>The syntax identifier for strings containing URIs.</summary>
- public const string Uri = nameof(Uri);
-
- /// <summary>The syntax identifier for strings containing XML.</summary>
- public const string Xml = nameof(Xml);
-}
-
-#endif
-Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies that the PR introduces a duplicated file and proposes a standard .NET practice to resolve it, which improves code maintainability.
| PR 16613 (2025-11-19) |
[possible issue] Avoid mutating a constructor parameter
✅ Avoid mutating a constructor parameter
To avoid mutating a constructor parameter and prevent potential runtime exceptions, create a new mutable copy of the composeLabels map before adding the new label.
java/src/org/openqa/selenium/grid/node/docker/DockerSessionFactory.java [144-146]
-this.composeLabels = Require.nonNull("Docker Compose labels", composeLabels);
// Merge compose labels with oneoff=False to prevent triggering --exit-code-from dynamic grid
-this.composeLabels.put("com.docker.compose.oneoff", "False");
+Map<String, String> allLabels = new HashMap<>(Require.nonNull("Docker Compose labels", composeLabels));
+allLabels.put("com.docker.compose.oneoff", "False");
+this.composeLabels = Collections.unmodifiableMap(allLabels);Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a potential UnsupportedOperationException if an immutable map is passed to the constructor and avoids a side effect by not mutating the input parameter, which significantly improves the code's robustness.
| PR 16610 (2025-11-18) |
[possible issue] Revert breaking lockfile version change
✅ Revert breaking lockfile version change
Revert the lockfileVersion update from '6.0' to '9.0'. This change requires a pnpm major version upgrade (to v9+) across all environments, which could break dependency installation if not coordinated.
-lockfileVersion: '9.0'
+lockfileVersion: '6.0'Suggestion importance[1-10]: 10
__
Why: This suggestion correctly points out a critical, project-wide breaking change in the pnpm lockfileVersion, which could halt all development and CI/CD pipelines if not managed correctly.
| PR 16607 (2025-11-17) |
[general] Ensure consistent docstring quote style
✅ Ensure consistent docstring quote style
Update the docstring function to generate docstrings with double quotes (""") instead of single quotes (''') for consistency.
def docstring(description):
""" Generate a docstring from a description. """
if not description:
return ''
description = escape_backticks(description)
- return dedent("'''\n{}\n'''").format(description)
+ return dedent('"""\n{}\n"""').format(description)Suggestion importance[1-10]: 7
__
Why: The suggestion correctly points out that while the PR changes existing docstrings to use double quotes, the docstring generator function itself still produces single-quoted docstrings, which is inconsistent with the PR's intent.
| PR 16603 (2025-11-16) |
[general] Remove redundant client-side context filtering
✅ Remove redundant client-side context filtering
Remove the redundant client-side context check in OnEntryAddedAsync methods. The event subscription is already filtered by context at the protocol level, making the if statement unnecessary.
dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextLogModule.cs [28-48]
public Task<Subscription> OnEntryAddedAsync(Func<Log.LogEntry, Task> handler, ContextSubscriptionOptions? options = null)
{
- return logModule.OnEntryAddedAsync(async args =>
- {
- if (args.Source.Context?.Equals(context) is true)
- {
- await handler(args).ConfigureAwait(false);
- }
- }, options.WithContext(context));
+ return logModule.OnEntryAddedAsync(handler, options.WithContext(context));
}
public Task<Subscription> OnEntryAddedAsync(Action<Log.LogEntry> handler, ContextSubscriptionOptions? options = null)
{
- return logModule.OnEntryAddedAsync(args =>
- {
- if (args.Source.Context?.Equals(context) is true)
- {
- handler(args);
- }
- }, options.WithContext(context));
+ return logModule.OnEntryAddedAsync(handler, options.WithContext(context));
}Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies redundant client-side filtering logic that is now handled by the protocol-level subscription, simplifying the code and improving maintainability.
| PR 16601 (2025-11-15) |
[possible issue] Correct JSON serialization for optional parameters
✅ Correct JSON serialization for optional parameters
To align with the WebDriver BiDi specification, correct the JSON serialization by removing the JsonIgnore attribute from the Viewport property and adding it to the DevicePixelRatio property.
dotnet/src/webdriver/BiDi/BrowsingContext/SetViewportCommand.cs [28]
-internal sealed record SetViewportParameters(BrowsingContext Context, [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] Viewport? Viewport, double? DevicePixelRatio) : Parameters;
+internal sealed record SetViewportParameters(BrowsingContext Context, Viewport? Viewport, [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] double? DevicePixelRatio) : Parameters;Suggestion importance[1-10]: 5
__
Why: The suggestion correctly identifies that the PR's change to Viewport is incorrect, as it prevents resetting the viewport by sending a null value. However, the proposed fix of moving the attribute to DevicePixelRatio is also incorrect, as the BiDi spec requires sending null to reset that value as well.
| PR 16599 (2025-11-15) |
[possible issue] Sanitize browser name for container
✅ Sanitize browser name for container
Sanitize the browser name by replacing characters invalid for Docker container names to prevent potential creation failures.
java/src/org/openqa/selenium/grid/node/docker/DockerSessionFactory.java [314-316]
-// Generate container name: browser-<browserName>-<timestamp>-<uuid>
-String browserName = stereotype.getBrowserName().toLowerCase();
+// Generate container name: browser-<browserName>-<sessionIdentifier>
+String browserName = stereotype.getBrowserName().toLowerCase().replaceAll("[^a-z0-9_.-]", "-");
String containerName = String.format("browser-%s-%s", browserName, sessionIdentifier);Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies that the browser name is not sanitized before being used in a Docker container name, which could lead to container creation failures if the name contains invalid characters.
[learned best practice] Validate and encode URL parameter
✅ Validate and encode URL parameter
Validate and URL-encode the optional container name to avoid invalid requests and injection issues. Reject empty/whitespace-only names and percent-encode the value.
java/src/org/openqa/selenium/docker/client/CreateContainer.java [66-69]
String url = String.format("/v%s/containers/create", apiVersion);
-if (info.getName() != null && !info.getName().isEmpty()) {
- url += "?name=" + info.getName();
+String name = info.getName();
+if (name != null) {
+ name = name.trim();
+ if (!name.isEmpty()) {
+ String encoded = java.net.URLEncoder.encode(name, java.nio.charset.StandardCharsets.UTF_8);
+ url += "?name=" + encoded;
+ }
}Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Guard external API and I/O operations with targeted validation and proper encoding when building request URLs.
| PR 16596 (2025-11-14) |
[possible issue] Avoid modifying nested map directly
✅ Avoid modifying nested map directly
To avoid side effects, create a defensive copy of the networkSettings map in adaptContainerInspectResponse before modifying it, ensuring the original response data structure remains unchanged.
java/src/org/openqa/selenium/docker/client/V148Adapter.java [165-205]
@SuppressWarnings("unchecked")
-Map<String, Object> networkSettings = (Map<String, Object>) adapted.get("NetworkSettings");
+Map<String, Object> originalNetworkSettings =
+ (Map<String, Object>) adapted.get("NetworkSettings");
-if (networkSettings != null) {
+if (originalNetworkSettings != null) {
+ // Create a mutable copy to avoid modifying the original map
+ Map<String, Object> networkSettings = new HashMap<>(originalNetworkSettings);
+
@SuppressWarnings("unchecked")
Map<String, Object> networks = (Map<String, Object>) networkSettings.get("Networks");
if (networks != null) {
for (Map.Entry<String, Object> entry : networks.entrySet()) {
if (entry.getValue() instanceof Map) {
@SuppressWarnings("unchecked")
Map<String, Object> network = (Map<String, Object>) entry.getValue();
if (network.containsKey("GwPriority")) {
LOG.fine(
"Network '" + entry.getKey() + "' includes GwPriority (API v" + apiVersion + ")");
}
}
}
}
// Remove deprecated fields (should not be present in v1.48+)
String[] deprecatedFields = {
"HairpinMode",
"LinkLocalIPv6Address",
"LinkLocalIPv6PrefixLen",
"SecondaryIPAddresses",
"SecondaryIPv6Addresses",
"Bridge" // Deprecated in v1.51, removed in v1.52
};
for (String field : deprecatedFields) {
if (networkSettings.containsKey(field)) {
LOG.fine(
"Removing deprecated field '"
+ field
+ "' from NetworkSettings (deprecated in earlier API versions)");
networkSettings.remove(field);
}
}
+ adapted.put("NetworkSettings", networkSettings);
}Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies that a nested map is being modified, which could lead to side effects. Creating a defensive copy is good practice for immutability and prevents unintended modification of the original data structure.
| PR 16594 (2025-11-14) |
[learned best practice] Close context in finally
✅ Close context in finally
Wrap context creation/usage in try-finally and close the BrowsingContext in finally to avoid leaks if assertions throw.
java/test/org/openqa/selenium/bidi/emulation/SetGeolocationOverrideTest.java [201-235]
BrowsingContext context = new BrowsingContext(driver, driver.getWindowHandle());
-String contextId = context.getId();
-...
-// Error because there's no real geolocation available
-assertThat(r2.containsKey("error")).isTrue();
+try {
+ String contextId = context.getId();
+ String url = appServer.whereIsSecure("blank.html");
+ context.navigate(url, ReadinessState.COMPLETE);
+ driver.switchTo().window(context.getId());
+ String origin =
+ (String) ((JavascriptExecutor) driver).executeScript("return window.location.origin;");
+ Emulation emul = new Emulation(driver);
+ GeolocationCoordinates coords = new GeolocationCoordinates(37.7749, -122.4194);
+ emul.setGeolocationOverride(
+ new SetGeolocationOverrideParameters(coords).contexts(List.of(contextId)));
+ Object firstResult = getBrowserGeolocation(driver, null, origin);
+ Map<String, Object> r1 = ((Map<String, Object>) firstResult);
+ assertThat(r1.containsKey("error")).isFalse();
+ double latitude1 = ((Number) r1.get("latitude")).doubleValue();
+ double longitude1 = ((Number) r1.get("longitude")).doubleValue();
+ assertThat(abs(latitude1 - coords.getLatitude())).isLessThan(0.0001);
+ assertThat(abs(longitude1 - coords.getLongitude())).isLessThan(0.0001);
+ emul.setGeolocationOverride(
+ new SetGeolocationOverrideParameters((GeolocationCoordinates) null)
+ .contexts(List.of(contextId)));
+ Object secondResult = getBrowserGeolocation(driver, null, origin);
+ Map<String, Object> r2 = ((Map<String, Object>) secondResult);
+ assertThat(r2.containsKey("error")).isTrue();
+} finally {
+ context.close();
+}Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Ensure resources are cleaned up using try-finally or equivalent to close/tear down contexts and user contexts, even on exceptions.
| PR 16564 (2025-11-08) |
[possible issue] Fix incorrect target file paths
✅ Fix incorrect target file paths
Fix typos in the target attribute of file elements for the net462 framework in Selenium.WebDriver.StrongNamed.nuspec by removing the extra dot in the filenames.
dotnet/src/webdriver/Selenium.WebDriver.StrongNamed.nuspec [43-45]
-<file src="lib/net462/WebDriver.StrongNamed.dll" target="lib/net462/WebDriverStrongNamed..dll" />
-<file src="lib/net462/WebDriver.StrongNamed.pdb" target="lib/net462/WebDriverStrongNamed..pdb" />
-<file src="lib/net462/WebDriver.StrongNamed.xml" target="lib/net462/WebDriverStrongNamed..xml" />
+<file src="lib/net462/WebDriver.StrongNamed.dll" target="lib/net462/WebDriver.StrongNamed.dll" />
+<file src="lib/net462/WebDriver.StrongNamed.pdb" target="lib/net462/WebDriver.StrongNamed.pdb" />
+<file src="lib/net462/WebDriver.StrongNamed.xml" target="lib/net462/WebDriver.StrongNamed.xml" />Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a typo in the NuGet package specification that would lead to incorrectly named files, breaking the package for the net462 target.
| PR 16556 (2025-11-06) |
[general] Replace fixed sleep with explicit wait
✅ Replace fixed sleep with explicit wait
Replace time.sleep(1) with an explicit WebDriverWait to create a more reliable test for verifying that a file is not downloaded.
py/test/selenium/webdriver/common/bidi_browser_tests.py [300-305]
driver.find_element(By.ID, "file-1").click()
-time.sleep(1)
+try:
+ WebDriverWait(driver, 2, poll_frequency=0.2).until(lambda _: len(os.listdir(tmp_dir)) > 0)
+ # If we get here, a file was created, which is a failure
+ files = os.listdir(tmp_dir)
+ pytest.fail(f"A file was downloaded unexpectedly: {files}")
+except TimeoutException:
+ # This is the expected outcome, no file was downloaded within the timeout.
+ pass
-files = os.listdir(tmp_dir)
-assert len(files) == 0, f"No files should be downloaded when denied, but found: {files}"
-Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies that using time.sleep() can lead to flaky tests and proposes a more robust explicit wait, which improves test reliability.
| PR 16551 (2025-11-04) |
[general] Make required arguments explicit in signature
✅ Make required arguments explicit in signature
Update the ChromiumDriver.init method signature to make browser_name and vendor_prefix required arguments, removing the Optional type hint and default None value, and then remove the now-redundant runtime checks for None.
py/selenium/webdriver/chromium/webdriver.py [31-67]
def __init__(
self,
- browser_name: Optional[str] = None,
- vendor_prefix: Optional[str] = None,
+ browser_name: str,
+ vendor_prefix: str,
options: Optional[ChromiumOptions] = None,
service: Optional[ChromiumService] = None,
keep_alive: bool = True,
) -> None:
"""Create a new WebDriver instance, start the service, and create new ChromiumDriver instance.
Args:
browser_name: Browser name used when matching capabilities.
vendor_prefix: Company prefix to apply to vendor-specific WebDriver extension commands.
options: This takes an instance of ChromiumOptions.
service: Service object for handling the browser driver if you need to pass extra details.
keep_alive: Whether to configure ChromiumRemoteConnection to use HTTP keep-alive.
"""
self.service = service if service else ChromiumService()
options = options if options else ChromiumOptions()
finder = DriverFinder(self.service, options)
if finder.get_browser_path():
options.binary_location = finder.get_browser_path()
options.browser_version = None
self.service.path = self.service.env_path() or finder.get_driver_path()
self.service.start()
- if browser_name is None:
- raise ValueError("browser_name must be specified")
- if vendor_prefix is None:
- raise ValueError("vendor_prefix must be specified")
-
executor = ChromiumRemoteConnection(
remote_server_addr=self.service.service_url,
browser_name=browser_name,
vendor_prefix=vendor_prefix,Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies a contradiction between the method signature, which marks arguments as optional, and the implementation, which requires them. Aligning the signature makes the API contract clearer and enables static analysis tools to catch errors.
| PR 16530 (2025-10-29) |
[general] Return a defensive copy of map
✅ Return a defensive copy of map
Return a defensive copy of the internal map in the toMap() method to prevent external modification and maintain encapsulation.
java/src/org/openqa/selenium/bidi/emulation/AbstractOverrideParameters.java [57]
-return map;
+return new HashMap<>(map);Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a significant encapsulation issue in the new AbstractOverrideParameters class where returning a direct reference to the internal map allows bypassing validation logic. Providing a defensive copy is crucial for maintaining the object's integrity.
[possible issue] Create a defensive copy of parameters
✅ Create a defensive copy of parameters
To ensure the Command object is immutable, create a defensive, unmodifiable copy of the params map that allows null values.
java/src/org/openqa/selenium/bidi/Command.java [51]
-this.params = Require.nonNull("Command parameters", params);
+this.params = java.util.Collections.unmodifiableMap(new java.util.HashMap<>(Require.nonNull("Command parameters", params)));Suggestion importance[1-10]: 7
__
Why: The PR removed Map.copyOf() which made the params map immutable but disallowed nulls. This suggestion correctly identifies that the new implementation is mutable from the outside and proposes a solution that restores immutability while still allowing null values, improving the robustness of the Command object.
| PR 16511 (2025-10-25) |
[general] Correct docstring return type
✅ Correct docstring return type
Correct the return type in the web_socket_url docstring from bool to str to accurately reflect that it returns a URL.
py/selenium/webdriver/common/options.py [316-328]
web_socket_url = _BaseOptionsDescriptor("webSocketUrl")
"""Gets and Sets WebSocket URL.
Usage:
- Get: `self.web_socket_url`
- Set: `self.web_socket_url = value`
Args:
value: str
Returns:
- bool when getting, None when setting.
+ str when getting, None when setting.
"""Suggestion importance[1-10]: 3
__
Why: The suggestion correctly identifies and fixes a documentation error where the return type for web_socket_url is incorrectly stated as bool instead of str, improving the accuracy of the docstring.
| PR 16504 (2025-10-24) |
[learned best practice] Add robust test cleanup
✅ Add robust test cleanup
Ensure the tab and user context are cleaned up even if assertions fail by wrapping them in try/finally blocks.
py/test/selenium/webdriver/common/bidi_emulation_tests.py [347-363]
def test_set_locale_override_with_user_contexts(driver, pages, value):
"""Test setting locale override with user contexts."""
user_context = driver.browser.create_user_context()
+ try:
+ context_id = driver.browsing_context.create(type=WindowTypes.TAB, user_context=user_context)
+ try:
+ driver.switch_to.window(context_id)
+ driver.emulation.set_locale_override(locale=value, user_contexts=[user_context])
+ driver.browsing_context.navigate(context_id, pages.url("formPage.html"), wait="complete")
+ current_locale = get_browser_locale(driver)
+ assert current_locale == value, f"Expected locale {value}, got {current_locale}"
+ finally:
+ driver.browsing_context.close(context_id)
+ finally:
+ driver.browser.remove_user_context(user_context)
- context_id = driver.browsing_context.create(type=WindowTypes.TAB, user_context=user_context)
-
- driver.switch_to.window(context_id)
-
- driver.emulation.set_locale_override(locale=value, user_contexts=[user_context])
-
- driver.browsing_context.navigate(context_id, pages.url("formPage.html"), wait="complete")
-
- current_locale = get_browser_locale(driver)
- assert current_locale == value, f"Expected locale {value}, got {current_locale}"
-
- driver.browsing_context.close(context_id)
- driver.browser.remove_user_context(user_context)
-Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Enforce deterministic cleanup of created resources in tests to avoid leaks and cross-test interference.
| PR 16477 (2025-10-21) |
[possible issue] Fix off-by-one error in slicing
✅ Fix off-by-one error in slicing
Correct the string slicing from f[:-7] to f[:-8] to properly remove the _spec.rb suffix from test file names.
rb/spec/integration/selenium/webdriver/BUILD.bazel [56-63]
[
rb_integration_test(
- name = f[:-7],
+ name = f[:-8],
srcs = [f],
tags = ["bidi"],
)
for f in _BIDI_FILES
]Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a functional bug in the build script. The incorrect string slicing f[:-7] would generate malformed test target names, likely causing build failures or tests not being correctly identified.
[learned best practice] Remove early macro return
✅ Remove early macro return
Avoid returning early from the macro; guard only the BiDi target creation with a conditional so other targets remain unaffected and macro flow stays predictable.
-if "bidi" not in tags:
- return # don't create -bidi targets for non-BiDi tests
+if "bidi" in tags:
+ rb_test(
+ name = "{}-{}-bidi".format(name, browser),
+ size = "large",
+ srcs = srcs,
+ # ...
+ )Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Keep build macros pure and predictable by avoiding early returns that skip subsequent target generation unexpectedly; prefer structured conditionals so all intended targets are considered.
| PR 16473 (2025-10-20) |
[possible issue] Fix conditional logic for GitHub Actions
✅ Fix conditional logic for GitHub Actions
Fix the conditional logic for ignoring tests on GitHub Actions. The current implementation incorrectly ignores tests when the gitHubActions attribute is not specified.
java/test/org/openqa/selenium/testing/IgnoreComparator.java [52-56]
return ignoreList.anyMatch(
driver ->
(ignored.contains(driver.value()) || driver.value() == Browser.ALL)
- && ((!driver.gitHubActions() || TestUtilities.isOnGitHubActions()))
+ && (!driver.gitHubActions() || TestUtilities.isOnGitHubActions())
&& isOpen(driver.issue()));Suggestion importance[1-10]: 10
__
Why: The suggestion correctly identifies a critical logic bug in the shouldIgnore method. The current logic causes tests to be ignored incorrectly when @Ignore is used without gitHubActions=true, which is a significant flaw introduced by the PR.
| PR 16449 (2025-10-16) |
[possible issue] Simplify file serving by reading all files in binary mode
✅ Simplify file serving by reading all files in binary mode
Simplify the _serve_file method by opening all files in binary mode ("rb") to avoid unnecessary and potentially corrupting text re-encoding.
py/test/selenium/webdriver/common/webserver.py [72-87]
def _serve_file(self, file_path):
"""Serve a file from the HTML root directory."""
- content_type, _ = mimetypes.guess_type(file_path)
+ with open(file_path, "rb") as f:
+ return f.read()
- if content_type and (
- content_type.startswith("image/")
- or content_type.startswith("application/")
- or content_type.startswith("video/")
- or content_type.startswith("audio/")
- ):
- with open(file_path, "rb") as f:
- return f.read()
- else:
- # text files
- with open(file_path, encoding="latin-1") as f:
- return f.read().encode("utf-8")
-Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that re-encoding text files from latin-1 to utf-8 is problematic and can cause corruption. The proposed change to read all files in binary mode is simpler, more robust, and the correct approach for a web server.
[learned best practice] Default Content-Type when unknown
✅ Default Content-Type when unknown
Ensure a valid Content-Type is always sent by defaulting to a sensible MIME type when guessing fails. This avoids sending a None header value.
py/test/selenium/webdriver/common/webserver.py [104-108]
elif os.path.isfile(file_path):
content_type, _ = mimetypes.guess_type(file_path)
+ if not content_type:
+ content_type = "application/octet-stream"
content = self._serve_file(file_path)
self._send_response(content_type)
self.wfile.write(content)Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Validate inputs and states early, providing safe defaults to prevent logic errors and None-related issues.
| PR 16444 (2025-10-15) |
[incremental [*]] Prevent heartbeat interval overflow
✅ Prevent heartbeat interval overflow
** * Configures ZeroMQ heartbeat settings on a socket to prevent stale connections.
-
-
-
The heartbeat interval is clamped between 1 second and ~24 days to prevent integer overflow
-
-
- and ensure reasonable values. If the provided duration is outside this range, it will be
-
- adjusted and a warning will be logged.
- @param socket The ZMQ socket to configure
- @param heartbeatPeriod The heartbeat interval duration @@ -39,14 +46,58 @@ */ static void configureHeartbeat(ZMQ.Socket socket, Duration heartbeatPeriod, String socketType) { if (heartbeatPeriod != null && !heartbeatPeriod.isZero() && !heartbeatPeriod.isNegative()) {
-
int heartbeatIvl = (int) heartbeatPeriod.toMillis();
-
long heartbeatMs = heartbeatPeriod.toMillis(); -
long clampedHeartbeatMs = clampHeartbeatInterval(heartbeatMs, socketType); -
// Safe to cast to int now -
int heartbeatIvl = (int) clampedHeartbeatMs; -
int heartbeatTimeout = heartbeatIvl * 3; -
int heartbeatTtl = heartbeatIvl * 6; -
socket.setHeartbeatIvl(heartbeatIvl);
-
socket.setHeartbeatTimeout(heartbeatIvl * 3); -
socket.setHeartbeatTtl(heartbeatIvl * 6);
-
socket.setHeartbeatTimeout(heartbeatTimeout); -
socket.setHeartbeatTtl(heartbeatTtl); -
LOG.info( String.format(
-
"ZMQ %s socket heartbeat configured: interval=%dms, timeout=%dms, ttl=%dms", -
socketType, heartbeatIvl, heartbeatIvl * 3, heartbeatIvl * 6));
-
"ZMQ %s socket heartbeat configured: interval=%ds, timeout=%ds, ttl=%ds", -
} }
socketType, heartbeatIvl / 1000, heartbeatTimeout / 1000, heartbeatTtl / 1000)); - /**
-
- Clamps the heartbeat interval to safe bounds and logs warnings if adjustments are made.
-
-
- @param heartbeatMs The heartbeat interval in milliseconds
-
- @param socketType The socket type for logging
-
- @return The clamped heartbeat interval
- */
- private static long clampHeartbeatInterval(long heartbeatMs, String socketType) {
- if (heartbeatMs < MIN_HEARTBEAT_MS) {
-
logHeartbeatClampWarning(socketType, heartbeatMs, MIN_HEARTBEAT_MS, "below minimum"); -
return MIN_HEARTBEAT_MS; - }
- if (heartbeatMs > MAX_HEARTBEAT_MS) {
-
logHeartbeatClampWarning(socketType, heartbeatMs, MAX_HEARTBEAT_MS, "exceeds maximum"); -
return MAX_HEARTBEAT_MS; - }
- return heartbeatMs;
- }
- /**
-
- Logs a warning when the heartbeat interval is clamped.
-
-
- @param socketType The socket type
-
- @param originalMs The original interval value in milliseconds
-
- @param clampedMs The clamped interval value in milliseconds
-
- @param reason The reason for clamping
- */
- private static void logHeartbeatClampWarning(
-
String socketType, long originalMs, long clampedMs, String reason) { - LOG.log(
-
Level.WARNING, -
String.format( -
"ZMQ %s socket heartbeat interval %ds %s %ds, clamping to %ds", -
socketType, originalMs / 1000, reason, clampedMs / 1000, clampedMs / 1000)); - }
**In configureHeartbeat, guard against integer overflow by clamping the heartbeat interval in milliseconds to a safe maximum before casting to int and setting socket options. Also, enforce a sensible minimum value.**
[java/src/org/openqa/selenium/events/zeromq/ZmqUtils.java [40-52]](https://github.com/SeleniumHQ/selenium/pull/16444/files#diff-f9f1bd9c11ff8d0995d73085dc4b3e906a8aa15c1a5ba90fc6b9059a3a8080a1R40-R52)
```diff
static void configureHeartbeat(ZMQ.Socket socket, Duration heartbeatPeriod, String socketType) {
- if (heartbeatPeriod != null && !heartbeatPeriod.isZero() && !heartbeatPeriod.isNegative()) {
- int heartbeatIvl = (int) heartbeatPeriod.toMillis();
- socket.setHeartbeatIvl(heartbeatIvl);
- socket.setHeartbeatTimeout(heartbeatIvl * 3);
- socket.setHeartbeatTtl(heartbeatIvl * 6);
- LOG.info(
- String.format(
- "ZMQ %s socket heartbeat configured: interval=%dms, timeout=%dms, ttl=%dms",
- socketType, heartbeatIvl, heartbeatIvl * 3, heartbeatIvl * 6));
+ if (heartbeatPeriod == null || heartbeatPeriod.isZero() || heartbeatPeriod.isNegative()) {
+ return;
}
+ long ivlMsLong = heartbeatPeriod.toMillis();
+ // Enforce sane bounds: at least 100ms and at most Integer.MAX_VALUE / 6 to avoid overflow below
+ long min = 100L;
+ long max = Integer.MAX_VALUE / 6L;
+ if (ivlMsLong < min) {
+ ivlMsLong = min;
+ } else if (ivlMsLong > max) {
+ ivlMsLong = max;
+ }
+ int heartbeatIvl = (int) ivlMsLong;
+ int heartbeatTimeout = heartbeatIvl * 3;
+ int heartbeatTtl = heartbeatIvl * 6;
+ socket.setHeartbeatIvl(heartbeatIvl);
+ socket.setHeartbeatTimeout(heartbeatTimeout);
+ socket.setHeartbeatTtl(heartbeatTtl);
+ LOG.info(
+ String.format(
+ "ZMQ %s socket heartbeat configured: interval=%dms, timeout=%dms, ttl=%dms",
+ socketType, heartbeatIvl, heartbeatTimeout, heartbeatTtl));
}
Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a potential integer overflow when calculating heartbeat intervals from a large Duration, which could lead to invalid socket configuration and runtime errors.
[general] Refactor duplicated code into a utility method
✅ Refactor duplicated code into a utility method
Extract the duplicated configureHeartbeat method from BoundZmqEventBus and UnboundZmqEventBus into a static helper method in a new utility class to avoid code repetition and improve maintainability.
java/src/org/openqa/selenium/events/zeromq/BoundZmqEventBus.java [84-97]
-private void configureHeartbeat(ZMQ.Socket socket, Duration heartbeatPeriod, String socketType) {
- if (heartbeatPeriod != null && !heartbeatPeriod.isZero() && !heartbeatPeriod.isNegative()) {
- int heartbeatIvl = (int) heartbeatPeriod.toMillis();
- socket.setHeartbeatIvl(heartbeatIvl);
- // Set heartbeat timeout to 3x the interval
- socket.setHeartbeatTimeout(heartbeatIvl * 3);
- // Set heartbeat TTL to 6x the interval
- socket.setHeartbeatTtl(heartbeatIvl * 6);
- LOG.info(
- String.format(
- "Event bus %s socket heartbeat configured: interval=%dms, timeout=%dms, ttl=%dms",
- socketType, heartbeatIvl, heartbeatIvl * 3, heartbeatIvl * 6));
+// In a new file: java/src/org/openqa/selenium/events/zeromq/ZmqUtils.java
+package org.openqa.selenium.events.zeromq;
+
+import java.time.Duration;
+import java.util.logging.Logger;
+import org.zeromq.ZMQ;
+
+class ZmqUtils {
+ private static final Logger LOG = Logger.getLogger(ZmqUtils.class.getName());
+
+ private ZmqUtils() {
+ // Utility class
+ }
+
+ static void configureHeartbeat(ZMQ.Socket socket, Duration heartbeatPeriod, String socketType) {
+ if (heartbeatPeriod != null && !heartbeatPeriod.isZero() && !heartbeatPeriod.isNegative()) {
+ long periodMillis = heartbeatPeriod.toMillis();
+ if (periodMillis > Integer.MAX_VALUE) {
+ LOG.warning(
+ String.format(
+ "Heartbeat period %dms is too large. Capping at %dms.",
+ periodMillis, Integer.MAX_VALUE));
+ periodMillis = Integer.MAX_VALUE;
+ }
+ int heartbeatIvl = (int) periodMillis;
+ socket.setHeartbeatIvl(heartbeatIvl);
+ // Set heartbeat timeout to 3x the interval
+ socket.setHeartbeatTimeout(heartbeatIvl * 3);
+ // Set heartbeat TTL to 6x the interval
+ socket.setHeartbeatTtl(heartbeatIvl * 6);
+ LOG.info(
+ String.format(
+ "Event bus %s socket heartbeat configured: interval=%dms, timeout=%dms, ttl=%dms",
+ socketType, heartbeatIvl, heartbeatIvl * 3, heartbeatIvl * 6));
+ }
}
}
+// In BoundZmqEventBus.java, replace the configureHeartbeat method with:
+private void configureHeartbeat(ZMQ.Socket socket, Duration heartbeatPeriod, String socketType) {
+ ZmqUtils.configureHeartbeat(socket, heartbeatPeriod, socketType);
+}
+Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies that the configureHeartbeat method is duplicated in BoundZmqEventBus and UnboundZmqEventBus, and proposes a valid refactoring to a shared utility method, which improves code maintainability by adhering to the DRY principle.
| PR 16442 (2025-10-15) |
[possible issue] Fix incorrect test assertion order
✅ Fix incorrect test assertion order
In the RSpec tests, move the action (e.g., network.continue_request) before the expect(...).to have_received(...) assertion to correctly verify the behavior.
rb/spec/unit/selenium/webdriver/bidi/network_spec.rb [35-41]
it 'sends only the mandatory request ID when all optional args are nil' do
expected_payload = {request: request_id}
+ network.continue_request(id: request_id)
+
expect(mock_bidi).to have_received(:send_cmd).with('network.continueRequest', expected_payload)
-
- network.continue_request(id: request_id)
endSuggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a critical flaw in the test implementation where the assertion precedes the action, rendering all new tests ineffective at verifying the intended behavior.
| PR 16427 (2025-10-14) |
[possible issue] Remove global docstring check ignore
✅ Remove global docstring check ignore
Remove the global ignore rule for docstring (D) checks from pyproject.toml to ensure the linter can report docstring issues as intended.
[tool.ruff.lint.per-file-ignores]
-"*.py" = ["D"]Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies that the per-file-ignores configuration completely negates the enabling of docstring checks, making the primary change of this PR ineffective.
| PR 16421 (2025-10-13) |
[general] Consolidate browser skip logic
✅ Consolidate browser skip logic
Consolidate the separate if conditions for skipping the test on Chrome and Edge into a single condition using in for better readability and maintainability.
py/test/selenium/webdriver/common/bidi_network_tests.py [104-107]
-if driver.caps["browserName"] == "chrome":
- pytest.skip(reason="Request handlers don't yet work in Chrome when using classic navigation")
-if driver.caps["browserName"] == "edge":
- pytest.skip(reason="Request handlers don't yet work in Edge when using classic navigation")
+if driver.caps["browserName"] in ("chrome", "edge"):
+ pytest.skip(reason="Request handlers don't yet work in Chrome/Edge when using classic navigation")Suggestion importance[1-10]: 4
__
Why: The suggestion improves code conciseness and maintainability by consolidating two if statements into a single check, which is a good practice but has a low impact on functionality.
| PR 16403 (2025-10-08) |
[possible issue] Use a non-generic base class
✅ Use a non-generic base class
Modify _pendingCommands to use a non-generic base CommandInfo class. This will allow storing different command result types in the dictionary, improving type safety.
dotnet/src/webdriver/BiDi/Communication/Broker.cs [40]
-private readonly ConcurrentDictionary<long, CommandInfo<EmptyResult>> _pendingCommands = new();
+private readonly ConcurrentDictionary<long, CommandInfo> _pendingCommands = new();Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a type safety issue where _pendingCommands is constrained to CommandInfo, which forces an unsafe cast later. Proposing a non-generic base class is a valid and robust design pattern to solve this problem.
| PR 16392 (2025-10-06) |
[possible issue] Remove exception from unimplemented method
Remove exception from unimplemented method
Remove the NotImplementedException from the Initialize method in EmulationModule and other modules. If no initialization is needed, the method body should be empty to prevent runtime crashes.
dotnet/src/webdriver/BiDi/Emulation/EmulationModule.cs [93-96]
protected internal override void Initialize(Broker broker)
{
- throw new NotImplementedException();
+ // No-op for this module.
}Suggestion importance[1-10]: 9
__
Why: This suggestion correctly identifies a critical bug introduced by the PR. The Initialize method will be called upon module creation, and throwing a NotImplementedException will cause a runtime crash, making the modules unusable.
[general] Register module-specific JSON serialization context
Register module-specific JSON serialization context
Implement the Initialize method in BrowsingContextModule to register a module-specific JsonSerializerContext. This aligns with the pattern in BrowserModule and is necessary for proper JSON serialization.
dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextModule.cs [254-257]
protected internal override void Initialize(Broker broker)
{
-
+ broker.ConfigureJsonContext(opts => opts.TypeInfoResolverChain.Add(BrowsingContextModuleJsonSerializerContext.Default));
}Suggestion importance[1-10]: 8
__
Why: The suggestion correctly points out that the PR's refactoring goal is to register module-specific JSON contexts, which is missing for BrowsingContextModule. Implementing this is crucial for completing the refactoring and gaining the performance/AOT benefits of source-generated serialization.
| PR 16386 (2025-10-05) |
[possible issue] Fix incorrect enum serialization casing
✅ Fix incorrect enum serialization casing
The UseStringEnumConverter option serializes enums to PascalCase, but the BiDi specification requires lowercase. Remove this option and instead implement custom JsonConverters for each enum to ensure correct serialization.
dotnet/src/webdriver/BiDi/Communication/Json/BiDiJsonSerializerContext.cs [189]
-[JsonSourceGenerationOptions(UseStringEnumConverter = true)]
+// This line should be removed.
+// [JsonSourceGenerationOptions(UseStringEnumConverter = true)]Suggestion importance[1-10]: 10
__
Why: The suggestion correctly identifies a critical issue where using UseStringEnumConverter would cause enum serialization to violate the WebDriver BiDi specification (PascalCase vs. lowercase), leading to communication failures.
| PR 16364 (2025-10-01) |
[general] Remove redundant and unused code
✅ Remove redundant and unused code
Remove the redundant file javascript/grid-ui/src/hooks/useTheme.tsx. Its logic is already implemented in javascript/grid-ui/src/contexts/ThemeContext.tsx, and it is not used by the application.
javascript/grid-ui/src/hooks/useTheme.tsx [1-61]
-// Licensed to the Software Freedom Conservancy (SFC) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The SFC licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
+// This file should be deleted.
-import { useState, useEffect } from 'react'
-import { lightTheme, darkTheme } from '../theme/themes'
-
-type ThemeMode = 'light' | 'dark' | 'system'
-
-export const useTheme = () => {
- const [themeMode, setThemeMode] = useState<ThemeMode>('system')
- const [systemPrefersDark, setSystemPrefersDark] = useState(false)
-
- useEffect(() => {
- if (typeof window !== 'undefined') {
- const saved = localStorage.getItem('theme-mode') as ThemeMode
- if (saved) setThemeMode(saved)
- setSystemPrefersDark(window.matchMedia('(prefers-color-scheme: dark)').matches)
- }
- }, [])
-
-
-
- useEffect(() => {
- if (typeof window !== 'undefined') {
- localStorage.setItem('theme-mode', themeMode)
- }
- }, [themeMode])
-
- useEffect(() => {
- if (typeof window !== 'undefined') {
- const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)')
- const handler = (e: MediaQueryListEvent) => setSystemPrefersDark(e.matches)
- mediaQuery.addEventListener('change', handler)
- return () => mediaQuery.removeEventListener('change', handler)
- }
- }, [])
-
- const isDark = themeMode === 'dark' || (themeMode === 'system' && systemPrefersDark)
- const currentTheme = isDark ? darkTheme : lightTheme
-
- return {
- themeMode,
- setThemeMode,
- currentTheme,
- isDark
- }
-}
-Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a redundant file (useTheme.tsx) whose logic is duplicated in ThemeContext.tsx. Removing this unused code improves maintainability and reduces confusion.
[general] Add assertions to validate behavior
✅ Add assertions to validate behavior
Add assertions to the 'cycles through theme modes on click' test in ThemeToggle.test.tsx. The test currently performs clicks without verifying the component's state changes.
javascript/grid-ui/src/tests/components/ThemeToggle.test.tsx [36-56]
it('cycles through theme modes on click', () => {
render(
<CustomThemeProvider>
<ThemeToggle />
</CustomThemeProvider>
)
-
+
const button = screen.getByRole('button')
-
- // Should start with system mode
- expect(button).toHaveAttribute('aria-label', 'Toggle theme')
-
- // Click to light mode
+
+ // Starts in system mode, next is light
+ expect(screen.getByTestId('AutoModeIcon')).toBeInTheDocument()
fireEvent.click(button)
-
- // Click to dark mode
+
+ // Now in light mode, next is dark
+ expect(screen.getByTestId('LightModeIcon')).toBeInTheDocument()
fireEvent.click(button)
-
- // Click back to system mode
+
+ // Now in dark mode, next is system
+ expect(screen.getByTestId('DarkModeIcon')).toBeInTheDocument()
fireEvent.click(button)
+
+ // Back to system mode
+ expect(screen.getByTestId('AutoModeIcon')).toBeInTheDocument()
})Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that the test case is missing assertions for intermediate states, which makes it ineffective. Improving the test coverage is a valuable enhancement.
[possible issue] Fix incorrect test mock setup
✅ Fix incorrect test mock setup
In TopBar.test.tsx, remove the incorrect mock for ../../hooks/useTheme. Instead, wrap the TopBar component with CustomThemeProvider to align the test environment with its actual usage.
javascript/grid-ui/src/tests/components/TopBar.test.tsx [23-43]
-// Mock the useTheme hook
-jest.mock('../../hooks/useTheme', () => ({
- useTheme: () => ({
- themeMode: 'light',
- setThemeMode: jest.fn(),
- currentTheme: {},
- isDark: false
- })
-}))
+import { CustomThemeProvider } from '../../contexts/ThemeContext'
const user = userEvent.setup()
+
+const renderWithTheme = (ui: React.ReactElement) => {
+ return render(<CustomThemeProvider>{ui}</CustomThemeProvider>)
+}
it('renders basic information', () => {
const subheaderText = 'Hello, world!'
const handleClick = jest.fn()
- render(<TopBar subheader={subheaderText} drawerOpen
+ renderWithTheme(<TopBar subheader={subheaderText} drawerOpen
toggleDrawer={handleClick}/>)
expect(screen.getByText('Selenium Grid')).toBeInTheDocument()
expect(screen.getByRole('img')).toHaveAttribute('alt', 'Selenium Grid Logo')
expect(screen.getByText(subheaderText)).toBeInTheDocument()
})Suggestion importance[1-10]: 8
__
Why: The suggestion correctly points out that the test is mocking a redundant hook (useTheme) instead of using the CustomThemeProvider as the application does, leading to an incorrect test setup.
[learned best practice] Guard browser API accesses
✅ Guard browser API accesses
Add environment checks before using window, localStorage, and matchMedia to avoid runtime errors in SSR/tests and ensure safe access. Fallback gracefully when unavailable.
javascript/grid-ui/src/contexts/ThemeContext.tsx [40-55]
useEffect(() => {
- const saved = localStorage.getItem('theme-mode') as ThemeMode
- if (saved) setThemeMode(saved)
- setSystemPrefersDark(window.matchMedia('(prefers-color-scheme: dark)').matches)
+ if (typeof window !== 'undefined') {
+ try {
+ const saved = window.localStorage.getItem('theme-mode') as ThemeMode
+ if (saved) setThemeMode(saved)
+ const mq = window.matchMedia?.('(prefers-color-scheme: dark)')
+ setSystemPrefersDark(!!mq && mq.matches)
+ } catch {
+ // ignore storage access errors
+ }
+ }
}, [])
useEffect(() => {
- localStorage.setItem('theme-mode', themeMode)
+ if (typeof window !== 'undefined') {
+ try {
+ window.localStorage.setItem('theme-mode', themeMode)
+ } catch {
+ // ignore storage access errors
+ }
+ }
}, [themeMode])
useEffect(() => {
- const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)')
- const handler = (e: MediaQueryListEvent) => setSystemPrefersDark(e.matches)
- mediaQuery.addEventListener('change', handler)
- return () => mediaQuery.removeEventListener('change', handler)
+ if (typeof window !== 'undefined' && typeof window.matchMedia === 'function') {
+ const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)')
+ const handler = (e: MediaQueryListEvent) => setSystemPrefersDark(e.matches)
+ mediaQuery.addEventListener?.('change', handler)
+ return () => mediaQuery.removeEventListener?.('change', handler)
+ }
+ return
}, [])Suggestion importance[1-10]: 6
__
Why:
Relevant best practice - Validate inputs and states early to prevent logic errors; guard access to browser-only APIs (window, localStorage, matchMedia) for non-browser/test environments.
| PR 16362 (2025-10-01) |
[possible issue] Fix syntax error in expression
✅ Fix syntax error in expression
Remove the extra closing curly brace } from the cache-key value to fix a syntax error in the GitHub Actions expression.
.github/workflows/ci-python.yml [70]
-cache-key: python-unit-test-${{ matrix.os }}}
+cache-key: python-unit-test-${{ matrix.os }}Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a syntax error in the GitHub Actions expression for cache-key which would cause the CI job to fail.
| PR 16347 (2025-09-24) |
[general] Fix inconsistent handler naming
✅ Fix inconsistent handler naming
In BrowsingContextInspector, rename the downloadWillEndMapper and downloadWillEndEvent fields to downloadEndMapper and downloadEndEvent to match the event name browsingContext.downloadEnd, and update their usages accordingly.
java/src/org/openqa/selenium/bidi/module/BrowsingContextInspector.java [68-186]
-private final Function<Map<String, Object>, DownloadEnded> downloadWillEndMapper =
+private final Function<Map<String, Object>, DownloadEnded> downloadEndMapper =
params -> {
try (StringReader reader = new StringReader(JSON.toJson(params));
- JsonInput input = JSON.newInput(reader)) {
+ JsonInput input = JSON.newInput(reader)) {
return input.read(DownloadEnded.class);
}
};
-...
-
-private final Event<DownloadEnded> downloadWillEndEvent =
- new Event<>("browsingContext.downloadEnd", downloadWillEndMapper);
-
-...
+private final Event<DownloadEnded> downloadEndEvent =
+ new Event<>("browsingContext.downloadEnd", downloadEndMapper);
public void onDownloadEnd(Consumer<DownloadEnded> consumer) {
if (browsingContextIds.isEmpty()) {
- this.bidi.addListener(downloadWillEndEvent, consumer);
+ this.bidi.addListener(downloadEndEvent, consumer);
} else {
- this.bidi.addListener(browsingContextIds, downloadWillEndEvent, consumer);
+ this.bidi.addListener(browsingContextIds, downloadEndEvent, consumer);
}
}
+@Override
+public void close() {
+ this.bidi.clearListener(browsingContextCreated);
+ this.bidi.clearListener(browsingContextDestroyed);
+ this.bidi.clearListener(userPromptOpened);
+ this.bidi.clearListener(userPromptClosed);
+ this.bidi.clearListener(historyUpdated);
+ this.bidi.clearListener(downloadWillBeginEvent);
+ this.bidi.clearListener(downloadEndEvent);
+
+ navigationEventSet.forEach(this.bidi::clearListener);
+}
+Suggestion importance[1-10]: 4
__
Why: The suggestion improves code consistency by renaming internal variables like downloadWillEndMapper and downloadWillEndEvent to align with the event name browsingContext.downloadEnd. This enhances readability and maintainability, though it is a minor style improvement.
[general] Refactor to remove duplicated JSON parsing
✅ Refactor to remove duplicated JSON parsing
Refactor the DownloadEnded.fromJson method to eliminate redundant JSON parsing logic by delegating deserialization to the DownloadCanceled.fromJson or DownloadCompleted.fromJson methods based on the status field.
java/src/org/openqa/selenium/bidi/browsingcontext/DownloadEnded.java [30-79]
public static DownloadEnded fromJson(JsonInput input) {
- String browsingContextId = null;
- String navigationId = null;
- long timestamp = 0;
- String url = null;
- String status = null;
- String filepath = null;
+ Map<String, Object> jsonMap = input.read(Map.class);
+ String status = (String) jsonMap.get("status");
- input.beginObject();
- while (input.hasNext()) {
- switch (input.nextName()) {
- case "context":
- browsingContextId = input.read(String.class);
- break;
- case "navigation":
- navigationId = input.read(String.class);
- break;
- case "timestamp":
- timestamp = input.read(Long.class);
- break;
- case "url":
- url = input.read(String.class);
- break;
- case "status":
- status = input.read(String.class);
- break;
- case "filepath":
- filepath = input.read(String.class);
- break;
- default:
- input.skipValue();
- break;
+ try (StringReader reader = new StringReader(new Json().toJson(jsonMap));
+ JsonInput jsonInput = new Json().newInput(reader)) {
+ if ("canceled".equals(status)) {
+ return new DownloadEnded(DownloadCanceled.fromJson(jsonInput));
+ } else if ("complete".equals(status)) {
+ return new DownloadEnded(DownloadCompleted.fromJson(jsonInput));
+ } else {
+ throw new IllegalArgumentException(
+ "status must be either 'canceled' or 'complete', but got: " + status);
}
- }
- input.endObject();
-
- // Create the appropriate object based on status
- if ("canceled".equals(status)) {
- DownloadCanceled canceled =
- new DownloadCanceled(browsingContextId, navigationId, timestamp, url, status);
- return new DownloadEnded(canceled);
- } else if ("complete".equals(status)) {
- DownloadCompleted completed =
- new DownloadCompleted(browsingContextId, navigationId, timestamp, url, status, filepath);
- return new DownloadEnded(completed);
- } else {
- throw new IllegalArgumentException(
- "status must be either 'canceled' or 'complete', but got: " + status);
}
}Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies duplicated JSON parsing logic in DownloadEnded.fromJson and proposes a valid refactoring to delegate deserialization, which improves code structure and maintainability.
[learned best practice] Use accurate event naming
✅ Use accurate event naming
Rename downloadWillEndEvent to reflect the actual event name (downloadEnd) for clarity and consistency with other events. This avoids confusion and aligns with event semantics.
java/src/org/openqa/selenium/bidi/module/BrowsingContextInspector.java [97-247]
-private final Event<DownloadEnded> downloadWillEndEvent =
+private final Event<DownloadEnded> downloadEndEvent =
new Event<>("browsingContext.downloadEnd", downloadWillEndMapper);
...
public void onDownloadEnd(Consumer<DownloadEnded> consumer) {
if (browsingContextIds.isEmpty()) {
- this.bidi.addListener(downloadWillEndEvent, consumer);
+ this.bidi.addListener(downloadEndEvent, consumer);
} else {
- this.bidi.addListener(browsingContextIds, downloadWillEndEvent, consumer);
+ this.bidi.addListener(browsingContextIds, downloadEndEvent, consumer);
}
}
...
public void close() {
this.bidi.clearListener(browsingContextCreated);
this.bidi.clearListener(browsingContextDestroyed);
this.bidi.clearListener(userPromptOpened);
this.bidi.clearListener(userPromptClosed);
this.bidi.clearListener(historyUpdated);
this.bidi.clearListener(downloadWillBeginEvent);
- this.bidi.clearListener(downloadWillEndEvent);
+ this.bidi.clearListener(downloadEndEvent);
navigationEventSet.forEach(this.bidi::clearListener);
}Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Always close or dispose resources and clear listeners to prevent leaks; ensure new listeners are cleared on shutdown using consistent fields.
| PR 16338 (2025-09-20) |
[possible issue] Prevent resource leaks with caching
✅ Prevent resource leaks with caching
Cache the BiDi instance to prevent creating a new HTTP client and connection on every invocation. This avoids potential resource leaks and performance issues.
java/src/org/openqa/selenium/bidi/BiDiProvider.java [47-56]
-return () -> {
- URI wsUri = getBiDiUrl(caps).orElseThrow(() -> new BiDiException("BiDi not supported"));
-
- HttpClient.Factory clientFactory = HttpClient.Factory.createDefault();
- ClientConfig wsConfig = ClientConfig.defaultConfig().baseUri(wsUri);
- HttpClient wsClient = clientFactory.createClient(wsConfig);
- Connection connection = new Connection(wsClient, wsUri.toString());
-
- return Optional.of(new BiDi(connection));
+return new HasBiDi() {
+ private volatile Optional<BiDi> cachedBiDi;
+
+ @Override
+ public Optional<BiDi> getBiDi() {
+ if (cachedBiDi == null) {
+ synchronized (this) {
+ if (cachedBiDi == null) {
+ URI wsUri = getBiDiUrl(caps).orElseThrow(() -> new BiDiException("BiDi not supported"));
+ HttpClient.Factory clientFactory = HttpClient.Factory.createDefault();
+ ClientConfig wsConfig = ClientConfig.defaultConfig().baseUri(wsUri);
+ HttpClient wsClient = clientFactory.createClient(wsConfig);
+ Connection connection = new Connection(wsClient, wsUri.toString());
+ cachedBiDi = Optional.of(new BiDi(connection));
+ }
+ }
+ }
+ return cachedBiDi;
+ }
};Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a significant issue where new HTTP clients and connections are created on each call, which can lead to resource exhaustion and performance degradation. The proposed caching solution is a robust fix for this problem.
[possible issue] Prevent connection recreation with caching
✅ Prevent connection recreation with caching
Cache the DevTools instance to avoid recreating connections and performing version matching on every call. This prevents potential resource leaks and unnecessary overhead.
java/src/org/openqa/selenium/devtools/DevToolsProvider.java [45-53]
-return () -> {
- Object cdpVersion = caps.getCapability("se:cdpVersion");
- String version = cdpVersion instanceof String ? (String) cdpVersion : caps.getBrowserVersion();
-
- CdpInfo info = new CdpVersionFinder().match(version).orElseGet(NoOpCdpInfo::new);
- Optional<DevTools> devTools =
- SeleniumCdpConnection.create(caps).map(conn -> new DevTools(info::getDomains, conn));
- return devTools;
+return new HasDevTools() {
+ private volatile Optional<DevTools> cachedDevTools;
+
+ @Override
+ public Optional<DevTools> getDevTools() {
+ if (cachedDevTools == null) {
+ synchronized (this) {
+ if (cachedDevTools == null) {
+ Object cdpVersion = caps.getCapability("se:cdpVersion");
+ String version = cdpVersion instanceof String ? (String) cdpVersion : caps.getBrowserVersion();
+ CdpInfo info = new CdpVersionFinder().match(version).orElseGet(NoOpCdpInfo::new);
+ cachedDevTools = SeleniumCdpConnection.create(caps).map(conn -> new DevTools(info::getDomains, conn));
+ }
+ }
+ }
+ return cachedDevTools;
+ }
};Suggestion importance[1-10]: 8
__
Why: The suggestion correctly points out that repeatedly creating DevTools connections and performing version matching is inefficient and can lead to resource leaks. The proposed caching mechanism is an effective solution to ensure the connection is created only once.
[possible issue] Prevent multiple connection creation
✅ Prevent multiple connection creation
To prevent resource leaks from multiple connections, cache the BiDi instance so it is created only once. The current implementation creates a new connection every time getBiDi() is called.
java/src/org/openqa/selenium/bidi/BiDiProvider.java [47-56]
-return () -> {
- URI wsUri = getBiDiUrl(caps).orElseThrow(() -> new BiDiException("BiDi not supported"));
-
- HttpClient.Factory clientFactory = HttpClient.Factory.createDefault();
- ClientConfig wsConfig = ClientConfig.defaultConfig().baseUri(wsUri);
- HttpClient wsClient = clientFactory.createClient(wsConfig);
- Connection connection = new Connection(wsClient, wsUri.toString());
-
- return Optional.of(new BiDi(connection));
+return new HasBiDi() {
+ private volatile Optional<BiDi> biDi;
+
+ @Override
+ public Optional<BiDi> getBiDi() {
+ if (biDi == null) {
+ synchronized (this) {
+ if (biDi == null) {
+ URI wsUri = getBiDiUrl(caps).orElseThrow(() -> new BiDiException("BiDi not supported"));
+ HttpClient.Factory clientFactory = HttpClient.Factory.createDefault();
+ ClientConfig wsConfig = ClientConfig.defaultConfig().baseUri(wsUri);
+ HttpClient wsClient = clientFactory.createClient(wsConfig);
+ Connection connection = new Connection(wsClient, wsUri.toString());
+ biDi = Optional.of(new BiDi(connection));
+ }
+ }
+ }
+ return biDi;
+ }
};Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a significant issue where the PR's change to lazy-load the connection would create a new connection on every call, leading to resource leaks. The proposed fix using double-checked locking correctly implements a cached, lazy-initialized connection, which is a critical improvement for correctness and performance.
[general] Simplify lazy-loading with a memoized supplier
✅ Simplify lazy-loading with a memoized supplier
Replace the manual double-checked locking implementation with Guava's Suppliers.memoize to simplify the code and improve robustness for lazy initialization.
java/src/org/openqa/selenium/bidi/BiDiProvider.java [47-68]
return new HasBiDi() {
- private volatile Optional<BiDi> biDi;
+ private final Supplier<Optional<BiDi>> biDiSupplier =
+ Suppliers.memoize(
+ () -> {
+ URI wsUri =
+ getBiDiUrl(caps).orElseThrow(() -> new BiDiException("BiDi not supported"));
+
+ HttpClient.Factory clientFactory = HttpClient.Factory.createDefault();
+ ClientConfig wsConfig = ClientConfig.defaultConfig().baseUri(wsUri);
+ HttpClient wsClient = clientFactory.createClient(wsConfig);
+ Connection connection = new Connection(wsClient, wsUri.toString());
+
+ return Optional.of(new BiDi(connection));
+ });
@Override
public Optional<BiDi> maybeGetBiDi() {
- if (biDi == null) {
- synchronized (this) {
- if (biDi == null) {
- URI wsUri = getBiDiUrl(caps).orElseThrow(() -> new BiDiException("BiDi not supported"));
-
- HttpClient.Factory clientFactory = HttpClient.Factory.createDefault();
- ClientConfig wsConfig = ClientConfig.defaultConfig().baseUri(wsUri);
- HttpClient wsClient = clientFactory.createClient(wsConfig);
- Connection connection = new Connection(wsClient, wsUri.toString());
-
- biDi = Optional.of(new BiDi(connection));
- }
- }
- }
- return biDi;
+ return biDiSupplier.get();
}
};Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that the manual double-checked locking can be replaced by a simpler and more robust library utility (Suppliers.memoize), significantly improving code readability and maintainability.
[learned best practice] Use initialized Optional with DCL
✅ Use initialized Optional with DCL
Initialize devTools to Optional.empty() and use a local variable in the double-checked locking to avoid null checks and publication races.
java/src/org/openqa/selenium/devtools/DevToolsProvider.java [45-64]
return new HasDevTools() {
- private volatile Optional<DevTools> devTools;
+ private volatile Optional<DevTools> devTools = Optional.empty();
@Override
public Optional<DevTools> maybeGetDevTools() {
- if (devTools == null) {
+ Optional<DevTools> local = devTools;
+ if (local.isEmpty()) {
synchronized (this) {
- if (devTools == null) {
+ local = devTools;
+ if (local.isEmpty()) {
Object cdpVersion = caps.getCapability("se:cdpVersion");
String version =
cdpVersion instanceof String ? (String) cdpVersion : caps.getBrowserVersion();
CdpInfo info = new CdpVersionFinder().match(version).orElseGet(NoOpCdpInfo::new);
- this.devTools = SeleniumCdpConnection.create(caps).map(conn -> new DevTools(info::getDomains, conn));
+ local = SeleniumCdpConnection.create(caps).map(conn -> new DevTools(info::getDomains, conn));
+ devTools = local;
}
}
}
- return devTools;
+ return local;
}
};Suggestion importance[1-10]: 5
__
Why: Relevant best practice - Initialize attributes to sane defaults to avoid null/partially-initialized states, especially when using double-checked locking.
| PR 16333 (2025-09-18) |
[general] Restrict constant visibility for better encapsulation
✅ Restrict constant visibility for better encapsulation
Change the ChromiumIgnoreReason constant's visibility from public to private to improve encapsulation, as it is only used within the WebExtensionTest class.
dotnet/test/common/BiDi/WebExtension/WebExtensionTest.cs [30-36]
-public const string ChromiumIgnoreReason = """
+private const string ChromiumIgnoreReason = """
The following test suite wants to set driver arguments via Options, but it breaks CDP/DevTools tests.
The desired arguments (for Chromium only?):
--enable-unsafe-extension-debugging
--remote-debugging-pipe
Ignoring these tests for now. Hopefully https://github.com/SeleniumHQ/selenium/issues/15536 will be resolved soon.
""";Suggestion importance[1-10]: 4
__
Why: The suggestion correctly identifies that the ChromiumIgnoreReason constant can be made private to improve encapsulation, as it is only used within its declaring class.
| PR 16327 (2025-09-16) |
[learned best practice] Add missing @Override annotation
✅ Add missing @Override annotation
Add the @Override annotation to getUpNodes() since it implements the new interface method, enabling compile-time checks.
java/src/org/openqa/selenium/grid/distributor/local/LocalNodeRegistry.java [366-376]
+@Override
public Set<NodeStatus> getUpNodes() {
Lock readLock = this.lock.readLock();
readLock.lock();
try {
return model.getSnapshot().stream()
.filter(node -> UP.equals(node.getAvailability()))
.collect(ImmutableSet.toImmutableSet());
} finally {
readLock.unlock();
}
}Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Explicitly annotate interface implementations with @Override to ensure contract adherence and improve maintainability.
| PR 16325 (2025-09-15) |
[possible issue] Sort events to prevent flaky tests
✅ Sort events to prevent flaky tests
To prevent flaky tests, wait for both download events, sort them by URL to ensure a deterministic order, and then validate the properties of each event.
py/test/selenium/webdriver/common/bidi_browsing_context_tests.py [828-840]
-WebDriverWait(driver, 5).until(lambda d: len(events_received) > 1)
+WebDriverWait(driver, 5).until(lambda d: len(events_received) == 2)
assert len(events_received) == 2
-download_event = events_received[0]
-assert download_event.download_params is not None
-assert download_event.download_params.status == "complete"
-assert download_event.download_params.context == context_id
-assert download_event.download_params.timestamp is not None
-assert "downloads/file_1.txt" in download_event.download_params.url
-# we assert that atleast the str "file_1" is present in the downloaded file since multiple downloads
+# Sort events to have a deterministic order for assertions
+events_received.sort(key=lambda e: e.download_params.url)
+
+download_event_1 = events_received[0]
+assert download_event_1.download_params is not None
+assert download_event_1.download_params.status == "complete"
+assert download_event_1.download_params.context == context_id
+assert download_event_1.download_params.timestamp is not None
+assert "downloads/file_1.txt" in download_event_1.download_params.url
+# we assert that at least the str "file_1" is present in the downloaded file since multiple downloads
# will have numbered suffix like file_1 (1)
-assert "file_1" in download_event.download_params.filepath
+assert "file_1" in download_event_1.download_params.filepath
+download_event_2 = events_received[1]
+assert download_event_2.download_params is not None
+assert download_event_2.download_params.status == "complete"
+assert download_event_2.download_params.context == context_id
+assert download_event_2.download_params.timestamp is not None
+assert "downloads/file_2.txt" in download_event_2.download_params.url
+assert "file_2" in download_event_2.download_params.filepath
+Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a potential for flaky tests due to the non-deterministic order of asynchronous download events and provides a robust solution by sorting the events before assertion, which is a critical improvement for test reliability.
| PR 16309 (2025-09-09) |
[possible issue] Preserve None for optional fields
✅ Preserve None for optional fields
Avoid coercing optional values to strings, since str(None) becomes the literal "None", which will be sent to the remote as an invalid value. Pass these through unchanged so None remains None and only actual strings are forwarded.
py/selenium/webdriver/chromium/webdriver.py [63-69]
executor = ChromiumRemoteConnection(
remote_server_addr=self.service.service_url,
- browser_name=str(browser_name),
- vendor_prefix=str(vendor_prefix),
+ browser_name=browser_name,
+ vendor_prefix=vendor_prefix,
keep_alive=keep_alive,
ignore_proxy=options._ignore_local_proxy,
)Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies that casting None to a string results in the literal "None", which is likely an invalid value for browser_name and vendor_prefix, thus fixing a bug introduced in the PR.
| PR 16271 (2025-08-29) |
[general] Properly stop driver before nullifying
✅ Properly stop driver before nullifying
Setting the global variable to None without properly stopping the driver can lead to resource leaks. The driver should be stopped before nullifying the reference to ensure proper cleanup.
if request.node.get_closest_marker("no_driver_after_test"):
+ if selenium_driver is not None:
+ selenium_driver.stop_driver()
selenium_driver = NoneSuggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that nullifying selenium_driver without stopping it first is fragile and can lead to resource leaks, making the code more robust and consistent with other cleanup logic in the file.
| PR 16262 (2025-08-26) |
[possible issue] Fix broken version specifier
✅ Fix broken version specifier
The version specifier is invalid due to a missing comma between the lower and upper bounds. This will break dependency parsing and resolution. Add a comma to separate the specifiers.
-"websocket-client>=1.8.0<2.0",
+"websocket-client>=1.8.0,<2.0",Suggestion importance[1-10]: 10
__
Why: The suggestion correctly identifies a malformed version specifier for websocket-client that lacks a comma, which would break dependency resolution, making this a critical fix.
[possible issue] Correct malformed dependency range
✅ Correct malformed dependency range
The dependency constraint is malformed because it lacks a comma between specifiers, violating PEP 508. Insert the comma to ensure valid parsing by build tools.
-"websocket-client>=1.8.0<2.0",
+"websocket-client>=1.8.0,<2.0",Suggestion importance[1-10]: 10
__
Why: The suggestion correctly identifies a malformed dependency constraint for websocket-client that violates PEP 508 and would break dependency installation, making this a critical fix.
| PR 16250 (2025-08-24) |
[general] Ensure attribute is always initialized
✅ Ensure attribute is always initialized
Initialize self.log_output with a default to avoid potential mypy "possibly uninitialized" errors when new branches are added. Also fix minor formatting for readability. This keeps the attribute always defined and improves maintainability.
py/selenium/webdriver/common/service.py [60-68]
-self.log_output: Optional[Union[int, IOBase]]
+self.log_output: Optional[Union[int, IOBase]] = None
if isinstance(log_output, str):
self.log_output = cast(IOBase, open(log_output, "a+", encoding="utf-8"))
elif log_output == subprocess.STDOUT:
self.log_output = None
elif log_output is None or log_output == subprocess.DEVNULL:
self.log_output = subprocess.DEVNULL
else:
- self.log_output = cast(Union[int, IOBase],log_output)
+ self.log_output = cast(Union[int, IOBase], log_output)Suggestion importance[1-10]: 3
__
Why: The suggestion to initialize self.log_output at declaration is good practice for robustness and readability, although the existing if/elif/else structure already ensures it is always assigned a value.
| PR 16248 (2025-08-23) |
[learned best practice] Validate WebSocket constructor inputs
✅ Validate WebSocket constructor inputs
Validate the constructor parameters to ensure they are present and of the expected types/ranges. Default or raise clear errors for invalid values to prevent subtle runtime issues.
py/selenium/webdriver/remote/websocket_connection.py [31-39]
class WebSocketConnection:
_max_log_message_size = 9999
def __init__(self, url, timeout, interval):
+ if not url:
+ raise ValueError("WebSocket URL must be provided")
+ if timeout is None or timeout <= 0:
+ raise ValueError("timeout must be a positive number")
+ if interval is None or interval <= 0:
+ raise ValueError("interval must be a positive number")
+
self.callbacks = {}
self.session_id = None
self.url = url
- self.response_wait_timeout = timeout
- self.response_wait_interval = interval
+ self.response_wait_timeout = float(timeout)
+ self.response_wait_interval = float(interval)Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Add null checks and validation for parameters and variables before using them to prevent runtime errors.
| PR 16233 (2025-08-21) |
[learned best practice] Fix incorrect Javadoc reference
✅ Fix incorrect Javadoc reference
The Javadoc text references TargetLocator#alert(), which is unrelated to element screenshots, and misuses "@see" in a @param. Update the description to reflect WebElement.getScreenshotAs and fix parameter docs and punctuation.
java/src/org/openqa/selenium/support/events/WebDriverListener.java [613-622]
/**
- * This action will be performed each time after {@link WebDriver.TargetLocator#alert()} is
- * called.
+ * This method will be called after {@link WebElement#getScreenshotAs(OutputType)} is called.
*
- * @param element - decorated WebElement instance
- * @param target - target type, @see OutputType
- * @param result - object in which is stored information about the screenshot.
- * @param <X> - return type for getScreenshotAs.
+ * @param element the decorated WebElement instance
+ * @param target the target type, {@link OutputType}
+ * @param result the screenshot result
+ * @param <X> the return type for getScreenshotAs
*/
default <X> void afterGetScreenshotAs(WebElement element, OutputType<X> target, X result) {}Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Fix syntax errors, typos, and naming inconsistencies in comments and documentation.
[learned best practice] Correct Javadoc parameter links
✅ Correct Javadoc parameter links
**
-
- This action will be performed each time after {@link WebDriver.TargetLocator#alert()} is
-
- called.
-
- This method will be called after {@link TakesScreenshot#getScreenshotAs(OutputType)} is called.
- @param element - decorated WebElement instance
- @param target - target type, @see OutputType
**In Javadoc, avoid using "@see" within @param descriptions; link the type directly with {@link}. This improves clarity and tooling parsing. Update the parameter docs to use proper links and consistent punctuation.**
[java/src/org/openqa/selenium/support/events/WebDriverListener.java [335-343]](https://github.com/SeleniumHQ/selenium/pull/16233/files#diff-27fd3dec4abffb9b78d39c4f8ca918bcb5cd04926e3d252d2398f561f5ad61ffR335-R343)
```diff
/**
- * This method will be called before {@link TakesScreenshot#getScreenshotAs(OutputType)} is
- * called.
+ * This method will be called before {@link TakesScreenshot#getScreenshotAs(OutputType)} is called.
*
- * @param driver - decorated WebDriver instance
- * @param target - target type, @see OutputType
- * @param <X> - return type for getScreenshotAs.
+ * @param driver the decorated WebDriver instance
+ * @param target the target type, {@link OutputType}
+ * @param <X> the return type for getScreenshotAs
*/
default <X> void beforeGetScreenshotAs(WebDriver driver, OutputType<X> target) {}
Suggestion importance[1-10]: 5
__
Why: Relevant best practice - Fix string formatting and interpolation issues; avoid ambiguous or incorrect Javadoc tags and references.
[learned best practice] Clean up Javadoc references
✅ Clean up Javadoc references
** * This method will be called after {@link TakesScreenshot#getScreenshotAs(OutputType)} is called. *
-
- @param driver - decorated WebDriver instance
-
- @param target - target type, @see OutputType
-
- @param result - object in which is stored information about the screenshot.
-
- @param - return type for getScreenshotAs.
-
- @param driver decorated WebDriver instance
-
- @param target target type, see {@link OutputType}
-
- @param result object that stores the screenshot information
-
- @param return type for getScreenshotAs */ default void afterGetScreenshotAs(WebDriver driver, OutputType target, X result) {}
@@ -607,19 +607,19 @@ * This method will be called before {@link TakesScreenshot#getScreenshotAs(OutputType)} is * called. *
-
- @param element - decorated WebElement instance
-
- @param target - target type, @see OutputType
-
- @param - return type for getScreenshotAs.
-
- @param element decorated WebElement instance
-
- @param target target type, see {@link OutputType}
-
- @param return type for getScreenshotAs */ default void beforeGetScreenshotAs(WebElement element, OutputType target) {}
/** * This method will be called after {@link TakesScreenshot#getScreenshotAs(OutputType)} is called. *
-
- @param element - decorated WebElement instance
-
- @param target - target type, @see OutputType
-
- @param result - object in which is stored information about the screenshot.
-
- @param - return type for getScreenshotAs.
-
- @param element decorated WebElement instance
-
- @param target target type, see {@link OutputType}
-
- @param result result object that stores the screenshot information
-
- @param return type for getScreenshotAs
**Replace "@see" inline in @param descriptions with proper Javadoc links or move them to @see tags. Also clarify generic return type wording and remove trailing periods in parameter descriptions for consistency.**
[java/src/org/openqa/selenium/support/events/WebDriverListener.java [335-624]](https://github.com/SeleniumHQ/selenium/pull/16233/files#diff-27fd3dec4abffb9b78d39c4f8ca918bcb5cd04926e3d252d2398f561f5ad61ffR335-R624)
```diff
/**
- * This method will be called before {@link TakesScreenshot#getScreenshotAs(OutputType)} is
- * called.
+ * This method will be called before {@link TakesScreenshot#getScreenshotAs(OutputType)} is called.
*
- * @param driver - decorated WebDriver instance
- * @param target - target type, @see OutputType
- * @param <X> - return type for getScreenshotAs.
+ * @param driver decorated WebDriver instance
+ * @param target target type, see {@link OutputType}
+ * @param <X> return type for getScreenshotAs
*/
default <X> void beforeGetScreenshotAs(WebDriver driver, OutputType<X> target) {}
/**
* This method will be called after {@link TakesScreenshot#getScreenshotAs(OutputType)} is called.
*
- * @param driver - decorated WebDriver instance
- * @param target - target type, @see OutputType
- * @param result - object in which is stored information about the screenshot.
- * @param <X> - return type for getScreenshotAs.
+ * @param driver decorated WebDriver instance
+ * @param target target type, see {@link OutputType}
+ * @param result object that stores the screenshot information
+ * @param <X> return type for getScreenshotAs
*/
default <X> void afterGetScreenshotAs(WebDriver driver, OutputType<X> target, X result) {}
/**
- * This method will be called before {@link TakesScreenshot#getScreenshotAs(OutputType)} is
- * called.
+ * This method will be called before {@link TakesScreenshot#getScreenshotAs(OutputType)} is called.
*
- * @param element - decorated WebElement instance
- * @param target - target type, @see OutputType
- * @param <X> - return type for getScreenshotAs.
+ * @param element decorated WebElement instance
+ * @param target target type, see {@link OutputType}
+ * @param <X> return type for getScreenshotAs
*/
default <X> void beforeGetScreenshotAs(WebElement element, OutputType<X> target) {}
/**
* This method will be called after {@link TakesScreenshot#getScreenshotAs(OutputType)} is called.
*
- * @param element - decorated WebElement instance
- * @param target - target type, @see OutputType
- * @param result - object in which is stored information about the screenshot.
- * @param <X> - return type for getScreenshotAs.
+ * @param element decorated WebElement instance
+ * @param target target type, see {@link OutputType}
+ * @param result object that stores the screenshot information
+ * @param <X> return type for getScreenshotAs
*/
default <X> void afterGetScreenshotAs(WebElement element, OutputType<X> target, X result) {}
Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Fix Javadoc formatting and reference style to avoid ambiguity and maintain consistent documentation quality.
[general] Fix misleading parameter name
✅ Fix misleading parameter name
The parameter name driver for WebElement callbacks is misleading and contradicts the interface, risking confusion and incorrect usage. Rename it to element to align with WebDriverListener method signatures and improve test clarity.
java/test/org/openqa/selenium/support/events/EventFiringDecoratorTest.java [476-483]
-public <X> void beforeGetScreenshotAs(WebElement driver, OutputType<X> target) {
+public <X> void beforeGetScreenshotAs(WebElement element, OutputType<X> target) {
acc.append("beforeGetScreenshotAs ").append(target).append("\n");
}
@Override
-public <X> void afterGetScreenshotAs(WebElement driver, OutputType<X> target, X result) {
+public <X> void afterGetScreenshotAs(WebElement element, OutputType<X> target, X result) {
acc.append("afterGetScreenshotAs ").append(target).append(" ").append(result).append("\n");
}Suggestion importance[1-10]: 4
__
Why: The suggestion correctly identifies a misleading parameter name driver for a WebElement and suggests renaming it to element for consistency with the interface, improving code clarity.
| PR 16228 (2025-08-21) |
[possible issue] Avoid unintended copies with multi-RID
✅ Avoid unintended copies with multi-RID
Guard against custom or cross-targeting builds where RID is set via TargetFramework or RuntimeIdentifiers by also checking that '$(RuntimeIdentifiers)' is empty. This prevents duplicate or incorrect asset copying when NuGet already selects runtime-specific assets.
dotnet/src/webdriver/assets/nuget/build/netstandard2.0/Selenium.WebDriver.targets [4-9]
<!-- Only run if the consumer did NOT set a RID (so NuGet won't select runtimes assets),
and only for .NET Framework projects where this problem is common. -->
-<ItemGroup Condition="'$(RuntimeIdentifier)' == '' and '$(TargetFrameworkIdentifier)' == '.NETFramework'">
+<ItemGroup Condition="'$(RuntimeIdentifier)' == '' and '$(RuntimeIdentifiers)' == '' and '$(TargetFrameworkIdentifier)' == '.NETFramework'">
<Content Include="$(MSBuildThisFileDirectory)..\..\runtimes\win\native\selenium-manager.exe">
<Link>runtimes\win\native\%(Filename)%(Extension)</Link>
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that checking only $(RuntimeIdentifier) is insufficient, as $(RuntimeIdentifiers) can be used for multi-targeted builds, making the proposed condition more robust and aligned with the PR's intent.
| PR 16212 (2025-08-19) |
[learned best practice] Close HTTP response via context manager
✅ Close HTTP response via context manager
Ensure the HTTP response object is properly closed by using a context manager. This prevents potential resource leaks under heavy usage or exceptions.
py/selenium/webdriver/common/utils.py [150-151]
-res = urllib.request.urlopen(f"{scheme}://{host}:{port}/status")
-return res.getcode() == 200
+with urllib.request.urlopen(f"{scheme}://{host}:{port}/status") as res:
+ return res.getcode() == 200Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Use proper resource disposal patterns with context managers to prevent leaks when working with network/IO resources.
| PR 16205 (2025-08-18) |
[general] Mark removed API as obsolete error
✅ Mark removed API as obsolete error
Remove UnsubscribeByAttributesOptions since attribute-based unsubscribe is no longer supported, preventing accidental usage and API drift. If kept for binary compatibility, mark it [Obsolete(true)] to produce compile-time errors.
dotnet/src/webdriver/BiDi/Session/UnsubscribeCommand.cs [32-35]
+[Obsolete("Unsubscribe by attributes is no longer supported. Use unsubscribe by subscription id instead.", true)]
public sealed class UnsubscribeByAttributesOptions : CommandOptions
{
public IEnumerable<BrowsingContext.BrowsingContext>? Contexts { get; set; }
}Suggestion importance[1-10]: 7
__
Why: The PR removes the functionality associated with UnsubscribeByAttributesOptions but leaves the class in the public API, so marking it as obsolete improves API consistency and prevents misuse.
| PR 16191 (2025-08-16) |
[possible issue] Fix malformed bug report link
✅ Fix malformed bug report link
Fix the malformed sentence and extra parenthesis to avoid confusing readers and broken rendering. Combine the text and link properly, using a single closing parenthesis and clear wording.
-Issues shouldn't be used for support. To raise a bug, please go here-
-(https://github.com/SeleniumHQ/selenium/issues)).
+Issues shouldn't be used for support. To report a bug, please open an issue at: https://github.com/SeleniumHQ/selenium/issuesSuggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies and fixes a malformed sentence and link, which has an extra parenthesis and unusual punctuation, improving the clarity and correctness of the documentation.
[general] Clarify Slack channel reference
✅ Clarify Slack channel reference
Clarify the Slack reference by using a direct, descriptive link label and avoid bare URLs in parentheses for better readability and accessibility. This reduces ambiguity and improves formatting consistency.
-Discussion of high level project ideas or non-technical topics should
-move to the Selenium Slack channel (https://inviter.co/seleniumhq).
+Discussion of high level project ideas or non-technical topics should move to the Selenium Slack channel: https://inviter.co/seleniumhqSuggestion importance[1-10]: 3
__
Why: The suggestion proposes a minor stylistic change to improve readability by replacing parentheses around a URL with a colon, which is a valid but low-impact improvement.
| PR 16174 (2025-08-13) |
[possible issue] Prevent invalid value reassignment
✅ Prevent invalid value reassignment
Avoid overwriting value with a non-dict message, which can lead to later .get() accesses failing. Only reassign value when message is a dict; otherwise keep value intact.
py/selenium/webdriver/remote/errorhandler.py [174-179]
if not isinstance(message, str):
- value = message
if isinstance(message, dict):
+ value = message
message = message.get("message")
else:
message = NoneSuggestion importance[1-10]: 7
__
Why: The suggestion correctly points out that value should only be reassigned if message is a dictionary, preventing potential AttributeError exceptions on subsequent .get() calls on value.
| PR 16169 (2025-08-13) |
[general] Clarify label formatting
✅ Clarify label formatting
Use backticks around the label name in the link text to match GitHub’s UI and avoid ambiguity. This also helps distinguish the label from surrounding prose.
-[issues labelled good first issue](https://github.com/SeleniumHQ/selenium/issues?q=is%3Aopen%20is%3Aissue%20label%3A%22good%20first%20issue%22)
+[issues labelled `good first issue`](https://github.com/SeleniumHQ/selenium/issues?q=is%3Aopen%20is%3Aissue%20label%3A%22good%20first%20issue%22)Suggestion importance[1-10]: 3
__
Why: This is a minor stylistic suggestion that improves readability by using backticks for the label name, which is a good practice.
| PR 16163 (2025-08-12) |
[general] Bound status probe timeout
✅ Bound status probe timeout
Add a short read timeout specifically for the /status probe to avoid hanging on an unresponsive node and blocking session creation. Use a bounded timeout (e.g., a few seconds) independent from the main client timeout.
java/src/org/openqa/selenium/grid/router/HandleSession.java [258-293]
-try (HttpClient httpClient = httpClientFactory.createClient(config)) {
+try (HttpClient httpClient = httpClientFactory.createClient(
+ ClientConfig.defaultConfig()
+ .baseUri(uri)
+ .readTimeout(Duration.ofSeconds(5))
+ .withRetries())) {
HttpRequest statusRequest = new HttpRequest(GET, "/status");
HttpResponse res = httpClient.execute(statusRequest);
- Reader reader = reader(res);
- Json JSON = new Json();
- JsonInput in = JSON.newInput(reader);
- in.beginObject();
- // Skip everything until we find "value"
- while (in.hasNext()) {
- if ("value".equals(in.nextName())) {
+ if (res.getStatus() == 200) {
+ try (Reader rdr = reader(res); JsonInput in = new Json().newInput(rdr)) {
in.beginObject();
while (in.hasNext()) {
- if ("node".equals(in.nextName())) {
- NodeStatus nodeStatus = in.read(NodeStatus.class);
- sessionTimeout = nodeStatus.getSessionTimeout();
- ...
+ String name = in.nextName();
+ if ("value".equals(name)) {
+ in.beginObject();
+ while (in.hasNext()) {
+ String inner = in.nextName();
+ if ("node".equals(inner)) {
+ NodeStatus nodeStatus = in.read(NodeStatus.class);
+ Duration parsed = nodeStatus.getSessionTimeout();
+ if (parsed != null && !parsed.isNegative() && !parsed.isZero()) {
+ sessionTimeout = parsed;
+ }
+ } else {
+ in.skipValue();
+ }
+ }
+ in.endObject();
} else {
in.skipValue();
}
}
- in.endObject();
- } else {
- in.skipValue();
}
}
} catch (Exception e) {
- LOG.fine(
- "Use default from ClientConfig (read timeout: "
- + config.readTimeout().toSeconds()
- + " seconds) for "
- + uri);
+ LOG.fine("Use default from ClientConfig (read timeout: "
+ + config.readTimeout().toSeconds() + " seconds) for " + uri);
}Suggestion importance[1-10]: 8
__
Why: The suggestion addresses a potential performance issue where fetching the node status could hang indefinitely if the node is unresponsive, by proposing a separate, short timeout for this specific request, which is a critical improvement for stability.
[possible issue] Close parser and validate response
✅ Close parser and validate response
Ensure the JsonInput is always closed to avoid resource leaks. Additionally, verify the HTTP response status and content type before parsing to prevent parsing errors on non-200 responses or non-JSON bodies.
java/src/org/openqa/selenium/grid/router/HandleSession.java [255-296]
private ClientConfig fetchNodeSessionTimeout(URI uri) {
ClientConfig config = ClientConfig.defaultConfig().baseUri(uri).withRetries();
Duration sessionTimeout = config.readTimeout();
try (HttpClient httpClient = httpClientFactory.createClient(config)) {
HttpRequest statusRequest = new HttpRequest(GET, "/status");
HttpResponse res = httpClient.execute(statusRequest);
- Reader reader = reader(res);
- Json JSON = new Json();
- JsonInput in = JSON.newInput(reader);
- in.beginObject();
- // Skip everything until we find "value"
- while (in.hasNext()) {
- if ("value".equals(in.nextName())) {
+ if (res.getStatus() == 200 && res.getHeader("Content-Type") != null && res.getHeader("Content-Type").contains("application/json")) {
+ try (Reader rdr = reader(res); JsonInput in = new Json().newInput(rdr)) {
in.beginObject();
while (in.hasNext()) {
- if ("node".equals(in.nextName())) {
- NodeStatus nodeStatus = in.read(NodeStatus.class);
- sessionTimeout = nodeStatus.getSessionTimeout();
- LOG.fine(
- "Fetched session timeout from node status (read timeout: "
- + sessionTimeout.toSeconds()
- + " seconds) for "
- + uri);
+ String name = in.nextName();
+ if ("value".equals(name)) {
+ in.beginObject();
+ while (in.hasNext()) {
+ String inner = in.nextName();
+ if ("node".equals(inner)) {
+ NodeStatus nodeStatus = in.read(NodeStatus.class);
+ sessionTimeout = nodeStatus.getSessionTimeout();
+ LOG.fine("Fetched session timeout from node status (read timeout: "
+ + sessionTimeout.toSeconds() + " seconds) for " + uri);
+ } else {
+ in.skipValue();
+ }
+ }
+ in.endObject();
} else {
in.skipValue();
}
}
- in.endObject();
- } else {
- in.skipValue();
}
+ } else {
+ LOG.fine("Non-OK or non-JSON status response from " + uri + " for /status, using default read timeout.");
}
} catch (Exception e) {
- LOG.fine(
- "Use default from ClientConfig (read timeout: "
- + config.readTimeout().toSeconds()
- + " seconds) for "
- + uri);
+ LOG.fine("Use default from ClientConfig (read timeout: "
+ + config.readTimeout().toSeconds() + " seconds) for " + uri);
}
- config = config.readTimeout(sessionTimeout);
- return config;
+ return config.readTimeout(sessionTimeout);
}Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies a potential resource leak by not closing the JsonInput and Reader, and improves robustness by adding a check for the HTTP response status and content type before parsing.
| PR 16155 (2025-08-10) |
[general] Use capacity check instead of slot scan
✅ Use capacity check instead of slot scan
Avoid iterating over all slots just to detect a free one by leveraging NodeStatus.hasCapacity() if it already encapsulates this logic. This reduces per-call overhead and keeps the intent consistent with other uses. Fall back to a short-circuiting check if hasCapacity() is insufficient.
java/src/org/openqa/selenium/grid/distributor/local/LocalDistributor.java [509-527]
protected Set<NodeStatus> getAvailableNodes() {
Lock readLock = this.lock.readLock();
readLock.lock();
try {
return model.getSnapshot().stream()
- .filter(
- node -> {
- // Only consider UP nodes (not DOWN, DRAINING, etc.)
- if (!UP.equals(node.getAvailability())) {
- return false;
- }
- // Consider node has at least one free slot
- return node.getSlots().stream().anyMatch(slot -> slot.getSession() == null);
- })
+ .filter(node -> UP.equals(node.getAvailability()) && node.hasCapacity())
.collect(toImmutableSet());
} finally {
readLock.unlock();
}
}Suggestion importance[1-10]: 6
__
Why: The suggestion correctly proposes using node.hasCapacity() to simplify the filter logic, which improves readability and aligns with its usage elsewhere in the PR.
| PR 16153 (2025-08-09) |
[possible issue] Scope version guard to Firefox
✅ Scope version guard to Firefox
The except guard mixes a version exclusion with browser exclusions but omits the browser key for the version condition. Add the browser: :firefox key to ensure the version comparison only applies to Firefox and doesn't accidentally affect other browsers.
rb/spec/integration/selenium/webdriver/manager_spec.rb [172-174]
-except: [{version: GlobalTestEnv.beta_browser_version(:firefox),
+except: [{browser: :firefox, version: GlobalTestEnv.beta_browser_version(:firefox),
reason: 'https://github.com/mozilla/geckodriver/issues/1842'},
{browser: %i[safari safari_preview]}]Suggestion importance[1-10]: 9
__
Why: This suggestion correctly identifies a bug introduced in the PR where removing the browser: :firefox key would cause the version exception to apply to all browsers, not just Firefox.
| PR 16151 (2025-08-09) |
[incremental [*]] Process all health check batches
✅ Process all health check batches
Ensure all batches are processed by removing the limit(maxConcurrentBatches) which drops excess batches, or implement a proper throttling mechanism that still visits every batch
java/src/org/openqa/selenium/grid/distributor/local/LocalNodeRegistry.java [402-422]
private void processBatchesInParallel(List<List<Runnable>> batches, int maxConcurrentBatches) {
if (batches.isEmpty()) {
return;
}
- // Process batches with controlled parallelism
batches.parallelStream()
- .limit(maxConcurrentBatches)
.forEach(
batch ->
batch.parallelStream()
.forEach(
r -> {
try {
r.run();
} catch (Throwable t) {
- LOG.log(
- getDebugLogLevel(), "Health check execution failed in batch", t);
+ LOG.log(getDebugLogLevel(), "Health check execution failed in batch", t);
}
}));
}Suggestion importance[1-10]: 9
__
Why: This suggestion identifies a critical bug where limit(maxConcurrentBatches) would cause health checks for some nodes to be skipped entirely, and the proposed fix correctly ensures all batches are processed.
[learned best practice] Simplify heartbeat timeout math
✅ Simplify heartbeat timeout math
Use consistent and clearer time calculations; avoid chained multiply/divide on Duration which can be error-prone. Replace with a single multiplication by half the multiplier to match intent and readability.
java/src/org/openqa/selenium/grid/distributor/local/LocalGridModel.java [245-247]
Instant lostTime =
- lastTouched.plus(
- node.getHeartbeatPeriod().multipliedBy(PURGE_TIMEOUT_MULTIPLIER).dividedBy(2));
+ lastTouched.plus(node.getHeartbeatPeriod().multipliedBy(PURGE_TIMEOUT_MULTIPLIER / 2));Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Fix syntax errors, typos, and naming inconsistencies to maintain code quality.
[incremental [*]] Cancel tasks and free resources
✅ Cancel tasks and free resources
Ensure scheduled tasks are cancelled and resources are released on close; cancel per-node futures and clear maps to prevent thread and memory leaks
java/src/org/openqa/selenium/grid/distributor/local/LocalNodeRegistry.java [535-539]
@Override
public void close() {
LOG.info("Shutting down LocalNodeRegistry");
+ Lock writeLock = lock.writeLock();
+ writeLock.lock();
+ try {
+ scheduledHealthChecks.values().forEach(f -> {
+ if (f != null) {
+ f.cancel(false);
+ }
+ });
+ scheduledHealthChecks.clear();
+ allChecks.clear();
+ nodes.values().forEach(n -> {
+ if (n instanceof RemoteNode) {
+ try {
+ ((RemoteNode) n).close();
+ } catch (Exception e) {
+ LOG.log(Level.WARNING, "Unable to close node properly: " + e.getMessage());
+ }
+ }
+ });
+ nodes.clear();
+ } finally {
+ writeLock.unlock();
+ }
}Suggestion importance[1-10]: 9
__
Why: The suggestion correctly points out a critical resource leak where scheduled health checks are not cancelled on close, which would prevent proper shutdown and cause memory leaks.
[possible issue] Use concurrent maps for health checks
✅ Use concurrent maps for health checks
Access to allChecks and scheduledHealthChecks occurs under locks but the maps themselves are non-concurrent. Replace them with concurrent maps to avoid accidental unsynchronized access paths and reduce risk of race conditions during listener callbacks. This is critical since listeners and scheduled tasks can run concurrently.
java/src/org/openqa/selenium/grid/distributor/local/LocalNodeRegistry.java [85-86]
-private final Map<NodeId, Runnable> allChecks = new HashMap<>();
-private final Map<NodeId, ScheduledFuture<?>> scheduledHealthChecks = new HashMap<>();
+private final Map<NodeId, Runnable> allChecks = new ConcurrentHashMap<>();
+private final Map<NodeId, ScheduledFuture<?>> scheduledHealthChecks = new ConcurrentHashMap<>();Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies that using ConcurrentHashMap for allChecks and scheduledHealthChecks improves robustness and maintainability in a highly concurrent class, reducing the risk of future errors.
[possible issue] Fix integer division in timing
✅ Fix integer division in timing
The division PURGE_TIMEOUT_MULTIPLIER / 2 performs integer division; for odd values it truncates and may degrade timing logic. Compute using long arithmetic to preserve intended scaling, e.g., multiply first or use exact constants.
java/src/org/openqa/selenium/grid/distributor/local/LocalGridModel.java [245-248]
Instant lostTime =
- lastTouched.plus(node.getHeartbeatPeriod().multipliedBy(PURGE_TIMEOUT_MULTIPLIER / 2));
+ lastTouched.plus(node.getHeartbeatPeriod().multipliedBy((long) PURGE_TIMEOUT_MULTIPLIER).dividedBy(2));
Instant deadTime =
- lastTouched.plus(node.getHeartbeatPeriod().multipliedBy(PURGE_TIMEOUT_MULTIPLIER));
+ lastTouched.plus(node.getHeartbeatPeriod().multipliedBy((long) PURGE_TIMEOUT_MULTIPLIER));Suggestion importance[1-10]: 5
__
Why: The suggestion correctly points out that integer division on PURGE_TIMEOUT_MULTIPLIER could lead to precision loss, and using long arithmetic or floating-point division would make the timing calculation more robust.
[learned best practice] Cancel tasks and close nodes
✅ Cancel tasks and close nodes
Ensure scheduled tasks are cancelled and nodes are closed on shutdown. Cancel futures in scheduledHealthChecks, clear listeners if needed, and close any RemoteNode instances to prevent resource leaks.
java/src/org/openqa/selenium/grid/distributor/local/LocalNodeRegistry.java [532-535]
@Override
public void close() {
LOG.info("Shutting down LocalNodeRegistry");
+ Lock writeLock = lock.writeLock();
+ writeLock.lock();
+ try {
+ // Cancel scheduled health checks
+ for (ScheduledFuture<?> future : scheduledHealthChecks.values()) {
+ if (future != null) {
+ future.cancel(false);
+ }
+ }
+ scheduledHealthChecks.clear();
+ allChecks.clear();
+ // Close remote nodes
+ for (Node node : nodes.values()) {
+ if (node instanceof RemoteNode) {
+ try {
+ ((RemoteNode) node).close();
+ } catch (Exception e) {
+ LOG.log(Level.WARNING, "Unable to close node properly: " + e.getMessage());
+ }
+ }
+ }
+ nodes.clear();
+ } finally {
+ writeLock.unlock();
+ }
}Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Properly dispose and clean up scheduled tasks and resources to prevent leaks.
[learned best practice] Add parameter null validation
✅ Add parameter null validation
Validate inputs before using them. Add null checks for nodeUri, id, and availability to avoid potential NullPointerExceptions during logging and model updates.
java/src/org/openqa/selenium/grid/distributor/local/LocalNodeRegistry.java [292-304]
public void updateNodeAvailability(URI nodeUri, NodeId id, Availability availability) {
+ Require.nonNull("Node URI", nodeUri);
+ Require.nonNull("Node ID", id);
+ Require.nonNull("Availability", availability);
Lock writeLock = lock.writeLock();
writeLock.lock();
try {
LOG.log(
getDebugLogLevel(),
String.format("Health check result for %s was %s", nodeUri, availability));
model.setAvailability(id, availability);
model.updateHealthCheckCount(id, availability);
} finally {
writeLock.unlock();
}
}Suggestion importance[1-10]: 5
__
Why: Relevant best practice - Add null checks and validation for parameters before use to prevent NullPointerException.
| PR 16136 (2025-08-06) |
[possible issue] Fix version constraint separator syntax
✅ Fix version constraint separator syntax
The version constraint uses a semicolon separator which is not standard for pip dependency specifications. Use comma separator instead for better compatibility across packaging tools.
-"urllib3[socks]>=2.5.0;<3.0",
+"urllib3[socks]>=2.5.0,<3.0",Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies an invalid separator in the urllib3 version specifier; using a semicolon instead of a comma would cause dependency resolution to fail.
[general] Use explicit version constraint format
✅ Use explicit version constraint format
The version constraint should use <3.0 instead of <3 for better clarity and consistency with semantic versioning practices. This makes the upper bound more explicit and follows common Python packaging conventions.
-"urllib3[socks]>=2.5.0;<3",
+"urllib3[socks]>=2.5.0,<3.0",Suggestion importance[1-10]: 8
__
Why: The suggestion corrects an invalid dependency specifier by changing the semicolon to a comma, which is crucial for correctness as per PEP 508.
| PR 16131 (2025-08-05) |
[general] Fix confusing property logic
✅ Fix confusing property logic
The property name LogTruncate is misleading since setting it to true actually disables truncation. Consider renaming to LogNoTruncate or inverting the logic to make the intent clearer.
dotnet/src/webdriver/Firefox/FirefoxDriverService.cs [202-205]
-if (this.LogTruncate)
+if (!this.LogTruncate)
{
argsBuilder.Append(" --log-no-truncate");
}Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies that the property name LogTruncate is confusing, as setting it to true disables truncation. This change would improve code clarity and maintainability.
| PR 16114 (2025-07-31) |
[possible issue] Fix missing comma in array
✅ Fix missing comma in array
Add a missing comma after "LICENSE" to properly separate the list items. Without the comma, this creates a syntax error in the TOML array.
-"LICENSE"
+"LICENSE",
"NOTICE"Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a missing comma in the TOML array, which is a syntax error that would cause the package build to fail.
| PR 16112 (2025-07-31) |
[general] Simplify dictionary building logic
✅ Simplify dictionary building logic
The method manually checks each attribute and builds the dictionary, which is repetitive and error-prone. Use a mapping approach to dynamically build the result dictionary from instance attributes.
py/selenium/webdriver/common/bidi/session.py [80-100]
def to_dict(self) -> Dict[str, str]:
"""Convert the UserPromptHandler to a dictionary for BiDi protocol.
Returns:
-------
Dict[str, str]: Dictionary representation suitable for BiDi protocol
"""
+ field_mapping = {
+ 'alert': 'alert',
+ 'before_unload': 'beforeUnload',
+ 'confirm': 'confirm',
+ 'default': 'default',
+ 'file': 'file',
+ 'prompt': 'prompt',
+ }
+
result = {}
- if self.alert is not None:
- result["alert"] = self.alert
- if self.before_unload is not None:
- result["beforeUnload"] = self.before_unload
- if self.confirm is not None:
- result["confirm"] = self.confirm
- if self.default is not None:
- result["default"] = self.default
- if self.file is not None:
- result["file"] = self.file
- if self.prompt is not None:
- result["prompt"] = self.prompt
+ for attr_name, dict_key in field_mapping.items():
+ value = getattr(self, attr_name)
+ if value is not None:
+ result[dict_key] = value
return resultSuggestion importance[1-10]: 5
__
Why: This suggestion improves maintainability by replacing a series of if statements with a more scalable, loop-based approach, making it easier to add new fields in the future.
| PR 16098 (2025-07-28) |
[general] Add enum validation before string conversion
✅ Add enum validation before string conversion
Add validation to ensure the enum value is defined before converting to string. This prevents potential issues if an invalid enum value is somehow assigned to LogLevel.
dotnet/src/webdriver/Chromium/ChromiumDriverService.cs [162-165]
if (this.LogLevel != ChromiumDriverLogLevel.Default)
{
- argsBuilder.Append(string.Format(CultureInfo.InvariantCulture, " --log-level={0}", this.LogLevel.ToString().ToUpperInvariant()));
+ if (Enum.IsDefined(typeof(ChromiumDriverLogLevel), this.LogLevel))
+ {
+ argsBuilder.Append($" --log-level={this.LogLevel.ToString().ToUpperInvariant()}");
+ }
}Suggestion importance[1-10]: 7
__
Why: This is a good defensive programming suggestion that improves robustness by validating the enum value, preventing potential errors if an undefined value is assigned to the public LogLevel property.
[general] Use string interpolation for cleaner code
✅ Use string interpolation for cleaner code
Consider using string interpolation instead of string.Format for better readability and performance. The current approach is unnecessarily verbose for a simple string concatenation.
dotnet/src/webdriver/Chromium/ChromiumDriverService.cs [164]
-argsBuilder.Append(string.Format(CultureInfo.InvariantCulture, " --log-level={0}", this.LogLevel.ToString().ToUpperInvariant()));
+argsBuilder.Append($" --log-level={this.LogLevel.ToString().ToUpperInvariant()}");Suggestion importance[1-10]: 4
__
Why: The suggestion to use string interpolation instead of string.Format is a valid style improvement that enhances code readability without changing functionality.
| PR 16097 (2025-07-28) |
[possible issue] Fix conditional redirection logic
✅ Fix conditional redirection logic
The redirection should be set unconditionally when LogPath is specified, not just when LogToConsole is true. This ensures proper log file functionality regardless of the LogToConsole state.
dotnet/src/webdriver/Firefox/FirefoxDriverService.cs [216-222]
// LogToConsole and LogPath are mutually exclusive. LogPath takes precedence.
-if (this.LogToConsole)
-{
- this.LogToConsole = false;
- eventArgs.DriverServiceProcessStartInfo.RedirectStandardOutput = true;
- eventArgs.DriverServiceProcessStartInfo.RedirectStandardError = true;
-}
+this.LogToConsole = false;
+eventArgs.DriverServiceProcessStartInfo.RedirectStandardOutput = true;
+eventArgs.DriverServiceProcessStartInfo.RedirectStandardError = true;Suggestion importance[1-10]: 9
__
Why: The suggestion correctly identifies a bug where setting the LogPath will not work as expected unless LogToConsole is also true, which is a significant flaw in the new logic.
| PR 16081 (2025-07-23) |
[possible issue] Add exception handling for async operations
✅ Add exception handling for async operations
The async method lacks exception handling which could cause unhandled exceptions to crash the application. Add try-catch blocks to handle potential I/O exceptions during stream reading and log writing operations.
dotnet/src/webdriver/Firefox/FirefoxDriverService.cs [346-356]
private async Task ReadStreamAsync(StreamReader reader)
{
- string? line;
- while ((line = await reader.ReadLineAsync()) != null)
+ try
{
- if (logWriter != null)
+ string? line;
+ while ((line = await reader.ReadLineAsync()) != null)
{
- logWriter.WriteLine($"{DateTime.Now:yyyy-MM-dd HH:mm:ss.fff} {line}");
+ if (logWriter != null)
+ {
+ logWriter.WriteLine($"{DateTime.Now:yyyy-MM-dd HH:mm:ss.fff} {line}");
+ }
}
+ }
+ catch (Exception ex)
+ {
+ // Log or handle the exception appropriately
+ System.Diagnostics.Debug.WriteLine($"Error reading stream: {ex.Message}");
}
}Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that the ReadStreamAsync method, being run as a fire-and-forget task, lacks exception handling, which could lead to unobserved exceptions and application instability.
[general] Set disposed field to null
✅ Set disposed field to null
The disposal logic should set the logWriter field to null after disposing to prevent potential use-after-dispose scenarios. This ensures the field cannot be accessed after disposal.
dotnet/src/webdriver/Firefox/FirefoxDriverService.cs [254-262]
protected override void Dispose(bool disposing)
{
if (logWriter != null && disposing)
{
logWriter.Dispose();
+ logWriter = null;
}
base.Dispose(disposing);
}Suggestion importance[1-10]: 5
__
Why: Setting the logWriter field to null after disposal is a good practice that improves code robustness by preventing potential use-after-dispose errors.
| PR 16070 (2025-07-18) |
[possible issue] Add missing coordinates/error validation
✅ Add missing coordinates/error validation
Add validation to ensure at least one of coordinates or error is specified. Currently, both can be null which would result in an invalid geolocation override request.
java/src/org/openqa/selenium/bidi/emulation/SetGeolocationOverrideParameters.java [41-50]
if (this.coordinates != null && this.error != null) {
throw new IllegalArgumentException("Cannot specify both coordinates and error");
+}
+if (this.coordinates == null && this.error == null) {
+ throw new IllegalArgumentException("Must specify either coordinates or error");
}
if (this.contexts != null && this.userContexts != null) {
throw new IllegalArgumentException("Cannot specify both contexts and userContexts");
}
if (this.contexts == null && this.userContexts == null) {
throw new IllegalArgumentException("Must specify either contexts or userContexts");
}Suggestion importance[1-10]: 8
__
Why: This suggestion correctly identifies a missing validation check that would prevent creating an invalid state where both coordinates and error are null, improving the robustness of the class.
| PR 16061 (2025-07-16) |
[possible issue] Handle potential None from regex
✅ Handle potential None from regex
The regex search could return None if the pattern doesn't match, causing an AttributeError when accessing index [1]. Add a check to handle cases where the URL format doesn't match the expected pattern.
scripts/update_multitool_binaries.py [40-42]
-version = re.search(f"download/(.*?)/{tool}", data[tool]["binaries"][0]["url"])[
- 1
-]
+version_match = re.search(f"download/(.*?)/{tool}", data[tool]["binaries"][0]["url"])
+if not version_match:
+ continue
+version = version_match[1]Suggestion importance[1-10]: 8
__
Why: This suggestion correctly identifies that re.search can return None, which would cause a TypeError, and provides a robust fix to prevent the script from crashing on unexpected URL formats.
[general] Use tag_name for version
✅ Use tag_name for version
Using .title assumes the release title contains the version, but GitHub releases often use .tag_name for version information. Consider using .tag_name instead for more reliable version extraction.
scripts/update_multitool_binaries.py [50-53]
try:
- new_version = Github().get_repo(user_repo).get_releases()[0].title
+ new_version = Github().get_repo(user_repo).get_releases()[0].tag_name
except Exception:
continueSuggestion importance[1-10]: 7
__
Why: The suggestion correctly points out that a release tag_name is generally a more reliable source for a version string than its title, improving the script's robustness for different GitHub repositories.
| PR 16048 (2025-07-13) |
[general] Use platform-appropriate path separator
✅ Use platform-appropriate path separator
The code assumes semicolon as the path separator, but this may not be correct on all platforms. On Unix-like systems, the path separator is typically a colon (:). Consider using Path.PathSeparator or detecting the platform-appropriate separator.
dotnet/src/webdriver/SeleniumManager.cs [105-111]
// Supporting .NET5+ applications deployed as self-contained applications (single file or AOT)
var nativeDllSearchDirectories = AppContext.GetData("NATIVE_DLL_SEARCH_DIRECTORIES")?.ToString();
if (nativeDllSearchDirectories is not null)
{
- probingPaths.AddRange(nativeDllSearchDirectories.Split(';').Select(path => Path.Combine(path, seleniumManagerFileName)));
+ probingPaths.AddRange(nativeDllSearchDirectories.Split(Path.PathSeparator).Select(path => Path.Combine(path, seleniumManagerFileName)));
}Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a cross-platform bug where a hardcoded Windows path separator (;) is used, and the proposed fix using Path.PathSeparator is essential for correctness on non-Windows systems.
[general] Use LINQ FirstOrDefault for consistency
✅ Use LINQ FirstOrDefault for consistency
The Find method returns null when no matching element is found, but the subsequent null check uses is null pattern. Consider using FirstOrDefault with LINQ for consistency with the added using System.Linq import, or keep the current approach but ensure consistent null checking patterns throughout the codebase.
dotnet/src/webdriver/SeleniumManager.cs [134-140]
-binaryFullPath = probingPaths.Find(path => File.Exists(path));
+binaryFullPath = probingPaths.FirstOrDefault(File.Exists);
if (binaryFullPath is null)
{
throw new FileNotFoundException(
$"Unable to locate Selenium Manager binary in the following paths: {string.Join(", ", probingPaths)}");
}Suggestion importance[1-10]: 3
__
Why: The suggestion correctly proposes using FirstOrDefault for consistency with the newly added System.Linq import, but this is a minor stylistic improvement with no functional impact.
[learned best practice] Add null validation for directory
✅ Add null validation for directory
The currentDirectory variable should be validated for null before being used in Path.Combine() calls. Add a null check to prevent potential NullReferenceException if AppContext.BaseDirectory returns null.
dotnet/src/webdriver/SeleniumManager.cs [82-89]
+ArgumentNullException.ThrowIfNull(currentDirectory);
+
binaryFullPath = platform switch
{
SupportedPlatform.Windows => Path.Combine(currentDirectory, "runtimes", "win", "native", "selenium-manager.exe"),
SupportedPlatform.Linux => Path.Combine(currentDirectory, "runtimes", "linux", "native", "selenium-manager"),
SupportedPlatform.MacOS => Path.Combine(currentDirectory, "runtimes", "osx", "native", "selenium-manager"),
_ => throw new PlatformNotSupportedException(
$"Selenium Manager doesn't support your runtime platform: {RuntimeInformation.OSDescription}"),
};Suggestion importance[1-10]: 6
__
Why: Relevant best practice - Add null checks and validation for parameters, properties, and return values before using them to prevent NullReferenceException and other runtime errors
| PR 16032 (2025-07-09) |
[general] Fix incorrect word usage
✅ Fix incorrect word usage
The word "preview" should be "purview" in this context. "Purview" means the scope or range of authority, while "preview" means a preliminary view or showing.
dotnet/src/webdriver/PinnedScript.cs [36-40]
/// <remarks>
/// This constructor is explicitly internal. Creation of pinned script objects
-/// is strictly the preview of Selenium, and should not be required by external
+/// is strictly the purview of Selenium, and should not be required by external
/// libraries.
/// </remarks>Suggestion importance[1-10]: 3
__
Why: The suggestion correctly identifies that the word preview is used incorrectly in the comment, and the correct word should be purview.
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