ferriskey 0.6.1

Rust client for Valkey, built for FlowFabric. Forked from glide-core (valkey-glide).
Documentation
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
use crate::cluster::slotmap::ReadFromReplicaStrategy;
use crate::cluster::topology::{
    DEFAULT_SLOTS_REFRESH_MAX_JITTER_MILLI, DEFAULT_SLOTS_REFRESH_WAIT_DURATION,
};
use crate::connection::info::TlsMode;
use crate::connection::info::{ConnectionAddr, ConnectionInfo, IntoConnectionInfo};
use crate::pubsub::push_manager::PushInfo;
use crate::retry_strategies::RetryStrategy;
use crate::value::{ErrorKind, ProtocolVersion, Error, Result};
use rand::Rng;
use std::ops::Add;
use std::sync::Arc;
use std::time::Duration;

use crate::connection::tls::TlsConnParams;

use crate::cluster;

use crate::connection::tls::{TlsCertificates, retrieve_tls_certificates};

use tokio::sync::mpsc;

/// Parameters specific to builder, so that
/// builder parameters may have different types
/// than final ClusterParams
#[derive(Default)]
struct BuilderParams {
    password: Option<String>,
    username: Option<String>,
    read_from_replicas: ReadFromReplicaStrategy,
    tls: Option<TlsMode>,
    certs: Option<TlsCertificates>,
    retries_configuration: RetryParams,
    connection_timeout: Option<Duration>,
    topology_checks_interval: Option<Duration>,
    connections_validation_interval: Option<Duration>,
    slots_refresh_rate_limit: SlotsRefreshRateLimit,
    client_name: Option<String>,
    lib_name: Option<String>,
    response_timeout: Option<Duration>,
    protocol: ProtocolVersion,
    reconnect_retry_strategy: Option<RetryStrategy>,
    refresh_topology_from_initial_nodes: bool,
    database_id: i64,
    tcp_nodelay: bool,
}

#[derive(Clone)]
pub(crate) struct RetryParams {
    pub(crate) number_of_retries: u32,
    max_wait_time: u64,
    min_wait_time: u64,
    exponent_base: u64,
    factor: u64,
}

impl Default for RetryParams {
    fn default() -> Self {
        const DEFAULT_RETRIES: u32 = 16;
        const DEFAULT_MAX_RETRY_WAIT_TIME: u64 = 655360;
        const DEFAULT_MIN_RETRY_WAIT_TIME: u64 = 1280;
        const DEFAULT_EXPONENT_BASE: u64 = 2;
        const DEFAULT_FACTOR: u64 = 10;
        Self {
            number_of_retries: DEFAULT_RETRIES,
            max_wait_time: DEFAULT_MAX_RETRY_WAIT_TIME,
            min_wait_time: DEFAULT_MIN_RETRY_WAIT_TIME,
            exponent_base: DEFAULT_EXPONENT_BASE,
            factor: DEFAULT_FACTOR,
        }
    }
}

impl RetryParams {
    pub(crate) fn wait_time_for_retry(&self, retry: u32) -> Duration {
        let base_wait = self.exponent_base.pow(retry) * self.factor;
        let clamped_wait = base_wait
            .min(self.max_wait_time)
            .max(self.min_wait_time + 1);
        let jittered_wait = rand::rng().random_range(self.min_wait_time..clamped_wait);
        Duration::from_millis(jittered_wait)
    }
}

/// Configuration for rate limiting slot refresh operations in a valkey cluster.
///
/// This struct defines the interval duration between consecutive slot refresh
/// operations and an additional jitter to introduce randomness in the refresh intervals.
///
/// # Fields
///
/// * `interval_duration`: The minimum duration to wait between consecutive slot refresh operations.
/// * `max_jitter_milli`: The maximum jitter in milliseconds to add to the interval duration.
#[derive(Clone, Copy)]
pub(crate) struct SlotsRefreshRateLimit {
    pub(crate) interval_duration: Duration,
    pub(crate) max_jitter_milli: u64,
}

