Skip to content

CHANGELOG.md

Latest commit

 

History

History
290 lines (214 loc) · 8.43 KB

CHANGELOG.md

File metadata and controls

290 lines (214 loc) · 8.43 KB

Unreleased

BREAKING CHANGES

  • installHandlers(server, options) renamed to attach(server) and only takes a single argument. This means you cannot use the same SockJS server installed at multiple prefixes. In practice this was confusing and not common.
  • websocket option is deprecated, but still respected. Please use the new transports option.
  • Node.js >= 18.0.0 is required.

Other Fixes/Changes

  • Convert from coffeescript to ES6.
  • Update minimum Node.js version to 6.X.
  • Update SockJSConnection implementation to be compatible with latest Node.js streams.
  • SockJSConnection properties readable and writable have been removed. These are used internally by Node.js streams.
  • Remove console.log logging by default.
  • Remove usage of exceptions for flow control.
  • Add debug logs for easier troubleshooting.
  • Added transports option to allow selection of specific transports.
  • Added detach(server) function to remove SockJS from a HTTP server instance.
  • Update dependencies.
  • Examples have been updated to use latest versions of libraries.
  • Remove the internal UUID helper and use Node.js crypto.randomUUID() directly.

0.3.19

  • Update node-uuid version #224
  • Add disable_cors option to prevent CORS headers from being added to responses #218
  • Add dnt header to whitelist #212
  • Add x-forwarded-host and x-forwarded-port headers to whitelist #208
  • Update sockjs_url default to latest 1.x target #223
  • Updated hapi.js example #216

0.3.18

  • Change to using res.statusCode instead of manual parsing of res._header #213
  • Update sockjs-protocol filename in README #203

0.3.17

  • Fix usage of undefined session in heartbeat_timeout #179

0.3.16

  • Fix CORS response for null origin #177
  • Add websocket ping-pong and close if no response #129, #162, #169
  • Update sockjs-client version in examples #182
  • Add koa example #180
  • Disable raw websocket endpoint when websocket = false #183
  • Upgrade to faye-websocket 0.10.0 and use proper close code
  • When connection is aborted, don't delay the teardown
  • Forward additional headers #188
  • Add no-transform to Cache-Control headers #189
  • Update documentation about heartbeats #192

0.3.15

  • Remove usage of naked '@' function params to be compatible with coffeescript 1.9.0 #175

0.3.14

  • Re-publish to npm because of build issue in 0.3.13

0.3.13

  • Upgrade faye-websocket to 0.9.3 to fix #171

0.3.12

  • Allow Faye socket constructor options to be passed with faye_server_options option to createServer
  • Fix websocket bad json tests
  • Upgrade Faye to allow 0.9.*

0.3.11

  • #133 - only delay disconnect on non-websocket transports
  • Upgrade Faye to 0.8.0

0.3.10

  • #168 - Add CORS headers for eventsource
  • #158 - schedule heartbeat timer even if send_buffer is not empty
  • #96 - remove rbytes dependency
  • #83 - update documentation for prefix
  • #163 - add protection to JSON for SWF exploit
  • #104 - delete unused parameters in code
  • #106 - update CDN urls
  • #79 - Don't remove stream listeners until after end so 'close' event is heard
  • Get rid of need for _sockjs_onload global variable
  • Use Faye for websocket request validation
  • Upgrade Faye to 0.7.3
  • Upgrade node-uuid to 1.4.1

0.3.9

  • #130 - Set Vary: Origin on CORS requests
  • Upgrade Faye to 0.7.2 from 0.7.0

0.3.8

  • #118 - Allow servers to specify a base URL in /info
  • #131 - Don't look up session id undefined
  • #124 - Small grammar updates for ReadMe
  • Upgrade Faye to 0.7.0 from 0.4.0

0.3.7

  • Expose "protocol" on raw websocket connection instance, correctly

0.3.6

  • When the server closes a connection, make sure the send buffer still gets flushed.
  • Expose "protocol" on raw websocket connection instance
  • #105, #109, #113 - expose 'host', 'user-agent', and 'accept-language' headers
  • Serve SockJS over https CDN by default
  • Upgrade Faye to 0.4.4 from 0.4.0

