2019-08-22 14:17:38 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
# Recursive queries, with relatively low effort, can quickly spiral out of control exponentially
|
|
|
|
# and may not be picked up by depth and complexity alone.
|
|
|
|
module Gitlab
|
|
|
|
module Graphql
|
|
|
|
module QueryAnalyzers
|
|
|
|
class RecursionAnalyzer
|
2020-02-04 00:09:04 +00:00
|
|
|
IGNORED_FIELDS = %w(node edges nodes ofType).freeze
|
2019-08-22 14:17:38 +00:00
|
|
|
RECURSION_THRESHOLD = 2
|
|
|
|
|
|
|
|
def initial_value(query)
|
|
|
|
{
|
|
|
|
recurring_fields: {}
|
|
|
|
}
|
|
|
|
end
|
|
|
|
|
|
|
|
def call(memo, visit_type, irep_node)
|
|
|
|
return memo if skip_node?(irep_node)
|
|
|
|
|
|
|
|
node_name = irep_node.ast_node.name
|
|
|
|
times_encountered = memo[node_name] || 0
|
|
|
|
|
|
|
|
if visit_type == :enter
|
|
|
|
times_encountered += 1
|
|
|
|
memo[:recurring_fields][node_name] = times_encountered if recursion_too_deep?(node_name, times_encountered)
|
|
|
|
else
|
|
|
|
times_encountered -= 1
|
|
|
|
end
|
|
|
|
|
|
|
|
memo[node_name] = times_encountered
|
|
|
|
memo
|
|
|
|
end
|
|
|
|
|
|
|
|
def final_value(memo)
|
|
|
|
recurring_fields = memo[:recurring_fields]
|
|
|
|
recurring_fields = recurring_fields.select { |k, v| recursion_too_deep?(k, v) }
|
|
|
|
if recurring_fields.any?
|
|
|
|
GraphQL::AnalysisError.new("Recursive query - too many of fields '#{recurring_fields}' detected in single branch of the query")
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def recursion_too_deep?(node_name, times_encountered)
|
|
|
|
return if IGNORED_FIELDS.include?(node_name)
|
|
|
|
|
2019-08-28 03:47:29 +00:00
|
|
|
times_encountered > recursion_threshold
|
2019-08-22 14:17:38 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def skip_node?(irep_node)
|
|
|
|
ast_node = irep_node.ast_node
|
|
|
|
!ast_node.is_a?(GraphQL::Language::Nodes::Field) || ast_node.selections.empty?
|
|
|
|
end
|
2019-08-28 03:47:29 +00:00
|
|
|
|
|
|
|
def recursion_threshold
|
|
|
|
RECURSION_THRESHOLD
|
|
|
|
end
|
2019-08-22 14:17:38 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|