amaters-cluster 0.2.2

Consensus layer for AmateRS (Ukehi)
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
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
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
//! Shard metadata and operations
//!
//! This module defines the core types for distributed sharding in AmateRS.
//! It handles shard metadata, split/merge operations, and data migration.

use crate::error::{RaftError, RaftResult};
use crate::types::NodeId;
use amaters_core::Key;
use std::collections::BTreeMap;
use std::sync::Arc;
use std::time::{Duration, SystemTime};

/// Unique identifier for a shard
pub type ShardId = u64;

/// Shard state
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ShardState {
    /// Shard is active and serving requests
    Active,
    /// Shard is being split into two shards
    Splitting,
    /// Shard is being merged with another shard
    Merging,
    /// Shard is being transferred to another node
    Transferring,
    /// Shard is offline (node failure or maintenance)
    Offline,
}

impl ShardState {
    /// Check if the shard can serve read requests
    pub fn can_read(&self) -> bool {
        matches!(
            self,
            ShardState::Active | ShardState::Splitting | ShardState::Transferring
        )
    }

    /// Check if the shard can serve write requests
    pub fn can_write(&self) -> bool {
        matches!(self, ShardState::Active)
    }

    /// Get the state name as a string
    pub fn as_str(&self) -> &'static str {
        match self {
            ShardState::Active => "Active",
            ShardState::Splitting => "Splitting",
            ShardState::Merging => "Merging",
            ShardState::Transferring => "Transferring",
            ShardState::Offline => "Offline",
        }
    }
}

/// Key range for a shard
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct KeyRange {
    /// Start key (inclusive)
    pub start: Key,
    /// End key (exclusive)
    pub end: Key,
}

impl KeyRange {
    /// Create a new key range
    pub fn new(start: Key, end: Key) -> RaftResult<Self> {
        if start >= end {
            return Err(RaftError::ConfigError {
                message: format!("Invalid key range: start {:?} >= end {:?}", start, end),
            });
        }
        Ok(Self { start, end })
    }

    /// Check if a key is within this range
    pub fn contains(&self, key: &Key) -> bool {
        key >= &self.start && key < &self.end
    }

    /// Check if this range overlaps with another range
    pub fn overlaps(&self, other: &KeyRange) -> bool {
        self.start < other.end && other.start < self.end
    }

    /// Calculate the midpoint key for splitting.
    ///
    /// Returns a key M such that `self.start <= M < self.end`.
    ///
    /// Both keys are padded to the same length with trailing zero bytes and
    /// treated as big-endian integers, so keys of different lengths are handled
    /// correctly (e.g. midpoint("y", "yyyyyy") yields [0x79, 0x3C, …], not "z").
    pub fn midpoint(&self) -> Key {
        let start_bytes = self.start.as_bytes();
        let end_bytes = self.end.as_bytes();
        let max_len = start_bytes.len().max(end_bytes.len());

        let get_byte = |v: &[u8], i: usize| -> u16 { v.get(i).copied().unwrap_or(0) as u16 };

        // Step 1: byte-wise sum with right-to-left carry propagation.
        let mut sum: Vec<u16> = (0..max_len)
            .map(|i| get_byte(start_bytes, i) + get_byte(end_bytes, i))
            .collect();
        let mut carry: u16 = 0;
        for b in sum.iter_mut().rev() {
            let v = *b + carry;
            *b = v & 0xFF;
            carry = v >> 8; // 0 or 1
        }
        // carry: 0 or 1 — overflow bit above position 0

        // Step 2: divide (carry || sum) by 2 via left-to-right bit-shift.
        let mut mid: Vec<u8> = Vec::with_capacity(max_len);
        let mut half_carry = carry; // the leading overflow bit
        for b in &sum {
            let val = half_carry * 256 + b;
            mid.push((val / 2) as u8);
            half_carry = val % 2;
        }
        // Discard the trailing remainder bit — it truncates (floor), keeping mid < end.

        // Note: we intentionally do NOT strip trailing zeros here. Stripping could
        // make `mid` lexicographically shorter than `start`, e.g. when both keys
        // begin with 0x00 bytes. The extra trailing zeros are harmless — they just
        // extend the resulting key to the same length as the longer of the two inputs.

        Key::from_slice(&mid)
    }

    /// Create a range that covers all possible keys
    pub fn full() -> Self {
        Self {
            start: Key::from_slice(&[0u8]),
            end: Key::from_slice(&[0xFFu8; 32]),
        }
    }
}

