feat: Support recovery from more websocket clsoe-codes (#1403)

* fix: Add more standard websocket close codes

* fix: Move 1011, 1012 to non-resumable

* feat: add more close codes and add comments + sanity check

* style: fix whitespace on comment

Co-authored-by: AlbertUnruh <73029826+AlbertUnruh@users.noreply.github.com>
Signed-off-by: LordOfPolls <dev@lordofpolls.com>

* style: grammar fix

Co-authored-by: AlbertUnruh <73029826+AlbertUnruh@users.noreply.github.com>
Signed-off-by: LordOfPolls <dev@lordofpolls.com>

---------

Signed-off-by: LordOfPolls <dev@lordofpolls.com>
Co-authored-by: zevaryx <zevaryx@gmail.com>
Co-authored-by: AlbertUnruh <73029826+AlbertUnruh@users.noreply.github.com>

Author: 3 people

interactions/client/const.py

@@ -220,5 +220,49 @@ class MentionPrefix(Sentinel):
 LIB_PATH = os.sep.join(__file__.split(os.sep)[:-2])
 """The path to the library folder."""
 
-RECOVERABLE_WEBSOCKET_CLOSE_CODES = (4000, 4001, 4002, 4003, 4005, 4007, 4008, 4009)
-NON_RESUMABLE_WEBSOCKET_CLOSE_CODES = (1000, 4007)
+# fmt: off
+RECOVERABLE_WEBSOCKET_CLOSE_CODES = (  # Codes that are recoverable, and the bot will reconnect
+    1000,  # Normal closure
+    1001,  # Server going away
+    1003,  # Unsupported Data
+    1005,  # No status code
+    1006,  # Abnormal closure
+    1008,  # Policy Violation
+    1009,  # Message too big
+    1011,  # Server error
+    1012,  # Server is restarting
+    1014,  # Handshake failed
+    1015,  # TLS error
+    4000,  # Unknown error
+    4001,  # Unknown opcode
+    4002,  # Decode error
+    4003,  # Not authenticated
+    4005,  # Already authenticated
+    4007,  # Invalid seq
+    4008,  # Rate limited
+    4009,  # Session timed out
+)
+NON_RESUMABLE_WEBSOCKET_CLOSE_CODES = (  # Codes that are recoverable, but the bot won't be able to resume the session
+    1000,  # Normal closure
+    1003,  # Unsupported Data
+    1008,  # Policy Violation
+    1009,  # Message too big
+    1011,  # Server error
+    1012,  # Server is restarting
+    1014,  # Handshake failed
+    1015,  # TLS error
+    4007,  # Invalid seq
+)
+# Any close code not in the above two tuples is a non-recoverable close code, and will result in the bot shutting down
+# fmt: on
+
+
+# Sanity check the above constants - only useful during development, but doesn't hurt to leave in
+try:
+    assert set(NON_RESUMABLE_WEBSOCKET_CLOSE_CODES).issubset(set(RECOVERABLE_WEBSOCKET_CLOSE_CODES))
+except AssertionError as e:
+    # find the difference between the two sets
+    diff = set(NON_RESUMABLE_WEBSOCKET_CLOSE_CODES) - set(RECOVERABLE_WEBSOCKET_CLOSE_CODES)
+    raise RuntimeError(
+        f"NON_RESUMABLE_WEBSOCKET_CLOSE_CODES contains codes that are not in RECOVERABLE_WEBSOCKET_CLOSE_CODES: {diff}"
+    ) from e