impl Default for SlotsRefreshRateLimit {
    fn default() -> Self {
        Self {
            interval_duration: DEFAULT_SLOTS_REFRESH_WAIT_DURATION,
            max_jitter_milli: DEFAULT_SLOTS_REFRESH_MAX_JITTER_MILLI,
        }
    }
}

impl SlotsRefreshRateLimit {
    pub(crate) fn wait_duration(&self) -> Duration {
        let duration_jitter = match self.max_jitter_milli {
            0 => Duration::from_millis(0),
            _ => Duration::from_millis(rand::rng().random_range(0..self.max_jitter_milli)),
        };
        self.interval_duration.add(duration_jitter)
    }
}
/// Redis cluster specific parameters.
#[derive(Default, Clone)]
#[doc(hidden)]
pub struct ClusterParams {
    pub(crate) password: Option<String>,
    pub(crate) username: Option<String>,
    pub(crate) read_from_replicas: ReadFromReplicaStrategy,
    /// tls indicates tls behavior of connections.
    /// When Some(TlsMode), connections use tls and verify certification depends on TlsMode.
    /// When None, connections do not use tls.
    pub(crate) tls: Option<TlsMode>,
    pub(crate) retry_params: RetryParams,
    pub(crate) topology_checks_interval: Option<Duration>,
    pub(crate) slots_refresh_rate_limit: SlotsRefreshRateLimit,
    pub(crate) connections_validation_interval: Option<Duration>,
    pub(crate) tls_params: Option<TlsConnParams>,
    pub(crate) client_name: Option<String>,
    pub(crate) lib_name: Option<String>,
    pub(crate) connection_timeout: Duration,
    pub(crate) response_timeout: Duration,
    pub(crate) protocol: ProtocolVersion,
    pub(crate) reconnect_retry_strategy: Option<RetryStrategy>,
    pub(crate) refresh_topology_from_initial_nodes: bool,
    pub(crate) database_id: i64,
    pub(crate) tcp_nodelay: bool,
}

impl ClusterParams {
    fn from(value: BuilderParams) -> Result<Self> {
        let tls_params = {
            let retrieved_tls_params = value.certs.clone().map(retrieve_tls_certificates);

            retrieved_tls_params.transpose()?
        };

        Ok(Self {
            password: value.password,
            username: value.username,
            read_from_replicas: value.read_from_replicas,
            tls: value.tls,
            retry_params: value.retries_configuration,
            connection_timeout: value
                .connection_timeout
                .unwrap_or(crate::connection::factory::NO_TIMEOUT),
            topology_checks_interval: value.topology_checks_interval,
            slots_refresh_rate_limit: value.slots_refresh_rate_limit,
            connections_validation_interval: value.connections_validation_interval,
            tls_params,
            client_name: value.client_name,
            lib_name: value.lib_name,
            response_timeout: value
                .response_timeout
                .unwrap_or(crate::connection::factory::NO_TIMEOUT),
            protocol: value.protocol,
            reconnect_retry_strategy: value.reconnect_retry_strategy,
            refresh_topology_from_initial_nodes: value.refresh_topology_from_initial_nodes,
            database_id: value.database_id,
            tcp_nodelay: value.tcp_nodelay,
        })
    }
}

impl ClusterParams {
    /// Create a `ClusterParams` with sensible defaults for unit tests.
    #[cfg(test)]
    pub(crate) fn default_for_test(password: Option<String>) -> Self {
        Self {
            password,
            username: None,
            read_from_replicas: ReadFromReplicaStrategy::AlwaysFromPrimary,
            tls: None,
            retry_params: Default::default(),
            connection_timeout: Duration::from_secs(1),
            topology_checks_interval: None,
            slots_refresh_rate_limit: Default::default(),
            connections_validation_interval: None,
            tls_params: None,
            client_name: None,
            lib_name: None,
            response_timeout: Duration::from_secs(1),
            protocol: ProtocolVersion::RESP2,
            reconnect_retry_strategy: None,
            refresh_topology_from_initial_nodes: false,
            database_id: 0,
            tcp_nodelay: false,
        }
    }
}

