Compare commits

...

135 Commits

Author SHA1 Message Date
James Coglan c68b3fdc46 Remove the websocket-driver submodule. 2013-05-04 20:45:26 +01:00
James Coglan 827af89809 Refer to 3rd 'upgrade' argument as 'body' instead of 'head'. 2013-05-04 17:37:53 +01:00
James Coglan 0d503a31e3 Return a normal HTTP response if the request is not a WebSocket in the documentation. 2013-05-04 17:33:57 +01:00
James Coglan 99fa7a57ca Various bits of stream-related refactoring. 2013-05-04 17:30:07 +01:00
James Coglan b0b39b8325 websocket-protocol is now websocket-driver. 2013-05-04 16:43:03 +01:00
James Coglan 77ee71c678 A few updates to the readme. 2013-05-04 15:09:45 +01:00
James Coglan fc759a66e9 s/this/self/ because otherwise error dispatching doesn't work. 2013-05-02 01:26:16 +01:00
James Coglan 459499d6d6 Expose parser error events to the user. 2013-05-02 00:12:56 +01:00
James Coglan 30d3eda575 Don't return anything from EventTarget methods. 2013-05-01 09:07:55 +01:00
James Coglan 699c023286 Turn EventTarget into a proxy to EventEmitter since classes are now Streams. 2013-05-01 08:57:53 +01:00
James Coglan 9ff5d28799 Implement EventSource as a writable stream. 2013-05-01 08:50:27 +01:00
James Coglan 43bd4dceb3 Change port used for tests. 2013-05-01 01:14:51 +01:00
James Coglan 971968be85 Rename supportedProtos to protocols. 2013-05-01 01:03:27 +01:00
James Coglan 2a2b7dfb11 Bump websocket-protocol. 2013-05-01 01:00:14 +01:00
James Coglan 83925f68d3 The protocol library now uses a version property instead of a getVersion() method. 2013-05-01 00:56:23 +01:00
James Coglan ee3212fada Implement the read/write stream interface on the API class. 2013-05-01 00:32:14 +01:00
James Coglan 789759bf07 Move most WebSocket logic into the API class so that the server and client classes just deal with getting a parser and setting up an IO stream. 2013-05-01 00:14:05 +01:00
James Coglan 3baa12600a Write the request body to the IO stream before piping the request socket in. 2013-04-30 23:48:11 +01:00
James Coglan 339cc7ad1c Bump websocket-protocol module and support legacy stream interface. 2013-04-30 23:36:54 +01:00
James Coglan fdd5cc6db2 Migrate to new protocol event API. 2013-04-30 09:07:06 +01:00
James Coglan 36d4e053d8 Bump the websocket-protocol submodule. 2013-04-29 22:35:28 +01:00
James Coglan 347e5df9a2 Bump the websocket-protocol submodule. 2013-04-29 21:51:58 +01:00
James Coglan 96d31cf694 Remove the hixie protocol handlers, they're now in websocket-protocol. 2013-04-29 21:45:03 +01:00
James Coglan 4ccd6f5a59 Bump the websocket-protocol submodule. 2013-04-29 21:36:46 +01:00
James Coglan 56f9b8ec4d Write the head to the handler so that draft-76 works. 2013-04-29 20:47:03 +01:00
James Coglan 217b32c383 Bump the websocket-protocol submodule. 2013-04-29 20:28:05 +01:00
James Coglan 6571e070a0 Remove some unneeded test code. 2013-04-29 19:08:38 +01:00
James Coglan 7e5d85278d Fix TCP error-catching. We should probably fix this in websocket-protocol instead, maybe. 2013-04-29 00:59:42 +01:00
James Coglan 178b2eebde Reinstate the exported Client. 2013-04-29 00:46:16 +01:00
James Coglan e6dd7b0749 Remove old Hybi parsers and update websocket-protocol submodule. 2013-04-29 00:20:01 +01:00
James Coglan ad4ca36a8c Move protocol handlers into a submodule. 2013-04-28 19:08:10 +01:00
James Coglan 13e27bdc3b Update Node versions for Travis. 2013-04-28 18:56:32 +01:00
James Coglan 62a0c7597f First steps toward streaming I/O-independent parsing. Implement the Hybi and Client protocol handlers as stateful protcol drivers with two duplex streams, one for messages and one for I/O. 2013-04-28 18:55:58 +01:00
James Coglan 78f8bfb26b Remove parser specs. 2013-04-28 14:01:28 +01:00
James Coglan 99aacf67a5 Bump copyright date. 2013-02-15 00:02:57 +00:00
James Coglan 1a6cdd3e43 Bump version to 0.4.4. 2013-02-14 22:40:48 +00:00
James Coglan 0e2417cd51 Change name used in Autobahn tests. 2013-02-14 22:39:13 +00:00
James Coglan 86f882f189 Return early rather than have an else-clause. 2013-02-10 23:41:37 +00:00
James Coglan 87f1abad08 s/close/finalize/ -- I missed one rename in the last commit. 2012-12-24 16:43:41 +00:00
James Coglan b86f505441 If WebSocket.close() is called without asking for an ack, then don't return if we're in the CLOSING state. This can happen if one peer sends a closing frame and the other peer terminates TCP before sending the reply, and as currently implemented this will no emit a close event or end the Node stream. 2012-12-24 16:37:57 +00:00
James Coglan 14a1a7372d Use progress bar using Autobahn client tests. 2012-12-23 18:25:50 +00:00
James Coglan ee22f75959 Remove trailing whitespace. 2012-12-22 23:13:04 +00:00
James Coglan 7b63baa5a6 Fix specs on v0.9. 2012-12-22 23:12:08 +00:00
James Coglan 0dc749e565 Merge pull request #18 from gsoltis/master
Fix for closing a socket in the CONNECTING state
2012-10-15 11:54:53 -07:00
Greg Soltis 3280f38c27 Fix check of readyState for immediate close 2012-10-15 11:34:44 -07:00
James Coglan 64b52a0be2 Update Node versions for Travis. 2012-10-13 17:02:07 +01:00
James Coglan bd6e89f290 If close() is called in the CONNECTING readyState, then close the TCP connection immediately without waiting for the handshake to complete. 2012-10-13 16:59:58 +01:00
James Coglan f50de64532 Update changelog. 2012-07-09 08:58:00 +01:00
James Coglan d071ec3acd Check that incoming requests have an output stream before doing anything with it. 2012-07-08 20:30:53 +01:00
James Coglan 59fd729a03 Bump version to 0.4.3. 2012-07-01 18:15:01 +01:00
James Coglan b458959e6a Update Node versions for Travis. 2012-07-01 18:12:54 +01:00
James Coglan 7f18af7c90 Use Connection:close on EventSource connections. 2012-05-21 19:41:26 +01:00
James Coglan 680d8fc759 Remove an expensive test. 2012-05-21 19:37:40 +01:00
James Coglan 90d039e371 Bump version to 0.4.2. 2012-04-06 18:57:29 +01:00
James Coglan b42cdf741d Add error code 1011. 2012-04-06 13:52:21 +01:00
James Coglan bd7c52dfa2 Use / as the default path if the client URI has no path. 2012-04-01 22:57:16 +01:00
James Coglan adee8ba51c Bump version to 0.4.1. 2012-02-26 19:00:04 +00:00
James Coglan 3675cfb798 Treat anything but a Buffer as a text message in WebSocket#send. 2012-02-25 09:49:53 +00:00
James Coglan 1222308201 Return boolean from EventSource.send(). 2012-02-16 23:15:16 +00:00
James Coglan 8c9ae84740 Treat numbers as strings when passed to Socket.send(). 2012-02-16 23:09:29 +00:00
James Coglan d404c78c46 Add items to .npmignore. 2012-02-13 12:43:12 +00:00
James Coglan a6e2fe2aaa Bump version to 0.4.0. 2012-02-13 09:15:57 +00:00
James Coglan 8f71ec1f8b Set EventSource readyState during constructor and attach pings and event listeners after sending handshake. 2012-02-13 00:26:43 +00:00
James Coglan 74b76e56b7 Only send ping messages for EventSource if the user specifies an interval, for symmetry with WebSocket. 2012-02-12 23:59:20 +00:00
James Coglan c958c5ead9 Don't send a message on connect from the server. 2012-02-12 23:54:03 +00:00
James Coglan faa1f11c28 Clean up ping code. 2012-02-11 14:06:43 +00:00
James Coglan a9659df7d8 Set readyState to OPEN as soon as possible. 2012-02-11 13:36:12 +00:00
James Coglan fe4314e62b Revert accidental change to ws.html. 2012-02-11 12:32:51 +00:00
James Coglan 8523605f88 Document return value of WebSocket.ping(). 2012-02-11 12:10:39 +00:00
James Coglan 25794989f0 Push ping logic down into HybiParser. 2012-02-11 12:07:40 +00:00
James Coglan 29cae88d2c Provide a default value (empty string) for WebSocket ping messages. 2012-02-11 12:02:04 +00:00
James Coglan e6c03b7629 Add a ping() interface to server-side WebSocket and EventSource connections. 2012-02-11 11:59:13 +00:00
James Coglan d18a818699 Do not buffer send() calls during the CONNECTING stage of WebSocket clients -- browsers throw an error in this case. 2012-02-11 11:30:28 +00:00
James Coglan a48333ee1b Node 0.5 is not available on Travis. 2012-02-11 11:23:37 +00:00
James Coglan 6de9e01e69 Buffer calls to ws.send() until the handshake is completed. 2012-02-11 11:22:28 +00:00
James Coglan 51d5978283 Pass options object to tls.connect or it hangs on Node 0.7. 2012-02-08 22:44:04 +00:00
James Coglan a2b2559bd6 Add npm test script to package.json. 2012-02-08 22:26:00 +00:00
James Coglan c3bf5e9fa8 Fix client connection error detection on Node 0.7. 2012-02-08 22:25:44 +00:00
James Coglan ce5c6015b3 Add Travis CI configuration. 2012-02-08 22:09:09 +00:00
James Coglan 8d860a83d9 Tiny formatting change. 2012-02-07 23:42:19 +00:00
James Coglan a8ab367a0f Provide usable and accurate (HAProxy-safe) onopen event on the server side. 2012-02-07 23:39:42 +00:00
James Coglan f0678e6c91 Bump version to 0.3.1. 2012-01-16 20:19:26 +00:00
James Coglan ce0f81c8d5 Call setNoDelay(true) on sockets. 2012-01-16 20:18:23 +00:00
James Coglan e2090ce019 Bump version to 0.3.0. 2012-01-13 21:41:29 +00:00
James Coglan 22a3507dad Correct EventSource error handler. 2012-01-13 21:24:54 +00:00
James Coglan 3ba69e4242 Correct variable name in WebSocket example. 2012-01-12 22:32:52 +00:00
James Coglan cc3581fd0c Reorder handlers in example server. 2012-01-12 20:18:00 +00:00
James Coglan 3488318ae6 Document the EventSource API. 2012-01-12 20:12:35 +00:00
James Coglan 91eb2642ee Store output socket as an instance variable in EventSource. 2012-01-12 19:53:06 +00:00
James Coglan 20dd83257a Implement EventSource connection handler. 2012-01-12 19:48:59 +00:00
James Coglan c82b59259f Remove some text about client versions from the README. 2012-01-09 01:52:58 +00:00
James Coglan 727aba743c Correct readme on default value of WebSocket#protocol. 2011-12-21 19:45:28 +00:00
James Coglan 0aac24bece Update repository location. 2011-12-21 17:05:33 +00:00
James Coglan 4c3eaf8141 Bump version to 0.2.0, add changelog. 2011-12-21 01:28:20 +00:00
James Coglan 0b53267717 protocol property should be '' if not set. 2011-12-21 01:19:39 +00:00
James Coglan bdb0de2cfa Draft-75/76 frames with length headers should be ignored. 2011-12-20 19:44:07 +00:00
James Coglan 6704d33859 Implement the full framing interpreter for draft-75/76, including closing frames for 76. 2011-12-19 22:59:08 +00:00
James Coglan 4240b6bc27 Test that parsers are not sensitive to how data is split across packets. 2011-12-19 21:36:49 +00:00
James Coglan afdf6c223c Change version strings. 2011-12-19 21:25:53 +00:00
James Coglan 2782990fe3 Rename Protocol8Parser to HybiParser. 2011-12-19 21:25:19 +00:00
James Coglan 421f4660e5 Don't use map() to generate masks. 2011-12-19 10:12:26 +00:00
James Coglan 9c1e260784 When client handshake fails, close with the right code and reason. 2011-12-19 00:14:06 +00:00
James Coglan 1ba9b8586a Refactor subprotocol documentation. 2011-12-18 16:16:55 +00:00
James Coglan 05bc759af6 Make protocol vaidation a little more strict. 2011-12-18 16:09:36 +00:00
James Coglan e1aac5db02 Switch client to Sec-WebSocket-Version: 13. 2011-12-18 16:05:10 +00:00
James Coglan c751d96b8b Document subprotocol negotiation. 2011-12-18 16:04:23 +00:00
James Coglan fa2aff1387 Implement client-side subprotocol validation, and expose the protocol property. 2011-12-18 15:57:24 +00:00
James Coglan ea635db3f4 Merge branch 'master' into subprotocols 2011-12-18 15:37:05 +00:00
James Coglan b129b447a2 Refactor masking code. 2011-12-18 11:52:47 +00:00
James Coglan 390882f720 Change package description. 2011-12-18 09:20:56 +00:00
James Coglan 5a0c941075 Explicitly return null where parser methods hit an error. 2011-12-17 19:23:56 +00:00
James Coglan f5a78efcfd Extract 255 into a constant. 2011-12-17 19:22:46 +00:00
James Coglan f0f0bfc951 Inline draft-75 parsing function. 2011-12-17 17:23:17 +00:00
James Coglan 48dfb9578c Merge branch 'master' into subprotocols
Conflicts:
	lib/faye/websocket.js
	lib/faye/websocket/protocol8_parser.js
