How to send str json format ping

[River-Shi]

It seems bybit requires user to send custom ping in str type not byte type.

Its offical sdk using self.custom_ping_message = json.dumps({"op": "ping"}) which returns a str type. However, I am using orjson.dumps({"op": "ping"} which returns byte type and the websocket will return b'\x03\xe9'. How to solve it?

class Listener(WSListener):
    def __init__(self, logger, specific_ping_msg: bytes = None):
        self._log = logger
        self.msg_queue = asyncio.Queue()
        self._specific_ping_msg = specific_ping_msg

    def send_user_specific_ping(self, transport: WSTransport):
        if self._specific_ping_msg:
            transport.send(WSMsgType.TEXT, self._specific_ping_msg)
        else:
            transport.send_ping()

    def on_ws_connected(self, transport: WSTransport):
        self._log.info("Connected to Websocket...")

    def on_ws_disconnected(self, transport: WSTransport):
        self._log.info("Disconnected from Websocket.")

    def on_ws_frame(self, transport: WSTransport, frame: WSFrame):
        try:
            if frame.msg_type == WSMsgType.PING:
                transport.send_pong(
                    frame.get_payload_as_bytes()
                )  # if enabled auto pong, we don't need to send pong manually
                return
            # msg = orjson.loads(frame.get_payload_as_bytes())
            self.msg_queue.put_nowait(
                frame.get_payload_as_bytes()
            )  # I think we should decode the frame in the handler
        except Exception as e:
            self._log.error(f"Error processing message: {str(e)}")

However, If I send json.dumps({"op": "ping"}), I got:

Traceback (most recent call last):
  File "picows/picows.pyx", line 1080, in picows.picows.WSProtocol._auto_ping_loop
  File "picows/picows.pyx", line 344, in picows.picows.WSListener.send_user_specific_ping
  File "/root/tradebot-pro/tradebot/base.py", line 371, in send_user_specific_ping
    transport.send(WSMsgType.TEXT, self._specific_ping_msg)
  File "picows/picows.pyx", line 453, in picows.picows.WSTransport.send
  File "picows/picows.pyx", line 473, in picows.picows.WSTransport.send
  File "picows/picows.pyx", line 154, in picows.picows._unpack_bytes_like
TypeError: a bytes-like object is required, not 'str'

[River-Shi]

It seems bybit requires user to send custom ping in str type not byte type.

Its offical [sdk](https://github.com/bybit-exchange/pybit/blob/master/pybit/_websocket_stream.py) using `self.custom_ping_message = json.dumps({"op": "ping"})` which returns a str type. However, I am using `orjson.dumps({"op": "ping"}` which returns byte type and the websocket will return `b'\x03\xe9'`. How to solve it?

class Listener(WSListener):
    def __init__(self, logger, specific_ping_msg: bytes = None):
        self._log = logger
        self.msg_queue = asyncio.Queue()
        self._specific_ping_msg = specific_ping_msg

    def send_user_specific_ping(self, transport: WSTransport):
        if self._specific_ping_msg:
            transport.send(WSMsgType.TEXT, self._specific_ping_msg)
        else:
            transport.send_ping()

    def on_ws_connected(self, transport: WSTransport):
        self._log.info("Connected to Websocket...")

    def on_ws_disconnected(self, transport: WSTransport):
        self._log.info("Disconnected from Websocket.")

    def on_ws_frame(self, transport: WSTransport, frame: WSFrame):
        try:
            if frame.msg_type == WSMsgType.PING:
                transport.send_pong(
                    frame.get_payload_as_bytes()
                )  # if enabled auto pong, we don't need to send pong manually
                return
            # msg = orjson.loads(frame.get_payload_as_bytes())
            self.msg_queue.put_nowait(
                frame.get_payload_as_bytes()
            )  # I think we should decode the frame in the handler
        except Exception as e:
            self._log.error(f"Error processing message: {str(e)}")

However, If I send json.dumps({"op": "ping"}), I got:

Traceback (most recent call last):
  File "picows/picows.pyx", line 1080, in picows.picows.WSProtocol._auto_ping_loop
  File "picows/picows.pyx", line 344, in picows.picows.WSListener.send_user_specific_ping
  File "/root/tradebot-pro/tradebot/base.py", line 371, in send_user_specific_ping
    transport.send(WSMsgType.TEXT, self._specific_ping_msg)
  File "picows/picows.pyx", line 453, in picows.picows.WSTransport.send
  File "picows/picows.pyx", line 473, in picows.picows.WSTransport.send
  File "picows/picows.pyx", line 154, in picows.picows._unpack_bytes_like
TypeError: a bytes-like object is required, not 'str'

It is also wield, I receiving success ping message when sending byte type ping.


But still receiving the b'\x03\xe9' and one successful ping return corresponds to the error message b'\x03\xe9'. I have checked the frame type of the b'\x03\xe9' which is <WSMsgType.CLOSE: 8>, why would I receive a close frame?

[tarasko]

It seems that picows library initiating disconnect because you didn't let picows know that you have received user specific pong.

If you redefine ping messages by overriding WSListener.send_user_specific_ping, you should also redefine expected pong replies by redefining either WSListener.is_user_specific_pong or by calling transport.notify_user_specific_pong_received() from on_ws_frame.

Check the guide on auto ping feature. It explains that.
https://picows.readthedocs.io/en/stable/guides.html#auto-ping

Also picows logs that it has not received user specific pong within required time and that's why it has initiated disconnect. You should be able to see that in the log

[River-Shi]

It seems that picows library initiating disconnect because you didn't let picows know that you have received user specific pong.

If you redefine ping messages by overriding WSListener.send_user_specific_ping, you should also redefine expected pong replies by redefining either WSListener.is_user_specific_pong or by calling transport.notify_user_specific_pong_received() from on_ws_frame.

Check the guide on auto ping feature. It explains that. https://picows.readthedocs.io/en/stable/guides.html#auto-ping

Also picows logs that it has not received user specific pong within required time and that's why it has initiated disconnect. You should be able to see that in the log

I have tried to modify the WSListener.is_user_specific_pong by

def WSListener.is_user_specific_pong():
    return False

But the problem is not fixed.

[River-Shi]

It seems that picows library initiating disconnect because you didn't let picows know that you have received user specific pong.
If you redefine ping messages by overriding WSListener.send_user_specific_ping, you should also redefine expected pong replies by redefining either WSListener.is_user_specific_pong or by calling transport.notify_user_specific_pong_received() from on_ws_frame.
Check the guide on auto ping feature. It explains that. https://picows.readthedocs.io/en/stable/guides.html#auto-ping
Also picows logs that it has not received user specific pong within required time and that's why it has initiated disconnect. You should be able to see that in the log

I have tried to modify the WSListener.is_user_specific_pong by

def WSListener.is_user_specific_pong():
    return False

But the problem is not fixed.

I understand ! If I return False, picows think I did not received the reply. So I should handle them by calling transport.notify_user_specific_pong_received()