在GraphQL-SPQR中返回错误的正确方法

Question

At the moment, I'm throwing RuntimeException 's to return GraphQL validation errors. It works surprisingly well, with the exception that it throws horrible errors with large stack traces in my logs.

Here you can see I'm checking the submitted new user registration mutation to be sure the passwords match one another and the email address isn't already in use.

What is the correct way to do this in GraphQL SPQR Spring Boot Starter.

@GraphQLMutation (name="register")
public User register(@GraphQLArgument(name="firstname") String firstname, @GraphQLArgument(name="lastname") String lastname, @GraphQLArgument(name="email") String email, @GraphQLArgument(name="msisdn") String msisdn, @GraphQLArgument(name="password") String password, @GraphQLArgument (name="confirmPassword") String confirmPassword) {
    if (userRepo.findByEmail(email) != null) {
        throw new RuntimeException("User already exists");
    }

    if (!password.equals(confirmPassword)) {
        throw new RuntimeException("Passwords do not match");
    }

    User newUser = new User();
    //...
    return userRepo.save(newUser);
}

Answer 1

It's unclear to me what you're asking... but I'll assume you want to customize what's getting logged.

For starters, I'd suggest a dedicated exception type like ValidationException , that you can catch and handle differently.

As for the logging, it's probably happening in grapqh-java as SPQR doesn't log anything by itself. By default graphql-java uses SimpleDataFetcherExceptionHandler which logs the exceptions caught during field resolution.

You now have a couple of options, you could register a ResolverInterceptor in SPQR that catches validation exceptions and logs what you want, and returns a DataFetcherResult with the error message for the user. Because no validation exceptions bubble up to graphql-java, DataFetcherExceptionHandler has nothing to do in this scenario.

It would look something like:

public class ValidationInterceptor implements ResolverInterceptor {

    @Override
    public Object aroundInvoke(InvocationContext context, Continuation continuation) throws Exception {
        try {
            return continuation.proceed(context);
        } catch (ValidationException e) {
            log.warning(e);
            return DataFetcherResult.newResult()
                    .error(GraphqlErrorBuilder
                            .newError(context.getResolutionEnvironment().dataFetchingEnvironment)
                            .message(e.getMessage()) //the message for the user
                            .build());
        }
    }
}

Look at the answer here for instructions on registering your custom interceptor with Spring Boot.

Another option would be to replace the DataFetcherExceptionHandler graphql-java uses. To do that you must construct GraphQL object yourself and register it as a bean.

@Bean
public GraphQL graphQL(GraphQLSchema schema) {
    GraphQL.Builder builder = GraphQL.newGraphQL(schema)
            .queryExecutionStrategy(new AsyncExecutionStrategy(customExceptionHandler))
            .mutationExecutionStrategy(new AsyncSerialExecutionStrategy(customExceptionHandler));
    return builder.build();
}

I also wouldn't be surprised if there's a Spring feature somewhere that can be used for exception handling on managed beans.