/// Shard metadata tracking
#[derive(Debug, Clone)]
pub struct ShardMetadata {
    /// Unique shard identifier
    pub id: ShardId,
    /// Key range this shard is responsible for
    pub range: KeyRange,
    /// Current state of the shard
    pub state: ShardState,
    /// Node ID where this shard is located
    pub node_id: NodeId,
    /// Replica node IDs (for fault tolerance)
    pub replicas: Vec<NodeId>,
    /// Estimated number of keys in this shard
    pub estimated_keys: u64,
    /// Estimated size in bytes
    pub estimated_size_bytes: u64,
    /// Last update timestamp
    pub last_updated: SystemTime,
    /// Creation timestamp
    pub created_at: SystemTime,
    /// Version number for optimistic concurrency control
    pub version: u64,
}

impl ShardMetadata {
    /// Create new shard metadata
    pub fn new(id: ShardId, range: KeyRange, node_id: NodeId) -> Self {
        let now = SystemTime::now();
        Self {
            id,
            range,
            state: ShardState::Active,
            node_id,
            replicas: Vec::new(),
            estimated_keys: 0,
            estimated_size_bytes: 0,
            last_updated: now,
            created_at: now,
            version: 1,
        }
    }

    /// Update shard state
    pub fn set_state(&mut self, state: ShardState) {
        self.state = state;
        self.last_updated = SystemTime::now();
        self.version += 1;
    }

    /// Update shard statistics
    pub fn update_stats(&mut self, estimated_keys: u64, estimated_size_bytes: u64) {
        self.estimated_keys = estimated_keys;
        self.estimated_size_bytes = estimated_size_bytes;
        self.last_updated = SystemTime::now();
        self.version += 1;
    }

    /// Add a replica
    pub fn add_replica(&mut self, node_id: NodeId) -> RaftResult<()> {
        if self.replicas.contains(&node_id) {
            return Err(RaftError::ConfigError {
                message: format!("Replica {} already exists for shard {}", node_id, self.id),
            });
        }
        self.replicas.push(node_id);
        self.last_updated = SystemTime::now();
        self.version += 1;
        Ok(())
    }

    /// Remove a replica
    pub fn remove_replica(&mut self, node_id: NodeId) -> RaftResult<()> {
        let initial_len = self.replicas.len();
        self.replicas.retain(|&id| id != node_id);
        if self.replicas.len() == initial_len {
            return Err(RaftError::ConfigError {
                message: format!("Replica {} not found for shard {}", node_id, self.id),
            });
        }
        self.last_updated = SystemTime::now();
        self.version += 1;
        Ok(())
    }

    /// Check if this shard is hot (exceeds threshold)
    pub fn is_hot(&self, key_threshold: u64, size_threshold: u64) -> bool {
        self.estimated_keys > key_threshold || self.estimated_size_bytes > size_threshold
    }

    /// Check if this shard is cold (below threshold)
    pub fn is_cold(&self, key_threshold: u64, size_threshold: u64) -> bool {
        self.estimated_keys < key_threshold && self.estimated_size_bytes < size_threshold
    }

    /// Check if the shard metadata is stale
    pub fn is_stale(&self, max_age: Duration) -> bool {
        self.last_updated
            .elapsed()
            .map(|elapsed| elapsed > max_age)
            .unwrap_or(false)
    }
}

/// Shard split operation descriptor
#[derive(Debug, Clone)]
pub struct ShardSplit {
    /// Source shard ID
    pub source_shard_id: ShardId,
    /// First new shard ID (left range)
    pub left_shard_id: ShardId,
    /// Second new shard ID (right range)
    pub right_shard_id: ShardId,
    /// Split point key
    pub split_key: Key,
    /// Timestamp when split was initiated
    pub initiated_at: SystemTime,
}

impl ShardSplit {
    /// Create a new shard split descriptor
    pub fn new(
        source_shard_id: ShardId,
        left_shard_id: ShardId,
        right_shard_id: ShardId,
        split_key: Key,
    ) -> Self {
        Self {
            source_shard_id,
            left_shard_id,
            right_shard_id,
            split_key,
            initiated_at: SystemTime::now(),
        }
    }

    /// Create left and right shard metadata from source
    pub fn create_shards(
        &self,
        source: &ShardMetadata,
    ) -> RaftResult<(ShardMetadata, ShardMetadata)> {
        // Create left shard (start to split_key)
        let left_range = KeyRange::new(source.range.start.clone(), self.split_key.clone())?;
        let mut left_shard = ShardMetadata::new(self.left_shard_id, left_range, source.node_id);
        left_shard.replicas = source.replicas.clone();

        // Create right shard (split_key to end)
        let right_range = KeyRange::new(self.split_key.clone(), source.range.end.clone())?;
        let mut right_shard = ShardMetadata::new(self.right_shard_id, right_range, source.node_id);
        right_shard.replicas = source.replicas.clone();

        // Estimate stats (simple equal split assumption)
        left_shard.estimated_keys = source.estimated_keys / 2;
        left_shard.estimated_size_bytes = source.estimated_size_bytes / 2;
        right_shard.estimated_keys = source.estimated_keys / 2;
        right_shard.estimated_size_bytes = source.estimated_size_bytes / 2;

        Ok((left_shard, right_shard))
    }
}

