-
Notifications
You must be signed in to change notification settings - Fork 221
/
SchemaValidationRule.scala
799 lines (685 loc) · 27.2 KB
/
SchemaValidationRule.scala
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
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
package sangria.schema
import sangria.ast.{
AstLocation,
Document,
NamedType,
NotNullType,
ObjectTypeDefinition,
ObjectTypeExtensionDefinition,
SourceMapper,
UnionTypeDefinition,
UnionTypeExtensionDefinition
}
import sangria.execution._
import sangria.introspection
import sangria.marshalling.{CoercedScalaResultMarshaller, ToInput}
import sangria.renderer.SchemaRenderer
import sangria.streaming.SubscriptionStream
import sangria.validation._
import scala.collection.immutable.VectorBuilder
trait SchemaValidationRule {
def validate[Ctx, Val](schema: Schema[Ctx, Val]): List[Violation]
}
object SchemaValidationRule {
val empty: List[SchemaValidationRule] = Nil
val defaultFullSchemaTraversalValidationRule = new FullSchemaTraversalValidationRule(
EnumValueReservedNameValidator,
ContainerMembersValidator,
ValidNamesValidator,
IntrospectionNamesValidator,
InputObjectTypeRecursionValidator)
val default: List[SchemaValidationRule] = List(
DefaultValuesValidationRule,
InterfaceImplementationValidationRule,
SubscriptionFieldsValidationRule,
defaultFullSchemaTraversalValidationRule)
def validate[Ctx, Val](
schema: Schema[Ctx, Val],
validationRules: List[SchemaValidationRule]): List[Violation] =
validationRules.flatMap(_.validate(schema))
def validateWithException[Ctx, Val](
schema: Schema[Ctx, Val],
validationRules: List[SchemaValidationRule]): Schema[Ctx, Val] = {
val validationErrors = validate(schema, validationRules)
if (validationErrors.nonEmpty) throw SchemaValidationException(validationErrors.toVector)
else schema
}
}
object DefaultValuesValidationRule extends SchemaValidationRule {
def validate[Ctx, Val](schema: Schema[Ctx, Val]): List[Violation] = {
val coercionHelper = ValueCoercionHelper.default
def validate(prefix: => String, path: List[String], tpe: InputType[_])(
defaultValue: (_, ToInput[_, _])): Vector[Violation] = {
val (default, toInput) = defaultValue.asInstanceOf[(Any, ToInput[Any, Any])]
val (inputValue, iu) = toInput.toInput(default)
coercionHelper.coerceInputValue(
tpe,
path,
inputValue,
None,
None,
CoercedScalaResultMarshaller.default,
CoercedScalaResultMarshaller.default,
isArgument = false,
errorPrefix = prefix)(iu) match {
case Left(violations) => violations
case Right(_) => Vector.empty
}
}
val inputTypeViolations = schema.inputTypes.values.flatMap {
case it: InputObjectType[_] =>
it.fields.flatMap(f =>
f.defaultValue
.map(
validate(
s"Invalid default value of field '${f.name}' in input type '${it.name}'. ",
it.name :: f.name :: Nil,
f.inputValueType))
.getOrElse(Nil))
case _ => Nil
}
val outputTypeViolations = schema.outputTypes.values.flatMap {
case ot: ObjectLikeType[_, _] =>
ot.fields.flatMap(f =>
f.arguments.flatMap(a =>
a.defaultValue
.map(validate(
s"Invalid default value of argument '${a.name}' in field '${f.name}' defined in output type '${ot.name}'. ",
ot.name :: f.name :: ("[" + a.name + "]") :: Nil,
a.inputValueType
))
.getOrElse(Nil)))
case _ => Nil
}
inputTypeViolations.toList ++ outputTypeViolations
}
}
object InterfaceImplementationValidationRule extends SchemaValidationRule {
private def validateObjectType[Ctx, Val](
schema: Schema[Ctx, Val],
objTpe: ObjectType[_, _],
intTpe: InterfaceType[_, _]): Vector[Violation] = {
val objFields: Map[String, Vector[Field[_, _]]] = objTpe.ownFields.groupBy(_.name)
val violations: List[Violation] = intTpe.ownFields.foldLeft(List.empty[Violation]) {
case (acc, intField) =>
objFields.get(intField.name) match {
case None =>
// we allow object type to inherit fields from the interfaces
// without explicitly defining them, but only when it is not
// defined though SDL.
acc
case Some(objField)
if !TypeComparators.isSubType(schema, objField.head.fieldType, intField.fieldType) =>
InvalidImplementationFieldTypeViolation(
intTpe.name,
objTpe.name,
intField.name,
SchemaRenderer.renderTypeName(intField.fieldType),
SchemaRenderer.renderTypeName(objField.head.fieldType),
SchemaElementValidator.sourceMapper(schema),
SchemaElementValidator.location(objField.head) ++ SchemaElementValidator.location(
intField)
) :: acc
case Some(objField) =>
val violationsWithIntArg = intField.arguments.foldLeft(acc) { case (acc, iarg) =>
objField.head.arguments.find(_.name == iarg.name) match {
case None =>
MissingImplementationFieldArgumentViolation(
intTpe.name,
objTpe.name,
intField.name,
iarg.name,
SchemaElementValidator.sourceMapper(schema),
SchemaElementValidator.location(iarg) ++ SchemaElementValidator.location(
objField.head)
) :: acc
case Some(oarg)
if !TypeComparators.isEqualType(iarg.argumentType, oarg.argumentType) =>
InvalidImplementationFieldArgumentTypeViolation(
intTpe.name,
objTpe.name,
intField.name,
iarg.name,
SchemaRenderer.renderTypeName(iarg.argumentType),
SchemaRenderer.renderTypeName(oarg.argumentType),
SchemaElementValidator.sourceMapper(schema),
SchemaElementValidator.location(iarg) ++ SchemaElementValidator.location(oarg)
) :: acc
case _ => acc
}
}
objField.head.arguments.iterator
.filterNot(oa => intField.arguments.exists(_.name == oa.name))
.foldLeft(violationsWithIntArg) { case (acc, oarg) =>
if (oarg.argumentType.isInstanceOf[OptionInputType[_]])
acc
else
ImplementationExtraFieldArgumentNotOptionalViolation(
intTpe.name,
objTpe.name,
intField.name,
oarg.name,
SchemaRenderer.renderTypeName(oarg.argumentType),
SchemaElementValidator.sourceMapper(schema),
SchemaElementValidator.location(oarg) ++ SchemaElementValidator.location(
intField)
) :: acc
}
}
}
violations.toVector
}
def validate[Ctx, Val](schema: Schema[Ctx, Val]): List[Violation] =
schema.possibleTypes.toList.flatMap { case (intName, objTypes) =>
schema.outputTypes(intName) match {
case intTpe: InterfaceType[_, _] => objTypes.flatMap(validateObjectType(schema, _, intTpe))
case _ => Nil
}
}
}
object SubscriptionFieldsValidationRule extends SchemaValidationRule {
def validate[Ctx, Val](schema: Schema[Ctx, Val]): List[Violation] = {
val subsName = schema.subscription.map(_.name)
def subscriptionTag(tag: FieldTag) = tag match {
case SubscriptionField(_) => true
case _ => false
}
val otherViolations = schema.typeList.flatMap {
case obj: ObjectLikeType[_, _] if subsName.isDefined && subsName.get != obj.name =>
obj.uniqueFields.iterator
.filter(_.tags.exists(subscriptionTag))
.map(f => InvalidSubscriptionFieldViolation(obj.name, f.name))
case _ => Nil
}
val subsViolations = schema.subscription.fold(List.empty[Violation]) { subsType =>
val fields = subsType.uniqueFields
val nonSubscription = fields.filter(f => !f.tags.exists(subscriptionTag))
if (nonSubscription.size == fields.size) {
Nil
} else if (nonSubscription.isEmpty) {
if (fields.isEmpty) Nil
else {
val first = fields.head.tags.collectFirst { case SubscriptionField(s) => s }.get
val differentFields = fields.tail.filter(f =>
f.tags.collectFirst {
case SubscriptionField(s)
if !first.supported(s.asInstanceOf[SubscriptionStream[({ type T[X] })#T]]) =>
s
}.nonEmpty)
if (differentFields.nonEmpty)
List(
NotAllSubscriptionFieldsHaveSameStreamViolation(
subsType.name,
differentFields.map(_.name)))
else Nil
}
} else
List(NotAllSubscriptionFieldsViolation(subsType.name, nonSubscription.map(_.name)))
}
subsViolations ++ otherViolations
}
}
object IntrospectionNamesValidator extends SchemaElementValidator {
private val explanation = "The name is reserved for GraphQL introspection API."
private val allowedTypeNames = introspection.IntrospectionTypesByName.keySet
private def isInvalidTypeName(name: String): Boolean =
name.startsWith("__") && !allowedTypeNames.contains(name)
private def isInvalidName(name: String): Boolean =
name.startsWith("__")
override def validateUnionType(schema: Schema[_, _], tpe: UnionType[_]) =
validateType(schema, tpe, "Union")
override def validateEnumType(schema: Schema[_, _], tpe: EnumType[_]) =
validateType(schema, tpe, "Enum")
override def validateInputObjectType(schema: Schema[_, _], tpe: InputObjectType[_]) =
validateType(schema, tpe, "Input")
override def validateObjectType(schema: Schema[_, _], tpe: ObjectType[_, _]) =
validateType(schema, tpe, "Object")
override def validateInterfaceType(schema: Schema[_, _], tpe: InterfaceType[_, _]) =
validateType(schema, tpe, "Interface")
override def validateScalarType(schema: Schema[_, _], tpe: ScalarType[_]) =
validateType(schema, tpe, "Scalar")
def validateType(schema: Schema[_, _], tpe: Type with Named with HasAstInfo, kind: String) =
if (isInvalidTypeName(tpe.name))
Vector(
InvalidTypeNameViolation(kind, tpe.name, explanation, sourceMapper(schema), location(tpe)))
else Vector.empty
override def validateEnumValue(schema: Schema[_, _], tpe: EnumType[_], value: EnumValue[_]) =
if (isInvalidName(value.name))
Vector(
InvalidEnumValueNameViolation(
tpe.name,
value.name,
explanation,
sourceMapper(schema),
location(value)))
else Vector.empty
override def validateField(schema: Schema[_, _], tpe: ObjectLikeType[_, _], field: Field[_, _]) =
if (isInvalidName(field.name))
Vector(
InvalidFieldNameViolation(
tpe.name,
field.name,
explanation,
sourceMapper(schema),
location(field)))
else Vector.empty
override def validateFieldArgument(
schema: Schema[_, _],
tpe: ObjectLikeType[_, _],
field: Field[_, _],
argument: Argument[_]) =
if (isInvalidName(argument.name))
Vector(
InvalidFieldArgumentNameViolation(
tpe.name,
field.name,
argument.name,
explanation,
sourceMapper(schema),
location(argument)))
else Vector.empty
override def validateInputField(
schema: Schema[_, _],
tpe: InputObjectType[_],
field: InputField[_]) =
if (isInvalidName(field.name))
Vector(
InvalidInputFieldNameViolation(
tpe.name,
field.name,
explanation,
sourceMapper(schema),
location(field)))
else Vector.empty
override def validateDirective(schema: Schema[_, _], tpe: Directive) =
if (isInvalidName(tpe.name))
Vector(InvalidDirectiveNameViolation(tpe.name, explanation, None, Nil))
else Vector.empty
override def validateDirectiveArgument(
schema: Schema[_, _],
tpe: Directive,
argument: Argument[_]) =
if (isInvalidName(argument.name))
Vector(
InvalidDirectiveArgumentNameViolation(
tpe.name,
argument.name,
explanation,
sourceMapper(schema),
location(argument)))
else Vector.empty
}
object ValidNamesValidator extends SchemaElementValidator {
private val explanation = s"Valid names must satisfy following regex: /${Named.NameRegexp}/."
override def validateUnionType(schema: Schema[_, _], tpe: UnionType[_]) =
validateType(schema, tpe, "Union")
override def validateEnumType(schema: Schema[_, _], tpe: EnumType[_]) =
validateType(schema, tpe, "Enum")
override def validateInputObjectType(schema: Schema[_, _], tpe: InputObjectType[_]) =
validateType(schema, tpe, "Input")
override def validateObjectType(schema: Schema[_, _], tpe: ObjectType[_, _]) =
validateType(schema, tpe, "Object")
override def validateInterfaceType(schema: Schema[_, _], tpe: InterfaceType[_, _]) =
validateType(schema, tpe, "Interface")
override def validateScalarType(schema: Schema[_, _], tpe: ScalarType[_]) =
validateType(schema, tpe, "Scalar")
def validateType(schema: Schema[_, _], tpe: Type with Named with HasAstInfo, kind: String) =
if (!Named.isValidName(tpe.name))
Vector(
InvalidTypeNameViolation(kind, tpe.name, explanation, sourceMapper(schema), location(tpe)))
else Vector.empty
override def validateEnumValue(schema: Schema[_, _], tpe: EnumType[_], value: EnumValue[_]) =
if (!Named.isValidName(value.name))
Vector(
InvalidEnumValueNameViolation(
tpe.name,
value.name,
explanation,
sourceMapper(schema),
location(value)))
else Vector.empty
override def validateField(schema: Schema[_, _], tpe: ObjectLikeType[_, _], field: Field[_, _]) =
if (!Named.isValidName(field.name))
Vector(
InvalidFieldNameViolation(
tpe.name,
field.name,
explanation,
sourceMapper(schema),
location(field)))
else Vector.empty
override def validateFieldArgument(
schema: Schema[_, _],
tpe: ObjectLikeType[_, _],
field: Field[_, _],
argument: Argument[_]) =
if (!Named.isValidName(argument.name))
Vector(
InvalidFieldArgumentNameViolation(
tpe.name,
field.name,
argument.name,
explanation,
sourceMapper(schema),
location(argument)))
else Vector.empty
override def validateInputField(
schema: Schema[_, _],
tpe: InputObjectType[_],
field: InputField[_]) =
if (!Named.isValidName(field.name))
Vector(
InvalidInputFieldNameViolation(
tpe.name,
field.name,
explanation,
sourceMapper(schema),
location(field)))
else Vector.empty
override def validateDirective(schema: Schema[_, _], tpe: Directive) =
if (!Named.isValidName(tpe.name))
Vector(InvalidDirectiveNameViolation(tpe.name, explanation, None, Nil))
else Vector.empty
override def validateDirectiveArgument(
schema: Schema[_, _],
tpe: Directive,
argument: Argument[_]) =
if (!Named.isValidName(argument.name))
Vector(
InvalidDirectiveArgumentNameViolation(
tpe.name,
argument.name,
explanation,
sourceMapper(schema),
location(argument)))
else Vector.empty
}
object ContainerMembersValidator extends SchemaElementValidator {
override def validateUnionType(schema: Schema[_, _], tpe: UnionType[_]): Vector[Violation] = {
val emptyErrors =
if (tpe.types.isEmpty)
Vector(EmptyUnionMembersViolation(tpe.name, sourceMapper(schema), location(tpe)))
else Vector.empty
val nonUnique =
tpe.types.groupBy(_.name).iterator.collect {
case (memberName, dup) if dup.size > 1 =>
val astMembers = tpe.astNodes.collect {
case astUnion: UnionTypeDefinition => astUnion.types
case astUnion: UnionTypeExtensionDefinition => astUnion.types
}
val locations = astMembers.flatten.filter(_.name == memberName).flatMap(_.location).toList
NonUniqueUnionMembersViolation(tpe.name, memberName, sourceMapper(schema), locations)
}
emptyErrors ++ nonUnique
}
override def validateEnumType(schema: Schema[_, _], tpe: EnumType[_]): Vector[Violation] = {
val emptyErrors =
if (tpe.values.isEmpty)
Vector(EmptyEnumValuesMembersViolation(tpe.name, sourceMapper(schema), location(tpe)))
else Vector.empty
val nonUnique =
tpe.values.groupBy(_.name).iterator.collect {
case (valueName, dup) if dup.size > 1 =>
NonUniqueEnumValuesViolation(
tpe.name,
valueName,
sourceMapper(schema),
dup.flatMap(location))
}
emptyErrors ++ nonUnique
}
override def validateInputObjectType(
schema: Schema[_, _],
tpe: InputObjectType[_]): Vector[Violation] = {
val emptyErrors =
if (tpe.fields.isEmpty)
Vector(EmptyInputFieldsViolation(tpe.name, sourceMapper(schema), location(tpe)))
else Vector.empty
val nonUnique =
tpe.fields.groupBy(_.name).iterator.collect {
case (fieldName, dup) if dup.size > 1 =>
NonUniqueInputFieldsViolation(
tpe.name,
fieldName,
sourceMapper(schema),
dup.flatMap(location))
}
emptyErrors ++ nonUnique
}
override def validateObjectType(
schema: Schema[_, _],
tpe: ObjectType[_, _]): Vector[Violation] = {
val generalErrors = validateObjectLikeType(schema, tpe, "Object")
val nonUnique =
tpe.interfaces.groupBy(_.name).iterator.collect {
case (intName, dup) if dup.size > 1 =>
val astMembers = tpe.astNodes.collect {
case astUnion: ObjectTypeDefinition => astUnion.interfaces
case astUnion: ObjectTypeExtensionDefinition => astUnion.interfaces
}
val locations = astMembers.flatten.filter(_.name == intName).flatMap(_.location).toList
NonUniqueInterfacesViolation(tpe.name, intName, sourceMapper(schema), locations)
}
generalErrors ++ nonUnique
}
override def validateInterfaceType(
schema: Schema[_, _],
tpe: InterfaceType[_, _]): Vector[Violation] =
validateObjectLikeType(schema, tpe, "Interface")
def validateObjectLikeType(
schema: Schema[_, _],
tpe: ObjectLikeType[_, _],
kind: String): Vector[Violation] = {
val emptyErrors =
if (tpe.uniqueFields.isEmpty)
Vector(EmptyFieldsViolation(kind, tpe.name, sourceMapper(schema), location(tpe)))
else Vector.empty
val nonUnique =
tpe.ownFields.groupBy(_.name).iterator.collect {
case (fieldName, dup) if dup.size > 1 =>
NonUniqueFieldsViolation(
kind,
tpe.name,
fieldName,
sourceMapper(schema),
dup.flatMap(location).toList)
}
emptyErrors ++ nonUnique
}
override def validateField(
schema: Schema[_, _],
tpe: ObjectLikeType[_, _],
field: Field[_, _]): Vector[Violation] =
field.arguments
.groupBy(_.name)
.iterator
.collect {
case (argName, dup) if dup.size > 1 =>
NonUniqueFieldArgumentsViolation(
tpe.name,
field.name,
argName,
sourceMapper(schema),
dup.flatMap(location))
}
.toVector
override def validateDirective(schema: Schema[_, _], tpe: Directive): Vector[Violation] =
tpe.arguments
.groupBy(_.name)
.iterator
.collect {
case (argName, dup) if dup.size > 1 =>
NonUniqueDirectiveArgumentsViolation(
tpe.name,
argName,
sourceMapper(schema),
dup.flatMap(location))
}
.toVector
}
object EnumValueReservedNameValidator extends SchemaElementValidator {
private val reservedNames = Set("true", "false", "null")
override def validateEnumValue(
schema: Schema[_, _],
tpe: EnumType[_],
value: EnumValue[_]): Vector[Violation] =
if (reservedNames.contains(value.name))
Vector(
ReservedEnumValueNameViolation(tpe.name, value.name, sourceMapper(schema), location(value)))
else Vector.empty
}
object InputObjectTypeRecursionValidator extends SchemaElementValidator {
override def validateInputObjectType(
schema: Schema[_, _],
tpe: InputObjectType[_]): Vector[Violation] =
containsRecursiveInputObject(tpe.namedType.name, List(), schema, tpe)
private def containsRecursiveInputObject(
rootTypeName: String,
path: List[String],
schema: Schema[_, _],
tpe: InputObjectType[_]): Vector[Violation] = {
val recursiveFields = tpe.fields.filter(childField =>
childField.fieldType.namedType.name == rootTypeName && !childField.fieldType.isOptional && !childField.fieldType.isList)
if (recursiveFields.nonEmpty) {
recursiveFields.iterator
.map(field => InputObjectTypeRecursion(tpe.name, field.name, path, None, Nil))
.toVector
} else {
val childTypesToCheck = tpe.fields.filter(field =>
!field.fieldType.isOptional && !field.fieldType.isList && field.fieldType
.isInstanceOf[InputObjectType[_]])
childTypesToCheck.foldLeft(Vector.empty[Violation]) { case (acc, field) =>
schema.getInputType(NotNullType(NamedType(field.fieldType.namedType.name))) match {
case Some(objectType: InputObjectType[_]) if objectType != tpe =>
val updatedPath = path :+ field.name
acc ++ containsRecursiveInputObject(rootTypeName, updatedPath, schema, objectType)
case _ => acc
}
}
}
}
}
trait SchemaElementValidator {
def validateUnionType(schema: Schema[_, _], tpe: UnionType[_]): Vector[Violation] = Vector.empty
def validateEnumType(schema: Schema[_, _], tpe: EnumType[_]): Vector[Violation] = Vector.empty
def validateEnumValue(
schema: Schema[_, _],
tpe: EnumType[_],
value: EnumValue[_]): Vector[Violation] = Vector.empty
def validateObjectType(schema: Schema[_, _], tpe: ObjectType[_, _]): Vector[Violation] =
Vector.empty
def validateInterfaceType(schema: Schema[_, _], tpe: InterfaceType[_, _]): Vector[Violation] =
Vector.empty
def validateField(
schema: Schema[_, _],
tpe: ObjectLikeType[_, _],
field: Field[_, _]): Vector[Violation] = Vector.empty
def validateFieldArgument(
schema: Schema[_, _],
tpe: ObjectLikeType[_, _],
field: Field[_, _],
argument: Argument[_]): Vector[Violation] = Vector.empty
def validateInputObjectType(schema: Schema[_, _], tpe: InputObjectType[_]): Vector[Violation] =
Vector.empty
def validateInputField(
schema: Schema[_, _],
tpe: InputObjectType[_],
field: InputField[_]): Vector[Violation] = Vector.empty
def validateDirective(schema: Schema[_, _], tpe: Directive): Vector[Violation] = Vector.empty
def validateDirectiveArgument(
schema: Schema[_, _],
tpe: Directive,
argument: Argument[_]): Vector[Violation] = Vector.empty
def validateScalarType(schema: Schema[_, _], tpe: ScalarType[_]): Vector[Violation] = Vector.empty
def sourceMapper(schema: Schema[_, _]): Option[SourceMapper] =
SchemaElementValidator.sourceMapper(schema)
def location(elem: HasAstInfo): List[AstLocation] = SchemaElementValidator.location(elem)
}
object SchemaElementValidator {
def sourceMapper(schema: Schema[_, _]): Option[SourceMapper] =
schema.astNodes.collectFirst { case doc: Document => doc.sourceMapper }.flatten
def location(elem: HasAstInfo): List[AstLocation] =
elem.astNodes.flatMap(_.location).toList
}
class FullSchemaTraversalValidationRule(validators: SchemaElementValidator*)
extends SchemaValidationRule {
private val reservedNames = Set("true", "false", "null")
def validate[Ctx, Val](schema: Schema[Ctx, Val]): List[Violation] = {
val violations = new VectorBuilder[Violation]
def add(vs: Vector[Violation]): Unit =
if (vs.nonEmpty) violations ++= vs
def validate(fn: SchemaElementValidator => Vector[Violation]): Unit =
validators.foreach(v => add(fn(v)))
schema.typeList.foreach {
case tpe: EnumType[_] =>
validate(_.validateEnumType(schema, tpe))
tpe.values.foreach(v => validate(_.validateEnumValue(schema, tpe, v)))
case tpe: ScalarType[_] =>
validate(_.validateScalarType(schema, tpe))
case tpe: UnionType[_] =>
validate(_.validateUnionType(schema, tpe))
case tpe: InputObjectType[_] =>
validate(_.validateInputObjectType(schema, tpe))
tpe.fields.foreach(f => validate(_.validateInputField(schema, tpe, f)))
case tpe: ObjectType[_, _] =>
validate(_.validateObjectType(schema, tpe))
tpe.fields.foreach { f =>
validate(_.validateField(schema, tpe, f))
f.arguments.foreach(a => validate(_.validateFieldArgument(schema, tpe, f, a)))
}
case tpe: InterfaceType[_, _] =>
validate(_.validateInterfaceType(schema, tpe))
tpe.fields.foreach { f =>
validate(_.validateField(schema, tpe, f))
f.arguments.foreach(a => validate(_.validateFieldArgument(schema, tpe, f, a)))
}
case _ => // everything is fine
}
schema.directives.foreach { d =>
validate(_.validateDirective(schema, d))
d.arguments.foreach(a => validate(_.validateDirectiveArgument(schema, d, a)))
}
violations.result().toList
}
def validName(name: String): Boolean = !reservedNames.contains(name)
}
/** Validates uniqueness of directives on types and the schema definition.
*
* It is not fully covered by `UniqueDirectivesPerLocation` since it onl looks at one AST node at a
* time, so it does not cover type + type extension scenario.
*/
class ResolvedDirectiveValidationRule(knownUniqueDirectives: Set[String])
extends SchemaValidationRule {
def validate[Ctx, Val](schema: Schema[Ctx, Val]): List[Violation] = {
val uniqueDirectives =
knownUniqueDirectives ++ schema.directives.filterNot(_.repeatable).map(_.name)
val sourceMapper = SchemaElementValidator.sourceMapper(schema)
val schemaViolations = validateUniqueDirectives(schema, uniqueDirectives, sourceMapper)
val typeViolations =
schema.typeList.collect { case withDirs: HasAstInfo =>
validateUniqueDirectives(withDirs, uniqueDirectives, sourceMapper)
}
schemaViolations.toList ++ typeViolations.flatten
}
private def validateUniqueDirectives(
withDirs: HasAstInfo,
uniqueDirectives: Set[String],
sourceMapper: Option[SourceMapper]) = {
val duplicates = withDirs.astDirectives
.filter(d => uniqueDirectives.contains(d.name))
.groupBy(_.name)
.filter(_._2.size > 1)
.toVector
duplicates.map { case (dirName, dups) =>
DuplicateDirectiveViolation(dirName, sourceMapper, dups.flatMap(_.location).toList)
}
}
}
case class SchemaValidationException(
violations: Vector[Violation],
eh: ExceptionHandler = ExceptionHandler.empty)
extends ExecutionError(
s"Schema does not pass validation. Violations:\n\n${violations.map(_.errorMessage).mkString("\n\n")}",
eh)
with WithViolations
with QueryAnalysisError