Skip to content

Commit 6fde8f2

Browse files
authored
Merge pull request #16 from Polymarket/harley/ws-error-context
fix: preserve WebSocket error subscription context
2 parents b42ead1 + 6a52685 commit 6fde8f2

9 files changed

Lines changed: 100 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,9 @@ except APIError as e:
194194
separately with `SUBSCRIPTION_TYPE_ORDER_SNAPSHOT` and a distinct request ID. A
195195
successful snapshot ends with an `eof: true` frame; failures use the `error` handler.
196196

197+
For server error frames, both streams emit a `WebSocketError` with optional
198+
`request_id` and `subscription_type` attributes when supplied by the server.
199+
197200
```python
198201
import asyncio
199202
import os

‎polymarket_us/errors.py‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,16 @@ class InternalServerError(APIStatusError):
123123
class WebSocketError(PolymarketUSError):
124124
"""WebSocket-related error."""
125125

126-
def __init__(self, message: str, request_id: str | None = None) -> None:
126+
def __init__(
127+
self,
128+
message: str,
129+
request_id: str | None = None,
130+
*,
131+
subscription_type: str | None = None,
132+
) -> None:
127133
super().__init__(message)
128134
self.request_id = request_id
135+
self.subscription_type = subscription_type
129136

130137
def __repr__(self) -> str:
131138
return f"WebSocketError(message={str(self)!r}, request_id={self.request_id!r})"

‎polymarket_us/websocket/markets.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,11 @@ def _handle_message(self, data: str) -> None:
7272
elif "error" in message:
7373
self._emit(
7474
"error",
75-
WebSocketError(message["error"], message.get("requestId")),
75+
WebSocketError(
76+
message["error"],
77+
message.get("requestId"),
78+
subscription_type=message.get("subscriptionType"),
79+
),
7680
)
7781
elif "marketData" in message:
7882
self._emit("market_data", message)

‎polymarket_us/websocket/private.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,11 @@ def _handle_message(self, data: str) -> None:
7979
elif message.get("error"):
8080
self._emit(
8181
"error",
82-
WebSocketError(message["error"], message.get("requestId")),
82+
WebSocketError(
83+
message["error"],
84+
message.get("requestId"),
85+
subscription_type=message.get("subscriptionType"),
86+
),
8387
)
8488
elif "orderSubscriptionSnapshot" in message or "ordersSnapshot" in message:
8589
self._emit("order_snapshot", message)

‎polymarket_us/websocket/types.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,7 @@ class WebSocketErrorMessage(TypedDict, total=False):
272272

273273
requestId: str
274274
error: str
275+
subscriptionType: str
275276

276277

277278
PrivateMessage = (

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "polymarket-us"
7-
version = "2.4.0"
7+
version = "2.4.1"
88
description = "Polymarket US Python SDK"
99
readme = "README.md"
1010
license = "MIT"

‎tests/test_errors.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,3 +178,16 @@ def test_stores_request_id(self) -> None:
178178
"""Should store request_id."""
179179
error = WebSocketError("test", request_id="req-123")
180180
assert error.request_id == "req-123"
181+
assert error.subscription_type is None
182+
183+
def test_subscription_context_preserves_existing_error_behavior(self) -> None:
184+
error = WebSocketError(
185+
"subscription failed", "req-123", subscription_type="SUBSCRIPTION_TYPE_ORDER"
186+
)
187+
assert error.subscription_type == "SUBSCRIPTION_TYPE_ORDER"
188+
assert error.request_id == "req-123"
189+
assert error.args == ("subscription failed",)
190+
assert str(error) == "subscription failed"
191+
assert repr(error) == (
192+
"WebSocketError(message='subscription failed', request_id='req-123')"
193+
)

‎tests/test_websocket.py‎

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import asyncio
44
import base64
5+
import json
56
from collections.abc import AsyncIterator
67
from typing import Literal
78

@@ -11,9 +12,10 @@
1112
from websockets.http11 import Request
1213

1314
from polymarket_us import AuthenticationError, PolymarketUS
14-
from polymarket_us.errors import PolymarketUSError
15+
from polymarket_us.errors import PolymarketUSError, WebSocketError
1516
from polymarket_us.websocket import MarketsWebSocket, PrivateWebSocket
1617
from polymarket_us.websocket.base import BaseWebSocket
18+
from polymarket_us.websocket.types import WebSocketErrorMessage
1719

1820
TEST_SECRET_KEY = "nWGxne/9WmC6hEr0kuwsxERJxWl7MmkZcDusAxyuf2A="
1921

@@ -84,6 +86,50 @@ async def handler(peer: ServerConnection) -> None:
8486
finally:
8587
await asyncio.wait_for(ws.close(), timeout=5)
8688

89+
@pytest.mark.parametrize(
90+
"subscription_type",
91+
["known", "SUBSCRIPTION_TYPE_UNSPECIFIED", "SUBSCRIPTION_TYPE_FUTURE", None],
92+
)
93+
@pytest.mark.parametrize("request_id", ["req-123", None])
94+
async def test_error_callback_preserves_subscription_context(
95+
self,
96+
connection: tuple[BaseWebSocket, ServerConnection],
97+
stream: Literal["markets", "private"],
98+
subscription_type: str | None,
99+
request_id: str | None,
100+
) -> None:
101+
ws, peer = connection
102+
if subscription_type == "known":
103+
subscription_type = (
104+
"SUBSCRIPTION_TYPE_MARKET_DATA"
105+
if stream == "markets"
106+
else "SUBSCRIPTION_TYPE_ORDER"
107+
)
108+
frame: WebSocketErrorMessage = {"error": "subscription failed"}
109+
if subscription_type is not None:
110+
frame["subscriptionType"] = subscription_type
111+
if request_id is not None:
112+
frame["requestId"] = request_id
113+
errors: list[PolymarketUSError] = []
114+
messages: list[object] = []
115+
heartbeat = asyncio.Event()
116+
ws.on("error", errors.append)
117+
ws.on("message", messages.append)
118+
ws.on("heartbeat", heartbeat.set)
119+
120+
await asyncio.wait_for(peer.send(json.dumps(frame)), timeout=5)
121+
await asyncio.wait_for(peer.send('{"heartbeat": {}}'), timeout=5)
122+
await asyncio.wait_for(heartbeat.wait(), timeout=5)
123+
124+
assert messages == [frame, {"heartbeat": {}}]
125+
assert len(errors) == 1
126+
error = errors[0]
127+
assert isinstance(error, WebSocketError)
128+
assert str(error) == "subscription failed"
129+
assert error.request_id == request_id
130+
assert error.subscription_type == subscription_type
131+
assert ws.is_connected
132+
87133
@pytest.mark.parametrize("close_code", [1000, 1001, 1011])
88134
async def test_remote_close_emits_once(
89135
self, connection: tuple[BaseWebSocket, ServerConnection], close_code: int

‎tests/types/websocket_errors.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""Typed consumers of WebSocket error context, including unknown subscriptions."""
2+
3+
from polymarket_us import WebSocketError
4+
from polymarket_us.websocket import WebSocketErrorMessage
5+
6+
legacy_frame: WebSocketErrorMessage = {"error": "subscription failed"}
7+
frame: WebSocketErrorMessage = {
8+
"error": "subscription failed",
9+
"requestId": "req-123",
10+
"subscriptionType": "SUBSCRIPTION_TYPE_FUTURE",
11+
}
12+
error = WebSocketError(
13+
frame["error"],
14+
frame.get("requestId"),
15+
subscription_type=frame.get("subscriptionType"),
16+
)
17+
subscription_type: str | None = error.subscription_type

0 commit comments

Comments
 (0)