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
|
# frozen_string_literal: true
require "spec_helper"
describe GraphQL::Language::SanitizedPrinter do
module SanitizeTest
class Color < GraphQL::Schema::Enum
value "RED"
value "BLUE"
end
class Url < GraphQL::Schema::Scalar
end
class SimpleInput < GraphQL::Schema::InputObject
argument :string, String
end
class ExampleInput < GraphQL::Schema::InputObject
argument :string, String
argument :id, ID
argument :int, Int
argument :float, Float
argument :enum, Color
argument :input_object, ExampleInput, required: false
argument :url, Url
end
class Query < GraphQL::Schema::Object
field :inputs, String, null: false do
argument :string, String
argument :id, ID
argument :int, Int
argument :float, Float
argument :enum, Color
argument :input_object, ExampleInput
argument :url, Url
end
field :nested_array_inputs, String, null: false do
argument :inputs, [SimpleInput]
end
field :colors, String, null: false do
argument :colors, [Color]
end
field :strings, String, null: false do
argument :strings, [String]
end
field :custom_scalar, String, null: false do
argument :scalar, GraphQL::Types::JSON
end
end
class Schema < GraphQL::Schema
query(Query)
end
class CustomSanitizedPrinter < GraphQL::Language::SanitizedPrinter
def redact_argument_value?(argument, value)
true
end
def redacted_argument_value(argument)
"<#{argument.graphql_name}-redacted>"
end
end
class CustomSanitizedPrinterSchema < GraphQL::Schema
query(Query)
sanitized_printer(CustomSanitizedPrinter)
end
end
def sanitize_string(query_string, inline_variables: true, **options)
query = GraphQL::Query.new(
SanitizeTest::Schema,
query_string,
**options
)
query.sanitized_query_string(inline_variables: inline_variables)
end
it "replaces strings with redacted" do
query_str = '
{
inputs(
string: "string",
id: "id",
int: 1,
float: 2.0,
url: "http://graphqliscool.com",
enum: RED
inputObject: {
string: "string"
id: "id"
int: 1
float: 2.0
url: "http://graphqliscool.com"
enum: RED
}
)
}
'
expected_query_string = 'query {
inputs(string: "<REDACTED>", id: "id", int: 1, float: 2.0, url: "<REDACTED>", enum: RED, inputObject: {string: "<REDACTED>", id: "id", int: 1, float: 2.0, url: "<REDACTED>", enum: RED})
}'
assert_equal expected_query_string, sanitize_string(query_str)
end
it "inlines variables AND redacts their values" do
query_str = '
query($string1: String!, $string2: String = "str2", $inputObject: ExampleInput!) {
inputs(
string: $string1,
id: "id1",
int: 1,
float: 1.0,
url: "http://graphqliscool.com",
enum: RED
inputObject: {
string: $string2
id: "id2"
int: 2
float: 2.0
url: "http://graphqliscool.com"
enum: RED
inputObject: $inputObject
}
)
}
'
variables = {
"string1" => "str1",
"inputObject" => {
"string" => "str3",
"id" => "id3",
"int" => 3,
"float" => 3.3,
"url" => "three.com",
"enum" => "BLUE"
}
}
expected_query_string = 'query {
inputs(' +
'string: "<REDACTED>", id: "id1", int: 1, float: 1.0, url: "<REDACTED>", enum: RED, inputObject: {' +
'string: "<REDACTED>", id: "id2", int: 2, float: 2.0, url: "<REDACTED>", enum: RED, inputObject: {' +
'string: "<REDACTED>", id: "id3", int: 3, float: 3.3, url: "<REDACTED>", enum: BLUE}})
}'
assert_equal expected_query_string, sanitize_string(query_str, variables: variables)
end
it "doesn't inline variables when inline_variables is false" do
query_str = '
query($string1: String!, $string2: String = "str2", $inputObject: ExampleInput!, $strings: [String!]!) {
inputs(
string: $string1,
id: "id1",
int: 1,
float: 1.0,
url: "http://graphqliscool.com",
enum: RED
inputObject: {
string: $string2
id: "id2"
int: 2
float: 2.0
url: "http://graphqliscool.com"
enum: RED
inputObject: $inputObject
}
)
strings(strings: $strings)
}
'
variables = {
"string1" => "str1",
"strings" => ["str1", "str2"],
"inputObject" => {
"string" => "str3",
"id" => "id3",
"int" => 3,
"float" => 3.3,
"url" => "three.com",
"enum" => "BLUE"
}
}
expected_query_string = 'query($string1: String!, $string2: String = "str2", $inputObject: ExampleInput!, $strings: [String!]!) {
inputs(' +
'string: $string1, id: "id1", int: 1, float: 1.0, url: "<REDACTED>", enum: RED, inputObject: {' +
'string: $string2, id: "id2", int: 2, float: 2.0, url: "<REDACTED>", enum: RED, inputObject: $inputObject})
strings(strings: $strings)
}'
assert_equal expected_query_string, sanitize_string(query_str, variables: variables, inline_variables: false)
end
it "redacts from lists" do
query_str_1 = '{ strings(strings: ["s1", "s2"]) }'
query_str_2 = 'query($strings: [String!]!) { strings(strings: $strings) }'
query_str_3 = 'query($string1: String!, $string2: String!) { strings(strings: [$string1, $string2]) }'
expected_query_string = 'query {
strings(strings: ["<REDACTED>", "<REDACTED>"])
}'
assert_equal expected_query_string, sanitize_string(query_str_1)
assert_equal expected_query_string, sanitize_string(query_str_2, variables: { "strings" => ["s1", "s2"] })
assert_equal expected_query_string, sanitize_string(query_str_3, variables: { "string1" => "s1", "string2" => "s2" })
end
it "redacts from coerced lists" do
query_str = '
query {
strings(strings: "s1")
nestedArrayInputs(inputs: {string: "s2"})
}
'
expected_query_string = 'query {
strings(strings: ["<REDACTED>"])
nestedArrayInputs(inputs: [{string: "<REDACTED>"}])
}'
assert_equal expected_query_string, sanitize_string(query_str)
end
it "doesn't redact enums" do
query_str_1 = '{ colors(colors: [RED, BLUE]) }'
query_str_2 = 'query($colors: [Color!]!) { colors(colors: $colors) }'
expected_query_string = 'query {
colors(colors: [RED, BLUE])
}'
assert_equal expected_query_string, sanitize_string(query_str_1)
assert_equal expected_query_string, sanitize_string(query_str_2, variables: { "colors" => ["RED", "BLUE"] })
end
it "redacts strings from custom scalars" do
query_str_1 = '
query {
s1: customScalar(scalar: "s1")
s2: customScalar(scalar: 1)
s3: customScalar(scalar: {string: "s2"})
s4: customScalar(scalar: [{string: "s3"}])
}
'
query_str_2 = '
query($jsonString: JSON!, $jsonInt: JSON!, $jsonObject: JSON!, $jsonArray: JSON!) {
s1: customScalar(scalar: $jsonString)
s2: customScalar(scalar: $jsonInt)
s3: customScalar(scalar: $jsonObject)
s4: customScalar(scalar: $jsonArray)
}
'
expected_query_string = 'query {
s1: customScalar(scalar: "<REDACTED>")
s2: customScalar(scalar: 1)
s3: customScalar(scalar: {string: "<REDACTED>"})
s4: customScalar(scalar: [{string: "<REDACTED>"}])
}'
assert_equal expected_query_string, sanitize_string(query_str_1)
variables = {
"jsonString" => "s1",
"jsonInt" => 1,
"jsonObject" => {
"string" => "s2"
},
"jsonArray" => [{
"string" => "s3"
}]
}
assert_equal expected_query_string, sanitize_string(query_str_2, variables: variables)
end
it "returns nil on invalid queries" do
assert_nil sanitize_string "{ __typename "
end
it "provides hooks to override the redaction behavior" do
query_str = '
{
inputs(
string: "string",
id: "id",
int: 1,
float: 2.0,
url: "http://graphqliscool.com",
enum: RED
inputObject: {
string: "string"
id: "id"
int: 1
float: 2.0
url: "http://graphqliscool.com"
enum: RED
}
)
}
'
expected_query_string = 'query {
inputs(' +
'string: <string-redacted>, id: <id-redacted>, int: <int-redacted>, float: <float-redacted>, url: <url-redacted>, enum: RED, inputObject: {' +
'string: <string-redacted>, id: <id-redacted>, int: <int-redacted>, float: <float-redacted>, url: <url-redacted>, enum: RED})
}'
query = GraphQL::Query.new(SanitizeTest::Schema, query_str)
sanitized_query = SanitizeTest::CustomSanitizedPrinter.new(query).sanitized_query_string
assert_equal expected_query_string, sanitized_query
end
it 'configure a custom printer from the schema' do
query_str = '
{
inputs(
string: "string",
id: "id",
int: 1,
float: 2.0,
url: "http://graphqliscool.com",
enum: RED
inputObject: {
string: "string"
id: "id"
int: 1
float: 2.0
url: "http://graphqliscool.com"
enum: RED
}
)
}
'
expected_query_string = 'query {
inputs(' +
'string: <string-redacted>, id: <id-redacted>, int: <int-redacted>, float: <float-redacted>, url: <url-redacted>, enum: RED, inputObject: {' +
'string: <string-redacted>, id: <id-redacted>, int: <int-redacted>, float: <float-redacted>, url: <url-redacted>, enum: RED})
}'
query = GraphQL::Query.new(SanitizeTest::CustomSanitizedPrinterSchema, query_str)
assert_equal expected_query_string, query.sanitized_query_string
end
it "properly prints enum variable default values" do
class EnumSchema < GraphQL::Schema
class Grouping < GraphQL::Schema::Enum
value "DAY"
end
class Query < GraphQL::Schema::Object
field :things, [String] do
argument :group, Grouping
end
def things(group:)
[group]
end
end
query(Query)
end
query_string = <<~EOS
query(
$group: Grouping = DAY
) {
things(group: $group)
}
EOS
query = ::GraphQL::Query.new(EnumSchema, query_string)
assert_equal ["DAY"], query.result["data"]["things"]
expected_query_string = "query {\n things(group: DAY)\n}"
assert_equal expected_query_string, query.sanitized_query_string
end
end
|
