Skip to content

Allow leading pipe in directive SDL, and add leading union pipe tests #2650

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
bbakerman merged 1 commit into from
Dec 20, 2021
Merged

Allow leading pipe in directive SDL, and add leading union pipe tests #2650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/main/antlr/GraphqlSDL.g4
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,6 @@ directiveDefinition : description? DIRECTIVE '@' name argumentsDefinition? REPEA
directiveLocation : name;

directiveLocations :
directiveLocation |
'|'? directiveLocation |
directiveLocations '|' directiveLocation
;
217 changes: 211 additions & 6 deletions src/test/groovy/graphql/parser/SDLParserTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,18 +241,14 @@ union UnionName @d1 @d2 = Type1 | Type2
"""

and: "expected schema"
def schema = UnionTypeDefinition.newUnionTypeDefinition().name("UnionName")
schema.directive(new Directive("d1"))
schema.directive(new Directive("d2"))
schema.memberType(new TypeName("Type1"))
schema.memberType(new TypeName("Type2"))
def unionTypeTestDefinition = unionDefinition()

when:
def document = new Parser().parseDocument(input)

then:
document.definitions.size() == 1
isEqual(document.definitions[0], schema.build())
isEqual(document.definitions[0], unionTypeTestDefinition)
}

def "input object schema"() {
Expand Down Expand Up @@ -860,6 +856,215 @@ input Gun {
description == "Represents the 😕 emoji."
}

def unionDefinition() {
def schema = UnionTypeDefinition.newUnionTypeDefinition().name("UnionName")
schema.directive(new Directive("d1"))
schema.directive(new Directive("d2"))
schema.memberType(new TypeName("Type1"))
schema.memberType(new TypeName("Type2"))
return schema.build()
}

def "union with two types and leading pipe"() {
given:
def input = """
union UnionName @d1 @d2 = | Type1 | Type2
"""

when:
def document = new Parser().parseDocument(input)

then:
document.definitions.size() == 1
isEqual(document.definitions[0], unionDefinition())
}

def "union with leading pipe"() {
given:
def input = """
union UnionName @d1 @d2 = | Type1
"""

and: "expected schema"
def schema = UnionTypeDefinition.newUnionTypeDefinition().name("UnionName")
schema.directive(new Directive("d1"))
schema.directive(new Directive("d2"))
schema.memberType(new TypeName("Type1"))

when:
def document = new Parser().parseDocument(input)

then:
document.definitions.size() == 1
isEqual(document.definitions[0], schema.build())
}

def "union fails with double leading pipe"() {
given:
def input = """
union UnionName @d1 @d2 = || Type1 | Type2
"""

when:
new Parser().parseDocument(input)

then:
def e = thrown(InvalidSyntaxException)

e.location.line == 2
e.location.column == 28
e.offendingToken == "|"
}

def "union fails with double inner pipe"() {
given:
def input = """
union UnionName @d1 @d2 = Type1 || Type2
"""

when:
new Parser().parseDocument(input)

then:
def e = thrown(InvalidSyntaxException)

e.location.line == 2
e.location.column == 34
e.offendingToken == "|"
}

def "union fails with trailing pipe"() {
given:
def input = """
union UnionName @d1 @d2 = Type1 | Type2 |
"""

when:
new Parser().parseDocument(input)

then:
def e = thrown(InvalidSyntaxException)

e.location.line == 3
e.location.column == 1
e.offendingToken == "<EOF>"
}

def "directive with two locations and leading pipe"() {
given:
def input = """
directive @myDirective on
| OBJECT
| INTERFACE
"""

when:
def directive = new Parser().parseDocument(input)

then:
directive.definitions.size() == 1
def first = directive.definitions[0]
first instanceof DirectiveDefinition
def resultDirective = (DirectiveDefinition) first
resultDirective.name == "myDirective"
resultDirective.inputValueDefinitions.size() == 0
resultDirective.directiveLocations.size() == 2
resultDirective.directiveLocations[0].name == "OBJECT"
resultDirective.directiveLocations[1].name == "INTERFACE"
}

def "directive with leading pipe"() {
given:
def input = """
directive @myDirective on
| OBJECT
"""

when:
def directive = new Parser().parseDocument(input)

then:
directive.definitions.size() == 1
def first = directive.definitions[0]
first instanceof DirectiveDefinition
def resultDirective = (DirectiveDefinition) first
resultDirective.name == "myDirective"
resultDirective.inputValueDefinitions.size() == 0
resultDirective.directiveLocations.size() == 1
resultDirective.directiveLocations[0].name == "OBJECT"
}

def "directive with leading pipe INLINE"() {
given:
def input = """
directive @myDirective on | OBJECT
"""

when:
def directive = new Parser().parseDocument(input)

then:
directive.definitions.size() == 1
def first = directive.definitions[0]
first instanceof DirectiveDefinition
def resultDirective = (DirectiveDefinition) first
resultDirective.name == "myDirective"
resultDirective.inputValueDefinitions.size() == 0
resultDirective.directiveLocations.size() == 1
resultDirective.directiveLocations[0].name == "OBJECT"
}

def "directive fails with double leading pipe"() {
given:
def input = """
directive @myDirective on || OBJECT | INTERFACE
"""

when:
new Parser().parseDocument(input)

then:
def e = thrown(InvalidSyntaxException)

e.location.line == 2
e.location.column == 28
e.offendingToken == "|"
}

def "directive fails with double inner pipe between locations"() {
given:
def input = """
directive @myDirective on OBJECT || INTERFACE
"""

when:
new Parser().parseDocument(input)

then:
def e = thrown(InvalidSyntaxException)

e.location.line == 2
e.location.column == 35
e.offendingToken == "|"
}

def "directive fails with trailing pipe"() {
given:
def input = """
directive @myDirective on
OBJECT
| INTERFACE |
"""

when:
new Parser().parseDocument(input)

then:
def e = thrown(InvalidSyntaxException)

e.location.line == 5
e.location.column == 1
e.offendingToken == "<EOF>"
}
}

15 changes: 15 additions & 0 deletions src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1911,6 +1911,21 @@ type MyQuery {
result == """directive @foo on FIELD_DEFINITION"""
}

def "directive with leading pipe gets discarded"() {
def sdl = """
directive @foo on | OBJECT | FIELD_DEFINITION
type Query { anything: String @foo }
"""
def schema = TestUtil.schema(sdl)
def directive = schema.getDirective("foo");

when:
def result = new SchemaPrinter(defaultOptions().includeDirectives(true)).print(directive)

then:
result == """directive @foo on OBJECT | FIELD_DEFINITION"""
}

def "description printing escapes triple quotes"() {
def descriptionWithTripleQuote = 'Hello """ \n World """ """';
def field = newFieldDefinition().name("hello").type(GraphQLString).build()
Expand Down