CHANGES.md

python-engineio change log

Release 3.12.1 - 2020-03-17

• Asyncio client: correctly update cookie jar #166 (commit)

Release 3.12.0 - 2020-03-14

• Correct handling of cookies in the client #162 (commit)
• Fixed infrequent race condition when upgrading from polling to WebSocket #160 (commit)
• Only add signal handler when client is created in main thread #163 (commit)
• More robust handling of a closing connection #164 (commit)
• More accurate logging documentation #158 (commit)

Release 3.11.2 - 2020-01-03

• Detect unreported websocket closures in asyncio client #401 (commit)
• Initialize aiohttp when client connects directly through websocket #152 (commit)
• Initialize the client's SIGINT signal handler only if a client is created #147 (commit)
• Add better exception handling for errors thrown by the websocket-client package #155 (commit) (thanks Adam Grant!)
• Missing timeout when closing websocket client connection #148 (commit)

Release 3.11.1 - 2019-12-10

• Reset event when it is reused after a reconnect #153 (commit)

Release 3.11.0 - 2019-12-07

• Use aiohttp's WebSocket client #324 (commit)
• Support user created loops on the asyncio client #1065 (commit)
• Fix occasional server disconnect crashes #146 (commit) (thanks Dominik Winecki!)
• Use X-Forwarded headers if present to verify origin (commit)
• Support async make_response function in ASGI driver #145 (commit)
• Support not having a sigint handler #143 (commit) (thanks Robin Christine Burr!)
• Fix websocket exception handling on python2.7 #149 (commit) (thanks Payton Yao!)

Release 3.10.0 - 2019-10-22

• Added support for SSL connection to unverified host in the client. #137 (commit) (thanks sgaron-cse!)
• Performance improvements in parsing long-polling payloads (commit)
• Prevent heavy CPU usage when decoding payloads (commit)
• Handle case where no original SIGINT handler existed and call signal.… #140 (commit) (thanks Robin Christine Burr!)
• Accept any 2xx response as valid in the client #331 (commit)
• Avoid loop without yield when sockets are >60 #138 (commit) (thanks Gawen Arab!)
• Configurable ping interval grace period #134 (commit)

Release 3.9.3 - 2019-08-05

• Apply timeouts to all HTTP requests sent from the client #127 (commit)
• Shutdown non responding websocket connections in the client #326 (commit)
• Catch OSError exceptions from websockets package #328 (commit)

Release 3.9.2 - 2019-08-03

• Skip CORS headers when origin is not given by client #131 (commit)
• Add async_handlers sub-package to setup.py (commit)

Release 3.9.1 - 2019-08-02

• Restore CORS disable option #329 (commit)

Release 3.9.0 - 2019-07-29

• Address potential websocket cross-origin attacks #128 (commit)
• Documentation for the Same Origin security policy (commit)
• Remove tests from built package #124 (commit) (thanks Pablo Escodebar!)

Release 3.8.2 - 2019-06-29

• Correctly autodetect asgi async mode #122 (commit)
• Omit response when asyncio websocket ends #120 (commit)
• Improved ocumentation on user session behavior on disconnections (commit)
• Correct spelling mistakes in documentation #119 (commit) (thanks Edward Betts!)

Release 3.8.1 - 2019-06-08

• Optimization to static file serving (commit)
• Do not reset connection when packet queue timeouts #110 (commit) (thanks Victor Moyano!)

Release 3.8.0 - 2019-06-03

• Much more flexible support for static files in the server (commit, commit)
• Correctly handle rejected websocket connections in Tornado #114 (commit)

Release 3.7.0 - 2019-05-29

• Add JSONP support in the server #98 (commit) (thanks StoneMoe!)
• Send binary packets as such in the sync client #112 (commit)
• Handle CLOSE packet in the client #100 (commit)
• Document how to access the sid for the connection (commit)

Release 3.6.0 - 2019-05-25

