Class: GraphQL::Analysis::Visitor

Inherits:
Language::StaticVisitor show all
Defined in:
lib/graphql/analysis/visitor.rb

Overview

Depth first traversal through a query AST, calling AST analyzers along the way.

The visitor is a special case of GraphQL::Language::StaticVisitor, visiting only the selected operation, providing helpers for common use cases such as skipped fields and visiting fragment spreads.

See Also:

  • AST Analyzers for queries

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Language::StaticVisitor

make_visit_methods, #on_argument_children, #on_document_children, #on_field_children, #on_fragment_definition_children, #on_operation_definition_children, #visit_directives, #visit_selections

Constructor Details

#initialize(query:, analyzers:) ⇒ Visitor

Returns a new instance of Visitor.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/graphql/analysis/visitor.rb', line 13

def initialize(query:, analyzers:)
  @analyzers = analyzers
  @path = []
  @object_types = []
  @directives = []
  @field_definitions = []
  @argument_definitions = []
  @directive_definitions = []
  @rescued_errors = []
  @query = query
  @schema = query.schema
  @types = query.types
  @response_path = []
  @skip_stack = [false]
  super(query.selected_operation)
end

Instance Attribute Details

#object_types ⇒ Array<GraphQL::ObjectType> (readonly)

Returns Types whose scope we've entered.

Returns:

  • (Array<GraphQL::ObjectType>) —

    Types whose scope we've entered



34
35
36
 
# File 'lib/graphql/analysis/visitor.rb', line 34

def object_types
  @object_types
end

#query ⇒ GraphQL::Query (readonly)

Returns the query being visited.

Returns:



31
32
33
 
# File 'lib/graphql/analysis/visitor.rb', line 31

def query
  @query
end

#rescued_errors ⇒ Array<GraphQL::AnalysisError] (readonly)

Returns Array<GraphQL::AnalysisError].

Returns:



37
38
39
 
# File 'lib/graphql/analysis/visitor.rb', line 37

def rescued_errors
  @rescued_errors
end

Instance Method Details

#argument_definition ⇒ GraphQL::Argument?

Returns The most-recently-entered GraphQL::Argument, if currently inside one.

Returns:

  • (GraphQL::Argument, nil) —

    The most-recently-entered GraphQL::Argument, if currently inside one



232
233
234
 
# File 'lib/graphql/analysis/visitor.rb', line 232

def argument_definition
  @argument_definitions.last
end

#arguments_for(ast_node, field_definition) ⇒ GraphQL::Execution::Interpreter::Arguments

Returns Arguments for this node, merging default values, literal values and query variables.

Returns:

