# all files / lib/spdy-transport/ stream.js

91.53% Statements 346/378
81.56% Branches 115/141
92.45% Functions 49/53
93.13% Lines 339/364

    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

    1×

    1×
    1×
    1×

    1×
    1×

    1×
    513×

    513×

    513×
    513×

    513×
    513×
    513×
    513×
    513×
    513×
    513×

    513×
    513×
    513×

    513×

    513×
    513×
    513×

    513×
    513×

    513×
    513×
    513×
    513×
    513×

    513×

    513×
    513×

    513×

    513×
    513×

    513×

    513×
    513×

    513×
    1×
    4×

    513×
    513×

    513×

    513×
    513×
    52×
    52×

    1×
    1×

    1×

    1×
    515×
    515×
    515×

    515×
    246×
    246×

    269×

    1×
    3049×

    3049×
    6×
    6×

    3043×

    3043×
    1683×
    1360×
    151×
    1209×
    53×
    1156×
    1×
    55×

    3043×
    155×
    155×

    1×
    3100×
    4×
    4×
    4×

    4×

    3096×

    1×
    1550×

    1550×

    1550×

    1550×
    1550×
    4×

    1546×

    1546×

    1546×

    1546×
    1546×

    1×
    128×

    128×

    128×
    16×
    16×
    16×

    16×

    112×

    1×
    112×

    1×
    1658×
    104×

    1554×
    1554×
    1554×

    1554×
    1554×
    1026×

    1554×
    1554×
    1060×

    1554×
    1554×

    1554×

    1554×
    4×

    4×

    1550×
    1550×

    1550×

    1550×
    1550×

    1546×

    1×
    1697×

    1697×
    609×

    1088×

    1088×

    1088×
    1088×

    1×
    1683×

    1683×
    4×
    4×

    1679×
    1679×

    1679×

    1×
    53×
    12×

    53×

    1×
    1100×

    1100×

    1×
    4×

    4×
    4×

    4×
    4×

    1×
    2×

    2×
    2×
    2×

    2×

    1×
    151×

    151×

    151×
    139×

    12×

    1×
    139×

    139×

    139×
    139×

    1×
    187×

    187×

    10×

    177×
    39×
    39×
    39×

    39×

    138×

    148×

    1×
    129×

    1×
    200×

    200×
    200×

    200×

    200×
    196×

    4×

    4×
    4×
    4×

    4×

    1×
    277×

    277×

    277×

    102×

    102×

    1×
    33×

    33×

    33×
    4×

    1×
    486×

    486×
    486×

    1×
    478×

    478×
    478×
    478×
    77×

    401×
    401×
    401×
    55×

    1×
    45×
    45×

    45×
    45×

    45×

    45×

    1×
    193×
    193×

    1×
    213×

    213×

    213×
    213×

    213×
    21×
    21×

    213×
    213×
    213×

    213×

    213×
    18×

    195×

    1×
    126×
    126×
    126×

    126×

    126×

    126×

    126×
    126×
    126×
    126×

    1×
    8×

    8×

    8×

    8×
    8×

    8×
    8×

    8×

    8×

    1×
    20×
    20×

    20×

    20×
    4×

    16×
    4×
    4×
    4×
    4×

    4×

    12×
    12×

    12×
    12×

    1×

    1×
    104×

    104×
    4×
    4×

    104×
    4×
    4×
    4×

    4×

    100×

    100×
    100×

    100×

    100×

    100×

    100×
    100×
    100×

    100×

    1×
    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×
    45×

    45×
    45×
    45×
    45×
    45×
    37×

    45×
    45×

    45×

    45×

    1×
    4×
    4×

    1×
    116×

    116×

     'use strict'

    var transport = require('../spdy-transport')

    var assert = require('assert')
    var util = require('util')
    var debug = {
      client: require('debug')('spdy:stream:client'),
      server: require('debug')('spdy:stream:server')
    }
    var Buffer = require('buffer').Buffer
    var Duplex = require('readable-stream').Duplex

    function Stream (connection, options) {
      Duplex.call(this)

      var connectionState = connection._spdyState

      var state = {}
      this._spdyState = state

      this.id = options.id
      this.method = options.method
      this.path = options.path
      this.host = options.host
      this.headers = options.headers || {}
      this.connection = connection
      this.parent = options.parent || null

      state.socket = null
      state.protocol = connectionState.protocol
      state.constants = state.protocol.constants

      // See _initPriority()
      state.priority = null

      state.version = this.connection.getVersion()
      state.isServer = this.connection.isServer()
      state.debug = state.isServer ? debug.server : debug.client

      state.framer = connectionState.framer
      state.parser = connectionState.parser

      state.request = options.request
      state.needResponse = options.request
      state.window = connectionState.streamWindow.clone(options.id)
      state.sessionWindow = connectionState.window
      state.maxChunk = connectionState.maxChunk

      // Can't send incoming request
      // (See `.send()` method)
      state.sent = !state.request

      state.readable = options.readable !== false
      state.writable = options.writable !== false

      state.aborted = false

      state.corked = 0
      state.corkQueue = []

      state.timeout = new transport.utils.Timeout(this)

      this.on('finish', this._onFinish)
      this.on('end', this._onEnd)

      var self = this
      function _onWindowOverflow () {
        self._onWindowOverflow()
      }

      state.window.recv.on('overflow', _onWindowOverflow)
      state.window.send.on('overflow', _onWindowOverflow)

      this._initPriority(options.priority)

      if (!state.readable) { this.push(null) }
      if (!state.writable) {
        this._writableState.ended = true
        this._writableState.finished = true
      }
    }
    util.inherits(Stream, Duplex)
    exports.Stream = Stream

    Stream.prototype._init = function _init (socket) {
      this.socket = socket
    }

    Stream.prototype._initPriority = function _initPriority (priority) {
      var state = this._spdyState
      var connectionState = this.connection._spdyState
      var root = connectionState.priorityRoot

      if (!priority) {
        state.priority = root.addDefault(this.id)
        return
      }

      state.priority = root.add({
        id: this.id,
        parent: priority.parent,
        weight: priority.weight,
        exclusive: priority.exclusive
      })
    }

    Stream.prototype._handleFrame = function _handleFrame (frame) {
      var state = this._spdyState

      // Ignore any kind of data after abort
      if (state.aborted) {
        state.debug('id=%d ignoring frame=%s after abort', this.id, frame.type)
        return
      }

      // Restart the timer on incoming frames
      state.timeout.reset()

      if (frame.type === 'DATA') {
        this._handleData(frame)
      } else if (frame.type === 'HEADERS') {
        this._handleHeaders(frame)
      } else if (frame.type === 'RST') {
        this._handleRST(frame)
      } else if (frame.type === 'WINDOW_UPDATE') { this._handleWindowUpdate(frame) } else if (frame.type === 'PRIORITY') {
        this._handlePriority(frame)
      } else if (frame.type === 'PUSH_PROMISE') { this._handlePushPromise(frame) }

      if (frame.fin) {
        state.debug('id=%d end', this.id)
        this.push(null)
      }
    }

    function checkAborted (stream, state, callback) {
      if (state.aborted) {
        state.debug('id=%d abort write', stream.id)
        process.nextTick(function () {
          callback(new Error('Stream write aborted'))
        })
        return true
      }

      return false
    }

    function _send (stream, state, data, callback) {
      Iif (checkAborted(stream, state, callback)) {
        return
      }

      state.debug('id=%d presend=%d', stream.id, data.length)

      state.timeout.reset()

      state.window.send.update(-data.length, function () {
        if (checkAborted(stream, state, callback)) {
          return
        }

        state.debug('id=%d send=%d', stream.id, data.length)

        state.timeout.reset()

        state.framer.dataFrame({
          id: stream.id,
          priority: state.priority.getPriority(),
          fin: false,
          data: data
        }, function (err) {
          state.debug('id=%d postsend=%d', stream.id, data.length)
          callback(err)
        })
      })
    }

    Stream.prototype._write = function _write (data, enc, callback) {
      var state = this._spdyState

      // Send the request if it wasn't sent
      if (!state.sent) { this.send() }

      // Writes should come after pending control frames (response and headers)
      if (state.corked !== 0) {
        var self = this
        state.corkQueue.push(function () {
          self._write(data, enc, callback)
        })
        return
      }

      // Split DATA in chunks to prevent window from going negative
      this._splitStart(data, _send, callback)
    }

    Stream.prototype._splitStart = function _splitStart (data, onChunk, callback) {
      return this._split(data, 0, onChunk, callback)
    }

    Stream.prototype._split = function _split (data, offset, onChunk, callback) {
      if (offset === data.length) {
        return process.nextTick(callback)
      }

      var state = this._spdyState
      var local = state.window.send
      var session = state.sessionWindow.send

      var availSession = Math.max(0, session.getCurrent())
      if (availSession === 0) {
        availSession = session.getMax()
      }
      var availLocal = Math.max(0, local.getCurrent())
      if (availLocal === 0) {
        availLocal = local.getMax()
      }

      var avail = Math.min(availSession, availLocal)
      avail = Math.min(avail, state.maxChunk)

      var self = this

      if (avail === 0) {
        state.window.send.update(0, function () {
          self._split(data, offset, onChunk, callback)
        })
        return
      }

      // Split data in chunks in a following way:
      var limit = avail
      var size = Math.min(data.length - offset, limit)

      var chunk = data.slice(offset, offset + size)

      onChunk(this, state, chunk, function (err) {
        if (err) { return callback(err) }

        // Get the next chunk
        self._split(data, offset + size, onChunk, callback)
      })
    }

    Stream.prototype._read = function _read () {
      var state = this._spdyState

      if (!state.window.recv.isDraining()) {
        return
      }

      var delta = state.window.recv.getDelta()

      state.debug('id=%d window emptying, update by %d', this.id, delta)

      state.window.recv.update(delta)
      state.framer.windowUpdateFrame({
        id: this.id,
        delta: delta
      })
    }

    Stream.prototype._handleData = function _handleData (frame) {
      var state = this._spdyState

      // DATA on ended or not readable stream!
      if (!state.readable || this._readableState.ended) {
        state.framer.rstFrame({ id: this.id, code: 'STREAM_CLOSED' })
        return
      }

      state.debug('id=%d recv=%d', this.id, frame.data.length)
      state.window.recv.update(-frame.data.length)

      this.push(frame.data)
    }

    Stream.prototype._handleRST = function _handleRST (frame) {
      if (frame.code !== 'CANCEL') {
        this.emit('error', new Error('Got RST: ' + frame.code))
      }
      this.abort()
    }

    Stream.prototype._handleWindowUpdate = function _handleWindowUpdate (frame) {
      var state = this._spdyState

      state.window.send.update(frame.delta)
    }

    Stream.prototype._onWindowOverflow = function _onWindowOverflow () {
      var state = this._spdyState

      state.debug('id=%d window overflow', this.id)
      state.framer.rstFrame({ id: this.id, code: 'FLOW_CONTROL_ERROR' })

      this.aborted = true
      this.emit('error', new Error('HTTP2 window overflow'))
    }

    Stream.prototype._handlePriority = function _handlePriority (frame) {
      var state = this._spdyState

      state.priority.remove()
      state.priority = null
      this._initPriority(frame.priority)

      // Mostly for testing purposes
      this.emit('priority', frame.priority)
    }

    Stream.prototype._handleHeaders = function _handleHeaders (frame) {
      var state = this._spdyState

      Iif (!state.readable || this._readableState.ended) {
        state.framer.rstFrame({ id: this.id, code: 'STREAM_CLOSED' })
        return
      }

      if (state.needResponse) {
        return this._handleResponse(frame)
      }

      this.emit('headers', frame.headers)
    }

    Stream.prototype._handleResponse = function _handleResponse (frame) {
      var state = this._spdyState

      Iif (frame.headers[':status'] === undefined) {
        state.framer.rstFrame({ id: this.id, code: 'PROTOCOL_ERROR' })
        return
      }

      state.needResponse = false
      this.emit('response', frame.headers[':status'] | 0, frame.headers)
    }

    Stream.prototype._onFinish = function _onFinish () {
      var state = this._spdyState

      // Send the request if it wasn't sent
      if (!state.sent) {
        // NOTE: will send HEADERS with FIN flag
        this.send()
      } else {
        // Just an `.end()` without any writes will trigger immediate `finish` event
        // without any calls to `_write()`.
        if (state.corked !== 0) {
          var self = this
          state.corkQueue.push(function () {
            self._onFinish()
          })
          return
        }

        state.framer.dataFrame({
          id: this.id,
          priority: state.priority.getPriority(),
          fin: true,
          data: new Buffer(0)
        })
      }

      this._maybeClose()
    }

    Stream.prototype._onEnd = function _onEnd () {
      this._maybeClose()
    }

    Stream.prototype._checkEnded = function _checkEnded (callback) {
      var state = this._spdyState

      var ended = false
      Iif (state.aborted) { ended = true }

      if (!state.writable || this._writableState.finished) { ended = true }

      if (!ended) {
        return true
      }

      Iif (!callback) {
        return false
      }

      var err = new Error('Ended stream can\'t send frames')
      process.nextTick(function () {
        callback(err)
      })

      return false
    }

    Stream.prototype._maybeClose = function _maybeClose () {
      var state = this._spdyState

      // .abort() emits `close`
      Iif (state.aborted) {
        return
      }

      if ((!state.readable || this._readableState.ended) &&
          this._writableState.finished) {
        // Clear timeout
        state.timeout.set(0)

        this.emit('close')
      }
    }

    Stream.prototype._handlePushPromise = function _handlePushPromise (frame) {
      var push = this.connection._createStream({
        id: frame.promisedId,
        parent: this,
        push: true,
        request: true,
        method: frame.headers[':method'],
        path: frame.headers[':path'],
        host: frame.headers[':authority'],
        priority: frame.priority,
        headers: frame.headers,
        writable: false
      })

      // GOAWAY
      Iif (this.connection._isGoaway(push.id)) {
        return
      }

      if (!this.emit('pushPromise', push)) {
        push.abort()
      }
    }

    Stream.prototype._hardCork = function _hardCork () {
      var state = this._spdyState

      this.cork()
      state.corked++
    }

    Stream.prototype._hardUncork = function _hardUncork () {
      var state = this._spdyState

      this.uncork()
      state.corked--
      if (state.corked !== 0) {
        return
      }

      // Invoke callbacks
      var queue = state.corkQueue
      state.corkQueue = []
      for (var i = 0; i < queue.length; i++) {
        queue[i]()
      }
    }

    Stream.prototype._sendPush = function _sendPush (status, response, callback) {
      var self = this
      var state = this._spdyState

      this._hardCork()
      state.framer.pushFrame({
        id: this.parent.id,
        promisedId: this.id,
        priority: state.priority.toJSON(),
        path: this.path,
        host: this.host,
        method: this.method,
        status: status,
        headers: this.headers,
        response: response
      }, function (err) {
        self._hardUncork()

        callback(err)
      })
    }

    Stream.prototype._wasSent = function _wasSent () {
      var state = this._spdyState
      return state.sent
    }

    // Public API

    Stream.prototype.send = function send (callback) {
      var state = this._spdyState

      Iif (state.sent) {
        var err = new Error('Stream was already sent')
        process.nextTick(function () {
          if (callback) {
            callback(err)
          }
        })
        return
      }

      state.sent = true
      state.timeout.reset()

      // GET requests should always be auto-finished
      if (this.method === 'GET') {
        this._writableState.ended = true
        this._writableState.finished = true
      }

      // TODO(indunty): ideally it should just take a stream object as an input
      var self = this
      this._hardCork()
      state.framer.requestFrame({
        id: this.id,
        method: this.method,
        path: this.path,
        host: this.host,
        priority: state.priority.toJSON(),
        headers: this.headers,
        fin: this._writableState.finished
      }, function (err) {
        self._hardUncork()

        if (!callback) {
          return
        }

        callback(err)
      })
    }

    Stream.prototype.respond = function respond (status, headers, callback) {
      var self = this
      var state = this._spdyState
      assert(!state.request, 'Can\'t respond on request')

      state.timeout.reset()

      Iif (!this._checkEnded(callback)) { return }

      var frame = {
        id: this.id,
        status: status,
        headers: headers
      }
      this._hardCork()
      state.framer.responseFrame(frame, function (err) {
        self._hardUncork()
        Iif (callback) { callback(err) }
      })
    }

    Stream.prototype.setWindow = function setWindow (size) {
      var state = this._spdyState

      state.timeout.reset()

      Iif (!this._checkEnded()) {
        return
      }

      state.debug('id=%d force window max=%d', this.id, size)
      state.window.recv.setMax(size)

      var delta = state.window.recv.getDelta()
      Iif (delta === 0) { return }

      state.framer.windowUpdateFrame({
        id: this.id,
        delta: delta
      })
      state.window.recv.update(delta)
    }

    Stream.prototype.sendHeaders = function sendHeaders (headers, callback) {
      var self = this
      var state = this._spdyState

      state.timeout.reset()

      if (!this._checkEnded(callback)) {
        return
      }

      // Request wasn't yet send, coalesce headers
      if (!state.sent) {
        this.headers = util._extend({}, this.headers)
        util._extend(this.headers, headers)
        process.nextTick(function () {
          Iif (callback) {
            callback(null)
          }
        })
        return
      }

      this._hardCork()
      state.framer.headersFrame({
        id: this.id,
        headers: headers
      }, function (err) {
        self._hardUncork()
        Iif (callback) { callback(err) }
      })
    }

    Stream.prototype.destroy = function destroy () {
      this.abort()
    }

    Stream.prototype.abort = function abort (code, callback) {
      var state = this._spdyState

      // .abort(callback)
      if (typeof code === 'function') {
        callback = code
        code = null
      }

      if (this._readableState.ended && this._writableState.finished) {
        state.debug('id=%d already closed', this.id)
        Eif (callback) {
          process.nextTick(callback)
        }
        return
      }

      Iif (state.aborted) {
        state.debug('id=%d already aborted', this.id)
        if (callback) { process.nextTick(callback) }
        return
      }

      state.aborted = true
      state.debug('id=%d abort', this.id)

      this.setTimeout(0)

      var abortCode = code || 'CANCEL'

      state.framer.rstFrame({
        id: this.id,
        code: abortCode
      })

      var self = this
      process.nextTick(function () {
        Iif (callback) {
          callback(null)
        }
        self.emit('close', new Error('Aborted, code: ' + abortCode))
      })
    }

    Stream.prototype.setPriority = function setPriority (info) {
      var state = this._spdyState

      state.timeout.reset()

      Iif (!this._checkEnded()) {
        return
      }

      state.debug('id=%d priority change', this.id, info)

      var frame = { id: this.id, priority: info }

      // Change priority on this side
      this._handlePriority(frame)

      // And on the other too
      state.framer.priorityFrame(frame)
    }

    Stream.prototype.pushPromise = function pushPromise (uri, callback) {
      Iif (!this._checkEnded(callback)) {
        return
      }

      var self = this
      this._hardCork()
      var push = this.connection.pushPromise(this, uri, function (err) {
        self._hardUncork()
        if (!err) {
          push._hardUncork()
        }

        Eif (callback) {
          return callback(err, push)
        }

        if (err) { push.emit('error', err) }
      })
      push._hardCork()

      return push
    }

    Stream.prototype.setMaxChunk = function setMaxChunk (size) {
      var state = this._spdyState
      state.maxChunk = size
    }

    Stream.prototype.setTimeout = function setTimeout (delay, callback) {
      var state = this._spdyState

      state.timeout.set(delay, callback)
    }