All Downloads are FREE. Search and download functionalities are using the official Maven repository.

graphql.execution.AbsoluteGraphQLError Maven / Gradle / Ivy

There is a newer version: 230521-nf-execution
Show newest version
package graphql.execution;

import graphql.ErrorClassification;
import graphql.GraphQLError;
import graphql.Internal;
import graphql.language.SourceLocation;
import graphql.schema.DataFetcher;

import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;

import static graphql.Assert.assertNotNull;

/**
 * A {@link GraphQLError} that has been changed from a {@link DataFetcher} relative error to an absolute one.
 */
@Internal
public class AbsoluteGraphQLError implements GraphQLError {

    private final List locations;
    private final List absolutePath;
    private final String message;
    private final ErrorClassification errorType;
    private final Map extensions;

    public AbsoluteGraphQLError(ExecutionStrategyParameters executionStrategyParameters, GraphQLError relativeError) {
        assertNotNull(executionStrategyParameters);
        assertNotNull(relativeError);
        this.absolutePath = createAbsolutePath(executionStrategyParameters.getPath(), relativeError);
        this.locations = createAbsoluteLocations(relativeError, executionStrategyParameters.getField());
        this.message = relativeError.getMessage();
        this.errorType = relativeError.getErrorType();
        if (relativeError.getExtensions() != null) {
            this.extensions = new LinkedHashMap<>();
            this.extensions.putAll(relativeError.getExtensions());
        } else {
            this.extensions = null;
        }
    }

    public AbsoluteGraphQLError(MergedField sameField, ExecutionPath executionPath, GraphQLError relativeError) {
        this.absolutePath = createAbsolutePath(executionPath, relativeError);
        this.locations = createAbsoluteLocations(relativeError, sameField);
        this.message = relativeError.getMessage();
        this.errorType = relativeError.getErrorType();
        if (relativeError.getExtensions() != null) {
            this.extensions = new LinkedHashMap<>();
            this.extensions.putAll(relativeError.getExtensions());
        } else {
            this.extensions = null;
        }

    }

    @Override
    public String getMessage() {
        return message;
    }

    @Override
    public List getLocations() {
        return locations;
    }

    @Override
    public ErrorClassification getErrorType() {
        return errorType;
    }

    @Override
    public List getPath() {
        return absolutePath;
    }

    @Override
    public Map getExtensions() {
        return extensions;
    }

    /**
     * Creating absolute paths follows the following logic:
     * Relative path is null -> Absolute path null
     * Relative path is empty -> Absolute paths is path up to the field.
     * Relative path is not empty -> Absolute paths [base Path, relative Path]
     *
     *
     * @return List of paths from the root.
     */
    private List createAbsolutePath(ExecutionPath executionPath,
                                            GraphQLError relativeError) {
        return Optional.ofNullable(relativeError.getPath())
                .map(originalPath -> {
                    List path = new ArrayList<>();
                    path.addAll(executionPath.toList());
                    path.addAll(relativeError.getPath());
                    return path;
                })
                .map(Collections::unmodifiableList)
                .orElse(executionPath.toList());
    }

    /**
     * Creating absolute locations follows the following logic:
     * Relative locations is null -> Absolute locations null
     * Relative locations is empty -> Absolute locations base locations of the field.
     * Relative locations is not empty -> Absolute locations [base line + relative line location]
     *
     * @param relativeError relative error
     * @param fields        fields on the current field.
     *
     * @return List of locations from the root.
     */
    private List createAbsoluteLocations(GraphQLError relativeError, MergedField fields) {
        Optional baseLocation = Optional.ofNullable(fields.getSingleField().getSourceLocation());
//        if (!fields.isEmpty()) {
//            baseLocation = Optional.ofNullable(fields.get(0).getSourceLocation());
//        } else {
//            baseLocation = Optional.empty();
//        }

        // relative error empty path should yield an absolute error with the base path
        if (relativeError.getLocations() != null && relativeError.getLocations().isEmpty()) {
            return baseLocation.map(Collections::singletonList).orElse(null);
        }

        return Optional.ofNullable(
                relativeError.getLocations())
                .map(locations -> locations.stream()
                        .map(l ->
                                baseLocation
                                        .map(base -> new SourceLocation(
                                                base.getLine() + l.getLine(),
                                                base.getColumn() + l.getColumn()))
                                        .orElse(null))
                        .collect(Collectors.toList()))
                .map(Collections::unmodifiableList)
                .orElse(null);
    }
}