How to create a custom error/exception handler for graphql?

Question

So, I have been coding a microservice which uses GraphQL's java implementation for APIs. GraphQL enforces some level of validation for the supplied queries by client. However, in cases when the issue occurs inside resolving the query, I have seen graphql show messages which exposes the internals of the micr-service.

What do I need? A way to handle all exceptions/errors thrown from resolver functions in such a way that I can sanitize the exceptions/errors before GraphQL creates corresponding response.

I have looked up official documentation and many stack over flow questions, but failed to find any place it talks about handling. If I found any, they were for previous versions and are no more supported.

Some of the links I referred - 1. https://www.howtographql.com/graphql-java/7-error-handling/ 2. GraphQL java send custom error in json format 3. https://www.graphql-java.com/documentation/v13/execution/

I have already done the below things like -

Creating custom handler

@Bean
public GraphQLErrorHandler errorHandler() {
    return new CustomGraphQLErrorHandler();
}

public class CustomGraphQLErrorHandler implements GraphQLErrorHandler {

    @Override
    public List<GraphQLError> processErrors(List<GraphQLError> errors) {
        List<GraphQLError> clientErrors = errors.stream()
                .filter(this::isClientError)
                .collect(Collectors.toList());

        List<GraphQLError> serverErrors = errors.stream()
                .filter(this::isSystemError)
                .map(GraphQLErrorAdapter::new)
                .collect(Collectors.toList());

        List<GraphQLError> e = new ArrayList<>();
        e.addAll(clientErrors);
        e.addAll(serverErrors);
        return e;
    }

    private boolean isSystemError(GraphQLError error) {
        return !isClientError(error);
    }

    private boolean isClientError(GraphQLError error) {
        return !(error instanceof ExceptionWhileDataFetching || error instanceof Throwable);
    }
}```

Expected behavior - The control would reach to `processErrors` method. Actual - It doesn't reach there.

Javi Mendoza Javi Mendoza · Accepted Answer · 2020-09-03T16:29:44

You need to override the errorsPresent method in GraphQLErrorHandler to return true when an error is passed into that method. Something like:

    @Override
    public boolean errorsPresent(List<GraphQLError> errors) {
        return !CollectionUtils.isEmpty(errors);
    }

How to create a custom error/exception handler for graphql?

1 Answers