Convert GraphQL v2 to Quarkus

.github/workflows/apis-v2.yaml

@@ -212,7 +212,7 @@ jobs:
       # image-file - file name of the image to import (must be in the artifact)
       # image - final image name to use when running int tests (-Dtesting.containers.stargate-image)
       matrix:
-        project: [ sgv2-docsapi ]
+        project: [ sgv2-docsapi, sgv2-graphqlapi ]
         name: [ cassandra-40, cassandra-311, dse-68, c2-dse-68 ]
         include:
           - name: cassandra-40
@@ -320,7 +320,7 @@ jobs:
       # container test for docsapi only for now, enable for other when ready
       - name: Integration Test
         env:
-          CONTAINER_TEST: ${{ matrix.project == 'sgv2-docsapi' && 'true' || 'false' }}
+          CONTAINER_TEST: ${{ ( matrix.project == 'sgv2-docsapi' || matrix.project == 'sgv2-graphqlapi' ) && 'true' || 'false' }}
         run: |
           cd apis/
           ./mvnw -B verify -DskipUnitTests -pl ${{ matrix.project }} -am -P ${{ matrix.profile }} -Dquarkus.container-image.build=$CONTAINER_TEST -Dtesting.containers.stargate-image=${{ matrix.image }}

Dockerfile

@@ -60,20 +60,3 @@ ENV STARGATE_REST_PORT=8082
 COPY stargate-lib/rest/sgv2*.jar stargate-lib/rest/
 COPY ./starctl-service-rest /starctl-service-rest
 ENTRYPOINT ["./starctl-service-rest"]
-
-
-#
-# Dockerfile for building GraphQL API image
-#
-
-FROM openjdk:11-jre-slim as graphqlapi
-
-EXPOSE 9080
-
-ENV STARGATE_BRIDGE_HOST=localhost
-ENV STARGATE_BRIDGE_PORT=8091
-ENV STARGATE_GRAPHQL_PORT=9080
-
-COPY stargate-lib/graphql/sgv2*.jar stargate-lib/graphql/
-COPY ./starctl-service-graphql /starctl-service-graphql
-ENTRYPOINT ["./starctl-service-graphql"]

apis/pom.xml

@@ -8,6 +8,7 @@
   <modules>
     <module>sgv2-quarkus-common</module>
     <module>sgv2-docsapi</module>
+    <module>sgv2-graphqlapi</module>
   </modules>
   <properties>
     <compiler-plugin.version>3.8.1</compiler-plugin.version>
@@ -52,6 +53,11 @@
         <artifactId>assertj-core</artifactId>
         <version>3.22.0</version>
       </dependency>
+      <dependency>
+        <groupId>com.datastax.oss</groupId>
+        <artifactId>java-driver-core</artifactId>
+        <version>4.14.1</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>
   <build>

apis/sgv2-graphqlapi/.dockerignore

