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
|
# frozen_string_literal: true
require "spec_helper"
describe "GraphQL::Directive" do
let(:variables) { {"t" => true, "f" => false} }
let(:result) { Dummy::Schema.execute(query_string, variables: variables) }
describe "on fields" do
let(:query_string) { %|query directives($t: Boolean!, $f: Boolean!) {
cheese(id: 1) {
# plain fields:
skipFlavor: flavor @skip(if: true)
dontSkipFlavor: flavor @skip(if: false)
dontSkipDontIncludeFlavor: flavor @skip(if: false), @include(if: false)
skipAndInclude: flavor @skip(if: true), @include(if: true)
includeFlavor: flavor @include(if: $t)
dontIncludeFlavor: flavor @include(if: $f)
# fields in fragments
... includeIdField
... dontIncludeIdField
... skipIdField
... dontSkipIdField
}
}
fragment includeIdField on Cheese { includeId: id @include(if: true) }
fragment dontIncludeIdField on Cheese { dontIncludeId: id @include(if: false) }
fragment skipIdField on Cheese { skipId: id @skip(if: true) }
fragment dontSkipIdField on Cheese { dontSkipId: id @skip(if: false) }
|
}
describe "child fields" do
let(:query_string) { <<-GRAPHQL
{
__type(name: """
Cheese
""") {
fields { name }
fields @skip(if: true) { isDeprecated }
}
}
GRAPHQL
}
it "skips child fields too" do
first_field = result["data"]["__type"]["fields"].first
assert first_field.key?("name")
assert !first_field.key?("isDeprecated")
end
end
describe "when directive uses argument with default value" do
describe "with false" do
let(:query_string) { <<-GRAPHQL
query($f: Boolean = false) {
cheese(id: 1) {
dontIncludeFlavor: flavor @include(if: $f)
dontSkipFlavor: flavor @skip(if: $f)
}
}
GRAPHQL
}
it "is not included" do
assert !result["data"]["cheese"].key?("dontIncludeFlavor")
end
it "is not skipped" do
assert result["data"]["cheese"].key?("dontSkipFlavor")
end
end
describe "with true" do
let(:query_string) { <<-GRAPHQL
query($t: Boolean = true) {
cheese(id: 1) {
includeFlavor: flavor @include(if: $t)
skipFlavor: flavor @skip(if: $t)
}
}
GRAPHQL
}
it "is included" do
assert result["data"]["cheese"].key?("includeFlavor")
end
it "is skipped" do
assert !result["data"]["cheese"].key?("skipFlavor")
end
end
end
it "intercepts fields" do
expected = { "data" =>{
"cheese" => {
"dontSkipFlavor" => "Brie",
"includeFlavor" => "Brie",
"includeId" => 1,
"dontSkipId" => 1,
},
}}
assert_equal(expected, result)
end
end
describe "on fragments spreads and inline fragments" do
let(:query_string) { %|query directives {
cheese(id: 1) {
... skipFlavorField @skip(if: true)
... dontSkipFlavorField @skip(if: false)
... includeFlavorField @include(if: true)
... dontIncludeFlavorField @include(if: false)
... on Cheese @skip(if: true) { skipInlineId: id }
... on Cheese @skip(if: false) { dontSkipInlineId: id }
... on Cheese @include(if: true) { includeInlineId: id }
... on Cheese @include(if: false) { dontIncludeInlineId: id }
... @skip(if: true) { skipNoType: id }
... @skip(if: false) { dontSkipNoType: id }
}
}
fragment includeFlavorField on Cheese { includeFlavor: flavor }
fragment dontIncludeFlavorField on Cheese { dontIncludeFlavor: flavor }
fragment skipFlavorField on Cheese { skipFlavor: flavor }
fragment dontSkipFlavorField on Cheese { dontSkipFlavor: flavor }
|}
it "intercepts fragment spreads" do
expected = { "data" => {
"cheese" => {
"dontSkipFlavor" => "Brie",
"includeFlavor" => "Brie",
"dontSkipInlineId" => 1,
"includeInlineId" => 1,
"dontSkipNoType" => 1,
},
}}
assert_equal(expected, result)
end
end
describe "merging @skip and @include" do
let(:field_included?) { r = result["data"]["cheese"]; r.has_key?('flavor') && r.has_key?('withVariables') }
let(:skip?) { false }
let(:include?) { true }
let(:variables) { {"skip" => skip?, "include" => include?} }
let(:query_string) {"
query getCheese ($include: Boolean!, $skip: Boolean!) {
cheese(id: 1) {
flavor @include(if: #{include?}) @skip(if: #{skip?}),
withVariables: flavor @include(if: $include) @skip(if: $skip)
}
}
"}
# behavior as defined in
# https://github.com/facebook/graphql/blob/master/spec/Section%203%20--%20Type%20System.md#include
describe "when @skip=false and @include=true" do
let(:skip?) { false }
let(:include?) { true }
it "is included" do assert field_included? end
end
describe "when @skip=false and @include=false" do
let(:skip?) { false }
let(:include?) { false }
it "is not included" do assert !field_included? end
end
describe "when @skip=true and @include=true" do
let(:skip?) { true }
let(:include?) { true }
it "is not included" do assert !field_included? end
end
describe "when @skip=true and @include=false" do
let(:skip?) { true }
let(:include?) { false }
it "is not included" do assert !field_included? end
end
describe "when evaluating skip on query selection and fragment" do
describe "with @skip" do
let(:query_string) {"
query getCheese ($skip: Boolean!) {
cheese(id: 1) {
flavor,
withVariables: flavor,
...F0
}
}
fragment F0 on Cheese {
flavor @skip(if: #{skip?})
withVariables: flavor @skip(if: $skip)
}
"}
describe "and @skip=false" do
let(:skip?) { false }
it "is included" do assert field_included? end
end
describe "and @skip=true" do
let(:skip?) { true }
it "is included" do assert field_included? end
end
end
end
describe "when evaluating conflicting @skip and @include on query selection and fragment" do
let(:query_string) {"
query getCheese ($include: Boolean!, $skip: Boolean!) {
cheese(id: 1) {
... on Cheese @include(if: #{include?}) {
flavor
}
withVariables: flavor @include(if: $include),
...F0
}
}
fragment F0 on Cheese {
flavor @skip(if: #{skip?}),
withVariables: flavor @skip(if: $skip)
}
"}
describe "when @skip=false and @include=true" do
let(:skip?) { false }
let(:include?) { true }
it "is included" do assert field_included? end
end
describe "when @skip=false and @include=false" do
let(:skip?) { false }
let(:include?) { false }
it "is included" do assert field_included? end
end
describe "when @skip=true and @include=true" do
let(:skip?) { true }
let(:include?) { true }
it "is included" do assert field_included? end
end
describe "when @skip=true and @include=false" do
let(:skip?) { true }
let(:include?) { false }
it "is not included" do
assert !field_included?
end
end
end
describe "when handling multiple fields at the same level" do
describe "when at least one occurrence would be included" do
let(:query_string) {"
query getCheese ($include: Boolean!, $skip: Boolean!) {
cheese(id: 1) {
... on Cheese {
flavor
}
flavor @include(if: #{include?}),
flavor @skip(if: #{skip?}),
withVariables: flavor,
withVariables: flavor @include(if: $include),
withVariables: flavor @skip(if: $skip)
}
}
"}
let(:skip?) { true }
let(:include?) { false }
it "is included" do assert field_included? end
end
describe "when no occurrence would be included" do
let(:query_string) {"
query getCheese ($include: Boolean!, $skip: Boolean!) {
cheese(id: 1) {
flavor @include(if: #{include?}),
flavor @skip(if: #{skip?}),
withVariables: flavor @include(if: $include),
withVariables: flavor @skip(if: $skip)
}
}
"}
let(:skip?) { true }
let(:include?) { false }
it "is not included" do assert !field_included? end
end
end
end
end
|
