Do not put validation annotaiton if return type is a nullable list having non-null values #959 (#960)

Author: kobylynskyi

src/main/java/com/kobylynskyi/graphql/codegen/mapper/AnnotationsMapper.java

@@ -6,6 +6,7 @@
 import com.kobylynskyi.graphql.codegen.utils.Utils;
 import graphql.language.Argument;
 import graphql.language.Directive;
+import graphql.language.InputValueDefinition;
 import graphql.language.ListType;
 import graphql.language.NamedNode;
 import graphql.language.NonNullType;
@@ -39,9 +40,20 @@ public abstract class AnnotationsMapper {
     public List<String> getAnnotations(MappingContext mappingContext, Type<?> type,
                                        NamedNode<?> def, String parentTypeName, boolean mandatory) {
         if (type instanceof ListType) {
-            return getAnnotations(mappingContext, ((ListType) type).getType(), def, parentTypeName, mandatory);
+            Type<?> subType = ((ListType) type).getType();
+            return getAnnotations(mappingContext, subType, def, parentTypeName, mandatory);
         } else if (type instanceof NonNullType) {
-            return getAnnotations(mappingContext, ((NonNullType) type).getType(), def, parentTypeName, true);
+            Type<?> parentType = null;
+            if (def instanceof ExtendedFieldDefinition) {
+                parentType = ((ExtendedFieldDefinition) def).getType();
+            } else if (def instanceof InputValueDefinition) {
+                parentType = ((InputValueDefinition) def).getType();
+            }
+            // if parent is a list, then pass a mandatory flag as is (do not override it)
+            if (!(parentType instanceof ListType)) {
+                mandatory = true;
+            }
+            return getAnnotations(mappingContext, ((NonNullType) type).getType(), def, parentTypeName, mandatory);
         } else if (type instanceof TypeName) {
             return getAnnotations(mappingContext, ((TypeName) type).getName(), def.getName(), parentTypeName,
                     getDirectives(def), mandatory, def);

src/test/java/com/kobylynskyi/graphql/codegen/GraphQLCodegenAnnotationsTest.java

@@ -266,4 +266,20 @@ void generate_Directives() throws Exception {
             getFileByName(files, "User.java"));
     }
 
+    @Test
+    void generate_ModelValidationAnnotationForSubType() throws Exception {
+        new JavaGraphQLCodegen(singletonList(
+                "src/test/resources/schemas/nullable-list-type-with-nullable-sub-types.graphqls"),
+                outputBuildDir, mappingConfig, TestUtils.getStaticGeneratedInfo()).generate();
+
+        File[] files = Objects.requireNonNull(outputJavaClassesDir.listFiles());
+        assertSameTrimmedContent(
+                new File("src/test/resources/expected-classes/annotation/" +
+                        "NullableListReturnTypeWithMandatoryElementsQueryResolver.java.txt"),
+                getFileByName(files, "NullableListReturnTypeWithMandatoryElementsQueryResolver.java"));
+        assertSameTrimmedContent(
+                new File("src/test/resources/expected-classes/annotation/TypeWithNullableListType.java.txt"),
+                getFileByName(files, "TypeWithNullableListType.java"));
+    }
+
 }

src/test/resources/expected-classes/CommitResolver.java.txt

@@ -19,7 +19,7 @@ public interface CommitResolver {
     @javax.validation.constraints.NotNull
     CommitCommentConnection comments(Commit commit, String after, String before, Integer first, Integer last, graphql.schema.DataFetchingEnvironment env) throws Exception;
 
-    DeploymentConnection deployments(Commit commit, String after, String before, @javax.validation.constraints.NotNull java.util.List<String> environments, Integer first, Integer last, DeploymentOrder orderBy, graphql.schema.DataFetchingEnvironment env) throws Exception;
+    DeploymentConnection deployments(Commit commit, String after, String before, java.util.List<String> environments, Integer first, Integer last, DeploymentOrder orderBy, graphql.schema.DataFetchingEnvironment env) throws Exception;
 
     @javax.validation.constraints.NotNull
     CommitHistoryConnection history(Commit commit, String after, CommitAuthor author, String before, Integer first, Integer last, String path, String since, String until, graphql.schema.DataFetchingEnvironment env) throws Exception;

src/test/resources/expected-classes/ProfileOwner.java.txt

@@ -25,10 +25,10 @@ public interface ProfileOwner {
     String getName();
 
     @javax.validation.constraints.NotNull
-    PinnableItemConnection getPinnableItems(String after, String before, Integer first, Integer last, @javax.validation.constraints.NotNull java.util.List<PinnableItemType> types);
+    PinnableItemConnection getPinnableItems(String after, String before, Integer first, Integer last, java.util.List<PinnableItemType> types);
 
     @javax.validation.constraints.NotNull
-    PinnableItemConnection getPinnedItems(String after, String before, Integer first, Integer last, @javax.validation.constraints.NotNull java.util.List<PinnableItemType> types);
+    PinnableItemConnection getPinnedItems(String after, String before, Integer first, Integer last, java.util.List<PinnableItemType> types);
 
     int getPinnedItemsRemaining();
 

src/test/resources/expected-classes/annotation/NullableListReturnTypeWithMandatoryElementsQueryResolver.java.txt

@@ -0,0 +1,18 @@
+package com.kobylynskyi.graphql.test1;
+
+
+/**
+ * NonNull validation annotation should not be present here
+ */
+@javax.annotation.Generated(
+    value = "com.kobylynskyi.graphql.codegen.GraphQLCodegen",
+    date = "2020-12-31T23:59:59-0500"
+)
+public interface NullableListReturnTypeWithMandatoryElementsQueryResolver {
+
+    /**
+     * NonNull validation annotation should not be present here
+     */
+    java.util.List<TypeWithNullableListType> nullableListReturnTypeWithMandatoryElements() throws Exception;
+
+}

src/test/resources/expected-classes/annotation/TypeWithNullableListType.java.txt

@@ -0,0 +1,61 @@
+package com.kobylynskyi.graphql.test1;
+
+
+@javax.annotation.Generated(
+    value = "com.kobylynskyi.graphql.codegen.GraphQLCodegen",
+    date = "2020-12-31T23:59:59-0500"
+)
+public class TypeWithNullableListType implements java.io.Serializable {
+
+    private static final long serialVersionUID = 1L;
+
+    private java.util.List<Type2> nullableListFieldWithMandatoryElements;
+
+    public TypeWithNullableListType() {
+    }
+
+    public TypeWithNullableListType(java.util.List<Type2> nullableListFieldWithMandatoryElements) {
+        this.nullableListFieldWithMandatoryElements = nullableListFieldWithMandatoryElements;
+    }
+
+    /**
+     * NonNull validation annotation should not be present here
+     */
+    public java.util.List<Type2> getNullableListFieldWithMandatoryElements() {
+        return nullableListFieldWithMandatoryElements;
+    }
+    /**
+     * NonNull validation annotation should not be present here
+     */
+    public void setNullableListFieldWithMandatoryElements(java.util.List<Type2> nullableListFieldWithMandatoryElements) {
+        this.nullableListFieldWithMandatoryElements = nullableListFieldWithMandatoryElements;
+    }
+
+
+
+    public static TypeWithNullableListType.Builder builder() {
+        return new TypeWithNullableListType.Builder();
+    }
+
+    public static class Builder {
+
+        private java.util.List<Type2> nullableListFieldWithMandatoryElements;
+
+        public Builder() {
+        }
+
+        /**
+         * NonNull validation annotation should not be present here
+         */
+        public Builder setNullableListFieldWithMandatoryElements(java.util.List<Type2> nullableListFieldWithMandatoryElements) {
+            this.nullableListFieldWithMandatoryElements = nullableListFieldWithMandatoryElements;
+            return this;
+        }
+
+
+        public TypeWithNullableListType build() {
+            return new TypeWithNullableListType(nullableListFieldWithMandatoryElements);
+        }
+
+    }
+}

src/test/resources/expected-classes/deprecated/EventsQueryResolver.java.txt

@@ -8,7 +8,6 @@ package com.kobylynskyi.graphql.test1;
 public interface EventsQueryResolver {
 
     @Deprecated
-    @javax.validation.constraints.NotNull
     java.util.List<Event> events() throws Exception;
 
 }

src/test/resources/expected-classes/deprecated/QueryResolver.java.txt

@@ -8,7 +8,6 @@ package com.kobylynskyi.graphql.test1;
 public interface QueryResolver {
 
     @Deprecated
-    @javax.validation.constraints.NotNull
     java.util.List<Event> events() throws Exception;
 
 }

src/test/resources/expected-classes/extend-with-resolvers/AssetsQueryResolver.java.txt

@@ -4,7 +4,6 @@
 )
 public interface AssetsQueryResolver {
 
-    @javax.validation.constraints.NotNull
     java.util.List<Asset> assets() throws Exception;
 
 }

src/test/resources/expected-classes/extend-with-resolvers/EventInput.java.txt

@@ -8,7 +8,6 @@ public class EventInput implements java.io.Serializable {
 
     @javax.validation.constraints.NotNull
     private Status status;
-    @javax.validation.constraints.NotNull
     private java.util.List<AssetInput> assets;
 
     public EventInput() {