Purpose of WebsocketRPCEndpoint.on_connect

[5p4k]

I was trying out the package and I was going to inherit from WebsocketRPCEndpoint and override on_connect.

fastapi_websocket_rpc/fastapi_websocket_rpc/websocket_rpc_endpoint.py

Line 110 in d0f322e

async def on_connect(self, channel, websocket):

However in my test example it's never called, and in fact, it seems like it's never referred to at any point; the handlers in the private member _on_connect are passed directly to RpcChannel:

fastapi_websocket_rpc/fastapi_websocket_rpc/websocket_rpc_endpoint.py

Line 85 in d0f322e

channel.register_connect_handler(self._on_connect)

So wonder what is the purpose of on_connect? Is that supposed to be called externally by e.g. FastAPI? Was it supposed to be passed to register_connect_handler?

[orweis]

on_connect is exposed for deriving layers that extended or build on top of the RPC channel - see https://github.com/permitio/fastapi_websocket_pubsub for example (https://github.com/permitio/fastapi_websocket_pubsub/blob/c757bd707622252aab761a59115897dd12413478/fastapi_websocket_pubsub/pub_sub_client.py#L194)

[5p4k]

The purpose of the on_connect argument of __init__ (which the example you linked makes use of) is clear.

I was wondering about the on_connect method of WebsocketRPCEndpoint. It creates a task that executes self._on_connect handlers, but it's never called and it duplicates the functionality already offered by RpcChannel.on_handler_event. It looks like it's not called by anything.

[orweis]

Yes, you seem to be right.
I guess it's seem artifact missed in a refactor - this part is 4 years old.

[orweis]

Would you like to open a PR to fix this? :)