-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
JsonFramingSpec.scala
442 lines (387 loc) · 15.4 KB
/
JsonFramingSpec.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
/*
* Copyright (C) 2009-2015 Typesafe Inc. <http://www.typesafe.com>
*/
package akka.stream.scaladsl
import akka.stream.ActorMaterializer
import akka.stream.impl.JsonObjectParser
import akka.stream.scaladsl.Framing.FramingException
import akka.stream.testkit.scaladsl.TestSink
import akka.testkit.AkkaSpec
import akka.util.ByteString
import scala.collection.immutable.Seq
import scala.concurrent.Await
import scala.concurrent.duration._
class JsonFramingSpec extends AkkaSpec {
override implicit val patience = PatienceConfig(timeout = 10.seconds)
implicit val mat = ActorMaterializer()
"collecting multiple json" should {
"parse json array" in {
val input =
"""
|[
| { "name" : "john" },
| { "name" : "Ég get etið gler án þess að meiða mig" },
| { "name" : "jack" },
|]
|""".stripMargin // also should complete once notices end of array
val result = Source.single(ByteString(input))
.via(JsonFraming.objectScanner(Int.MaxValue))
.runFold(Seq.empty[String]) {
case (acc, entry) ⇒ acc ++ Seq(entry.utf8String)
}
result.futureValue shouldBe Seq(
"""{ "name" : "john" }""",
"""{ "name" : "Ég get etið gler án þess að meiða mig" }""",
"""{ "name" : "jack" }"""
)
}
"emit single json element from string" in {
val input =
"""| { "name": "john" }
| { "name": "jack" }
""".stripMargin
val result = Source.single(ByteString(input))
.via(JsonFraming.objectScanner(Int.MaxValue))
.take(1)
.runFold(Seq.empty[String]) {
case (acc, entry) ⇒ acc ++ Seq(entry.utf8String)
}
Await.result(result, 3.seconds) shouldBe Seq("""{ "name": "john" }""")
}
"parse line delimited" in {
val input =
"""| { "name": "john" }
| { "name": "jack" }
| { "name": "katie" }
""".stripMargin
val result = Source.single(ByteString(input))
.via(JsonFraming.objectScanner(Int.MaxValue))
.runFold(Seq.empty[String]) {
case (acc, entry) ⇒ acc ++ Seq(entry.utf8String)
}
Await.result(result, 3.seconds) shouldBe Seq(
"""{ "name": "john" }""",
"""{ "name": "jack" }""",
"""{ "name": "katie" }""")
}
"parse comma delimited" in {
val input =
""" { "name": "john" }, { "name": "jack" }, { "name": "katie" } """
val result = Source.single(ByteString(input))
.via(JsonFraming.objectScanner(Int.MaxValue))
.runFold(Seq.empty[String]) {
case (acc, entry) ⇒ acc ++ Seq(entry.utf8String)
}
result.futureValue shouldBe Seq(
"""{ "name": "john" }""",
"""{ "name": "jack" }""",
"""{ "name": "katie" }""")
}
"parse chunks successfully" in {
val input: Seq[ByteString] = Seq(
"""
|[
| { "name": "john"""".stripMargin,
"""
|},
""".stripMargin,
"""{ "na""",
"""me": "jack""",
""""}]"""").map(ByteString(_))
val result = Source.apply(input)
.via(JsonFraming.objectScanner(Int.MaxValue))
.runFold(Seq.empty[String]) {
case (acc, entry) ⇒ acc ++ Seq(entry.utf8String)
}
result.futureValue shouldBe Seq(
"""{ "name": "john"
|}""".stripMargin,
"""{ "name": "jack"}""")
}
}
"collecting json buffer" when {
"nothing is supplied" should {
"return nothing" in {
val buffer = new JsonObjectParser()
buffer.poll() should ===(None)
}
}
"valid json is supplied" which {
"has one object" should {
"successfully parse empty object" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString("""{}"""))
buffer.poll().get.utf8String shouldBe """{}"""
}
"successfully parse single field having string value" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString("""{ "name": "john"}"""))
buffer.poll().get.utf8String shouldBe """{ "name": "john"}"""
}
"successfully parse single field having string value containing space" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString("""{ "name": "john doe"}"""))
buffer.poll().get.utf8String shouldBe """{ "name": "john doe"}"""
}
"successfully parse single field having string value containing curly brace" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString("""{ "name": "john{"""))
buffer.offer(ByteString("}"))
buffer.offer(ByteString("\""))
buffer.offer(ByteString("}"))
buffer.poll().get.utf8String shouldBe """{ "name": "john{}"}"""
}
"successfully parse single field having string value containing curly brace and escape character" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString("""{ "name": "john"""))
buffer.offer(ByteString("\\\""))
buffer.offer(ByteString("{"))
buffer.offer(ByteString("}"))
buffer.offer(ByteString("\\\""))
buffer.offer(ByteString(" "))
buffer.offer(ByteString("hey"))
buffer.offer(ByteString("\""))
buffer.offer(ByteString("}"))
buffer.poll().get.utf8String shouldBe """{ "name": "john\"{}\" hey"}"""
}
"successfully parse single field having integer value" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString("""{ "age": 101}"""))
buffer.poll().get.utf8String shouldBe """{ "age": 101}"""
}
"successfully parse single field having decimal value" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString("""{ "age": 101}"""))
buffer.poll().get.utf8String shouldBe """{ "age": 101}"""
}
"successfully parse single field having nested object" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString(
"""
|{ "name": "john",
| "age": 101,
| "address": {
| "street": "Straight Street",
| "postcode": 1234
| }
|}
| """.stripMargin))
buffer.poll().get.utf8String shouldBe """{ "name": "john",
| "age": 101,
| "address": {
| "street": "Straight Street",
| "postcode": 1234
| }
|}""".stripMargin
}
"successfully parse single field having multiple level of nested object" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString(
"""
|{ "name": "john",
| "age": 101,
| "address": {
| "street": {
| "name": "Straight",
| "type": "Avenue"
| },
| "postcode": 1234
| }
|}
| """.stripMargin))
buffer.poll().get.utf8String shouldBe """{ "name": "john",
| "age": 101,
| "address": {
| "street": {
| "name": "Straight",
| "type": "Avenue"
| },
| "postcode": 1234
| }
|}""".stripMargin
}
}
"has nested array" should {
"successfully parse" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString(
"""
|{ "name": "john",
| "things": [
| 1,
| "hey",
| 3,
| "there"
| ]
|}
| """.stripMargin))
buffer.poll().get.utf8String shouldBe """{ "name": "john",
| "things": [
| 1,
| "hey",
| 3,
| "there"
| ]
|}""".stripMargin
}
}
"has complex object graph" should {
"successfully parse" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString(
"""
|{
| "name": "john",
| "addresses": [
| {
| "street": "3 Hopson Street",
| "postcode": "ABC-123",
| "tags": ["work", "office"],
| "contactTime": [
| {"time": "0900-1800", "timezone", "UTC"}
| ]
| },
| {
| "street": "12 Adielie Road",
| "postcode": "ZZY-888",
| "tags": ["home"],
| "contactTime": [
| {"time": "0800-0830", "timezone", "UTC"},
| {"time": "1800-2000", "timezone", "UTC"}
| ]
| }
| ]
|}
| """.stripMargin))
buffer.poll().get.utf8String shouldBe """{
| "name": "john",
| "addresses": [
| {
| "street": "3 Hopson Street",
| "postcode": "ABC-123",
| "tags": ["work", "office"],
| "contactTime": [
| {"time": "0900-1800", "timezone", "UTC"}
| ]
| },
| {
| "street": "12 Adielie Road",
| "postcode": "ZZY-888",
| "tags": ["home"],
| "contactTime": [
| {"time": "0800-0830", "timezone", "UTC"},
| {"time": "1800-2000", "timezone", "UTC"}
| ]
| }
| ]
|}""".stripMargin
}
}
"has multiple fields" should {
"parse successfully" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString("""{ "name": "john", "age": 101}"""))
buffer.poll().get.utf8String shouldBe """{ "name": "john", "age": 101}"""
}
"parse successfully despite valid whitespaces around json" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString(
"""
|
|
|{"name": "john"
|, "age": 101}""".stripMargin))
buffer.poll().get.utf8String shouldBe
"""{"name": "john"
|, "age": 101}""".stripMargin
}
}
"has multiple objects" should {
"pops the right object as buffer is filled" in {
val input =
"""
| {
| "name": "john",
| "age": 32
| },
| {
| "name": "katie",
| "age": 25
| }
""".stripMargin
val buffer = new JsonObjectParser()
buffer.offer(ByteString(input))
buffer.poll().get.utf8String shouldBe
"""{
| "name": "john",
| "age": 32
| }""".stripMargin
buffer.poll().get.utf8String shouldBe
"""{
| "name": "katie",
| "age": 25
| }""".stripMargin
buffer.poll() should ===(None)
buffer.offer(ByteString("""{"name":"jenkins","age": """))
buffer.poll() should ===(None)
buffer.offer(ByteString("65 }"))
buffer.poll().get.utf8String shouldBe """{"name":"jenkins","age": 65 }"""
}
}
"returns none until valid json is encountered" in {
val buffer = new JsonObjectParser()
"""{ "name": "john"""".foreach {
c ⇒
buffer.offer(ByteString(c))
buffer.poll() should ===(None)
}
buffer.offer(ByteString("}"))
buffer.poll().get.utf8String shouldBe """{ "name": "john"}"""
}
"invalid json is supplied" should {
"fail if it's broken from the start" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString("""THIS IS NOT VALID { "name": "john"}"""))
a[FramingException] shouldBe thrownBy { buffer.poll() }
}
"fail if it's broken at the end" in {
val buffer = new JsonObjectParser()
buffer.offer(ByteString("""{ "name": "john"} THIS IS NOT VALID"""))
buffer.poll() // first emitting the valid element
a[FramingException] shouldBe thrownBy { buffer.poll() }
}
}
}
"fail on too large initial object" in {
val input =
"""
| { "name": "john" }, { "name": "jack" }
""".stripMargin
val result = Source.single(ByteString(input))
.via(JsonFraming.objectScanner(5)).map(_.utf8String)
.runFold(Seq.empty[String]) {
case (acc, entry) ⇒ acc ++ Seq(entry)
}
a[FramingException] shouldBe thrownBy {
Await.result(result, 3.seconds)
}
}
"fail when 2nd object is too large" in {
val input = List(
"""{ "name": "john" }""",
"""{ "name": "jack" }""",
"""{ "name": "very very long name somehow. how did this happen?" }""").map(s ⇒ ByteString(s))
val probe = Source(input)
.via(JsonFraming.objectScanner(48))
.runWith(TestSink.probe)
probe.ensureSubscription()
probe
.request(1)
.expectNext(ByteString("""{ "name": "john" }"""))
.request(1)
.expectNext(ByteString("""{ "name": "jack" }"""))
.request(1)
.expectError().getMessage should include("exceeded")
}
}
}