Use Socket.IO for message transport #449
Conversation
| @@ -85,24 +100,6 @@ def __call__(self) -> FastAPI: | |||
| """ | |||
| return self.api | |||
|
|
|||
| def add_default_endpoints(self): | |||
There was a problem hiding this comment.
We should keep the ping endpoint
There was a problem hiding this comment.
I've added it back in. For future reference it can be tested like so:
socket.current.emit('ping')
console.log('ping')
socket.current.on('ping', function(data) {
console.log(data);
});
In the console you should see:
ping
pong
| # To make state changes. | ||
| self.api.websocket(str(constants.Endpoint.EVENT))(event(app=self)) | ||
|
|
||
| def add_cors(self): |
There was a problem hiding this comment.
Do we not need this anymore?
There was a problem hiding this comment.
It's taken care of when the AsyncServer is created on the App __init__ :
self.sio = AsyncServer(async_mode="asgi", cors_allowed_origins="*")
There's also cors_credentials= which defaults to True already.
python-scoketio does not have CORS options like allow_methods and allow_headers but I believe it's configured to avoid cross-origin problems with browsers by allowing all headers and methods anyway.
| @@ -327,52 +324,6 @@ def compile(self, force_compile: bool = False): | |||
| compiler.compile_components(custom_components) | |||
|
|
|||
|
|
|||
| async def ping() -> str: | |||
There was a problem hiding this comment.
This can be useful for health checks, etc.
pynecone/app.py
Outdated
| self.sio = AsyncServer(async_mode="asgi", cors_allowed_origins="*") | ||
|
|
||
| # Create the socket app. Note 'event' replaces the default 'socket.io' path. | ||
| socket_app = ASGIApp(self.sio, socketio_path="event") |
There was a problem hiding this comment.
Let's use constants.Endpoint.EVENT instead of a string here (and in the EventNameSpace below)
There was a problem hiding this comment.
I'll do that. Note that str(constants.Endpoint.EVENT) returns "/event" not "event" so I'll also update state.js accordingly, since those have to match.
There was a problem hiding this comment.
Actually that might cause a bunch of confusion in the future, for example you call ping with 'ping' but it returns on '\ping'. So I'll modify constants.py `Endpoint' to allow it to return the literal value without the leading ''.
There was a problem hiding this comment.
Now that I think about it it's still confusing. There's potential confusion between the URL endpoint /event (a namespace) and the socket event event (they're separate concepts in socket.io). I'll separate those in constants.py to avoid future problems.
|
Also, can you update the |
|
Thanks for the feedback. Please see the latest commits and let me know if there's anything else! |
|
Magnifique, you're the boss @advo-kat You rock ! |
| # To make state changes. | ||
| self.api.websocket(str(constants.Endpoint.EVENT))(event(app=self)) | ||
|
|
||
| def add_cors(self): |
All Submissions:
Type of change
Please delete options that are not relevant.
New Feature Submission:
Description
A rework of the websocket implementation in Pynecone.
Benefits
AsyncServer, it will be easier to implement implement server side / async events in the future/socket.ioendpoint has been replaced with the usual/eventendpointI've tested this PR locally and on a production server.