/// Used to configure and build a [`ClusterClient`].
pub struct ClusterClientBuilder {
    initial_nodes: Result<Vec<ConnectionInfo>>,
    builder_params: BuilderParams,
}

impl ClusterClientBuilder {
    /// Creates a new `ClusterClientBuilder` with the provided initial_nodes.
    ///
    /// This is the same as `ClusterClient::builder(initial_nodes)`.
    pub fn new<T: IntoConnectionInfo>(
        initial_nodes: impl IntoIterator<Item = T>,
    ) -> ClusterClientBuilder {
        ClusterClientBuilder {
            initial_nodes: initial_nodes
                .into_iter()
                .map(|x| x.into_connection_info())
                .collect(),
            builder_params: Default::default(),
        }
    }

    /// Creates a new [`ClusterClient`] from the parameters.
    ///
    /// This does not create connections to the Redis Cluster, but only performs some basic checks
    /// on the initial nodes' URLs and passwords/usernames.
    ///
    /// When the `tls-rustls` feature is enabled and TLS credentials are provided, they are set for
    /// each cluster connection.
    ///
    /// # Errors
    ///
    /// Upon failure to parse initial nodes or if the initial nodes have different passwords or
    /// usernames, an error is returned.
    pub fn build(self) -> Result<ClusterClient> {
        let initial_nodes = self.initial_nodes?;

        let first_node = match initial_nodes.first() {
            Some(node) => node,
            None => {
                return Err(Error::from((
                    ErrorKind::InvalidClientConfig,
                    "Initial nodes can't be empty.",
                )));
            }
        };

        let mut cluster_params = ClusterParams::from(self.builder_params)?;
        let password = if cluster_params.password.is_none() {
            cluster_params
                .password
                .clone_from(&first_node.valkey.password);
            &cluster_params.password
        } else {
            &cluster_params.password
        };
        let username = if cluster_params.username.is_none() {
            cluster_params
                .username
                .clone_from(&first_node.valkey.username);
            &cluster_params.username
        } else {
            &cluster_params.username
        };
        if cluster_params.tls.is_none() {
            cluster_params.tls = match first_node.addr {
                ConnectionAddr::TcpTls {
                    host: _,
                    port: _,
                    insecure,
                    tls_params: _,
                } => Some(match insecure {
                    false => TlsMode::Secure,
                    true => TlsMode::Insecure,
                }),
                _ => None,
            };
        }

        // Validate cross-seed TLS consistency: all seeds must agree on TLS vs non-TLS.
        let mut has_tls = false;
        let mut has_non_tls = false;
        for node in &initial_nodes {
            match &node.addr {
                ConnectionAddr::TcpTls { .. } => has_tls = true,
                ConnectionAddr::Tcp(..) => has_non_tls = true,
                ConnectionAddr::Unix(_) => {} // rejected below
            }
        }
        if has_tls && has_non_tls {
            return Err(Error::from((
                ErrorKind::InvalidClientConfig,
                "Cannot mix TLS and non-TLS seed nodes. All seeds must use the same scheme (redis:// or rediss://).",
            )));
        }

        let mut nodes = Vec::with_capacity(initial_nodes.len());
        // Validate per-seed credentials and settings. Seeds without embedded
        // credentials (username/password = None) are allowed -- they inherit
        // the credentials set on the builder (or extracted from the first node
        // above). Only seeds that *explicitly* set credentials to a *different*
        // value than the builder's are rejected, ensuring a single consistent
        // identity across the cluster.
        for mut node in initial_nodes {
            if let ConnectionAddr::Unix(_) = node.addr {
                return Err(Error::from((
                    ErrorKind::InvalidClientConfig,
                    "This library cannot use unix socket because Redis's cluster command returns only cluster's IP and port.",
                )));
            }

            if password.is_some()
                && node.valkey.password.is_some()
                && node.valkey.password != *password
            {
                return Err(Error::from((
                    ErrorKind::InvalidClientConfig,
                    "Cannot use different password among initial nodes.",
                )));
            }

            if username.is_some()
                && node.valkey.username.is_some()
                && node.valkey.username != *username
            {
                return Err(Error::from((
                    ErrorKind::InvalidClientConfig,
                    "Cannot use different username among initial nodes.",
                )));
            }

            if node.valkey.client_name.is_some()
                && node.valkey.client_name != cluster_params.client_name
            {
                return Err(Error::from((
                    ErrorKind::InvalidClientConfig,
                    "Cannot use different client_name among initial nodes.",
                )));
            }

            node.valkey.protocol = cluster_params.protocol;
            nodes.push(node);
        }

        Ok(ClusterClient {
            initial_nodes: nodes,
            cluster_params,
        })
    }

