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 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
|
# frozen_string_literal: true
require "strscan"
require "graphql/language/nodes"
module GraphQL
module Language
class Parser
include GraphQL::Language::Nodes
include EmptyObjects
class << self
attr_accessor :cache
def parse(graphql_str, filename: nil, trace: Tracing::NullTrace)
self.new(graphql_str, filename: filename, trace: trace).parse
end
def parse_file(filename, trace: Tracing::NullTrace)
if cache
cache.fetch(filename) do
parse(File.read(filename), filename: filename, trace: trace)
end
else
parse(File.read(filename), filename: filename, trace: trace)
end
end
end
def initialize(graphql_str, filename: nil, trace: Tracing::NullTrace)
if graphql_str.nil?
raise GraphQL::ParseError.new("No query string was present", nil, nil, nil)
end
@lexer = Lexer.new(graphql_str, filename: filename)
@graphql_str = graphql_str
@filename = filename
@trace = trace
end
def parse
@document ||= begin
@trace.parse(query_string: @graphql_str) do
document
end
rescue SystemStackError
raise GraphQL::ParseError.new("This query is too large to execute.", nil, nil, @query_str, filename: @filename)
end
end
private
attr_reader :token_name
def advance_token
@token_name = @lexer.advance
end
def pos
@lexer.pos
end
def document
any_tokens = advance_token
defns = []
if any_tokens
defns << definition
else
# Only ignored characters is not a valid document
raise GraphQL::ParseError.new("Unexpected end of document", nil, nil, @graphql_str)
end
while !@lexer.eos?
defns << definition
end
Document.new(pos: 0, definitions: defns, filename: @filename, source_string: @graphql_str)
end
def definition
case token_name
when :FRAGMENT
loc = pos
expect_token :FRAGMENT
f_name = if !at?(:ON)
parse_name
end
expect_token :ON
f_type = parse_type_name
directives = parse_directives
selections = selection_set
Nodes::FragmentDefinition.new(
pos: loc,
name: f_name,
type: f_type,
directives: directives,
selections: selections,
filename: @filename,
source_string: @graphql_str
)
when :QUERY, :MUTATION, :SUBSCRIPTION, :LCURLY
op_loc = pos
op_type = case token_name
when :LCURLY
"query"
else
parse_operation_type
end
op_name = at?(:IDENTIFIER) ? parse_name : nil
variable_definitions = if at?(:LPAREN)
expect_token(:LPAREN)
defs = []
while !at?(:RPAREN)
loc = pos
expect_token(:VAR_SIGN)
var_name = parse_name
expect_token(:COLON)
var_type = self.type
default_value = if at?(:EQUALS)
advance_token
value
end
directives = parse_directives
defs << Nodes::VariableDefinition.new(
pos: loc,
name: var_name,
type: var_type,
default_value: default_value,
directives: directives,
filename: @filename,
source_string: @graphql_str
)
end
expect_token(:RPAREN)
defs
else
EmptyObjects::EMPTY_ARRAY
end
directives = parse_directives
OperationDefinition.new(
pos: op_loc,
operation_type: op_type,
name: op_name,
variables: variable_definitions,
directives: directives,
selections: selection_set,
filename: @filename,
source_string: @graphql_str
)
when :EXTEND
loc = pos
advance_token
case token_name
when :SCALAR
advance_token
name = parse_name
directives = parse_directives
ScalarTypeExtension.new(pos: loc, name: name, directives: directives, filename: @filename, source_string: @graphql_str)
when :TYPE
advance_token
name = parse_name
implements_interfaces = parse_implements
directives = parse_directives
field_defns = at?(:LCURLY) ? parse_field_definitions : EMPTY_ARRAY
ObjectTypeExtension.new(pos: loc, name: name, interfaces: implements_interfaces, directives: directives, fields: field_defns, filename: @filename, source_string: @graphql_str)
when :INTERFACE
advance_token
name = parse_name
directives = parse_directives
interfaces = parse_implements
fields_definition = at?(:LCURLY) ? parse_field_definitions : EMPTY_ARRAY
InterfaceTypeExtension.new(pos: loc, name: name, directives: directives, fields: fields_definition, interfaces: interfaces, filename: @filename, source_string: @graphql_str)
when :UNION
advance_token
name = parse_name
directives = parse_directives
union_member_types = parse_union_members
UnionTypeExtension.new(pos: loc, name: name, directives: directives, types: union_member_types, filename: @filename, source_string: @graphql_str)
when :ENUM
advance_token
name = parse_name
directives = parse_directives
enum_values_definition = parse_enum_value_definitions
Nodes::EnumTypeExtension.new(pos: loc, name: name, directives: directives, values: enum_values_definition, filename: @filename, source_string: @graphql_str)
when :INPUT
advance_token
name = parse_name
directives = parse_directives
input_fields_definition = parse_input_object_field_definitions
InputObjectTypeExtension.new(pos: loc, name: name, directives: directives, fields: input_fields_definition, filename: @filename, source_string: @graphql_str)
when :SCHEMA
advance_token
directives = parse_directives
query = mutation = subscription = nil
if at?(:LCURLY)
advance_token
while !at?(:RCURLY)
if at?(:QUERY)
advance_token
expect_token(:COLON)
query = parse_name
elsif at?(:MUTATION)
advance_token
expect_token(:COLON)
mutation = parse_name
elsif at?(:SUBSCRIPTION)
advance_token
expect_token(:COLON)
subscription = parse_name
else
expect_one_of([:QUERY, :MUTATION, :SUBSCRIPTION])
end
end
expect_token :RCURLY
end
SchemaExtension.new(
subscription: subscription,
mutation: mutation,
query: query,
directives: directives,
pos: loc,
filename: @filename,
source_string: @graphql_str,
)
else
expect_one_of([:SCHEMA, :SCALAR, :TYPE, :ENUM, :INPUT, :UNION, :INTERFACE])
end
else
loc = pos
desc = at?(:STRING) ? string_value : nil
defn_loc = pos
case token_name
when :SCHEMA
advance_token
directives = parse_directives
query = mutation = subscription = nil
expect_token :LCURLY
while !at?(:RCURLY)
if at?(:QUERY)
advance_token
expect_token(:COLON)
query = parse_name
elsif at?(:MUTATION)
advance_token
expect_token(:COLON)
mutation = parse_name
elsif at?(:SUBSCRIPTION)
advance_token
expect_token(:COLON)
subscription = parse_name
else
expect_one_of([:QUERY, :MUTATION, :SUBSCRIPTION])
end
end
expect_token :RCURLY
SchemaDefinition.new(pos: loc, definition_pos: defn_loc, query: query, mutation: mutation, subscription: subscription, directives: directives, filename: @filename, source_string: @graphql_str)
when :DIRECTIVE
advance_token
expect_token :DIR_SIGN
name = parse_name
arguments_definition = parse_argument_definitions
repeatable = if at?(:REPEATABLE)
advance_token
true
else
false
end
expect_token :ON
directive_locations = [DirectiveLocation.new(pos: pos, name: parse_name, filename: @filename, source_string: @graphql_str)]
while at?(:PIPE)
advance_token
directive_locations << DirectiveLocation.new(pos: pos, name: parse_name, filename: @filename, source_string: @graphql_str)
end
DirectiveDefinition.new(pos: loc, definition_pos: defn_loc, description: desc, name: name, arguments: arguments_definition, locations: directive_locations, repeatable: repeatable, filename: @filename, source_string: @graphql_str)
when :TYPE
advance_token
name = parse_name
implements_interfaces = parse_implements
directives = parse_directives
field_defns = at?(:LCURLY) ? parse_field_definitions : EMPTY_ARRAY
ObjectTypeDefinition.new(pos: loc, definition_pos: defn_loc, description: desc, name: name, interfaces: implements_interfaces, directives: directives, fields: field_defns, filename: @filename, source_string: @graphql_str)
when :INTERFACE
advance_token
name = parse_name
interfaces = parse_implements
directives = parse_directives
fields_definition = parse_field_definitions
InterfaceTypeDefinition.new(pos: loc, definition_pos: defn_loc, description: desc, name: name, directives: directives, fields: fields_definition, interfaces: interfaces, filename: @filename, source_string: @graphql_str)
when :UNION
advance_token
name = parse_name
directives = parse_directives
union_member_types = parse_union_members
UnionTypeDefinition.new(pos: loc, definition_pos: defn_loc, description: desc, name: name, directives: directives, types: union_member_types, filename: @filename, source_string: @graphql_str)
when :SCALAR
advance_token
name = parse_name
directives = parse_directives
ScalarTypeDefinition.new(pos: loc, definition_pos: defn_loc, description: desc, name: name, directives: directives, filename: @filename, source_string: @graphql_str)
when :ENUM
advance_token
name = parse_name
directives = parse_directives
enum_values_definition = parse_enum_value_definitions
Nodes::EnumTypeDefinition.new(pos: loc, definition_pos: defn_loc, description: desc, name: name, directives: directives, values: enum_values_definition, filename: @filename, source_string: @graphql_str)
when :INPUT
advance_token
name = parse_name
directives = parse_directives
input_fields_definition = parse_input_object_field_definitions
InputObjectTypeDefinition.new(pos: loc, definition_pos: defn_loc, description: desc, name: name, directives: directives, fields: input_fields_definition, filename: @filename, source_string: @graphql_str)
else
expect_one_of([:SCHEMA, :SCALAR, :TYPE, :ENUM, :INPUT, :UNION, :INTERFACE])
end
end
end
def parse_input_object_field_definitions
if at?(:LCURLY)
expect_token :LCURLY
list = []
while !at?(:RCURLY)
list << parse_input_value_definition
end
expect_token :RCURLY
list
else
EMPTY_ARRAY
end
end
def parse_enum_value_definitions
if at?(:LCURLY)
expect_token :LCURLY
list = []
while !at?(:RCURLY)
v_loc = pos
description = if at?(:STRING); string_value; end
defn_loc = pos
enum_value = parse_enum_name
v_directives = parse_directives
list << EnumValueDefinition.new(pos: v_loc, definition_pos: defn_loc, description: description, name: enum_value, directives: v_directives, filename: @filename, source_string: @graphql_str)
end
expect_token :RCURLY
list
else
EMPTY_ARRAY
end
end
def parse_union_members
if at?(:EQUALS)
expect_token :EQUALS
list = [parse_type_name]
while at?(:PIPE)
advance_token
list << parse_type_name
end
list
else
EMPTY_ARRAY
end
end
def parse_implements
if at?(:IMPLEMENTS)
advance_token
list = []
while true
advance_token if at?(:AMP)
break unless at?(:IDENTIFIER)
list << parse_type_name
end
list
else
EMPTY_ARRAY
end
end
def parse_field_definitions
expect_token :LCURLY
list = []
while !at?(:RCURLY)
loc = pos
description = if at?(:STRING); string_value; end
defn_loc = pos
name = parse_name
arguments_definition = parse_argument_definitions
expect_token :COLON
type = self.type
directives = parse_directives
list << FieldDefinition.new(pos: loc, definition_pos: defn_loc, description: description, name: name, arguments: arguments_definition, type: type, directives: directives, filename: @filename, source_string: @graphql_str)
end
expect_token :RCURLY
list
end
def parse_argument_definitions
if at?(:LPAREN)
advance_token
list = []
while !at?(:RPAREN)
list << parse_input_value_definition
end
expect_token :RPAREN
list
else
EMPTY_ARRAY
end
end
def parse_input_value_definition
loc = pos
description = if at?(:STRING); string_value; end
defn_loc = pos
name = parse_name
expect_token :COLON
type = self.type
default_value = if at?(:EQUALS)
advance_token
value
else
nil
end
directives = parse_directives
InputValueDefinition.new(pos: loc, definition_pos: defn_loc, description: description, name: name, type: type, default_value: default_value, directives: directives, filename: @filename, source_string: @graphql_str)
end
def type
type = case token_name
when :IDENTIFIER
parse_type_name
when :LBRACKET
list_type
end
if at?(:BANG)
type = Nodes::NonNullType.new(pos: pos, of_type: type)
expect_token(:BANG)
end
type
end
def list_type
loc = pos
expect_token(:LBRACKET)
type = Nodes::ListType.new(pos: loc, of_type: self.type)
expect_token(:RBRACKET)
type
end
def parse_operation_type
val = if at?(:QUERY)
"query"
elsif at?(:MUTATION)
"mutation"
elsif at?(:SUBSCRIPTION)
"subscription"
else
expect_one_of([:QUERY, :MUTATION, :SUBSCRIPTION])
end
advance_token
val
end
def selection_set
expect_token(:LCURLY)
selections = []
while @token_name != :RCURLY
selections << if at?(:ELLIPSIS)
loc = pos
advance_token
case token_name
when :ON, :DIR_SIGN, :LCURLY
if_type = if at?(:ON)
advance_token
parse_type_name
else
nil
end
directives = parse_directives
Nodes::InlineFragment.new(pos: loc, type: if_type, directives: directives, selections: selection_set, filename: @filename, source_string: @graphql_str)
else
name = parse_name_without_on
directives = parse_directives
# Can this ever happen?
# expect_token(:IDENTIFIER) if at?(:ON)
FragmentSpread.new(pos: loc, name: name, directives: directives, filename: @filename, source_string: @graphql_str)
end
else
loc = pos
name = parse_name
field_alias = nil
if at?(:COLON)
advance_token
field_alias = name
name = parse_name
end
arguments = at?(:LPAREN) ? parse_arguments : nil
directives = at?(:DIR_SIGN) ? parse_directives : nil
selection_set = at?(:LCURLY) ? self.selection_set : nil
Nodes::Field.new(pos: loc, field_alias: field_alias, name: name, arguments: arguments, directives: directives, selections: selection_set, filename: @filename, source_string: @graphql_str)
end
end
expect_token(:RCURLY)
selections
end
def parse_name
case token_name
when :IDENTIFIER
expect_token_value(:IDENTIFIER)
when :SCHEMA
advance_token
"schema"
when :SCALAR
advance_token
"scalar"
when :IMPLEMENTS
advance_token
"implements"
when :INTERFACE
advance_token
"interface"
when :UNION
advance_token
"union"
when :ENUM
advance_token
"enum"
when :INPUT
advance_token
"input"
when :DIRECTIVE
advance_token
"directive"
when :TYPE
advance_token
"type"
when :QUERY
advance_token
"query"
when :MUTATION
advance_token
"mutation"
when :SUBSCRIPTION
advance_token
"subscription"
when :TRUE
advance_token
"true"
when :FALSE
advance_token
"false"
when :FRAGMENT
advance_token
"fragment"
when :REPEATABLE
advance_token
"repeatable"
when :NULL
advance_token
"null"
when :ON
advance_token
"on"
when :DIRECTIVE
advance_token
"directive"
when :EXTEND
advance_token
"extend"
else
expect_token(:NAME)
end
end
def parse_name_without_on
if at?(:ON)
expect_token(:IDENTIFIER)
else
parse_name
end
end
# Any identifier, but not true, false, or null
def parse_enum_name
if at?(:TRUE) || at?(:FALSE) || at?(:NULL)
expect_token(:IDENTIFIER)
else
parse_name
end
end
def parse_type_name
TypeName.new(pos: pos, name: parse_name, filename: @filename, source_string: @graphql_str)
end
def parse_directives
if at?(:DIR_SIGN)
dirs = []
while at?(:DIR_SIGN)
loc = pos
advance_token
name = parse_name
arguments = parse_arguments
dirs << Nodes::Directive.new(pos: loc, name: name, arguments: arguments, filename: @filename, source_string: @graphql_str)
end
dirs
else
EMPTY_ARRAY
end
end
def parse_arguments
if at?(:LPAREN)
advance_token
args = []
while !at?(:RPAREN)
loc = pos
name = parse_name
expect_token(:COLON)
args << Nodes::Argument.new(pos: loc, name: name, value: value, filename: @filename, source_string: @graphql_str)
end
if args.empty?
expect_token(:ARGUMENT_NAME) # At least one argument is required
end
expect_token(:RPAREN)
args
else
EMPTY_ARRAY
end
end
def string_value
token_value = @lexer.string_value
expect_token :STRING
token_value
end
def value
case token_name
when :INT
expect_token_value(:INT).to_i
when :FLOAT
expect_token_value(:FLOAT).to_f
when :STRING
string_value
when :TRUE
advance_token
true
when :FALSE
advance_token
false
when :NULL
advance_token
NullValue.new(pos: pos, name: "null", filename: @filename, source_string: @graphql_str)
when :IDENTIFIER
Nodes::Enum.new(pos: pos, name: expect_token_value(:IDENTIFIER), filename: @filename, source_string: @graphql_str)
when :LBRACKET
advance_token
list = []
while !at?(:RBRACKET)
list << value
end
expect_token(:RBRACKET)
list
when :LCURLY
start = pos
advance_token
args = []
while !at?(:RCURLY)
loc = pos
n = parse_name
expect_token(:COLON)
args << Argument.new(pos: loc, name: n, value: value, filename: @filename, source_string: @graphql_str)
end
expect_token(:RCURLY)
InputObject.new(pos: start, arguments: args, filename: @filename, source_string: @graphql_str)
when :VAR_SIGN
loc = pos
advance_token
VariableIdentifier.new(pos: loc, name: parse_name, filename: @filename, source_string: @graphql_str)
else
expect_token(:VALUE)
end
end
def at?(expected_token_name)
@token_name == expected_token_name
end
def expect_token(expected_token_name)
unless @token_name == expected_token_name
raise_parse_error("Expected #{expected_token_name}, actual: #{token_name || "(none)"} (#{debug_token_value.inspect})")
end
advance_token
end
def expect_one_of(token_names)
raise_parse_error("Expected one of #{token_names.join(", ")}, actual: #{token_name || "NOTHING"} (#{debug_token_value.inspect})")
end
def raise_parse_error(message)
message += " at [#{@lexer.line_number}, #{@lexer.column_number}]"
raise GraphQL::ParseError.new(
message,
@lexer.line_number,
@lexer.column_number,
@graphql_str,
filename: @filename,
)
end
# Only use when we care about the expected token's value
def expect_token_value(tok)
token_value = @lexer.token_value
expect_token(tok)
token_value
end
# token_value works for when the scanner matched something
# which is usually fine and it's good for it to be fast at that.
def debug_token_value
@lexer.debug_token_value(token_name)
end
end
end
end
|