[grid] Adding Grid version to GraphQL

This will show the version of the component
that is running up front (Router, Hub, or
Standalone).

There will be a separate commit to add the
version of each Node.

Author: diemol

java/server/src/org/openqa/selenium/grid/commands/Hub.java

@@ -169,7 +169,8 @@ protected Handlers createHandlers(Config config) {
       tracer,
       distributor,
       queuer,
-      serverOptions.getExternalUri());
+      serverOptions.getExternalUri(),
+      getFormattedVersion());
     HttpHandler readinessCheck = req -> {
       boolean ready = router.isReady() && bus.isReady();
       return new HttpResponse()
@@ -206,11 +207,11 @@ protected void execute(Config config) {
 
     Server<?> server = asServer(config).start();
 
+    LOG.info(String.format("Started Selenium Hub %s: %s", getFormattedVersion(), server.getUrl()));
+  }
+
+  private String getFormattedVersion() {
     BuildInfo info = new BuildInfo();
-    LOG.info(String.format(
-      "Started Selenium hub %s (revision %s): %s",
-      info.getReleaseLabel(),
-      info.getBuildRevision(),
-      server.getUrl()));
+    return String.format("%s (revision %s)", info.getReleaseLabel(), info.getBuildRevision());
   }
 }

java/server/src/org/openqa/selenium/grid/commands/Standalone.java

@@ -149,6 +149,7 @@ protected Handlers createHandlers(Config config) {
       bus,
       newSessionQueueOptions.getSessionRequestRetryInterval(),
       newSessionQueueOptions.getSessionRequestTimeout());
+
     NewSessionQueuer queuer = new LocalNewSessionQueuer(
       tracer,
       bus,
@@ -179,7 +180,8 @@ protected Handlers createHandlers(Config config) {
       tracer,
       distributor,
       queuer,
-      serverOptions.getExternalUri());
+      serverOptions.getExternalUri(),
+      getFormattedVersion());
 
     Routable ui;
     URL uiRoot = getClass().getResource("/javascript/grid-ui/build");
@@ -213,11 +215,14 @@ protected void execute(Config config) {
 
     Server<?> server = asServer(config).start();
 
-    BuildInfo info = new BuildInfo();
     LOG.info(String.format(
-      "Started Selenium standalone %s (revision %s): %s",
-      info.getReleaseLabel(),
-      info.getBuildRevision(),
+      "Started Selenium Standalone %s: %s",
+      getFormattedVersion(),
       server.getUrl()));
   }
+
+  private String getFormattedVersion() {
+    BuildInfo info = new BuildInfo();
+    return String.format("%s (revision %s)", info.getReleaseLabel(), info.getBuildRevision());
+  }
 }

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

@@ -34,7 +34,6 @@
 import org.openqa.selenium.json.Json;
 import org.openqa.selenium.remote.http.Contents;
 import org.openqa.selenium.remote.http.HttpHandler;
-import org.openqa.selenium.remote.http.HttpMethod;
 import org.openqa.selenium.remote.http.HttpRequest;
 import org.openqa.selenium.remote.http.HttpResponse;
 import org.openqa.selenium.remote.tracing.AttributeKey;
@@ -49,11 +48,9 @@
 import java.net.URI;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Objects;
 import java.util.concurrent.ExecutionException;
 
 import static java.net.HttpURLConnection.HTTP_INTERNAL_ERROR;
-import static java.net.HttpURLConnection.HTTP_OK;
 import static org.openqa.selenium.json.Json.JSON_UTF_8;
 import static org.openqa.selenium.json.Json.MAP_TYPE;
 import static org.openqa.selenium.remote.http.Contents.utf8String;
