org.openqa.selenium.devtools.SeleniumCdpConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-remote-driver Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
There is a newer version: 4.26.0
Show newest version
// 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.devtools;

import java.net.URI;
import java.net.URISyntaxException;
import java.util.Optional;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.HasCapabilities;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.internal.Require;
import org.openqa.selenium.remote.http.HttpClient;

public class SeleniumCdpConnection extends Connection {

  private static final Logger LOG = Logger.getLogger(SeleniumCdpConnection.class.getName());

  private SeleniumCdpConnection(HttpClient client, String url) {
    super(client, url);
  }

  public static Optional create(WebDriver driver) {
    if (!(driver instanceof HasCapabilities)) {
      throw new IllegalStateException("Given webdriver instance must have capabilities");
    }

    return create(((HasCapabilities) driver).getCapabilities());
  }

  public static Optional create(Capabilities capabilities) {
    Require.nonNull("Capabilities", capabilities);
    return create(HttpClient.Factory.createDefault(), capabilities);
  }

  public static Optional create(
      HttpClient.Factory clientFactory, Capabilities capabilities) {
    Require.nonNull("HTTP client factory", clientFactory);
    Require.nonNull("Capabilities", capabilities);

    Optional cdpUri =
        Optional.ofNullable(capabilities.getCapability("se:cdp"))
            .flatMap(
                (uri) -> {
                  if (uri instanceof String) {
                    try {
                      return Optional.of(new URI((String) uri));
                    } catch (URISyntaxException e) {
                      return Optional.empty();
                    }
                  }
                  return Optional.empty();
                });

    Optional client;

    if (cdpUri.isPresent()) {
      client = Optional.of(CdpEndpointFinder.getHttpClient(clientFactory, cdpUri.get()));
    } else {
      Optional reportedUri = CdpEndpointFinder.getReportedUri(capabilities);
      client = reportedUri.map(uri -> CdpEndpointFinder.getHttpClient(clientFactory, uri));

      try {
        cdpUri = client.flatMap(httpClient -> CdpEndpointFinder.getCdpEndPoint(httpClient));
      } catch (Exception e) {
        try {
          client.ifPresent(HttpClient::close);
        } catch (Exception ex) {
          e.addSuppressed(ex);
        }
        throw e;
      }

      if (!cdpUri.isPresent()) {
        try {
          client.ifPresent(HttpClient::close);
        } catch (Exception e) {
          LOG.log(
              Level.FINE,
              "failed to close the http client used to check the reported CDP endpoint: "
                  + reportedUri.get(),
              e);
        }
      }
    }

    return cdpUri.map(uri -> new SeleniumCdpConnection(client.get(), uri.toString()));
  }
}