Analyzer APIを使ってconnectionフィールドのfirstまたはlast argumentを必須パラメータにする (graphql-ruby 1.9)
See also Analyzer APIを使ってconnectionフィールドのfirstまたはlast argumentを必須パラメータにする (graphql-ruby 1.8)
code:app/graphql/analyzers/relay_connection_first_last_requried.rb
# frozen_string_literal: true
module Analyzers
class RelayConnectionFirstLastRequired < GraphQL::Analysis::AST::Analyzer
def result
errors
end
# @param GraphQL::Language::Nodes::Field node
# @param GraphQL::Language::Nodes::AbstractNode _parent
# @param GraphQL::Analysis::AST::Visitor visitor
def on_leave_field(node, _parent, visitor)
return if visitor.skipping?
# @type GraphQL::Field
field = visitor.field_definition
if connection?(field)
args = visitor.arguments_for(node, field)
unless args.key?("first") || args.key?("last")
errors << GraphQL::AnalysisError.new(
"You have to use first or last parameter for #{field.type.unwrap}: #{field.graphql_name}",
ast_node: node,
)
end
end
end
# @param GraphQL::Field field
def connection?(field)
# Kibela's SimpleConnection has no last,
# so just check first existence.
field.type.to_type_signature =~ /Connection!?/ && field.arguments.key?("first")
end
# @return Array<String>
private def errors
@errors ||= []
end
end
end
#Analyzer_API