-
Notifications
You must be signed in to change notification settings - Fork 172
Expand file tree
/
Copy pathrequest.py
More file actions
942 lines (809 loc) · 31.6 KB
/
request.py
File metadata and controls
942 lines (809 loc) · 31.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
from __future__ import annotations
import asyncio
import functools
import io
import json as modjson
import logging
import sys
import uuid
from collections import namedtuple
from collections.abc import AsyncIterator, Awaitable, Callable, Iterable, Mapping, Sequence
from datetime import datetime
from decimal import Decimal
from enum import StrEnum
from pathlib import Path
from typing import (
Any,
cast,
)
import aiohttp
import aiohttp.web
import appdirs
import attrs
from aiohttp.client import _RequestContextManager, _WSRequestContextManager
from dateutil.tz import tzutc
from multidict import CIMultiDict
from yarl import URL
from ai.backend.common.json import dump_json_str
from .auth import generate_signature
from .exceptions import BackendAPIError, BackendClientError
from .session import AsyncSession, BaseSession, api_session
from .session import Session as SyncSession
log = logging.getLogger(__spec__.name)
__all__ = [
"AttachedFile",
"BaseResponse",
"FetchContextManager",
"Request",
"Response",
"SSEContextManager",
"SSEResponse",
"WebSocketContextManager",
"WebSocketResponse",
]
RequestContent = bytes | bytearray | str | aiohttp.StreamReader | io.IOBase | None
"""
The type alias for the set of allowed types for request content.
"""
AttachedFile = namedtuple("AttachedFile", "filename stream content_type")
"""
A struct that represents an attached file to the API request.
:param str filename: The name of file to store. It may include paths
and the server will create parent directories
if required.
:param Any stream: A file-like object that allows stream-reading bytes.
:param str content_type: The content type for the stream. For arbitrary
binary data, use "application/octet-stream".
"""
async def _coro_return[T](val: T) -> T:
return val
class ExtendedJSONEncoder(modjson.JSONEncoder):
def default(self, obj: Any) -> Any:
if isinstance(obj, uuid.UUID):
return str(obj)
if isinstance(obj, Path):
return str(obj)
if isinstance(obj, Decimal):
return str(obj)
return super().default(obj)
class SessionMode(StrEnum):
CLIENT = "CLIENT"
PROXY = "PROXY"
class Request:
"""
The API request object.
"""
__slots__ = (
"_attached_files",
"_content",
"_session_mode",
"api_version",
"config",
"content_type",
"date",
"headers",
"method",
"params",
"path",
"reporthook",
"session",
)
_content: RequestContent
_attached_files: Sequence[AttachedFile] | None
date: datetime | None
api_version: str
_allowed_methods = frozenset(["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"])
def __init__(
self,
method: str = "GET",
path: str | None = None,
content: RequestContent | None = None,
*,
content_type: str | None = None,
params: Mapping[str, str | int] | None = None,
reporthook: Callable[..., Any] | None = None,
override_api_version: str | None = None,
session_mode: SessionMode = SessionMode.CLIENT,
) -> None:
"""
Initialize an API request.
:param BaseSession session: The session where this request is executed on.
:param str path: The query path. When performing requests, the version number
prefix will be automatically prepended if required.
:param RequestContent content: The API query body which will be encoded as
JSON.
:param str content_type: Explicitly set the content type. See also
:func:`Request.set_content`.
:param SessionMode session_mode: The session mode, either CLIENT or PROXY.
This affects how the response decoding is handled.
"""
self.session = api_session.get()
self.config = self.session.config
self.method = method
if path is not None and path.startswith("/"):
path = path[1:]
self.path = path
self.params = params
self.date = None
if override_api_version:
self.api_version = override_api_version
else:
self.api_version = f"v{self.session.api_version[0]}.{self.session.api_version[1]}"
self.headers = CIMultiDict([
("User-Agent", self.config.user_agent),
("X-BackendAI-Domain", self.config.domain),
("X-BackendAI-Version", self.api_version),
])
self._content = b""
self._attached_files = None
self.set_content(content, content_type=content_type)
self.reporthook = reporthook
self._session_mode = session_mode
@property
def content(self) -> RequestContent:
"""
Retrieves the content in the original form.
Private codes should NOT use this as it incurs duplicate
encoding/decoding.
"""
return self._content
def set_content(
self,
value: RequestContent,
*,
content_type: str | None = None,
) -> None:
"""
Sets the content of the request.
"""
if self._attached_files is not None:
raise ValueError("Cannot set content because files are already attached")
guessed_content_type = "application/octet-stream"
if value is None:
guessed_content_type = "text/plain"
self._content = b""
elif isinstance(value, str):
guessed_content_type = "text/plain"
self._content = value.encode("utf-8")
else:
guessed_content_type = "application/octet-stream"
self._content = value
self.content_type = content_type if content_type is not None else guessed_content_type
def set_json(self, value: Any) -> None:
"""
A shortcut for set_content() with JSON objects.
"""
self.set_content(
modjson.dumps(value, cls=ExtendedJSONEncoder), content_type="application/json"
)
def attach_files(self, files: Sequence[AttachedFile]) -> None:
"""
Attach a list of files represented as AttachedFile.
"""
if self._content:
raise ValueError("Content must be empty to attach files")
self.content_type = "multipart/form-data"
self._attached_files = files
def _sign(
self,
rel_url: URL,
access_key: str | None = None,
secret_key: str | None = None,
hash_type: str | None = None,
) -> None:
"""
Calculates the signature of the given request and adds the
Authorization HTTP header.
It should be called at the very end of request preparation and before
sending the request to the server.
"""
if access_key is None:
access_key = self.config.access_key
if secret_key is None:
secret_key = self.config.secret_key
if hash_type is None:
hash_type = self.config.hash_type
if self.date is None:
raise RuntimeError("Request date is not set")
if self.config.endpoint_type == "api":
hdrs, _ = generate_signature(
method=self.method,
version=self.api_version,
endpoint=self.config.endpoint,
date=self.date,
rel_url=str(rel_url),
content_type=self.content_type,
access_key=access_key,
secret_key=secret_key,
hash_type=hash_type,
)
self.headers.update(hdrs)
elif self.config.endpoint_type == "session":
local_state_path = Path(appdirs.user_state_dir("backend.ai", "Lablup"))
try:
cookie_jar = cast(aiohttp.CookieJar, self.session.aiohttp_session.cookie_jar)
cookie_jar.load(local_state_path / "cookie.dat")
except (OSError, PermissionError):
pass
else:
raise ValueError("unsupported endpoint type")
def _pack_content(self) -> RequestContent | aiohttp.FormData:
if self._attached_files is not None:
data = aiohttp.FormData()
for f in self._attached_files:
data.add_field("src", f.stream, filename=f.filename, content_type=f.content_type)
if not data.is_multipart:
raise RuntimeError("Failed to pack files as multipart")
# Let aiohttp fill up the content-type header including
# multipart boundaries.
self.headers.pop("Content-Type", None)
return data
return self._content
def _build_url(self) -> URL:
base_url = self.config.endpoint.path.rstrip("/")
query_path = self.path.lstrip("/") if self.path is not None and len(self.path) > 0 else ""
if self.config.endpoint_type == "session":
if not query_path.startswith("server"):
query_path = f"func/{query_path}"
path = f"{base_url}/{query_path}"
url = self.config.endpoint.with_path(path)
if self.params:
url = url.with_query(self.params)
return url
# TODO: attach rate-limit information
def fetch(self, **kwargs: Any) -> FetchContextManager:
"""
Sends the request to the server and reads the response.
You may use this method with AsyncSession only,
following the pattern below:
.. code-block:: python3
from ai.backend.client.request import Request
from ai.backend.client.session import AsyncSession
async with AsyncSession() as sess:
rqst = Request('GET', ...)
async with rqst.fetch() as resp:
print(await resp.text())
"""
if self.method not in self._allowed_methods:
raise ValueError(f"Disallowed HTTP method: {self.method}")
self.date = datetime.now(tzutc())
if self.date is None:
raise RuntimeError("Failed to set request date")
self.headers["Date"] = self.date.isoformat()
if self.content_type is not None and "Content-Type" not in self.headers:
self.headers["Content-Type"] = self.content_type
force_anonymous = kwargs.pop("anonymous", False)
def _rqst_ctx_builder() -> _RequestContextManager:
timeout_config = aiohttp.ClientTimeout(
total=None,
connect=None,
sock_connect=self.config.connection_timeout,
sock_read=self.config.read_timeout,
)
full_url = self._build_url()
if self.session.aiohttp_session._base_url is None:
# for anonymous requests or API sessions created without using ClientPool
request_url = full_url
else:
request_url = full_url.relative()
if not self.config.is_anonymous and not force_anonymous:
self._sign(full_url.relative())
return self.session.aiohttp_session.request(
self.method,
str(request_url),
data=self._pack_content(),
timeout=timeout_config,
headers=self.headers,
allow_redirects=False,
)
return FetchContextManager(self.session, _rqst_ctx_builder, self._session_mode, **kwargs)
def connect_websocket(
self, protocols: Iterable[str] = tuple(), **kwargs: Any
) -> WebSocketContextManager:
"""
Creates a WebSocket connection.
.. warning::
This method only works with
:class:`~ai.backend.client.session.AsyncSession`.
"""
if not isinstance(self.session, AsyncSession):
raise RuntimeError("Cannot use websockets with sessions in the synchronous mode")
if self.method != "GET":
raise ValueError("Invalid websocket method")
self.date = datetime.now(tzutc())
if self.date is None:
raise RuntimeError("Failed to set request date")
self.headers["Date"] = self.date.isoformat()
# websocket is always a "binary" stream.
self.content_type = "application/octet-stream"
def _ws_ctx_builder() -> _WSRequestContextManager:
full_url = self._build_url()
if not self.config.is_anonymous:
self._sign(full_url.relative())
if self.session.aiohttp_session._base_url is None:
# for anonymous requests or API sessions created without using ClientPool
request_url = full_url
else:
request_url = full_url.relative()
return self.session.aiohttp_session.ws_connect(
str(request_url),
autoping=True,
heartbeat=30.0,
headers=self.headers,
protocols=protocols,
)
return WebSocketContextManager(self.session, _ws_ctx_builder, **kwargs)
def connect_events(self, **kwargs: Any) -> SSEContextManager:
"""
Creates a Server-Sent Events connection.
.. warning::
This method only works with
:class:`~ai.backend.client.session.AsyncSession`.
"""
if not isinstance(self.session, AsyncSession):
raise RuntimeError("Cannot use event streams with sessions in the synchronous mode")
if self.method != "GET":
raise ValueError("Invalid event stream method")
self.date = datetime.now(tzutc())
if self.date is None:
raise RuntimeError("Failed to set request date")
self.headers["Date"] = self.date.isoformat()
self.content_type = "application/octet-stream"
def _rqst_ctx_builder() -> _RequestContextManager:
timeout_config = aiohttp.ClientTimeout(
total=None,
connect=None,
sock_connect=self.config.connection_timeout,
sock_read=self.config.read_timeout,
)
full_url = self._build_url()
if not self.config.is_anonymous:
self._sign(full_url.relative())
if self.session.aiohttp_session._base_url is None:
# for anonymous requests or API sessions created without using ClientPool
request_url = full_url
else:
request_url = full_url.relative()
return self.session.aiohttp_session.request(
self.method, str(request_url), timeout=timeout_config, headers=self.headers
)
return SSEContextManager(self.session, _rqst_ctx_builder, **kwargs)
class AsyncResponseMixin:
_session: BaseSession
_raw_response: aiohttp.ClientResponse
async def text(self) -> str:
return await self._raw_response.text()
async def json(self, *, loads: Callable[[str], Any] = modjson.loads) -> Any:
loads = functools.partial(loads)
return await self._raw_response.json(loads=loads)
async def read(self, n: int = -1) -> bytes:
return await self._raw_response.content.read(n)
async def readall(self) -> bytes:
return await self._raw_response.content.read(-1)
class SyncResponseMixin:
_session: BaseSession
_raw_response: aiohttp.ClientResponse
def text(self) -> str:
sync_session = cast(SyncSession, self._session)
return cast(
str,
sync_session.worker_thread.execute(
self._raw_response.text(),
),
)
def json(self, *, loads: Callable[[str], Any] = modjson.loads) -> Any:
loads = functools.partial(loads)
sync_session = cast(SyncSession, self._session)
return sync_session.worker_thread.execute(
self._raw_response.json(loads=loads),
)
def read(self, n: int = -1) -> bytes:
sync_session = cast(SyncSession, self._session)
return cast(
bytes,
sync_session.worker_thread.execute(
self._raw_response.content.read(n),
),
)
def readall(self) -> bytes:
sync_session = cast(SyncSession, self._session)
return cast(
bytes,
sync_session.worker_thread.execute(
self._raw_response.content.read(-1),
),
)
class BaseResponse:
"""
Represents the Backend.AI API response.
Also serves as a high-level wrapper of :class:`aiohttp.ClientResponse`.
The response objects are meant to be created by the SDK, not the callers.
:func:`text`, :func:`json` methods return the resolved content directly with
plain synchronous Session while they return the coroutines with AsyncSession.
"""
__slots__ = (
"_async_mode",
"_raw_response",
"_session",
)
_session: BaseSession
_raw_response: aiohttp.ClientResponse
_async_mode: bool
def __init__(
self,
session: BaseSession,
underlying_response: aiohttp.ClientResponse,
*,
async_mode: bool = False,
**kwargs: Any,
) -> None:
self._session = session
self._raw_response = underlying_response
self._async_mode = async_mode
@property
def session(self) -> BaseSession:
return self._session
@property
def status(self) -> int:
return self._raw_response.status
@property
def reason(self) -> str:
if self._raw_response.reason is not None:
return self._raw_response.reason
return ""
@property
def headers(self) -> Mapping[str, str]:
return self._raw_response.headers
@property
def raw_response(self) -> aiohttp.ClientResponse:
return self._raw_response
@property
def content_type(self) -> str:
return self._raw_response.content_type
@property
def content_length(self) -> int | None:
return self._raw_response.content_length
@property
def content(self) -> aiohttp.StreamReader:
return self._raw_response.content
class Response(AsyncResponseMixin, BaseResponse):
pass
class FetchContextManager:
"""
The context manager returned by :func:`Request.fetch`.
It provides asynchronous context manager interfaces only.
"""
__slots__ = (
"_async_mode",
"_rqst_ctx",
"_session_mode",
"check_status",
"response_cls",
"rqst_ctx_builder",
"session",
)
_rqst_ctx: _RequestContextManager | None
def __init__(
self,
session: BaseSession,
rqst_ctx_builder: Callable[[], _RequestContextManager],
session_mode: SessionMode = SessionMode.CLIENT,
*,
response_cls: type[Response] = Response,
check_status: bool = True,
) -> None:
self.session = session
self.rqst_ctx_builder = rqst_ctx_builder
self.check_status = check_status
self.response_cls = response_cls
self._async_mode = isinstance(session, AsyncSession)
self._rqst_ctx = None
self._session_mode = session_mode
async def __aenter__(self) -> Response:
max_retries = len(self.session.config.endpoints)
retry_count = 0
raw_resp: aiohttp.ClientResponse | None = None
while True:
try:
retry_count += 1
self._rqst_ctx = self.rqst_ctx_builder()
if self._rqst_ctx is None:
raise RuntimeError("Failed to build request context")
raw_resp = await self._rqst_ctx.__aenter__()
if self.check_status and raw_resp.status // 100 not in [2, 3]:
match self._session_mode:
case SessionMode.CLIENT:
error_data = await raw_resp.json()
msg = dump_json_str(error_data)
await raw_resp.__aexit__(None, None, None)
raise BackendAPIError(raw_resp.status, raw_resp.reason or "", msg)
case SessionMode.PROXY:
pass
return self.response_cls(self.session, raw_resp, async_mode=self._async_mode)
except aiohttp.ClientConnectionError as e:
if retry_count == max_retries:
msg = (
"Request to the API endpoint has failed.\n"
"Check your network connection and/or the server status.\n"
f"\u279c {e!r}"
)
raise BackendClientError(msg) from e
self.session.config.rotate_endpoints()
continue
except aiohttp.ClientResponseError as e:
msg = f"API endpoint response error.\n\u279c {e!r}"
if raw_resp is not None:
await raw_resp.__aexit__(*sys.exc_info())
raise BackendClientError(msg) from e
finally:
self.session.config.load_balance_endpoints()
async def __aexit__(self, *exc_info: Any) -> bool | None:
if self._rqst_ctx is None:
raise RuntimeError("Request context is not initialized")
await self._rqst_ctx.__aexit__(*exc_info)
self._rqst_ctx = None
return None
class WebSocketResponse(BaseResponse):
"""
A high-level wrapper of :class:`aiohttp.ClientWebSocketResponse`.
"""
__slots__ = ("_raw_ws",)
def __init__(
self,
session: BaseSession,
underlying_response: aiohttp.ClientResponse,
**kwargs: Any,
) -> None:
# Unfortunately, aiohttp.ClientWebSocketResponse is not a subclass of aiohttp.ClientResponse.
# Since we block methods that require ClientResponse-specific methods, we just force-typecast.
super().__init__(session, underlying_response, **kwargs)
self._raw_ws = cast(aiohttp.ClientWebSocketResponse, underlying_response)
@property
def content_type(self) -> str:
raise AttributeError("WebSocketResponse does not have an explicit content type.")
@property
def content_length(self) -> int | None:
raise AttributeError("WebSocketResponse does not have a fixed content length.")
@property
def content(self) -> aiohttp.StreamReader:
raise AttributeError("WebSocketResponse does not support reading the content.")
@property
def raw_websocket(self) -> aiohttp.ClientWebSocketResponse:
return self._raw_ws
@property
def closed(self) -> bool:
return self._raw_ws.closed
async def close(self) -> None:
await self._raw_ws.close()
def __aiter__(self) -> AsyncIterator[aiohttp.WSMessage]:
return self._raw_ws.__aiter__()
def exception(self) -> BaseException | None:
return self._raw_ws.exception()
async def send_str(self, raw_str: str) -> None:
if self._raw_ws.closed:
raise aiohttp.ServerDisconnectedError("server disconnected")
await self._raw_ws.send_str(raw_str)
async def send_json(self, obj: Any) -> None:
if self._raw_ws.closed:
raise aiohttp.ServerDisconnectedError("server disconnected")
await self._raw_ws.send_json(obj)
async def send_bytes(self, data: bytes) -> None:
if self._raw_ws.closed:
raise aiohttp.ServerDisconnectedError("server disconnected")
await self._raw_ws.send_bytes(data)
async def receive_str(self) -> str:
if self._raw_ws.closed:
raise aiohttp.ServerDisconnectedError("server disconnected")
return await self._raw_ws.receive_str()
async def receive_json(self) -> Any:
if self._raw_ws.closed:
raise aiohttp.ServerDisconnectedError("server disconnected")
return await self._raw_ws.receive_json()
async def receive_bytes(self) -> bytes:
if self._raw_ws.closed:
raise aiohttp.ServerDisconnectedError("server disconnected")
return await self._raw_ws.receive_bytes()
class WebSocketContextManager:
"""
The context manager returned by :func:`Request.connect_websocket`.
"""
__slots__ = (
"_ws_ctx",
"on_enter",
"response_cls",
"session",
"ws_ctx_builder",
)
_ws_ctx: _WSRequestContextManager | None
def __init__(
self,
session: BaseSession,
ws_ctx_builder: Callable[[], _WSRequestContextManager],
*,
on_enter: Callable[..., Any] | None = None,
response_cls: type[WebSocketResponse] = WebSocketResponse,
) -> None:
self.session = session
self.ws_ctx_builder = ws_ctx_builder
self.response_cls = response_cls
self.on_enter = on_enter
self._ws_ctx = None
async def __aenter__(self) -> WebSocketResponse:
max_retries = len(self.session.config.endpoints)
retry_count = 0
while True:
try:
retry_count += 1
self._ws_ctx = self.ws_ctx_builder()
if self._ws_ctx is None:
raise RuntimeError("Failed to build WebSocket context")
raw_ws = await self._ws_ctx.__aenter__()
except aiohttp.ClientConnectionError as e:
if retry_count == max_retries:
msg = (
"Request to the API endpoint has failed.\n"
"Check your network connection and/or the server status.\n"
f"Error detail: {e!r}"
)
raise BackendClientError(msg) from e
self.session.config.rotate_endpoints()
continue
except aiohttp.ClientResponseError as e:
msg = f"API endpoint response error.\n\u279c {e!r}"
raise BackendClientError(msg) from e
else:
break
finally:
self.session.config.load_balance_endpoints()
wrapped_ws = self.response_cls(self.session, cast(aiohttp.ClientResponse, raw_ws))
if self.on_enter is not None:
await self.on_enter(wrapped_ws)
return wrapped_ws
async def __aexit__(self, *args: Any) -> bool | None:
if self._ws_ctx is None:
raise RuntimeError("WebSocket context is not initialized")
await self._ws_ctx.__aexit__(*args)
self._ws_ctx = None
return None
@attrs.define(auto_attribs=True, slots=True, frozen=True)
class SSEMessage:
event: str
data: str
id: str | None = None
retry: int | None = None
class SSEResponse(BaseResponse):
__slots__ = (
"_auto_reconnect",
"_connector",
"_retry",
)
def __init__(
self,
session: BaseSession,
underlying_response: aiohttp.ClientResponse,
*,
connector: Callable[[], Awaitable[aiohttp.ClientResponse]],
auto_reconnect: bool = True,
default_retry: int = 5,
**kwargs: Any,
) -> None:
super().__init__(session, underlying_response, async_mode=True, **kwargs)
self._auto_reconnect = auto_reconnect
self._retry = default_retry
self._connector = connector
async def fetch_events(self) -> AsyncIterator[SSEMessage]:
msg_lines: list[str] = []
server_closed = False
while True:
received_line = await self._raw_response.content.readline()
if not received_line:
# connection closed
if self._auto_reconnect and not server_closed:
await asyncio.sleep(self._retry)
self._raw_response = await self._connector()
continue
else:
break
received_line = received_line.strip(b"\r\n")
if received_line.startswith(b":"):
# comment
continue
if not received_line:
# message boundary
if len(msg_lines) == 0:
continue
event_type = "message"
event_id = None
event_retry = None
data_lines = []
try:
for stored_line in msg_lines:
hdr, text = stored_line.split(":", maxsplit=1)
text = text.lstrip(" ")
if hdr == "data":
data_lines.append(text)
elif hdr == "event":
event_type = text
elif hdr == "id":
event_id = text
elif hdr == "retry":
event_retry = int(text)
except (IndexError, ValueError):
log.exception("SSEResponse: parsing-error")
continue
event_data = "\n".join(data_lines)
msg_lines.clear()
if event_retry is not None:
self._retry = event_retry
yield SSEMessage(
event=event_type,
data=event_data,
id=event_id,
retry=event_retry,
)
if event_type == "server_close":
server_closed = True
break
else:
msg_lines.append(received_line.decode("utf-8"))
def __aiter__(self) -> AsyncIterator[SSEMessage]:
return self.fetch_events()
class SSEContextManager:
__slots__ = (
"_rqst_ctx",
"response_cls",
"rqst_ctx_builder",
"session",
)
_rqst_ctx: _RequestContextManager | None
def __init__(
self,
session: BaseSession,
rqst_ctx_builder: Callable[[], _RequestContextManager],
*,
response_cls: type[SSEResponse] = SSEResponse,
) -> None:
self.session = session
self.rqst_ctx_builder = rqst_ctx_builder
self.response_cls = response_cls
self._rqst_ctx = None
async def reconnect(self) -> aiohttp.ClientResponse:
if self._rqst_ctx is not None:
await self._rqst_ctx.__aexit__(None, None, None)
self._rqst_ctx = self.rqst_ctx_builder()
if self._rqst_ctx is None:
raise RuntimeError("Failed to build request context for SSE")
raw_resp = await self._rqst_ctx.__aenter__()
if raw_resp.status // 100 != 2:
msg = await raw_resp.text()
raise BackendAPIError(raw_resp.status, raw_resp.reason or "", msg)
return raw_resp
async def __aenter__(self) -> SSEResponse:
max_retries = len(self.session.config.endpoints)
retry_count = 0
while True:
try:
retry_count += 1
raw_resp = await self.reconnect()
return self.response_cls(self.session, raw_resp, connector=self.reconnect)
except aiohttp.ClientConnectionError as e:
if retry_count == max_retries:
msg = (
"Request to the API endpoint has failed.\n"
"Check your network connection and/or the server status.\n"
f"\u279c {e!r}"
)
raise BackendClientError(msg) from e
self.session.config.rotate_endpoints()
continue
except aiohttp.ClientResponseError as e:
msg = f"API endpoint response error.\n\u279c {e!r}"
raise BackendClientError(msg) from e
finally:
self.session.config.load_balance_endpoints()
async def __aexit__(self, *args: Any) -> bool | None:
if self._rqst_ctx is None:
raise RuntimeError("SSE request context is not initialized")
await self._rqst_ctx.__aexit__(*args)
self._rqst_ctx = None
return None