Class: GraphQL::StaticValidation::Validator
- Inherits:
-
Object
- Object
- GraphQL::StaticValidation::Validator
- Defined in:
- lib/graphql/static_validation/validator.rb
Overview
Initialized with a GraphQL::Schema, then it can validate Language::Nodes::Documentss based on that schema.
By default, it's used by Query
Instance Method Summary collapse
-
#handle_timeout(query, context) ⇒ Object
Invoked when static validation times out.
-
#initialize(schema:, rules: GraphQL::StaticValidation::ALL_RULES) ⇒ Validator
constructor
A new instance of Validator.
-
#validate(query, validate: true, timeout: nil, max_errors: nil) ⇒ Array<Hash>
Validate
query
against the schema.
Constructor Details
#initialize(schema:, rules: GraphQL::StaticValidation::ALL_RULES) ⇒ Validator
Returns a new instance of Validator.
18 19 20 21 |
# File 'lib/graphql/static_validation/validator.rb', line 18 def initialize(schema:, rules: GraphQL::StaticValidation::ALL_RULES) @schema = schema @rules = rules end |
Instance Method Details
#handle_timeout(query, context) ⇒ Object
Invoked when static validation times out.
67 68 69 70 71 |
# File 'lib/graphql/static_validation/validator.rb', line 67 def handle_timeout(query, context) context.errors << GraphQL::StaticValidation::ValidationTimeoutError.new( "Timeout on validation of query" ) end |
#validate(query, validate: true, timeout: nil, max_errors: nil) ⇒ Array<Hash>
Validate query
against the schema. Returns an array of message hashes.
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 |
# File 'lib/graphql/static_validation/validator.rb', line 29 def validate(query, validate: true, timeout: nil, max_errors: nil) query.current_trace.validate(validate: validate, query: query) do errors = if validate == false [] else rules_to_use = validate ? @rules : [] visitor_class = BaseVisitor.including_rules(rules_to_use) context = GraphQL::StaticValidation::ValidationContext.new(query, visitor_class, max_errors) begin # CAUTION: Usage of the timeout module makes the assumption that validation rules are stateless Ruby code that requires no cleanup if process was interrupted. This means no blocking IO calls, native gems, locks, or `rescue` clauses that must be reached. # A timeout value of 0 or nil will execute the block without any timeout. Timeout::timeout(timeout) do catch(:too_many_validation_errors) do context.visitor.visit end end rescue Timeout::Error handle_timeout(query, context) end context.errors end { errors: errors, } end rescue GraphQL::ExecutionError => e { errors: [e], } end |