WebSocket Client & Server Implementation for Node

Overview

This is a (mostly) pure JavaScript implementation of the WebSocket protocol versions 8 and 13 for Node. There are some example client and server applications that implement various interoperability testing protocols in the "test/scripts" folder.

Documentation

You can read the full API documentation in the docs folder.

Changelog

Current Version: 1.0.34 - Release 2021-04-14

• Updated browser shim to use the native globalThis property when available. See this MDN page for context. Resolves #415

View the full changelog

Browser Support

All current browsers are fully* supported.

• Firefox 7-9 (Old) (Protocol Version 8)
• Firefox 10+ (Protocol Version 13)
• Chrome 14,15 (Old) (Protocol Version 8)
• Chrome 16+ (Protocol Version 13)
• Internet Explorer 10+ (Protocol Version 13)
• Safari 6+ (Protocol Version 13)

(Not all W3C WebSocket features are supported by browsers. More info in the Full API documentation)

Benchmarks

There are some basic benchmarking sections in the Autobahn test suite. I've put up a benchmark page that shows the results from the Autobahn tests run against AutobahnServer 0.4.10, WebSocket-Node 1.0.2, WebSocket-Node 1.0.4, and ws 0.3.4.

(These benchmarks are quite a bit outdated at this point, so take them with a grain of salt. Anyone up for running new benchmarks? I'll link to your report.)

Autobahn Tests

The very complete Autobahn Test Suite is used by most WebSocket implementations to test spec compliance and interoperability.

• View Server Test Results

Installation

In your project root:

$ npm install websocket

Then in your code:

1var WebSocketServer = require('websocket').server;
2var WebSocketClient = require('websocket').client;
3var WebSocketFrame  = require('websocket').frame;
4var WebSocketRouter = require('websocket').router;
5var W3CWebSocket = require('websocket').w3cwebsocket;

Current Features:

• Licensed under the Apache License, Version 2.0
• Protocol version "8" and "13" (Draft-08 through the final RFC) framing and handshake
• Can handle/aggregate received fragmented messages
• Can fragment outgoing messages
• Router to mount multiple applications to various path and protocol combinations
• TLS supported for outbound connections via WebSocketClient
• TLS supported for server connections (use https.createServer instead of http.createServer)
  • Thanks to pors for confirming this!
• Cookie setting and parsing
• Tunable settings
  • Max Receivable Frame Size
  • Max Aggregate ReceivedMessage Size
  • Whether to fragment outgoing messages
  • Fragmentation chunk size for outgoing messages
  • Whether to automatically send ping frames for the purposes of keepalive
  • Keep-alive ping interval
  • Whether or not to automatically assemble received fragments (allows application to handle individual fragments directly)
  • How long to wait after sending a close frame for acknowledgment before closing the socket.
• W3C WebSocket API for applications running on both Node and browsers (via the W3CWebSocket class).

Known Issues/Missing Features:

• No API for user-provided protocol extensions.

Usage Examples

Server Example

Here's a short example showing a server that echos back anything sent to it, whether utf-8 or binary.

1#!/usr/bin/env node
2var WebSocketServer = require('websocket').server;
3var http = require('http');
4
5var server = http.createServer(function(request, response) {
6    console.log((new Date()) + ' Received request for ' + request.url);
7    response.writeHead(404);
8    response.end();
9});
10server.listen(8080, function() {
11    console.log((new Date()) + ' Server is listening on port 8080');
12});
13
14wsServer = new WebSocketServer({
15    httpServer: server,
16    // You should not use autoAcceptConnections for production
17    // applications, as it defeats all standard cross-origin protection
18    // facilities built into the protocol and the browser.  You should
19    // *always* verify the connection's origin and decide whether or not
20    // to accept it.
21    autoAcceptConnections: false
22});
23
24function originIsAllowed(origin) {
25  // put logic here to detect whether the specified origin is allowed.
26  return true;
27}
28
29wsServer.on('request', function(request) {
30    if (!originIsAllowed(request.origin)) {
31      // Make sure we only accept requests from an allowed origin
32      request.reject();
33      console.log((new Date()) + ' Connection from origin ' + request.origin + ' rejected.');
34      return;
35    }
36    
37    var connection = request.accept('echo-protocol', request.origin);
38    console.log((new Date()) + ' Connection accepted.');
39    connection.on('message', function(message) {
40        if (message.type === 'utf8') {
41            console.log('Received Message: ' + message.utf8Data);
42            connection.sendUTF(message.utf8Data);
43        }
44        else if (message.type === 'binary') {
45            console.log('Received Binary Message of ' + message.binaryData.length + ' bytes');
46            connection.sendBytes(message.binaryData);
47        }
48    });
49    connection.on('close', function(reasonCode, description) {
50        console.log((new Date()) + ' Peer ' + connection.remoteAddress + ' disconnected.');
51    });
52});

Client Example

This is a simple example client that will print out any utf-8 messages it receives on the console, and periodically sends a random number.

This code demonstrates a client in Node.js, not in the browser

1#!/usr/bin/env node
2var WebSocketClient = require('websocket').client;
3
4var client = new WebSocketClient();
5
6client.on('connectFailed', function(error) {
7    console.log('Connect Error: ' + error.toString());
8});
9
10client.on('connect', function(connection) {
11    console.log('WebSocket Client Connected');
12    connection.on('error', function(error) {
13        console.log("Connection Error: " + error.toString());
14    });
15    connection.on('close', function() {
16        console.log('echo-protocol Connection Closed');
17    });
18    connection.on('message', function(message) {
19        if (message.type === 'utf8') {
20            console.log("Received: '" + message.utf8Data + "'");
21        }
22    });
23    
24    function sendNumber() {
25        if (connection.connected) {
26            var number = Math.round(Math.random() * 0xFFFFFF);
27            connection.sendUTF(number.toString());
28            setTimeout(sendNumber, 1000);
29        }
30    }
31    sendNumber();
32});
33
34client.connect('ws://localhost:8080/', 'echo-protocol');

Client Example using the W3C WebSocket API

Same example as above but using the W3C WebSocket API.

1var W3CWebSocket = require('websocket').w3cwebsocket;
2
3var client = new W3CWebSocket('ws://localhost:8080/', 'echo-protocol');
4
5client.onerror = function() {
6    console.log('Connection Error');
7};
8
9client.onopen = function() {
10    console.log('WebSocket Client Connected');
11
12    function sendNumber() {
13        if (client.readyState === client.OPEN) {
14            var number = Math.round(Math.random() * 0xFFFFFF);
15            client.send(number.toString());
16            setTimeout(sendNumber, 1000);
17        }
18    }
19    sendNumber();
20};
21
22client.onclose = function() {
23    console.log('echo-protocol Client Closed');
24};
25
26client.onmessage = function(e) {
27    if (typeof e.data === 'string') {
28        console.log("Received: '" + e.data + "'");
29    }
30};

Request Router Example

For an example of using the request router, see libwebsockets-test-server.js in the test folder.

Resources

A presentation on the state of the WebSockets protocol that I gave on July 23, 2011 at the LA Hacker News meetup. WebSockets: The Real-Time Web, Delivered