molnarg/node-http2-protocol

WARNING: This code was merged into node-http2

node-http2-protocol

An HTTP/2 (draft-ietf-httpbis-http2-14) framing layer implementaion for node.js.

Installation

npm install http2-protocol

Examples

API

Development

Development dependencies

There's a few library you will need to have installed to do anything described in the following sections. After installing/cloning node-http2, run npm install in its directory to install development dependencies.

Used libraries:

• mocha for tests
• chai for assertions
• istanbul for code coverage analysis
• docco for developer documentation
• bunyan for logging

For pretty printing logs, you will also need a global install of bunyan (npm install -g bunyan).

Developer documentation

The developer documentation is generated from the source code using docco and can be viewed online here. If you'd like to have an offline copy, just run npm run-script doc.

Running the tests

It's easy, just run npm test. The tests are written in BDD style, so they are a good starting point to understand the code.

Test coverage

To generate a code coverage report, run npm test --coverage (it may be slow, be patient). Code coverage summary as of version 0.13.0:

Statements   : 92.23% ( 1341/1454 )
Branches     : 86% ( 553/643 )
Functions    : 91.93% ( 148/161 )
Lines        : 92.32% ( 1335/1446 )

There's a hosted version of the detailed (line-by-line) coverage report here.

Logging

Contributors

Code contributions are always welcome! People who contributed to node-http2 so far:

• Nick Hurley
• Mike Belshe
• vsemogutor

Special thanks to Google for financing the development of this module as part of their Summer of Code program (project: HTTP/2 prototype server implementation), and Nick Hurley of Mozilla, my GSoC mentor, who helped with regular code review and technical advices.

License

The MIT License

Copyright (C) 2013 Gábor Molnár [email protected]

node-http2-protocol's Issues

Compression: implement a real streaming decompressor

• that can be used to implement header buffer space limitation
• and can avoid costly buffer copies

Forbid sending a promise when the peer disables it

WINDOW_UPDATE frame with oversized payload or without payload should raise error of type FRAME_SIZE_ERROR

If a frame size exceeds any defined limit, or is too small to contain mandatory frame data, the endpoint MUST send a FRAME_SIZE_ERROR error (draft-09, section 4.2)

Upgrade to the -07 draft

Flow control may block non-flow-controlled frames

For all frame types, lib/stream.js uses this._pushUpstream to submit the frame for sending, which in turn calls Flow.prototype.push. In Flow.prototype.push, we could conceivably get into a state where there are DATA frames queued (so this._queue.length !== 0), so moreNeeded will not get set to non-null, and the check on line 278 will evaluate to true, thus enqueuing the frame, regardless of what type of frame it is. We should check the frame type in Flow.prototype.push before checking moreNeeded at all, so we don't end up blocking non-flow-controlled frames (I think).

I can whip up a patch for this, but I wanted to submit the issue to make sure I'm not crazy before doing the work :)

Update examples to use node-http2-protocol instead of node-http2

SETTINGS frame with ACK flag set and non-zero length

Receipt of a SETTINGS frame with the ACK flag set and a length field value other than 0 MUST be treated as a connection error of type FRAME_SIZE_ERROR (draft-09, section 6.5)

Reserved bits are treated as part of frame length

A reserved 2-bit field. The semantics of these bits are undefined and the bits MUST remain unset when sending and MUST be ignored when receiving (draft-09, section 4.1)

header compression error

Recently we have built some HPACK test cases https://github.com/Jxck/hpack-test-case
I'd like to add node-http2 compressor to there. While doing that, I found a bug in HeaderTable.prototype._enforceLimit. The code you should look at is:

droppedEntries[droppedEntries] = dropped;

droppedEntries is an array and stores the dropped entries. But the above code sets itself as index, which is apparently a bug.

I suspect that it is dropPoint, but I leave the fix for you. (I'm not really Nodejs guy)

The failed testcase is https://github.com/Jxck/hpack-test-case/blob/master/nghttp2/story_20.json When encoded by node-http2 compressor, at case #37 (1-based), it emits 2 empty name/value pairs.

PING frame with a length field value other than 8 must raise FRAME_SIZE_ERROR

Receipt of a PING frame with a length field value other than 8 MUST be treated as a connection error of type FRAME_SIZE_ERROR instead of PROTOCOL_ERROR (draft-09, section 6.7)

Sending frames on already closed stream should raise RST_STREAM

An endpoint MUST NOT send frames on a closed stream. An endpoint that receives any frame after receiving a RST_STREAM MUST treat that as a stream error of type STREAM_CLOSED instead of sending GOAWAY frame (draft-09, section 5.1)

Unknown frame types must be ignored

Implementations MUST ignore frames of unsupported or unrecognized types (draft-09, section 4.1). Now endpoint fails when receives incoming frame with unknown frame type in function readCommonHeader.

Sending BLOCKED frame

Use simple-streams internally for data flow