Skip to content

Commit

Permalink
Add JSON serialization for ShadowRoot
Browse files Browse the repository at this point in the history
  • Loading branch information
sbabcoc committed Mar 12, 2024
1 parent ad17dd2 commit 31de941
Show file tree
Hide file tree
Showing 9 changed files with 101 additions and 94 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,4 @@ bazel-testlogs
javascript/node/selenium-webdriver/.vscode/settings.json

dotnet-bin
.metadata/
1 change: 0 additions & 1 deletion java/src/org/openqa/selenium/remote/RemoteWebDriver.java
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@
import org.openqa.selenium.remote.http.ClientConfig;
import org.openqa.selenium.remote.http.ConnectionFailedException;
import org.openqa.selenium.remote.http.HttpClient;
import org.openqa.selenium.remote.internal.WebElementToJsonConverter;
import org.openqa.selenium.remote.tracing.TracedHttpClient;
import org.openqa.selenium.remote.tracing.Tracer;
import org.openqa.selenium.remote.tracing.opentelemetry.OpenTelemetryTracer;
Expand Down
93 changes: 93 additions & 0 deletions java/src/org/openqa/selenium/remote/WebElementToJsonConverter.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
// 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.remote;

import static java.util.stream.Collectors.toList;

import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import org.openqa.selenium.WrapsElement;

