distinct sql and ignore field in filters and sorting (#95)

miklemv · igdianov · commit bde04d570294 · 2019-03-17T11:00:11.000-07:00
* change distinct and annotation filter and sort

* fix - distinct params to scheme builder

* fix sub filter
diff --git a/graphql-jpa-query-annotations/src/main/java/com/introproventures/graphql/jpa/query/annotation/GraphQLIgnoreFilter.java b/graphql-jpa-query-annotations/src/main/java/com/introproventures/graphql/jpa/query/annotation/GraphQLIgnoreFilter.java
@@ -0,0 +1,14 @@
+package com.introproventures.graphql.jpa.query.annotation;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+@Target( { TYPE, FIELD })
+@Retention(RUNTIME)
+public @interface GraphQLIgnoreFilter {
+}
+
diff --git a/graphql-jpa-query-annotations/src/main/java/com/introproventures/graphql/jpa/query/annotation/GraphQLIgnoreOrder.java b/graphql-jpa-query-annotations/src/main/java/com/introproventures/graphql/jpa/query/annotation/GraphQLIgnoreOrder.java
@@ -0,0 +1,14 @@
+package com.introproventures.graphql.jpa.query.annotation;
+
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+@Target( { FIELD })
+@Retention(RUNTIME)
+public @interface GraphQLIgnoreOrder {
+}
+
diff --git a/graphql-jpa-query-autoconfigure/src/main/java/com/introproventures/graphql/jpa/query/autoconfigure/GraphQLJpaQueryProperties.java b/graphql-jpa-query-autoconfigure/src/main/java/com/introproventures/graphql/jpa/query/autoconfigure/GraphQLJpaQueryProperties.java
@@ -36,6 +36,16 @@ public class GraphQLJpaQueryProperties {
     @NotEmpty
     private String description;
 
+    /**
+     * Enable or disable distinct parameter.
+     */
+    private boolean useDistinctParameter;
+
+    /**
+     * Enable or disable distinct distinct sql query fetcher.
+     */
+    private boolean distinctFetcher;
+
     /**
      * Enable or disable QraphQL module services.
      */
@@ -78,6 +88,34 @@ public void setDescription(String description) {
         this.description = description;
     }
 
+    /**
+     * @return the useDistinctParameter
+     */
+    public boolean isUseDistinctParameter() {
+        return useDistinctParameter;
+    }
+
+    /**
+     * @param useDistinctParameter the useDistinctParameter to set
+     */
+    public void setUseDistinctParameter(boolean useDistinctParameter) {
+        this.useDistinctParameter = useDistinctParameter;
+    }
+
+    /**
+     * @return the distinctFetcher
+     */
+    public boolean isDistinctFetcher() {
+        return distinctFetcher;
+    }
+
+    /**
+     * @param distinctFetcher the distinctFetcher to set
+     */
+    public void setDistinctFetcher(boolean distinctFetcher) {
+        this.distinctFetcher = distinctFetcher;
+    }
+
     /**
      * @return the enabled
      */
diff --git a/graphql-jpa-query-autoconfigure/src/main/resources/com/introproventures/graphql/jpa/query/boot/autoconfigure/default.properties b/graphql-jpa-query-autoconfigure/src/main/resources/com/introproventures/graphql/jpa/query/boot/autoconfigure/default.properties
@@ -1,4 +1,6 @@
 spring.graphql.jpa.query.name=Query
 spring.graphql.jpa.query.description=
+spring.graphql.jpa.query.useDistinctParameter=false
+spring.graphql.jpa.query.distinctFetcher=false
 spring.graphql.jpa.query.enabled=true
 spring.graphql.jpa.query.path=/graphql
diff --git a/graphql-jpa-query-boot-starter/src/main/resources/com/introproventures/graphql/jpa/query/boot/autoconfigure/default.properties b/graphql-jpa-query-boot-starter/src/main/resources/com/introproventures/graphql/jpa/query/boot/autoconfigure/default.properties
@@ -1,4 +1,6 @@
 spring.graphql.jpa.query.name=GraphQLJpaQuery
 spring.graphql.jpa.query.description=GraphQL Jpa Query Schema Specification
+spring.graphql.jpa.query.useDistinctParameter=false
+spring.graphql.jpa.query.distinctFetcher=false
 spring.graphql.jpa.query.enabled=true
 spring.graphql.jpa.query.path=/graphql
diff --git a/graphql-jpa-query-example-merge/pom.xml b/graphql-jpa-query-example-merge/pom.xml
@@ -32,7 +32,7 @@
       <groupId>com.introproventures</groupId>
       <artifactId>graphql-jpa-query-autoconfigure</artifactId>
     </dependency>
-    
+
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
diff --git a/graphql-jpa-query-example-merge/src/main/java/com/introproventures/graphql/jpa/query/example/books/Book.java b/graphql-jpa-query-example-merge/src/main/java/com/introproventures/graphql/jpa/query/example/books/Book.java
@@ -23,6 +23,8 @@
 import javax.persistence.Id;
 import javax.persistence.ManyToOne;
 
+import com.introproventures.graphql.jpa.query.annotation.GraphQLIgnoreFilter;
+import com.introproventures.graphql.jpa.query.annotation.GraphQLIgnoreOrder;
 import lombok.Data;
 
 @Data
@@ -31,6 +33,8 @@ public class Book {
 	@Id
 	Long id;
 
+	@GraphQLIgnoreOrder
+	@GraphQLIgnoreFilter
 	String title;
 
 	@ManyToOne(fetch=FetchType.LAZY)
diff --git a/graphql-jpa-query-example-merge/src/main/java/com/introproventures/graphql/jpa/query/example/books/BooksSchemaConfiguration.java b/graphql-jpa-query-example-merge/src/main/java/com/introproventures/graphql/jpa/query/example/books/BooksSchemaConfiguration.java
@@ -7,11 +7,13 @@
 import javax.persistence.EntityManagerFactory;
 import javax.sql.DataSource;
 
+import com.introproventures.graphql.jpa.query.autoconfigure.GraphQLJpaQueryProperties;
 import com.introproventures.graphql.jpa.query.autoconfigure.GraphQLSchemaConfigurer;
 import com.introproventures.graphql.jpa.query.autoconfigure.GraphQLShemaRegistration;
 import com.introproventures.graphql.jpa.query.schema.impl.GraphQLJpaSchemaBuilder;
 import org.hibernate.cfg.AvailableSettings;
 import org.hibernate.dialect.H2Dialect;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.jdbc.DataSourceBuilder;
@@ -74,14 +76,22 @@ public static class GraphQLJpaQuerySchemaConfigurer implements GraphQLSchemaConf
 
         private final EntityManager entityManager;
 
+        @Autowired
+        private GraphQLJpaQueryProperties properties;
+
         public GraphQLJpaQuerySchemaConfigurer(@Qualifier("bookEntityManager") EntityManagerFactory entityManager) {
             this.entityManager = entityManager.createEntityManager();
         }
 
         @Override
         public void configure(GraphQLShemaRegistration registry) {
-
-            registry.register(new GraphQLJpaSchemaBuilder(entityManager).name("GraphQLBooks").build());
+            registry.register(
+                    new GraphQLJpaSchemaBuilder(entityManager)
+                        .name("GraphQLBooks")
+                        .useDistinctParameter(properties.isUseDistinctParameter())
+                        .setDistinctFetcher(properties.isDistinctFetcher())
+                        .build()
+            );
         }
     }
     
diff --git a/graphql-jpa-query-example-merge/src/main/resources/application.yml b/graphql-jpa-query-example-merge/src/main/resources/application.yml
@@ -10,7 +10,9 @@ spring:
       query:
         name: Query
         description: Combined GraphQL Jpa Query for Starwars and Books Example
+        useDistinctParameter: true
         enabled: true
+        path: graphql
         
 starwars:
   hikari:
diff --git a/graphql-jpa-query-schema/src/main/java/com/introproventures/graphql/jpa/query/schema/impl/GraphQLJpaQueryDataFetcher.java b/graphql-jpa-query-schema/src/main/java/com/introproventures/graphql/jpa/query/schema/impl/GraphQLJpaQueryDataFetcher.java
@@ -46,6 +46,8 @@
  *
  */
 class GraphQLJpaQueryDataFetcher extends QraphQLJpaBaseDataFetcher {
+
+    private boolean defaultDistinct = false;
 	
     private static final String HIBERNATE_QUERY_PASS_DISTINCT_THROUGH = "hibernate.query.passDistinctThrough";
     private static final String ORG_HIBERNATE_CACHEABLE = "org.hibernate.cacheable";
@@ -57,6 +59,19 @@ public GraphQLJpaQueryDataFetcher(EntityManager entityManager, EntityType<?> ent
         super(entityManager, entityType);
     }
 
+    public GraphQLJpaQueryDataFetcher(EntityManager entityManager, EntityType<?> entityType, boolean defaultDistinct) {
+        super(entityManager, entityType);
+        this.defaultDistinct = defaultDistinct;
+    }
+
+    public boolean isDefaultDistinct() {
+        return defaultDistinct;
+    }
+
+    public void setDefaultDistinct(boolean defaultDistinct) {
+        this.defaultDistinct = defaultDistinct;
+    }
+
     @Override
     public Object get(DataFetchingEnvironment environment) {
         Field field = environment.getFields().iterator().next();
@@ -69,7 +84,7 @@ public Object get(DataFetchingEnvironment environment) {
 
         Optional<Argument> pageArgument = getPageArgument(field);
         Page page = extractPageArgument(environment, field);
-        Argument distinctArg = extractArgument(environment, field, GraphQLJpaSchemaBuilder.SELECT_DISTINCT_PARAM_NAME, new BooleanValue(true));
+        Argument distinctArg = extractArgument(environment, field, GraphQLJpaSchemaBuilder.SELECT_DISTINCT_PARAM_NAME, new BooleanValue(defaultDistinct));
         
         boolean isDistinct = ((BooleanValue) distinctArg.getValue()).isValue();
         
diff --git a/graphql-jpa-query-schema/src/main/java/com/introproventures/graphql/jpa/query/schema/impl/GraphQLJpaSchemaBuilder.java b/graphql-jpa-query-schema/src/main/java/com/introproventures/graphql/jpa/query/schema/impl/GraphQLJpaSchemaBuilder.java
@@ -43,6 +43,8 @@
 import javax.persistence.metamodel.SingularAttribute;
 import javax.persistence.metamodel.Type;
 
+import com.introproventures.graphql.jpa.query.annotation.GraphQLIgnoreFilter;
+import com.introproventures.graphql.jpa.query.annotation.GraphQLIgnoreOrder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -113,6 +115,9 @@ public class GraphQLJpaSchemaBuilder implements GraphQLSchemaBuilder {
     
     private String description = "GraphQL Schema for all entities in this JPA application";
 
+    private boolean distinctParameter = false;
+    private boolean distinctFetcher = false;
+
     public GraphQLJpaSchemaBuilder(EntityManager entityManager) {
         this.entityManager = entityManager;
     }
@@ -192,22 +197,34 @@ private GraphQLFieldDefinition getQueryFieldSelectDefinition(EntityType<?> entit
                     .build()
                 )
                 .build();
-        
-        return GraphQLFieldDefinition.newFieldDefinition()
+
+        GraphQLFieldDefinition.Builder fdBuilder =  GraphQLFieldDefinition.newFieldDefinition()
                 .name(namingStrategy.pluralize(entityType.getName()))
                 .description("Query request wrapper for " + entityType.getName() + " to request paginated data. "
                     + "Use query request arguments to specify query filter criterias. "
                     + "Use the '"+QUERY_SELECT_PARAM_NAME+"' field to request actual fields. "
                     + "Use the '"+ORDER_BY_PARAM_NAME+"' on a field to specify sort order for each field. ")
                 .type(pageType)
-                .dataFetcher(new GraphQLJpaQueryDataFetcher(entityManager, entityType))
+                .dataFetcher(new GraphQLJpaQueryDataFetcher(entityManager, entityType, distinctFetcher))
                 .argument(paginationArgument)
-                .argument(getWhereArgument(entityType))
-                .build();
+                .argument(getWhereArgument(entityType));
+        if (distinctParameter) {
+                fdBuilder.argument(distinctArgument(entityType));
+        }
+
+        return fdBuilder.build();
     }
 
     private Map<Class<?>, GraphQLArgument> whereArgumentsMap = new HashMap<>();
 
+    private GraphQLArgument distinctArgument(EntityType<?> entityType) {
+        return GraphQLArgument.newArgument()
+                .name(SELECT_DISTINCT_PARAM_NAME)
+                .description("Distinct logical specification")
+                .type(Scalars.GraphQLBoolean)
+                .build();
+    }
+
     private GraphQLArgument getWhereArgument(ManagedType<?> managedType) {
     	String typeName="";
     	if (managedType instanceof EmbeddableType){
@@ -241,18 +258,21 @@ private GraphQLArgument getWhereArgument(ManagedType<?> managedType) {
             .fields(managedType.getAttributes().stream()
                                                .filter(this::isValidInput)
                                                .filter(this::isNotIgnored)
+                                               .filter(this::isNotIgnoredFilter)
                                                .map(this::getWhereInputField)
                                                .collect(Collectors.toList())
             )
             .fields(managedType.getAttributes().stream()
                                                .filter(this::isToOne)
                                                .filter(this::isNotIgnored)
+                                               .filter(this::isNotIgnoredFilter)
                                                .map(this::getInputObjectField)
                                                .collect(Collectors.toList())
             )
             .fields(managedType.getAttributes().stream()
                                                 .filter(this::isToMany)
                                                 .filter(this::isNotIgnored)
+                                                .filter(this::isNotIgnoredFilter)
                                                 .map(this::getInputObjectField)
                                                 .collect(Collectors.toList())
             )
@@ -302,6 +322,7 @@ private GraphQLInputObjectType computeWhereInputType(ManagedType<?> managedType)
             .fields(managedType.getAttributes().stream()
                 .filter(this::isValidInput)
                 .filter(this::isNotIgnored)
+                .filter(this::isNotIgnoredFilter)
                 .map(this::getWhereInputField)
                 .collect(Collectors.toList())
             )
@@ -568,7 +589,8 @@ private GraphQLFieldDefinition getObjectField(Attribute attribute) {
 
         // Only add the orderBy argument for basic attribute types
         if (attribute instanceof SingularAttribute
-            && attribute.getPersistentAttributeType() == Attribute.PersistentAttributeType.BASIC) {
+            && attribute.getPersistentAttributeType() == Attribute.PersistentAttributeType.BASIC
+            && isNotIgnoredOrder(attribute) ) {
             arguments.add(GraphQLArgument.newArgument()
                 .name(ORDER_BY_PARAM_NAME)
                 .description("Specifies field sort direction in the query results.")
@@ -816,6 +838,37 @@ private boolean isNotIgnored(AnnotatedElement annotatedElement) {
 
         return false;
     }
+
+    protected boolean isNotIgnoredFilter(Attribute<?,?> attribute) {
+        return isNotIgnoredFilter(attribute.getJavaMember()) && isNotIgnoredFilter(attribute.getJavaType());
+    }
+
+    protected boolean isNotIgnoredFilter(EntityType<?> entityType) {
+        return isNotIgnoredFilter(entityType.getJavaType());
+    }
+
+    protected boolean isNotIgnoredFilter(Member member) {
+        return member instanceof AnnotatedElement && isNotIgnoredFilter((AnnotatedElement) member);
+    }
+
+    protected boolean isNotIgnoredFilter(AnnotatedElement annotatedElement) {
+        if (annotatedElement != null) {
+            GraphQLIgnoreFilter schemaDocumentation = annotatedElement.getAnnotation(GraphQLIgnoreFilter.class);
+            return schemaDocumentation == null;
+        }
+
+        return false;
+    }
+
+    protected boolean isNotIgnoredOrder(Attribute<?,?> attribute) {
+        AnnotatedElement annotatedElement = (AnnotatedElement)attribute.getJavaMember();
+        if (annotatedElement != null) {
+            GraphQLIgnoreOrder schemaDocumentation = annotatedElement.getAnnotation(GraphQLIgnoreOrder.class);
+            return schemaDocumentation == null;
+        }
+        return false;
+    }
+
     
     @SuppressWarnings( "unchecked" )
     private GraphQLOutputType getGraphQLTypeFromJavaType(Class<?> clazz) {
@@ -934,6 +987,26 @@ public GraphQLJpaSchemaBuilder description(String description) {
         return this;
     }
 
+    public GraphQLJpaSchemaBuilder useDistinctParameter(boolean distinctArgument) {
+        this.distinctParameter = distinctArgument;
+
+        return this;
+    }
+
+    public boolean isDistinctParameter() {
+        return distinctParameter;
+    }
+
+    public boolean isDistinctFetcher() {
+        return distinctFetcher;
+    }
+
+    public GraphQLJpaSchemaBuilder setDistinctFetcher(boolean distinctFetcher) {
+        this.distinctFetcher = distinctFetcher;
+
+        return this;
+    }
+
     /**
      * @param namingStrategy the namingStrategy to set
      */
diff --git a/graphql-jpa-query-schema/src/test/java/com/introproventures/graphql/jpa/query/schema/GraphQLExecutorTests.java b/graphql-jpa-query-schema/src/test/java/com/introproventures/graphql/jpa/query/schema/GraphQLExecutorTests.java
diff --git a/graphql-jpa-query-schema/src/test/java/com/introproventures/graphql/jpa/query/schema/StarwarsSchemaBuildWithDistinctTest.java b/graphql-jpa-query-schema/src/test/java/com/introproventures/graphql/jpa/query/schema/StarwarsSchemaBuildWithDistinctTest.java
diff --git a/graphql-jpa-query-schema/src/test/java/com/introproventures/graphql/jpa/query/schema/model/book/Book.java b/graphql-jpa-query-schema/src/test/java/com/introproventures/graphql/jpa/query/schema/model/book/Book.java
diff --git a/graphql-jpa-query-schema/src/test/resources/data.sql b/graphql-jpa-query-schema/src/test/resources/data.sql