/// Shard merge operation descriptor
#[derive(Debug, Clone)]
pub struct ShardMerge {
    /// First source shard ID (should have lower key range)
    pub left_shard_id: ShardId,
    /// Second source shard ID (should have higher key range)
    pub right_shard_id: ShardId,
    /// Target merged shard ID
    pub target_shard_id: ShardId,
    /// Timestamp when merge was initiated
    pub initiated_at: SystemTime,
}

impl ShardMerge {
    /// Create a new shard merge descriptor
    pub fn new(left_shard_id: ShardId, right_shard_id: ShardId, target_shard_id: ShardId) -> Self {
        Self {
            left_shard_id,
            right_shard_id,
            target_shard_id,
            initiated_at: SystemTime::now(),
        }
    }

    /// Validate that two shards can be merged
    pub fn validate(&self, left: &ShardMetadata, right: &ShardMetadata) -> RaftResult<()> {
        // Check that key ranges are adjacent
        if left.range.end != right.range.start {
            return Err(RaftError::ConfigError {
                message: format!(
                    "Shards {} and {} are not adjacent (left.end={:?}, right.start={:?})",
                    left.id, right.id, left.range.end, right.range.start
                ),
            });
        }

        // Check that shards are on the same node
        if left.node_id != right.node_id {
            return Err(RaftError::ConfigError {
                message: format!(
                    "Shards {} and {} are on different nodes ({} vs {})",
                    left.id, right.id, left.node_id, right.node_id
                ),
            });
        }

        Ok(())
    }

    /// Create merged shard metadata
    pub fn create_merged_shard(
        &self,
        left: &ShardMetadata,
        right: &ShardMetadata,
    ) -> RaftResult<ShardMetadata> {
        self.validate(left, right)?;

        let merged_range = KeyRange::new(left.range.start.clone(), right.range.end.clone())?;

        let mut merged = ShardMetadata::new(self.target_shard_id, merged_range, left.node_id);

        // Combine statistics
        merged.estimated_keys = left.estimated_keys + right.estimated_keys;
        merged.estimated_size_bytes = left.estimated_size_bytes + right.estimated_size_bytes;

        // Use replicas from left shard (should be same as right)
        merged.replicas = left.replicas.clone();

        Ok(merged)
    }
}

/// Shard transfer operation descriptor
#[derive(Debug, Clone)]
pub struct ShardTransfer {
    /// Shard ID being transferred
    pub shard_id: ShardId,
    /// Source node ID
    pub from_node: NodeId,
    /// Destination node ID
    pub to_node: NodeId,
    /// Transfer progress (0.0 to 1.0)
    pub progress: f64,
    /// Timestamp when transfer was initiated
    pub initiated_at: SystemTime,
    /// Estimated completion time
    pub estimated_completion: Option<SystemTime>,
}

impl ShardTransfer {
    /// Create a new shard transfer descriptor
    pub fn new(shard_id: ShardId, from_node: NodeId, to_node: NodeId) -> Self {
        Self {
            shard_id,
            from_node,
            to_node,
            progress: 0.0,
            initiated_at: SystemTime::now(),
            estimated_completion: None,
        }
    }

    /// Update transfer progress
    pub fn update_progress(&mut self, progress: f64) {
        self.progress = progress.clamp(0.0, 1.0);

        // Estimate completion time based on progress
        if progress > 0.0 && progress < 1.0 {
            if let Ok(elapsed) = self.initiated_at.elapsed() {
                let total_time = elapsed.as_secs_f64() / progress;
                let remaining_time = total_time * (1.0 - progress);
                self.estimated_completion =
                    Some(SystemTime::now() + Duration::from_secs_f64(remaining_time));
            }
        }
    }

    /// Check if transfer is complete
    pub fn is_complete(&self) -> bool {
        self.progress >= 1.0
    }
}

/// Shard registry for tracking all shards in the cluster
#[derive(Debug, Clone)]
pub struct ShardRegistry {
    /// Map from shard ID to shard metadata
    shards: Arc<parking_lot::RwLock<BTreeMap<ShardId, ShardMetadata>>>,
    /// Next available shard ID
    next_shard_id: Arc<parking_lot::Mutex<ShardId>>,
}

impl ShardRegistry {
    /// Create a new shard registry
    pub fn new() -> Self {
        Self {
            shards: Arc::new(parking_lot::RwLock::new(BTreeMap::new())),
            next_shard_id: Arc::new(parking_lot::Mutex::new(1)),
        }
    }

    /// Allocate a new shard ID
    pub fn allocate_shard_id(&self) -> ShardId {
        let mut next_id = self.next_shard_id.lock();
        let id = *next_id;
        *next_id += 1;
        id
    }