See Also:

  • GraphQL::Analysis::Visitor.{GraphQL{GraphQL::Query{GraphQL::Query#arguments_for}


48
49
50
 
# File 'lib/graphql/analysis/visitor.rb', line 48

def arguments_for(ast_node, field_definition)
  @query.arguments_for(ast_node, field_definition)
end

#directive_definition ⇒ GraphQL::Directive?

Returns The most-recently-entered GraphQL::Directive, if currently inside one.

Returns:

  • (GraphQL::Directive, nil) —

    The most-recently-entered GraphQL::Directive, if currently inside one



227
228
229
 
# File 'lib/graphql/analysis/visitor.rb', line 227

def directive_definition
  @directive_definitions.last
end

#field_definition ⇒ GraphQL::Field?

Returns The most-recently-entered GraphQL::Field, if currently inside one.

Returns:

  • (GraphQL::Field, nil) —

    The most-recently-entered GraphQL::Field, if currently inside one



217
218
219
 
# File 'lib/graphql/analysis/visitor.rb', line 217

def field_definition
  @field_definitions.last
end

#on_argument(node, parent) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/graphql/analysis/visitor.rb', line 167

def on_argument(node, parent)
  argument_defn = if (arg = @argument_definitions.last)
    arg_type = arg.type.unwrap
    if arg_type.kind.input_object?
      @types.argument(arg_type, node.name)
    else
      nil
    end
  elsif (directive_defn = @directive_definitions.last)
    @types.argument(directive_defn, node.name)
  elsif (field_defn = @field_definitions.last)
    @types.argument(field_defn, node.name)
  else
    nil
  end

  @argument_definitions.push(argument_defn)
  @path.push(node.name)
  call_on_enter_argument(node, parent)
  super
  call_on_leave_argument(node, parent)
  @argument_definitions.pop
  @path.pop
end

#on_directive(node, parent) ⇒ Object 



158
159
160
161
162
163
164
165
 
# File 'lib/graphql/analysis/visitor.rb', line 158

def on_directive(node, parent)
  directive_defn = @schema.directives[node.name]
  @directive_definitions.push(directive_defn)
  call_on_enter_directive(node, parent)
  super
  call_on_leave_directive(node, parent)
  @directive_definitions.pop
end

#on_field(node, parent) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/graphql/analysis/visitor.rb', line 131

def on_field(node, parent)
  @response_path.push(node.alias || node.name)
  parent_type = @object_types.last
  # This could be nil if the previous field wasn't found:
  field_definition = parent_type && @types.field(parent_type, node.name)
  @field_definitions.push(field_definition)
  if !field_definition.nil?
    next_object_type = field_definition.type.unwrap
    @object_types.push(next_object_type)
  else
    @object_types.push(nil)
  end
  @path.push(node.alias || node.name)

  @skipping = @skip_stack.last || skip?(node)
  @skip_stack << @skipping

  call_on_enter_field(node, parent)
  super
  @skipping = @skip_stack.pop
  call_on_leave_field(node, parent)
  @response_path.pop
  @field_definitions.pop
  @object_types.pop
  @path.pop
end

#on_fragment_definition(node, parent) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
 
# File 'lib/graphql/analysis/visitor.rb', line 107

def on_fragment_definition(node, parent)
  on_fragment_with_type(node) do
    @path.push("fragment #{node.name}")
    @in_fragment_def = false
    call_on_enter_fragment_definition(node, parent)
    super
    @in_fragment_def = false
    call_on_leave_fragment_definition(node, parent)
  end
end

#on_fragment_spread(node, parent) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/graphql/analysis/visitor.rb', line 192

def on_fragment_spread(node, parent)
  @path.push("... #{node.name}")
  @skipping = @skip_stack.last || skip?(node)
  @skip_stack << @skipping

  call_on_enter_fragment_spread(node, parent)
  enter_fragment_spread_inline(node)
  super
  @skipping = @skip_stack.pop
  leave_fragment_spread_inline(node)
  call_on_leave_fragment_spread(node, parent)
  @path.pop
end

#on_inline_fragment(node, parent) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/graphql/analysis/visitor.rb', line 118

def on_inline_fragment(node, parent)
  on_fragment_with_type(node) do
    @path.push("...#{node.type ? " on #{node.type.name}" : ""}")
    @skipping = @skip_stack.last || skip?(node)
    @skip_stack << @skipping

    call_on_enter_inline_fragment(node, parent)
    super
    @skipping = @skip_stack.pop
    call_on_leave_inline_fragment(node, parent)
  end
end

#on_operation_definition(node, parent) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/graphql/analysis/visitor.rb', line 96

def on_operation_definition(node, parent)
  object_type = @schema.root_type_for_operation(node.operation_type)
  @object_types.push(object_type)
  @path.push("#{node.operation_type}#{node.name ? " #{node.name}" : ""}")
  call_on_enter_operation_definition(node, parent)
  super
  call_on_leave_operation_definition(node, parent)
  @object_types.pop
  @path.pop
end

#parent_type_definition ⇒ GraphQL::BaseType

Returns The type which the current type came from.

Returns:

  • (GraphQL::BaseType) —

    The type which the current type came from



212
213
214
 
# File 'lib/graphql/analysis/visitor.rb', line 212

def parent_type_definition
  @object_types[-2]
end

#previous_argument_definition ⇒ GraphQL::Argument?

Returns The previous GraphQL argument.

Returns:

  • (GraphQL::Argument, nil) —

    The previous GraphQL argument



237
238
239
 
# File 'lib/graphql/analysis/visitor.rb', line 237

def previous_argument_definition
  @argument_definitions[-2]
end

#previous_field_definition ⇒ GraphQL::Field?

Returns The GraphQL field which returned the object that the current field belongs to.

Returns:

  • (GraphQL::Field, nil) —

    The GraphQL field which returned the object that the current field belongs to



222
223
224
 
# File 'lib/graphql/analysis/visitor.rb', line 222

def previous_field_definition
  @field_definitions[-2]
end

#response_path ⇒ Array<String>

Returns The path to the response key for the current field.

Returns:

  • (Array<String>) —

    The path to the response key for the current field



63
64
65
 
# File 'lib/graphql/analysis/visitor.rb', line 63

def response_path
  @response_path.dup
end

#skipping? ⇒ Boolean

Returns If the current node should be skipped because of a skip or include directive.

Returns:

  • (Boolean) —

    If the current node should be skipped because of a skip or include directive



58
59
60
 
# File 'lib/graphql/analysis/visitor.rb', line 58

def skipping?
  @skipping
end

#type_definition ⇒ GraphQL::BaseType

Returns The current object type.

Returns:

  • (GraphQL::BaseType) —

    The current object type



207
208
209
 
# File 'lib/graphql/analysis/visitor.rb', line 207

def type_definition
  @object_types.last
end

#visit ⇒ Object 



39
40
41
42
 
# File 'lib/graphql/analysis/visitor.rb', line 39

def visit
  return unless @document
  super
end

#visiting_fragment_definition? ⇒ Boolean

Returns If the visitor is currently inside a fragment definition.

Returns:

  • (Boolean) —

    If the visitor is currently inside a fragment definition



53
54
55
 
# File 'lib/graphql/analysis/visitor.rb', line 53

def visiting_fragment_definition?
  @in_fragment_def
end