org.openqa.selenium.remote.NewSessionPayload Maven / Gradle / Ivy
Show all versions of selenium-remote-driver Show documentation
// 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.nio.charset.StandardCharsets.UTF_8;
import static org.openqa.selenium.json.Json.LIST_OF_MAPS_TYPE;
import static org.openqa.selenium.json.Json.MAP_TYPE;
import static org.openqa.selenium.remote.CapabilityType.PLATFORM;
import static org.openqa.selenium.remote.CapabilityType.PLATFORM_NAME;
import static org.openqa.selenium.remote.CapabilityType.PROXY;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.Ordering;
import com.google.common.collect.Sets;
import com.google.common.io.CharSource;
import com.google.common.io.CharStreams;
import com.google.common.io.FileBackedOutputStream;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.ImmutableCapabilities;
import org.openqa.selenium.Proxy;
import org.openqa.selenium.json.Json;
import org.openqa.selenium.json.JsonInput;
import org.openqa.selenium.json.JsonOutput;
import org.openqa.selenium.remote.session.CapabilitiesFilter;
import org.openqa.selenium.remote.session.CapabilityTransform;
import org.openqa.selenium.remote.session.ChromeFilter;
import org.openqa.selenium.remote.session.EdgeFilter;
import org.openqa.selenium.remote.session.FirefoxFilter;
import org.openqa.selenium.remote.session.InternetExplorerFilter;
import org.openqa.selenium.remote.session.OperaFilter;
import org.openqa.selenium.remote.session.ProxyTransform;
import org.openqa.selenium.remote.session.SafariFilter;
import org.openqa.selenium.remote.session.StripAnyPlatform;
import org.openqa.selenium.remote.session.W3CPlatformNameNormaliser;
import java.io.Closeable;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Reader;
import java.io.StringReader;
import java.io.UncheckedIOException;
import java.io.Writer;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Queue;
import java.util.ServiceLoader;
import java.util.Set;
import java.util.TreeMap;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;
public class NewSessionPayload implements Closeable {
private final Set adapters;
private final Set transforms;
private static final Dialect DEFAULT_DIALECT = Dialect.OSS;
private final static Predicate ACCEPTED_W3C_PATTERNS = new AcceptedW3CCapabilityKeys();
private final Json json = new Json();
private final FileBackedOutputStream backingStore;
private final ImmutableSet dialects;
public static NewSessionPayload create(Capabilities caps) {
// We need to convert the capabilities into a new session payload. At this point we're dealing
// with references, so I'm Just Sure This Will Be Fine.
return create(ImmutableMap.of("desiredCapabilities", caps.asMap()));
}
public static NewSessionPayload create(Map source) {
Objects.requireNonNull(source, "Payload must be set");
String json = new Json().toJson(source);
return new NewSessionPayload(new StringReader(json));
}
public static NewSessionPayload create(Reader source) {
return new NewSessionPayload(source);
}
private NewSessionPayload(Reader source) {
// Dedicate up to 10% of all RAM or 20% of available RAM (whichever is smaller) to storing this
// payload.
int threshold = (int) Math.min(
Integer.MAX_VALUE,
Math.min(
Runtime.getRuntime().freeMemory() / 5,
Runtime.getRuntime().maxMemory() / 10));
backingStore = new FileBackedOutputStream(threshold);
try (Writer writer = new OutputStreamWriter(backingStore, UTF_8)) {
CharStreams.copy(source, writer);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
ImmutableSet.Builder adapters = ImmutableSet.builder();
ServiceLoader.load(CapabilitiesFilter.class).forEach(adapters::add);
adapters
.add(new ChromeFilter())
.add(new EdgeFilter())
.add(new FirefoxFilter())
.add(new InternetExplorerFilter())
.add(new OperaFilter())
.add(new SafariFilter());
this.adapters = adapters.build();
ImmutableSet.Builder transforms = ImmutableSet.builder();
ServiceLoader.load(CapabilityTransform.class).forEach(transforms::add);
transforms
.add(new ProxyTransform())
.add(new StripAnyPlatform())
.add(new W3CPlatformNameNormaliser());
this.transforms = transforms.build();
ImmutableSet.Builder dialects = ImmutableSet.builder();
try {
if (getOss() != null) {
dialects.add(Dialect.OSS);
}
if (getAlwaysMatch() != null || getFirstMatches() != null) {
dialects.add(Dialect.W3C);
}
this.dialects = dialects.build();
validate();
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
private void validate() throws IOException {
Map alwaysMatch = getAlwaysMatch();
if (alwaysMatch == null) {
alwaysMatch = ImmutableMap.of();
}
Map always = alwaysMatch;
Collection> firsts = getFirstMatches();
if (firsts == null) {
firsts = ImmutableList.of(ImmutableMap.of());
}
if (firsts.isEmpty()) {
throw new IllegalArgumentException("First match w3c capabilities is zero length");
}
firsts.stream()
.peek(map -> {
Set overlap = Sets.intersection(always.keySet(), map.keySet());
if (!overlap.isEmpty()) {
throw new IllegalArgumentException(
"Overlapping keys between w3c always and first match capabilities: " + overlap);
}
})
.map(first -> {
Map toReturn = new HashMap<>();
toReturn.putAll(always);
toReturn.putAll(first);
return toReturn;
})
.peek(map -> {
ImmutableSortedSet nullKeys = map.entrySet().stream()
.filter(entry -> entry.getValue() == null)
.map(Map.Entry::getKey)
.collect(ImmutableSortedSet.toImmutableSortedSet(Ordering.natural()));
if (!nullKeys.isEmpty()) {
throw new IllegalArgumentException(
"Null values found in w3c capabilities. Keys are: " + nullKeys);
}
})
.peek(map -> {
ImmutableSortedSet illegalKeys = map.entrySet().stream()
.filter(entry -> !ACCEPTED_W3C_PATTERNS.test(entry.getKey()))
.map(Map.Entry::getKey)
.collect(ImmutableSortedSet.toImmutableSortedSet(Ordering.natural()));
if (!illegalKeys.isEmpty()) {
throw new IllegalArgumentException(
"Illegal key values seen in w3c capabilities: " + illegalKeys);
}
})
.forEach(map -> {});
}
public void writeTo(Appendable appendable) throws IOException {
try (JsonOutput json = new Json().newOutput(appendable)) {
json.beginObject();
Map first = getOss();
if (first == null) {
//noinspection unchecked
first = stream().findFirst()
.orElse(new ImmutableCapabilities())
.asMap();
}
Map ossFirst = new HashMap<>(first);
if (first.containsKey(CapabilityType.PROXY)) {
Map proxyMap;
Object rawProxy = first.get(CapabilityType.PROXY);
if (rawProxy instanceof Proxy) {
proxyMap = ((Proxy) rawProxy).toJson();
} else if (rawProxy instanceof Map) {
proxyMap = (Map) rawProxy;
} else {
proxyMap = new HashMap<>();
}
if (proxyMap.containsKey("noProxy")) {
Map ossProxyMap = new HashMap<>(proxyMap);
Object rawData = proxyMap.get("noProxy");
if (rawData instanceof List) {
ossProxyMap.put("noProxy", String.join(",", ((List) rawData)));
}
ossFirst.put(CapabilityType.PROXY, ossProxyMap);
}
}
// Write the first capability we get as the desired capability.
json.name("desiredCapabilities");
json.write(ossFirst);
// Now for the w3c capabilities
json.name("capabilities");
json.beginObject();
// Then write everything into the w3c payload. Because of the way we do this, it's easiest
// to just populate the "firstMatch" section. The spec says it's fine to omit the
// "alwaysMatch" field, so we do this.
json.name("firstMatch");
json.beginArray();
//noinspection unchecked
getW3C().forEach(json::write);
json.endArray();
json.endObject(); // Close "capabilities" object
writeMetaData(json);
json.endObject();
}
}
private void writeMetaData(JsonOutput out) throws IOException {
CharSource charSource = backingStore.asByteSource().asCharSource(UTF_8);
try (Reader reader = charSource.openBufferedStream();
JsonInput input = json.newInput(reader)) {
input.beginObject();
while (input.hasNext()) {
String name = input.nextName();
switch (name) {
case "capabilities":
case "desiredCapabilities":
case "requiredCapabilities":
input.skipValue();
break;
default:
out.name(name);
out.write(input.read(Object.class));
break;
}
}
}
}
/**
* Stream the {@link Capabilities} encoded in the payload used to create this instance. The
* {@link Stream} will start with a {@link Capabilities} object matching the OSS capabilities, and
* will then expand each of the "{@code firstMatch}" and "{@code alwaysMatch}" contents as defined
* in the W3C WebDriver spec.
*
* The OSS {@link Capabilities} are listed first because converting the OSS capabilities to the
* equivalent W3C capabilities isn't particularly easy, so it's hoped that this approach gives us
* the most compatible implementation.
*/
public Stream stream() {
try {
// OSS first
Stream> oss = Stream.of(getOss());
// And now W3C
Stream> w3c = getW3C();
return Stream.concat(oss, w3c)
.filter(Objects::nonNull)
.map(this::applyTransforms)
.filter(Objects::nonNull)
.distinct()
.map(ImmutableCapabilities::new);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
public ImmutableSet getDownstreamDialects() {
return dialects.isEmpty() ? ImmutableSet.of(DEFAULT_DIALECT) : dialects;
}
@Override
public void close() {
try {
backingStore.reset();
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
private Map getOss() throws IOException {
CharSource charSource = backingStore.asByteSource().asCharSource(UTF_8);
try (Reader reader = charSource.openBufferedStream();
JsonInput input = json.newInput(reader)) {
input.beginObject();
while (input.hasNext()) {
String name = input.nextName();
if ("desiredCapabilities".equals(name)) {
return input.read(MAP_TYPE);
} else {
input.skipValue();
}
}
}
return null;
}
private Stream> getW3C() throws IOException {
// If there's an OSS value, generate a stream of capabilities from that using the transforms,
// then add magic to generate each of the w3c capabilities. For the sake of simplicity, we're
// going to make the (probably wrong) assumption we can hold all of the firstMatch values and
// alwaysMatch value in memory at the same time.
Map oss = convertOssToW3C(getOss());
Stream> fromOss;
if (oss != null) {
Set usedKeys = new HashSet<>();
// Are there any values we care want to pull out into a mapping of their own?
List> firsts = adapters.stream()
.map(adapter -> adapter.apply(oss))
.filter(Objects::nonNull)
.filter(map -> !map.isEmpty())
.map(map ->
map.entrySet().stream()
.filter(entry -> entry.getKey() != null)
.filter(entry -> ACCEPTED_W3C_PATTERNS.test(entry.getKey()))
.filter(entry -> entry.getValue() != null)
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)))
.peek(map -> usedKeys.addAll(map.keySet()))
.collect(ImmutableList.toImmutableList());
if (firsts.isEmpty()) {
firsts = ImmutableList.of(ImmutableMap.of());
}
// Are there any remaining unused keys?
Map always = oss.entrySet().stream()
.filter(entry -> !usedKeys.contains(entry.getKey()))
.filter(entry -> entry.getValue() != null)
.collect(ImmutableMap.toImmutableMap(Map.Entry::getKey, Map.Entry::getValue));
// Firsts contains at least one entry, always contains everything else. Let's combine them
// into the stream to form a unified set of capabilities. Woohoo!
fromOss = firsts.stream()
.map(first -> ImmutableMap.builder().putAll(always).putAll(first).build())
.map(this::applyTransforms)
.map(map -> map.entrySet().stream()
.filter(entry -> ACCEPTED_W3C_PATTERNS.test(entry.getKey()))
.collect(ImmutableMap.toImmutableMap(Map.Entry::getKey, Map.Entry::getValue)));
} else {
fromOss = Stream.of();
}
Stream> fromW3c;
Map alwaysMatch = getAlwaysMatch();
Collection> firsts = getFirstMatches();
if (alwaysMatch == null && firsts == null) {
fromW3c = Stream.of(); // No W3C capabilities.
} else {
if (alwaysMatch == null) {
alwaysMatch = ImmutableMap.of();
}
Map always = alwaysMatch; // Keep the comoiler happy.
if (firsts == null) {
firsts = ImmutableList.of(ImmutableMap.of());
}
fromW3c = firsts.stream()
.map(first -> ImmutableMap.builder().putAll(always).putAll(first).build());
}
return Stream.concat(fromOss, fromW3c).distinct();
}
private Map convertOssToW3C(Map capabilities) {
if (capabilities == null) {
return null;
}
Map toReturn = new TreeMap<>(capabilities);
// Platform name
if (capabilities.containsKey(PLATFORM) && !capabilities.containsKey(PLATFORM_NAME)) {
toReturn.put(PLATFORM_NAME, String.valueOf(capabilities.get(PLATFORM)));
}
if (capabilities.containsKey(PROXY)) {
Map proxyMap;
Object rawProxy = capabilities.get(CapabilityType.PROXY);
if (rawProxy instanceof Proxy) {
proxyMap = ((Proxy) rawProxy).toJson();
} else if (rawProxy instanceof Map) {
proxyMap = (Map) rawProxy;
} else {
proxyMap = new HashMap<>();
}
if (proxyMap.containsKey("noProxy")) {
Map w3cProxyMap = new HashMap<>(proxyMap);
Object rawData = proxyMap.get("noProxy");
if (rawData instanceof String) {
w3cProxyMap.put("noProxy", Arrays.asList(((String) rawData).split(",\\s*")));
}
toReturn.put(CapabilityType.PROXY, w3cProxyMap);
}
}
return toReturn;
}
private Map getAlwaysMatch() throws IOException {
CharSource charSource = backingStore.asByteSource().asCharSource(UTF_8);
try (Reader reader = charSource.openBufferedStream();
JsonInput input = json.newInput(reader)) {
input.beginObject();
while (input.hasNext()) {
String name = input.nextName();
if ("capabilities".equals(name)) {
input.beginObject();
while (input.hasNext()) {
name = input.nextName();
if ("alwaysMatch".equals(name)) {
return input.read(MAP_TYPE);
} else {
input.skipValue();
}
}
input.endObject();
} else {
input.skipValue();
}
}
}
return null;
}
private Collection> getFirstMatches() throws IOException {
CharSource charSource = backingStore.asByteSource().asCharSource(UTF_8);
try (Reader reader = charSource.openBufferedStream();
JsonInput input = json.newInput(reader)) {
input.beginObject();
while (input.hasNext()) {
String name = input.nextName();
if ("capabilities".equals(name)) {
input.beginObject();
while (input.hasNext()) {
name = input.nextName();
if ("firstMatch".equals(name)) {
return input.read(LIST_OF_MAPS_TYPE);
} else {
input.skipValue();
}
}
input.endObject();
} else {
input.skipValue();
}
}
}
return null;
}
private Map applyTransforms(Map caps) {
Queue> toExamine = new LinkedList<>(caps.entrySet());
Set seenKeys = new HashSet<>();
Map toReturn = new TreeMap<>();
// Take each entry and apply the transforms
while (!toExamine.isEmpty()) {
Map.Entry entry = toExamine.remove();
seenKeys.add(entry.getKey());
if (entry.getValue() == null) {
continue;
}
for (CapabilityTransform transform : transforms) {
Collection> result = transform.apply(entry);
if (result == null) {
toReturn.remove(entry.getKey());
break;
}
for (Map.Entry newEntry : result) {
if (!seenKeys.contains(newEntry.getKey())) {
toExamine.add(newEntry);
} else {
if (newEntry.getKey().equals(entry.getKey())) {
entry = newEntry;
}
toReturn.put(newEntry.getKey(), newEntry.getValue());
}
}
}
}
return toReturn;
}
@Override
public String toString() {
StringBuilder res = new StringBuilder();
try {
writeTo(res);
} catch (IOException e) {
e.printStackTrace();
}
return res.toString();
}
}