Make the return type of NewSessionQueue.getQueuedRequests strongly typed

Author: shs96c

java/server/src/org/openqa/selenium/grid/graphql/Grid.java

@@ -20,6 +20,7 @@
 import com.google.common.base.Suppliers;
 import com.google.common.collect.ImmutableList;
 import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.ImmutableCapabilities;
 import org.openqa.selenium.grid.data.DistributorStatus;
 import org.openqa.selenium.grid.data.NodeStatus;
 import org.openqa.selenium.grid.data.Slot;
@@ -34,6 +35,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
@@ -42,7 +44,7 @@ public class Grid {
   private static final Json JSON = new Json();
   private final URI uri;
   private final Supplier<DistributorStatus> distributorStatus;
-  private final List<Object> queueInfoList;
+  private final List<Set<Capabilities>> queueInfoList;
   private final String version;
 
   public Grid(Distributor distributor, NewSessionQueuer newSessionQueuer, URI uri,
@@ -128,7 +130,9 @@ public int getSessionQueueSize() {
   }
 
   public List<String> getSessionQueueRequests() {
+    // TODO: The Grid UI expects there to be a single capability per new session request, which is not correct
     return queueInfoList.stream()
+      .map(set -> set.isEmpty() ? new ImmutableCapabilities() : set.iterator().next())
       .map(JSON::toJson)
       .collect(Collectors.toList());
   }

java/server/src/org/openqa/selenium/grid/sessionqueue/NewSessionQueue.java

@@ -17,6 +17,7 @@
 
 package org.openqa.selenium.grid.sessionqueue;
 
+import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.grid.data.RequestId;
 import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.remote.tracing.Tracer;
@@ -26,6 +27,7 @@
 import java.time.Instant;
 import java.util.List;
 import java.util.Optional;
+import java.util.Set;
 
 public abstract class NewSessionQueue implements HasReadyState {
 
@@ -49,7 +51,7 @@ protected NewSessionQueue(Tracer tracer, Duration retryInterval, Duration reques
 
   public abstract int getQueueSize();
 
-  public abstract List<Object> getQueuedRequests();
+  public abstract List<Set<Capabilities>> getQueuedRequests();
 
   public boolean hasRequestTimedOut(SessionRequest request) {
     Instant enque = request.getEnqueued();

java/server/src/org/openqa/selenium/grid/sessionqueue/NewSessionQueuer.java

@@ -17,6 +17,7 @@
 
 package org.openqa.selenium.grid.sessionqueue;
 
+import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.grid.data.RequestId;
 import org.openqa.selenium.grid.security.RequiresSecretFilter;
 import org.openqa.selenium.grid.security.Secret;
@@ -37,6 +38,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 import java.util.UUID;
 import java.util.stream.Collectors;
 
@@ -98,7 +100,7 @@ private RequestId requestIdFrom(Map<String, String> params) {
 
   public abstract int clearQueue();
 
-  public abstract List<Object> getQueueContents();
+  public abstract List<Set<Capabilities>> getQueueContents();
 
   @Override
   public boolean matches(HttpRequest req) {

java/server/src/org/openqa/selenium/grid/sessionqueue/local/LocalNewSessionQueue.java

@@ -17,6 +17,7 @@
 
 package org.openqa.selenium.grid.sessionqueue.local;
 
+import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.concurrent.Regularly;
 import org.openqa.selenium.events.EventBus;
 import org.openqa.selenium.grid.config.Config;
@@ -46,6 +47,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 import java.util.concurrent.ConcurrentLinkedDeque;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
@@ -114,14 +116,12 @@ public int getQueueSize() {
   }
 
   @Override
-  public List<Object> getQueuedRequests() {
+  public List<Set<Capabilities>> getQueuedRequests() {
     Lock readLock = lock.readLock();
     readLock.lock();
     try {
       return sessionRequests.stream()
-        .map(req -> req.getDesiredCapabilities().iterator())
-        .filter(Iterator::hasNext)
-        .map(Iterator::next)
+        .map(SessionRequest::getDesiredCapabilities)
         .collect(Collectors.toList());
     } finally {
       readLock.unlock();

java/server/src/org/openqa/selenium/grid/sessionqueue/local/LocalNewSessionQueuer.java

@@ -50,6 +50,7 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.Set;
 
 import static org.openqa.selenium.remote.http.Contents.reader;
 import static org.openqa.selenium.remote.tracing.Tags.EXCEPTION;
@@ -111,7 +112,7 @@ public int clearQueue() {
   }
 
   @Override
-  public List<Object> getQueueContents() {
+  public List<Set<Capabilities>> getQueueContents() {
     return sessionRequests.getQueuedRequests();
   }
 

java/server/src/org/openqa/selenium/grid/sessionqueue/remote/RemoteNewSessionQueuer.java

@@ -17,6 +17,7 @@
 
 package org.openqa.selenium.grid.sessionqueue.remote;
 
+import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.grid.config.Config;
 import org.openqa.selenium.grid.data.RequestId;
 import org.openqa.selenium.grid.log.LoggingOptions;
@@ -30,6 +31,7 @@
 import org.openqa.selenium.grid.web.Values;
 import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.json.Json;
+import org.openqa.selenium.json.TypeToken;
 import org.openqa.selenium.remote.http.Contents;
 import org.openqa.selenium.remote.http.Filter;
 import org.openqa.selenium.remote.http.HttpClient;
@@ -39,17 +41,20 @@
 import org.openqa.selenium.remote.tracing.Tracer;
 
 import java.io.UncheckedIOException;
+import java.lang.reflect.Type;
 import java.net.MalformedURLException;
 import java.net.URI;
 import java.util.List;
 import java.util.Optional;
+import java.util.Set;
 
 import static org.openqa.selenium.remote.http.HttpMethod.DELETE;
 import static org.openqa.selenium.remote.http.HttpMethod.GET;
 import static org.openqa.selenium.remote.http.HttpMethod.POST;
 
 public class RemoteNewSessionQueuer extends NewSessionQueuer {
 
+  private static final Type QUEUE_CONTENTS_TYPE = new TypeToken<List<Set<Capabilities>>>() {}.getType();
   private static final Json JSON = new Json();
   private final HttpClient client;
   private final Filter addSecret;
@@ -128,11 +133,12 @@ public int clearQueue() {
   }
 
   @Override
-  public List<Object> getQueueContents() {
+  public List<Set<Capabilities>> getQueueContents() {
     HttpRequest upstream = new HttpRequest(GET, "/se/grid/newsessionqueuer/queue");
     HttpTracing.inject(tracer, tracer.getCurrentContext(), upstream);
     HttpResponse response = client.execute(upstream);
-    return Values.get(response, List.class);
+
+    return Values.get(response, QUEUE_CONTENTS_TYPE);
   }
 
   @Override

java/server/test/org/openqa/selenium/grid/sessionqueue/NewSessionQueuerTest.java

@@ -225,24 +225,24 @@ public void shouldBeClearQueueRemotely() {
   public void shouldBeAbleToGetQueueContents() {
     sessionQueue.offerLast(sessionRequest);
 
-    List<Object> response = local.getQueueContents();
+    List<Set<Capabilities>> response = local.getQueueContents();
     assertThat(response).isNotNull();
 
     assertEquals(1, response.size());
 
-    assertEquals(caps, response.get(0));
+    assertEquals(Set.of(caps), response.get(0));
   }
 
   @Test
   public void shouldBeAbleToGetQueueContentsRemotely() {
     sessionQueue.offerLast(sessionRequest);
 
-    List<Object> response = sessionQueue.getQueuedRequests();
+    List<Set<Capabilities>> response = sessionQueue.getQueuedRequests();
     assertThat(response).isNotNull();
 
     assertEquals(1, response.size());
 
-    assertEquals(caps, response.iterator().next());
+    assertEquals(Set.of(caps), response.iterator().next());
   }
 
   @Test

java/server/test/org/openqa/selenium/grid/sessionqueue/local/LocalNewSessionQueueTest.java

@@ -192,13 +192,13 @@ public void shouldBeAbleToGetQueueContents() {
     boolean addFirefoxRequest = sessionQueue.offerLast(firefoxRequest);
     assertTrue(addFirefoxRequest);
 
-    List<Object> response = sessionQueue.getQueuedRequests();
+    List<Set<Capabilities>> response = sessionQueue.getQueuedRequests();
     assertThat(response).isNotNull();
 
     assertEquals(2, response.size());
 
-    assertEquals(chromeCaps, response.get(0));
-    assertEquals(firefoxCaps, response.get(1));
+    assertEquals(Set.of(chromeCaps), response.get(0));
+    assertEquals(Set.of(firefoxCaps), response.get(1));
   }
 
   @Test(timeout = 15000)