org.openqa.grid.web.servlet.NodeSessionsServlet Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of selenium-server 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.0.0-alpha-2
// 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.grid.web.servlet;

import org.openqa.grid.common.exception.GridException;
import org.openqa.grid.internal.GridRegistry;
import org.openqa.grid.internal.RemoteProxy;
import org.openqa.selenium.json.Json;
import org.openqa.selenium.json.JsonException;
import org.openqa.selenium.json.JsonInput;
import org.openqa.selenium.json.JsonOutput;
import org.openqa.selenium.remote.http.HttpMethod;
import org.openqa.selenium.remote.http.HttpRequest;
import org.openqa.selenium.remote.http.HttpResponse;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.Writer;
import java.net.URL;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * API to query all the sessions that are currently running in the hub.
 */
public class NodeSessionsServlet extends RegistryBasedServlet {

  private final Json json = new Json();

  public NodeSessionsServlet() {
    this(null);
  }

  public NodeSessionsServlet(GridRegistry registry) {
    super(registry);
  }

  @Override
  protected void doGet(HttpServletRequest req, HttpServletResponse rsp) throws IOException {
    process(rsp);
  }

  @Override
  protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
    process(resp);
  }

  protected void process(HttpServletResponse response) throws IOException {
    response.setContentType("application/json");
    response.setCharacterEncoding("UTF-8");
    response.setStatus(200);
    Map proxies = new TreeMap<>();
    try (Writer writer = response.getWriter();
         JsonOutput out = json.newOutput(writer)) {
      proxies.put("success", true);
      proxies.put("proxies", extractSessionsFromAllProxies());
      out.write(proxies);
    }
  }

  private List> extractSessionsFromAllProxies() {
    List> results = new LinkedList<>();
    List proxies = getRegistry().getAllProxies().getBusyProxies();
    for (RemoteProxy proxy : proxies) {
      Map res = new TreeMap<>();
      res.put("id", proxy.getId());
      res.put("remoteHost", proxy.getRemoteHost().toString());
      Map sessionsInProxy = new TreeMap<>(extractSessionInfo(proxy));
      if (sessionsInProxy.isEmpty()) {
        sessionsInProxy.put("success", false);
      }
      res.put("sessions", sessionsInProxy);
      results.add(res);
    }
    return results;
  }

  private Map extractSessionInfo(RemoteProxy proxy) {
    try {
      URL url = proxy.getRemoteHost();
      HttpRequest req = new HttpRequest(HttpMethod.GET, "/wd/hub/sessions");
      Integer nodeStatusCheckTimeout = proxy.getConfig().nodeStatusCheckTimeout;
      HttpResponse rsp = proxy.getHttpClient(url, nodeStatusCheckTimeout, nodeStatusCheckTimeout)
          .execute(req);

      try (InputStream in = new ByteArrayInputStream(rsp.getContent());
           Reader reader = new InputStreamReader(in, rsp.getContentEncoding());
           JsonInput jsonReader = json.newInput(reader)){
        return jsonReader.read(Json.MAP_TYPE);
      } catch (JsonException e) {
        // Nothing to do --- poorly formed payload.
      }
    } catch (IOException e) {
      throw new GridException(e.getMessage());
    }
    return new TreeMap<>();
  }
}