From 36b7413c559761bb431d40e87a3469c3d6a6ce70 Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 2 Jun 2022 06:03:58 +0200 Subject: [PATCH 1/6] fix: Add prefix to platformVersion capability name --- .../java_client/remote/options/BaseOptions.java | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/main/java/io/appium/java_client/remote/options/BaseOptions.java b/src/main/java/io/appium/java_client/remote/options/BaseOptions.java index c157fc684..50011c7a7 100644 --- a/src/main/java/io/appium/java_client/remote/options/BaseOptions.java +++ b/src/main/java/io/appium/java_client/remote/options/BaseOptions.java @@ -27,6 +27,8 @@ import javax.annotation.Nullable; import java.lang.reflect.Constructor; import java.lang.reflect.InvocationTargetException; +import java.util.Collections; +import java.util.List; import java.util.Map; import java.util.Optional; import java.util.stream.Collectors; @@ -52,6 +54,10 @@ public class BaseOptions> extends MutableCapabilities i SupportsBrowserNameOption, SupportsPlatformVersionOption { private static final AcceptedW3CCapabilityKeys W3C_KEY_PATTERNS = new AcceptedW3CCapabilityKeys(); + // TODO: This is an ugly workaround for another Selenium workaround, + // which includes `platformVersion` into W3C key patterns even though + // this particular capability name is not a part of the standard + private static final List EXCLUDED_KEYS = Collections.singletonList("platformVersion"); /** * Creates new instance with no preset capabilities. @@ -145,7 +151,10 @@ public T clone() { @Override public void setCapability(String key, @Nullable Object value) { Require.nonNull("Capability name", key); - super.setCapability(W3C_KEY_PATTERNS.test(key) ? key : APPIUM_PREFIX + key, value); + String w3cName = W3C_KEY_PATTERNS.test(key) && !EXCLUDED_KEYS.contains(key) + ? key + : APPIUM_PREFIX + key; + super.setCapability(w3cName, value); } @Override From 00521d360eedb9d5ac24d2991fbdabb3679b7bf1 Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 2 Jun 2022 06:30:16 +0200 Subject: [PATCH 2/6] simplify --- .../AppiumNewSessionCommandPayload.java | 13 ++--- .../remote/options/BaseOptions.java | 33 ++++++------ .../remote/options/W3CCapabilityKeys.java | 53 +++++++++++++++++++ 3 files changed, 73 insertions(+), 26 deletions(-) create mode 100644 src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java diff --git a/src/main/java/io/appium/java_client/remote/AppiumNewSessionCommandPayload.java b/src/main/java/io/appium/java_client/remote/AppiumNewSessionCommandPayload.java index 5ebbdfbc3..ff926ae9e 100644 --- a/src/main/java/io/appium/java_client/remote/AppiumNewSessionCommandPayload.java +++ b/src/main/java/io/appium/java_client/remote/AppiumNewSessionCommandPayload.java @@ -18,19 +18,16 @@ import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; +import io.appium.java_client.remote.options.BaseOptions; import org.openqa.selenium.Capabilities; import org.openqa.selenium.internal.Require; -import org.openqa.selenium.AcceptedW3CCapabilityKeys; import org.openqa.selenium.remote.CommandPayload; import java.util.Map; -import static io.appium.java_client.internal.CapabilityHelpers.APPIUM_PREFIX; import static org.openqa.selenium.remote.DriverCommand.NEW_SESSION; public class AppiumNewSessionCommandPayload extends CommandPayload { - private static final AcceptedW3CCapabilityKeys ACCEPTED_W3C_PATTERNS = new AcceptedW3CCapabilityKeys(); - /** * Appends "appium:" prefix to all non-prefixed non-standard capabilities. * @@ -40,10 +37,10 @@ public class AppiumNewSessionCommandPayload extends CommandPayload { private static Map makeW3CSafe(Capabilities possiblyInvalidCapabilities) { return Require.nonNull("Capabilities", possiblyInvalidCapabilities) .asMap().entrySet().stream() - .collect(ImmutableMap.toImmutableMap(entry -> ACCEPTED_W3C_PATTERNS.test(entry.getKey()) - ? entry.getKey() - : APPIUM_PREFIX + entry.getKey(), - Map.Entry::getValue)); + .collect(ImmutableMap.toImmutableMap( + entry -> BaseOptions.toW3cName(entry.getKey()), + Map.Entry::getValue + )); } /** diff --git a/src/main/java/io/appium/java_client/remote/options/BaseOptions.java b/src/main/java/io/appium/java_client/remote/options/BaseOptions.java index 50011c7a7..b424aa5f9 100644 --- a/src/main/java/io/appium/java_client/remote/options/BaseOptions.java +++ b/src/main/java/io/appium/java_client/remote/options/BaseOptions.java @@ -21,14 +21,11 @@ import org.openqa.selenium.Platform; import org.openqa.selenium.WebDriverException; import org.openqa.selenium.internal.Require; -import org.openqa.selenium.AcceptedW3CCapabilityKeys; import org.openqa.selenium.remote.CapabilityType; import javax.annotation.Nullable; import java.lang.reflect.Constructor; import java.lang.reflect.InvocationTargetException; -import java.util.Collections; -import java.util.List; import java.util.Map; import java.util.Optional; import java.util.stream.Collectors; @@ -53,11 +50,6 @@ public class BaseOptions> extends MutableCapabilities i SupportsNewCommandTimeoutOption, SupportsBrowserNameOption, SupportsPlatformVersionOption { - private static final AcceptedW3CCapabilityKeys W3C_KEY_PATTERNS = new AcceptedW3CCapabilityKeys(); - // TODO: This is an ugly workaround for another Selenium workaround, - // which includes `platformVersion` into W3C key patterns even though - // this particular capability name is not a part of the standard - private static final List EXCLUDED_KEYS = Collections.singletonList("platformVersion"); /** * Creates new instance with no preset capabilities. @@ -115,8 +107,7 @@ public Platform getPlatformName() { @Override public Map asMap() { return unmodifiableMap(super.asMap().entrySet().stream() - .collect(Collectors.toMap(entry -> W3C_KEY_PATTERNS.test(entry.getKey()) - ? entry.getKey() : APPIUM_PREFIX + entry.getKey(), Map.Entry::getValue) + .collect(Collectors.toMap(entry -> toW3cName(entry.getKey()), Map.Entry::getValue) )); } @@ -151,19 +142,25 @@ public T clone() { @Override public void setCapability(String key, @Nullable Object value) { Require.nonNull("Capability name", key); - String w3cName = W3C_KEY_PATTERNS.test(key) && !EXCLUDED_KEYS.contains(key) - ? key - : APPIUM_PREFIX + key; - super.setCapability(w3cName, value); + super.setCapability(toW3cName(key), value); } @Override @Nullable public Object getCapability(String capabilityName) { Object value = super.getCapability(capabilityName); - if (value == null) { - value = super.getCapability(APPIUM_PREFIX + capabilityName); - } - return value; + return value == null + ? super.getCapability(APPIUM_PREFIX + capabilityName) + : value; + } + + /** + * Adds the 'appium:' prefix to the given capability name if necessary. + * + * @param capName the original capability name. + * @return The preformatted W3C-compatible capability name. + */ + public static String toW3cName(String capName) { + return W3CCapabilityKeys.getInstance().test(capName) ? capName : APPIUM_PREFIX + capName; } } \ No newline at end of file diff --git a/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java b/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java new file mode 100644 index 000000000..02105a237 --- /dev/null +++ b/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java @@ -0,0 +1,53 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * See the NOTICE file distributed with this work for additional + * information regarding copyright ownership. + * 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 io.appium.java_client.remote.options; + +import java.util.function.Predicate; +import java.util.regex.Pattern; +import java.util.stream.Stream; + +public class W3CCapabilityKeys implements Predicate { + private static W3CCapabilityKeys instance = null; + private static final Predicate ACCEPTED_W3C_PATTERNS = Stream.of( + "^[\\w-]+:.*$", + "^acceptInsecureCerts$", + "^browserName$", + "^browserVersion$", + "^platformName$", + "^pageLoadStrategy$", + "^proxy$", + "^setWindowRect$", + "^strictFileInteractability$", + "^timeouts$", + "^unhandledPromptBehavior$", + "^webSocketUrl$") // from webdriver-bidi + .map(Pattern::compile) + .map(Pattern::asPredicate) + .reduce(identity -> false, Predicate::or); + + @Override + public boolean test(String capabilityName) { + return ACCEPTED_W3C_PATTERNS.test(capabilityName); + } + + public static synchronized W3CCapabilityKeys getInstance() { + if (instance == null) { + instance = new W3CCapabilityKeys(); + } + return instance; + } +} From 6087bd11137309bb68110c74cb7068e28fa717ce Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 2 Jun 2022 06:46:20 +0200 Subject: [PATCH 3/6] Fix checkstyle --- .../java_client/remote/AppiumNewSessionCommandPayload.java | 4 ++-- .../appium/java_client/remote/options/W3CCapabilityKeys.java | 5 +++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/src/main/java/io/appium/java_client/remote/AppiumNewSessionCommandPayload.java b/src/main/java/io/appium/java_client/remote/AppiumNewSessionCommandPayload.java index ff926ae9e..a57170d6c 100644 --- a/src/main/java/io/appium/java_client/remote/AppiumNewSessionCommandPayload.java +++ b/src/main/java/io/appium/java_client/remote/AppiumNewSessionCommandPayload.java @@ -38,8 +38,8 @@ private static Map makeW3CSafe(Capabilities possiblyInvalidCapab return Require.nonNull("Capabilities", possiblyInvalidCapabilities) .asMap().entrySet().stream() .collect(ImmutableMap.toImmutableMap( - entry -> BaseOptions.toW3cName(entry.getKey()), - Map.Entry::getValue + entry -> BaseOptions.toW3cName(entry.getKey()), + Map.Entry::getValue )); } diff --git a/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java b/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java index 02105a237..104fab683 100644 --- a/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java +++ b/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java @@ -44,6 +44,11 @@ public boolean test(String capabilityName) { return ACCEPTED_W3C_PATTERNS.test(capabilityName); } + /** + * Returns class singleton instance. + * + * @return Singleton object. + */ public static synchronized W3CCapabilityKeys getInstance() { if (instance == null) { instance = new W3CCapabilityKeys(); From 68cdf873cfab40422d32c4b51998beaaeca6598f Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 2 Jun 2022 09:12:03 +0200 Subject: [PATCH 4/6] Make it non-lazy --- .../java_client/remote/options/BaseOptions.java | 2 +- .../remote/options/W3CCapabilityKeys.java | 14 +------------- 2 files changed, 2 insertions(+), 14 deletions(-) diff --git a/src/main/java/io/appium/java_client/remote/options/BaseOptions.java b/src/main/java/io/appium/java_client/remote/options/BaseOptions.java index b424aa5f9..7ef52b7e4 100644 --- a/src/main/java/io/appium/java_client/remote/options/BaseOptions.java +++ b/src/main/java/io/appium/java_client/remote/options/BaseOptions.java @@ -161,6 +161,6 @@ public Object getCapability(String capabilityName) { * @return The preformatted W3C-compatible capability name. */ public static String toW3cName(String capName) { - return W3CCapabilityKeys.getInstance().test(capName) ? capName : APPIUM_PREFIX + capName; + return W3CCapabilityKeys.INSTANCE.test(capName) ? capName : APPIUM_PREFIX + capName; } } \ No newline at end of file diff --git a/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java b/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java index 104fab683..300e1b714 100644 --- a/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java +++ b/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java @@ -21,7 +21,7 @@ import java.util.stream.Stream; public class W3CCapabilityKeys implements Predicate { - private static W3CCapabilityKeys instance = null; + public static final W3CCapabilityKeys INSTANCE = new W3CCapabilityKeys(); private static final Predicate ACCEPTED_W3C_PATTERNS = Stream.of( "^[\\w-]+:.*$", "^acceptInsecureCerts$", @@ -43,16 +43,4 @@ public class W3CCapabilityKeys implements Predicate { public boolean test(String capabilityName) { return ACCEPTED_W3C_PATTERNS.test(capabilityName); } - - /** - * Returns class singleton instance. - * - * @return Singleton object. - */ - public static synchronized W3CCapabilityKeys getInstance() { - if (instance == null) { - instance = new W3CCapabilityKeys(); - } - return instance; - } } From 5966d18c255fec4a1a18b98ee323faaf2a44b0c1 Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 2 Jun 2022 09:22:03 +0200 Subject: [PATCH 5/6] Add constructor --- .../io/appium/java_client/remote/options/W3CCapabilityKeys.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java b/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java index 300e1b714..3d8e8fad3 100644 --- a/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java +++ b/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java @@ -39,6 +39,8 @@ public class W3CCapabilityKeys implements Predicate { .map(Pattern::asPredicate) .reduce(identity -> false, Predicate::or); + protected W3CCapabilityKeys () {} + @Override public boolean test(String capabilityName) { return ACCEPTED_W3C_PATTERNS.test(capabilityName); From 4c6685578f8437c342236df11a7ce1762df5558b Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 2 Jun 2022 09:28:29 +0200 Subject: [PATCH 6/6] styling --- .../appium/java_client/remote/options/W3CCapabilityKeys.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java b/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java index 3d8e8fad3..b29150311 100644 --- a/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java +++ b/src/main/java/io/appium/java_client/remote/options/W3CCapabilityKeys.java @@ -39,7 +39,8 @@ public class W3CCapabilityKeys implements Predicate { .map(Pattern::asPredicate) .reduce(identity -> false, Predicate::or); - protected W3CCapabilityKeys () {} + protected W3CCapabilityKeys() { + } @Override public boolean test(String capabilityName) {