Use wslay as a WebSocket library #30263

Faless · 2019-07-02T18:03:43Z

~~I know, I know, another WIP, sorry! 🙏~~
~~I have a few intertwined PRs, this is probably next in line, then I'll move back to the Crypto one.~~

~~Why WIP? There are some edge cases when the client gets disconnected it does not emit the appropriate signal. I'm working on it. (plus few TODOs, mostly optimizations).~~

EDIT: No longer WIP, ready fro review.

~~Beside that~~ both client and server are working. Client also support SSL (server should be able to do that easily as soon as the Crypto PR is in).

While I'm pretty happy with this work, I'm sure it's still not as stable as the other library, mainly because this Godot integration is less tested then the other.

It would be great if people who uses the WebSocket module could give this PR a try with their servers to verify I didn't mess up the handshake part ( ❤️ ).

Please report any issue you might encounter, I'll try to fix the edge cases mentioned above in the coming days.

Fixes #27632 (given the libwebsocket is dropped, and the new lib uses our StreamPeerSSL implementation).
Sadly, while the new library do include a .pc file, it does not seem to be included in Debian/Ubuntu packages, not sure about other distros.

COPYRIGHT.txt

akien-mga · 2019-07-03T16:04:24Z

Sadly, while the new library do include a .pc file, it does not seem to be included in Debian/Ubuntu packages, not sure about other distros.

I'll package it for Mageia to give it a try, and if that works I'll import it in Fedora too.

Edit: It actually is packaged in Debian/Ubuntu already in recent versions, as well as openSUSE: https://pkgs.org/download/wslay
They're not all on 1.1.0 though so not sure if they'd build fine.

akien-mga · 2019-07-03T16:04:53Z

I added a conflict in the SCsub as I replaced all CPPFLAGS by CPPDEFINES.

akien-mga · 2019-07-03T17:20:27Z

platform/x11/detect.py

-    if not env['builtin_libwebsockets']:
-        env.ParseConfig('pkg-config libwebsockets --cflags --libs')
+    if not env['builtin_wslay']:
+        env.ParseConfig('pkg-config libwslay --cflags --libs')


Just for the reference (no need to change anything for now), the libwslay.pc pkgconfig file is not a given even on distros which package the library. wslay comes with two buildsystems, autotools and cmake, and only the former configures and installs the .pc file.

openSUSE use the autotools buildsystem and have thus libwslay.pc installed, so this will work.
Debian/Ubuntu use the CMake buildsystem, <troll>which, like any good CMake project, is CMake-centric and only installs its own .cmake config files</troll>. I'll open a ticket on https://salsa.debian.org/debian/wslay to suggest that they add a pkgconfig file. Edit: Done, https://salsa.debian.org/debian/wslay/issues/1

For Mageia I used the CMake buildsystem, and wrote a libwslay.pc file myself. I use the same patch as Debian for the CMakeLists.txt to get a shared library with proper soname and libwslay.so, instead of libwslay_shared.so (ugh).

akien-mga · 2019-07-03T17:38:43Z

Builds fine locally on Mageia 7 x86_64. I tested both against the builtin version (default) and against the system-provided wslay package that I just packaged for Mageia :)

akien-mga · 2019-07-03T20:40:45Z

@AshfordN , @RyanJEC, would you be able to test this PR on your WebSockets projects to ensure that there are no regressions compared to libwebsockets 3.0.1?

Faless · 2019-07-04T01:17:30Z

@LikeLakers2 too could be interested

LikeLakers2 · 2019-07-04T04:03:21Z

I don't currently have any projects I'm working on that use websockets (the only one I've done so far, a discord library, I'm thinking of remaking from scratch anyways; that one will be a ways off though), but I do have a couple ideas for ones. I might as well test it when I get the chance.

ghost · 2019-07-04T12:53:16Z

Seems to be working with my systems. Found no major hitches...Yet

Could we get an example on how to use WebSocketServer with SSL when it's ready.

Both client and server are supported on native builds (as usual). SSL server is still not supported, but will soon be possible with this new library. The API stays the same, we just need to work out potential issues due to this big library switch.

Faless · 2019-07-04T13:17:13Z

Could we get an example on how to use this with SSL when it's ready.

Sure, client already works as before (just pass wss://mydomain.com, i.e. wss instead of ws).

Server will likely have two new parameters to listen e.g. listen(port, protocols, gd_mp_api=false, key=null, cert=null). When they are not null, SSL will be used. It should be quite straight forward after the crypto PR.

I'll make sure to implement it in the websocket_chat_demo and push it to the godot demo projects repository.

Thank you for trying this out!

akien-mga · 2019-07-04T13:55:46Z

Thanks a lot, awesome work! :)

akien-mga · 2019-07-08T05:53:46Z

For the reference, if anyone wants to cherrypick this PR for their own 3.1 branch, you'll need #30419 too to keep feature parity.

Faless · 2019-07-08T17:28:41Z

And also #30434

djole1973 · 2019-07-19T11:50:40Z

why did you change/remove libwebsocket?