@@ -0,0 +1,5 @@
+*
+!target/*-runner
+!target/*-runner.jar
+!target/lib/*
+!target/quarkus-app/*

sgv2-graphqlapi/README.md → apis/sgv2-graphqlapi/README.md

@@ -16,13 +16,6 @@ online docs]).
   one: `/graphql/<keyspace>` now uses the custom schema, and the generated schema is not available
   anymore.
 
-## Where to start
-
-[GraphqlServiceStarter] starts the HTTP service.
-
-[GraphqlServiceServer] is the HTTP server that exposes the GraphQL services as REST resources. As
-the name indicates, it's implemented with [Dropwizard](https://www.dropwizard.io/en/latest/).
-
 ## GraphQL Java primer
 
 We rely extensively on [GraphQL Java](https://www.graphql-java.com/). Before delving further into
@@ -56,7 +49,7 @@ System.out.println(result.getData().toString()); // prints {random=1384094011}
 ```
 
 1. `newSchema()` provides a DSL to create the GraphQL schema programmatically. This example will
-   produce:
+    produce:
 
     ```graphql
     type Query {
@@ -72,10 +65,15 @@ System.out.println(result.getData().toString()); // prints {random=1384094011}
 
 ### Bridge connectivity
 
-The service accesses the Stargate persistence via the [gRPC bridge](../bridge).
-[CreateStargateBridgeClientFilter] (imported from `sgv2-service-common`) intercepts every HTTP
-request to look for an auth token and optional tenant ID in the headers, and create a bridge client
-accordingly. That client is stored in the HTTP context for consumption in the REST resources.
+The service accesses the Stargate persistence via the [gRPC bridge](../../bridge). The bridge client
+is obtained via [StargateRequestInfo] (imported from `sgv2-quarkus-common`), which creates it
+from the auth token and (optional) tenant ID passed as HTTP request headers.
+
+Note that we don't use the gRPC client generated by Quarkus (`StargateBridge`) directly; instead, we
+rewrap it in a synchronous / future-based interface: [StargateBridgeClient]. This was done out of
+convenience to simplify the migration of existing code. In the future, it might be possible to make
+all the fetcher code asynchronous and use the Quarkus client (but there will still be some wrapping
+required because graphql-java only knows of to deal with futures).
 
 ### Resources
 
@@ -89,9 +87,8 @@ The only thing that changes across subclasses is how we get hold of the `GraphQL
 (see [GraphQL layer](#graphql-layer) below), and whether multipart is supported.
 
 [StargateGraphqlContext] allows us to inject state that will be available later in the data fetchers
-(see [CassandraFetcher]). In particular, this is how we pass the authentication subject and
-datastore that were initialized in the authentication filter. The context also handles
-[batching](#batching), which will be described below.
+(see [CassandraFetcher]). In particular, this is how we pass the reference to the bridge client. The
+context also handles [batching](#batching), which will be described below.
 
 #### Other resources
 
@@ -253,21 +250,10 @@ The easiest way is to use the built-in GraphQL playground at http://localhost:80
 You can then interact with the various GraphQL schemas by entering their URL in the playground's
 address bar, for example http://localhost:8080/graphql/{keyspace}.
 
-### Integration tests
-
-The integration tests are located in the [testing] module. There use two different approaches:
-
-* the tests that extend [ApolloTestBase] use the [Apollo client] library. They provide a good
-  example of using a "real-world" client, but require a lot of boilerplate: external definition
-  files, code generation...
-* the other tests use a more lightweight approach that takes GraphQL queries as plain strings, and
-  returns raw JSON responses. See [GraphqlClient] and its subclasses.
-
-If you add new tests, please favor the lightweight approach.
+<!-- TODO integration tests -->
 
-[GraphqlServiceStarter]: src/main/java/io/stargate/sgv2/graphql/impl/GraphqlServiceStarter.java
-[GraphqlServiceServer]: src/main/java/io/stargate/sgv2/graphql/impl/GraphqlServiceServer.java
-[CreateStargateBridgeClientFilter]: ../sgv2-service-common/src/main/java/io/stargate/sgv2/common/http/CreateStargateBridgeClientFilter.java
+[StargateRequestInfo]: ../sgv2-quarkus-common/src/main/java/io/stargate/sgv2/api/common/StargateRequestInfo.java
+[StargateBridgeClient]: ../sgv2-quarkus-common/src/main/java/io/stargate/sgv2/api/common/grpc/StargateBridgeClient.java
 [GraphqlResourceBase]: src/main/java/io/stargate/sgv2/graphql/web/resources/GraphqlResourceBase.java
 [StargateGraphqlContext]: src/main/java/io/stargate/sgv2/graphql/web/resources/StargateGraphqlContext.java
 [CassandraFetcher]: src/main/java/io/stargate/sgv2/graphql/schema/CassandraFetcher.java
@@ -291,9 +277,5 @@ If you add new tests, please favor the lightweight approach.
 [CassandraMigrator]: src/main/java/io/stargate/sgv2/graphql/schema/graphqlfirst/migration/CassandraMigrator.java
 [CqlDirectives]: src/main/java/io/stargate/sgv2/graphql/schema/graphqlfirst/processor/CqlDirectives.java
 [graphqlfirst.fetchers.deployed]: src/main/java/io/stargate/sgv2/graphql/schema/graphqlfirst/fetchers/deployed
-[testing]: ../testing/src/main/java/io/stargate/it/http/graphql
-[ApolloTestBase]: ../testing/src/main/java/io/stargate/it/http/graphql/cqlfirst/ApolloTestBase.java
-[GraphqlClient]: ../testing/src/main/java/io/stargate/it/http/graphql/GraphqlClient.java
 
-[Apollo client]: https://www.apollographql.com/docs/android/essentials/get-started-java/
 [Stargate online docs]: https://stargate.io/docs/stargate/1.0/quickstart/quick_start-graphql.html