• Tornado 6 support (commit) (thanks Michel Llorens!)
• added note on CORS support for sanic (commit)
• added python 3.7 build (commit)
• auto-generate change log during release (commit)
• added change log (commit)
• helper release script (commit)

Release 3.5.2 - 2019-05-19

• migrate to ASGI3 #108 (commit) (thanks Florimond Manca!)
• updated asgi examples to latest uvicorn (commit)
• remove security alert in requirements (commit)
• removed unused arguments and methods (commit)

Release 3.5.1 - 2019-04-07

• Downgrade log levels in some areas #103 (commit) (thanks Aaron Bach!)
• capture timeouts and other exceptions from requests (commit)

Release 3.5.0 - 2019-03-16

• not necessary to hold the packet queue when upgrading (commit)
• add link to stack overflow for questions (commit)
• pep8 fixes for previous commit (commit)
• Use the correct text type for upgrade probes in both Python 2 and 3 #101 #265. (commit) (thanks Sam Brightman!)

Release 3.4.4 - 2019-03-14

• Pass cookies to websocket connection creation (commit) (thanks Adrien Gavignet!)
• close the aiohttp client to prevent exit warnings (commit)
• readme fixes (commit)

Release 3.4.3 - 2019-02-20

• exit service task if event loop is closed (commit)
• more tornado fixes (commit)

Release 3.4.2 - 2019-02-19

• added missing await in tornado driver (commit)

Release 3.4.1 - 2019-02-16

• check for origin in Tornado's WebSocket handler (commit)

Release 3.4.0 - 2019-02-15

• replace urllib3 with requests to get cookie support (commit)

Release 3.3.2 - 2019-02-12

• reset sid after a disconnect (commit)
• uniform service task cancellation (commit)
• Fix hang on KeyboardInterrupt when running with asyncio. #95 (commit) (thanks Ingmar Steen!)

Release 3.3.1 - 2019-02-09

• better error handling during websocket connection handshake (commit)
• more places where connection shouldn't be reset too quickly (commit)

Release 3.3.0 - 2019-01-23

• do not reset connection when ping loop exits (commit)

Release 3.2.3 - 2019-01-12

• never import invalid async drivers (commit)

Release 3.2.2 - 2019-01-10

• fixed unreliable unit test (commit)
• Fixes #236 (commit)
• fixed handling of queue empty exceptions #88 (commit)

Release 3.2.1 - 2019-01-09

• add a grace period of 5 seconds to ping timeout (commit)
• do not use six in setup.py (commit)
• minor refactor of clients for consistency with servers (commit)
• minor refactor of the async drivers (commit)

Release 3.2.0 - 2019-01-03

• unit test reorganization (commit)
• do not block upgrades with high packet traffic #16 (commit)
• user session documentation (commit)
• remove python 3.4 from builds (commit)
• user sessions (commit)

Release 3.1.2 - 2018-12-22

• fixed dependency (commit)
• small documentation updates (commit)

Release 3.1.1 - 2018-12-20

• bug fixes on handling of timeouts in the client (commit)
• make ping loop task more responsive to cancellation (commit)
• correct handling of disconnect event (commit)
• make unit tests compatible with python 3.5 (commit)
• do not drop extra packets included in first response (commit)

Release 3.1.0 - 2018-12-14

• initial Engine.IO client implementation
• client examples (commit)
• pass custom headers in client connection requests (commit)
• restructure async drivers into a subpackage (commit)
• documentation updates (commit)

Release 3.0.0 - 2018-12-01

• ASGI support
• support serving static files in wsgi and asgi middlewares (commit)
• refactor wsgi and asgi middlewares (commit)
• minor documentation fixes (commit)
• reorganized documentation (commit)

Release 2.3.2 - 2018-10-09

• address potential lock of the service thread (commit)
• graceful exit for service task (commit)

Release 2.3.1 - 2018-09-30

