Skip to content

feat: add schema wiring support for Spring Graphql 1.0 project #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion graphql-jpa-query-autoconfigure/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@
<artifactId>graphql-jpa-query-autoconfigure</artifactId>

<dependencies>
<dependency>
<groupId>com.introproventures</groupId>
<artifactId>graphql-jpa-query-scalars</artifactId>
</dependency>
<dependency>
<groupId>com.introproventures</groupId>
<artifactId>graphql-jpa-query-schema</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>com.graphql-java</groupId>
<artifactId>graphql-java</artifactId>
Expand All @@ -25,7 +34,6 @@
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
*/
package com.introproventures.graphql.jpa.query.autoconfigure;

import javax.validation.constraints.NotEmpty;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;

import javax.validation.constraints.NotEmpty;

@ConfigurationProperties(prefix="spring.graphql.jpa.query")
@Validated
public class GraphQLJpaQueryProperties {
Expand Down Expand Up @@ -61,7 +61,11 @@ public class GraphQLJpaQueryProperties {
*/
private boolean enabled;

@NotEmpty
/**
* Web path for web controller
* Use 'spring.graphql.jpa.query.web.path' to customize default /graphql path
*/
@Deprecated
private String path;

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
package com.introproventures.graphql.jpa.query.autoconfigure;

import java.util.ArrayList;
import java.util.List;

import graphql.GraphQL;
import graphql.schema.GraphQLSchema;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
Expand All @@ -13,8 +12,8 @@
import org.springframework.context.annotation.PropertySources;
import org.springframework.util.CollectionUtils;

import graphql.GraphQL;
import graphql.schema.GraphQLSchema;
import java.util.ArrayList;
import java.util.List;

@Configuration
@ConditionalOnClass(GraphQL.class)
Expand All @@ -27,9 +26,6 @@ public class GraphQLSchemaAutoConfiguration {

private final List<GraphQLSchemaConfigurer> graphQLSchemaConfigurers = new ArrayList<>();

@Autowired
private GraphQLJpaQueryProperties properties;

@Autowired(required = true)
public void setGraphQLSchemaConfigurers(List<GraphQLSchemaConfigurer> configurers) {
if (!CollectionUtils.isEmpty(configurers)) {
Expand All @@ -39,7 +35,7 @@ public void setGraphQLSchemaConfigurers(List<GraphQLSchemaConfigurer> configurer

@Bean
@ConditionalOnMissingBean(GraphQLSchema.class)
public GraphQLSchemaFactoryBean graphQLSchemaFactoryBean() {
public GraphQLSchemaFactoryBean graphQLSchemaFactoryBean(GraphQLJpaQueryProperties properties) {
GraphQLShemaRegistrationImpl graphQLShemaRegistration = new GraphQLShemaRegistrationImpl();

for (GraphQLSchemaConfigurer configurer : graphQLSchemaConfigurers) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package com.introproventures.graphql.jpa.query.autoconfigure;

import com.introproventures.graphql.jpa.query.schema.GraphQLSchemaBuilder;
import com.introproventures.graphql.jpa.query.schema.RestrictedKeysProvider;
import com.introproventures.graphql.jpa.query.schema.impl.GraphQLJpaSchemaBuilder;
import graphql.GraphQL;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.persistence.EntityManagerFactory;

@Configuration
@ConditionalOnClass({GraphQL.class, GraphQLSchemaBuilder.class})
@ConditionalOnProperty(name="spring.graphql.jpa.query.enabled", havingValue="true", matchIfMissing=true)
@AutoConfigureBefore(GraphQLSchemaAutoConfiguration.class)
@AutoConfigureAfter(HibernateJpaAutoConfiguration.class)
public class GraphQLSchemaBuilderAutoConfiguration {
@Bean
@ConditionalOnMissingBean
@ConditionalOnSingleCandidate(EntityManagerFactory.class)
public GraphQLSchemaBuilder graphQLJpaSchemaBuilder(final EntityManagerFactory entityManagerFactory,
ObjectProvider<RestrictedKeysProvider> restrictedKeysProvider) {
GraphQLJpaSchemaBuilder bean = new GraphQLJpaSchemaBuilder(entityManagerFactory.createEntityManager());

restrictedKeysProvider.ifAvailable(bean::restrictedKeysProvider);

return bean;
}

@Bean
@ConditionalOnMissingBean
public GraphQLSchemaConfigurer graphQLJpaQuerySchemaConfigurer(GraphQLSchemaBuilder graphQLSchemaBuilder) {

return (registry) -> {
registry.register(graphQLSchemaBuilder.build());
};
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package com.introproventures.graphql.jpa.query.autoconfigure;

@FunctionalInterface
public interface GraphQLSchemaConfigurer {

void configure(GraphQLShemaRegistration registry);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,26 +1,5 @@
package com.introproventures.graphql.jpa.query.autoconfigure;

import static graphql.Assert.assertTrue;
import static graphql.schema.FieldCoordinates.coordinates;
import static graphql.util.TraversalControl.CONTINUE;

import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import graphql.schema.GraphQLNamedType;
import graphql.schema.GraphQLSchemaElement;
import org.springframework.beans.factory.config.AbstractFactoryBean;

import graphql.Internal;
import graphql.schema.DataFetcher;
import graphql.schema.FieldCoordinates;
Expand All @@ -29,16 +8,35 @@
import graphql.schema.GraphQLFieldDefinition;
import graphql.schema.GraphQLFieldsContainer;
import graphql.schema.GraphQLInterfaceType;
import graphql.schema.GraphQLNamedType;
import graphql.schema.GraphQLObjectType;
import graphql.schema.GraphQLSchema;
import graphql.schema.GraphQLSchemaElement;
import graphql.schema.GraphQLType;
import graphql.schema.GraphQLTypeVisitorStub;
import graphql.schema.GraphQLUnionType;
import graphql.schema.PropertyDataFetcher;
import graphql.schema.TypeResolver;
import graphql.util.TraversalControl;
import graphql.util.TraverserContext;
import graphql.util.Traverser;
import org.springframework.beans.factory.config.AbstractFactoryBean;

import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import static graphql.Assert.assertTrue;
import static graphql.schema.FieldCoordinates.coordinates;
import static graphql.util.TraversalControl.CONTINUE;


public class GraphQLSchemaFactoryBean extends AbstractFactoryBean<GraphQLSchema>{
Expand Down Expand Up @@ -145,7 +143,7 @@ protected GraphQLSchema createInstance() throws Exception {
if (!types.isEmpty()) {
schemaBuilder.additionalTypes(types);
}

if(!mutations.isEmpty())
schemaBuilder.mutation(GraphQLObjectType.newObject()
.name(this.mutationName)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.introproventures.graphql.jpa.query.autoconfigure.GraphQLSchemaAutoConfiguration
com.introproventures.graphql.jpa.query.autoconfigure.GraphQLSchemaAutoConfiguration,\
com.introproventures.graphql.jpa.query.autoconfigure.GraphQLSchemaBuilderAutoConfiguration
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@ spring.graphql.jpa.query.description=Query root
spring.graphql.jpa.query.useDistinctParameter=false
spring.graphql.jpa.query.defaultDistinct=true
spring.graphql.jpa.query.enabled=true
spring.graphql.jpa.query.path=/graphql
Original file line number Diff line number Diff line change
@@ -1,47 +1,45 @@
package com.introproventures.graphql.jpa.query.autoconfigure;

import static graphql.annotations.AnnotationsSchemaCreator.newAnnotationsSchema;
import static graphql.schema.GraphQLFieldDefinition.newFieldDefinition;
import static org.assertj.core.api.Assertions.assertThat;

import java.util.Collections;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.reflections.Reflections;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.util.StringUtils;

import com.introproventures.graphql.jpa.query.autoconfigure.support.AdditionalGraphQLType;
import com.introproventures.graphql.jpa.query.autoconfigure.support.MutationRoot;
import com.introproventures.graphql.jpa.query.autoconfigure.support.QueryRoot;
import com.introproventures.graphql.jpa.query.autoconfigure.support.SubscriptionRoot;

import graphql.Directives;
import graphql.GraphQL;
import graphql.Scalars;
import graphql.annotations.AnnotationsSchemaCreator;
import graphql.annotations.annotationTypes.GraphQLField;
import graphql.annotations.annotationTypes.GraphQLInvokeDetached;
import graphql.annotations.annotationTypes.GraphQLName;
import graphql.annotations.annotationTypes.directives.definition.GraphQLDirectiveDefinition;
import graphql.scalars.ExtendedScalars;
import graphql.schema.FieldCoordinates;
import graphql.schema.GraphQLCodeRegistry;
import graphql.schema.GraphQLDirective;
import graphql.schema.GraphQLFieldDefinition;
import graphql.schema.GraphQLObjectType;
import graphql.schema.GraphQLSchema;
import graphql.schema.StaticDataFetcher;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.reflections.Reflections;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.util.StringUtils;

import java.util.Collections;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import static graphql.annotations.AnnotationsSchemaCreator.newAnnotationsSchema;
import static graphql.schema.GraphQLFieldDefinition.newFieldDefinition;
import static org.assertj.core.api.Assertions.assertThat;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment=WebEnvironment.NONE)
Expand Down Expand Up @@ -124,7 +122,13 @@ public static class AnnotatedQuery implements QueryRoot {
public Greeting greeting(@GraphQLName("name") String name) {
return new Greeting("Hi, " + name + "!");
}


@GraphQLField
@GraphQLInvokeDetached
public Long count() {
return Long.valueOf(1);
}

public static class Greeting {

@GraphQLField
Expand All @@ -151,6 +155,9 @@ public void configure(GraphQLShemaRegistration registry) {
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("greet2")
.type(Scalars.GraphQLString))
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("count1")
.type(ExtendedScalars.GraphQLLong))
.build();

GraphQLCodeRegistry codeRegistry = GraphQLCodeRegistry.newCodeRegistry()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@ spring:
name: GraphQLBooks
description: GraphQL Books Schema Description
enabled: true
path: /graphql
Loading