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 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 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 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
|
# frozen_string_literal: true
module GraphQL
module Language
# @api private
#
# {GraphQL::Language::DocumentFromSchemaDefinition} is used to convert a {GraphQL::Schema} object
# To a {GraphQL::Language::Document} AST node.
#
# @param context [Hash]
# @param only [<#call(member, ctx)>]
# @param except [<#call(member, ctx)>]
# @param include_introspection_types [Boolean] Whether or not to include introspection types in the AST
# @param include_built_in_scalars [Boolean] Whether or not to include built in scalars in the AST
# @param include_built_in_directives [Boolean] Whether or not to include built in directives in the AST
class DocumentFromSchemaDefinition
def initialize(
schema, context: nil, include_introspection_types: false,
include_built_in_directives: false, include_built_in_scalars: false, always_include_schema: false
)
@schema = schema
@always_include_schema = always_include_schema
@include_introspection_types = include_introspection_types
@include_built_in_scalars = include_built_in_scalars
@include_built_in_directives = include_built_in_directives
@include_one_of = false
schema_context = schema.context_class.new(query: nil, object: nil, schema: schema, values: context)
@warden = @schema.warden_class.new(
schema: @schema,
context: schema_context,
)
schema_context.warden = @warden
end
def document
GraphQL::Language::Nodes::Document.new(
definitions: build_definition_nodes
)
end
def build_schema_node
if !schema_respects_root_name_conventions?(@schema)
GraphQL::Language::Nodes::SchemaDefinition.new(
query: (q = warden.root_type_for_operation("query")) && q.graphql_name,
mutation: (m = warden.root_type_for_operation("mutation")) && m.graphql_name,
subscription: (s = warden.root_type_for_operation("subscription")) && s.graphql_name,
directives: definition_directives(@schema, :schema_directives)
)
else
# A plain `schema ...` _must_ include root type definitions.
# If the only difference is directives, then you have to use `extend schema`
GraphQL::Language::Nodes::SchemaExtension.new(directives: definition_directives(@schema, :schema_directives))
end
end
def build_object_type_node(object_type)
ints = warden.interfaces(object_type)
if ints.any?
ints.sort_by!(&:graphql_name)
ints.map! { |iface| build_type_name_node(iface) }
end
GraphQL::Language::Nodes::ObjectTypeDefinition.new(
name: object_type.graphql_name,
interfaces: ints,
fields: build_field_nodes(warden.fields(object_type)),
description: object_type.description,
directives: directives(object_type),
)
end
def build_field_node(field)
GraphQL::Language::Nodes::FieldDefinition.new(
name: field.graphql_name,
arguments: build_argument_nodes(warden.arguments(field)),
type: build_type_name_node(field.type),
description: field.description,
directives: directives(field),
)
end
def build_union_type_node(union_type)
GraphQL::Language::Nodes::UnionTypeDefinition.new(
name: union_type.graphql_name,
description: union_type.description,
types: warden.possible_types(union_type).sort_by(&:graphql_name).map { |type| build_type_name_node(type) },
directives: directives(union_type),
)
end
def build_interface_type_node(interface_type)
GraphQL::Language::Nodes::InterfaceTypeDefinition.new(
name: interface_type.graphql_name,
interfaces: warden.interfaces(interface_type).sort_by(&:graphql_name).map { |type| build_type_name_node(type) },
description: interface_type.description,
fields: build_field_nodes(warden.fields(interface_type)),
directives: directives(interface_type),
)
end
def build_enum_type_node(enum_type)
GraphQL::Language::Nodes::EnumTypeDefinition.new(
name: enum_type.graphql_name,
values: warden.enum_values(enum_type).sort_by(&:graphql_name).map do |enum_value|
build_enum_value_node(enum_value)
end,
description: enum_type.description,
directives: directives(enum_type),
)
end
def build_enum_value_node(enum_value)
GraphQL::Language::Nodes::EnumValueDefinition.new(
name: enum_value.graphql_name,
description: enum_value.description,
directives: directives(enum_value),
)
end
def build_scalar_type_node(scalar_type)
GraphQL::Language::Nodes::ScalarTypeDefinition.new(
name: scalar_type.graphql_name,
description: scalar_type.description,
directives: directives(scalar_type),
)
end
def build_argument_node(argument)
if argument.default_value?
default_value = build_default_value(argument.default_value, argument.type)
else
default_value = nil
end
argument_node = GraphQL::Language::Nodes::InputValueDefinition.new(
name: argument.graphql_name,
description: argument.description,
type: build_type_name_node(argument.type),
default_value: default_value,
directives: directives(argument),
)
argument_node
end
def build_input_object_node(input_object)
GraphQL::Language::Nodes::InputObjectTypeDefinition.new(
name: input_object.graphql_name,
fields: build_argument_nodes(warden.arguments(input_object)),
description: input_object.description,
directives: directives(input_object),
)
end
def build_directive_node(directive)
GraphQL::Language::Nodes::DirectiveDefinition.new(
name: directive.graphql_name,
repeatable: directive.repeatable?,
arguments: build_argument_nodes(warden.arguments(directive)),
locations: build_directive_location_nodes(directive.locations),
description: directive.description,
)
end
def build_directive_location_nodes(locations)
locations.sort.map { |location| build_directive_location_node(location) }
end
def build_directive_location_node(location)
GraphQL::Language::Nodes::DirectiveLocation.new(
name: location.to_s
)
end
def build_type_name_node(type)
case type.kind.name
when "LIST"
GraphQL::Language::Nodes::ListType.new(
of_type: build_type_name_node(type.of_type)
)
when "NON_NULL"
GraphQL::Language::Nodes::NonNullType.new(
of_type: build_type_name_node(type.of_type)
)
else
@cached_type_name_nodes ||= {}
@cached_type_name_nodes[type.graphql_name] ||= GraphQL::Language::Nodes::TypeName.new(name: type.graphql_name)
end
end
def build_default_value(default_value, type)
if default_value.nil?
return GraphQL::Language::Nodes::NullValue.new(name: "null")
end
case type.kind.name
when "SCALAR"
type.coerce_isolated_result(default_value)
when "ENUM"
GraphQL::Language::Nodes::Enum.new(name: type.coerce_isolated_result(default_value))
when "INPUT_OBJECT"
GraphQL::Language::Nodes::InputObject.new(
arguments: default_value.to_h.map do |arg_name, arg_value|
args = @warden.arguments(type)
arg = args.find { |a| a.keyword.to_s == arg_name.to_s }
if arg.nil?
raise ArgumentError, "No argument definition on #{type.graphql_name} for argument: #{arg_name.inspect} (expected one of: #{args.map(&:keyword)})"
end
GraphQL::Language::Nodes::Argument.new(
name: arg.graphql_name.to_s,
value: build_default_value(arg_value, arg.type)
)
end
)
when "NON_NULL"
build_default_value(default_value, type.of_type)
when "LIST"
default_value.to_a.map { |v| build_default_value(v, type.of_type) }
else
raise GraphQL::RequiredImplementationMissingError, "Unexpected default value type #{type.inspect}"
end
end
def build_type_definition_node(type)
case type.kind.name
when "OBJECT"
build_object_type_node(type)
when "UNION"
build_union_type_node(type)
when "INTERFACE"
build_interface_type_node(type)
when "SCALAR"
build_scalar_type_node(type)
when "ENUM"
build_enum_type_node(type)
when "INPUT_OBJECT"
build_input_object_node(type)
else
raise TypeError
end
end
def build_argument_nodes(arguments)
if arguments.any?
nodes = arguments.map { |arg| build_argument_node(arg) }
nodes.sort_by!(&:name)
nodes
else
arguments
end
end
def build_directive_nodes(directives)
directives
.map { |directive| build_directive_node(directive) }
.sort_by(&:name)
end
def build_definition_nodes
dirs_to_build = warden.directives
if !include_built_in_directives
dirs_to_build = dirs_to_build.reject { |directive| directive.default_directive? }
end
definitions = build_directive_nodes(dirs_to_build)
type_nodes = build_type_definition_nodes(warden.reachable_types + schema.extra_types)
if @include_one_of
# This may have been set to true when iterating over all types
definitions.concat(build_directive_nodes([GraphQL::Schema::Directive::OneOf]))
end
definitions.concat(type_nodes)
if include_schema_node?
definitions.unshift(build_schema_node)
end
definitions
end
def build_type_definition_nodes(types)
if !include_introspection_types
types = types.reject { |type| type.introspection? }
end
if !include_built_in_scalars
types = types.reject { |type| type.kind.scalar? && type.default_scalar? }
end
types
.map { |type| build_type_definition_node(type) }
.sort_by(&:name)
end
def build_field_nodes(fields)
f_nodes = fields.map { |field| build_field_node(field) }
f_nodes.sort_by!(&:name)
f_nodes
end
private
def include_schema_node?
always_include_schema ||
!schema_respects_root_name_conventions?(schema) ||
!schema.schema_directives.empty?
end
def schema_respects_root_name_conventions?(schema)
(schema.query.nil? || schema.query.graphql_name == 'Query') &&
(schema.mutation.nil? || schema.mutation.graphql_name == 'Mutation') &&
(schema.subscription.nil? || schema.subscription.graphql_name == 'Subscription')
end
def directives(member)
definition_directives(member, :directives)
end
def definition_directives(member, directives_method)
dirs = if !member.respond_to?(directives_method) || member.directives.empty?
EmptyObjects::EMPTY_ARRAY
else
member.public_send(directives_method).map do |dir|
args = []
dir.arguments.argument_values.each_value do |arg_value| # rubocop:disable Development/ContextIsPassedCop -- directive instance method
arg_defn = arg_value.definition
if arg_defn.default_value? && arg_value.value == arg_defn.default_value
next
else
value_node = build_default_value(arg_value.value, arg_value.definition.type)
args << GraphQL::Language::Nodes::Argument.new(
name: arg_value.definition.name,
value: value_node,
)
end
end
# If this schema uses this built-in directive definition,
# include it in the print-out since it's not part of the spec yet.
@include_one_of ||= dir.class == GraphQL::Schema::Directive::OneOf
GraphQL::Language::Nodes::Directive.new(
name: dir.class.graphql_name,
arguments: args
)
end
end
dirs
end
attr_reader :schema, :warden, :always_include_schema,
:include_introspection_types, :include_built_in_directives, :include_built_in_scalars
end
end
end
|