0.3.5

  • #103 - connection.protocol might have been empty on some rare occasions.
  • #99 - faye-websocket was leaking sockets in "closed" state when dealing with rfc websockets

0.3.4

  • #73 - apparently 'package' is a reserved keyword (use 'pkg' instead)
  • #93 - Coffescript can leak a variable when the same name is used in catch statement. Let's always use 'x' as the variable in catch.
  • #76 - decorateConnection could throw an error if remote connection was closed before setup was complete
  • #90 - Fix "TypeError: 'addListener'" exception (via @pl).
  • remove 'optionalDependencies' section from package.json, 'rbytes' was always optional.
  • #91 - Fix rare null exception.

0.3.3

0.3.1

  • #58 - websocket transport emitted an array instead of a string during onmessage event.
  • Running under node.js 0.7 caused infinite recursion (Stephan Kochen)
  • #59 - restrict characters allowed in callback parameter
  • Updated readme - rbytes package is optional
  • Updated readme WRT deployments on heroku
  • Add minimalistic license block to every source file.

0.3.0

  • Sending JSESSIONID cookie is now disabled by default.
  • sockjs/sockjs-protocol#46 - introduce new service required for protocol tests "/cookie_needed_echo"
  • Initial work towards better integration with "connect" (Stephan Kochen). See discusion: senchalabs/connect#506
  • More documentation about the Cookie and Origin headers.
  • #51 - expose "readyState" on connection instance
  • #53 - expose "protocol" on connection instance
  • #52 - Some protocols may not emit 'close' event with IE.
  • sockjs/sockjs-client#49 - Support 'null' origin - aka: allow SockJS client to be served from file:// paths.

0.2.1

  • Bumped "faye-websocket" dependency to 0.4. Updated code to take advantage of introduced changes.
  • Pinned "node-static" and bumped "node-uuid" dependencies.
  • Removed "Origin" header list of headers exposed to the user. This header is not really meaningful in sockjs context.
  • Header "Access-Control-Allow-Methods" was misspelled.

0.2.0

  • #36, #3 - Replace a custom WebSocket server implementation with faye-websocket-node.
  • Multiple changes to support SockJS-protocol 0.2.
    • The session is now closed on network errors immediately (instead of waiting 5 seconds)
    • Raw websocket interface available - to make it easier to write command line SockJS clients.
    • Support '/info' url.
  • The test server got moved from SockJS-client to SockJS-node.
  • Dropped deprecated Server API (use createServer method instead).
  • Option websocket is now used instead of disabled_transports.

0.1.2

  • #27 - Allow all unicode characters to be send over SockJS.
  • #14 - Make it possible to customize JSESSIONID cookie logic.

0.1.1

  • #32 Expose various request headers on connection.
  • #30 Expose request path on connection.

0.1.0

  • The API changed, there is now an idiomatic API, modelled on node.js Stream API. The old API is deprecated and there is a dummy wrapper that emulates it. Please do upgrade to the new idiomatic API.
  • #22 Initial support for hybi13 (stephank)
  • New options accepted by the Server constructor: log, heartbeat_delay and disconnect_delay.
  • SockJS is now not able to send rich data structures - all data passed to write is converted to a string.
  • #23 Connection.remoteAddress property introduced (Stéphan Kochen)
  • Loads of small changes in order to adhere to protocol spec.

0.0.5

  • #20: npm submodule sockjs didn't work due to outdated github path.

0.0.4

  • Support for htmlfile transport, used by IE in a deployment dependent on cookies.
  • Added /chunking_test API, used to detect support for HTTP chunking on client side.
  • Unified code logic for all the chunking transports - the same code is reused for polling versions.
  • All the chunking transports are closed by the server after 128K was send, in order to force client to GC and reconnect.
  • Don't distribute source coffeescript with npm.
  • Minor fixes in websocket code.
  • Dropped jQuery dependency.
  • Unicode encoding could been garbled during XHR upload.
  • Other minor fixes.

0.0.3

  • EventSource transport didn't emit 'close' event.

0.0.2

  • By default set JSESSIONID cookie, useful for load balancing.

0.0.1

  • Initial release.