Faless · 2019-07-19T16:42:52Z

why did you change/remove libwebsocket?

because it was bloated, broken, unmaintainable.
If you check the line changes, it's +4,052 −49,109. This already gives you a picture of how bad that library was for our needs.
Each library update changed the file structure completely and tended to break stuff (see #27560), so much that we had to roll back (#28568).
We couldn't use our socket implementation (i.e. the library do not support I/O abstraction) and the developer clearly stated he had no intention in accepting work in that direction.
The SSL support was troublesome due to their awful wrapper (#27632),
in general it's a badly written library, and the developer seemed more interested in implementing non-standard features instead of fixing existing issues.

Faless added enhancement topic:thirdparty needs testing topic:network labels Jul 2, 2019

Faless requested review from akien-mga and a team as code owners July 2, 2019 18:03

akien-mga added this to the 3.2 milestone Jul 2, 2019

Faless force-pushed the ws/wslay_pr branch from ef44587 to 505ad4d Compare July 3, 2019 01:00

akien-mga reviewed Jul 3, 2019

View reviewed changes

COPYRIGHT.txt Show resolved Hide resolved

Faless force-pushed the ws/wslay_pr branch 4 times, most recently from 37df4dc to 9d7a933 Compare July 3, 2019 12:34

Faless changed the title ~~[WIP] Use wslay as a WebSocket library~~ Use wslay as a WebSocket library Jul 3, 2019

akien-mga reviewed Jul 3, 2019

View reviewed changes

COPYRIGHT.txt Outdated Show resolved Hide resolved

akien-mga reviewed Jul 3, 2019

View reviewed changes

COPYRIGHT.txt Outdated Show resolved Hide resolved

Faless added 3 commits July 3, 2019 18:42

Add sha1 functions to string (using new CryptoCore)

6c512e2

Add b64 to string helper in CryptoCore

24c52f1

Add TCP Server is_listening method

c13be79

Faless force-pushed the ws/wslay_pr branch from 9d7a933 to 5f311e9 Compare July 3, 2019 16:52

akien-mga reviewed Jul 3, 2019

View reviewed changes

akien-mga approved these changes Jul 3, 2019

View reviewed changes

Faless added 4 commits July 4, 2019 15:03

Remove libwebsocket. No longer used, yay!

aae6c07

Godot addition to wslay, fixes MSVC build

9233edd

Optimize header reads (avoid extra allocs)

3380dc9

Faless force-pushed the ws/wslay_pr branch from 5f311e9 to 3380dc9 Compare July 4, 2019 13:03

akien-mga merged commit 550f436 into godotengine:master Jul 4, 2019

Faless mentioned this pull request Jul 7, 2019

WebSocketServer no longer support subprotocols #30415

Closed

anoadragon453 mentioned this pull request Aug 28, 2019

Allow specifying custom HTTP headers in WebSocket connect_to_url #25999

Closed

raulsntos mentioned this pull request Oct 7, 2022

C#: Cleanup and sync StringExtensions with core #67031

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use wslay as a WebSocket library #30263

Use wslay as a WebSocket library #30263

Faless commented Jul 2, 2019 •

edited

Loading

akien-mga commented Jul 3, 2019 •

edited

Loading

akien-mga commented Jul 3, 2019

akien-mga Jul 3, 2019 •

edited

Loading

akien-mga commented Jul 3, 2019

akien-mga commented Jul 3, 2019

Faless commented Jul 4, 2019

LikeLakers2 commented Jul 4, 2019 •

edited

Loading

ghost commented Jul 4, 2019 •

edited by ghost

Loading

Faless commented Jul 4, 2019

akien-mga commented Jul 4, 2019

akien-mga commented Jul 8, 2019

Faless commented Jul 8, 2019

djole1973 commented Jul 19, 2019

Faless commented Jul 19, 2019 •

edited

Loading

Use wslay as a WebSocket library #30263

Use wslay as a WebSocket library #30263

Conversation

Faless commented Jul 2, 2019 • edited Loading

akien-mga commented Jul 3, 2019 • edited Loading

akien-mga commented Jul 3, 2019

akien-mga Jul 3, 2019 • edited Loading

Choose a reason for hiding this comment

akien-mga commented Jul 3, 2019

akien-mga commented Jul 3, 2019

Faless commented Jul 4, 2019

LikeLakers2 commented Jul 4, 2019 • edited Loading

ghost commented Jul 4, 2019 • edited by ghost Loading

Faless commented Jul 4, 2019

akien-mga commented Jul 4, 2019

akien-mga commented Jul 8, 2019

Faless commented Jul 8, 2019

djole1973 commented Jul 19, 2019

Faless commented Jul 19, 2019 • edited Loading

Faless commented Jul 2, 2019 •

edited

Loading

akien-mga commented Jul 3, 2019 •

edited

Loading

akien-mga Jul 3, 2019 •

edited

Loading

LikeLakers2 commented Jul 4, 2019 •

edited

Loading

ghost commented Jul 4, 2019 •

edited by ghost

Loading

Faless commented Jul 19, 2019 •

edited

Loading