    /// Register a new shard
    pub fn register(&self, shard: ShardMetadata) -> RaftResult<()> {
        let mut shards = self.shards.write();

        // Check for overlapping ranges
        for existing in shards.values() {
            if existing.range.overlaps(&shard.range) {
                return Err(RaftError::ConfigError {
                    message: format!(
                        "Shard {} range overlaps with existing shard {} range",
                        shard.id, existing.id
                    ),
                });
            }
        }

        shards.insert(shard.id, shard);
        Ok(())
    }

    /// Get shard metadata by ID
    pub fn get(&self, shard_id: ShardId) -> Option<ShardMetadata> {
        self.shards.read().get(&shard_id).cloned()
    }

    /// Update shard metadata
    pub fn update(&self, shard: ShardMetadata) -> RaftResult<()> {
        let mut shards = self.shards.write();
        shards.insert(shard.id, shard);
        Ok(())
    }

    /// Remove a shard
    pub fn remove(&self, shard_id: ShardId) -> RaftResult<()> {
        let mut shards = self.shards.write();
        shards
            .remove(&shard_id)
            .ok_or_else(|| RaftError::ConfigError {
                message: format!("Shard {} not found", shard_id),
            })?;
        Ok(())
    }

    /// Get all shards
    pub fn get_all(&self) -> Vec<ShardMetadata> {
        self.shards.read().values().cloned().collect()
    }

    /// Get shards on a specific node
    pub fn get_by_node(&self, node_id: NodeId) -> Vec<ShardMetadata> {
        self.shards
            .read()
            .values()
            .filter(|shard| shard.node_id == node_id)
            .cloned()
            .collect()
    }

    /// Find shard responsible for a key
    pub fn find_shard_for_key(&self, key: &Key) -> Option<ShardMetadata> {
        self.shards
            .read()
            .values()
            .find(|shard| shard.range.contains(key))
            .cloned()
    }

    /// Get total number of shards
    pub fn count(&self) -> usize {
        self.shards.read().len()
    }

    /// Atomic split: parent Active→removed, two children inserted as Active.
    pub fn execute_split(&self, split: &ShardSplit) -> RaftResult<()> {
        let mut shards = self.shards.write();
        let parent = shards
            .get(&split.source_shard_id)
            .ok_or_else(|| RaftError::Other {
                message: format!("execute_split: shard {} not found", split.source_shard_id),
            })?
            .clone();
        if parent.state != ShardState::Active {
            return Err(RaftError::Other {
                message: format!(
                    "execute_split: shard {} is not Active (state={})",
                    split.source_shard_id,
                    parent.state.as_str()
                ),
            });
        }
        let (left, right) = split.create_shards(&parent)?;
        shards.insert(left.id, left);
        shards.insert(right.id, right);
        shards.remove(&split.source_shard_id);
        Ok(())
    }

    /// Atomic merge: both sources validated as Active, merged shard inserted, sources removed.
    pub fn execute_merge(&self, merge: &ShardMerge) -> RaftResult<()> {
        let mut shards = self.shards.write();
        let left = shards
            .get(&merge.left_shard_id)
            .ok_or_else(|| RaftError::Other {
                message: format!(
                    "execute_merge: left shard {} not found",
                    merge.left_shard_id
                ),
            })?
            .clone();
        let right = shards
            .get(&merge.right_shard_id)
            .ok_or_else(|| RaftError::Other {
                message: format!(
                    "execute_merge: right shard {} not found",
                    merge.right_shard_id
                ),
            })?
            .clone();
        if left.state != ShardState::Active {
            return Err(RaftError::Other {
                message: format!(
                    "execute_merge: left shard {} is not Active (state={})",
                    merge.left_shard_id,
                    left.state.as_str()
                ),
            });
        }
        if right.state != ShardState::Active {
            return Err(RaftError::Other {
                message: format!(
                    "execute_merge: right shard {} is not Active (state={})",
                    merge.right_shard_id,
                    right.state.as_str()
                ),
            });
        }
        // create_merged_shard validates adjacency using Active metadata.
        let merged = merge.create_merged_shard(&left, &right)?;
        shards.remove(&merge.left_shard_id);
        shards.remove(&merge.right_shard_id);
        shards.insert(merged.id, merged);
        Ok(())
    }