• updated requirements file (commit)
• more fixes towards cleaning up abruptly disconnected clients (commit)

Release 2.3.0 - 2018-09-23

• Actively monitor clients for disconnections (commit)
• parse integer packets as strings #75 (commit)
• missing unit test (commit)
• add Python 3.7 to build (commit)
• removed unused import (commit)
• Tornado docs (commit)

Release 2.2.0 - 2018-06-28

• tornado unit tests (commit)
• Tornado 5 support (commit)

Release 2.1.1 - 2018-05-12

• support OPTIONS request method in aiohttp and sanic #70 (commit)
• More flexible specification of CORS allowed origins Suggested in miguelgrinberg/Flask-SocketIO#697 (comment) (commit)

Release 2.1.0 - 2018-04-27

• basic support for cors allowed headers (commit)
• add pypy3 target to travis builds (commit)
• respond to CORS preflight requests #630 (commit)

Release 2.0.4 - 2018-03-13

• suppress queue empty errors #65 (commit)

Release 2.0.3 - 2018-03-06

• more aiohttp unit test fixes (commit)
• fix aiohttp unit test (commit)
• support for aiohttp 3.x (commit)

Release 2.0.2 - 2018-01-04

• fix documentation builds (commit)
• Suppress "socket is closed" stack trace from logs #57 (commit)
• Reraise exceptions in a Py2/Py3 compatible way #58 (commit)

Release 2.0.1 - 2017-11-21

• Fixed poll() method to always empty the queue #589 (commit)

Release 2.0.0 - 2017-11-19

• remove double-utf8 encoding hack this hack that made some incorrectly encoded packets sent by the JS socket.io 1.x clients does not always work, and is not needed anymore since the 2.x clients have been fixed. (commit)
• Documented protocol defaults (commit)

Release 1.7.0 - 2017-07-02

• cleaner disconnecting of polling clients (commit)
• Support async_handlers option for the asyncio server #95 (commit)

Release 1.6.1 - 2017-06-27

• Tolerate errors when cleaning up a task cancellation #110 (commit)

Release 1.6.0 - 2017-06-23

• better error handling strategy #49 (again and hopefully better) (commit)
• Reraise app exceptions with the correct traceback #49 (commit)

Release 1.5.4 - 2017-05-30

• Workaround to prevent the "exception never retrieved" asyncio bug #48 (commit)

Release 1.5.3 - 2017-05-29

• Handle buggy and correct encodings for engine.io unicode packets #102 (commit)

Release 1.5.2 - 2017-05-16

• be a bit more forgiving with socket timeouts (commit)

Release 1.5.1 - 2017-05-09

• fixed typo (commit)

Release 1.5.0 - 2017-05-09

• another fix in the lost connection detection logic (commit)
• detect lost connections (asyncio) (commit)
• detect lost connections (eventlet/gevent) (commit)

Release 1.4.0 - 2017-04-21

• properly handle crashes in connect/disconnect handlers (commit)
• invoke disconnect handler when websocket handler crashes (commit)
• invoke disconnect handler when application handler crashes (commit)

Release 1.3.2 - 2017-04-09

• Accept leading and trailing slashes in engineio_path #83 (commit)
• Use custom exceptions for internal errors #44 (commit)
• Fix sanic url parsing #43 According to sanic docs, request.url already contains query string, so adding it results in data corruption. This fix worked for me. #42 (commit) (thanks Семён Марьясин!)
• fixed aiohttp unit test (commit)

Release 1.3.1 - 2017-03-22

• Do not depends on SERVER_SOFTWARE constant from aiohttp #86 (commit)
• proper handling of closed sockets (commit)
• use Python 3.6 for docs build (commit)
• release 1.3.0 (commit)
• Better handling of close packets from the client #41 (commit)
• rename async to _async to avoid conflicts #36 (commit)
• websocket support for sanic (commit)

Release 1.2.4 - 2017-03-02