    /// Sets client name for the new ClusterClient.
    pub fn client_name(mut self, client_name: String) -> ClusterClientBuilder {
        self.builder_params.client_name = Some(client_name);
        self
    }

    /// Sets library name for the new ClusterClient.
    pub fn lib_name(mut self, lib_name: String) -> ClusterClientBuilder {
        self.builder_params.lib_name = Some(lib_name);
        self
    }

    /// Sets password for the new ClusterClient.
    pub fn password(mut self, password: String) -> ClusterClientBuilder {
        self.builder_params.password = Some(password);
        self
    }

    /// Sets username for the new ClusterClient.
    pub fn username(mut self, username: String) -> ClusterClientBuilder {
        self.builder_params.username = Some(username);
        self
    }

    /// Sets number of retries for the new ClusterClient.
    pub fn retries(mut self, retries: u32) -> ClusterClientBuilder {
        self.builder_params.retries_configuration.number_of_retries = retries;
        self
    }

    /// Sets maximal wait time in milliseconds between retries for the new ClusterClient.
    pub fn max_retry_wait(mut self, max_wait: u64) -> ClusterClientBuilder {
        self.builder_params.retries_configuration.max_wait_time = max_wait;
        self
    }

    /// Sets minimal wait time in milliseconds between retries for the new ClusterClient.
    pub fn min_retry_wait(mut self, min_wait: u64) -> ClusterClientBuilder {
        self.builder_params.retries_configuration.min_wait_time = min_wait;
        self
    }

    /// Sets the factor and exponent base for the retry wait time.
    /// The formula for the wait is rand(min_wait_retry .. min(max_retry_wait , factor * exponent_base ^ retry))ms.
    pub fn retry_wait_formula(mut self, factor: u64, exponent_base: u64) -> ClusterClientBuilder {
        self.builder_params.retries_configuration.factor = factor;
        self.builder_params.retries_configuration.exponent_base = exponent_base;
        self
    }

    /// Sets TLS mode for the new ClusterClient.
    ///
    /// It is extracted from the first node of initial_nodes if not set.
    pub fn tls(mut self, tls: TlsMode) -> ClusterClientBuilder {
        self.builder_params.tls = Some(tls);
        self
    }

    /// Sets raw TLS certificates for the new ClusterClient.
    ///
    /// When set, enforces the connection must be TLS secured.
    ///
    /// All certificates must be provided as byte streams loaded from PEM files their consistency is
    /// checked during `build()` call.
    ///
    /// - `certificates` - `TlsCertificates` structure containing:
    ///   -- `client_tls` - Optional `ClientTlsConfig` containing byte streams for
    ///   --- `client_cert` - client's byte stream containing client certificate in PEM format
    ///   --- `client_key` - client's byte stream containing private key in PEM format
    ///   -- `root_cert` - Optional byte stream yielding PEM formatted file for root certificates.
    ///
    /// If `ClientTlsConfig` ( cert+key pair ) is not provided, then client-side authentication is not enabled.
    /// If `root_cert` is not provided, then system root certificates are used instead.
    pub fn certs(mut self, certificates: TlsCertificates) -> ClusterClientBuilder {
        self.builder_params.tls = Some(TlsMode::Secure);
        self.builder_params.certs = Some(certificates);
        self
    }