    /// Atomic transfer: source shard set to Transferring state; a new shard record
    /// with a freshly allocated ID is inserted for the target node as Active.
    ///
    /// Lock ordering: `next_shard_id` Mutex is acquired first (briefly), then
    /// `shards` RwLock — consistent order prevents deadlock.
    pub fn execute_transfer(&self, transfer: &ShardTransfer) -> RaftResult<()> {
        // Allocate the new shard ID before acquiring the shards write-lock
        // so we never hold both locks simultaneously.
        let new_target_id = self.allocate_shard_id();

        let mut shards = self.shards.write();
        let source = shards
            .get(&transfer.shard_id)
            .ok_or_else(|| RaftError::Other {
                message: format!("execute_transfer: shard {} not found", transfer.shard_id),
            })?
            .clone();
        if source.state != ShardState::Active {
            return Err(RaftError::Other {
                message: format!(
                    "execute_transfer: shard {} is not Active (state={})",
                    transfer.shard_id,
                    source.state.as_str()
                ),
            });
        }
        // Build target metadata on the destination node (same range, new ID, Active state).
        let target_shard =
            ShardMetadata::new(new_target_id, source.range.clone(), transfer.to_node);
        // Transition source to Transferring.
        let mut source_transferring = source;
        source_transferring.set_state(ShardState::Transferring);
        // Apply both changes atomically under the single write-lock.
        shards.insert(source_transferring.id, source_transferring);
        shards.insert(new_target_id, target_shard);
        Ok(())
    }
}

impl Default for ShardRegistry {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod prop_tests {
    use super::*;
    use proptest::prelude::*;

    /// Strategy: lowercase ASCII string, length [min, max].
    fn arb_key_str(min: usize, max: usize) -> impl Strategy<Value = String> {
        prop::collection::vec(b'a'..=b'z', min..=max)
            .prop_map(|v| String::from_utf8(v).expect("valid utf-8"))
    }

