Skip to content

Allows nullable error attributes in GraphqlErrorBuilder #2670

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 4 commits into from
Feb 4, 2022
Merged

Allows nullable error attributes in GraphqlErrorBuilder #2670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c65ee9c
Allows nullable error attributes
bbakerman Jan 4, 2022
24ce41c
Merge remote-tracking branch 'origin/master' into nullable-error-attrs
bbakerman Feb 1, 2022
ea22108
Feedback on @Nullable from Andi
bbakerman Feb 1, 2022
01e5fd0
fixed @Nullable
bbakerman Feb 4, 2022
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
34 changes: 24 additions & 10 deletions src/main/java/graphql/GraphqlErrorBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import graphql.language.SourceLocation;
import graphql.schema.DataFetchingEnvironment;

import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
Expand All @@ -31,10 +32,12 @@ public String getMessage() {
return message;
}

@Nullable
public List<Object> getPath() {
return path;
}

@Nullable
public List<SourceLocation> getLocations() {
return locations;
}
Expand All @@ -43,6 +46,7 @@ public ErrorClassification getErrorType() {
return errorType;
}

@Nullable
public Map<String, Object> getExtensions() {
return extensions;
}
Expand Down Expand Up @@ -80,23 +84,33 @@ public B message(String message, Object... formatArgs) {
return (B) this;
}

public B locations(List<SourceLocation> locations) {
this.locations.addAll(assertNotNull(locations));
public B locations(@Nullable List<SourceLocation> locations) {
if (locations != null) {
Copy link
Member

@andimarek andimarek Jan 24, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we add the Nullable annotation to the argument to make this more clear?

Copy link
Member

@andimarek andimarek Feb 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bbakerman I think that is a missunderstanding: the result is never null, but the argument. So the directive should be on the argument.

Copy link
Member Author

@bbakerman bbakerman Feb 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

this.locations.addAll(locations);
} else {
this.locations = null;
}
return (B) this;
}

public B location(SourceLocation location) {
this.locations.add(assertNotNull(location));
public B location(@Nullable SourceLocation location) {
if (locations != null) {
this.locations.add(location);
}
return (B) this;
}

public B path(ResultPath path) {
this.path = assertNotNull(path).toList();
public B path(@Nullable ResultPath path) {
if (path != null) {
this.path = path.toList();
} else {
this.path = null;
}
return (B) this;
}

public B path(List<Object> path) {
this.path = assertNotNull(path);
public B path(@Nullable List<Object> path) {
this.path = path;
return (B) this;
}

Expand All @@ -105,8 +119,8 @@ public B errorType(ErrorClassification errorType) {
return (B) this;
}

public B extensions(Map<String, Object> extensions) {
this.extensions = assertNotNull(extensions);
public B extensions(@Nullable Map<String, Object> extensions) {
this.extensions = extensions;
return (B) this;
}

Expand Down
14 changes: 14 additions & 0 deletions src/test/groovy/graphql/GraphqlErrorBuilderTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,18 @@ class GraphqlErrorBuilderTest extends Specification {
then:
thrown(AssertException)
}

def "can have nullable attributes"() {
when:
def error = GraphqlErrorBuilder.newError().message("msg")
.locations(null)
.extensions(null)
.path(null)
.build()
then:
error.message == "msg"
error.locations == null
error.path == null
error.extensions == null
}
}