[grid] Splitting GraphQL queries

This will make life easier for clients
consuming data because they can cache
data without any custom configuration.

Author: diemol

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

@@ -173,15 +173,14 @@ public HttpResponse execute(HttpRequest req) throws UncheckedIOException {
   }
 
   private RuntimeWiring buildRuntimeWiring() {
+    GridData gridData = new GridData(distributor, newSessionQueuer, publicUri, version);
     return RuntimeWiring.newRuntimeWiring()
       .scalar(Types.Uri)
       .scalar(Types.Url)
       .type("GridQuery", typeWiring -> typeWiring
-        .dataFetcher("grid", new GridData(
-          distributor,
-          newSessionQueuer,
-          publicUri,
-          version))
+        .dataFetcher("grid", gridData)
+        .dataFetcher("sessionsInfo", gridData)
+        .dataFetcher("nodesInfo", gridData)
         .dataFetcher("session", new SessionData(distributor)))
       .build();
   }

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

@@ -46,19 +46,27 @@ type Node {
   osInfo: OsInfo!
 }
 
+type Sessions {
+  sessionQueueRequests: [String]!
+  sessions: [Session]!
+}
+
+type Nodes {
+  nodes: [Node!]!
+}
+
 type GridQuery {
   grid: Grid!
+  sessionsInfo: Sessions!
+  nodesInfo: Nodes!
   session(id: String!) : Session!
 }
 
 type Grid {
   uri: Uri!
-  nodes: [Node!]!
   totalSlots: Int!
   usedSlots: Int!
   sessionCount: Int!
   version: String!
   sessionQueueSize: Int!
-  sessionQueueRequests: [String]!
-  sessions: [Session]!
 }

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

@@ -17,14 +17,17 @@
 
 package org.openqa.selenium.grid.graphql;
 
+import com.google.common.collect.ImmutableMap;
 import org.junit.Before;
 import org.junit.Test;
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.ImmutableCapabilities;
 import org.openqa.selenium.SessionNotCreatedException;
 import org.openqa.selenium.events.EventBus;
 import org.openqa.selenium.events.local.GuavaEventBus;
-import org.openqa.selenium.grid.data.*;
+import org.openqa.selenium.grid.data.CreateSessionRequest;
+import org.openqa.selenium.grid.data.CreateSessionResponse;
+import org.openqa.selenium.grid.data.RequestId;
 import org.openqa.selenium.grid.data.Session;
 import org.openqa.selenium.grid.data.Slot;
 import org.openqa.selenium.grid.distributor.Distributor;
@@ -57,8 +60,8 @@
 import java.io.UncheckedIOException;
 import java.net.URI;
 import java.net.URISyntaxException;
-import java.time.Instant;
 import java.time.Duration;
+import java.time.Instant;
 import java.util.Collections;
 import java.util.Map;
 import java.util.Optional;
@@ -77,15 +80,13 @@
 import static org.openqa.selenium.remote.http.HttpMethod.GET;
 import static org.openqa.selenium.remote.http.HttpMethod.POST;
 