    /// Enables reading from replicas for all new connections (default is disabled).
    ///
    /// If enabled, then read queries will go to the replica nodes & write queries will go to the
    /// primary nodes. If there are no replica nodes, then all queries will go to the primary nodes.
    pub fn read_from_replicas(mut self) -> ClusterClientBuilder {
        self.builder_params.read_from_replicas = ReadFromReplicaStrategy::RoundRobin;
        self
    }

    /// Set the read strategy for this client.
    ///
    /// The parameter `read_strategy` can be one of:
    /// `ReadFromReplicaStrategy::AZAffinity(availability_zone)` - attempt to access replicas in the same availability zone.
    /// If no suitable replica is found (i.e. no replica could be found in the requested availability zone), choose any replica. Falling back to primary if needed.
    /// `ReadFromReplicaStrategy::AZAffinityReplicasAndPrimary(availability_zone)` - attempt to access nodes in the same availability zone.
    ///  prioritizing local replicas, then the local primary, and falling back to any replica or the primary if needed.
    /// `ReadFromReplicaStrategy::RoundRobin` - reads are distributed across replicas for load balancing using round-robin algorithm. Falling back to primary if needed.
    /// `ReadFromReplicaStrategy::AlwaysFromPrimary` ensures all read and write queries are directed to the primary node.
    ///
    /// # Parameters
    /// - `read_strategy`: defines the replica routing strategy.
    pub fn read_from(mut self, read_strategy: ReadFromReplicaStrategy) -> ClusterClientBuilder {
        self.builder_params.read_from_replicas = read_strategy;
        self
    }

    /// Set reconnect retry strategy configuration for this client
    ///
    /// # Parameters
    /// - `reconnect_retry_strategy`: Use the `reconnect_retry_strategy` to set the reconnect backoff with jitter params.
    pub fn reconnect_retry_strategy(
        mut self,
        reconnect_retry_strategy: RetryStrategy,
    ) -> ClusterClientBuilder {
        self.builder_params.reconnect_retry_strategy = Some(reconnect_retry_strategy);
        self
    }

    /// Enables periodic topology checks for this client.
    ///
    /// If enabled, periodic topology checks will be executed at the configured intervals to examine whether there
    /// have been any changes in the cluster's topology. If a change is detected, it will trigger a slot refresh.
    /// Unlike slot refreshments, the periodic topology checks only examine a limited number of nodes to query their
    /// topology, ensuring that the check remains quick and efficient.
    pub fn periodic_topology_checks(mut self, interval: Duration) -> ClusterClientBuilder {
        self.builder_params.topology_checks_interval = Some(interval);
        self
    }

    /// Enables periodic connections checks for this client.
    /// If enabled, the connections to the cluster nodes will be validated periodically, per configured interval.
    /// In addition, for tokio runtime, passive disconnections could be detected instantly,
    /// triggering reestablishment, w/o waiting for the next periodic check.
    pub fn periodic_connections_checks(
        mut self,
        interval: Option<Duration>,
    ) -> ClusterClientBuilder {
        self.builder_params.connections_validation_interval = interval;
        self
    }

