com.github.testsmith.cdt.services.impl.ChromeServiceImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdt-java-client Show documentation
Show all versions of cdt-java-client Show documentation
Chrome DevTools java client
The newest version!
package com.github.testsmith.cdt.services.impl;
/*-
* #%L
* cdt-java-client
* %%
* Copyright (C) 2018 - 2024 Kenan Klisura
* %%
* Licensed 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.
* #L%
*/
import com.fasterxml.jackson.databind.ObjectMapper;
import com.github.testsmith.cdt.services.ChromeDevToolsService;
import com.github.testsmith.cdt.services.ChromeService;
import com.github.testsmith.cdt.services.WebSocketService;
import com.github.testsmith.cdt.services.config.ChromeDevToolsServiceConfiguration;
import com.github.testsmith.cdt.services.exceptions.ChromeServiceException;
import com.github.testsmith.cdt.services.exceptions.WebSocketServiceException;
import com.github.testsmith.cdt.services.factory.WebSocketServiceFactory;
import com.github.testsmith.cdt.services.invocation.CommandInvocationHandler;
import com.github.testsmith.cdt.services.types.ChromeTab;
import com.github.testsmith.cdt.services.types.ChromeVersion;
import com.github.testsmith.cdt.services.utils.ProxyUtils;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.net.HttpURLConnection;
import java.net.URI;
import java.net.URL;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* Chrome service implementation.
*
* @author Kenan Klisura
* @version $Id: $Id
*/
public class ChromeServiceImpl implements ChromeService {
/** Constant ABOUT_BLANK_PAGE="about:blank" */
public static final String ABOUT_BLANK_PAGE = "about:blank";
private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
private static final String EMPTY_STRING = "";
private static final String LOCALHOST = "localhost";
private static final String LIST_TABS = "json/list";
private static final String CREATE_TAB = "json/new";
private static final String ACTIVATE_TAB = "json/activate";
private static final String CLOSE_TAB = "json/close";
private static final String VERSION = "json/version";
private final String host;
private final int port;
private WebSocketServiceFactory webSocketServiceFactory;
private final Map chromeDevToolServiceCache =
new ConcurrentHashMap<>();
/**
* Creates a new chrome service given a host, port and web service socket factory.
*
* @param host Chrome host.
* @param port Chrome debugging port.
* @param webSocketServiceFactory Web socket service factory.
*/
public ChromeServiceImpl(String host, int port, WebSocketServiceFactory webSocketServiceFactory) {
this.host = host;
this.port = port;
this.webSocketServiceFactory = webSocketServiceFactory;
}
/**
* Creates a new chrome service given a host and a port.
*
* @param host Chrome host.
* @param port Chrome debugging port.
*/
public ChromeServiceImpl(String host, int port) {
this(host, port, (wsUrl -> WebSocketServiceImpl.create(URI.create(wsUrl))));
}
/**
* Creates new chrome service given a port. Host is assumed to be localhost.
*
* @param port Chrome debugging port.
*/
public ChromeServiceImpl(int port) {
this(LOCALHOST, port);
}
/**
* Creates new chrome service given a port. Host is assumed to be localhost.
*
* @param port Chrome debugging port.
* @param webSocketServiceFactory Web socket service factory.
*/
public ChromeServiceImpl(int port, WebSocketServiceFactory webSocketServiceFactory) {
this(LOCALHOST, port, webSocketServiceFactory);
}
/**
* Sets web socket service factory.
*
* @param webSocketServiceFactory Web socket service factory.
*/
public void setWebSocketServiceFactory(WebSocketServiceFactory webSocketServiceFactory) {
this.webSocketServiceFactory = webSocketServiceFactory;
}
/** {@inheritDoc} */
@Override
public List getTabs() throws ChromeServiceException {
return Arrays.asList(request(ChromeTab[].class, "http://%s:%d/%s", host, port, LIST_TABS));
}
/** {@inheritDoc} */
@Override
public ChromeTab createTab() throws ChromeServiceException {
return createTab(ABOUT_BLANK_PAGE);
}
/** {@inheritDoc} */
@Override
public ChromeTab createTab(String tab) throws ChromeServiceException {
return request(ChromeTab.class, "http://%s:%d/%s?%s", host, port, CREATE_TAB, tab);
}
/** {@inheritDoc} */
@Override
public void activateTab(ChromeTab tab) throws ChromeServiceException {
request(Void.class, "http://%s:%d/%s/%s", host, port, ACTIVATE_TAB, tab.getId());
}
/** {@inheritDoc} */
@Override
public void closeTab(ChromeTab tab) throws ChromeServiceException {
request(Void.class, "http://%s:%d/%s/%s", host, port, CLOSE_TAB, tab.getId());
// Remove dev tools from cache.
clearChromeDevToolsServiceCache(tab);
}
/** {@inheritDoc} */
@Override
public ChromeVersion getVersion() throws ChromeServiceException {
return request(ChromeVersion.class, "http://%s:%d/%s", host, port, VERSION);
}
/** {@inheritDoc} */
@Override
public synchronized ChromeDevToolsService createDevToolsService(ChromeTab tab)
throws ChromeServiceException {
return createDevToolsService(tab, new ChromeDevToolsServiceConfiguration());
}
/** {@inheritDoc} */
@Override
public synchronized ChromeDevToolsService createDevToolsService(
ChromeTab tab, ChromeDevToolsServiceConfiguration chromeDevToolsServiceConfiguration)
throws ChromeServiceException {
try {
if (isChromeDevToolsServiceCached(tab)) {
return getCachedChromeDevToolsService(tab);
}
// Connect to a tab via web socket
String webSocketDebuggerUrl = tab.getWebSocketDebuggerUrl();
WebSocketService webSocketService =
webSocketServiceFactory.createWebSocketService(webSocketDebuggerUrl);
// Create invocation handler
CommandInvocationHandler commandInvocationHandler = new CommandInvocationHandler();
// Setup command cache for this session
Map commandsCache = new ConcurrentHashMap<>();
// Create dev tools service.
ChromeDevToolsServiceImpl chromeDevToolsService =
ProxyUtils.createProxyFromAbstract(
ChromeDevToolsServiceImpl.class,
new Class[] {WebSocketService.class, ChromeDevToolsServiceConfiguration.class},
new Object[] {webSocketService, chromeDevToolsServiceConfiguration},
(unused, method, args) ->
commandsCache.computeIfAbsent(
method,
key -> {
Class returnType = method.getReturnType();
return ProxyUtils.createProxy(returnType, commandInvocationHandler);
}));
// Register dev tools service with invocation handler.
commandInvocationHandler.setChromeDevToolsService(chromeDevToolsService);
// Cache it up.
cacheChromeDevToolsService(tab, chromeDevToolsService);
return chromeDevToolsService;
} catch (WebSocketServiceException ex) {
throw new ChromeServiceException("Failed connecting to tab web socket.", ex);
}
}
/**
* Returns current port number.
*
* @return Port number.
*/
public int getPort() {
return port;
}
/**
* Returns host.
*
* @return Host.
*/
public String getHost() {
return host;
}
/**
* Clears the chrome dev tool service cache given a tab.
*
* @param tab Chrome tab.
*/
public void clearChromeDevToolsServiceCache(ChromeTab tab) {
ChromeDevToolsService chromeDevToolsService = chromeDevToolServiceCache.remove(tab.getId());
if (chromeDevToolsService != null) {
chromeDevToolsService.close();
}
}
private boolean isChromeDevToolsServiceCached(ChromeTab tab) {
return chromeDevToolServiceCache.get(tab.getId()) != null;
}
private ChromeDevToolsService getCachedChromeDevToolsService(ChromeTab tab) {
return chromeDevToolServiceCache.get(tab.getId());
}
private void cacheChromeDevToolsService(
ChromeTab tab, ChromeDevToolsService chromeDevToolsService) {
chromeDevToolServiceCache.put(tab.getId(), chromeDevToolsService);
}
/**
* Sends a request and parses json response as type T.
*
* @param responseType Resulting class type.
* @param path Path with optional params similar to String.formats params.
* @param params Path params.
* @param Type of response type.
* @return Response object.
* @throws ChromeServiceException If sending request fails due to any reason.
*/
private static T request(Class responseType, String path, Object... params)
throws ChromeServiceException {
HttpURLConnection connection = null;
InputStream inputStream = null;
try {
URL uri = new URL(String.format(path, params));
connection = (HttpURLConnection) uri.openConnection();
connection.setRequestMethod("PUT");
int responseCode = connection.getResponseCode();
if (HttpURLConnection.HTTP_OK == responseCode) {
if (Void.class.equals(responseType)) {
return null;
}
inputStream = connection.getInputStream();
return OBJECT_MAPPER.readerFor(responseType).readValue(inputStream);
}
inputStream = connection.getErrorStream();
final String responseBody = inputStreamToString(inputStream);
String message =
MessageFormat.format(
"Server responded with non-200 code: {0} - {1}. {2}",
responseCode, connection.getResponseMessage(), responseBody);
throw new ChromeServiceException(message);
} catch (IOException ex) {
throw new ChromeServiceException("Failed sending HTTP request.", ex);
} finally {
if (inputStream != null) {
try {
inputStream.close();
} catch (IOException e) {
// We can ignore this.
}
}
if (connection != null) {
connection.disconnect();
}
}
}
/**
* Converts input stream to string. If input string is null, it returns empty string.
*
* @param inputStream Input stream.
* @return String
* @throws java.io.IOException If conversion fails.
*/
public static String inputStreamToString(InputStream inputStream) throws IOException {
if (inputStream == null) {
return EMPTY_STRING;
}
int length;
byte[] buffer = new byte[1024];
ByteArrayOutputStream result = new ByteArrayOutputStream();
while ((length = inputStream.read(buffer)) != -1) {
result.write(buffer, 0, length);
}
return result.toString("UTF-8");
}
}