Make Socket.IO great again

[darrachequesne]

(yep, that headline is overrused)

Disclaimer:

• I have no control over the website (socket.io), to my knowledge only @rauchg has, so I'm unfortunately not able to fix those issues: socket.io/docs/client-api returns corrupted response #2807 Client API docs is blank on website #2791 Web page, slack, documentation - down for long time... [old: Is this project alive?] #2781 Slack image doesn't load and leads to "502 bad gateway" in README.md on GitHub #2773 socket.io website: dead link on slack button #2753 Demo Chat from Main Site doesn't work #2743 Online examples are not functioning #2736
• I have no control over the chat example repository, that is the one that is behind the chat example, so I'm unfortunately not able to fix those issues: Very minor script issue in "Get Started" #2821 (and all open PR over there)
• I'm not even an expert in Socket.IO, just a developer digging around during his free time between two freelance contracts

Now, enough about my limitations. The Server API and Client API were added on Github, do not hesitate if you find something missing!

Current to-do list:

• release the version 2.0 of Engine.IO
  Engine.IO will now default to uws as WebSocket engine, that should bring great performance improvements. An important issue about double UTF-8 encoding was also fixed in the parser. The only "problem" is that one of the numerous issues open could need a fix over there, hence the delay.
• complete the API docs (missing methods, code examples...): Update official documentation #2350 (comment)
• add a Features section in the README, listing all features provided by Socket.IO (reconnection, multiplexing, rooms...)
• add an Architecture overview section, listing every project (socket.io-adapter, socket.io-parser...) and maybe describing what's happening behind the hood when calling socket.emit() or io.emit().
• take control over the website and the online examples. @rauchg suggested to rewrite the website with next.js (currently it is backed by WordPress) and to host it at https://now.sh
• merge the cluster examples: nginx, haproxy, httpd, reviews are welcome!
• merge the whiteboard example: Implement whiteboard example #2810
• dig into CORS issue: CORS pre-flight breaks socket.io behind load balancer engine.io#279 > [feat] Add an option to toggle handling of OPTIONS requests (#484) engine.io#491
• dig into binary performance issue: Each binary packet results in two packets, and two websocket frames socket.io-parser#61
• maybe update the Namespace API on the client-side (Can't connect to namespace on specified socket socket.io-client#1029, https://www.rabbitmq.com/blog/2012/02/23/how-to-compose-apps-using-websockets/)
• add a Webpack build example: Error when building for WebPack #2109 > Add WebPack build example #2828
• dig into handshake optimisation: Handshake optimization #1954 (somewhere around here) > Add an initialPacket option engine.io#471
• dig into custom codecs: Custom codecs #1946
• document the slim build: Provide a slim build without JSON3 and debug socket.io-client#1030 (related: Useless debug key set in local storage #2610)
• fix the id generation on the client-side: Add nsp prefix to socket.id socket.io-client#1058

I closed quite a lot of issues yesterday through the GitHub API (hitting the rate limit several times), in order to have some feedback (like this one ❤️) and to be able to focus to the active ones.

As usual, every contribution is welcome!

[rauchg]

My hope is to support you and help out with the website. As soon as we add organizations support to now.sh I'll be able to include you. In the mean time, feel free to point me to what repositories I should deploy at what URLs!

…

On Fri, Jan 13, 2017 at 1:55 AM Damien Arrachequesne < ***@***.***> wrote: (yep, that headline is overrused) Disclaimer: - I have no control over the website (socket.io), to my knowledge only @rauchg <https://github.com/rauchg> has, so I'm unfortunately not able to fix those issues: #2807 <#2807> #2791 <#2791> #2781 <#2781> #2773 <#2773> #2753 <#2753> #2743 <#2743> #2736 <#2736> - I have no control over the chat example repository <https://github.com/rauchg/chat-example>, that is the one that is behind the chat example <http://socket.io/get-started/chat/>, so I'm unfortunately not able to fix those issues: #2821 <#2821> (and all open PR over there) - I'm not even an expert in Socket.IO, just a developer digging around during his free time between two freelance contracts Now, enough about my limitations. The Server API <https://github.com/socketio/socket.io/blob/master/docs/API.md> and Client API <https://github.com/socketio/socket.io-client/blob/master/docs/API.md> were added on Github, do not hesitate if you find something missing! Current to-do list: - release the version 2.0 of Engine.IO Engine.IO will now default to uws <https://github.com/uWebSockets/uWebSockets> as WebSocket engine, that should bring great performance improvements. An important issue about double UTF-8 encoding was also fixed in the parser <socketio/engine.io-parser#81>. The only "problem" is that one of the numerous issues open could need a fix over there, hence the delay. - complete the API docs (missing methods, code examples...): #2350 (comment) <#2350 (comment)> - add a Features section in the README, listing all features provided by Socket.IO (reconnection, multiplexing, rooms...) - add an Architecture overview section, listing every project ( socket.io-adapter, socket.io-parser...) and maybe describing what's happening behind the hood when calling socket.emit() or io.emit(). - take control over the website and the online examples. @rauchg <https://github.com/rauchg> suggested to rewrite the website with next.js <https://github.com/zeit/next.js/> (currently it is backed by WordPress) and to host it at https://now.sh - merge the cluster examples: nginx <#2817>, haproxy <#2818>, httpd <#2819>, reviews are welcome! - merge the whiteboard example: #2810 <#2810> - dig into CORS issue: socketio/engine.io#279 <socketio/engine.io#279> - dig into binary performance issue: socketio/socket.io-parser#61 <socketio/socket.io-parser#61> - maybe update the Namespace API on the client-side ( socketio/socket.io-client#1029 <socketio/socket.io-client#1029>, https://www.rabbitmq.com/blog/2012/02/23/how-to-compose-apps-using-websockets/ ) - add a Webpack build example: #2109 <#2109> - dig into handshake optimisation: #1954 <#1954> (somewhere around here <https://github.com/socketio/engine.io/blob/1.8.2/lib/socket.js#L56>) - dig into custom codecs: #1946 <#1946> - document the slim build: socketio/socket.io-client#1030 <socketio/socket.io-client#1030> (related: #2610 <#2610>) - fix the id generation on the client-side: socketio/socket.io-client#1058 <socketio/socket.io-client#1058> I closed quite a lot of issues yesterday through the GitHub API (hitting the rate limit several times), in order to have some feedback (like this one <#2350 (comment)> ❤️) and to be able to focus to the active ones. As usual, every contribution is welcome! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2823>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAAy8VewxIPJHaoMLBgIxmmbSfXVuTlQks5rR0oJgaJpZM4Lis7q> .

[dsalcedo]

May the force with you.

[cozzbie]

MSGA!!!!

[Swinkid]

Great to hear. Wish I could get involved, But I wish you the best of luck. Socket.IO Is probably my favourite library!

[darrachequesne]

@Swinkid, well, actually you can! If you find something missing / not clear enough in the documentation, do not hesitate to open a pull request!

[Swinkid]

@darrachequesne Awesome. One thing I did find while picking up Socket.IO, which maybe not the place for the documentation, was different "Niché" things like how to select certain Transport methods. Maybe in the future we need a look at code examples and what not.

Also @darrachequesne , seems like your portfolio's SSL Cert has expired ;)

[darrachequesne]

@Swinkid yep, it needs some love too 😄

• add a Webpack build example > Add WebPack build example #2828
• dig into handshake optimisation > Add an initialPacket option engine.io#471
• dig into custom codecs > Add support of msgpack format  #1652 (comment)

[darrachequesne]

Two PR that would need reviews / opinions:

• enable the use of a custom parser: Allow the use of a custom parser #2829
• add an initialMessage option: Add an initialPacket option engine.io#471 (so the connect event will be triggered earlier)

[Swinkid]

Hey,

Just a suggestion - is the Wiki function on github editable by anyone? Wondering if considering using that so that when you get access to the website again we could just link to the documentation there to prevent the issue being present in the future.

Also, I was thinking about writing the chat application tutorial in markdown while fixing some of the issues raised in pull requests, opinions?