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 | class BaseClient(CoreCommands):
def __init__(self, config: BaseClientConfiguration):
"""
To create a new client, use the `create` classmethod
"""
self.config: BaseClientConfiguration = config
self._available_futures: Dict[int, asyncio.Future] = {}
self._available_callback_indexes: List[int] = list()
self._buffered_requests: List[TRequest] = list()
self._writer_lock = threading.Lock()
self.socket_path: Optional[str] = None
self._reader_task: Optional[asyncio.Task] = None
self._is_closed: bool = False
self._pubsub_futures: List[asyncio.Future] = []
self._pubsub_lock = threading.Lock()
self._pending_push_notifications: List[Response] = list()
@classmethod
async def create(cls, config: BaseClientConfiguration) -> Self:
"""Creates a Glide client.
Args:
config (ClientConfiguration): The configuration options for the client, including cluster addresses,
authentication credentials, TLS settings, periodic checks, and Pub/Sub subscriptions.
Returns:
Self: A promise that resolves to a connected client instance.
Examples:
# Connecting to a Standalone Server
>>> from glide import GlideClientConfiguration, NodeAddress, GlideClient, ServerCredentials, BackoffStrategy
>>> config = GlideClientConfiguration(
... [
... NodeAddress('primary.example.com', 6379),
... NodeAddress('replica1.example.com', 6379),
... ],
... use_tls = True,
... database_id = 1,
... credentials = ServerCredentials(username = 'user1', password = 'passwordA'),
... reconnect_strategy = BackoffStrategy(num_of_retries = 5, factor = 1000, exponent_base = 2),
... pubsub_subscriptions = GlideClientConfiguration.PubSubSubscriptions(
... channels_and_patterns = {GlideClientConfiguration.PubSubChannelModes.Exact: {'updates'}},
... callback = lambda message,context : print(message),
... ),
... )
>>> client = await GlideClient.create(config)
# Connecting to a Cluster
>>> from glide import GlideClusterClientConfiguration, NodeAddress, GlideClusterClient,
... PeriodicChecksManualInterval
>>> config = GlideClusterClientConfiguration(
... [
... NodeAddress('address1.example.com', 6379),
... NodeAddress('address2.example.com', 6379),
... ],
... use_tls = True,
... periodic_checks = PeriodicChecksManualInterval(duration_in_sec = 30),
... credentials = ServerCredentials(username = 'user1', password = 'passwordA'),
... reconnect_strategy = BackoffStrategy(num_of_retries = 5, factor = 1000, exponent_base = 2),
... pubsub_subscriptions = GlideClusterClientConfiguration.PubSubSubscriptions(
... channels_and_patterns = {
... GlideClusterClientConfiguration.PubSubChannelModes.Exact: {'updates'},
... GlideClusterClientConfiguration.PubSubChannelModes.Sharded: {'sharded_channel'},
... },
... callback = lambda message,context : print(message),
... ),
... )
>>> client = await GlideClusterClient.create(config)
Remarks:
Use this static method to create and connect a client to a Valkey server.
The client will automatically handle connection establishment, including cluster topology discovery and
handling of authentication and TLS configurations.
- **Cluster Topology Discovery**: The client will automatically discover the cluster topology based
on the seed addresses provided.
- **Authentication**: If `ServerCredentials` are provided, the client will attempt to authenticate
using the specified username and password.
- **TLS**: If `use_tls` is set to `true`, the client will establish secure connections using TLS.
- **Periodic Checks**: The `periodic_checks` setting allows you to configure how often the client
checks for cluster topology changes.
- **Reconnection Strategy**: The `BackoffStrategy` settings define how the client will attempt to
reconnect in case of disconnections.
- **Pub/Sub Subscriptions**: Any channels or patterns specified in `PubSubSubscriptions` will be
subscribed to upon connection.
"""
config = config
self = cls(config)
init_future: asyncio.Future = asyncio.Future()
loop = asyncio.get_event_loop()
def init_callback(socket_path: Optional[str], err: Optional[str]):
if err is not None:
raise ClosingError(err)
elif socket_path is None:
raise ClosingError(
"Socket initialization error: Missing valid socket path."
)
else:
# Received socket path
self.socket_path = socket_path
loop.call_soon_threadsafe(init_future.set_result, True)
start_socket_listener_external(init_callback=init_callback)
# will log if the logger was created (wrapper or costumer) on info
# level or higher
ClientLogger.log(LogLevel.INFO, "connection info", "new connection established")
# Wait for the socket listener to complete its initialization
await init_future
# Create UDS connection
await self._create_uds_connection()
# Start the reader loop as a background task
self._reader_task = asyncio.create_task(self._reader_loop())
# Set the client configurations
await self._set_connection_configurations()
return self
async def _create_uds_connection(self) -> None:
try:
# Open an UDS connection
async with async_timeout.timeout(DEFAULT_TIMEOUT_IN_MILLISECONDS):
reader, writer = await asyncio.open_unix_connection(
path=self.socket_path
)
self._reader = reader
self._writer = writer
except Exception as e:
await self.close(f"Failed to create UDS connection: {e}")
raise
def __del__(self) -> None:
try:
if self._reader_task:
self._reader_task.cancel()
except RuntimeError as e:
if "no running event loop" in str(e):
# event loop already closed
pass
async def close(self, err_message: Optional[str] = None) -> None:
"""
Terminate the client by closing all associated resources, including the socket and any active futures.
All open futures will be closed with an exception.
Args:
err_message (Optional[str]): If not None, this error message will be passed along with the exceptions when
closing all open futures.
Defaults to None.
"""
self._is_closed = True
for response_future in self._available_futures.values():
if not response_future.done():
err_message = "" if err_message is None else err_message
response_future.set_exception(ClosingError(err_message))
try:
self._pubsub_lock.acquire()
for pubsub_future in self._pubsub_futures:
if not pubsub_future.done() and not pubsub_future.cancelled():
pubsub_future.set_exception(ClosingError(""))
finally:
self._pubsub_lock.release()
self._writer.close()
await self._writer.wait_closed()
self.__del__()
def _get_future(self, callback_idx: int) -> asyncio.Future:
response_future: asyncio.Future = asyncio.Future()
self._available_futures.update({callback_idx: response_future})
return response_future
def _get_protobuf_conn_request(self) -> ConnectionRequest:
return self.config._create_a_protobuf_conn_request()
async def _set_connection_configurations(self) -> None:
conn_request = self._get_protobuf_conn_request()
response_future: asyncio.Future = self._get_future(0)
await self._write_or_buffer_request(conn_request)
await response_future
if response_future.result() is not OK:
raise ClosingError(response_future.result())
def _create_write_task(self, request: TRequest):
asyncio.create_task(self._write_or_buffer_request(request))
async def _write_or_buffer_request(self, request: TRequest):
self._buffered_requests.append(request)
if self._writer_lock.acquire(False):
try:
while len(self._buffered_requests) > 0:
await self._write_buffered_requests_to_socket()
finally:
self._writer_lock.release()
async def _write_buffered_requests_to_socket(self) -> None:
requests = self._buffered_requests
self._buffered_requests = list()
b_arr = bytearray()
for request in requests:
ProtobufCodec.encode_delimited(b_arr, request)
self._writer.write(b_arr)
await self._writer.drain()
def _encode_arg(self, arg: TEncodable) -> bytes:
"""
Converts a string argument to bytes.
Args:
arg (str): An encodable argument.
Returns:
bytes: The encoded argument as bytes.
"""
if isinstance(arg, str):
# TODO: Allow passing different encoding options
return bytes(arg, encoding="utf8")
return arg
def _encode_and_sum_size(
self,
args_list: Optional[List[TEncodable]],
) -> Tuple[List[bytes], int]:
"""
Encodes the list and calculates the total memory size.
Args:
args_list (Optional[List[TEncodable]]): A list of strings to be converted to bytes.
If None or empty, returns ([], 0).
Returns:
int: The total memory size of the encoded arguments in bytes.
"""
args_size = 0
encoded_args_list: List[bytes] = []
if not args_list:
return (encoded_args_list, args_size)
for arg in args_list:
encoded_arg = self._encode_arg(arg) if isinstance(arg, str) else arg
encoded_args_list.append(encoded_arg)
args_size += sys.getsizeof(encoded_arg)
return (encoded_args_list, args_size)
async def _execute_command(
self,
request_type: RequestType.ValueType,
args: List[TEncodable],
route: Optional[Route] = None,
) -> TResult:
if self._is_closed:
raise ClosingError(
"Unable to execute requests; the client is closed. Please create a new client."
)
request = CommandRequest()
request.callback_idx = self._get_callback_index()
request.single_command.request_type = request_type
request.single_command.args_array.args[:] = [
bytes(elem, encoding="utf8") if isinstance(elem, str) else elem
for elem in args
]
(encoded_args, args_size) = self._encode_and_sum_size(args)
if args_size < MAX_REQUEST_ARGS_LEN:
request.single_command.args_array.args[:] = encoded_args
else:
request.single_command.args_vec_pointer = create_leaked_bytes_vec(
encoded_args
)
set_protobuf_route(request, route)
return await self._write_request_await_response(request)
async def _execute_transaction(
self,
commands: List[Tuple[RequestType.ValueType, List[TEncodable]]],
route: Optional[Route] = None,
) -> List[TResult]:
if self._is_closed:
raise ClosingError(
"Unable to execute requests; the client is closed. Please create a new client."
)
request = CommandRequest()
request.callback_idx = self._get_callback_index()
transaction_commands = []
for requst_type, args in commands:
command = Command()
command.request_type = requst_type
# For now, we allow the user to pass the command as array of strings
# we convert them here into bytes (the datatype that our rust core expects)
(encoded_args, args_size) = self._encode_and_sum_size(args)
if args_size < MAX_REQUEST_ARGS_LEN:
command.args_array.args[:] = encoded_args
else:
command.args_vec_pointer = create_leaked_bytes_vec(encoded_args)
transaction_commands.append(command)
request.batch.commands.extend(transaction_commands)
request.batch.is_atomic = True
# TODO: add support for timeout, raise on error and retry strategy
set_protobuf_route(request, route)
return await self._write_request_await_response(request)
async def _execute_script(
self,
hash: str,
keys: Optional[List[Union[str, bytes]]] = None,
args: Optional[List[Union[str, bytes]]] = None,
route: Optional[Route] = None,
) -> TResult:
if self._is_closed:
raise ClosingError(
"Unable to execute requests; the client is closed. Please create a new client."
)
request = CommandRequest()
request.callback_idx = self._get_callback_index()
(encoded_keys, keys_size) = self._encode_and_sum_size(keys)
(encoded_args, args_size) = self._encode_and_sum_size(args)
if (keys_size + args_size) < MAX_REQUEST_ARGS_LEN:
request.script_invocation.hash = hash
request.script_invocation.keys[:] = encoded_keys
request.script_invocation.args[:] = encoded_args
else:
request.script_invocation_pointers.hash = hash
request.script_invocation_pointers.keys_pointer = create_leaked_bytes_vec(
encoded_keys
)
request.script_invocation_pointers.args_pointer = create_leaked_bytes_vec(
encoded_args
)
set_protobuf_route(request, route)
return await self._write_request_await_response(request)
async def get_pubsub_message(self) -> CoreCommands.PubSubMsg:
if self._is_closed:
raise ClosingError(
"Unable to execute requests; the client is closed. Please create a new client."
)
if not self.config._is_pubsub_configured():
raise ConfigurationError(
"The operation will never complete since there was no pubsub subscriptions applied to the client."
)
if self.config._get_pubsub_callback_and_context()[0] is not None:
raise ConfigurationError(
"The operation will never complete since messages will be passed to the configured callback."
)
# locking might not be required
response_future: asyncio.Future = asyncio.Future()
try:
self._pubsub_lock.acquire()
self._pubsub_futures.append(response_future)
self._complete_pubsub_futures_safe()
finally:
self._pubsub_lock.release()
return await response_future
def try_get_pubsub_message(self) -> Optional[CoreCommands.PubSubMsg]:
if self._is_closed:
raise ClosingError(
"Unable to execute requests; the client is closed. Please create a new client."
)
if not self.config._is_pubsub_configured():
raise ConfigurationError(
"The operation will never succeed since there was no pubsbub subscriptions applied to the client."
)
if self.config._get_pubsub_callback_and_context()[0] is not None:
raise ConfigurationError(
"The operation will never succeed since messages will be passed to the configured callback."
)
# locking might not be required
msg: Optional[CoreCommands.PubSubMsg] = None
try:
self._pubsub_lock.acquire()
self._complete_pubsub_futures_safe()
while len(self._pending_push_notifications) and not msg:
push_notification = self._pending_push_notifications.pop(0)
msg = self._notification_to_pubsub_message_safe(push_notification)
finally:
self._pubsub_lock.release()
return msg
def _cancel_pubsub_futures_with_exception_safe(self, exception: ConnectionError):
while len(self._pubsub_futures):
next_future = self._pubsub_futures.pop(0)
if not next_future.cancelled():
next_future.set_exception(exception)
def _notification_to_pubsub_message_safe(
self, response: Response
) -> Optional[CoreCommands.PubSubMsg]:
pubsub_message = None
push_notification = cast(
Dict[str, Any], value_from_pointer(response.resp_pointer)
)
message_kind = push_notification["kind"]
if message_kind == "Disconnection":
ClientLogger.log(
LogLevel.WARN,
"disconnect notification",
"Transport disconnected, messages might be lost",
)
elif (
message_kind == "Message"
or message_kind == "PMessage"
or message_kind == "SMessage"
):
values: List = push_notification["values"]
if message_kind == "PMessage":
pubsub_message = BaseClient.PubSubMsg(
message=values[2], channel=values[1], pattern=values[0]
)
else:
pubsub_message = BaseClient.PubSubMsg(
message=values[1], channel=values[0], pattern=None
)
elif (
message_kind == "PSubscribe"
or message_kind == "Subscribe"
or message_kind == "SSubscribe"
or message_kind == "Unsubscribe"
or message_kind == "PUnsubscribe"
or message_kind == "SUnsubscribe"
):
pass
else:
ClientLogger.log(
LogLevel.WARN,
"unknown notification",
f"Unknown notification message: '{message_kind}'",
)
return pubsub_message
def _complete_pubsub_futures_safe(self):
while len(self._pending_push_notifications) and len(self._pubsub_futures):
next_push_notification = self._pending_push_notifications.pop(0)
pubsub_message = self._notification_to_pubsub_message_safe(
next_push_notification
)
if pubsub_message:
self._pubsub_futures.pop(0).set_result(pubsub_message)
async def _write_request_await_response(self, request: CommandRequest):
# Create a response future for this request and add it to the available
# futures map
response_future = self._get_future(request.callback_idx)
self._create_write_task(request)
await response_future
return response_future.result()
def _get_callback_index(self) -> int:
try:
return self._available_callback_indexes.pop()
except IndexError:
# The list is empty
return len(self._available_futures)
async def _process_response(self, response: Response) -> None:
res_future = self._available_futures.pop(response.callback_idx, None)
if not res_future or response.HasField("closing_error"):
err_msg = (
response.closing_error
if response.HasField("closing_error")
else f"Client Error - closing due to unknown error. callback index: {response.callback_idx}"
)
if res_future is not None:
res_future.set_exception(ClosingError(err_msg))
await self.close(err_msg)
raise ClosingError(err_msg)
else:
self._available_callback_indexes.append(response.callback_idx)
if response.HasField("request_error"):
error_type = get_request_error_class(response.request_error.type)
res_future.set_exception(error_type(response.request_error.message))
elif response.HasField("resp_pointer"):
res_future.set_result(value_from_pointer(response.resp_pointer))
elif response.HasField("constant_response"):
res_future.set_result(OK)
else:
res_future.set_result(None)
async def _process_push(self, response: Response) -> None:
if response.HasField("closing_error") or not response.HasField("resp_pointer"):
err_msg = (
response.closing_error
if response.HasField("closing_error")
else "Client Error - push notification without resp_pointer"
)
await self.close(err_msg)
raise ClosingError(err_msg)
try:
self._pubsub_lock.acquire()
callback, context = self.config._get_pubsub_callback_and_context()
if callback:
pubsub_message = self._notification_to_pubsub_message_safe(response)
if pubsub_message:
callback(pubsub_message, context)
else:
self._pending_push_notifications.append(response)
self._complete_pubsub_futures_safe()
finally:
self._pubsub_lock.release()
async def _reader_loop(self) -> None:
# Socket reader loop
remaining_read_bytes = bytearray()
while True:
read_bytes = await self._reader.read(DEFAULT_READ_BYTES_SIZE)
if len(read_bytes) == 0:
err_msg = "The communication layer was unexpectedly closed."
await self.close(err_msg)
raise ClosingError(err_msg)
read_bytes = remaining_read_bytes + bytearray(read_bytes)
read_bytes_view = memoryview(read_bytes)
offset = 0
while offset <= len(read_bytes):
try:
response, offset = ProtobufCodec.decode_delimited(
read_bytes, read_bytes_view, offset, Response
)
except PartialMessageException:
# Received only partial response, break the inner loop
remaining_read_bytes = read_bytes[offset:]
break
response = cast(Response, response)
if response.is_push:
await self._process_push(response=response)
else:
await self._process_response(response=response)
async def get_statistics(self) -> dict:
return get_statistics()
async def _update_connection_password(
self, password: Optional[str], immediate_auth: bool
) -> TResult:
request = CommandRequest()
request.callback_idx = self._get_callback_index()
if password is not None:
request.update_connection_password.password = password
request.update_connection_password.immediate_auth = immediate_auth
response = await self._write_request_await_response(request)
# Update the client binding side password if managed to change core configuration password
if response is OK:
if self.config.credentials is None:
self.config.credentials = ServerCredentials(password=password or "")
self.config.credentials.password = password or ""
return response
|