    /// Sets the rate limit for slot refresh operations in the cluster.
    ///
    /// This method configures the interval duration between consecutive slot
    /// refresh operations and an additional jitter to introduce randomness
    /// in the refresh intervals.
    ///
    /// # Parameters
    ///
    /// * `interval_duration`: The minimum duration to wait between consecutive slot refresh operations.
    /// * `max_jitter_milli`: The maximum jitter in milliseconds to add to the interval duration.
    ///
    /// # Defaults
    ///
    /// If not set, the slots refresh rate limit configurations will be set with the default values:
    /// ```ignore
    /// use ferriskey::cluster::topology::{DEFAULT_SLOTS_REFRESH_MAX_JITTER_MILLI, DEFAULT_SLOTS_REFRESH_WAIT_DURATION};
    /// ```ignore
    ///
    /// - `interval_duration`: `DEFAULT_SLOTS_REFRESH_WAIT_DURATION`
    /// - `max_jitter_milli`: `DEFAULT_SLOTS_REFRESH_MAX_JITTER_MILLI`
    ///
    pub fn slots_refresh_rate_limit(
        mut self,
        interval_duration: Duration,
        max_jitter_milli: u64,
    ) -> ClusterClientBuilder {
        self.builder_params.slots_refresh_rate_limit = SlotsRefreshRateLimit {
            interval_duration,
            max_jitter_milli,
        };
        self
    }

    /// Enables refreshing the cluster topology from seed nodes.
    ///
    /// When enabled, the client will periodically query the seed nodes (the nodes provided when
    /// creating the client) to update its internal view of the cluster topology.
    pub fn refresh_topology_from_initial_nodes(
        mut self,
        refresh_topology_from_initial_nodes: bool,
    ) -> ClusterClientBuilder {
        self.builder_params.refresh_topology_from_initial_nodes =
            refresh_topology_from_initial_nodes;
        self
    }

    /// Sets the TCP_NODELAY socket option.
    ///
    /// When true, disables Nagle's algorithm for lower latency.
    /// When false, enables Nagle's algorithm to reduce network overhead.
    /// Defaults to true if not set.
    pub fn tcp_nodelay(mut self, tcp_nodelay: bool) -> ClusterClientBuilder {
        self.builder_params.tcp_nodelay = tcp_nodelay;
        self
    }

    /// Enables timing out on slow connection time.
    ///
    /// If enabled, the cluster will only wait the given time on each connection attempt to each node.
    pub fn connection_timeout(mut self, connection_timeout: Duration) -> ClusterClientBuilder {
        self.builder_params.connection_timeout = Some(connection_timeout);
        self
    }

    /// Enables timing out on slow responses.
    ///
    /// If enabled, the cluster will only wait the given time to each response from each node.
    pub fn response_timeout(mut self, response_timeout: Duration) -> ClusterClientBuilder {
        self.builder_params.response_timeout = Some(response_timeout);
        self
    }

    /// Sets the protocol with which the client should communicate with the server.
    pub fn use_protocol(mut self, protocol: ProtocolVersion) -> ClusterClientBuilder {
        self.builder_params.protocol = protocol;
        self
    }

    /// Sets the database ID for the new ClusterClient.
    ///
    /// Note: Database selection in cluster mode requires server support for multiple databases.
    /// Most cluster configurations only support database 0.
    pub fn database_id(mut self, database_id: i64) -> ClusterClientBuilder {
        self.builder_params.database_id = database_id;
        self
    }
}

/// This is a valkey Cluster client.
#[derive(Clone)]
pub struct ClusterClient {
    initial_nodes: Vec<ConnectionInfo>,
    cluster_params: ClusterParams,
}

impl ClusterClient {
    /// Creates a `ClusterClient` with the default parameters.
    ///
    /// This does not create connections to the Redis Cluster, but only performs some basic checks
    /// on the initial nodes' URLs and passwords/usernames.
    ///
    /// # Errors
    ///
    /// Upon failure to parse initial nodes or if the initial nodes have different passwords or
    /// usernames, an error is returned.
    pub fn new<T: IntoConnectionInfo>(
        initial_nodes: impl IntoIterator<Item = T>,
    ) -> Result<ClusterClient> {
        Self::builder(initial_nodes).build()
    }

