Skip to content

fix: input field deprecation #85

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.

Sign up for GitHub

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
danadajian merged 2 commits into from
Jun 12, 2024
Merged

fix: input field deprecation #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef8c20b
unit test
danadajian Jun 12, 2024
924cb58
make test pass
danadajian Jun 12, 2024
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
8 changes: 7 additions & 1 deletion src/annotations/build-description-annotation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,13 @@ export function buildDescriptionAnnotation(
const isDeprecatedDescription = trimmedDescription.startsWith(
deprecatedDescriptionPrefix,
);
if (isDeprecatedDescription && typeMetadata?.unionAnnotation) {
const isRequiredInputField =
definitionNode.kind === Kind.INPUT_VALUE_DEFINITION &&
definitionNode.type.kind === Kind.NON_NULL_TYPE;
if (
isDeprecatedDescription &&
(typeMetadata?.unionAnnotation || isRequiredInputField)
) {
return `@GraphQLDescription("${trimmedDescription}")\n`;
} else if (isDeprecatedDescription) {
const descriptionValue = description.replace(
Expand Down
8 changes: 8 additions & 0 deletions test/unit/should_annotate_types_properly/expected.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,11 @@ data class TypeThatShouldBeProperlyAnnotated(
) : UnionThatShouldBeProperlyAnnotated

interface UnionThatShouldBeProperlyAnnotated

@GraphQLValidObjectLocations(locations = [GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
data class InputTypeThatShouldBeProperlyAnnotated(
@Deprecated("this field is deprecated")
val optionalField: String? = null,
@GraphQLDescription("DEPRECATED: this field is deprecated")
val requiredField: String
)
7 changes: 7 additions & 0 deletions test/unit/should_annotate_types_properly/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,10 @@ type TypeThatShouldBeProperlyAnnotated {
}

union UnionThatShouldBeProperlyAnnotated = TypeThatShouldBeProperlyAnnotated

input InputTypeThatShouldBeProperlyAnnotated {
"DEPRECATED: this field is deprecated"
optionalField: String
"DEPRECATED: this field is deprecated"
requiredField: String!
}