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
|
# frozen_string_literal: true
require "spec_helper"
describe GraphQL::Analysis::AST do
class AstTypeCollector < GraphQL::Analysis::AST::Analyzer
def initialize(query)
super
@types = []
end
def on_enter_operation_definition(node, parent, visitor)
@types << visitor.type_definition
end
def on_enter_field(memo, node, visitor)
@types << visitor.field_definition.type.unwrap
end
def result
@types
end
end
class AstNodeCounter < GraphQL::Analysis::AST::Analyzer
def initialize(query)
super
@nodes = Hash.new { |h,k| h[k] = 0 }
end
def on_enter_abstract_node(node, parent, _visitor)
@nodes[node.class] += 1
end
alias :on_enter_operation_definition :on_enter_abstract_node
alias :on_enter_field :on_enter_abstract_node
alias :on_enter_argument :on_enter_abstract_node
def result
@nodes
end
end
class AstConditionalAnalyzer < GraphQL::Analysis::AST::Analyzer
def initialize(query)
super
@i_have_been_called = false
end
def analyze?
!!query.context[:analyze]
end
def on_operation_definition(node, parent, visitor)
@i_have_been_called = true
end
def result
@i_have_been_called
end
end
class AstPrecomputedAnalyzer < GraphQL::Analysis::AST::Analyzer
def initialize(query)
super
@i_have_been_visited = false
end
def visit?
query.context[:precomputed_result].nil?
end
def on_enter_field(node, parent, visitor)
@i_have_been_visited = true
end
def result
return query.context[:precomputed_result], @i_have_been_visited
end
end
class AstErrorAnalyzer < GraphQL::Analysis::AST::Analyzer
def result
GraphQL::AnalysisError.new("An Error!")
end
end
class AstPreviousField < GraphQL::Analysis::AST::Analyzer
def on_enter_field(node, parent, visitor)
@previous_field = visitor.previous_field_definition
end
def result
@previous_field
end
end
class AstArguments < GraphQL::Analysis::AST::Analyzer
def on_enter_argument(node, parent, visitor)
@argument = visitor.argument_definition
@previous_argument = visitor.previous_argument_definition
end
def result
[@argument, @previous_argument]
end
end
describe "using the AST analysis engine" do
let(:schema) do
query_type = Class.new(GraphQL::Schema::Object) do
graphql_name 'Query'
field :foobar, Integer, null: false
def foobar
1337
end
end
Class.new(GraphQL::Schema) do
query query_type
query_analyzer AstErrorAnalyzer
end
end
let(:query_string) {%|
query {
foobar
}
|}
let(:query) { GraphQL::Query.new(schema, query_string, variables: {}) }
it "runs the AST analyzers correctly" do
res = query.result
refute res.key?("data")
assert_equal ["An Error!"], res["errors"].map { |e| e["message"] }
end
end
describe ".analyze_query" do
let(:analyzers) { [AstTypeCollector, AstNodeCounter] }
let(:reduce_result) { GraphQL::Analysis::AST.analyze_query(query, analyzers) }
let(:variables) { {} }
let(:query) { GraphQL::Query.new(Dummy::Schema, query_string, variables: variables) }
let(:query_string) {%|
{
cheese(id: 1) {
id
flavor
}
}
|}
describe "without a valid operation" do
let(:query_string) {%|
# A comment
# is an invalid operation
# Should break
|}
it "bails early when there is no selected operation to be executed" do
assert_equal 2, reduce_result.size
end
end
describe "conditional analysis" do
let(:analyzers) { [AstTypeCollector, AstConditionalAnalyzer] }
describe "when analyze? returns false" do
let(:query) { GraphQL::Query.new(Dummy::Schema, query_string, variables: variables, context: { analyze: false }) }
it "does not run the analyzer" do
# Only type_collector ran
assert_equal 1, reduce_result.size
end
end
describe "when analyze? returns true" do
let(:query) { GraphQL::Query.new(Dummy::Schema, query_string, variables: variables, context: { analyze: true }) }
it "it runs the analyzer" do
# Both analyzers ran
assert_equal 2, reduce_result.size
end
end
describe "Visitor#previous_field_definition" do
let(:analyzers) { [AstPreviousField] }
let(:query) { GraphQL::Query.new(Dummy::Schema, "{ __schema { types { name } } }") }
it "it runs the analyzer" do
prev_field = reduce_result.first
assert_equal "__Schema.types", prev_field.path
end
end
describe "Visitor#argument_definition" do
let(:analyzers) { [AstArguments] }
let(:query) do
GraphQL::Query.new(
Dummy::Schema,
'{ searchDairy(product: [{ source: "SHEEP" }]) { ... on Cheese { id } } }'
)
end
it "it runs the analyzer" do
argument, prev_argument = reduce_result.first
assert_equal "DairyProductInput.source", argument.path
assert_equal "Query.searchDairy.product", prev_argument.path
end
end
end
describe "precomputed analysis" do
let(:analyzers) { [AstPrecomputedAnalyzer] }
describe "when visit? returns true" do
let(:query) { GraphQL::Query.new(Dummy::Schema, query_string, variables: variables, context: {}) }
it "runs the analyzer with visitation" do
assert_equal [nil, true], reduce_result.first
end
end
describe "when visit? returns false" do
let(:query) { GraphQL::Query.new(Dummy::Schema, query_string, variables: variables, context: { precomputed_result: 23 }) }
it "runs the analyzer without visitation" do
assert_equal [23, false], reduce_result.first
end
end
end
it "calls the defined analyzers" do
collected_types, node_counts = reduce_result
expected_visited_types = [
Dummy::DairyAppQuery,
Dummy::Cheese,
GraphQL::Types::Int,
GraphQL::Types::String
]
assert_equal expected_visited_types, collected_types
expected_node_counts = {
GraphQL::Language::Nodes::OperationDefinition => 1,
GraphQL::Language::Nodes::Field => 3,
GraphQL::Language::Nodes::Argument => 1
}
assert_equal expected_node_counts, node_counts
end
class FinishedSchema < GraphQL::Schema
class FinishedAnalyzer < GraphQL::Analysis::AST::Analyzer
def on_enter_field(node, parent, visitor)
if query.context[:force_prepare]
visitor.arguments_for(node, visitor.field_definition)
end
end
def result
query.context[:analysis_finished] = true
end
end
class Query < GraphQL::Schema::Object
field :f1, Int do
argument :arg, String, prepare: ->(val, ctx) {
ctx[:analysis_finished] ? val.to_i : raise("Prepared too soon!")
}
end
def f1(arg:)
arg
end
end
query(Query)
query_analyzer(FinishedAnalyzer)
end
it "doesn't call prepare hooks by default" do
res = FinishedSchema.execute("{ f1(arg: \"5\") }")
assert_equal 5, res["data"]["f1"]
err = assert_raises RuntimeError do
FinishedSchema.execute("{ f1(arg: \"5\") }", context: { force_prepare: true })
end
assert_equal "Prepared too soon!", err.message
end
describe "tracing" do
let(:query_string) { "{ t: __typename }"}
it "emits traces" do
traces = TestTracing.with_trace do
ctx = { tracers: [TestTracing] }
Dummy::Schema.execute(query_string, context: ctx)
end
# The query_trace is on the list _first_ because it finished first
if USING_C_PARSER
_lex, _parse, _validate, query_trace, multiplex_trace, *_rest = traces
else
_parse, _validate, query_trace, multiplex_trace, *_rest = traces
end
assert_equal "analyze_multiplex", multiplex_trace[:key]
assert_instance_of GraphQL::Execution::Multiplex, multiplex_trace[:multiplex]
assert_equal "analyze_query", query_trace[:key]
assert_instance_of GraphQL::Query, query_trace[:query]
end
end
class AstConnectionCounter < GraphQL::Analysis::AST::Analyzer
def initialize(query)
super
@fields = 0
@connections = 0
end
def on_enter_field(node, parent, visitor)
if visitor.field_definition.connection?
@connections += 1
else
@fields += 1
end
end
def result
{
fields: @fields,
connections: @connections
}
end
end
describe "when processing fields" do
let(:analyzers) { [AstConnectionCounter] }
let(:reduce_result) { GraphQL::Analysis::AST.analyze_query(query, analyzers) }
let(:query) { GraphQL::Query.new(StarWars::Schema, query_string, variables: variables) }
let(:query_string) {%|
query getBases {
empire {
basesByName(first: 30) { edges { cursor } }
bases(first: 30) { edges { cursor } }
}
}
|}
it "knows which fields are connections" do
connection_counts = reduce_result.first
expected_connection_counts = {
:fields => 5,
:connections => 2
}
assert_equal expected_connection_counts, connection_counts
end
end
end
describe "Detecting all-introspection queries" do
class AllIntrospectionSchema < GraphQL::Schema
class Query < GraphQL::Schema::Object
field :int, Int
end
query(Query)
end
class AllIntrospectionAnalyzer < GraphQL::Analysis::AST::Analyzer
def initialize(query)
@is_introspection = true
super
end
def on_enter_field(node, parent, visitor)
@is_introspection &= (visitor.field_definition.introspection? || ((owner = visitor.field_definition.owner) && owner.introspection?))
end
def result
@is_introspection
end
end
def is_introspection?(query_str)
query = GraphQL::Query.new(AllIntrospectionSchema, query_str)
result = GraphQL::Analysis::AST.analyze_query(query, [AllIntrospectionAnalyzer])
result.first
end
it "returns true for queries containing only introspection types and fields" do
assert is_introspection?("{ __typename }")
refute is_introspection?("{ int }")
assert is_introspection?(GraphQL::Introspection::INTROSPECTION_QUERY)
assert is_introspection?("{ __type(name: \"Something\") { fields { name } } }")
refute is_introspection?("{ int __type(name: \"Thing\") { name } }")
end
end
describe "when there's a hidden field" do
class HiddenAnalyzedFieldSchema < GraphQL::Schema
class DoNothingAnalyzer < GraphQL::Analysis::AST::Analyzer
def on_enter_field(node, parent, visitor)
@result ||= []
@result << [node.name, visitor.field_definition.class]
super
end
def result
@result
end
end
class BaseField < GraphQL::Schema::Field
def initialize(*args, visible: true, **kwargs, &block)
@visible = visible
super(*args, **kwargs, &block)
end
def visible?(context)
return @visible
end
end
class BaseObject < GraphQL::Schema::Object
field_class BaseField
end
class Article < BaseObject
field :title, String, null: false
end
class Query < BaseObject
field :article, String, visible: false do |f|
f.argument(:id, Integer)
end
def article(id:)
{ title: "hello world" }
end
end
query Query
end
it "uses nil for the field definition" do
gql = <<~GQL
{
article(id: 1) {
title
}
}
GQL
query = GraphQL::Query.new(HiddenAnalyzedFieldSchema, gql)
result = GraphQL::Analysis::AST.analyze_query(query, [HiddenAnalyzedFieldSchema::DoNothingAnalyzer])
assert_equal [[["article", NilClass], ["title", NilClass]]], result
end
end
describe ".validate_timeout" do
class AnalysisTimeoutSchema < GraphQL::Schema
class SlowAnalyzer < GraphQL::Analysis::AST::Analyzer
def on_enter_field(node, parent, visitor)
sleep 0.1
super
end
def result
nil
end
end
class Query < GraphQL::Schema::Object
field :f1, Int
def f1
context[:int] ||= 0
context[:int] += 1
end
end
query(Query)
query_analyzer(SlowAnalyzer)
validate_timeout 0.5
end
it "covers analysis too" do
res = AnalysisTimeoutSchema.execute("{ f1: f1 f2: f1 }")
assert_equal({ "f1" => 1, "f2" => 2}, res["data"])
res2 = AnalysisTimeoutSchema.execute("{ f1: f1, f2: f1, f3: f1, f4: f1, f5: f1, f6: f1}")
assert_equal ["Timeout on validation of query"], res2["errors"].map { |e| e["message"]}
end
end
end
|