-import com.google.common.collect.ImmutableMap;
-
 public class GraphqlHandlerTest {
 
+  private static final Json JSON = new Json();
   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 final Wait<Object> wait = new FluentWait<>(new Object()).withTimeout(Duration.ofSeconds(5));
-  private static final Json JSON = new Json();
   private Distributor distributor;
   private NewSessionQueuer queuer;
   private Tracer tracer;
@@ -188,12 +189,12 @@ public void shouldBeAbleToGetSessionQueueRequests() {
     GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
 
     Map<String, Object> topLevel = executeQuery(handler,
-      "{ grid { sessionQueueRequests } }");
+      "{ sessionsInfo { sessionQueueRequests } }");
 
     assertThat(topLevel).isEqualTo(
       singletonMap(
         "data", singletonMap(
-          "grid", singletonMap(
+          "sessionsInfo", singletonMap(
             "sessionQueueRequests", singletonList(JSON.toJson(caps))))));
   }
 
@@ -202,25 +203,25 @@ public void shouldBeReturnAnEmptyListIfQueueIsEmpty() {
     GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
 
     Map<String, Object> topLevel = executeQuery(handler,
-      "{ grid { sessionQueueRequests } }");
+      "{ sessionsInfo { sessionQueueRequests } }");
 
     assertThat(topLevel).isEqualTo(
       singletonMap(
         "data", singletonMap(
-          "grid", singletonMap(
+          "sessionsInfo", singletonMap(
             "sessionQueueRequests", Collections.emptyList()))));
   }
 
   @Test
   public void shouldReturnAnEmptyListForNodesIfNoneAreRegistered() {
     GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
 
-    Map<String, Object> topLevel = executeQuery(handler, "{ grid { nodes { uri } } }");
+    Map<String, Object> topLevel = executeQuery(handler, "{ nodesInfo { nodes { uri } } }");
 
     assertThat(topLevel).describedAs(topLevel.toString()).isEqualTo(
       singletonMap(
         "data", singletonMap(
-          "grid", singletonMap(
+          "nodesInfo", singletonMap(
             "nodes", Collections.emptyList()))));
   }
 
@@ -245,12 +246,12 @@ public boolean test(Capabilities capabilities) {
     wait.until(obj -> distributor.getStatus().hasCapacity());
 
     GraphqlHandler handler = new GraphqlHandler(tracer, distributor, queuer, publicUri, version);
-    Map<String, Object> topLevel = executeQuery(handler, "{ grid { nodes { uri } } }");
+    Map<String, Object> topLevel = executeQuery(handler, "{ nodesInfo { nodes { uri } } }");
 
     assertThat(topLevel).describedAs(topLevel.toString()).isEqualTo(
       singletonMap(
         "data", singletonMap(
-          "grid", singletonMap(
+          "nodesInfo", singletonMap(
             "nodes", singletonList(singletonMap("uri", nodeUri))))));
   }
 

javascript/grid-ui/src/components/RunningSessions/RunningSessions.tsx

@@ -336,7 +336,7 @@ export default function RunningSessions(props) {
                             <Typography gutterBottom>
                               Capabilities:
                             </Typography>
-                            <Typography gutterBottom>
+                            <Typography gutterBottom component={'span'}>
                               <pre>
                                 {JSON.stringify(JSON.parse(row.rawCapabilities as string), null, 2)}
                               </pre>

javascript/grid-ui/src/components/TopBar/TopBar.tsx

@@ -52,7 +52,7 @@ const useStyles = makeStyles((theme) => ({
   },
 }));
 
-const GRID_SUMMARY_QUERY = loader("../../graphql/grid-summary.gql");
+const GRID_QUERY = loader("../../graphql/grid.gql");
 
 
 export default function TopBar() {
@@ -65,7 +65,7 @@ export default function TopBar() {
     setOpen(false);
   };
 
-  const {loading, error, data} = useQuery(GRID_SUMMARY_QUERY,
+  const {loading, error, data} = useQuery(GRID_QUERY,
     {pollInterval: GridConfig.status.xhrPollingIntervalMillis, fetchPolicy: "network-only"});
   if (loading) return <p>Loading...</p>;
   if (error) return <p>`Error! ${error.message}`</p>;

javascript/grid-ui/src/graphql/grid-summary.gql

@@ -1,21 +1,6 @@
-query {
+query Summary {
 	grid {
 		uri
-		nodes {
-			id
-			uri
-			status
-			maxSession
-			slotCount
-			stereotypes
-			version
-			sessionCount
-			osInfo {
-				version
-				name
-				arch
-			}
-		}
 		totalSlots
 		usedSlots
 		version

javascript/grid-ui/src/graphql/grid.gql

@@ -0,0 +1,19 @@
+query GetNodes {
+	nodesInfo {
+		nodes {
+			id
+			uri
+			status
+			maxSession
+			slotCount
+			stereotypes
+			version
+			sessionCount
+			osInfo {
+				version
+				name
+				arch
+			}
+		}
+	}
+}

javascript/grid-ui/src/graphql/nodes.gql

@@ -1,5 +1,5 @@
-query {
-    grid {
+query GetSessions {
+    sessionsInfo {
         sessions {
             id
             capabilities

javascript/grid-ui/src/graphql/sessions.gql

@@ -28,19 +28,19 @@ const useStyles = makeStyles((theme) => ({
   },
 }));
 
-const GRID_QUERY = loader("../../graphql/grid.gql");
+const NODES_QUERY = loader("../../graphql/nodes.gql");
 
 
 export default function Overview() {
   const classes = useStyles();
   const fixedHeightPaper = clsx(classes.paper, classes.fixedHeight);
 
-  const {loading, error, data} = useQuery(GRID_QUERY,
-      {pollInterval: GridConfig.status.xhrPollingIntervalMillis, fetchPolicy: "network-only"});
+  const {loading, error, data} = useQuery(NODES_QUERY,
+    {pollInterval: GridConfig.status.xhrPollingIntervalMillis, fetchPolicy: "network-only"});
   if (loading) return <p>Loading...</p>;
   if (error) return <p>`Error! ${error.message}`</p>;
 
-  const nodes = data.grid.nodes.map((node) => {
+  const nodes = data.nodesInfo.nodes.map((node) => {
     const osInfo: OsInfoType = {
       name: node.osInfo.name,
       version: node.osInfo.version,

javascript/grid-ui/src/screens/Overview/Overview.tsx

@@ -18,8 +18,8 @@ export default function Sessions() {
 
   return (
     <Grid container spacing={3}>
-      <QueuedSessions sessionQueueRequests={data.grid.sessionQueueRequests}/>
-      <RunningSessions sessions={data.grid.sessions}/>
+      <QueuedSessions sessionQueueRequests={data.sessionsInfo.sessionQueueRequests}/>
+      <RunningSessions sessions={data.sessionsInfo.sessions}/>
     </Grid>
   );
 }