    /// Creates a [`ClusterClientBuilder`] with the provided initial_nodes.
    pub fn builder<T: IntoConnectionInfo>(
        initial_nodes: impl IntoIterator<Item = T>,
    ) -> ClusterClientBuilder {
        ClusterClientBuilder::new(initial_nodes)
    }

    /// Creates new connections to Redis Cluster nodes and returns a
    /// [`cluster::ClusterConnection`].
    ///
    /// # Errors
    ///
    /// An error is returned if there is a failure while creating connections or slots.
    /// Creates new connections to Redis Cluster nodes and returns a
    /// [`cluster::ClusterConnection`].
    pub async fn get_async_connection(
        &self,
        push_sender: Option<mpsc::UnboundedSender<PushInfo>>,
        pubsub_synchronizer: Option<Arc<dyn crate::pubsub::synchronizer_trait::PubSubSynchronizer>>,
        iam_token_provider: Option<Arc<dyn crate::connection::factory::IAMTokenProvider>>,
    ) -> Result<cluster::ClusterConnection> {
        cluster::ClusterConnection::new(
            &self.initial_nodes,
            self.cluster_params.clone(),
            push_sender,
            pubsub_synchronizer,
            iam_token_provider,
        )
        .await
    }

    #[doc(hidden)]
    pub async fn get_async_generic_connection<C>(
        &self,
    ) -> Result<cluster::ClusterConnection<C>>
    where
        C: crate::connection::ConnectionLike
            + cluster::Connect
            + Clone
            + Send
            + Sync
            + Unpin
            + 'static,
    {
        cluster::ClusterConnection::new(
            &self.initial_nodes,
            self.cluster_params.clone(),
            None,
            None,
            None,
        )
        .await
    }
}

#[cfg(test)]
mod tests {
    use crate::cluster::topology::{
        DEFAULT_SLOTS_REFRESH_MAX_JITTER_MILLI, DEFAULT_SLOTS_REFRESH_WAIT_DURATION,
    };

    use super::{ClusterClient, ClusterClientBuilder, ConnectionInfo, IntoConnectionInfo};

    fn get_connection_data() -> Vec<ConnectionInfo> {
        vec![
            "redis://127.0.0.1:6379".into_connection_info().unwrap(),
            "redis://127.0.0.1:6378".into_connection_info().unwrap(),
            "redis://127.0.0.1:6377".into_connection_info().unwrap(),
        ]
    }

    fn get_connection_data_with_password() -> Vec<ConnectionInfo> {
        vec![
            "redis://:password@127.0.0.1:6379"
                .into_connection_info()
                .unwrap(),
            "redis://:password@127.0.0.1:6378"
                .into_connection_info()
                .unwrap(),
            "redis://:password@127.0.0.1:6377"
                .into_connection_info()
                .unwrap(),
        ]
    }

    fn get_connection_data_with_username_and_password() -> Vec<ConnectionInfo> {
        vec![
            "redis://user1:password@127.0.0.1:6379"
                .into_connection_info()
                .unwrap(),
            "redis://user1:password@127.0.0.1:6378"
                .into_connection_info()
                .unwrap(),
            "redis://user1:password@127.0.0.1:6377"
                .into_connection_info()
                .unwrap(),
        ]
    }

    #[test]
    fn give_no_password() {
        let client = ClusterClient::new(get_connection_data()).unwrap();
        assert_eq!(client.cluster_params.password, None);
    }

    #[test]
    fn give_password_by_initial_nodes() {
        let client = ClusterClient::new(get_connection_data_with_password()).unwrap();
        assert_eq!(client.cluster_params.password, Some("password".to_string()));
    }

    #[test]
    fn give_username_and_password_by_initial_nodes() {
        let client = ClusterClient::new(get_connection_data_with_username_and_password()).unwrap();
        assert_eq!(client.cluster_params.password, Some("password".to_string()));
        assert_eq!(client.cluster_params.username, Some("user1".to_string()));
    }

