fix: add graphql valid object annotation to all input and output types (#45)

danadajian · web-flow · commit 9a40a3d01669 · 2024-04-26T11:31:30.000-05:00
* failing test

* pass test

* refactor

* improve test cases

* fix: include GraphQLValidObject annotation on all input and output types
diff --git a/src/definitions/input.ts b/src/definitions/input.ts
@@ -56,7 +56,9 @@ export function buildInputObjectDefinition(
     definitionNode: node,
   });
 
-  return `${annotations}data class ${node.name.value}(
+  const inputRestrictionAnnotation =
+    "@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])\n";
+  return `${annotations}${inputRestrictionAnnotation}data class ${node.name.value}(
 ${classMembers}
 )`;
 }
diff --git a/src/definitions/object.ts b/src/definitions/object.ts
@@ -24,6 +24,7 @@ import { isResolverType } from "../helpers/is-resolver-type";
 import { buildFieldDefinition } from "../helpers/build-field-definition";
 import { isExternalField } from "../helpers/is-external-field";
 import { CodegenConfigWithDefaults } from "../helpers/build-config-with-defaults";
+import { inputTypeHasMatchingOutputType } from "../helpers/input-type-has-matching-output-type";
 
 export function buildObjectTypeDefinition(
   node: ObjectTypeDefinitionNode,
@@ -57,7 +58,14 @@ ${getDataClassMembers({ node, schema, config, completableFuture: true })}
 }`;
   }
 
