fix: VoiceGateway connection is closed with code 4020

[SirTurlock]

Pull Request Type

• Feature addition
• Bugfix
• Documentation update
• Code refactor
• Tests improvement
• CI/CD pipeline enhancement
• Other: [Replace with a description]

Description

The heartbeat sent to the VoiceGateway used random.uniform(0.0, 1.0) to generate a nonce. A recent change in the Discord backend causes it to reject a float value and close the connection with code 4020. The backend now expects an uint64.

Changes

• changed random.uniform(0.0, 1.0) to random.getrandbits(64) in send_heartbeat to generate an uint64 instead of a float.

Related Issues

Fixes #1726

Test Scenarios

None.

Python Compatibility

• I've ensured my code works on Python 3.10.x
• I've ensured my code works on Python 3.11.x
• I've ensured my code works on Python 3.12.x

Checklist

• I've run the pre-commit code linter over all edited files (ran manually)
• I've tested my changes on supported Python versions
• I've added tests for my code, if applicable
• I've updated / added documentation, where applicable

[SirTurlock]

Discord has since acknowledged the issue and reverted the change so this is now kinda redundant, but it may be a bit more future-proof this way (technically uint64 is the accepted value) and better matches the example in the documentation.

[donkevlar]

Note that I am getting this error repeatedly even though its reportedly 'reverted' on the discord API.

Task exception was never retrieved
future: <Task finished name='Task-458' coro=<ActiveVoiceState._ws_connect() done, defined at /usr/local/lib/python3.12/site-packages/interactions/models/internal/active_voice_state.py:105> exception=VoiceWebSocketClosed('The Websocket closed with code: 4020 - Unknown Error')>
Traceback (most recent call last):
  File "/usr/local/lib/python3.12/site-packages/interactions/models/internal/active_voice_state.py", line 109, in _ws_connect
    await self.ws.run()
  File "/usr/local/lib/python3.12/site-packages/interactions/api/voice/voice_gateway.py", line 85, in run
    msg = await receiving
          ^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/interactions/api/voice/voice_gateway.py", line 121, in receive
    raise VoiceWebSocketClosed(resp.data)
interactions.client.errors.VoiceWebSocketClosed: The Websocket closed with code: 4020 - Unknown Error

[SirTurlock]

I may have been a bit hasty when I said it was redundant. I double checked just right now and the exact words from the Discord staff guy was:

or JS 64-bit integer reasons we're now rolling out a change that'll let you send the strings again

So, I'm guessing this fix is not at all redundant, because the lib is sending a float. :/
I'm assuming here that it now accepts integer and string, but not float, but I can't test it right now.