@@ -71,14 +68,16 @@ public class GraphqlHandler implements HttpHandler {
   private final Distributor distributor;
   private final NewSessionQueuer newSessionQueuer;
   private final URI publicUri;
+  private final String version;
   private final GraphQL graphQl;
 
 
   public GraphqlHandler(Tracer tracer, Distributor distributor, NewSessionQueuer newSessionQueuer,
-                        URI publicUri) {
+                        URI publicUri, String version) {
     this.distributor = Require.nonNull("Distributor", distributor);
     this.newSessionQueuer = Require.nonNull("NewSessionQueuer", newSessionQueuer);
     this.publicUri = Require.nonNull("Uri", publicUri);
+    this.version = Require.nonNull("GridVersion", version);
     this.tracer = Require.nonNull("Tracer", tracer);
 
     GraphQLSchema schema = new SchemaGenerator()
@@ -132,7 +131,8 @@ public HttpResponse execute(HttpRequest req) throws UncheckedIOException {
       }
 
       String query = (String) inputs.get("query");
-      @SuppressWarnings("unchecked") Map<String, Object> variables = inputs.get("variables") instanceof Map ?
+      @SuppressWarnings("unchecked")
+      Map<String, Object> variables = inputs.get("variables") instanceof Map ?
         (Map<String, Object>) inputs.get("variables") :
         new HashMap<>();
 
@@ -173,7 +173,11 @@ private RuntimeWiring buildRuntimeWiring() {
       .scalar(Types.Uri)
       .scalar(Types.Url)
       .type("GridQuery", typeWiring -> typeWiring
-          .dataFetcher("grid", new GridData(distributor, newSessionQueuer, publicUri))
+          .dataFetcher("grid", new GridData(
+            distributor,
+            newSessionQueuer,
+            publicUri,
+            version))
           .dataFetcher("session", new SessionData(distributor)))
       .build();
   }

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

@@ -39,18 +39,25 @@ public class Grid {
   private final URI uri;
   private final Supplier<DistributorStatus> distributorStatus;
   private final NewSessionQueuer newSessionQueuer;
+  private final String version;
 
-  public Grid(Distributor distributor, NewSessionQueuer newSessionQueuer, URI uri) {
+  public Grid(Distributor distributor, NewSessionQueuer newSessionQueuer, URI uri,
+              String version) {
     Require.nonNull("Distributor", distributor);
     this.uri = Require.nonNull("Grid's public URI", uri);
     this.newSessionQueuer = Require.nonNull("NewSessionQueuer", newSessionQueuer);
     this.distributorStatus = Suppliers.memoize(distributor::getStatus);
+    this.version = Require.nonNull("Grid's version", version);
   }
 
   public URI getUri() {
     return uri;
   }
 
+  public String getVersion() {
+    return version;
+  }
+
   public List<Node> getNodes() {
     ImmutableList.Builder<Node> toReturn = ImmutableList.builder();
 

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

@@ -29,15 +29,18 @@ public class GridData implements DataFetcher {
   private final Distributor distributor;
   private final NewSessionQueuer newSessionQueuer;
   private final URI publicUri;
+  private final String version;
 
-  public GridData(Distributor distributor, NewSessionQueuer newSessionQueuer, URI publicUri) {
+  public GridData(Distributor distributor, NewSessionQueuer newSessionQueuer, URI publicUri,
+                  String version) {
     this.distributor = Require.nonNull("Distributor", distributor);
     this.publicUri = Require.nonNull("Grid's public URI", publicUri);
     this.newSessionQueuer = Require.nonNull("NewSessionQueuer", newSessionQueuer);
+    this.version = Require.nonNull("Grid's version", version);
   }
 
   @Override
   public Object get(DataFetchingEnvironment environment) {
-    return new Grid(distributor, newSessionQueuer, publicUri);
+    return new Grid(distributor, newSessionQueuer, publicUri, version);
   }
 }

java/server/src/org/openqa/selenium/grid/graphql/selenium-grid-schema.graphqls

@@ -44,7 +44,8 @@ type GridQuery {
 type Grid {
   uri: Uri!
   nodes: [Node!]!
-  totalSlots: Int
-  usedSlots: Int
+  totalSlots: Int!
+  usedSlots: Int!
   sessionCount: Int!
+  version: String!
 }

java/server/src/org/openqa/selenium/grid/router/httpd/RouterServer.java

@@ -133,11 +133,17 @@ protected Handlers createHandlers(Config config) {
       distributorUrl,
       secret);
 
+    BuildInfo info = new BuildInfo();
+    String gridVersion = String.format(
+      "%s (revision %s)",
+      info.getReleaseLabel(),
+      info.getBuildRevision());
     GraphqlHandler graphqlHandler = new GraphqlHandler(
       tracer,
       distributor,
       queuer,
-      serverOptions.getExternalUri());
+      serverOptions.getExternalUri(),
+      gridVersion);
 
     Route handler = Route.combine(
       new Router(tracer, clientFactory, sessions, queuer, distributor).with(networkOptions.getSpecComplianceChecks()),
@@ -153,11 +159,12 @@ protected void execute(Config config) {
 
     Server<?> server = asServer(config).start();
 
-    BuildInfo info = new BuildInfo();
     LOG.info(String.format(
-      "Started Selenium router %s (revision %s): %s",
-      info.getReleaseLabel(),
-      info.getBuildRevision(),
-      server.getUrl()));
+      "Started Selenium Router %s: %s", getFormattedVersion(), server.getUrl()));
+  }
+
+  private String getFormattedVersion() {
+    BuildInfo info = new BuildInfo();
+    return String.format("%s (revision %s)", info.getReleaseLabel(), info.getBuildRevision());
   }
 }

java/server/test/org/openqa/selenium/grid/graphql/GraphqlHandlerTest.java

@@ -72,7 +72,6 @@
 import static org.assertj.core.api.InstanceOfAssertFactories.LIST;
 import static org.assertj.core.api.InstanceOfAssertFactories.MAP;
 import static org.openqa.selenium.json.Json.MAP_TYPE;
-import static org.openqa.selenium.remote.http.Contents.asJson;
 import static org.openqa.selenium.remote.http.Contents.utf8String;
 import static org.openqa.selenium.remote.http.HttpMethod.GET;
 import static org.openqa.selenium.remote.http.HttpMethod.POST;
@@ -83,8 +82,8 @@ public class GraphqlHandlerTest {
 
   private final Secret registrationSecret = new Secret("stilton");
   private final URI publicUri = new URI("http://example.com/grid-o-matic");
+  private final String version = "4.0.0";
   private Distributor distributor;
-  private LocalNewSessionQueue localNewSessionQueue;
   private NewSessionQueuer queuer;
   private Tracer tracer;
   private EventBus events;
@@ -107,7 +106,7 @@ public void setupGrid() {
     caps = new ImmutableCapabilities("browserName", "cheese");
     payload = NewSessionPayload.create(caps);
 
-    localNewSessionQueue = new LocalNewSessionQueue(
+    LocalNewSessionQueue localNewSessionQueue = new LocalNewSessionQueue(
       tracer,
       events,
       Duration.ofSeconds(2),
@@ -130,7 +129,7 @@ public void setupGrid() {
 
   @Test
   public void shouldBeAbleToGetGridUri() {
-    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri);
+    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
 
     Map<String, Object> topLevel = executeQuery(handler, "{ grid { uri } }");
 
@@ -141,9 +140,22 @@ public void shouldBeAbleToGetGridUri() {
             "uri", publicUri.toString()))));
   }
 
+  @Test
+  public void shouldBeAbleToGetGridVersion() {
+    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
+
+    Map<String, Object> topLevel = executeQuery(handler, "{ grid { version } }");
+
+    assertThat(topLevel).isEqualTo(
+      singletonMap(
+        "data", singletonMap(
+          "grid", singletonMap(
+            "version", version))));
+  }
+
   @Test
   public void shouldReturnAnEmptyListForNodesIfNoneAreRegistered() {
-    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri);
+    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
 
     Map<String, Object> topLevel = executeQuery(handler, "{ grid { nodes { uri } } }");
 
@@ -174,7 +186,7 @@ public boolean test(Capabilities capabilities) {
     distributor.add(node);
     wait.until(obj -> distributor.getStatus().hasCapacity());
 
-    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri);
+    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
     Map<String, Object> topLevel = executeQuery(handler, "{ grid { nodes { uri } } }");
 
     assertThat(topLevel).describedAs(topLevel.toString()).isEqualTo(
@@ -224,7 +236,7 @@ public void shouldBeAbleToGetSessionInfo() throws URISyntaxException {
       String query = String.format(
         "{ session (id: \"%s\") { id, capabilities, startTime, uri } }", sessionId);
 
-      GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri);
+      GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
       Map<String, Object> result = executeQuery(handler, query);
 
       assertThat(result).describedAs(result.toString()).isEqualTo(
@@ -280,7 +292,7 @@ public void shouldBeAbleToGetNodeInfoForSession() throws URISyntaxException {
           slot);
       String query = String.format("{ session (id: \"%s\") { nodeId, nodeUri } }", sessionId);
 
-      GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri);
+      GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
       Map<String, Object> result = executeQuery(handler, query);
 
       assertThat(result).describedAs(result.toString()).isEqualTo(
@@ -338,7 +350,7 @@ public void shouldBeAbleToGetSlotInfoForSession() throws URISyntaxException {
       String query = String.format(
         "{ session (id: \"%s\") { slot { id, stereotype, lastStarted } } }", sessionId);
 
-      GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri);
+      GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
       Map<String, Object> result = executeQuery(handler, query);
 
       assertThat(result).describedAs(result.toString()).isEqualTo(
@@ -381,7 +393,7 @@ public void shouldBeAbleToGetSessionDuration() throws URISyntaxException {
 
       String query = String.format("{ session (id: \"%s\") { sessionDurationMillis } }", sessionId);
 
-      GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri);
+      GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
       Map<String, Object> result = executeQuery(handler, query);
 
       assertThat(result)
@@ -412,7 +424,7 @@ public void shouldThrowExceptionWhenSessionNotFound() throws URISyntaxException
     String randomSessionId = UUID.randomUUID().toString();
     String query = "{ session (id: \"" + randomSessionId + "\") { sessionDurationMillis } }";
 
-    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri);
+    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
     Map<String, Object> result = executeQuery(handler, query);
     assertThat(result)
       .containsEntry("data", null)
@@ -441,7 +453,7 @@ public void shouldThrowExceptionWhenSessionIsEmpty() throws URISyntaxException {
 
     String query = "{ session (id: \"\") { sessionDurationMillis } }";
 
-    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri);
+    GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
     Map<String, Object> result = executeQuery(handler, query);
     assertThat(result)
       .containsEntry("data", null)