2011-12-17 15:37:54 +00:00
James Coglan 15f1b4df99 Remove benchmark page. 2011-12-17 15:20:30 +00:00
James Coglan 5635baf3a7 Don't skip any Autobahn tests since they run fast enough now. 2011-12-17 15:13:28 +00:00
James Coglan 2fa34ef097 Prevent stack overflows while parsing. 2011-12-17 15:13:09 +00:00
James Coglan 06f4c51a5b Refactor Protocol8 parser to read in chunks rather than one byte at a time. 2011-12-17 14:34:22 +00:00
James Coglan 3fa6e43ca9 Move Protocol8Parser.Handshake into its own file. 2011-12-17 13:30:05 +00:00
James Coglan a138004ec3 Don't pass TCP socket in when constructing a parser. 2011-12-17 03:06:40 +00:00
James Coglan d295047393 Decouple TCP sockets from parsers. 2011-12-17 01:41:34 +00:00
James Coglan 6f1bc69cc0 Remove an unneeded local var. 2011-12-16 23:04:23 +00:00
James Coglan c2ad20e226 Make Protocol8's frame() method much faster. 2011-12-16 23:03:23 +00:00
James Coglan 880398ff29 Merge remote branch 'majek/issue7' 2011-12-16 21:12:51 +00:00
James Coglan 0ea03585f9 Add benchmarking page. 2011-12-16 21:11:23 +00:00
James Coglan 918f86f58d Inline some parsing methods to improve performance. 2011-12-16 16:45:27 +00:00
Marek Majkowski 2f4f1cdc8f Fix #7 - random values should be 0...255 inclusive. 2011-12-16 15:07:20 +00:00
James Coglan 2dbac35b15 Only send Sec-WebSocket-Protocol response if there is a matching protocol available. 2011-12-15 20:05:03 +00:00
James Coglan 430b8ab7df Formatting tweaks. 2011-12-15 19:59:28 +00:00
James Coglan 283b13b617 Initial support for user-defined subprotocol negotiation on the server side. 2011-12-15 00:33:23 +00:00
James Coglan 19da8de414 Bump version to 0.1.2. 2011-12-05 09:39:40 +00:00
James Coglan 85ddb3f3dc Remove some comments. 2011-12-05 09:38:10 +00:00
James Coglan 7e2461e153 Fix draft-76 sockets when running behind HAProxy. 2011-12-04 21:15:24 +00:00
James Coglan ca3571f103 Don't do so many writes. 2011-12-03 21:37:38 +00:00
James Coglan 27f8f9a0f2 Detect closed sockets on the server side. 2011-12-02 10:00:25 +00:00
24 changed files with 915 additions and 1180 deletions
+2
View File
@@ -1,4 +1,6 @@
.git
.gitignore
.npmignore
.redcar
.travis.yml
node_modules
+8
View File
@@ -0,0 +1,8 @@
language: node_js
node_js:
- "0.6"
- "0.8"
- "0.10"
- "0.11"
+62
View File
@@ -0,0 +1,62 @@
### 0.4.4 / 2013-02-14
* Emit the `close` event if TCP is closed before CLOSE frame is acked
### 0.4.3 / 2012-07-09
* Add `Connection: close` to EventSource response
* Handle situations where `request.socket` is undefined
### 0.4.2 / 2012-04-06
* Add WebSocket error code `1011`.
* Handle URLs with no path correctly by sending `GET /`
### 0.4.1 / 2012-02-26
* Treat anything other than a `Buffer` as a string when calling `send()`
### 0.4.0 / 2012-02-13
* Add `ping()` method to server-side `WebSocket` and `EventSource`
* Buffer `send()` calls until the draft-76 handshake is complete
* Fix HTTPS problems on Node 0.7
### 0.3.1 / 2012-01-16
* Call `setNoDelay(true)` on `net.Socket` objects to reduce latency
### 0.3.0 / 2012-01-13
* Add support for `EventSource` connections
### 0.2.0 / 2011-12-21
* Add support for `Sec-WebSocket-Protocol` negotiation
* Support `hixie-76` close frames and 75/76 ignored segments
* Improve performance of HyBi parsing/framing functions
* Decouple parsers from TCP and reduce write volume
### 0.1.2 / 2011-12-05
* Detect closed sockets on the server side when TCP connection breaks
* Make `hixie-76` sockets work through HAProxy
### 0.1.1 / 2011-11-30
* Fix `addEventListener()` interface methods
### 0.1.0 / 2011-11-27
* Initial release, based on WebSocket components from Faye
-119
View File
@@ -1,119 +0,0 @@
# faye-websocket
This is a robust, general-purpose WebSocket implementation extracted from the
[Faye](http://faye.jcoglan.com) project. It provides classes for easily building
WebSocket servers and clients in Node. It does not provide a server itself, but
rather makes it easy to handle WebSocket connections within an existing
[Node](http://nodejs.org/) application. It does not provide any abstraction
other than the standard [WebSocket API](http://dev.w3.org/html5/websockets/).
The server-side socket can process [draft-75](http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75),
[draft-76](http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76),
[hybi-07](http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07)
and later versions of the protocol. It selects protocol versions automatically,
supports both `text` and `binary` messages, and transparently handles `ping`,
`pong`, `close` and fragmented messages.
## Accepting WebSocket connections in Node
You can handle WebSockets on the server side by listening for HTTP Upgrade
requests, and creating a new socket for the request. This socket object exposes
the usual WebSocket methods for receiving and sending messages. For example this
is how you'd implement an echo server:
```js
var WebSocket = require('faye-websocket'),
http = require('http');
var server = http.createServer();
server.addListener('upgrade', function(request, socket, head) {
var ws = new WebSocket(request, socket, head);
ws.onmessage = function(event) {
ws.send(event.data);
};
ws.onclose = function(event) {
console.log('close', event.code, event.reason);
ws = null;
};
});
server.listen(8000);
```
## Using the WebSocket client
The client supports both the plain-text `ws` protocol and the encrypted `wss`
protocol, and has exactly the same interface as a socket you would use in a web
browser. On the wire it identifies itself as hybi-08, though it's compatible
with servers speaking later versions of the protocol, at least up to version 17.
```js
var WebSocket = require('faye-websocket'),
ws = new WebSocket.Client('ws://www.example.com/');
ws.onopen = function(event) {
console.log('open');
ws.send('Hello, world!');
};
ws.onmessage = function(event) {
console.log('message', event.data);
};
ws.onclose = function(event) {
console.log('close', event.code, event.reason);
ws = null;
};
```
## WebSocket API
The WebSocket API consists of several event handlers and a method for sending
messages.
* <b><tt>onopen</tt></b> fires when the socket connection is established. Event
has no attributes.
* <b><tt>onerror</tt></b> fires when the connection attempt fails. Event has no
attributes.
* <b><tt>onmessage</tt></b> fires when the socket receives a message. Event has
one attribute, <b><tt>data</tt></b>, which is either a `String` (for text
frames) or a `Buffer` (for binary frames).
* <b><tt>onclose</tt></b> fires when either the client or the server closes the
connection. Event has two optional attributes, <b><tt>code</tt></b> and
<b><tt>reason</tt></b>, that expose the status code and message sent by the
peer that closed the connection.
* <b><tt>send(message)</tt></b> accepts either a `String` or a `Buffer` and
sends a text or binary message over the connection to the other peer.
* <b><tt>close(code, reason)</tt></b> closes the connection, sending the given
status code and reason text, both of which are optional.
## License
(The MIT License)
Copyright (c) 2009-2011 James Coglan
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+259
View File
@@ -0,0 +1,259 @@
# faye-websocket
* Travis CI build: [![Build
status](https://secure.travis-ci.org/faye/faye-websocket-node.png)](http://travis-ci.org/faye/faye-websocket-node)
* Autobahn tests: [server](http://faye.jcoglan.com/autobahn/servers/),
[client](http://faye.jcoglan.com/autobahn/clients/)
This is a general-purpose WebSocket implementation extracted from the
[Faye](http://faye.jcoglan.com) project. It provides classes for easily
building WebSocket servers and clients in Node. It does not provide a server
itself, but rather makes it easy to handle WebSocket connections within an
existing [Node](http://nodejs.org/) application. It does not provide any
abstraction other than the standard [WebSocket
API](http://dev.w3.org/html5/websockets/).
It also provides an abstraction for handling
[EventSource](http://dev.w3.org/html5/eventsource/) connections, which are
one-way connections that allow the server to push data to the client. They are
based on streaming HTTP responses and can be easier to access via proxies than
WebSockets.
## Installation
```
$ npm install faye-websocket
```
## Handling WebSocket connections in Node
You can handle WebSockets on the server side by listening for HTTP Upgrade
requests, and creating a new socket for the request. This socket object exposes
the usual WebSocket methods for receiving and sending messages. For example this
is how you'd implement an echo server:
```js
var WebSocket = require('faye-websocket'),
http = require('http');
var server = http.createServer();
server.on('upgrade', function(request, socket, body) {
if (WebSocket.isWebSocket(request)) {
var ws = new WebSocket(request, socket, body);
ws.on('message', function(event) {
ws.send(event.data);
});
ws.on('close', function(event) {
console.log('close', event.code, event.reason);
ws = null;
});
}
});
server.listen(8000);
```
Note that under certain circumstances (notably a draft-76 client connecting
through an HTTP proxy), the WebSocket handshake will not be complete after you
call `new WebSocket()` because the server will not have received the entire
handshake from the client yet. In this case, calls to `ws.send()` will buffer
the message in memory until the handshake is complete, at which point any
buffered messages will be sent to the client.
If you need to detect when the WebSocket handshake is complete, you can use the
`onopen` event.
If the connection's protocol version supports it, you can call `ws.ping()` to
send a ping message and wait for the client's response. This method takes a
message string, and an optional callback that fires when a matching pong
message is received. It returns `true` iff a ping message was sent. If the
client does not support ping/pong, this method sends no data and returns
`false`.
```js
ws.ping('Mic check, one, two', function() {
// fires when pong is received
});
```
## Using the WebSocket client
The client supports both the plain-text `ws` protocol and the encrypted `wss`
protocol, and has exactly the same interface as a socket you would use in a web
browser. On the wire it identifies itself as `hybi-13`.
```js
var WebSocket = require('faye-websocket'),
ws = new WebSocket.Client('ws://www.example.com/');
ws.on('open', function(event) {
console.log('open');
ws.send('Hello, world!');
});
ws.on('message', function(event) {
console.log('message', event.data);
});
ws.on('close', function(event) {
console.log('close', event.code, event.reason);
ws = null;
});
```
## Subprotocol negotiation
The WebSocket protocol allows peers to select and identify the application
protocol to use over the connection. On the client side, you can set which
protocols the client accepts by passing a list of protocol names when you
construct the socket:
```js
var ws = new WebSocket.Client('ws://www.example.com/', ['irc', 'amqp']);
```
On the server side, you can likewise pass in the list of protocols the server
supports after the other constructor arguments:
```js
var ws = new WebSocket(request, socket, body, ['irc', 'amqp']);
```
If the client and server agree on a protocol, both the client- and server-side
socket objects expose the selected protocol through the `ws.protocol` property.
## WebSocket API
Both server- and client-side `WebSocket` objects support the following API:
* <b>`on('open', function(event) {})`</b> fires when the socket connection is
established. Event has no attributes.
* <b>`on('message', function(event) {})`</b> fires when the socket receives a
message. Event has one attribute, <b>`data`</b>, which is either a `String`
(for text frames) or a `Buffer` (for binary frames).
* <b>`on('error', function(event) {})`</b> fires when there is a protocol error
due to bad data sent by the other peer. This event is purely informational,
you do not need to implement error recover.
* <b>`on('close', function(event) {})`</b> fires when either the client or the
server closes the connection. Event has two optional attributes,
<b>`code`</b> and <b>`reason`</b>, that expose the status code and message
sent by the peer that closed the connection.
* <b>`send(message)`</b> accepts either a `String` or a `Buffer` and sends a
text or binary message over the connection to the other peer.
* <b>`ping(message = '', function() {})`</b> sends a ping frame with an
optional message and fires the callback when a matching pong is received.
* <b>`close(code, reason)`</b> closes the connection, sending the given status
code and reason text, both of which are optional.
* <b>`version`</b> is a string containing the version of the `WebSocket`
protocol the connection is using.
* <b>`protocol`</b> is a string (which may be empty) identifying the
subprotocol the socket is using.
## Handling EventSource connections in Node
EventSource connections provide a very similar interface, although because they
only allow the server to send data to the client, there is no `onmessage` API.
EventSource allows the server to push text messages to the client, where each
message has an optional event-type and ID.
```js
var WebSocket = require('faye-websocket'),
EventSource = WebSocket.EventSource,
http = require('http');
var server = http.createServer();
server.on('request', function(request, response) {
if (EventSource.isEventSource(request)) {
var es = new EventSource(request, response);
console.log('open', es.url, es.lastEventId);
// Periodically send messages
var loop = setInterval(function() { es.send('Hello') }, 1000);
es.on('close', function() {
clearInterval(loop);
es = null;
});
} else {
// Normal HTTP request
response.writeHead(200, {'Content-Type': 'text/plain'});
response.end('Hello');
}
});
server.listen(8000);
```
The `send` method takes two optional parameters, `event` and `id`. The default
event-type is `'message'` with no ID. For example, to send a `notification`
event with ID `99`:
```js
es.send('Breaking News!', {event: 'notification', id: '99'});
```
The `EventSource` object exposes the following properties:
* <b>`url`</b> is a string containing the URL the client used to create the
EventSource.
* <b>`lastEventId`</b> is a string containing the last event ID received by the
client. You can use this when the client reconnects after a dropped
connection to determine which messages need resending.
When you initialize an EventSource with ` new EventSource()`, you can pass
configuration options after the `response` parameter. Available options are:
* <b>`retry`</b> is a number that tells the client how long (in seconds) it
should wait after a dropped connection before attempting to reconnect.
* <b>`ping`</b> is a number that tells the server how often (in seconds) to
send 'ping' packets to the client to keep the connection open, to defeat
timeouts set by proxies. The client will ignore these messages.
For example, this creates a connection that pings every 15 seconds and is
retryable every 10 seconds if the connection is broken:
```js
var es = new EventSource(request, response, {ping: 15, retry: 10});
```
You can send a ping message at any time by calling `es.ping()`. Unlike
WebSocket, the client does not send a response to this; it is merely to send
some data over the wire to keep the connection alive.
## License
(The MIT License)
Copyright (c) 2010-2013 James Coglan
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+15 -12
View File
@@ -1,41 +1,44 @@
var WebSocket = require('../lib/faye/websocket');
var WebSocket = require('../lib/faye/websocket'),
pace = require('pace');
var host = 'ws://localhost:9001',
agent = 'Faye (Node ' + process.version + ')',
agent = 'Node ' + process.version,
cases = 0,
skip = [247,248,249,250,251,252,253,254,255,
256,257,258,259,260,261,262,263,264];
skip = [];
var socket = new WebSocket.Client(host + '/getCaseCount');
var socket = new WebSocket.Client(host + '/getCaseCount'),
progress;
socket.onmessage = function(event) {
console.log('Total cases to run: ' + event.data);
cases = parseInt(event.data);
progress = pace(cases);
};
socket.onclose = function() {
var runCase = function(n) {
progress.op();
if (n > cases) {
socket = new WebSocket.Client(host + '/updateReports?agent=' + encodeURIComponent(agent));
socket.onclose = process.exit
socket.onclose = process.exit;
} else if (skip.indexOf(n) >= 0) {
runCase(n + 1);
} else {
console.log('Running test case #' + n + ' ...');
socket = new WebSocket.Client(host + '/runCase?case=' + n + '&agent=' + encodeURIComponent(agent));
socket.onmessage = function(event) {
socket.send(event.data);
};
socket.onclose = function() {
runCase(n + 1);
};
}
};
runCase(1);
};
+21
View File
@@ -0,0 +1,21 @@
defaults
mode http
timeout client 5s
timeout connect 5s
timeout server 5s
frontend all 0.0.0.0:3000
mode http
timeout client 120s
option forwardfor
option http-server-close
option http-pretend-keepalive
default_backend sockets
backend sockets
balance uri depth 2
timeout server 120s
server socket1 127.0.0.1:7000
+43 -16
View File
@@ -6,9 +6,47 @@ var WebSocket = require('../lib/faye/websocket'),
var port = process.argv[2] || 7000,
secure = process.argv[3] === 'ssl';
var upgradeHandler = function(request, socket, head) {
var ws = new WebSocket(request, socket, head, ['irc', 'xmpp'], {ping: 5});
console.log('open', ws.url, ws.version, ws.protocol);
ws.pipe(ws);
ws.onclose = function(event) {
console.log('close', event.code, event.reason);
ws = null;
};
};
var requestHandler = function(request, response) {
if (!WebSocket.EventSource.isEventSource(request))
return staticHandler(request, response);
var es = new WebSocket.EventSource(request, response),
time = parseInt(es.lastEventId, 10) || 0;
console.log('open', es.url, es.lastEventId);
var loop = setInterval(function() {
time += 1;
es.send('Time: ' + time);
setTimeout(function() {
if (es) es.send('Update!!', {event: 'update', id: time});
}, 1000);
}, 2000);
fs.createReadStream(__dirname + '/haproxy.conf').pipe(es);
es.onclose = function() {
clearInterval(loop);
console.log('close', es.url);
es = null;
};
};
var staticHandler = function(request, response) {
var path = request.url;
fs.readFile(__dirname + path, function(err, content) {
var status = err ? 404 : 200;
response.writeHead(status, {'Content-Type': 'text/html'});
@@ -22,20 +60,9 @@ var server = secure
key: fs.readFileSync(__dirname + '/../spec/server.key'),
cert: fs.readFileSync(__dirname + '/../spec/server.crt')
})
: http.createServer(staticHandler);
server.addListener('upgrade', function(request, socket, head) {
var ws = new WebSocket(request, socket, head);
console.log('open', ws.url, ws.version);
ws.onmessage = function(event) {
ws.send(event.data);
};
ws.onclose = function(event) {
console.log('close', event.code, event.reason);
ws = null;
};
});
: http.createServer();
server.on('request', requestHandler);
server.on('upgrade', upgradeHandler);
server.listen(port);
+39
View File
@@ -0,0 +1,39 @@
<!doctype html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8">
<title>EventSource test</title>
</head>
<body>
<h1>EventSource test</h1>
<ul></ul>
<script type="text/javascript">
var logger = document.getElementsByTagName('ul')[0],
socket = new EventSource('/');
var log = function(text) {
logger.innerHTML += '<li>' + text + '</li>';
};
socket.onopen = function() {
log('OPEN');
};
socket.onmessage = function(event) {
log('MESSAGE: ' + event.data);
};
socket.addEventListener('update', function(event) {
log('UPDATE(' + event.lastEventId + '): ' + event.data);
});
socket.onerror = function(event) {
log('ERROR: ' + event.message);
};
</script>
</body>
</html>
+23 -14
View File
@@ -5,31 +5,40 @@
<title>WebSocket test</title>
</head>
<body>
<h1>WebSocket test</h1>
<ul></ul>
<script type="text/javascript">
var logger = document.getElementsByTagName('ul')[0],
Socket = window.MozWebSocket || window.WebSocket,
socket = new Socket('ws://' + location.hostname + ':' + location.port + '/'),
protos = ['foo', 'bar', 'xmpp'],
socket = new Socket('ws://' + location.hostname + ':' + location.port + '/', protos),
index = 0;
socket.onopen = function() {
logger.innerHTML += '<li>OPEN</li>';
socket.send('Hello, world');
var log = function(text) {
logger.innerHTML += '<li>' + text + '</li>';
};
socket.addEventListener('message', function(event) {
logger.innerHTML += '<li>MESSAGE: ' + event.data + '</li>';
setTimeout(function() { socket.send(++index + ' ' + event.data) }, 2000);
socket.addEventListener('open', function() {
log('OPEN: ' + socket.protocol);
socket.send('Hello, world');
});
socket.onerror = function(event) {
log('ERROR: ' + event.message);
};
socket.onmessage = function(event) {
log('MESSAGE: ' + event.data);
setTimeout(function() { socket.send(++index + ' ' + event.data) }, 2000);
};
socket.onclose = function(event) {
logger.innerHTML += '<li>CLOSE: ' + event.code + ', ' + event.reason + '</li>';
log('CLOSE: ' + event.code + ', ' + event.reason);
};
</script>
</body>
</html>
+125
View File
@@ -0,0 +1,125 @@
var Stream = require('stream').Stream,
util = require('util'),
driver = require('websocket-driver'),
API = require('./websocket/api'),
EventTarget = require('./websocket/api/event_target'),
Event = require('./websocket/api/event');
var EventSource = function(request, response, options) {
this.writable = true;
options = options || {};
this._stream = response.socket;
this._ping = options.ping || this.DEFAULT_PING;
this._retry = options.retry || this.DEFAULT_RETRY;
var scheme = driver.isSecureRequest(request) ? 'https:' : 'http:';
this.url = scheme + '//' + request.headers.host + request.url;
this.lastEventId = request.headers['last-event-id'] || '';
this.readyState = API.CONNECTING;
var self = this;
if (!this._stream || !this._stream.writable) return;
process.nextTick(function() { self._open() });
this._stream.setTimeout(0);
this._stream.setNoDelay(true);
var handshake = 'HTTP/1.1 200 OK\r\n' +
'Content-Type: text/event-stream\r\n' +
'Cache-Control: no-cache, no-store\r\n' +
'Connection: close\r\n' +
'\r\n\r\n' +
'retry: ' + Math.floor(this._retry * 1000) + '\r\n\r\n';
this._write(handshake);
this._stream.on('drain', function() { self.emit('drain') });
if (this._ping)
this._pingTimer = setInterval(function() { self.ping() }, this._ping * 1000);
['error', 'end'].forEach(function(event) {
self._stream.on(event, function() { self.close() });
});
};
util.inherits(EventSource, Stream);
EventSource.isEventSource = function(request) {
if (request.method !== 'GET') return false;
var accept = (request.headers.accept || '').split(/\s*,\s*/);
return accept.indexOf('text/event-stream') >= 0;
};
var instance = {
DEFAULT_PING: 10,
DEFAULT_RETRY: 5,
_write: function(chunk) {
if (!this.writable) return false;
try {
return this._stream.write(chunk, 'utf8');
} catch (e) {
return false;
}
},
_open: function() {
if (this.readyState !== API.CONNECTING) return;
this.readyState = API.OPEN;
var event = new Event('open');
event.initEvent('open', false, false);
this.dispatchEvent(event);
},
write: function(message) {
return this.send(message);
},
end: function(message) {
if (message !== undefined) this.write(message);
this.close();
},
send: function(message, options) {
if (this.readyState > API.OPEN) return false;
message = String(message).replace(/(\r\n|\r|\n)/g, '$1data: ');
options = options || {};
var frame = '';
if (options.event) frame += 'event: ' + options.event + '\r\n';
if (options.id) frame += 'id: ' + options.id + '\r\n';
frame += 'data: ' + message + '\r\n\r\n';
return this._write(frame);
},
ping: function() {
return this._write(':\r\n\r\n');
},
close: function() {
if (this.readyState > API.OPEN) return false;
this.readyState = API.CLOSED;
this.writable = false;
if (this._pingTimer) clearInterval(this._pingTimer);
if (this._stream) this._stream.end();
var event = new Event('close');
event.initEvent('close', false, false);
this.dispatchEvent(event);
return true;
}
};
for (var method in instance) EventSource.prototype[method] = instance[method];
for (var key in EventTarget) EventSource.prototype[key] = EventTarget[key];
module.exports = EventSource;
+34 -57
View File
@@ -1,69 +1,46 @@
// API and protocol references:
// API references:
//
// * http://dev.w3.org/html5/websockets/
// * http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget
// * http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-event
// * http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75
// * http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76
// * http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-17
var Draft75Parser = require('./websocket/draft75_parser'),
Draft76Parser = require('./websocket/draft76_parser'),
Protocol8Parser = require('./websocket/protocol8_parser'),
API = require('./websocket/api');
var util = require('util'),
driver = require('websocket-driver'),
API = require('./websocket/api');
var getParser = function(request) {
var headers = request.headers;
return headers['sec-websocket-version']
? Protocol8Parser
: (headers['sec-websocket-key1'] && headers['sec-websocket-key2'])
? Draft76Parser
: Draft75Parser;
};
var WebSocket = function(request, socket, body, protocols, options) {
this._stream = socket;
this._ping = options && options.ping;
this._pingId = 0;
this._driver = driver.http(request, {protocols: protocols});
var isSecureConnection = function(request) {
if (request.headers['x-forwarded-proto']) {
return request.headers['x-forwarded-proto'] === 'https';
} else {
return (request.connection && request.connection.authorized !== undefined) ||
(request.socket && request.socket.secure);
}
};
var WebSocket = function(request, socket, head) {
this.request = request;
this._stream = request.socket;
var scheme = isSecureConnection(request) ? 'wss:' : 'ws:';
this.url = scheme + '//' + request.headers.host + request.url;
this.readyState = API.CONNECTING;
this.bufferedAmount = 0;
var Parser = getParser(request);
this._parser = new Parser(this, this._stream);
this._parser.handshakeResponse(head);
this.readyState = API.OPEN;
this.version = this._parser.getVersion();
var event = new API.Event('open');
event.initEvent('open', false, false);
this.dispatchEvent(event);
var self = this;
this._stream.addListener('data', function(data) {
self._parser.parse(data);
});
this._stream.addListener('close', function() {
self.close(1006, '', false);
});
this._stream.addListener('error', function() {});
if (!this._stream || !this._stream.writable) return;
var catchup = function() { self._stream.removeListener('data', catchup) };
this._stream.on('data', catchup);
this._stream.setTimeout(0);
this._stream.setNoDelay(true);
this._driver.io.write(body);
API.call(this);
['error', 'end'].forEach(function(event) {
this._stream.on(event, function() { self._finalize('', 1006) });
}, this);
this._driver.start();
};
util.inherits(WebSocket, API);
WebSocket.isWebSocket = function(request) {
return driver.isWebSocket(request);
};
var API = require('./websocket/api');
for (var key in API) WebSocket.prototype[key] = API[key];
WebSocket.WebSocket = WebSocket;
WebSocket.Client = require('./websocket/client');
WebSocket.EventSource = require('./eventsource');
WebSocket.Client = require('./websocket/client');
module.exports = WebSocket;
module.exports = WebSocket;
+114 -99
View File
@@ -1,108 +1,123 @@
var API = {
CONNECTING: 0,
OPEN: 1,
CLOSING: 2,
CLOSED: 3,
onopen: null,
onmessage: null,
onerror: null,
onclose: null,
receive: function(data) {
if (this.readyState !== API.OPEN) return false;
var event = new API.Event('message');
event.initEvent('message', false, false);
event.data = data;
var Stream = require('stream').Stream,
util = require('util'),
EventTarget = require('./api/event_target'),
Event = require('./api/event');
var API = function() {
this.readable = this.writable = true;
this.readyState = API.CONNECTING;
this.bufferedAmount = 0;
this.protocol = '';
this.url = this._driver.url;
this.version = this._driver.version;
var self = this;
this._driver.on('open', function(e) { self._open() });
this._driver.on('message', function(e) { self._receiveMessage(e.data) });
this._driver.on('close', function(e) { self._finalize(e.reason, e.code) });
this._driver.on('error', function(error) {
var event = new Event('error', {message: error.message});
event.initEvent('error', false, false);
self.dispatchEvent(event);
});
this.on('error', function() {});
this._driver.messages.on('drain', function() {
self.emit('drain');
});
if (this._ping)
this._pingTimer = setInterval(function() {
self._pingId += 1;
self.ping(self._pingId.toString());
}, this._ping * 1000);
this._stream.pipe(this._driver.io);
this._driver.io.pipe(this._stream);
};
util.inherits(API, Stream);
API.CONNECTING = 0;
API.OPEN = 1;
API.CLOSING = 2;
API.CLOSED = 3;
var instance = {
write: function(data) {
return this.send(data);
},
end: function(data) {
if (data !== undefined) this.send(data);
this.close();
},
pause: function() {
return this._driver.messages.pause();
},
resume: function() {
return this._driver.messages.resume();
},
send: function(data) {
if (this.readyState > API.OPEN) return false;
if (!(data instanceof Buffer)) data = String(data);
return this._driver.messages.write(data);
},
ping: function(message, callback) {
if (this.readyState > API.OPEN) return false;
return this._driver.ping(message, callback);
},
close: function() {
if (this.readyState === API.OPEN) this.readyState = API.CLOSING;
this._driver.close();
},
_open: function() {
if (this.readyState !== API.CONNECTING) return;
this.readyState = API.OPEN;
this.protocol = this._driver.protocol || '';
var event = new Event('open');
event.initEvent('open', false, false);
this.dispatchEvent(event);
},
send: function(data, type, errorType) {
if (this.readyState === API.CLOSED) return false;
return this._parser.frame(data, type, errorType);
_receiveMessage: function(data) {
if (this.readyState > API.OPEN) return false;
if (this.readable) this.emit('data', data);
var event = new Event('message', {data: data});
event.initEvent('message', false, false);
this.dispatchEvent(event);
},
close: function(code, reason, ack) {
if (this.readyState === API.CLOSING ||
this.readyState === API.CLOSED) return;
this.readyState = API.CLOSING;
var close = function() {
this.readyState = API.CLOSED;
this._stream.end();
var event = new API.Event('close', {code: code || 1000, reason: reason || ''});
event.initEvent('close', false, false);
this.dispatchEvent(event);
};
if (ack !== false) {
if (this._parser.close) this._parser.close(code, reason, close, this);
else close.call(this);
} else {
if (this._parser.close) this._parser.close(code, reason);
close.call(this);
}
},
addEventListener: function(eventType, listener, useCapture) {
this._listeners = this._listeners || {};
var list = this._listeners[eventType] = this._listeners[eventType] || [];
list.push(listener);
},
removeEventListener: function(eventType, listener, useCapture) {
if (!this._listeners || !this._listeners[eventType]) return;
if (!listener) {
delete this._listeners[eventType];
return;
}
var list = this._listeners[eventType],
i = list.length;
while (i--) {
if (listener !== list[i]) continue;
list.splice(i,1);
}
},
dispatchEvent: function(event) {
event.target = event.currentTarget = this;
event.eventPhase = API.Event.AT_TARGET;
if (this['on' + event.type])
this['on' + event.type](event);
if (!this._listeners || !this._listeners[event.type]) return;
this._listeners[event.type].forEach(function(listener) {
listener(event);
}, this);
_finalize: function(reason, code) {
if (this.readyState === API.CLOSED) return;
if (this._pingTimer) clearInterval(this._pingTimer);
if (this._stream) this._stream.end();
if (this.readable) this.emit('end');
this.readable = this.writable = false;
this.readyState = API.CLOSED;
var event = new Event('close', {code: code || 1000, reason: reason || ''});
event.initEvent('close', false, false);
this.dispatchEvent(event);
}
};
var Event = function(eventType, options) {
this.type = eventType;
for (var key in options)
this[key] = options[key];
};
Event.prototype.initEvent = function(eventType, canBubble, cancelable) {
this.type = eventType;
this.bubbles = canBubble;
this.cancelable = cancelable;
};
Event.prototype.stopPropagation = function() {};
Event.prototype.preventDefault = function() {};
Event.CAPTURING_PHASE = 1;
Event.AT_TARGET = 2;
Event.BUBBLING_PHASE = 3;
API.Event = Event;
for (var method in instance) API.prototype[method] = instance[method];
for (var key in EventTarget) API.prototype[key] = EventTarget[key];
module.exports = API;
+21
View File
@@ -0,0 +1,21 @@
var Event = function(eventType, options) {
this.type = eventType;
for (var key in options)
this[key] = options[key];
};
Event.prototype.initEvent = function(eventType, canBubble, cancelable) {
this.type = eventType;
this.bubbles = canBubble;
this.cancelable = cancelable;
};
Event.prototype.stopPropagation = function() {};
Event.prototype.preventDefault = function() {};
Event.CAPTURING_PHASE = 1;
Event.AT_TARGET = 2;
Event.BUBBLING_PHASE = 3;
module.exports = Event;
+29
View File
@@ -0,0 +1,29 @@
var Event = require('./event');
var EventTarget = {
onopen: null,
onmessage: null,
onerror: null,
onclose: null,
addEventListener: function(eventType, listener, useCapture) {
this.on(eventType, listener);
},
removeEventListener: function(eventType, listener, useCapture) {
this.removeListener(eventType, listener);
},
dispatchEvent: function(event) {
event.target = event.currentTarget = this;
event.eventPhase = Event.AT_TARGET;
if (this['on' + event.type])
this['on' + event.type](event);
this.emit(event.type, event);
}
};
module.exports = EventTarget;
+32 -68
View File
@@ -1,76 +1,40 @@
var API = require('./api'),
net = require('net'),
tls = require('tls');
var util = require('util'),
net = require('net'),
tls = require('tls'),
driver = require('websocket-driver'),
API = require('./api');
var Protocol8Parser = require('./protocol8_parser');
var Client = function(url, protocols, options) {
this.url = url;
this._uri = require('url').parse(url);
this._ping = options && options.ping;
this._pingId = 0;
this._driver = driver.client(url, {protocols: protocols});
var secure = (this._uri.protocol === 'wss:'),
onConnect = function() { self._driver.start() },
tlsOptions = {},
self = this;
if (options && options.verify === false) tlsOptions.rejectUnauthorized = false;
var connection = secure
? tls.connect(this._uri.port || 443, this._uri.hostname, tlsOptions, onConnect)
: net.createConnection(this._uri.port || 80, this._uri.hostname);
var Client = function(url) {
this.url = url;
this.uri = require('url').parse(url);
this.readyState = API.CONNECTING;
this.bufferedAmount = 0;
var secure = (this.uri.protocol === 'wss:'),
self = this,
onConnect = function() { self._onConnect() },
connection = secure
? tls.connect(this.uri.port || 443, this.uri.hostname, onConnect)
: net.createConnection(this.uri.port || 80, this.uri.hostname);
this._parser = new Protocol8Parser(this, connection, {masking: true});
this._stream = connection;
if (!secure) connection.addListener('connect', onConnect);
connection.addListener('data', function(data) {
self._onData(data);
});
connection.addListener('close', function() {
self.close(1006, '', false);
});
connection.addListener('error', function() {});
};
Client.prototype._onConnect = function() {
this._handshake = this._parser.createHandshake(this.uri);
this._message = [];
this._handshake.requestData();
};
this._stream.setTimeout(0);
this._stream.setNoDelay(true);
Client.prototype._onData = function(data) {
switch (this.readyState) {
case API.CONNECTING:
var bytes = this._handshake.parse(data);
for (var i = 0, n = bytes.length; i < n; i++)
this._message.push(bytes[i]);
if (!this._handshake.isComplete()) return;
if (this._handshake.isValid()) {
this.readyState = API.OPEN;
var event = new API.Event('open');
event.initEvent('open', false, false);
this.dispatchEvent(event);
this._parser.parse(this._message);
} else {
this.readyState = API.CLOSED;
var event = new API.Event('close');
event.initEvent('close', false, false);
this.dispatchEvent(event);
}
break;
case API.OPEN:
case API.CLOSING:
this._parser.parse(data);
}
};
if (!secure) this._stream.on('connect', onConnect);
for (var key in API) Client.prototype[key] = API[key];
API.call(this);
['error', 'end'].forEach(function(event) {
this._stream.on(event, function() { self._finalize('', 1006) });
}, this);
};
util.inherits(Client, API);
module.exports = Client;
-70
View File
@@ -1,70 +0,0 @@
var Draft75Parser = function(webSocket, stream) {
this._socket = webSocket;
this._stream = stream;
this._buffer = [];
this._buffering = false;
};
var instance = {
FRAME_START : new Buffer([0x00]),
FRAME_END : new Buffer([0xFF]),
getVersion: function() {
return 'draft-75';
},
handshakeResponse: function() {
var stream = this._stream;
try {
stream.write('HTTP/1.1 101 Web Socket Protocol Handshake\r\n');
stream.write('Upgrade: WebSocket\r\n');
stream.write('Connection: Upgrade\r\n');
stream.write('WebSocket-Origin: ' + this._socket.request.headers.origin + '\r\n');
stream.write('WebSocket-Location: ' + this._socket.url + '\r\n\r\n');
} catch (e) {
// socket closed while writing
// no handshake sent; client will stop using WebSocket
}
},
parse: function(data) {
for (var i = 0, n = data.length; i < n; i++)
this._handleChar(data[i]);
},
frame: function(data) {
var stream = this._stream;
try {
stream.write(this.FRAME_START, 'binary');
stream.write(new Buffer(data), 'utf8');
stream.write(this.FRAME_END, 'binary');
return true;
} catch (e) {
return false;
}
},
_handleChar: function(data) {
switch (data) {
case 0x00:
this._buffering = true;
break;
case 0xFF:
this._buffer = new Buffer(this._buffer);
this._socket.receive(this._buffer.toString('utf8', 0, this._buffer.length));
this._buffer = [];
this._buffering = false;
break;
default:
if (this._buffering) this._buffer.push(data);
}
}
};
for (var key in instance)
Draft75Parser.prototype[key] = instance[key];
module.exports = Draft75Parser;
-59
View File
@@ -1,59 +0,0 @@
var crypto = require('crypto'),
Draft75Parser = require('./draft75_parser'),
Draft76Parser = function() { Draft75Parser.apply(this, arguments) };
var bridge = function() {};
bridge.prototype = Draft75Parser.prototype;
Draft76Parser.prototype = new bridge();
var numberFromKey = function(key) {
return parseInt(key.match(/[0-9]/g).join(''), 10);
};
var spacesInKey = function(key) {
return key.match(/ /g).length;
};
var bigEndian = function(number) {
var string = '';
[24,16,8,0].forEach(function(offset) {
string += String.fromCharCode(number >> offset & 0xFF);
});
return string;
};
Draft76Parser.prototype.getVersion = function() {
return 'draft-76';
};
Draft76Parser.prototype.handshakeResponse = function(head) {
var request = this._socket.request,
stream = this._stream,
key1 = request.headers['sec-websocket-key1'],
value1 = numberFromKey(key1) / spacesInKey(key1),
key2 = request.headers['sec-websocket-key2'],
value2 = numberFromKey(key2) / spacesInKey(key2),
MD5 = crypto.createHash('md5');
MD5.update(bigEndian(value1));
MD5.update(bigEndian(value2));
MD5.update(head.toString('binary'));
try {
stream.write('HTTP/1.1 101 Web Socket Protocol Handshake\r\n', 'binary');
stream.write('Upgrade: WebSocket\r\n', 'binary');
stream.write('Connection: Upgrade\r\n', 'binary');
stream.write('Sec-WebSocket-Origin: ' + request.headers.origin + '\r\n', 'binary');
stream.write('Sec-WebSocket-Location: ' + this._socket.url + '\r\n\r\n', 'binary');
stream.write(MD5.digest('binary'), 'binary');
} catch (e) {
// socket closed while writing
// no handshake sent; client will stop using WebSocket
}
};
module.exports = Draft76Parser;
-384
View File
@@ -1,384 +0,0 @@
var crypto = require('crypto');
var Handshake = function(uri, stream) {
this._uri = uri;
this._stream = stream;
var buffer = new Buffer(16), i = 16;
while (i--) buffer[i] = Math.floor(Math.random() * 254);
this._key = buffer.toString('base64');
var SHA1 = crypto.createHash('sha1');
SHA1.update(this._key + Protocol8Parser.prototype.GUID);
this._accept = SHA1.digest('base64');
var HTTPParser = process.binding('http_parser').HTTPParser,
parser = new HTTPParser(HTTPParser.RESPONSE || 'response'),
current = null,
self = this;
this._nodeVersion = HTTPParser.RESPONSE ? 6 : 4;
this._complete = false;
this._headers = {};
this._parser = parser;
parser.onHeaderField = function(b, start, length) {
current = b.toString('utf8', start, start + length);
};
parser.onHeaderValue = function(b, start, length) {
self._headers[current] = b.toString('utf8', start, start + length);
};
parser.onHeadersComplete = function(info) {
self._status = info.statusCode;
var headers = info.headers;
if (!headers) return;
for (var i = 0, n = headers.length; i < n; i += 2)
self._headers[headers[i]] = headers[i+1];
};
parser.onMessageComplete = function() {
self._complete = true;
};
};
Handshake.prototype.requestData = function() {
var stream = this._stream, u = this._uri;
try {
stream.write('GET ' + u.pathname + (u.search || '') + ' HTTP/1.1\r\n');
stream.write('Host: ' + u.hostname + (u.port ? ':' + u.port : '') + '\r\n');
stream.write('Upgrade: websocket\r\n');
stream.write('Connection: Upgrade\r\n');
stream.write('Sec-WebSocket-Key: ' + this._key + '\r\n');
stream.write('Sec-WebSocket-Version: 8\r\n');
stream.write('\r\n');
} catch (e) {}
};
Handshake.prototype.parse = function(data) {
var consumed = this._parser.execute(data, 0, data.length),
offset = (this._nodeVersion < 6) ? 1 : 0;
return (consumed === data.length) ? [] : data.slice(consumed + offset);
};
Handshake.prototype.isComplete = function() {
return this._complete;
};
Handshake.prototype.isValid = function() {
if (this._status !== 101) return false;
var upgrade = this._headers.Upgrade,
connection = this._headers.Connection;
return upgrade && /^websocket$/i.test(upgrade) &&
connection && connection.split(/\s*,\s*/).indexOf('Upgrade') >= 0 &&
this._headers['Sec-WebSocket-Accept'] === this._accept;
};
var Protocol8Parser = function(webSocket, stream, options) {
this._reset();
this._socket = webSocket;
this._stream = stream;
this._stage = 0;
this._masking = options && options.masking;
};
var instance = {
FIN: 128,
MASK: 128,
RSV1: 64,
RSV2: 32,
RSV3: 16,
OPCODE: 15,
LENGTH: 127,
GUID: '258EAFA5-E914-47DA-95CA-C5AB0DC85B11',
OPCODES: {
continuation: 0,
text: 1,
binary: 2,
close: 8,
ping: 9,
pong: 10
},
ERRORS: {
normal_closure: 1000,
going_away: 1001,
protocol_error: 1002,
unacceptable: 1003,
encoding_error: 1007,
policy_violation: 1008,
too_large: 1009,
extension_error: 1010
},
FRAGMENTED_OPCODES: [0,1,2],
OPENING_OPCODES: [1,2],
ERROR_CODES: [1000,1001,1002,1003,1007,1008,1009,1010],
UTF8_MATCH: /^([\x00-\x7F]|[\xC2-\xDF][\x80-\xBF]|\xE0[\xA0-\xBF][\x80-\xBF]|[\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}|\xED[\x80-\x9F][\x80-\xBF]|\xF0[\x90-\xBF][\x80-\xBF]{2}|[\xF1-\xF3][\x80-\xBF]{3}|\xF4[\x80-\x8F][\x80-\xBF]{2})*$/,
getVersion: function() {
var version = this._socket.request.headers['sec-websocket-version'];
return 'protocol-' + version;
},
handshakeResponse: function() {
var secKey = this._socket.request.headers['sec-websocket-key'];
if (!secKey) return;
var SHA1 = crypto.createHash('sha1');
SHA1.update(secKey + this.GUID);
var accept = SHA1.digest('base64');
var stream = this._stream;
try {
stream.write('HTTP/1.1 101 Switching Protocols\r\n');
stream.write('Upgrade: websocket\r\n');
stream.write('Connection: Upgrade\r\n');
stream.write('Sec-WebSocket-Accept: ' + accept + '\r\n\r\n');
} catch (e) {
// socket closed while writing
// no handshake sent; client will stop using WebSocket
}
},
createHandshake: function() {
return new Handshake(this._socket.uri, this._stream);
},
parse: function(data) {
for (var i = 0, n = data.length; i < n; i++) {
switch (this._stage) {
case 0: this._parseOpcode(data[i]); break;
case 1: this._parseLength(data[i]); break;
case 2: this._parseExtendedLength(data[i]); break;
case 3: this._parseMask(data[i]); break;
case 4: this._parsePayload(data[i]); break;
}
if (this._stage === 4 && this._length === 0)
this._emitFrame();
}
},
frame: function(data, type, code) {
if (this._closed) return;
var opcode = this.OPCODES[type || (typeof data === 'string' ? 'text' : 'binary')],
buffer = new Buffer(data),
insert = code ? 2 : 0,
length = buffer.length + insert,
masked = this._masking ? this.MASK : 0,
stream = this._stream,
frame, factor, mask, i, n;
data = new Buffer(length);
if (code) {
data[0] = Math.floor(code / 256);
data[1] = code & 255;
}
for (i = 0, n = buffer.length; i < n; i++)
data[insert + i] = buffer[i];
if (length <= 125) {
frame = new Buffer(2);
frame[1] = masked | length;
} else if (length >= 126 && length <= 65535) {
frame = new Buffer(4);
frame[1] = masked | 126;
frame[2] = Math.floor(length / 256);
frame[3] = length & 255;
} else {
frame = new Buffer(10);
frame[1] = masked | 127;
for (var i = 0; i < 8; i++) {
factor = Math.pow(2, 8 * (8 - 1 - i));
frame[2+i] = Math.floor(length / factor) & 255;
}
}
frame[0] = this.FIN | opcode;
if (this._masking) {
mask = [1,2,3,4].map(function() { return Math.floor(Math.random() * 255) });
for (i = 0, n = data.length; i < n; i++)
data[i] = data[i] ^ mask[i % 4];
}
try {
stream.write(frame, 'binary');
if (mask) stream.write(new Buffer(mask), 'binary');
if (data.length > 0) stream.write(data, 'utf8');
return true;
} catch (e) {
return false;
}
},
close: function(code, reason, callback, context) {
if (this._closed) return;
if (callback) this._closingCallback = [callback, context];
this.frame(reason || '', 'close', code || this.ERRORS.normal_closure);
this._closed = true;
},
buffer: function(fragment) {
for (var i = 0, n = fragment.length; i < n; i++)
this._buffer.push(fragment[i]);
},
_parseOpcode: function(data) {
var rsvs = [this.RSV1, this.RSV2, this.RSV3].filter(function(rsv) {
return (data & rsv) === rsv;
}, this);
if (rsvs.length > 0) return this._socket.close(this.ERRORS.protocol_error, null, false);
this._final = (data & this.FIN) === this.FIN;
this._opcode = (data & this.OPCODE);
this._mask = [];
this._payload = [];
var valid = false;
for (var key in this.OPCODES) {
if (this.OPCODES[key] === this._opcode)
valid = true;
}
if (!valid) return this._socket.close(this.ERRORS.protocol_error, null, false);
if (this.FRAGMENTED_OPCODES.indexOf(this._opcode) < 0 && !this._final)
return this._socket.close(this.ERRORS.protocol_error, null, false);
if (this._mode && this.OPENING_OPCODES.indexOf(this._opcode) >= 0)
return this._socket.close(this.ERRORS.protocol_error, null, false);
this._stage = 1;
},
_parseLength: function(data) {
this._masked = (data & this.MASK) === this.MASK;
this._length = (data & this.LENGTH);
if (this._length >= 0 && this._length <= 125) {
this._stage = this._masked ? 3 : 4;
} else {
this._lengthBuffer = [];
this._lengthSize = (this._length === 126 ? 2 : 8);
this._stage = 2;
}
},
_parseExtendedLength: function(data) {
this._lengthBuffer.push(data);
if (this._lengthBuffer.length < this._lengthSize) return;
this._length = this._getInteger(this._lengthBuffer);
this._stage = this._masked ? 3 : 4;
},
_parseMask: function(data) {
this._mask.push(data);
if (this._mask.length < 4) return;
this._stage = 4;
},
_parsePayload: function(data) {
this._payload.push(data);
if (this._payload.length < this._length) return;
this._emitFrame();
},
_emitFrame: function() {
var payload = this._unmask(this._payload, this._mask),
opcode = this._opcode;
if (opcode === this.OPCODES.continuation) {
if (!this._mode) return this._socket.close(this.ERRORS.protocol_error, null, false);
this.buffer(payload);
if (this._final) {
var message = new Buffer(this._buffer);
if (this._mode === 'text') message = this._encode(message);
this._reset();
if (message !== null) this._socket.receive(message);
else this._socket.close(this.ERRORS.encoding_error, null, false);
}
}
else if (opcode === this.OPCODES.text) {
if (this._final) {
var message = this._encode(payload);
if (message !== null) this._socket.receive(message);
else this._socket.close(this.ERRORS.encoding_error, null, false);
} else {
this._mode = 'text';
this.buffer(payload);
}
}
else if (opcode === this.OPCODES.binary) {
if (this._final) {
this._socket.receive(payload);
} else {
this._mode = 'binary';
this.buffer(payload);
}
}
else if (opcode === this.OPCODES.close) {
var code = (payload.length >= 2) ? 256 * payload[0] + payload[1] : null,
reason = (payload.length > 2) ? this._encode(payload.slice(2)) : null;
if (!(payload.length === 0) &&
!(code !== null && code >= 3000 && code < 5000) &&
this.ERROR_CODES.indexOf(code) < 0)
code = this.ERRORS.protocol_error;
if (payload.length > 125 || (payload.length > 2 && !reason))
code = this.ERRORS.protocol_error;
this._socket.close(code, (payload.length > 2) ? reason : null, false);
if (this._closingCallback)
this._closingCallback[0].call(this._closingCallback[1]);
}
else if (opcode === this.OPCODES.ping) {
if (payload.length > 125) return this._socket.close(this.ERRORS.protocol_error, null, false);
this._socket.send(payload, 'pong');
}
this._stage = 0;
},
_reset: function() {
this._mode = null;
this._buffer = [];
},
_encode: function(buffer) {
try {
var string = buffer.toString('binary', 0, buffer.length);
if (!this.UTF8_MATCH.test(string)) return null;
} catch (e) {}
return buffer.toString('utf8', 0, buffer.length);
},
_getInteger: function(bytes) {
var number = 0;
for (var i = 0, n = bytes.length; i < n; i++)
number += bytes[i] << (8 * (n - 1 - i));
return number;
},
_unmask: function(payload, mask) {
var unmasked = new Buffer(payload.length), b;
for (var i = 0, n = payload.length; i < n; i++) {
b = payload[i];
if (mask.length > 0) b = b ^ mask[i % 4];
unmasked[i] = b;
}
return unmasked;
}
};
for (var key in instance)
Protocol8Parser.prototype[key] = instance[key];
module.exports = Protocol8Parser;
+13 -10
View File
@@ -1,23 +1,26 @@
{ "name" : "faye-websocket"
, "description" : "Robust general-purpose WebSocket server and client"
, "homepage" : "http://github.com/jcoglan/faye-websocket-node"
, "description" : "Standards-compliant WebSocket server and client"
, "homepage" : "http://github.com/faye/faye-websocket-node"
, "author" : "James Coglan <jcoglan@gmail.com> (http://jcoglan.com/)"
, "keywords" : ["websocket"]
, "keywords" : ["websocket", "eventsource"]
, "version" : "0.1.1"
, "version" : "0.4.4"
, "engines" : {"node": ">=0.4.0"}
, "main" : "./lib/faye/websocket"
, "devDependencies" : {"jsclass": ">=3.0.4"}
, "dependencies" : {"websocket-driver": ""}
, "devDependencies" : {"jsclass": "", "pace": ""}
, "bugs" : "http://github.com/jcoglan/faye-websocket-node/issues"
, "scripts" : {"test": "node spec/runner.js"}
, "licenses" : [ { "type" : "MIT"
, "url" : "http://www.opensource.org/licenses/mit-license.php"
, "bugs" : "http://github.com/faye/faye-websocket-node/issues"
, "licenses" : [ { "type" : "MIT"
, "url" : "http://www.opensource.org/licenses/mit-license.php"
}
]
, "repositories" : [ { "type" : "git"
, "url" : "git://github.com/jcoglan/faye-websocket-node.git"
, "repositories" : [ { "type" : "git"
, "url" : "git://github.com/faye/faye-websocket-node.git"
}
]
}
+68 -47
View File
@@ -7,29 +7,29 @@ JS.ENV.WebSocketSteps = JS.Test.asyncSteps({
this._port = port
setTimeout(callback, 100)
},
stop: function(callback) {
this._adapter.stop()
setTimeout(callback, 100)
},
open_socket: function(url, callback) {
open_socket: function(url, protocols, callback) {
var done = false,
self = this,
resume = function(open) {
if (done) return
done = true
self._open = open
callback()
}
this._ws = new Client(url)
this._ws = new Client(url, protocols, {verify: false})
this._ws.onopen = function() { resume(true) }
this._ws.onclose = function() { resume(false) }
},
close_socket: function(callback) {
var self = this
this._ws.onclose = function() {
@@ -38,33 +38,38 @@ JS.ENV.WebSocketSteps = JS.Test.asyncSteps({
}
this._ws.close()
},
check_open: function(callback) {
this.assert( this._open )
callback()
},
check_closed: function(callback) {
this.assert( !this._open )
callback()
},
check_protocol: function(protocol, callback) {
this.assertEqual( protocol, this._ws.protocol )
callback()
},
listen_for_message: function(callback) {
var self = this
this._ws.addEventListener('message', function(message) { self._message = message.data })
callback()
},
send_message: function(callback) {
this._ws.send("I expect this to be echoed")
send_message: function(message, callback) {
this._ws.send(message)
setTimeout(callback, 100)
},
check_response: function(callback) {
this.assertEqual( "I expect this to be echoed", this._message )
check_response: function(message, callback) {
this.assertEqual( message, this._message )
callback()
},
check_no_response: function(callback) {
this.assert( !this._message )
callback()
@@ -74,76 +79,92 @@ JS.ENV.WebSocketSteps = JS.Test.asyncSteps({
JS.ENV.ClientSpec = JS.Test.describe("Client", function() { with(this) {
include(WebSocketSteps)
before(function() {
this.plain_text_url = "ws://localhost:8000/bayeux"
this.secure_url = "wss://localhost:8000/bayeux"
this.protocols = ["foo", "echo"]
this.plain_text_url = "ws://localhost:4180/bayeux"
this.secure_url = "wss://localhost:4180/bayeux"
this.port = 4180
})
sharedBehavior("socket client", function() { with(this) {
it("can open a connection", function() { with(this) {
open_socket(socket_url)
open_socket(socket_url, protocols)
check_open()
check_protocol("echo")
}})
it("cannot open a connection to the wrong host", function() { with(this) {
open_socket(blocked_url)
check_closed()
}})
it("can close the connection", function() { with(this) {
open_socket(socket_url)
open_socket(socket_url, protocols)
close_socket()
check_closed()
}})
describe("in the OPEN state", function() { with(this) {
before(function() { with(this) {
open_socket(socket_url)
open_socket(socket_url, protocols)
}})
it("can send and receive messages", function() { with(this) {
listen_for_message()
send_message()
check_response()
send_message("I expect this to be echoed")
check_response("I expect this to be echoed")
}})
it("sends numbers as strings", function() { with(this) {
listen_for_message()
send_message(13)
check_response("13")
}})
it("sends booleans as strings", function() { with(this) {
listen_for_message()
send_message(false)
check_response("false")
}})
it("sends arrays as strings", function() { with(this) {
listen_for_message()
send_message([13,14,15])
check_response("13,14,15")
}})
}})
describe("in the CLOSED state", function() { with(this) {
before(function() { with(this) {
open_socket(socket_url)
open_socket(socket_url, protocols)
close_socket()
}})
it("cannot send and receive messages", function() { with(this) {
listen_for_message()
send_message()
send_message("I expect this to be echoed")
check_no_response()
}})
}})
}})
describe("with a plain-text server", function() { with(this) {
before(function() {
this.socket_url = this.plain_text_url
this.blocked_url = this.secure_url
})
before(function() { this.server(8000, false) })
before(function() { this.server(4180, false) })
after (function() { this.stop() })
behavesLike("socket client")
}})
describe("with a secure server", function() { with(this) {
before(function() {
this.socket_url = this.secure_url
this.blocked_url = this.plain_text_url
})
before(function() { this.server(8000, true) })
before(function() { this.server(4180, true) })
after (function() { this.stop() })
behavesLike("socket client")
}})
}})
-39
View File
@@ -1,39 +0,0 @@
var Draft75Parser = require('../../../lib/faye/websocket/draft75_parser')
JS.ENV.Draft75ParserSpec = JS.Test.describe("Draft75Parser", function() { with(this) {
before(function() { with(this) {
this.webSocket = {dispatchEvent: function() {}}
this.socket = new FakeSocket
this.parser = new Draft75Parser(webSocket, socket)
}})
describe("parse", function() { with(this) {
it("parses text frames", function() { with(this) {
expect(webSocket, "receive").given("Hello")
parser.parse([0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff])
}})
it("parses multibyte text frames", function() { with(this) {
expect(webSocket, "receive").given("Apple = ")
parser.parse([0x00, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf, 0xff])
}})
it("parses fragmented frames", function() { with(this) {
expect(webSocket, "receive").given("Hello")
parser.parse([0x00, 0x48, 0x65, 0x6c])
parser.parse([0x6c, 0x6f, 0xff])
}})
}})
describe("frame", function() { with(this) {
it("returns the given string formatted as a WebSocket frame", function() { with(this) {
parser.frame("Hello")
assertEqual( [0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff], socket.read() )
}})
it("encodes multibyte characters correctly", function() { with(this) {
parser.frame("Apple = ")
assertEqual( [0x00, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf, 0xff], socket.read() )
}})
}})
}})
-153
View File
@@ -1,153 +0,0 @@
var Protocol8Parser = require('../../../lib/faye/websocket/protocol8_parser')
JS.ENV.Protocol8ParserSpec = JS.Test.describe("Protocol8Parser", function() { with(this) {
before(function() { with(this) {
this.webSocket = {dispatchEvent: function() {}}
this.socket = new FakeSocket
this.parser = new Protocol8Parser(webSocket, socket)
}})
define("parse", function() {
var bytes = [];
for (var i = 0, n = arguments.length; i < n; i++) bytes = bytes.concat(arguments[i])
this.parser.parse(new Buffer(bytes))
})
define("buffer", function(string) {
return {
equals: function(buffer) {
return buffer.toString('utf8', 0, buffer.length) === string
}
}
})
describe("parse", function() { with(this) {
define("mask", function() {
return this._mask = this._mask || [1,2,3,4].map(function() { return Math.floor(Math.random() * 255) })
})
define("maskMessage", function(bytes) {
var output = []
Array.prototype.forEach.call(bytes, function(b, i) {
output[i] = bytes[i] ^ this.mask()[i % 4]
}, this)
return output
})
it("parses unmasked text frames", function() { with(this) {
expect(webSocket, "receive").given("Hello")
parse([0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f])
}})
it("parses empty text frames", function() { with(this) {
expect(webSocket, "receive").given("")
parse([0x81, 0x00])
}})
it("parses fragmented text frames", function() { with(this) {
expect(webSocket, "receive").given("Hello")
parse([0x01, 0x03, 0x48, 0x65, 0x6c])
parse([0x80, 0x02, 0x6c, 0x6f])
}})
it("parses masked text frames", function() { with(this) {
expect(webSocket, "receive").given("Hello")
parse([0x81, 0x85], mask(), maskMessage([0x48, 0x65, 0x6c, 0x6c, 0x6f]))
}})
it("parses masked empty text frames", function() { with(this) {
expect(webSocket, "receive").given("")
parse([0x81, 0x80], mask(), maskMessage([]))
}})
it("parses masked fragmented text frames", function() { with(this) {
expect(webSocket, "receive").given("Hello")
parse([0x01, 0x81], mask(), maskMessage([0x48]))
parse([0x80, 0x84], mask(), maskMessage([0x65, 0x6c, 0x6c, 0x6f]))
}})
it("closes the socket if the frame has an unrecognized opcode", function() { with(this) {
expect(webSocket, "close").given(1002, null, false)
parse([0x83, 0x00])
}})
it("closes the socket if a close frame is received", function() { with(this) {
expect(webSocket, "close").given(1000, "Hello", false)
parse([0x88, 0x07, 0x03, 0xe8, 0x48, 0x65, 0x6c, 0x6c, 0x6f])
}})
it("parses unmasked multibyte text frames", function() { with(this) {
expect(webSocket, "receive").given("Apple = ")
parse([0x81, 0x0b, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf])
}})
it("parses fragmented multibyte text frames", function() { with(this) {
expect(webSocket, "receive").given("Apple = ")
parse([0x01, 0x0a, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3])
parse([0x80, 0x01, 0xbf])
}})
it("parses masked multibyte text frames", function() { with(this) {
expect(webSocket, "receive").given("Apple = ")
parse([0x81, 0x8b], mask(), maskMessage([0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf]))
}})
it("parses masked fragmented multibyte text frames", function() { with(this) {
expect(webSocket, "receive").given("Apple = ")
parse([0x01, 0x8a], mask(), maskMessage([0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3]))
parse([0x80, 0x81], mask(), maskMessage([0xbf]))
}})
it("parses unmasked medium-length text frames", function() { with(this) {
expect(webSocket, "receive").given("HelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHello")
parse([129, 126, 0, 200, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111])
}})
it("parses masked medium-length text frames", function() { with(this) {
expect(webSocket, "receive").given("HelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHello")
parse([129, 254, 0, 200], mask(), maskMessage([72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111]))
}})
it("replies to pings with a pong", function() { with(this) {
expect(webSocket, "send").given(buffer("OHAI"), "pong")
parse([0x89, 0x04, 0x4f, 0x48, 0x41, 0x49])
}})
}})
describe("frame", function() { with(this) {
it("returns the given string formatted as a WebSocket frame", function() { with(this) {
parser.frame("Hello")
assertEqual( [0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f], socket.read() )
}})
it("encodes multibyte characters correctly", function() { with(this) {
parser.frame("Apple = ")
assertEqual( [0x81, 0x0b, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf], socket.read() )
}})
it("encodes medium-length strings using extra length bytes", function() { with(this) {
parser.frame("HelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHelloHello")
assertEqual( [129, 126, 0, 200, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111, 72, 101, 108, 108, 111], socket.read() )
}})
it("encodes long strings using extra length bytes", function() { with(this) {
var reps = 13108, message = '', output = [0x81, 0x7f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x04]
while (reps--) {
message += "Hello"
output = output.concat([0x48, 0x65, 0x6c, 0x6c, 0x6f])
}
parser.frame(message)
assertEqual( output, socket.read() )
}})
it("encodes close frames with an error code", function() { with(this) {
parser.frame("Hello", "close", 1002)
assertEqual( [0x88, 0x07, 0x03, 0xea, 0x48, 0x65, 0x6c, 0x6c, 0x6f], socket.read() )
}})
it("encodes pong frames", function() { with(this) {
parser.frame("", "pong")
assertEqual( [0x8a, 0x00], socket.read() )
}})
}})
}})
+7 -33
View File
@@ -6,23 +6,6 @@ var WebSocket = require('../lib/faye/websocket'),
https = require('https')
JS.ENV.FakeSocket = function() {
this._fragments = []
}
FakeSocket.prototype.write = function(buffer, encoding) {
this._fragments.push([buffer, encoding])
}
FakeSocket.prototype.read = function() {
var output = []
this._fragments.forEach(function(buffer, i) {
for (var j = 0, n = buffer[0].length; j < n; j++)
output.push(buffer[0][j])
})
return output
}
FakeSocket.prototype.addListener = function() {}
JS.ENV.EchoServer = function() {}
EchoServer.prototype.listen = function(port, ssl) {
var server = ssl
@@ -31,33 +14,24 @@ EchoServer.prototype.listen = function(port, ssl) {
cert: fs.readFileSync(__dirname + '/server.crt')
})
: http.createServer()
server.addListener('upgrade', function(request, socket, head) {
var ws = new WebSocket(request, socket, head)
ws.onmessage = function(event) {
ws.send(event.data)
}
server.on('upgrade', function(request, socket, head) {
var ws = new WebSocket(request, socket, head, ["echo"])
ws.pipe(ws)
})
this._httpServer = server
server.listen(port)
}
EchoServer.prototype.stop = function(callback, scope) {
this._httpServer.addListener('close', function() {
this._httpServer.on('close', function() {
if (callback) callback.call(scope);
});
this._httpServer.close();
}
JS.Packages(function() { with(this) {
autoload(/.*Spec/, {from: 'spec/faye/websocket'})
}})
JS.require('JS.Test', function() {
JS.require( 'ClientSpec',
'Draft75ParserSpec',
'Protocol8ParserSpec',
JS.Test.method('autorun'))
require('./faye/websocket/client_spec')
JS.Test.autorun()
})