Added doc and test case for connection.headers

Author: sitegui

Connection.js

@@ -45,6 +45,7 @@ function Connection(socket, parentOrUrl, callback) {
 	this.frameBuffer = null // string for text frames and InStream for binary frames
 	this.outStream = null // current allocated OutStream object for sending binary frames
 	this.key = null // the Sec-WebSocket-Key header
+	this.headers = {} // read only map of header names and values. Header names are lower-cased
 
 	// Set listeners
 	socket.on('readable', function () {
@@ -244,14 +245,31 @@ Connection.prototype.startHandshake = function () {
 	this.socket.write(str)
 }
 
+/**
+ * Read headers from HTTP protocol
+ * Update the Connection#headers property
+ * @param {string[]} lines one for each '\r\n'-separated HTTP request line
+ */
+Connection.prototype.readHeaders = function (lines) {
+	var i, match
+
+	// Extract all headers
+	// Ignore bad-formed lines and ignore the first line (HTTP header)
+	for (i = 1; i < lines.length; i++) {
+		if ((match = lines[i].match(/^([a-z-]+): (.+)$/i))) {
+			this.headers[match[1].toLowerCase()] = match[2]
+		}
+	}
+}
+
 /**
  * Process and check a handshake answered by a server
  * @param {string[]} lines one for each '\r\n'-separated HTTP request line
  * @returns {boolean} if the handshake was sucessful. If not, the connection must be closed
  * @private
  */
 Connection.prototype.checkHandshake = function (lines) {
-	var headers, i, temp, key, sha1
+	var key, sha1
 
 	// First line
 	if (lines.length < 4) {
@@ -262,30 +280,20 @@ Connection.prototype.checkHandshake = function (lines) {
 	}
 
 	// Extract all headers
-	headers = {}
-	for (i = 1; i < lines.length; i++) {
-		if (!lines[i].trim()) {
-			continue
-		}
-		temp = lines[i].match(/^([a-z-]+): (.+)$/i)
-		if (!temp) {
-			return false
-		}
-		headers[temp[1].toLowerCase()] = temp[2]
-	}
+	this.readHeaders(lines)
 
 	// Validate necessary headers
-	if (!('upgrade' in headers) ||
-		!('sec-websocket-accept' in headers) ||
-		!('connection' in headers)) {
+	if (!('upgrade' in this.headers) ||
+		!('sec-websocket-accept' in this.headers) ||
+		!('connection' in this.headers)) {
 		return false
 	}
-	if (headers.upgrade.toLowerCase() !== 'websocket' ||
-		headers.connection.toLowerCase().split(', ').indexOf('upgrade') === -1) {
+	if (this.headers.upgrade.toLowerCase() !== 'websocket' ||
+		this.headers.connection.toLowerCase().split(', ').indexOf('upgrade') === -1) {
 		return false
 	}
-	key = headers['sec-websocket-accept']
-	this.headers = headers
+	key = this.headers['sec-websocket-accept']
+
 	// Check the key
 	sha1 = crypto.createHash('sha1')
 	sha1.end(this.key + '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')
@@ -302,7 +310,7 @@ Connection.prototype.checkHandshake = function (lines) {
  * @private
  */
 Connection.prototype.answerHandshake = function (lines) {
-	var path, headers, i, temp, key, sha1
+	var path, key, sha1
 
 	// First line
 	if (lines.length < 6) {
@@ -315,32 +323,22 @@ Connection.prototype.answerHandshake = function (lines) {
 	this.path = path[1]
 
 	// Extract all headers
-	headers = {}
-	for (i = 1; i < lines.length; i++) {
-		if (!lines[i].trim()) {
-			continue
-		}
-		temp = lines[i].match(/^([a-z-]+): (.+)$/i)
-		if (!temp) {
-			return false
-		}
-		headers[temp[1].toLowerCase()] = temp[2]
-	}
+	this.readHeaders(lines)
 
 	// Validate necessary headers
-	if (!('host' in headers) || !('sec-websocket-key' in headers)) {
+	if (!('host' in this.headers) || !('sec-websocket-key' in this.headers)) {
 		return false
 	}
-	if (headers.upgrade.toLowerCase() !== 'websocket' ||
-		headers.connection.toLowerCase().split(', ').indexOf('upgrade') === -1) {
+	if (this.headers.upgrade.toLowerCase() !== 'websocket' ||
+		this.headers.connection.toLowerCase().split(', ').indexOf('upgrade') === -1) {
 		return false
 	}
-	if (headers['sec-websocket-version'] !== '13') {
+	if (this.headers['sec-websocket-version'] !== '13') {
 		return false
 	}
 
-	this.key = headers['sec-websocket-key']
-	this.headers = headers
+	this.key = this.headers['sec-websocket-key']
+
 	// Build and send the response
 	sha1 = crypto.createHash('sha1')
 	sha1.end(this.key + '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')
@@ -521,4 +519,4 @@ Connection.prototype.processCloseFrame = function (payload) {
 	this.socket.write(frame.createCloseFrame(code, reason, !this.server))
 	this.readyState = this.CLOSED
 	this.emit('close', code, reason)
-}
+}

README.md

@@ -132,6 +132,9 @@ Stores the OutStream object returned by connection.beginBinary(). null if there
 ## connection.path
 For a connection accepted by a server, it is a string representing the path to which the connection was made (example: "/chat"). null otherwise
 
+## connection.headers
+Read only map of header names and values. Header names are lower-cased
+
 ## Event: 'close(code, reason)'
 Emitted when the connection is closed by any side
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nodejs-websocket",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"author": "Sitegui <sitegui@sitegui.com.br>",
 	"description": "Basic server&client approach to websocket (text and binary frames)",
 	"main": "./index.js",

test/test.js

@@ -104,6 +104,15 @@ describe('text frames', function () {
 		// The server do nothing in this case
 		getServer()
 	})
+
+	it('should expose the headers', function () {
+		var client = getClient()
+
+		// Send a string and wait
+		client.headers.should.have.property('upgrade', 'websocket')
+		client.headers.should.have.property('connection', 'Upgrade')
+		client.headers.should.have.property('sec-websocket-accept')
+	})
 })
 
 function getClient() {