Skip to content

Commit e759093

Browse files
clarify client/transport/session_id parameters
1 parent 174bd33 commit e759093

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

src/replit_river/v2/session.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,6 @@ class _IgnoreMessage:
119119

120120

121121
class Session[HandshakeMetadata]:
122-
_transport_id: str
123122
_server_id: str
124123
session_id: str
125124
_transport_options: TransportOptions
@@ -184,6 +183,13 @@ def __init__(
184183
self._wait_for_connected = asyncio.Event()
185184

186185
self._client_id = client_id
186+
# TODO: LeakyBucketRateLimit accepts "user" for all methods, which has
187+
# historically been and continues to be "client_id".
188+
#
189+
# There's 1:1 client <-> transport, which means LeakyBucketRateLimit is only
190+
# tracking exactly one rate limit.
191+
#
192+
# The "user" parameter is YAGNI, dethread client_id after v1 is deleted.
187193
self._rate_limiter = rate_limiter
188194
self._uri_and_metadata_factory = uri_and_metadata_factory
189195

@@ -324,7 +330,7 @@ async def _begin_close_session_countdown(self) -> None:
324330
return
325331
logger.info(
326332
"websocket closed from %s to %s begin grace period",
327-
self._transport_id,
333+
self.session_id,
328334
self._server_id,
329335
)
330336
self._state = SessionState.NO_CONNECTION
@@ -372,7 +378,7 @@ async def _enqueue_message(
372378
msg = TransportMessage(
373379
streamId=stream_id,
374380
id=nanoid.generate(),
375-
from_=self._transport_id,
381+
from_=self._client_id,
376382
to=self._server_id,
377383
seq=self.seq,
378384
ack=self.ack,
@@ -402,7 +408,7 @@ async def _enqueue_message(
402408
async def close(self) -> None:
403409
"""Close the session and all associated streams."""
404410
logger.info(
405-
f"{self._transport_id} closing session to {self._server_id}, ws: {self._ws}"
411+
f"{self.session_id} closing session to {self._server_id}, ws: {self._ws}"
406412
)
407413
if self._state in TerminalStates:
408414
# already closing
@@ -563,7 +569,7 @@ async def block_until_connected() -> None:
563569
self._task_manager.create_task(
564570
_recv_from_ws(
565571
block_until_connected=block_until_connected,
566-
client_id=self._transport_id,
572+
client_id=self._client_id,
567573
get_state=lambda: self._state,
568574
get_ws=lambda: self._ws,
569575
transition_connecting=transition_connecting,
@@ -906,8 +912,8 @@ async def _send_close_stream(
906912

907913
async def _do_ensure_connected[HandshakeMetadata](
908914
client_id: str,
909-
server_id: str,
910915
session_id: str,
916+
server_id: str,
911917
max_retry: int,
912918
rate_limiter: LeakyBucketRateLimit,
913919
uri_and_metadata_factory: Callable[

0 commit comments

Comments
 (0)