forked from graphql-go/graphql
-
Notifications
You must be signed in to change notification settings - Fork 2
/
rules.go
1961 lines (1849 loc) · 55.3 KB
/
rules.go
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
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package graphql
import (
"fmt"
"github.com/graphql-go/graphql/gqlerrors"
"github.com/graphql-go/graphql/language/ast"
"github.com/graphql-go/graphql/language/kinds"
"github.com/graphql-go/graphql/language/printer"
"github.com/graphql-go/graphql/language/visitor"
"sort"
"strings"
)
/**
* SpecifiedRules set includes all validation rules defined by the GraphQL spec.
*/
var SpecifiedRules = []ValidationRuleFn{
ArgumentsOfCorrectTypeRule,
DefaultValuesOfCorrectTypeRule,
FieldsOnCorrectTypeRule,
FragmentsOnCompositeTypesRule,
KnownArgumentNamesRule,
KnownDirectivesRule,
KnownFragmentNamesRule,
KnownTypeNamesRule,
LoneAnonymousOperationRule,
NoFragmentCyclesRule,
NoUndefinedVariablesRule,
NoUnusedFragmentsRule,
NoUnusedVariablesRule,
OverlappingFieldsCanBeMergedRule,
PossibleFragmentSpreadsRule,
ProvidedNonNullArgumentsRule,
ScalarLeafsRule,
UniqueArgumentNamesRule,
UniqueFragmentNamesRule,
UniqueOperationNamesRule,
VariablesAreInputTypesRule,
VariablesInAllowedPositionRule,
}
type ValidationRuleInstance struct {
VisitorOpts *visitor.VisitorOptions
VisitSpreadFragments bool
}
type ValidationRuleFn func(context *ValidationContext) *ValidationRuleInstance
func newValidationRuleError(message string, nodes []ast.Node) (string, error) {
return visitor.ActionNoChange, gqlerrors.NewError(
message,
nodes,
"",
nil,
[]int{},
)
}
/**
* ArgumentsOfCorrectTypeRule
* Argument values of correct type
*
* A GraphQL document is only valid if all field argument literal values are
* of the type expected by their position.
*/
func ArgumentsOfCorrectTypeRule(context *ValidationContext) *ValidationRuleInstance {
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.Argument: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
var action = visitor.ActionNoChange
var result interface{}
if argAST, ok := p.Node.(*ast.Argument); ok {
value := argAST.Value
argDef := context.Argument()
if argDef != nil && !isValidLiteralValue(argDef.Type, value) {
argNameValue := ""
if argAST.Name != nil {
argNameValue = argAST.Name.Value
}
return newValidationRuleError(
fmt.Sprintf(`Argument "%v" expected type "%v" but got: %v.`,
argNameValue, argDef.Type, printer.Print(value)),
[]ast.Node{value},
)
}
}
return action, result
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
/**
* DefaultValuesOfCorrectTypeRule
* Variable default values of correct type
*
* A GraphQL document is only valid if all variable default values are of the
* type expected by their definition.
*/
func DefaultValuesOfCorrectTypeRule(context *ValidationContext) *ValidationRuleInstance {
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.VariableDefinition: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
var action = visitor.ActionNoChange
var result interface{}
if varDefAST, ok := p.Node.(*ast.VariableDefinition); ok {
name := ""
if varDefAST.Variable != nil && varDefAST.Variable.Name != nil {
name = varDefAST.Variable.Name.Value
}
defaultValue := varDefAST.DefaultValue
ttype := context.InputType()
if ttype, ok := ttype.(*NonNull); ok && defaultValue != nil {
return newValidationRuleError(
fmt.Sprintf(`Variable "$%v" of type "%v" is required and will not use the default value. Perhaps you meant to use type "%v".`,
name, ttype, ttype.OfType),
[]ast.Node{defaultValue},
)
}
if ttype != nil && defaultValue != nil && !isValidLiteralValue(ttype, defaultValue) {
return newValidationRuleError(
fmt.Sprintf(`Variable "$%v" of type "%v" has invalid default value: %v.`,
name, ttype, printer.Print(defaultValue)),
[]ast.Node{defaultValue},
)
}
}
return action, result
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
/**
* FieldsOnCorrectTypeRule
* Fields on correct type
*
* A GraphQL document is only valid if all fields selected are defined by the
* parent type, or are an allowed meta field such as __typenamme
*/
func FieldsOnCorrectTypeRule(context *ValidationContext) *ValidationRuleInstance {
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.Field: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
var action = visitor.ActionNoChange
var result interface{}
if node, ok := p.Node.(*ast.Field); ok {
ttype := context.ParentType()
if ttype != nil {
fieldDef := context.FieldDef()
if fieldDef == nil {
nodeName := ""
if node.Name != nil {
nodeName = node.Name.Value
}
return newValidationRuleError(
fmt.Sprintf(`Cannot query field "%v" on "%v".`,
nodeName, ttype.Name()),
[]ast.Node{node},
)
}
}
}
return action, result
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
/**
* FragmentsOnCompositeTypesRule
* Fragments on composite type
*
* Fragments use a type condition to determine if they apply, since fragments
* can only be spread into a composite type (object, interface, or union), the
* type condition must also be a composite type.
*/
func FragmentsOnCompositeTypesRule(context *ValidationContext) *ValidationRuleInstance {
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.InlineFragment: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if node, ok := p.Node.(*ast.InlineFragment); ok {
ttype := context.Type()
if ttype != nil && !IsCompositeType(ttype) {
return newValidationRuleError(
fmt.Sprintf(`Fragment cannot condition on non composite type "%v".`, ttype),
[]ast.Node{node.TypeCondition},
)
}
}
return visitor.ActionNoChange, nil
},
},
kinds.FragmentDefinition: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if node, ok := p.Node.(*ast.FragmentDefinition); ok {
ttype := context.Type()
if ttype != nil && !IsCompositeType(ttype) {
nodeName := ""
if node.Name != nil {
nodeName = node.Name.Value
}
return newValidationRuleError(
fmt.Sprintf(`Fragment "%v" cannot condition on non composite type "%v".`, nodeName, printer.Print(node.TypeCondition)),
[]ast.Node{node.TypeCondition},
)
}
}
return visitor.ActionNoChange, nil
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
/**
* KnownArgumentNamesRule
* Known argument names
*
* A GraphQL field is only valid if all supplied arguments are defined by
* that field.
*/
func KnownArgumentNamesRule(context *ValidationContext) *ValidationRuleInstance {
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.Argument: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
var action = visitor.ActionNoChange
var result interface{}
if node, ok := p.Node.(*ast.Argument); ok {
var argumentOf ast.Node
if len(p.Ancestors) > 0 {
argumentOf = p.Ancestors[len(p.Ancestors)-1]
}
if argumentOf == nil {
return action, result
}
if argumentOf.GetKind() == "Field" {
fieldDef := context.FieldDef()
if fieldDef == nil {
return action, result
}
nodeName := ""
if node.Name != nil {
nodeName = node.Name.Value
}
var fieldArgDef *Argument
for _, arg := range fieldDef.Args {
if arg.Name() == nodeName {
fieldArgDef = arg
}
}
if fieldArgDef == nil {
parentType := context.ParentType()
parentTypeName := ""
if parentType != nil {
parentTypeName = parentType.Name()
}
return newValidationRuleError(
fmt.Sprintf(`Unknown argument "%v" on field "%v" of type "%v".`, nodeName, fieldDef.Name, parentTypeName),
[]ast.Node{node},
)
}
} else if argumentOf.GetKind() == "Directive" {
directive := context.Directive()
if directive == nil {
return action, result
}
nodeName := ""
if node.Name != nil {
nodeName = node.Name.Value
}
var directiveArgDef *Argument
for _, arg := range directive.Args {
if arg.Name() == nodeName {
directiveArgDef = arg
}
}
if directiveArgDef == nil {
return newValidationRuleError(
fmt.Sprintf(`Unknown argument "%v" on directive "@%v".`, nodeName, directive.Name),
[]ast.Node{node},
)
}
}
}
return action, result
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
/**
* Known directives
*
* A GraphQL document is only valid if all `@directives` are known by the
* schema and legally positioned.
*/
func KnownDirectivesRule(context *ValidationContext) *ValidationRuleInstance {
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.Directive: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
var action = visitor.ActionNoChange
var result interface{}
if node, ok := p.Node.(*ast.Directive); ok {
nodeName := ""
if node.Name != nil {
nodeName = node.Name.Value
}
var directiveDef *Directive
for _, def := range context.Schema().Directives() {
if def.Name == nodeName {
directiveDef = def
}
}
if directiveDef == nil {
return newValidationRuleError(
fmt.Sprintf(`Unknown directive "%v".`, nodeName),
[]ast.Node{node},
)
}
var appliedTo ast.Node
if len(p.Ancestors) > 0 {
appliedTo = p.Ancestors[len(p.Ancestors)-1]
}
if appliedTo == nil {
return action, result
}
if appliedTo.GetKind() == kinds.OperationDefinition && directiveDef.OnOperation == false {
return newValidationRuleError(
fmt.Sprintf(`Directive "%v" may not be used on "%v".`, nodeName, "operation"),
[]ast.Node{node},
)
}
if appliedTo.GetKind() == kinds.Field && directiveDef.OnField == false {
return newValidationRuleError(
fmt.Sprintf(`Directive "%v" may not be used on "%v".`, nodeName, "field"),
[]ast.Node{node},
)
}
if (appliedTo.GetKind() == kinds.FragmentSpread ||
appliedTo.GetKind() == kinds.InlineFragment ||
appliedTo.GetKind() == kinds.FragmentDefinition) && directiveDef.OnFragment == false {
return newValidationRuleError(
fmt.Sprintf(`Directive "%v" may not be used on "%v".`, nodeName, "fragment"),
[]ast.Node{node},
)
}
}
return action, result
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
/**
* KnownFragmentNamesRule
* Known fragment names
*
* A GraphQL document is only valid if all `...Fragment` fragment spreads refer
* to fragments defined in the same document.
*/
func KnownFragmentNamesRule(context *ValidationContext) *ValidationRuleInstance {
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.FragmentSpread: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
var action = visitor.ActionNoChange
var result interface{}
if node, ok := p.Node.(*ast.FragmentSpread); ok {
fragmentName := ""
if node.Name != nil {
fragmentName = node.Name.Value
}
fragment := context.Fragment(fragmentName)
if fragment == nil {
return newValidationRuleError(
fmt.Sprintf(`Unknown fragment "%v".`, fragmentName),
[]ast.Node{node.Name},
)
}
}
return action, result
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
/**
* KnownTypeNamesRule
* Known type names
*
* A GraphQL document is only valid if referenced types (specifically
* variable definitions and fragment conditions) are defined by the type schema.
*/
func KnownTypeNamesRule(context *ValidationContext) *ValidationRuleInstance {
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.Named: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if node, ok := p.Node.(*ast.Named); ok {
typeNameValue := ""
typeName := node.Name
if typeName != nil {
typeNameValue = typeName.Value
}
ttype := context.Schema().Type(typeNameValue)
if ttype == nil {
return newValidationRuleError(
fmt.Sprintf(`Unknown type "%v".`, typeNameValue),
[]ast.Node{node},
)
}
}
return visitor.ActionNoChange, nil
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
/**
* LoneAnonymousOperationRule
* Lone anonymous operation
*
* A GraphQL document is only valid if when it contains an anonymous operation
* (the query short-hand) that it contains only that one operation definition.
*/
func LoneAnonymousOperationRule(context *ValidationContext) *ValidationRuleInstance {
var operationCount = 0
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.Document: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if node, ok := p.Node.(*ast.Document); ok {
operationCount = 0
for _, definition := range node.Definitions {
if definition.GetKind() == kinds.OperationDefinition {
operationCount = operationCount + 1
}
}
}
return visitor.ActionNoChange, nil
},
},
kinds.OperationDefinition: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if node, ok := p.Node.(*ast.OperationDefinition); ok {
if node.Name == nil && operationCount > 1 {
return newValidationRuleError(
`This anonymous operation must be the only defined operation.`,
[]ast.Node{node},
)
}
}
return visitor.ActionNoChange, nil
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
type nodeSet struct {
set map[ast.Node]bool
}
func newNodeSet() *nodeSet {
return &nodeSet{
set: map[ast.Node]bool{},
}
}
func (set *nodeSet) Has(node ast.Node) bool {
_, ok := set.set[node]
return ok
}
func (set *nodeSet) Add(node ast.Node) bool {
if set.Has(node) {
return false
}
set.set[node] = true
return true
}
/**
* NoFragmentCyclesRule
*/
func NoFragmentCyclesRule(context *ValidationContext) *ValidationRuleInstance {
// Gather all the fragment spreads ASTs for each fragment definition.
// Importantly this does not include inline fragments.
definitions := context.Document().Definitions
spreadsInFragment := map[string][]*ast.FragmentSpread{}
for _, node := range definitions {
if node.GetKind() == kinds.FragmentDefinition {
if node, ok := node.(*ast.FragmentDefinition); ok && node != nil {
nodeName := ""
if node.Name != nil {
nodeName = node.Name.Value
}
spreadsInFragment[nodeName] = gatherSpreads(node)
}
}
}
// Tracks spreads known to lead to cycles to ensure that cycles are not
// redundantly reported.
knownToLeadToCycle := newNodeSet()
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.FragmentDefinition: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if node, ok := p.Node.(*ast.FragmentDefinition); ok && node != nil {
errors := []error{}
spreadPath := []*ast.FragmentSpread{}
initialName := ""
if node.Name != nil {
initialName = node.Name.Value
}
var detectCycleRecursive func(fragmentName string)
detectCycleRecursive = func(fragmentName string) {
spreadNodes, _ := spreadsInFragment[fragmentName]
for _, spreadNode := range spreadNodes {
if knownToLeadToCycle.Has(spreadNode) {
continue
}
spreadNodeName := ""
if spreadNode.Name != nil {
spreadNodeName = spreadNode.Name.Value
}
if spreadNodeName == initialName {
cyclePath := []ast.Node{}
for _, path := range spreadPath {
cyclePath = append(cyclePath, path)
}
cyclePath = append(cyclePath, spreadNode)
for _, spread := range cyclePath {
knownToLeadToCycle.Add(spread)
}
via := ""
spreadNames := []string{}
for _, s := range spreadPath {
if s.Name != nil {
spreadNames = append(spreadNames, s.Name.Value)
}
}
if len(spreadNames) > 0 {
via = " via " + strings.Join(spreadNames, ", ")
}
_, err := newValidationRuleError(
fmt.Sprintf(`Cannot spread fragment "%v" within itself%v.`, initialName, via),
cyclePath,
)
errors = append(errors, err)
continue
}
spreadPathHasCurrentNode := false
for _, spread := range spreadPath {
if spread == spreadNode {
spreadPathHasCurrentNode = true
}
}
if spreadPathHasCurrentNode {
continue
}
spreadPath = append(spreadPath, spreadNode)
detectCycleRecursive(spreadNodeName)
_, spreadPath = spreadPath[len(spreadPath)-1], spreadPath[:len(spreadPath)-1]
}
}
detectCycleRecursive(initialName)
if len(errors) > 0 {
return visitor.ActionNoChange, errors
}
}
return visitor.ActionNoChange, nil
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
/**
* NoUndefinedVariables
* No undefined variables
*
* A GraphQL operation is only valid if all variables encountered, both directly
* and via fragment spreads, are defined by that operation.
*/
func NoUndefinedVariablesRule(context *ValidationContext) *ValidationRuleInstance {
var operation *ast.OperationDefinition
var visitedFragmentNames = map[string]bool{}
var definedVariableNames = map[string]bool{}
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.OperationDefinition: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if node, ok := p.Node.(*ast.OperationDefinition); ok && node != nil {
operation = node
visitedFragmentNames = map[string]bool{}
definedVariableNames = map[string]bool{}
}
return visitor.ActionNoChange, nil
},
},
kinds.VariableDefinition: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if node, ok := p.Node.(*ast.VariableDefinition); ok && node != nil {
variableName := ""
if node.Variable != nil && node.Variable.Name != nil {
variableName = node.Variable.Name.Value
}
definedVariableNames[variableName] = true
}
return visitor.ActionNoChange, nil
},
},
kinds.Variable: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if variable, ok := p.Node.(*ast.Variable); ok && variable != nil {
variableName := ""
if variable.Name != nil {
variableName = variable.Name.Value
}
if val, _ := definedVariableNames[variableName]; !val {
withinFragment := false
for _, node := range p.Ancestors {
if node.GetKind() == kinds.FragmentDefinition {
withinFragment = true
break
}
}
if withinFragment == true && operation != nil && operation.Name != nil {
return newValidationRuleError(
fmt.Sprintf(`Variable "$%v" is not defined by operation "%v".`, variableName, operation.Name.Value),
[]ast.Node{variable, operation},
)
}
return newValidationRuleError(
fmt.Sprintf(`Variable "$%v" is not defined.`, variableName),
[]ast.Node{variable},
)
}
}
return visitor.ActionNoChange, nil
},
},
kinds.FragmentSpread: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if node, ok := p.Node.(*ast.FragmentSpread); ok && node != nil {
// Only visit fragments of a particular name once per operation
fragmentName := ""
if node.Name != nil {
fragmentName = node.Name.Value
}
if val, ok := visitedFragmentNames[fragmentName]; ok && val == true {
return visitor.ActionSkip, nil
}
visitedFragmentNames[fragmentName] = true
}
return visitor.ActionNoChange, nil
},
},
},
}
return &ValidationRuleInstance{
VisitSpreadFragments: true,
VisitorOpts: visitorOpts,
}
}
/**
* NoUnusedFragmentsRule
* No unused fragments
*
* A GraphQL document is only valid if all fragment definitions are spread
* within operations, or spread within other fragments spread within operations.
*/
func NoUnusedFragmentsRule(context *ValidationContext) *ValidationRuleInstance {
var fragmentDefs = []*ast.FragmentDefinition{}
var spreadsWithinOperation = []map[string]bool{}
var fragAdjacencies = map[string]map[string]bool{}
var spreadNames = map[string]bool{}
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.OperationDefinition: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if node, ok := p.Node.(*ast.OperationDefinition); ok && node != nil {
spreadNames = map[string]bool{}
spreadsWithinOperation = append(spreadsWithinOperation, spreadNames)
}
return visitor.ActionNoChange, nil
},
},
kinds.FragmentDefinition: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if def, ok := p.Node.(*ast.FragmentDefinition); ok && def != nil {
defName := ""
if def.Name != nil {
defName = def.Name.Value
}
fragmentDefs = append(fragmentDefs, def)
spreadNames = map[string]bool{}
fragAdjacencies[defName] = spreadNames
}
return visitor.ActionNoChange, nil
},
},
kinds.FragmentSpread: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if spread, ok := p.Node.(*ast.FragmentSpread); ok && spread != nil {
spreadName := ""
if spread.Name != nil {
spreadName = spread.Name.Value
}
spreadNames[spreadName] = true
}
return visitor.ActionNoChange, nil
},
},
kinds.Document: visitor.NamedVisitFuncs{
Leave: func(p visitor.VisitFuncParams) (string, interface{}) {
fragmentNameUsed := map[string]interface{}{}
var reduceSpreadFragments func(spreads map[string]bool)
reduceSpreadFragments = func(spreads map[string]bool) {
for fragName, _ := range spreads {
if isFragNameUsed, _ := fragmentNameUsed[fragName]; isFragNameUsed != true {
fragmentNameUsed[fragName] = true
if adjacencies, ok := fragAdjacencies[fragName]; ok {
reduceSpreadFragments(adjacencies)
}
}
}
}
for _, spreadWithinOperation := range spreadsWithinOperation {
reduceSpreadFragments(spreadWithinOperation)
}
errors := []error{}
for _, def := range fragmentDefs {
defName := ""
if def.Name != nil {
defName = def.Name.Value
}
isFragNameUsed, ok := fragmentNameUsed[defName]
if !ok || isFragNameUsed != true {
_, err := newValidationRuleError(
fmt.Sprintf(`Fragment "%v" is never used.`, defName),
[]ast.Node{def},
)
errors = append(errors, err)
}
}
if len(errors) > 0 {
return visitor.ActionNoChange, errors
}
return visitor.ActionNoChange, nil
},
},
},
}
return &ValidationRuleInstance{
VisitorOpts: visitorOpts,
}
}
/**
* NoUnusedVariablesRule
* No unused variables
*
* A GraphQL operation is only valid if all variables defined by an operation
* are used, either directly or within a spread fragment.
*/
func NoUnusedVariablesRule(context *ValidationContext) *ValidationRuleInstance {
var visitedFragmentNames = map[string]bool{}
var variableDefs = []*ast.VariableDefinition{}
var variableNameUsed = map[string]bool{}
visitorOpts := &visitor.VisitorOptions{
KindFuncMap: map[string]visitor.NamedVisitFuncs{
kinds.OperationDefinition: visitor.NamedVisitFuncs{
Enter: func(p visitor.VisitFuncParams) (string, interface{}) {
visitedFragmentNames = map[string]bool{}
variableDefs = []*ast.VariableDefinition{}
variableNameUsed = map[string]bool{}
return visitor.ActionNoChange, nil
},
Leave: func(p visitor.VisitFuncParams) (string, interface{}) {
errors := []error{}
for _, def := range variableDefs {
variableName := ""
if def.Variable != nil && def.Variable.Name != nil {
variableName = def.Variable.Name.Value
}
if isVariableNameUsed, _ := variableNameUsed[variableName]; isVariableNameUsed != true {
_, err := newValidationRuleError(
fmt.Sprintf(`Variable "$%v" is never used.`, variableName),
[]ast.Node{def},
)
errors = append(errors, err)
}
}
if len(errors) > 0 {
return visitor.ActionNoChange, errors
}
return visitor.ActionNoChange, nil
},
},
kinds.VariableDefinition: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if def, ok := p.Node.(*ast.VariableDefinition); ok && def != nil {
variableDefs = append(variableDefs, def)
}
// Do not visit deeper, or else the defined variable name will be visited.
return visitor.ActionSkip, nil
},
},
kinds.Variable: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if variable, ok := p.Node.(*ast.Variable); ok && variable != nil {
if variable.Name != nil {
variableNameUsed[variable.Name.Value] = true
}
}
return visitor.ActionNoChange, nil
},
},
kinds.FragmentSpread: visitor.NamedVisitFuncs{
Kind: func(p visitor.VisitFuncParams) (string, interface{}) {
if spreadAST, ok := p.Node.(*ast.FragmentSpread); ok && spreadAST != nil {
// Only visit fragments of a particular name once per operation
spreadName := ""
if spreadAST.Name != nil {
spreadName = spreadAST.Name.Value
}
if hasVisitedFragmentNames, _ := visitedFragmentNames[spreadName]; hasVisitedFragmentNames == true {
return visitor.ActionSkip, nil
}
visitedFragmentNames[spreadName] = true
}
return visitor.ActionNoChange, nil
},
},
},
}
return &ValidationRuleInstance{
// Visit FragmentDefinition after visiting FragmentSpread
VisitSpreadFragments: true,
VisitorOpts: visitorOpts,
}
}
type fieldDefPair struct {
Field *ast.Field
FieldDef *FieldDefinition
}
func collectFieldASTsAndDefs(context *ValidationContext, parentType Named, selectionSet *ast.SelectionSet, visitedFragmentNames map[string]bool, astAndDefs map[string][]*fieldDefPair) map[string][]*fieldDefPair {
if astAndDefs == nil {
astAndDefs = map[string][]*fieldDefPair{}
}
if visitedFragmentNames == nil {
visitedFragmentNames = map[string]bool{}
}
if selectionSet == nil {
return astAndDefs
}
for _, selection := range selectionSet.Selections {
switch selection := selection.(type) {
case *ast.Field:
fieldName := ""
if selection.Name != nil {
fieldName = selection.Name.Value
}
var fieldDef *FieldDefinition
if parentType, ok := parentType.(*Object); ok {
fieldDef, _ = parentType.Fields()[fieldName]
}
if parentType, ok := parentType.(*Interface); ok {
fieldDef, _ = parentType.Fields()[fieldName]
}
responseName := fieldName
if selection.Alias != nil {
responseName = selection.Alias.Value
}
_, ok := astAndDefs[responseName]
if !ok {
astAndDefs[responseName] = []*fieldDefPair{}
}
astAndDefs[responseName] = append(astAndDefs[responseName], &fieldDefPair{
Field: selection,
FieldDef: fieldDef,
})
case *ast.InlineFragment:
parentType, _ := typeFromAST(*context.Schema(), selection.TypeCondition)
astAndDefs = collectFieldASTsAndDefs(
context,
parentType,
selection.SelectionSet,
visitedFragmentNames,
astAndDefs,
)
case *ast.FragmentSpread:
fragName := ""
if selection.Name != nil {
fragName = selection.Name.Value
}
if _, ok := visitedFragmentNames[fragName]; ok {
continue
}
visitedFragmentNames[fragName] = true
fragment := context.Fragment(fragName)
if fragment == nil {
continue
}
parentType, _ := typeFromAST(*context.Schema(), fragment.TypeCondition)
astAndDefs = collectFieldASTsAndDefs(
context,
parentType,
fragment.SelectionSet,
visitedFragmentNames,
astAndDefs,
)
}
}
return astAndDefs
}
/**
* pairSet A way to keep track of pairs of things when the ordering of the pair does
* not matter. We do this by maintaining a sort of double adjacency sets.
*/
type pairSet struct {
data map[ast.Node]*nodeSet
}
func newPairSet() *pairSet {
return &pairSet{
data: map[ast.Node]*nodeSet{},
}
}
func (pair *pairSet) Has(a ast.Node, b ast.Node) bool {