walk.js
14.2 KB
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
'use strict'
const check = require('check-types')
const error = require('./error')
const EventEmitter = require('events').EventEmitter
const events = require('./events')
const promise = require('./promise')
const terminators = {
obj: '}',
arr: ']'
}
const escapes = {
/* eslint-disable quote-props */
'"': '"',
'\\': '\\',
'/': '/',
'b': '\b',
'f': '\f',
'n': '\n',
'r': '\r',
't': '\t'
/* eslint-enable quote-props */
}
module.exports = initialise
/**
* Public function `walk`.
*
* Returns an event emitter and asynchronously walks a stream of JSON data,
* emitting events as it encounters tokens. The event emitter is decorated
* with a `pause` method that can be called to pause processing.
*
* @param stream: Readable instance representing the incoming JSON.
*
* @option yieldRate: The number of data items to process per timeslice,
* default is 16384.
*
* @option Promise: The promise constructor to use, defaults to bluebird.
*
* @option ndjson: Set this to true to parse newline-delimited JSON.
**/
function initialise (stream, options = {}) {
check.assert.instanceStrict(stream, require('stream').Readable, 'Invalid stream argument')
const currentPosition = {
line: 1,
column: 1
}
const emitter = new EventEmitter()
const handlers = {
arr: value,
obj: property
}
const json = []
const lengths = []
const previousPosition = {}
const Promise = promise(options)
const scopes = []
const yieldRate = options.yieldRate || 16384
const shouldHandleNdjson = !! options.ndjson
let index = 0
let isStreamEnded = false
let isWalkBegun = false
let isWalkEnded = false
let isWalkingString = false
let hasEndedLine = true
let count = 0
let resumeFn
let pause
let cachedCharacter
stream.setEncoding('utf8')
stream.on('data', readStream)
stream.on('end', endStream)
stream.on('error', err => {
emitter.emit(events.error, err)
endStream()
})
emitter.pause = () => {
let resolve
pause = new Promise(res => resolve = res)
return () => {
pause = null
count = 0
if (shouldHandleNdjson && isStreamEnded && isWalkEnded) {
emit(events.end)
} else {
resolve()
}
}
}
return emitter
function readStream (chunk) {
addChunk(chunk)
if (isWalkBegun) {
return resume()
}
isWalkBegun = true
value()
}
function addChunk (chunk) {
json.push(chunk)
const chunkLength = chunk.length
lengths.push({
item: chunkLength,
aggregate: length() + chunkLength
})
}
function length () {
const chunkCount = lengths.length
if (chunkCount === 0) {
return 0
}
return lengths[chunkCount - 1].aggregate
}
function value () {
/* eslint-disable no-underscore-dangle */
if (++count % yieldRate !== 0) {
return _do()
}
return new Promise(resolve => {
setImmediate(() => _do().then(resolve))
})
function _do () {
return awaitNonWhitespace()
.then(next)
.then(handleValue)
.catch(() => {})
}
/* eslint-enable no-underscore-dangle */
}
function awaitNonWhitespace () {
return wait()
function wait () {
return awaitCharacter()
.then(step)
}
function step () {
if (isWhitespace(character())) {
return next().then(wait)
}
}
}
function awaitCharacter () {
let resolve, reject
if (index < length()) {
return Promise.resolve()
}
if (isStreamEnded) {
setImmediate(endWalk)
return Promise.reject()
}
resumeFn = after
return new Promise((res, rej) => {
resolve = res
reject = rej
})
function after () {
if (index < length()) {
return resolve()
}
reject()
if (isStreamEnded) {
setImmediate(endWalk)
}
}
}
function character () {
if (cachedCharacter) {
return cachedCharacter
}
if (lengths[0].item > index) {
return cachedCharacter = json[0][index]
}
const len = lengths.length
for (let i = 1; i < len; ++i) {
const { aggregate, item } = lengths[i]
if (aggregate > index) {
return cachedCharacter = json[i][index + item - aggregate]
}
}
}
function isWhitespace (char) {
switch (char) {
case '\n':
if (shouldHandleNdjson && scopes.length === 0) {
return false
}
case ' ':
case '\t':
case '\r':
return true
}
return false
}
function next () {
return awaitCharacter().then(after)
function after () {
const result = character()
cachedCharacter = null
index += 1
previousPosition.line = currentPosition.line
previousPosition.column = currentPosition.column
if (result === '\n') {
currentPosition.line += 1
currentPosition.column = 1
} else {
currentPosition.column += 1
}
if (index > lengths[0].aggregate) {
json.shift()
const difference = lengths.shift().item
index -= difference
lengths.forEach(len => len.aggregate -= difference)
}
return result
}
}
function handleValue (char) {
if (shouldHandleNdjson && scopes.length === 0) {
if (char === '\n') {
hasEndedLine = true
return emit(events.endLine)
.then(value)
}
if (! hasEndedLine) {
return fail(char, '\n', previousPosition)
.then(value)
}
hasEndedLine = false
}
switch (char) {
case '[':
return array()
case '{':
return object()
case '"':
return string()
case '0':
case '1':
case '2':
case '3':
case '4':
case '5':
case '6':
case '7':
case '8':
case '9':
case '-':
case '.':
return number(char)
case 'f':
return literalFalse()
case 'n':
return literalNull()
case 't':
return literalTrue()
default:
return fail(char, 'value', previousPosition)
.then(value)
}
}
function array () {
return scope(events.array, value)
}
function scope (event, contentHandler) {
return emit(event)
.then(() => {
scopes.push(event)
return endScope(event)
})
.then(contentHandler)
}
function emit (...args) {
return (pause || Promise.resolve())
.then(() => {
try {
emitter.emit(...args)
} catch (err) {
try {
emitter.emit(events.error, err)
} catch (_) {
// When calling user code, anything is possible
}
}
})
}
function endScope (scp) {
return awaitNonWhitespace()
.then(() => {
if (character() === terminators[scp]) {
return emit(events.endPrefix + scp)
.then(() => {
scopes.pop()
return next()
})
.then(endValue)
}
})
.catch(endWalk)
}
function endValue () {
return awaitNonWhitespace()
.then(after)
.catch(endWalk)
function after () {
if (scopes.length === 0) {
if (shouldHandleNdjson) {
return value()
}
return fail(character(), 'EOF', currentPosition)
.then(value)
}
return checkScope()
}
function checkScope () {
const scp = scopes[scopes.length - 1]
const handler = handlers[scp]
return endScope(scp)
.then(() => {
if (scopes.length > 0) {
return checkCharacter(character(), ',', currentPosition)
}
})
.then(result => {
if (result) {
return next()
}
})
.then(handler)
}
}
function fail (actual, expected, position) {
return emit(
events.dataError,
error.create(
actual,
expected,
position.line,
position.column
)
)
}
function checkCharacter (char, expected, position) {
if (char === expected) {
return Promise.resolve(true)
}
return fail(char, expected, position)
.then(false)
}
function object () {
return scope(events.object, property)
}
function property () {
return awaitNonWhitespace()
.then(next)
.then(propertyName)
}
function propertyName (char) {
return checkCharacter(char, '"', previousPosition)
.then(() => walkString(events.property))
.then(awaitNonWhitespace)
.then(next)
.then(propertyValue)
}
function propertyValue (char) {
return checkCharacter(char, ':', previousPosition)
.then(value)
}
function walkString (event) {
let isEscaping = false
const str = []
isWalkingString = true
return next().then(step)
function step (char) {
if (isEscaping) {
isEscaping = false
return escape(char).then(escaped => {
str.push(escaped)
return next().then(step)
})
}
if (char === '\\') {
isEscaping = true
return next().then(step)
}
if (char !== '"') {
str.push(char)
return next().then(step)
}
isWalkingString = false
return emit(event, str.join(''))
}
}
function escape (char) {
if (escapes[char]) {
return Promise.resolve(escapes[char])
}
if (char === 'u') {
return escapeHex()
}
return fail(char, 'escape character', previousPosition)
.then(() => `\\${char}`)
}
function escapeHex () {
let hexits = []
return next().then(step.bind(null, 0))
function step (idx, char) {
if (isHexit(char)) {
hexits.push(char)
}
if (idx < 3) {
return next().then(step.bind(null, idx + 1))
}
hexits = hexits.join('')
if (hexits.length === 4) {
return String.fromCharCode(parseInt(hexits, 16))
}
return fail(char, 'hex digit', previousPosition)
.then(() => `\\u${hexits}${char}`)
}
}
function string () {
return walkString(events.string).then(endValue)
}
function number (firstCharacter) {
let digits = [ firstCharacter ]
return walkDigits().then(addDigits.bind(null, checkDecimalPlace))
function addDigits (step, result) {
digits = digits.concat(result.digits)
if (result.atEnd) {
return endNumber()
}
return step()
}
function checkDecimalPlace () {
if (character() === '.') {
return next()
.then(char => {
digits.push(char)
return walkDigits()
})
.then(addDigits.bind(null, checkExponent))
}
return checkExponent()
}
function checkExponent () {
if (character() === 'e' || character() === 'E') {
return next()
.then(char => {
digits.push(char)
return awaitCharacter()
})
.then(checkSign)
.catch(fail.bind(null, 'EOF', 'exponent', currentPosition))
}
return endNumber()
}
function checkSign () {
if (character() === '+' || character() === '-') {
return next().then(char => {
digits.push(char)
return readExponent()
})
}
return readExponent()
}
function readExponent () {
return walkDigits().then(addDigits.bind(null, endNumber))
}
function endNumber () {
return emit(events.number, parseFloat(digits.join('')))
.then(endValue)
}
}
function walkDigits () {
const digits = []
return wait()
function wait () {
return awaitCharacter()
.then(step)
.catch(atEnd)
}
function step () {
if (isDigit(character())) {
return next().then(char => {
digits.push(char)
return wait()
})
}
return { digits, atEnd: false }
}
function atEnd () {
return { digits, atEnd: true }
}
}
function literalFalse () {
return literal([ 'a', 'l', 's', 'e' ], false)
}
function literal (expectedCharacters, val) {
let actual, expected, invalid
return wait()
function wait () {
return awaitCharacter()
.then(step)
.catch(atEnd)
}
function step () {
if (invalid || expectedCharacters.length === 0) {
return atEnd()
}
return next().then(afterNext)
}
function atEnd () {
return Promise.resolve()
.then(() => {
if (invalid) {
return fail(actual, expected, previousPosition)
}
if (expectedCharacters.length > 0) {
return fail('EOF', expectedCharacters.shift(), currentPosition)
}
return done()
})
.then(endValue)
}
function afterNext (char) {
actual = char
expected = expectedCharacters.shift()
if (actual !== expected) {
invalid = true
}
return wait()
}
function done () {
return emit(events.literal, val)
}
}
function literalNull () {
return literal([ 'u', 'l', 'l' ], null)
}
function literalTrue () {
return literal([ 'r', 'u', 'e' ], true)
}
function endStream () {
isStreamEnded = true
if (isWalkBegun) {
return resume()
}
endWalk()
}
function resume () {
if (resumeFn) {
resumeFn()
resumeFn = null
}
}
function endWalk () {
if (isWalkEnded) {
return Promise.resolve()
}
isWalkEnded = true
return Promise.resolve()
.then(() => {
if (isWalkingString) {
return fail('EOF', '"', currentPosition)
}
})
.then(popScopes)
.then(() => emit(events.end))
}
function popScopes () {
if (scopes.length === 0) {
return Promise.resolve()
}
return fail('EOF', terminators[scopes.pop()], currentPosition)
.then(popScopes)
}
}
function isHexit (character) {
return isDigit(character) ||
isInRange(character, 'A', 'F') ||
isInRange(character, 'a', 'f')
}
function isDigit (character) {
return isInRange(character, '0', '9')
}
function isInRange (character, lower, upper) {
const code = character.charCodeAt(0)
return code >= lower.charCodeAt(0) && code <= upper.charCodeAt(0)
}