[grid] Fix DefaultSlotMatcher matching requests differentiated only by undeclared automationName #17898
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| // 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. | ||
|
|
||
| package org.openqa.selenium.grid.data; | ||
|
|
||
| import java.io.Serializable; | ||
| import java.util.Objects; | ||
| import org.openqa.selenium.Capabilities; | ||
|
|
||
| /** | ||
| * Opt-in matching implementation for Nodes that relay sessions to an Appium server. Unlike {@link | ||
| * DefaultSlotMatcher}, a stereotype that advertises Appium-awareness (an {@code appium:}-prefixed | ||
| * capability, or the non-W3C {@code platformVersion} signal) is treated as a wildcard for | ||
| * automationName, and a request carrying app-relay capabilities ({@link | ||
| * DefaultSlotMatcher#SPECIFIC_RELAY_CAPABILITIES_APP}) bypasses browserName/browserVersion | ||
| * matching. This lets a single relay slot serve varied automation frameworks and hybrid | ||
| * browser/native-app requests without the operator enumerating every client value in the | ||
| * stereotype. | ||
| * | ||
| * <p>Configure a Node to use this matcher instead of the default with: | ||
| * | ||
| * <pre> | ||
| * [distributor] | ||
| * slot-matcher = "org.openqa.selenium.grid.data.AppiumRelaySlotMatcher" | ||
| * </pre> | ||
| */ | ||
| public class AppiumRelaySlotMatcher implements SlotMatcher, Serializable { | ||
|
|
||
| private final DefaultSlotMatcher strict = new DefaultSlotMatcher(); | ||
|
|
||
| @Override | ||
| public boolean matches(Capabilities stereotype, Capabilities capabilities) { | ||
|
|
||
| if (capabilities.asMap().isEmpty()) { | ||
| return false; | ||
| } | ||
|
|
||
| if (!strict.initialMatch(stereotype, capabilities)) { | ||
| return false; | ||
| } | ||
|
|
||
| if (!strict.managedDownloadsEnabled(stereotype, capabilities)) { | ||
| return false; | ||
| } | ||
|
|
||
| if (!strict.extensionCapabilitiesMatch(stereotype, capabilities)) { | ||
| return false; | ||
|
Comment on lines
+60
to
+61
Contributor
There was a problem hiding this comment. 5. Relay wildcard check is preempted AppiumRelaySlotMatcher runs strict extension matching before its wildcard automationName check, so a stereotype advertising appium:automationName=UiAutomator2 still rejects a request for another framework. This contradicts the new matcher's documented promise that Appium-aware stereotypes act as automationName wildcards for varied frameworks. Agent Prompt
|
||
| } | ||
|
|
||
| if (!automationNameMatch(stereotype, capabilities)) { | ||
| return false; | ||
| } | ||
|
|
||
| if (!strict.platformVersionMatch(stereotype, capabilities)) { | ||
| return false; | ||
| } | ||
|
|
||
| boolean browserNameMatch = | ||
| (capabilities.getBrowserName() == null || capabilities.getBrowserName().isEmpty()) | ||
| || Objects.equals(stereotype.getBrowserName(), capabilities.getBrowserName()) | ||
| || DefaultSlotMatcher.matchConditionToRemoveCapability(capabilities); | ||
| boolean browserVersionMatch = | ||
| (capabilities.getBrowserVersion() == null | ||
| || capabilities.getBrowserVersion().isEmpty() | ||
| || Objects.equals(capabilities.getBrowserVersion(), "stable")) | ||
| || strict.browserVersionMatch( | ||
| stereotype.getBrowserVersion(), capabilities.getBrowserVersion()) | ||
| || DefaultSlotMatcher.matchConditionToRemoveCapability(capabilities); | ||
|
Comment on lines
+80
to
+82
Contributor
There was a problem hiding this comment. 2. browserversion bypass remains untested The new matcher bypasses browserVersion mismatches for app-relay requests, but its new test class contains no scenario with browser versions. A regression in this advertised behavior could therefore pass the test suite unnoticed. Agent Prompt
|
||
| boolean platformNameMatch = | ||
| capabilities.getPlatformName() == null | ||
| || Objects.equals(stereotype.getPlatformName(), capabilities.getPlatformName()) | ||
| || (stereotype.getPlatformName() != null | ||
| && stereotype.getPlatformName().is(capabilities.getPlatformName())); | ||
| return browserNameMatch && browserVersionMatch && platformNameMatch; | ||
| } | ||
|
|
||
| private boolean automationNameMatch(Capabilities stereotype, Capabilities capabilities) { | ||
| /* | ||
| A stereotype with no Appium-related capabilities at all has no relationship to a | ||
| requested automationName, so it should not match. Otherwise, an Appium-aware | ||
| stereotype is allowed to omit automationName and still match, since relay | ||
| stereotypes intentionally do this to serve varied automation sessions. | ||
| */ | ||
| boolean stereotypeIsAppiumAware = | ||
| stereotype.getCapabilityNames().stream() | ||
| .anyMatch(name -> name.contains("platformVersion") || name.startsWith("appium:")); | ||
| return stereotypeIsAppiumAware || DefaultSlotMatcher.automationNameValue(capabilities) == null; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. matches lacks javadoc
📘 Rule violation✧ QualityAgent Prompt
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools