Add support for GraphQL schema query field names and result types customizations (#419)

* Add support for GraphQL schema query field names and result type customizations

* Add initial spring-graphql-web example with mutations

* apply prettier formatting

* introduce EntityObjectTypeMetadata registry

* Add BooksSchemaCustomizerBuildTest

* update BooksSchemaCustomizerBuildTest

* add BooksSchemaCustomizerBuildTest tests

* Add example graphql query ApplicationTest

* Add MutationControllerTest

* Add SubscriptionControllerTest

* Extract GraphQLSchemaConfiguration from Application

* Polish GraphQLObjectTypeMetadata

* add notifyBooksCreated test

* Refine example graphql schema merge to filter null placeholders

* add queryResultTypeNameCustomizer example

* refine CodeRegistryVisitor to remove deprecated use of getDataFetcher

* polish

Author: igdianov

autoconfigure/src/main/java/com/introproventures/graphql/jpa/query/autoconfigure/GraphQLSchemaFactoryBean.java

@@ -121,6 +121,7 @@ protected GraphQLSchema createInstance() {
             .map(GraphQLSchema::getQueryType)
             .map(GraphQLObjectType::getFieldDefinitions)
             .flatMap(Collection::stream)
+            .filter(fd -> !"null".equals(fd.getName()))
             .collect(Collectors.toList());
 
         List<GraphQLFieldDefinition> subscriptions = Stream
@@ -270,7 +271,7 @@ public TraversalControl visitGraphQLFieldDefinition(
             GraphQLFieldDefinition node,
             TraverserContext<GraphQLSchemaElement> context
         ) {
-            GraphQLFieldsContainer parentContainerType = (GraphQLFieldsContainer) context.getParentContext().thisNode();
+            GraphQLObjectType parentContainerType = (GraphQLObjectType) context.getParentContext().thisNode();
             FieldCoordinates coordinates = parentContainerType.equals(containerType)
                 ? coordinates(typeName, node.getName())
                 : coordinates(parentContainerType, node);

examples/spring-graphql-web/pom.xml

@@ -51,6 +51,16 @@
     <artifactId>spring-webflux</artifactId>
     <scope>test</scope>
   </dependency>
+  <dependency>
+    <groupId>io.projectreactor</groupId>
+    <artifactId>reactor-test</artifactId>
+    <scope>test</scope>
+  </dependency>
+  <dependency>
+    <groupId>io.projectreactor.netty</groupId>
+    <artifactId>reactor-netty</artifactId>
+    <scope>test</scope>
+  </dependency>
   <dependency>
     <groupId>org.springframework.graphql</groupId>
     <artifactId>spring-graphql-test</artifactId>

examples/spring-graphql-web/src/main/java/com/introproventures/graphql/jpa/query/example/Application.java

@@ -15,21 +15,10 @@
  */
 package com.introproventures.graphql.jpa.query.example;
 
-import com.introproventures.graphql.jpa.query.autoconfigure.EnableGraphQLJpaQuerySchema;
-import com.introproventures.graphql.jpa.query.schema.model.book.Book;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
-/**
- * GraphQL JPA Query Example with Spring Boot Autoconfiguration
- *
- * You can configure GraphQL JPA Query properties in application.yml
- *
- * @author Igor Dianov
- *
- */
 @SpringBootApplication
-@EnableGraphQLJpaQuerySchema(basePackageClasses = Book.class)
 public class Application {
 
     public static void main(String[] args) {

examples/spring-graphql-web/src/main/java/com/introproventures/graphql/jpa/query/example/config/GraphQLSchemaConfiguration.java

@@ -0,0 +1,29 @@
+package com.introproventures.graphql.jpa.query.example.config;
+
+import com.introproventures.graphql.jpa.query.autoconfigure.EnableGraphQLJpaQuerySchema;
+import com.introproventures.graphql.jpa.query.autoconfigure.GraphQLJPASchemaBuilderCustomizer;
+import com.introproventures.graphql.jpa.query.example.controllers.dto.CreateBookResult;
+import com.introproventures.graphql.jpa.query.schema.model.book.Book;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import reactor.core.publisher.Sinks;
+
+@Configuration
+@EnableGraphQLJpaQuerySchema(basePackageClasses = Book.class)
+public class GraphQLSchemaConfiguration {
+
+    @Bean
+    GraphQLJPASchemaBuilderCustomizer graphQLJPASchemaBuilderCustomizer() {
+        return builder ->
+            builder
+                .graphQLIDType(true)
+                .queryByIdFieldNameCustomizer("find%sById"::formatted)
+                .queryAllFieldNameCustomizer("findAll%s"::formatted)
+                .queryResultTypeNameCustomizer("%sQueryResult"::formatted);
+    }
+
+    @Bean
+    Sinks.Many<CreateBookResult> createBookResultSink() {
+        return Sinks.many().replay().latest();
+    }
+}

examples/spring-graphql-web/src/main/java/com/introproventures/graphql/jpa/query/example/controllers/MutationController.java

@@ -1,14 +1,74 @@
 package com.introproventures.graphql.jpa.query.example.controllers;
 
+import com.introproventures.graphql.jpa.query.example.controllers.dto.CreateBookInput;
+import com.introproventures.graphql.jpa.query.example.controllers.dto.CreateBookResult;
+import com.introproventures.graphql.jpa.query.example.repository.BookRepository;
+import com.introproventures.graphql.jpa.query.schema.model.book.Author;
+import com.introproventures.graphql.jpa.query.schema.model.book.Book;
+import jakarta.persistence.EntityManager;
+import java.util.List;
+import java.util.function.Function;
 import org.springframework.graphql.data.method.annotation.Argument;
 import org.springframework.graphql.data.method.annotation.MutationMapping;
 import org.springframework.stereotype.Controller;
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+import reactor.core.publisher.Sinks;
 
 @Controller
 public class MutationController {
 
+    private final EntityManager entityManager;
+
+    private final BookRepository bookRepository;
+
+    private final Sinks.Many<CreateBookResult> createBookResultSink;
+
+    public MutationController(
+        EntityManager entityManager,
+        BookRepository bookRepository,
+        Sinks.Many<CreateBookResult> createBookResultSink
+    ) {
+        this.entityManager = entityManager;
+        this.bookRepository = bookRepository;
+        this.createBookResultSink = createBookResultSink;
+    }
+
+    @MutationMapping
+    public Mono<CreateBookResult> createBook(@Argument CreateBookInput bookInput) {
+        return Mono.just(bookInput).map(this::doCreateBook);
+    }
+
     @MutationMapping
-    String echo(@Argument String name) {
-        return name;
+    public Flux<CreateBookResult> createBooks(@Argument List<CreateBookInput> bookInputs) {
+        return Flux.fromStream(bookInputs.stream()).map(this::doCreateBook);
+    }
+
+    CreateBookResult doCreateBook(CreateBookInput input) {
+        return createBookEntity()
+            .andThen(bookRepository::save)
+            .andThen(createBookResult())
+            .andThen(notifyCreateBookResult())
+            .apply(input);
+    }
+
+    Function<CreateBookInput, Book> createBookEntity() {
+        return bookInput -> {
+            Book book = new Book();
+            book.setTitle(bookInput.title());
+            book.setAuthor(entityManager.getReference(Author.class, bookInput.authorId()));
+            return book;
+        };
+    }
+
+    Function<CreateBookResult, CreateBookResult> notifyCreateBookResult() {
+        return result -> {
+            createBookResultSink.emitNext(result, Sinks.EmitFailureHandler.FAIL_FAST);
+            return result;
+        };
+    }
+
+    Function<Book, CreateBookResult> createBookResult() {
+        return book -> CreateBookResult.builder().id(book.getId()).build();
     }
 }

examples/spring-graphql-web/src/main/java/com/introproventures/graphql/jpa/query/example/controllers/QueryController.java

@@ -1,7 +1,5 @@
 package com.introproventures.graphql.jpa.query.example.controllers;
 
-import java.util.Date;
-import java.util.Random;
 import org.springframework.graphql.data.method.annotation.Argument;
 import org.springframework.graphql.data.method.annotation.QueryMapping;
 import org.springframework.stereotype.Controller;
@@ -13,14 +11,4 @@ public class QueryController {
     String hello(@Argument String name) {
         return "Greetings, " + name + "!";
     }
-
-    @QueryMapping
-    Long random() {
-        return new Random().nextLong();
-    }
-
-    @QueryMapping
-    Date now() {
-        return new Date();
-    }
 }

examples/spring-graphql-web/src/main/java/com/introproventures/graphql/jpa/query/example/controllers/SubscriptionController.java

@@ -1,21 +1,34 @@
 package com.introproventures.graphql.jpa.query.example.controllers;
 
+import com.introproventures.graphql.jpa.query.example.controllers.dto.CreateBookResult;
 import java.time.Duration;
 import java.time.Instant;
+import java.util.List;
 import java.util.stream.Stream;
+import org.reactivestreams.Publisher;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.graphql.data.method.annotation.Argument;
 import org.springframework.graphql.data.method.annotation.SubscriptionMapping;
 import org.springframework.stereotype.Controller;
 import reactor.core.publisher.Flux;
+import reactor.core.publisher.Sinks;
 
 @Controller
 public class SubscriptionController {
 
+    @Autowired
+    private Sinks.Many<CreateBookResult> createBookResultSink;
+
     @SubscriptionMapping
     Flux<String> greetings(@Argument String name) {
         return Flux
             .fromStream(Stream.generate(() -> "Hello, " + name + "@ " + Instant.now()))
             .delayElements(Duration.ofSeconds(1))
             .take(10);
     }
+
+    @SubscriptionMapping
+    Publisher<List<CreateBookResult>> notifyBookCreated() {
+        return createBookResultSink.asFlux().buffer(Duration.ofSeconds(1));
+    }
 }

examples/spring-graphql-web/src/main/java/com/introproventures/graphql/jpa/query/example/controllers/dto/CreateBookInput.java

@@ -0,0 +1,3 @@
+package com.introproventures.graphql.jpa.query.example.controllers.dto;
+
+public record CreateBookInput(String title, Long authorId) {}

examples/spring-graphql-web/src/main/java/com/introproventures/graphql/jpa/query/example/controllers/dto/CreateBookResult.java

@@ -0,0 +1,23 @@
+package com.introproventures.graphql.jpa.query.example.controllers.dto;
+
+public record CreateBookResult(Long id) {
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public static final class Builder {
+
+        private Long id;
+
+        private Builder() {}
+
+        public Builder id(Long id) {
+            this.id = id;
+            return this;
+        }
+
+        public CreateBookResult build() {
+            return new CreateBookResult(id);
+        }
+    }
+}

examples/spring-graphql-web/src/main/java/com/introproventures/graphql/jpa/query/example/repository/BookRepository.java

@@ -0,0 +1,8 @@
+package com.introproventures.graphql.jpa.query.example.repository;
+
+import com.introproventures.graphql.jpa.query.schema.model.book.Book;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface BookRepository extends JpaRepository<Book, Long> {}