    #[test]
    fn give_different_password_by_initial_nodes() {
        let result = ClusterClient::new(vec![
            "redis://:password1@127.0.0.1:6379",
            "redis://:password2@127.0.0.1:6378",
            "redis://:password3@127.0.0.1:6377",
        ]);
        assert!(result.is_err());
    }

    #[test]
    fn give_different_username_by_initial_nodes() {
        let result = ClusterClient::new(vec![
            "redis://user1:password@127.0.0.1:6379",
            "redis://user2:password@127.0.0.1:6378",
            "redis://user1:password@127.0.0.1:6377",
        ]);
        assert!(result.is_err());
    }

    #[test]
    fn give_username_password_by_method() {
        // Builder-set credentials work with seeds that have no embedded creds
        let client = ClusterClientBuilder::new(get_connection_data())
            .password("pass".to_string())
            .username("user1".to_string())
            .build()
            .unwrap();
        assert_eq!(client.cluster_params.password, Some("pass".to_string()));
        assert_eq!(client.cluster_params.username, Some("user1".to_string()));
    }

    #[test]
    fn give_username_password_by_method_matching_seeds() {
        // Builder-set credentials that match seed credentials should succeed
        let client = ClusterClientBuilder::new(get_connection_data_with_password())
            .password("password".to_string())
            .username("user1".to_string())
            .build()
            .unwrap();
        assert_eq!(
            client.cluster_params.password,
            Some("password".to_string())
        );
        assert_eq!(client.cluster_params.username, Some("user1".to_string()));
    }

    #[test]
    fn give_password_by_method_mismatching_seeds() {
        // Builder-set password that conflicts with seed passwords should fail
        let result = ClusterClientBuilder::new(get_connection_data_with_password())
            .password("different_pass".to_string())
            .build();
        assert!(result.is_err());
    }

    #[test]
    fn give_empty_initial_nodes() {
        let client = ClusterClient::new(Vec::<String>::new());
        assert!(client.is_err())
    }

    #[test]
    fn give_slots_refresh_rate_limit_configurations() {
        let interval_dur = std::time::Duration::from_secs(20);
        let client = ClusterClientBuilder::new(get_connection_data())
            .slots_refresh_rate_limit(interval_dur, 500)
            .build()
            .unwrap();
        assert_eq!(
            client
                .cluster_params
                .slots_refresh_rate_limit
                .interval_duration,
            interval_dur
        );
        assert_eq!(
            client
                .cluster_params
                .slots_refresh_rate_limit
                .max_jitter_milli,
            500
        );
    }

    #[test]
    fn dont_give_slots_refresh_rate_limit_configurations_uses_defaults() {
        let client = ClusterClientBuilder::new(get_connection_data())
            .build()
            .unwrap();
        assert_eq!(
            client
                .cluster_params
                .slots_refresh_rate_limit
                .interval_duration,
            DEFAULT_SLOTS_REFRESH_WAIT_DURATION
        );
        assert_eq!(
            client
                .cluster_params
                .slots_refresh_rate_limit
                .max_jitter_milli,
            DEFAULT_SLOTS_REFRESH_MAX_JITTER_MILLI
        );
    }

    #[test]
    fn mixed_tls_and_non_tls_seeds_rejected() {
        let result = ClusterClient::new(vec![
            "redis://127.0.0.1:6379",
            "rediss://127.0.0.1:6380",
        ]);
        assert!(result.is_err());
    }

    #[test]
    fn all_tls_seeds_accepted() {
        let result = ClusterClient::new(vec![
            "rediss://127.0.0.1:6379",
            "rediss://127.0.0.1:6380",
        ]);
        assert!(result.is_ok());
    }

    #[test]
    fn all_non_tls_seeds_accepted() {
        let result = ClusterClient::new(vec![
            "redis://127.0.0.1:6379",
            "redis://127.0.0.1:6380",
        ]);
        assert!(result.is_ok());
    }
}