    proptest! {
        #[test]
        fn prop_key_range_contains_consistent(
            start in arb_key_str(1, 8),
            mid in arb_key_str(1, 8),
            end in arb_key_str(1, 8),
        ) {
            // Only test when start < end (valid range).
            prop_assume!(start < end);
            let range = match KeyRange::new(Key::from_str(&start), Key::from_str(&end)) {
                Ok(r) => r,
                Err(_) => return Ok(()),
            };
            let mid_key = Key::from_str(&mid);
            // [start, end) — inclusive start, exclusive end.
            let expected = mid >= start && mid < end;
            prop_assert_eq!(
                range.contains(&mid_key),
                expected,
                "contains({:?}) in [{:?}, {:?}) should be {}",
                mid,
                start,
                end,
                expected
            );
        }

        #[test]
        fn prop_key_range_midpoint_is_between_bounds(
            start in arb_key_str(1, 5),
            end in arb_key_str(6, 12),
        ) {
            // Property: midpoint lies strictly inside [start, end).
            // Use disjoint length ranges so start < end almost always holds.
            prop_assume!(start < end);
            let range = match KeyRange::new(Key::from_str(&start), Key::from_str(&end)) {
                Ok(r) => r,
                Err(_) => return Ok(()),
            };
            let mid = range.midpoint();
            // Midpoint must satisfy start <= mid < end.
            prop_assert!(
                mid >= range.start,
                "midpoint {:?} must be >= start {:?}",
                mid,
                range.start
            );
            prop_assert!(
                mid < range.end,
                "midpoint {:?} must be < end {:?}",
                mid,
                range.end
            );
        }

        #[test]
        fn prop_key_range_split_no_overlap(
            start in arb_key_str(1, 4),
            end in arb_key_str(8, 12),
        ) {
            // Property: after split at midpoint, no key is in both halves.
            prop_assume!(start < end);
            let range = match KeyRange::new(Key::from_str(&start), Key::from_str(&end)) {
                Ok(r) => r,
                Err(_) => return Ok(()),
            };
            let mid = range.midpoint();
            let (left, right) = match (
                KeyRange::new(range.start.clone(), mid.clone()),
                KeyRange::new(mid.clone(), range.end.clone()),
            ) {
                (Ok(l), Ok(r)) => (l, r),
                _ => return Ok(()), // degenerate midpoint — skip
            };
            // Spot-check: start key is in left, never in right.
            let test_key = Key::from_str(&start);
            let in_left = left.contains(&test_key);
            let in_right = right.contains(&test_key);
            prop_assert!(
                !(in_left && in_right),
                "start key {:?} must not be in both halves after split",
                test_key
            );
        }

        #[test]
        fn prop_shard_registry_count_matches_unique_registrations(
            raw_ids in prop::collection::vec(1u64..=20u64, 1..=8)
        ) {
            // Property: registry count == number of unique shards successfully registered.
            let registry = ShardRegistry::new();
            // Collect non-overlapping ranges by building shards with single-byte keys.
            // We use each unique id to claim a single 1-byte slice of the keyspace.
            let mut distinct_ids: Vec<u64> = raw_ids.clone();
            distinct_ids.sort_unstable();
            distinct_ids.dedup();

            // Each shard gets a unique 1-byte range: [i, i+1)
            let mut registered = 0usize;
            for (slot, _id) in distinct_ids.iter().enumerate() {
                let start_byte = slot as u8;
                // Stop before overflow
                if start_byte == u8::MAX {
                    break;
                }
                let range = match KeyRange::new(
                    Key::from_slice(&[start_byte]),
                    Key::from_slice(&[start_byte + 1]),
                ) {
                    Ok(r) => r,
                    Err(_) => continue,
                };
                let shard_id = registry.allocate_shard_id();
                let shard = ShardMetadata::new(shard_id, range, 1);
                if registry.register(shard).is_ok() {
                    registered += 1;
                }
            }

            let count = registry.count();
            prop_assert_eq!(
                count,
                registered,
                "registry.count() must equal number of successfully registered shards"
            );
        }

        #[test]
        fn prop_shard_registry_find_key_correctness(
            start_byte in 0u8..100u8,
            end_byte in 101u8..=200u8,
            query_byte in 0u8..=255u8,
        ) {
            // Property: find_shard_for_key returns Some iff query is in [start, end).
            let registry = ShardRegistry::new();
            let range = match KeyRange::new(
                Key::from_slice(&[start_byte]),
                Key::from_slice(&[end_byte]),
            ) {
                Ok(r) => r,
                Err(_) => return Ok(()),
            };
            let shard_id = registry.allocate_shard_id();
            let shard = ShardMetadata::new(shard_id, range, 1);
            registry.register(shard).expect("register shard");

            let query = Key::from_slice(&[query_byte]);
            let found = registry.find_shard_for_key(&query);
            let in_range = query_byte >= start_byte && query_byte < end_byte;
            prop_assert_eq!(
                found.is_some(),
                in_range,
                "find_shard_for_key({}) in [{}, {}) should be {}",
                query_byte,
                start_byte,
                end_byte,
                in_range
            );
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_shard_state() {
        assert!(ShardState::Active.can_read());
        assert!(ShardState::Active.can_write());
        assert!(ShardState::Splitting.can_read());
        assert!(!ShardState::Splitting.can_write());
        assert!(!ShardState::Offline.can_read());
        assert!(!ShardState::Offline.can_write());
    }

    #[test]
    fn test_key_range_contains() -> RaftResult<()> {
        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z"))?;

        assert!(range.contains(&Key::from_str("m")));
        assert!(range.contains(&Key::from_str("a")));
        assert!(!range.contains(&Key::from_str("z")));
        assert!(range.contains(&Key::from_str("aa"))); // "aa" > "a" and "aa" < "z" lexicographically
        assert!(!range.contains(&Key::from_str("{"))); // "{" has ASCII 123 > 'z' (122), outside range

        Ok(())
    }

    #[test]
    fn test_key_range_overlaps() -> RaftResult<()> {
        let range1 = KeyRange::new(Key::from_str("a"), Key::from_str("m"))?;
        let range2 = KeyRange::new(Key::from_str("g"), Key::from_str("z"))?;
        let range3 = KeyRange::new(Key::from_str("m"), Key::from_str("z"))?;

        assert!(range1.overlaps(&range2));
        assert!(range2.overlaps(&range1));
        assert!(!range1.overlaps(&range3));

        Ok(())
    }

    #[test]
    fn test_key_range_midpoint() -> RaftResult<()> {
        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z"))?;

        let mid = range.midpoint();
        assert!(mid > range.start);
        assert!(mid < range.end);

        Ok(())
    }

    #[test]
    fn test_shard_metadata_creation() {
        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z")).expect("valid range");
        let shard = ShardMetadata::new(1, range, 100);

        assert_eq!(shard.id, 1);
        assert_eq!(shard.node_id, 100);
        assert_eq!(shard.state, ShardState::Active);
        assert_eq!(shard.version, 1);
    }

    #[test]
    fn test_shard_metadata_update_stats() {
        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z")).expect("valid range");
        let mut shard = ShardMetadata::new(1, range, 100);

        let initial_version = shard.version;
        shard.update_stats(1000, 50000);

        assert_eq!(shard.estimated_keys, 1000);
        assert_eq!(shard.estimated_size_bytes, 50000);
        assert_eq!(shard.version, initial_version + 1);
    }

    #[test]
    fn test_shard_metadata_replicas() -> RaftResult<()> {
        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z"))?;
        let mut shard = ShardMetadata::new(1, range, 100);

        shard.add_replica(101)?;
        shard.add_replica(102)?;
        assert_eq!(shard.replicas.len(), 2);

        assert!(shard.add_replica(101).is_err());

        shard.remove_replica(101)?;
        assert_eq!(shard.replicas.len(), 1);
        assert!(shard.replicas.contains(&102));

        Ok(())
    }

    #[test]
    fn test_shard_split() -> RaftResult<()> {
        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z"))?;
        let mut source = ShardMetadata::new(1, range, 100);
        source.update_stats(1000, 100000);

        let split = ShardSplit::new(1, 2, 3, Key::from_str("m"));
        let (left, right) = split.create_shards(&source)?;

        assert_eq!(left.id, 2);
        assert_eq!(right.id, 3);
        assert_eq!(left.range.end, Key::from_str("m"));
        assert_eq!(right.range.start, Key::from_str("m"));
        assert_eq!(left.estimated_keys, 500);
        assert_eq!(right.estimated_keys, 500);

        Ok(())
    }

    #[test]
    fn test_shard_merge() -> RaftResult<()> {
        let left_range = KeyRange::new(Key::from_str("a"), Key::from_str("m"))?;
        let right_range = KeyRange::new(Key::from_str("m"), Key::from_str("z"))?;

        let mut left = ShardMetadata::new(1, left_range, 100);
        let mut right = ShardMetadata::new(2, right_range, 100);

        left.update_stats(500, 50000);
        right.update_stats(500, 50000);

        let merge = ShardMerge::new(1, 2, 3);
        let merged = merge.create_merged_shard(&left, &right)?;

        assert_eq!(merged.id, 3);
        assert_eq!(merged.range.start, Key::from_str("a"));
        assert_eq!(merged.range.end, Key::from_str("z"));
        assert_eq!(merged.estimated_keys, 1000);
        assert_eq!(merged.estimated_size_bytes, 100000);

        Ok(())
    }

    #[test]
    fn test_shard_transfer() {
        let mut transfer = ShardTransfer::new(1, 100, 101);
        assert_eq!(transfer.progress, 0.0);
        assert!(!transfer.is_complete());

        transfer.update_progress(0.5);
        assert_eq!(transfer.progress, 0.5);
        assert!(!transfer.is_complete());

        transfer.update_progress(1.0);
        assert!(transfer.is_complete());
    }

    #[test]
    fn test_shard_registry() -> RaftResult<()> {
        let registry = ShardRegistry::new();

        let id1 = registry.allocate_shard_id();
        let id2 = registry.allocate_shard_id();
        assert_ne!(id1, id2);

        let range1 = KeyRange::new(Key::from_str("a"), Key::from_str("m"))?;
        let shard1 = ShardMetadata::new(id1, range1, 100);
        registry.register(shard1.clone())?;

        let retrieved = registry.get(id1);
        assert!(retrieved.is_some());
        assert_eq!(
            retrieved
                .expect("Shard should be retrieved from registry")
                .id,
            id1
        );

        let found = registry.find_shard_for_key(&Key::from_str("g"));
        assert!(found.is_some());
        assert_eq!(found.expect("Shard should be found for key").id, id1);

        assert_eq!(registry.count(), 1);

        Ok(())
    }

    #[test]
    fn test_shard_registry_overlapping_ranges() -> RaftResult<()> {
        let registry = ShardRegistry::new();

        let range1 = KeyRange::new(Key::from_str("a"), Key::from_str("m"))?;
        let shard1 = ShardMetadata::new(1, range1, 100);
        registry.register(shard1)?;

        let range2 = KeyRange::new(Key::from_str("g"), Key::from_str("z"))?;
        let shard2 = ShardMetadata::new(2, range2, 100);
        let result = registry.register(shard2);

        assert!(result.is_err());

        Ok(())
    }

    #[test]
    fn test_hot_cold_shards() {
        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z")).expect("valid range");
        let mut shard = ShardMetadata::new(1, range, 100);

        shard.update_stats(1000, 50000);
        assert!(shard.is_hot(500, 25000));
        assert!(!shard.is_cold(500, 25000));

        shard.update_stats(100, 5000);
        assert!(!shard.is_hot(500, 25000));
        assert!(shard.is_cold(500, 25000));
    }

    #[test]
    fn test_execute_split() -> RaftResult<()> {
        let registry = ShardRegistry::new();

        // Register source shard covering "a".."z"
        let src_id = registry.allocate_shard_id();
        let left_id = registry.allocate_shard_id();
        let right_id = registry.allocate_shard_id();

        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z"))?;
        let mut source = ShardMetadata::new(src_id, range, 1);
        source.update_stats(1000, 100_000);
        registry.register(source)?;

        let split = ShardSplit::new(src_id, left_id, right_id, Key::from_str("m"));
        registry.execute_split(&split)?;

        // Source shard must be gone.
        assert!(
            registry.get(src_id).is_none(),
            "source shard must be removed after split"
        );

        // Both children must exist and be Active.
        let left = registry.get(left_id).expect("left child shard must exist");
        let right = registry
            .get(right_id)
            .expect("right child shard must exist");
        assert_eq!(left.state, ShardState::Active);
        assert_eq!(right.state, ShardState::Active);
        assert_eq!(left.range.start, Key::from_str("a"));
        assert_eq!(left.range.end, Key::from_str("m"));
        assert_eq!(right.range.start, Key::from_str("m"));
        assert_eq!(right.range.end, Key::from_str("z"));
        assert_eq!(registry.count(), 2);

        Ok(())
    }

    #[test]
    fn test_execute_split_non_active_fails() -> RaftResult<()> {
        let registry = ShardRegistry::new();

        let src_id = registry.allocate_shard_id();
        let left_id = registry.allocate_shard_id();
        let right_id = registry.allocate_shard_id();

        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z"))?;
        let mut source = ShardMetadata::new(src_id, range, 1);
        source.set_state(ShardState::Offline);
        registry.register(source)?;

        let split = ShardSplit::new(src_id, left_id, right_id, Key::from_str("m"));
        let result = registry.execute_split(&split);
        assert!(result.is_err(), "split of non-Active shard must fail");

        Ok(())
    }

    #[test]
    fn test_execute_merge() -> RaftResult<()> {
        let registry = ShardRegistry::new();

        let left_id = registry.allocate_shard_id();
        let right_id = registry.allocate_shard_id();
        let merged_id = registry.allocate_shard_id();

        let left_range = KeyRange::new(Key::from_str("a"), Key::from_str("m"))?;
        let right_range = KeyRange::new(Key::from_str("m"), Key::from_str("z"))?;

        let mut left = ShardMetadata::new(left_id, left_range, 1);
        left.update_stats(500, 50_000);
        let mut right = ShardMetadata::new(right_id, right_range, 1);
        right.update_stats(500, 50_000);

        registry.register(left)?;
        registry.register(right)?;

        let merge = ShardMerge::new(left_id, right_id, merged_id);
        registry.execute_merge(&merge)?;

        // Both sources must be removed.
        assert!(
            registry.get(left_id).is_none(),
            "left source must be removed after merge"
        );
        assert!(
            registry.get(right_id).is_none(),
            "right source must be removed after merge"
        );

        // Merged shard must exist as Active with combined range and stats.
        let merged = registry.get(merged_id).expect("merged shard must exist");
        assert_eq!(merged.state, ShardState::Active);
        assert_eq!(merged.range.start, Key::from_str("a"));
        assert_eq!(merged.range.end, Key::from_str("z"));
        assert_eq!(merged.estimated_keys, 1000);
        assert_eq!(merged.estimated_size_bytes, 100_000);
        assert_eq!(registry.count(), 1);

        Ok(())
    }

    #[test]
    fn test_execute_merge_non_active_fails() -> RaftResult<()> {
        let registry = ShardRegistry::new();

        let left_id = registry.allocate_shard_id();
        let right_id = registry.allocate_shard_id();
        let merged_id = registry.allocate_shard_id();

        let left_range = KeyRange::new(Key::from_str("a"), Key::from_str("m"))?;
        let right_range = KeyRange::new(Key::from_str("m"), Key::from_str("z"))?;

        let left = ShardMetadata::new(left_id, left_range, 1);
        let mut right = ShardMetadata::new(right_id, right_range, 1);
        right.set_state(ShardState::Merging);

        registry.register(left)?;
        registry.register(right)?;

        let merge = ShardMerge::new(left_id, right_id, merged_id);
        let result = registry.execute_merge(&merge);
        assert!(result.is_err(), "merge with non-Active shard must fail");

        Ok(())
    }

    #[test]
    fn test_execute_transfer() -> RaftResult<()> {
        let registry = ShardRegistry::new();

        let src_id = registry.allocate_shard_id();
        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z"))?;
        let source = ShardMetadata::new(src_id, range, 1);
        registry.register(source)?;

        let transfer = ShardTransfer::new(src_id, 1, 2);
        registry.execute_transfer(&transfer)?;

        // Source shard must now be in Transferring state.
        let updated_source = registry.get(src_id).expect("source shard must still exist");
        assert_eq!(
            updated_source.state,
            ShardState::Transferring,
            "source shard must be Transferring after transfer initiation"
        );
        assert_eq!(
            updated_source.node_id, 1,
            "source node_id must be unchanged"
        );

        // A new shard record for the target node must have been inserted.
        let all_shards = registry.get_all();
        assert_eq!(
            all_shards.len(),
            2,
            "registry must have exactly two shards (source + target)"
        );

        let target_shard = all_shards
            .iter()
            .find(|s| s.id != src_id)
            .expect("target shard must exist");
        assert_eq!(target_shard.state, ShardState::Active);
        assert_eq!(target_shard.node_id, 2);
        assert_eq!(target_shard.range.start, Key::from_str("a"));
        assert_eq!(target_shard.range.end, Key::from_str("z"));

        Ok(())
    }

    #[test]
    fn test_execute_transfer_non_active_fails() -> RaftResult<()> {
        let registry = ShardRegistry::new();

        let src_id = registry.allocate_shard_id();
        let range = KeyRange::new(Key::from_str("a"), Key::from_str("z"))?;
        let mut source = ShardMetadata::new(src_id, range, 1);
        source.set_state(ShardState::Transferring);
        registry.register(source)?;

        let transfer = ShardTransfer::new(src_id, 1, 2);
        let result = registry.execute_transfer(&transfer);
        assert!(result.is_err(), "transfer of non-Active shard must fail");

        Ok(())
    }
}