• Use non-blocking reads for uwsgi websocket handles #417 (commit)
• handle unexpected disconnects from uwsgi websocket (commit)

Release 1.2.3 - 2017-02-22

• Use correct key name for ACCEPT_ENCODING header #39 (commit)

Release 1.2.2 - 2017-02-15

• updated examples readme (commit)
• Fix crash on invalid packet type. Add test #37 (commit) (thanks Dmitry Voronin!)
• minor updates to sanic examples (commit)
• sanic examples (commit)
• sanic support (long-polling only) (commit)
• updated documentation logo (commit)
• ensure iscoroutinefunction works well for mocks (commit)
• updated requirement files for examples (commit)

Release 1.2.1 - 2017-02-11

• various minor improvements for asyncio support (commit)
• Fixed asyncio example code #35 (commit)

Release 1.2.0 - 2017-02-09

• minor documentation updates (commit)
• async socket unit tests (commit)
• more asyncio unit tests (commit)
• catch cancelled tasks due to client leaving (commit)
• some initial async server unit tests (commit)
• asyncio documentation (commit)
• reorganized examples (commit)
• Preliminary asyncio support! Yay! (commit)

Release 1.1.2 - 2017-01-30

• Clean websocket exit for uWSGI #377 (commit)

Release 1.1.1 - 2017-01-23

• Use text/plain content type for base64 encoded responses #33 (commit)
• removed py33 from tests, added py36 (commit)
• additional fix regarding bytearray support (commit)
• Merge branch 'wwqgtxx-patch-1' (commit)
• allow binary packets to be given as bytearrays (commit) (thanks wwqgtxx!)

Release 1.1.0 - 2016-11-27

• Prevent recursive disconnect handlers #329 (commit)

Release 1.0.4 - 2016-11-26

• Use a statically allocated logger by default (commit)
• fix unit test to work on python 2.7 (commit)

Release 1.0.3 - 2016-09-05

• workaround double utf-8 encode bug in javascript client #315 (commit)
• upgrade to a more recent engineio.js for the examples (commit)
• do not close a socket that is already closed #312 (commit)

Release 1.0.2 - 2016-09-04

• add version to package (commit)

Release 1.0.1 - 2016-09-01

• corrected logic that selects gevent_uwsgi as async mode #28 (commit)
• documentation fixes (commit)

Release 1.0.0 - 2016-08-26

• updated Server class docstring (commit)
• added async_handlers option to server (commit)
• documentation for new gevent_uwsgi async_mode (commit)
• add unit test for complete code coverage (commit)
• Merge branch 'efficiosoft-uwsgi-gevent-support' (commit)
• Added websocket support for uWSGI with gevent (commit) (thanks Robert Schindler!)
• minor updates to readme file (commit)

Release 0.9.2 - 2016-06-28

• minor comment additions to examples (commit)
• async message events, sleep function, better client timeout Several improvements in this commit: 1. Message event handlers are invoked in a thread so that they are non-blocking. 2. Added a sleep function that is generic across async modes. 3. The timeout to declare a client gone has been extended to match the ping timeout setting. (commit)

Release 0.9.1 - 2016-05-15

• do not crash if recipient of a message is gone (commit)

Release 0.9.0 - 2016-03-06

• Correct generation of binary xhr2 packets (commit)
• Do not write binary packets to the log (commit)
• Hopefully addressed some tests that fail intermittently on travis (commit)

Release 0.8.8 - 2016-02-21

• Dispose of disconnected sockets (commit)
• disable imports warning in flake8 (commit)

Release 0.8.7 - 2016-01-26

Release 0.8.6 - 2016-01-10

• Graceful failure when websocket is request and the async mode does not support it (commit)

Release 0.8.5 - 2016-01-02

• additional eventlet unit test (commit)
• Update tests to correspond with flake8 (commit) (thanks Artemiy Rodionov!)
• Fix eventlet wsgi websocket call return #12 (commit) (thanks Artemiy Rodionov!)

