org.openqa.selenium.grid.node.local.LocalNode Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of grid Show documentation
Show all versions of grid Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
// 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.node.local;
import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static java.util.stream.Collectors.groupingBy;
import static java.util.stream.Collectors.summingInt;
import static org.openqa.selenium.grid.data.SessionClosedEvent.SESSION_CLOSED;
import static org.openqa.selenium.grid.node.CapabilityResponseEncoder.getEncoder;
import static org.openqa.selenium.remote.HttpSessionId.getSessionId;
import static org.openqa.selenium.remote.http.HttpMethod.DELETE;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.base.Ticker;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.RemovalListener;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.NoSuchSessionException;
import org.openqa.selenium.concurrent.Regularly;
import org.openqa.selenium.events.EventBus;
import org.openqa.selenium.grid.component.HealthCheck;
import org.openqa.selenium.grid.data.CreateSessionRequest;
import org.openqa.selenium.grid.data.CreateSessionResponse;
import org.openqa.selenium.grid.data.NodeStatus;
import org.openqa.selenium.grid.data.Session;
import org.openqa.selenium.grid.node.ActiveSession;
import org.openqa.selenium.grid.node.Node;
import org.openqa.selenium.grid.node.SessionFactory;
import org.openqa.selenium.json.Json;
import org.openqa.selenium.remote.SessionId;
import org.openqa.selenium.remote.http.HttpClient;
import org.openqa.selenium.remote.http.HttpRequest;
import org.openqa.selenium.remote.http.HttpResponse;
import org.openqa.selenium.remote.tracing.DistributedTracer;
import org.openqa.selenium.remote.tracing.Span;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.net.URI;
import java.time.Clock;
import java.time.Duration;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.UUID;
import java.util.stream.Collectors;
public class LocalNode extends Node {
public static final Json JSON = new Json();
private final URI externalUri;
private final HealthCheck healthCheck;
private final int maxSessionCount;
private final List factories;
private final Cache currentSessions;
private final Regularly regularly;
private LocalNode(
DistributedTracer tracer,
EventBus bus,
URI uri,
HealthCheck healthCheck,
int maxSessionCount,
Ticker ticker,
Duration sessionTimeout,
List factories) {
super(tracer, UUID.randomUUID(), uri);
Preconditions.checkArgument(
maxSessionCount > 0,
"Only a positive number of sessions can be run: " + maxSessionCount);
this.externalUri = Objects.requireNonNull(uri);
this.healthCheck = Objects.requireNonNull(healthCheck);
this.maxSessionCount = Math.min(maxSessionCount, factories.size());
this.factories = ImmutableList.copyOf(factories);
this.currentSessions = CacheBuilder.newBuilder()
.expireAfterAccess(sessionTimeout)
.ticker(ticker)
.removalListener((RemovalListener) notification -> {
// If we were invoked explicitly, then return: we know what we're doing.
if (!notification.wasEvicted()) {
return;
}
try (Span span = tracer.createSpan("node.evict-session", null)) {
killSession(span, notification.getValue());
}
})
.build();
this.regularly = new Regularly("Local Node: " + externalUri);
regularly.submit(currentSessions::cleanUp, Duration.ofSeconds(30), Duration.ofSeconds(30));
bus.addListener(SESSION_CLOSED, event -> {
try {
this.stop(event.getData(SessionId.class));
} catch (NoSuchSessionException ignore) {}
});
}
@VisibleForTesting
public int getCurrentSessionCount() {
// It seems wildly unlikely we'll overflow an int
return Math.toIntExact(currentSessions.size());
}
@Override
public boolean isSupporting(Capabilities capabilities) {
try (Span span = tracer.createSpan("node.is-supporting", tracer.getActiveSpan())) {
span.addTag("capabilities", capabilities);
boolean toReturn = factories.parallelStream().anyMatch(factory -> factory.test(capabilities));
span.addTag("match-made", toReturn);
return toReturn;
}
}
@Override
public Optional newSession(CreateSessionRequest sessionRequest) {
try (Span span = tracer.createSpan("node.new-session", tracer.getActiveSpan())) {
Objects.requireNonNull(sessionRequest, "Session request has not been set.");
span.addTag("capabilities", sessionRequest.getCapabilities());
if (getCurrentSessionCount() >= maxSessionCount) {
span.addTag("result", "session count exceeded");
return Optional.empty();
}
Optional possibleSession = Optional.empty();
SessionSlot slot = null;
for (SessionSlot factory : factories) {
if (!factory.isAvailable() || !factory.test(sessionRequest.getCapabilities())) {
continue;
}
possibleSession = factory.apply(sessionRequest);
if (possibleSession.isPresent()) {
slot = factory;
break;
}
}
if (!possibleSession.isPresent()) {
span.addTag("result", "No possible session detected");
return Optional.empty();
}
ActiveSession session = possibleSession.get();
span.addTag("session.id", session.getId());
span.addTag("session.capabilities", session.getCapabilities());
span.addTag("session.uri", session.getUri());
currentSessions.put(session.getId(), slot);
// The session we return has to look like it came from the node, since we might be dealing
// with a webdriver implementation that only accepts connections from localhost
Session externalSession = createExternalSession(session, externalUri);
return Optional.of(new CreateSessionResponse(
externalSession,
getEncoder(session.getDownstreamDialect()).apply(externalSession)));
}
}
@Override
protected boolean isSessionOwner(SessionId id) {
try (Span span = tracer.createSpan("node.is-session-owner", tracer.getActiveSpan())) {
Objects.requireNonNull(id, "Session ID has not been set");
span.addTag("session.id", id);
boolean toReturn = currentSessions.getIfPresent(id) != null;
span.addTag("result", toReturn);
return toReturn;
}
}
@Override
public Session getSession(SessionId id) throws NoSuchSessionException {
Objects.requireNonNull(id, "Session ID has not been set");
try (Span span = tracer.createSpan("node.get-session", tracer.getActiveSpan())) {
span.addTag("session.id", id);
SessionSlot slot = currentSessions.getIfPresent(id);
if (slot == null) {
span.addTag("result", false);
throw new NoSuchSessionException("Cannot find session with id: " + id);
}
span.addTag("session.capabilities", slot.getSession().getCapabilities());
span.addTag("session.uri", slot.getSession().getUri());
return createExternalSession(slot.getSession(), externalUri);
}
}
@Override
public void executeWebDriverCommand(HttpRequest req, HttpResponse resp) {
try (Span span = tracer.createSpan("node.webdriver-command", tracer.getActiveSpan())) {
span.addTag("http.method", req.getMethod());
span.addTag("http.url", req.getUri());
// True enough to be good enough
SessionId id = getSessionId(req.getUri()).map(SessionId::new)
.orElseThrow(() -> new NoSuchSessionException("Cannot find session: " + req));
span.addTag("session.id", id);
SessionSlot slot = currentSessions.getIfPresent(id);
if (slot == null) {
span.addTag("result", "Session not found");
throw new NoSuchSessionException("Cannot find session with id: " + id);
}
span.addTag("session.capabilities", slot.getSession().getCapabilities());
span.addTag("session.uri", slot.getSession().getUri());
try {
slot.execute(req, resp);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
if (req.getMethod() == DELETE && req.getUri().equals("/session/" + id)) {
stop(id);
}
}
}
@Override
public void stop(SessionId id) throws NoSuchSessionException {
try (Span span = tracer.createSpan("node.stop-session", tracer.getActiveSpan())) {
Objects.requireNonNull(id, "Session ID has not been set");
SessionSlot slot = currentSessions.getIfPresent(id);
if (slot == null) {
throw new NoSuchSessionException("Cannot find session with id: " + id);
}
killSession(span, slot);
}
}
private Session createExternalSession(ActiveSession other, URI externalUri) {
return new Session(other.getId(), externalUri, other.getCapabilities());
}
private void killSession(Span span, SessionSlot slot) {
span.addTag("session.id", slot.getSession().getId());
span.addTag("session.capabilities", slot.getSession().getCapabilities());
span.addTag("session.uri", slot.getSession().getUri());
currentSessions.invalidate(slot.getSession().getId());
// Attempt to stop the session
if (!slot.isAvailable()) {
slot.stop();
}
}
@Override
public NodeStatus getStatus() {
Map stereotypes = factories.stream()
.collect(groupingBy(SessionSlot::getStereotype, summingInt(caps -> 1)));
ImmutableSet activeSessions = currentSessions.asMap().values().stream()
.map(slot -> new NodeStatus.Active(
slot.getStereotype(),
slot.getSession().getId(),
slot.getSession().getCapabilities()))
.collect(toImmutableSet());
return new NodeStatus(
getId(),
externalUri,
maxSessionCount,
stereotypes,
activeSessions);
}
@Override
public HealthCheck getHealthCheck() {
return healthCheck;
}
private Map toJson() {
return ImmutableMap.of(
"id", getId(),
"uri", externalUri,
"maxSessions", maxSessionCount,
"capabilities", factories.stream()
.map(SessionSlot::getStereotype)
.collect(Collectors.toSet()));
}
public static Builder builder(
DistributedTracer tracer,
EventBus bus,
HttpClient.Factory httpClientFactory,
URI uri) {
return new Builder(tracer, bus, httpClientFactory, uri);
}
public static class Builder {
private final DistributedTracer tracer;
private final EventBus bus;
private final HttpClient.Factory httpClientFactory;
private final URI uri;
private final ImmutableList.Builder factories;
private int maxCount = Runtime.getRuntime().availableProcessors() * 5;
private Ticker ticker = Ticker.systemTicker();
private Duration sessionTimeout = Duration.ofMinutes(5);
private HealthCheck healthCheck;
public Builder(
DistributedTracer tracer,
EventBus bus,
HttpClient.Factory httpClientFactory,
URI uri) {
this.tracer = Objects.requireNonNull(tracer);
this.bus = Objects.requireNonNull(bus);
this.httpClientFactory = Objects.requireNonNull(httpClientFactory);
this.uri = Objects.requireNonNull(uri);
this.factories = ImmutableList.builder();
}
public Builder add(Capabilities stereotype, SessionFactory factory) {
Objects.requireNonNull(stereotype, "Capabilities must be set.");
Objects.requireNonNull(factory, "Session factory must be set.");
factories.add(new SessionSlot(bus, stereotype, factory));
return this;
}
public Builder maximumConcurrentSessions(int maxCount) {
Preconditions.checkArgument(
maxCount > 0,
"Only a positive number of sessions can be run: " + maxCount);
this.maxCount = maxCount;
return this;
}
public Builder sessionTimeout(Duration timeout) {
sessionTimeout = timeout;
return this;
}
public LocalNode build() {
HealthCheck check =
healthCheck == null ?
() -> new HealthCheck.Result(true, uri + " is ok") :
healthCheck;
return new LocalNode(
tracer,
bus,
uri,
check,
maxCount,
ticker,
sessionTimeout,
factories.build());
}
public Advanced advanced() {
return new Advanced();
}
public class Advanced {
public Advanced clock(Clock clock) {
ticker = new Ticker() {
@Override
public long read() {
return clock.instant().toEpochMilli() * Duration.ofMillis(1).toNanos();
}
};
return this;
}
public Advanced healthCheck(HealthCheck healthCheck) {
Builder.this.healthCheck = Objects.requireNonNull(healthCheck, "Health check must be set.");
return this;
}
public Node build() {
return Builder.this.build();
}
}
}
}