-  return `${annotations}data class ${name}(
+  const potentialMatchingInputType = schema.getType(`${name}Input`)?.astNode;
+  const typeWillBeConsolidated =
+    potentialMatchingInputType?.kind === Kind.INPUT_OBJECT_TYPE_DEFINITION &&
+    inputTypeHasMatchingOutputType(potentialMatchingInputType, schema);
+  const outputRestrictionAnnotation = typeWillBeConsolidated
+    ? ""
+    : "@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])\n";
+  return `${annotations}${outputRestrictionAnnotation}data class ${name}(
 ${getDataClassMembers({ node, schema, config })}
 )${interfaceInheritance}`;
 }
diff --git a/test/unit/should_annotate_types_properly/expected.kt b/test/unit/should_annotate_types_properly/expected.kt
@@ -3,6 +3,7 @@ package com.kotlin.generated
 import com.expediagroup.graphql.generator.annotations.*
 
 @GraphQLDescription("A description for MyType")
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeThatShouldBeProperlyAnnotated(
     val field: String? = null,
     @GraphQLDescription("A description for fieldWithDescription")
diff --git a/test/unit/should_consolidate_input_and_output_types/expected.kt b/test/unit/should_consolidate_input_and_output_types/expected.kt
@@ -25,28 +25,34 @@ data class MyTypeToConsolidate4(
     val field: String? = null
 )
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyTypeNotToConsolidate(
     val field: String? = null
 )
 
 @GraphQLDescription("The type name must exactly match in order to consolidate")
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
 data class MyTypeToNotConsolidateInput(
     val field: String? = null
 )
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyTypeToNotConsolidate2(
     val field: String? = null
 )
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
 data class MyTypeInputToNotConsolidate2(
     val field: String? = null
 )
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyTypeWhereFieldsDoNotMatch(
     val field: String? = null,
     val field2: String? = null
 )
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
 data class MyTypeWhereFieldsDoNotMatchInput(
     val field: String? = null,
     val field2: Int? = null
diff --git a/test/unit/should_convert_graphql_float_to_kotlin_double/expected.kt b/test/unit/should_convert_graphql_float_to_kotlin_double/expected.kt
@@ -2,6 +2,7 @@ package com.kotlin.generated
 
 import com.expediagroup.graphql.generator.annotations.*
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyFloatType(
     val field: Double? = null
 )
diff --git a/test/unit/should_default_non_nullable_boolean_fields_to_false/expected.kt b/test/unit/should_default_non_nullable_boolean_fields_to_false/expected.kt
@@ -2,6 +2,7 @@ package com.kotlin.generated
 
 import com.expediagroup.graphql.generator.annotations.*
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyBooleanType(
     val field: Boolean = false,
     val field2: Boolean? = null
diff --git a/test/unit/should_generate_field_resolver_interfaces/expected.kt b/test/unit/should_generate_field_resolver_interfaces/expected.kt
@@ -18,6 +18,7 @@ interface QueryCompletableFuture {
     fun nonNullableResolver(arg: InputTypeGenerateFieldResolverInterfaces): java.util.concurrent.CompletableFuture<String>
 }
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
 data class InputTypeGenerateFieldResolverInterfaces(
     val field: String? = null
 )
diff --git a/test/unit/should_generate_input_types_properly/expected.kt b/test/unit/should_generate_input_types_properly/expected.kt
@@ -3,6 +3,7 @@ package com.kotlin.generated
 import com.expediagroup.graphql.generator.annotations.*
 
 @GraphQLDescription("A description for MyInputType")
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
 data class InputTypeThatShouldBeGeneratedProperly(
     val field1: String? = null,
     @GraphQLDescription("A description for field2")
diff --git a/test/unit/should_generate_interfaces_with_inheritance/expected.kt b/test/unit/should_generate_interfaces_with_inheritance/expected.kt
@@ -9,6 +9,7 @@ interface InterfaceWithInheritance {
 }
 
 @GraphQLDescription("A description for MyInterfaceImplementation")
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyInterfaceImplementation(
     override val field: String? = null,
     override val field2: String
@@ -22,6 +23,7 @@ interface InheritedInterface2 {
     val field2: String
 }
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyMergedInterfaceImplementation(
     override val field: String? = null,
     override val field2: String
diff --git a/test/unit/should_generate_list_types_properly/expected.kt b/test/unit/should_generate_list_types_properly/expected.kt
@@ -2,6 +2,7 @@ package com.kotlin.generated
 
 import com.expediagroup.graphql.generator.annotations.*
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyListType(
     val field: List<String> = emptyList(),
     val field2: List<String?> = emptyList(),
diff --git a/test/unit/should_generate_multi_union_types_properly/expected.kt b/test/unit/should_generate_multi_union_types_properly/expected.kt
@@ -2,10 +2,12 @@ package com.kotlin.generated
 
 import com.expediagroup.graphql.generator.annotations.*
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyType3(
     val field: String? = null
 ) : MyUnion1, MyUnion2
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyType4(
     val field: String? = null
 ) : MyUnion1, MyUnion2
@@ -14,6 +16,7 @@ interface MyUnion1
 
 interface MyUnion2
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyMultiUnionType(
     val field: MyUnion1? = null,
     val field2: MyUnion2? = null
diff --git a/test/unit/should_generate_non_nullable_union_list_types_properly/expected.kt b/test/unit/should_generate_non_nullable_union_list_types_properly/expected.kt
@@ -3,17 +3,20 @@ package com.kotlin.generated
 import com.expediagroup.graphql.generator.annotations.*
 
 @GraphQLDescription("A description for MyType1")
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeForNonNullableUnionList1(
     val field: String? = null
 ) : UnionForNonNullableList
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeForNonNullableUnionList2(
     val field: String? = null
 ) : UnionForNonNullableList
 
 @GraphQLDescription("A description for UnionForNonNullableList")
 interface UnionForNonNullableList
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyNonNullableUnionListType(
     val field: List<UnionForNonNullableList> = emptyList(),
     val field2: List<UnionForNonNullableList?> = emptyList()
diff --git a/test/unit/should_generate_type_with_interface_field_type/expected.kt b/test/unit/should_generate_type_with_interface_field_type/expected.kt
@@ -8,6 +8,7 @@ interface MyInterface {
     val field2: String
 }
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyInterfaceFieldType(
     val field: MyInterface? = null,
     val field2: MyInterface
diff --git a/test/unit/should_generate_union_list_types_properly/expected.kt b/test/unit/should_generate_union_list_types_properly/expected.kt
@@ -3,17 +3,20 @@ package com.kotlin.generated
 import com.expediagroup.graphql.generator.annotations.*
 
 @GraphQLDescription("A description for TypeForGeneratingUnionListTypes1")
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeForGeneratingUnionListTypes1(
     val field: String? = null
 ) : UnionForGeneratingUnionListTypes
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeForGeneratingUnionListTypes2(
     val field: String? = null
 ) : UnionForGeneratingUnionListTypes
 
 @GraphQLDescription("A description for UnionForGeneratingUnionListTypes")
 interface UnionForGeneratingUnionListTypes
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyUnionListType(
     @GraphQLDescription("A description for field")
     val field: List<UnionForGeneratingUnionListTypes>? = null,
diff --git a/test/unit/should_generate_union_types_properly/expected.kt b/test/unit/should_generate_union_types_properly/expected.kt
@@ -3,17 +3,20 @@ package com.kotlin.generated
 import com.expediagroup.graphql.generator.annotations.*
 
 @GraphQLDescription("A description for MyType1")
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeForGeneratingUnionTypesProperly1(
     val field: String? = null
 ) : UnionForGeneratingUnionsProperly
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeForGeneratingUnionTypesProperly2(
     val field: String? = null
 ) : UnionForGeneratingUnionsProperly
 
 @GraphQLDescription("A trimmed description for UnionForGeneratingUnionsProperly")
 interface UnionForGeneratingUnionsProperly
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyUnionType(
     @GraphQLDescription("A description for field")
     val field: UnionForGeneratingUnionsProperly? = null,
diff --git a/test/unit/should_honor_dependentTypesInScope_config/expected.kt b/test/unit/should_honor_dependentTypesInScope_config/expected.kt
@@ -3,11 +3,13 @@ package com.kotlin.generated
 import com.expediagroup.graphql.generator.annotations.*
 import should_honor_dependentTypesInScope_config.*
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyTypeInOnlyTypes(
     val field: TypeInScope,
     val field2: TypeOutOfScope
 )
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeInScope(
     val field: String? = null,
     val unionInScopeField: UnionInScope? = null,
@@ -17,6 +19,7 @@ data class TypeInScope(
 
 interface UnionInScope
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class Type1(
     val field: String? = null
 ) : UnionInScope, ExternalUnionAsInterface
diff --git a/test/unit/should_honor_directiveReplacements_config/expected.kt b/test/unit/should_honor_directiveReplacements_config/expected.kt
@@ -7,6 +7,7 @@ import should_honor_directiveReplacements_config.*
 @SomeAnnotation1
 @SomeAnnotation2
 @SomeAnnotationWithArgs(arg1 = "arg1", arg2 = 0)
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeHonoringDirectiveReplacements(
     val field: String? = null
 ) : MyDirectiveUnion
diff --git a/test/unit/should_honor_directiveReplacements_config_with_multiple_directives/expected.kt b/test/unit/should_honor_directiveReplacements_config_with_multiple_directives/expected.kt
@@ -6,6 +6,7 @@ import should_honor_directiveReplacements_config.*
 @GraphQLDescription("A description for MyDirectiveType")
 @SomeAnnotation1
 @SomeAnnotation2
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeHonoringDirectiveReplacementsMultipleDirectives(
     val field: String? = null
 )
diff --git a/test/unit/should_honor_directiveReplacements_definitionType_config/expected.kt b/test/unit/should_honor_directiveReplacements_definitionType_config/expected.kt
@@ -5,12 +5,14 @@ import should_honor_directiveReplacements_config.*
 
 @SomeAnnotation1
 @CommonAnnotation
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeHonoringDirectiveReplacementsDefinitionType(
     val field: String? = null
 )
 
 @SomeAnnotation2
 @CommonAnnotation
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
 data class MyDirectiveTypeInput(
     val field: String? = null
 )
diff --git a/test/unit/should_honor_includeDependentTypes_config/expected.kt b/test/unit/should_honor_includeDependentTypes_config/expected.kt
@@ -2,6 +2,7 @@ package com.kotlin.generated
 
 import com.expediagroup.graphql.generator.annotations.*
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeHonoringIncludeDependentTypesConfig(
     val field: MyNestedType? = null
 )
diff --git a/test/unit/should_honor_onlyTypes_config/expected.kt b/test/unit/should_honor_onlyTypes_config/expected.kt
@@ -2,6 +2,7 @@ package com.kotlin.generated
 
 import com.expediagroup.graphql.generator.annotations.*
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeHonoringOnlyTypesConfig(
     val field1: String? = null,
     @GraphQLDescription("A description for field2")
diff --git a/test/unit/should_honor_packageName_config/expected.kt b/test/unit/should_honor_packageName_config/expected.kt
@@ -2,6 +2,7 @@ package com.some.custom.name
 
 import com.expediagroup.graphql.generator.annotations.*
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeHonoringPackageNameConfig(
     val field: String? = null
 )
diff --git a/test/unit/should_honor_resolverTypes_config/expected.kt b/test/unit/should_honor_resolverTypes_config/expected.kt
@@ -30,6 +30,7 @@ interface MyIncludedResolverTypeCompletableFuture {
     fun nonNullableField(): java.util.concurrent.CompletableFuture<String>
 }
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class MyExcludedResolverType(
     val nullableField: String? = null,
     val nonNullableField: String
diff --git a/test/unit/should_honor_union_generation_config/expected.kt b/test/unit/should_honor_union_generation_config/expected.kt
@@ -3,10 +3,12 @@ package com.kotlin.generated
 import com.expediagroup.graphql.generator.annotations.*
 
 @GraphQLDescription("A description for TypeForHonoringUnionGenerationConfig1")
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeForHonoringUnionGenerationConfig1(
     val field: String? = null
 )
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class TypeForHonoringUnionGenerationConfig2(
     val field: String? = null
 )
@@ -18,6 +20,7 @@ data class TypeForHonoringUnionGenerationConfig2(
 )
 annotation class UnionAsAnnotation
 
+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])
 data class UnionForHonoringUnionGenerationConfig(
     @UnionAsAnnotation
     @GraphQLDescription("A description for field")
diff --git a/test/unit/should_include_dependent_types_in_onlyTypes_config/expected.kt b/test/unit/should_include_dependent_types_in_onlyTypes_config/expected.kt
diff --git a/test/unit/should_replace_federation_directives/expected.kt b/test/unit/should_replace_federation_directives/expected.kt
diff --git a/test/unit/should_support_custom_scalars/expected.kt b/test/unit/should_support_custom_scalars/expected.kt

Original file line number	Diff line number	Diff line change
`@@ -25,28 +25,34 @@ data class MyTypeToConsolidate4(`
`25`	`25`	`val field: String? = null`
`26`	`26`	`)`
`27`	`27`
	`28`	`+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])`
`28`	`29`	`data class MyTypeNotToConsolidate(`
`29`	`30`	`val field: String? = null`
`30`	`31`	`)`
`31`	`32`
`32`	`33`	`@GraphQLDescription("The type name must exactly match in order to consolidate")`
	`34`	`+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])`
`33`	`35`	`data class MyTypeToNotConsolidateInput(`
`34`	`36`	`val field: String? = null`
`35`	`37`	`)`
`36`	`38`
	`39`	`+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])`
`37`	`40`	`data class MyTypeToNotConsolidate2(`
`38`	`41`	`val field: String? = null`
`39`	`42`	`)`
`40`	`43`
	`44`	`+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])`
`41`	`45`	`data class MyTypeInputToNotConsolidate2(`
`42`	`46`	`val field: String? = null`
`43`	`47`	`)`
`44`	`48`
	`49`	`+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])`
`45`	`50`	`data class MyTypeWhereFieldsDoNotMatch(`
`46`	`51`	`val field: String? = null,`
`47`	`52`	`val field2: String? = null`
`48`	`53`	`)`
`49`	`54`
	`55`	`+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])`
`50`	`56`	`data class MyTypeWhereFieldsDoNotMatchInput(`
`51`	`57`	`val field: String? = null,`
`52`	`58`	`val field2: Int? = null`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@ package com.kotlin.generated`
`2`	`2`
`3`	`3`	`import com.expediagroup.graphql.generator.annotations.*`
`4`	`4`
	`5`	`+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])`
`5`	`6`	`data class MyFloatType(`
`6`	`7`	`val field: Double? = null`
`7`	`8`	`)`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ interface QueryCompletableFuture {`
`18`	`18`	`fun nonNullableResolver(arg: InputTypeGenerateFieldResolverInterfaces): java.util.concurrent.CompletableFuture<String>`
`19`	`19`	`}`
`20`	`20`
	`21`	`+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])`
`21`	`22`	`data class InputTypeGenerateFieldResolverInterfaces(`
`22`	`23`	`val field: String? = null`
`23`	`24`	`)`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ interface InterfaceWithInheritance {`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`@GraphQLDescription("A description for MyInterfaceImplementation")`
	`12`	`+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])`
`12`	`13`	`data class MyInterfaceImplementation(`
`13`	`14`	`override val field: String? = null,`
`14`	`15`	`override val field2: String`
`@@ -22,6 +23,7 @@ interface InheritedInterface2 {`
`22`	`23`	`val field2: String`
`23`	`24`	`}`
`24`	`25`
	`26`	`+@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.OBJECT])`
`25`	`27`	`data class MyMergedInterfaceImplementation(`
`26`	`28`	`override val field: String? = null,`
`27`	`29`	`override val field2: String`