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
|
# frozen_string_literal: true
require "spec_helper"
describe GraphQL::StaticValidation::VariableUsagesAreAllowed do
include StaticValidationHelpers
let(:query_string) {'
query getCheese(
$goodInt: Int = 1,
$okInt: Int!,
$badInt: Int,
$badStr: String!,
$goodAnimals: [DairyAnimal!]!,
$badAnimals: [DairyAnimal]!,
$deepAnimals: [[DairyAnimal!]!]!,
$goodSource: DairyAnimal!,
) {
goodCheese: cheese(id: $goodInt) { source }
okCheese: cheese(id: $okInt) { source }
badCheese: cheese(id: $badInt) { source }
badStrCheese: cheese(id: $badStr) { source }
cheese(id: 1) {
similarCheese(source: $goodAnimals) { source }
other: similarCheese(source: $badAnimals) { source }
tooDeep: similarCheese(source: $deepAnimals) { source }
nullableCheese(source: $goodAnimals) { source }
deeplyNullableCheese(source: $deepAnimals) { source }
}
milk(id: 1) {
flavors(limit: $okInt)
}
searchDairy(product: [{source: $goodSource}]) {
... on Cheese { id }
}
}
'}
it "finds variables used as arguments but don't match the argument's type" do
assert_equal(4, errors.length)
expected = [
{
"message"=>"Nullability mismatch on variable $badInt and argument id (Int / Int!)",
"locations"=>[{"line"=>14, "column"=>28}],
"path"=>["query getCheese", "badCheese", "id"],
"extensions"=>{"code"=>"variableMismatch", "variableName"=>"badInt", "typeName"=>"Int", "argumentName"=>"id", "errorMessage"=>"Nullability mismatch"}
},
{
"message"=>"Type mismatch on variable $badStr and argument id (String! / Int!)",
"locations"=>[{"line"=>15, "column"=>28}],
"path"=>["query getCheese", "badStrCheese", "id"],
"extensions"=>{"code"=>"variableMismatch", "variableName"=>"badStr", "typeName"=>"String!", "argumentName"=>"id", "errorMessage"=>"Type mismatch"}
},
{
"message"=>"Nullability mismatch on variable $badAnimals and argument source ([DairyAnimal]! / [DairyAnimal!]!)",
"locations"=>[{"line"=>18, "column"=>30}],
"path"=>["query getCheese", "cheese", "other", "source"],
"extensions"=>{"code"=>"variableMismatch", "variableName"=>"badAnimals", "typeName"=>"[DairyAnimal]!", "argumentName"=>"source", "errorMessage"=>"Nullability mismatch"}
},
{
"message"=>"List dimension mismatch on variable $deepAnimals and argument source ([[DairyAnimal!]!]! / [DairyAnimal!]!)",
"locations"=>[{"line"=>19, "column"=>32}],
"path"=>["query getCheese", "cheese", "tooDeep", "source"],
"extensions"=>{"code"=>"variableMismatch", "variableName"=>"deepAnimals", "typeName"=>"[[DairyAnimal!]!]!", "argumentName"=>"source", "errorMessage"=>"List dimension mismatch"}
}
]
assert_equal(expected, errors)
end
describe "input objects that are out of place" do
let(:query_string) { <<-GRAPHQL
query getCheese($id: ID!) {
cheese(id: {blah: $id} ) {
__typename @nonsense(id: {blah: $id})
nonsense(id: {blah: {blah: $id}})
}
}
GRAPHQL
}
it "adds an error" do
assert_equal 3, errors.length
assert_equal "Argument 'id' on Field 'cheese' has an invalid value ({blah: $id}). Expected type 'Int!'.", errors[0]["message"]
end
end
describe "list-type variables" do
let(:schema) {
GraphQL::Schema.from_definition <<-GRAPHQL
input ImageSize {
height: Int
width: Int
scale: Int
}
type Query {
imageUrl(height: Int, width: Int, size: ImageSize, sizes: [ImageSize!]): String!
sizedImageUrl(sizes: [ImageSize!]!): String!
}
GRAPHQL
}
describe "nullability mismatch" do
let(:query_string) {
<<-GRAPHQL
# This variable _should_ be [ImageSize!]
query ($sizes: [ImageSize]) {
imageUrl(sizes: $sizes)
}
GRAPHQL
}
it "finds invalid inner definitions" do
assert_equal 1, errors.size
expected_message = "Nullability mismatch on variable $sizes and argument sizes ([ImageSize] / [ImageSize!])"
assert_equal [expected_message], errors.map { |e| e["message"] }
end
end
describe "list dimension mismatch" do
let(:query_string) {
<<-GRAPHQL
query ($sizes: [ImageSize]) {
imageUrl(sizes: [$sizes])
}
GRAPHQL
}
it "finds invalid inner definitions" do
assert_equal 1, errors.size
expected_message = "List dimension mismatch on variable $sizes and argument sizes ([[ImageSize]]! / [ImageSize!])"
assert_equal [expected_message], errors.map { |e| e["message"] }
end
end
describe 'list is in the argument' do
let(:query_string) {
<<-GRAPHQL
query ($size: ImageSize!) {
imageUrl(sizes: [$size])
}
GRAPHQL
}
it "is a valid query" do
assert_equal 0, errors.size
end
describe "mixed with invalid literals" do
let(:query_string) {
<<-GRAPHQL
query ($size: ImageSize!) {
imageUrl(sizes: [$size, 1, true])
}
GRAPHQL
}
it "is an invalid query" do
assert_equal 1, errors.size
end
end
describe "mixed with invalid variables" do
let(:query_string) {
<<-GRAPHQL
query ($size: ImageSize!, $wrongSize: Boolean!) {
imageUrl(sizes: [$size, $wrongSize])
}
GRAPHQL
}
it "is an invalid query" do
assert_equal 1, errors.size
end
end
describe "mixed with valid literals and invalid variables" do
let(:query_string) {
<<-GRAPHQL
query ($size: ImageSize!, $wrongSize: Boolean!) {
imageUrl(sizes: [$size, {height: 100} $wrongSize])
}
GRAPHQL
}
it "is an invalid query" do
assert_equal 1, errors.size
end
end
end
describe 'argument contains a list with literal values' do
let(:query_string) {
<<-GRAPHQL
query {
imageUrl(sizes: [{height: 100, width: 100, scale: 1}])
}
GRAPHQL
}
it "is a valid query" do
assert_equal 0, errors.size
end
end
describe 'argument contains a list with both literal and variable values' do
let(:query_string) {
<<-GRAPHQL
query($size1: ImageSize!, $size2: ImageSize!) {
imageUrl(sizes: [{height: 100, width: 100, scale: 1}, $size1, {height: 1920, width: 1080, scale: 2}, $size2])
}
GRAPHQL
}
it "is a valid query" do
assert_equal 0, errors.size
end
end
describe "variable in non-null list" do
let(:query_string) {
<<-GRAPHQL
# This should work
query ($size: ImageSize!) {
sizedImageUrl(sizes: [$size])
}
GRAPHQL
}
it "is allowed" do
assert_equal [], errors
end
end
describe "nullability mismatch in non-null list" do
let(:query_string) {
<<-GRAPHQL
query ($sizes: [ImageSize!]) {
sizedImageUrl(sizes: $sizes)
}
GRAPHQL
}
it "gives the right error" do
err = "Nullability mismatch on variable $sizes and argument sizes ([ImageSize!] / [ImageSize!]!)"
assert_equal [err], errors.map { |e| e["message"]}
end
end
end
describe "for input properties" do
class InputVariableSchema < GraphQL::Schema
class Input < GraphQL::Schema::InputObject
argument(:id, String)
end
class FooMutation < GraphQL::Schema::Mutation
field(:foo, String)
argument(:input, Input)
def resolve(input:)
{ foo: input.id }
end
end
class Mutation < GraphQL::Schema::Object
field(:foo_mutation, mutation: FooMutation)
end
mutation(Mutation)
end
it "gives a proper error" do
res1 = InputVariableSchema.execute("mutation($id: String) { fooMutation(input: { id: $id }) { foo } }")
assert_equal ["Nullability mismatch on variable $id and argument id (String / String!)"], res1["errors"].map { |e| e["message"] }
res2 = InputVariableSchema.execute("mutation($id: String!) { fooMutation(input: { id: $id }) { foo } }", variables: { id: "abc" })
refute res2.key?("errors")
assert_equal "abc", res2["data"]["fooMutation"]["foo"]
end
end
describe "with error limiting" do
describe("disabled") do
let(:args) {
{ max_errors: nil }
}
it "does not limit the number of errors" do
assert_equal(error_messages.length, 4)
assert_equal(error_messages, [
"Nullability mismatch on variable $badInt and argument id (Int / Int!)",
"Type mismatch on variable $badStr and argument id (String! / Int!)",
"Nullability mismatch on variable $badAnimals and argument source ([DairyAnimal]! / [DairyAnimal!]!)",
"List dimension mismatch on variable $deepAnimals and argument source ([[DairyAnimal!]!]! / [DairyAnimal!]!)"
])
end
end
describe("enabled") do
let(:args) {
{ max_errors: 1 }
}
it "does limit the number of errors" do
assert_equal(error_messages.length, 1)
assert_equal(error_messages, [
"Nullability mismatch on variable $badInt and argument id (Int / Int!)"
])
end
end
end
describe "non-null arguments with default values" do
it "doesn't require a value in the query" do
schema_graphql = <<~GRAPHQL
type Query {
songs(sort: SongSort! = {name: asc}): [Song!]!
topSong(input: TopSongInput!): Song
}
type Song {
name: String!
}
input SongSort {
name: SortDirection
}
enum SortDirection {
asc
desc
}
input TopSongInput {
thisYear: Boolean! = true
}
GRAPHQL
schema = GraphQL::Schema.from_definition(
schema_graphql,
default_resolve: {
"Query" => {
"songs" => ->(obj, args, ctx) {
sort = args[:sort]
names = ["asc", nil].include?(sort[:name]) ? ["A", "B"] : ["B", "A"]
names.map { |name| Struct.new(:name).new(name) }
},
"topSong" => ->(obj, args, ctx) {
args[:input][:this_year] ? OpenStruct.new(name: "Hey Ya!") : OpenStruct.new(name: "Here Comes the Sun")
}
}
}
)
result = schema.execute("query($sort: SongSort) { songs(sort: $sort) { name } }", variables: {})
expected_result = {"data" => {"songs" => [{"name" => "A"},{"name" => "B"}]}}
assert_graphql_equal expected_result, result
result = schema.execute("query($sort: SongSort) { songs(sort: $sort) { name } }", variables: { sort: { name: "desc" } })
expected_result = {"data" => {"songs" => [{"name" => "B"},{"name" => "A"}]}}
assert_graphql_equal expected_result, result
result = schema.execute("query($sort: SongSort) { songs(sort: $sort) { name } }", variables: { sort: nil })
expected_result = {"errors"=>[{"message"=>"`null` is not a valid input for `SongSort!`, please provide a value for this argument.", "locations"=>[{"line"=>1, "column"=>26}], "path"=>["songs"]}], "data" => nil}
assert_graphql_equal expected_result, result
result = schema.execute("{ topSong(input: {}) { name } }")
assert_equal "Hey Ya!", result["data"]["topSong"]["name"]
result = schema.execute("{ topSong(input: { thisYear: false }) { name } }")
assert_equal "Here Comes the Sun", result["data"]["topSong"]["name"]
result = schema.execute("{ topSong(input: { thisYear: null }) { name } }")
assert_equal ["Argument 'thisYear' on InputObject 'TopSongInput' has an invalid value (null). Expected type 'Boolean!'."], result["errors"].map { |err| err["message"] }
end
end
end
|