/**
* Converts {@link RemoteWebElement} objects, which may be {@link WrapsElement wrapped}, into their
* JSON representation as defined by the WebDriver wire protocol. This class will recursively
* convert Lists and Maps to catch nested references.
*
* @see <a
* href="https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#webelement-json-object">
* WebDriver JSON Wire Protocol</a>
*/
public class WebElementToJsonConverter implements Function<Object, Object> {
@Override
public Object apply(Object arg) {
if (arg == null || arg instanceof String || arg instanceof Boolean || arg instanceof Number) {
return arg;
}

while (arg instanceof WrapsElement) {
arg = ((WrapsElement) arg).getWrappedElement();
}

if (arg instanceof RemoteWebElement) {
return Map.of(Dialect.W3C.getEncodedElementKey(), ((RemoteWebElement) arg).getId());
}

if (arg instanceof ShadowRoot) {
return Map.of(Dialect.W3C.getShadowRootElementKey(), ((ShadowRoot) arg).getId());
}

if (arg.getClass().isArray()) {
arg = arrayToList(arg);
}

if (arg instanceof Collection<?>) {
Collection<?> args = (Collection<?>) arg;
return args.stream().map(this).collect(toList());
}

if (arg instanceof Map<?, ?>) {
Map<?, ?> args = (Map<?, ?>) arg;
Map<String, Object> converted = new HashMap<>(args.size());
for (Map.Entry<?, ?> entry : args.entrySet()) {
Object key = entry.getKey();
if (!(key instanceof String)) {
throw new IllegalArgumentException(
"All keys in Map script arguments must be strings: " + key.getClass().getName());
}
converted.put((String) key, apply(entry.getValue()));
}
return converted;
}

throw new IllegalArgumentException(
"Argument is of an illegal type: " + arg.getClass().getName());
}

private static List<Object> arrayToList(Object array) {
List<Object> list = new ArrayList<>();
for (int i = 0; i < Array.getLength(array); i++) {
list.add(Array.get(array, i));
}
return list;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
import org.openqa.selenium.InvalidSelectorException;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.remote.codec.AbstractHttpCommandCodec;
import org.openqa.selenium.remote.internal.WebElementToJsonConverter;
import org.openqa.selenium.remote.WebElementToJsonConverter;

/**
* A command codec that adheres to the W3C's WebDriver wire protocol.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,75 +17,9 @@

package org.openqa.selenium.remote.internal;

import static java.util.stream.Collectors.toList;

import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import org.openqa.selenium.WrapsElement;
import org.openqa.selenium.remote.Dialect;
import org.openqa.selenium.remote.RemoteWebElement;

/**
* Converts {@link RemoteWebElement} objects, which may be {@link WrapsElement wrapped}, into their
* JSON representation as defined by the WebDriver wire protocol. This class will recursively
* convert Lists and Maps to catch nested references.
*
* @see <a
* href="https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#webelement-json-object">
* WebDriver JSON Wire Protocol</a>
* {@inheritDoc}
* @deprecated This class has moved to a {@link org.openqa.selenium.remote.WebElementToJsonConverter new location}.
*/
public class WebElementToJsonConverter implements Function<Object, Object> {
@Override
public Object apply(Object arg) {
if (arg == null || arg instanceof String || arg instanceof Boolean || arg instanceof Number) {
return arg;
}

while (arg instanceof WrapsElement) {
arg = ((WrapsElement) arg).getWrappedElement();
}

if (arg instanceof RemoteWebElement) {
return Map.of(Dialect.W3C.getEncodedElementKey(), ((RemoteWebElement) arg).getId());
}

if (arg.getClass().isArray()) {
arg = arrayToList(arg);
}

if (arg instanceof Collection<?>) {
Collection<?> args = (Collection<?>) arg;
return args.stream().map(this).collect(toList());
}

if (arg instanceof Map<?, ?>) {
Map<?, ?> args = (Map<?, ?>) arg;
Map<String, Object> converted = new HashMap<>(args.size());
for (Map.Entry<?, ?> entry : args.entrySet()) {
Object key = entry.getKey();
if (!(key instanceof String)) {
throw new IllegalArgumentException(
"All keys in Map script arguments must be strings: " + key.getClass().getName());
}
converted.put((String) key, apply(entry.getValue()));
}
return converted;
}

throw new IllegalArgumentException(
"Argument is of an illegal type: " + arg.getClass().getName());
}

private static List<Object> arrayToList(Object array) {
List<Object> list = new ArrayList<>();
for (int i = 0; i < Array.getLength(array); i++) {
list.add(Array.get(array, i));
}
return list;
}
public class WebElementToJsonConverter extends org.openqa.selenium.remote.WebElementToJsonConverter {
}
1 change: 1 addition & 0 deletions java/test/org/openqa/selenium/remote/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ java_test_suite(
"//java/src/org/openqa/selenium/json",
"//java/src/org/openqa/selenium/remote",
"//java/src/org/openqa/selenium/support",
"//java/test/org/openqa/selenium:helpers",
"//java/test/org/openqa/selenium/testing:annotations",
artifact("org.assertj:assertj-core"),
artifact("com.google.guava:guava"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
// specific language governing permissions and limitations
// under the License.

package org.openqa.selenium.remote.internal;
package org.openqa.selenium.remote;

import static java.util.Arrays.asList;
import static org.assertj.core.api.Assertions.assertThat;
Expand All @@ -29,8 +29,6 @@
import org.junit.jupiter.api.Test;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.WrappedWebElement;
import org.openqa.selenium.remote.Dialect;
import org.openqa.selenium.remote.RemoteWebElement;

class WebElementToJsonConverterTest {

Expand Down
19 changes: 0 additions & 19 deletions java/test/org/openqa/selenium/remote/internal/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,3 @@ java_library(
artifact("io.netty:netty-transport"),
] + JUNIT5_DEPS,
)

java_test_suite(
name = "SmallTests",
size = "small",
srcs = glob(["*Test.java"]),
tags = [
"no-sandbox",
],
deps = [
":test-lib",
"//java/src/org/openqa/selenium:core",
"//java/src/org/openqa/selenium/remote",
"//java/src/org/openqa/selenium/remote/http",
"//java/test/org/openqa/selenium:helpers",
artifact("org.assertj:assertj-core"),
artifact("com.google.guava:guava"),
artifact("org.junit.jupiter:junit-jupiter-api"),
] + JUNIT5_DEPS,
)
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.RemoteWebElement;
import org.openqa.selenium.remote.internal.WebElementToJsonConverter;
import org.openqa.selenium.remote.WebElementToJsonConverter;
import org.openqa.selenium.support.ByIdOrName;
import org.openqa.selenium.support.CacheLookup;
import org.openqa.selenium.support.FindBy;
Expand Down

0 comments on commit 31de941

Please sign in to comment.