Release 0.8.4 - 2015-12-18

• Revert "_websocket_handler waits on writer even after the socket is closed" #11 (commit)

Release 0.8.3 - 2015-12-14

• _websocket_handler waits on writer even after the socket is closed This patch wakes up the writer with a null message when the socket gets closed (commit) (thanks Babu Shanmugam!)

Release 0.8.2 - 2015-12-13

• Runtime error when websocket is missing from environment (commit)

Release 0.8.1 - 2015-12-03

• fix python 3.5 build (commit)
• tolerate payloads in UPGRADE packet #7 (commit)

Release 0.8.0 - 2015-11-21

• expose start_background_thread() as a public method (commit)
• Added python 3.5 to the tox build (commit)

Release 0.7.2 - 2015-11-04

• Correctly end eventlet's websocket connection See miguelgrinberg/flask-socketio#167 for the problem this fixes. (commit)

Release 0.7.1 - 2015-10-19

• More robust handling of the upgrade exchange (commit)

Release 0.7.0 - 2015-10-17

• Add kwargs to server constructor (commit)

Release 0.6.9 - 2015-10-16

• Give eventlet access to the socket when running under gunicorn (commit)

Release 0.6.8 - 2015-10-07

• Raise a runtime error when gevent-websocket's custom server is not used (commit)

Release 0.6.7 - 2015-09-26

• Better handling of connection state (commit)
• Small improvements to example apps (commit)
• Correctly set state of socket connected directly with websocket transport (commit)
• Add wrapper to create threads compatible with the selected async mode (commit)

Release 0.6.6 - 2015-09-06

• Accept direct websocket connections (commit)
• Fix executable bit, once again (commit)

Release 0.6.5 - 2015-09-02

• Added transport() method (commit)

Release 0.6.4 - 2015-09-01

• Preserve exception in case it is lost before it is re-reaised (commit)
• Added a port of the "latency" example from the official Javascript client (commit)
• Allow application to provide a custom JSON encoder/decoder. (commit)

Release 0.6.3 - 2015-08-30

• added b64 unit tests (commit)
• Added b64 checks and encoding during initial connect #4 (commit) (thanks Myles Ringle!)

Release 0.6.2 - 2015-08-23

• Improved handling of logging (commit)
• Make gevent websocket optional in example app (commit)

Release 0.6.1 - 2015-08-20

• Make gevent thread arguments optional (commit)

Release 0.6.0 - 2015-08-20

• Add WebSocket support for gevent (Idea derived from pull request #1 by @drdaeman) (commit)
• Made parsing of HTTP connection header more robust (commit)
• Refactored the three async modes as separate modules for greater flexibility (Idea derived from pull request #1 by @drdaeman) (commit)
• Fix executable bit on several files (commit)

Release 0.5.1 - 2015-08-17

• Correct handling of CORS origin header (commit)
• minor improvements to the example application (commit)
• documentation improvements (commit)

Release 0.5.0 - 2015-08-04

• Support for gevent and threading in addition to eventlet. Also improved example application. (commit)

Release 0.4.0 - 2015-08-03

• ensure all HTTP response payloads are returned as bytes (commit)
• Added robustness when dealing with disconnected clients (commit)
• removed assert_called_once from tests (commit)
• Added logging for websocket upgrade (commit)
• Fixed incorrect unit test (commit)
• rename close() to disconnect() for consistency (commit)

Release 0.3.1 - 2015-07-04

• Switch README to rst format (commit)
• minor documentation and code fixes (commit)

Release 0.3.0 - 2015-07-04

• Better support for unicode in Python 2 (commit)
• allow connect event handler to send data to client (commit)

Release 0.2.0 - 2015-06-29

• Added non-decorator format for Server.on() (commit)
• declared vendered js file (commit)
• Added pypy to travis builds (commit)
• minor documentation updates (commit)
• Initial commit (commit)
• initial version (commit)