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
|
# frozen_string_literal: true
require "active_support/inflector"
require "graphql"
require "graphql/client/view_module"
require "rubocop"
module RuboCop
module Cop
module GraphQL
# Public: Rubocop for catching overfetched fields in ERB templates.
class Overfetch < Cop
if defined?(RangeHelp)
# rubocop 0.53 moved the #source_range method into this module
include RangeHelp
end
def_node_search :send_methods, "({send csend block_pass} ...)"
def investigate(processed_source)
erb = File.read(processed_source.buffer.name)
query, = ::GraphQL::Client::ViewModule.extract_graphql_section(erb)
return unless query
aliases = {}
fields = {}
ranges = {}
# TODO: Use GraphQL client parser
document = ::GraphQL.parse(query.gsub(/::/, "__"))
visitor = ::GraphQL::Language::Visitor.new(document)
visitor[::GraphQL::Language::Nodes::Field] << ->(node, _parent) do
name = node.alias || node.name
fields[name] ||= 0
field_aliases(name).each { |n| (aliases[n] ||= []) << name }
ranges[name] ||= source_range(processed_source.buffer, node.line, 0)
end
visitor.visit
send_methods(processed_source.ast).each do |node|
method_names = method_names_for(*node)
method_names.each do |method_name|
aliases.fetch(method_name, []).each do |field_name|
fields[field_name] += 1
end
end
end
fields.each do |field, count|
next if count > 0
add_offense(nil, location: ranges[field], message: "GraphQL field '#{field}' query but was not used in template.")
end
end
def field_aliases(name)
names = Set.new
names << name
names << "#{name}?"
names << underscore_name = ActiveSupport::Inflector.underscore(name)
names << "#{underscore_name}?"
names
end
def method_names_for(*node)
receiver, method_name, *_args = node
method_names = []
method_names << method_name if method_name
# add field accesses like `nodes.map(&:field)`
method_names.concat(receiver.children) if receiver && receiver.sym_type?
method_names.map!(&:to_s)
end
end
end
end
end
|
