FilesExpand file tree

 master

/

ParseAndValidate.java

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

94 lines (86 loc) · 3.95 KB

 master

/

ParseAndValidate.java

Copy path

Top

File metadata and controls

• Code
• Blame

94 lines (86 loc) · 3.95 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

package graphql;

import graphql.language.Document;

import graphql.parser.InvalidSyntaxException;

import graphql.parser.Parser;

import graphql.parser.ParserOptions;

import graphql.schema.GraphQLSchema;

import graphql.validation.ValidationError;

import graphql.validation.Validator;

import java.util.List;

import java.util.function.Predicate;

/**

* This class allows you to parse and validate a graphql query without executing it. It will tell you

* if its syntactically valid and also semantically valid according to the graphql specification

* and the provided schema.

*/

@PublicApi

public class ParseAndValidate {

/**

* This {@link GraphQLContext} hint can be used to supply a Predicate to the Validator so that certain rules can be skipped.

*

* This is an internal capability that you should use at your own risk. While we intend for this to be present for some time, the validation

* rule class names may change, as may this mechanism.

*/

@Internal

public static final String INTERNAL_VALIDATION_PREDICATE_HINT = "graphql.ParseAndValidate.Predicate";

/**

* This can be called to parse and validate a graphql query against a schema, which is useful if you want to know if it would be acceptable

* for execution.

*

* @param graphQLSchema the schema to validate against

* @param executionInput the execution input containing the query

*

* @return a result object that indicates how this operation went

*/

public static ParseAndValidateResult parseAndValidate(GraphQLSchema graphQLSchema, ExecutionInput executionInput) {

ParseAndValidateResult result = parse(executionInput);

if (!result.isFailure()) {

List<ValidationError> errors = validate(graphQLSchema, result.getDocument());

return result.transform(builder -> builder.validationErrors(errors));

}

return result;

}

/**

* This can be called to parse (but not validate) a graphql query.

*

* @param executionInput the input containing the query

*

* @return a result object that indicates how this operation went

*/

public static ParseAndValidateResult parse(ExecutionInput executionInput) {

try {

//

// we allow the caller to specify new parser options by context

ParserOptions parserOptions = executionInput.getGraphQLContext().get(ParserOptions.class);

Parser parser = new Parser();

Document document = parser.parseDocument(executionInput.getQuery(), parserOptions);

return ParseAndValidateResult.newResult().document(document).variables(executionInput.getVariables()).build();

} catch (InvalidSyntaxException e) {

return ParseAndValidateResult.newResult().syntaxException(e).variables(executionInput.getVariables()).build();

}

}

/**

* This can be called to validate a parsed graphql query.

*

* @param graphQLSchema the graphql schema to validate against

* @param parsedDocument the previously parsed document

*

* @return a result object that indicates how this operation went

*/

public static List<ValidationError> validate(GraphQLSchema graphQLSchema, Document parsedDocument) {

return validate(graphQLSchema, parsedDocument, ruleClass -> true);

}

/**

* This can be called to validate a parsed graphql query.

*

* @param graphQLSchema the graphql schema to validate against

* @param parsedDocument the previously parsed document

* @param rulePredicate this predicate is used to decide what validation rules will be applied

*

* @return a result object that indicates how this operation went

*/

public static List<ValidationError> validate(GraphQLSchema graphQLSchema, Document parsedDocument, Predicate<Class<?>> rulePredicate) {

Validator validator = new Validator();

return validator.validateDocument(graphQLSchema, parsedDocument, rulePredicate);

}

}