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
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
|
//! Purgatory: In-memory holding area for events awaiting git data.
//!
//! Solves the "which arrives first?" problem where either nostr events or git pushes
//! can arrive in any order. Events and git data are held temporarily until their
//! counterpart arrives, at which point they can be processed together.
//!
//! ## Architecture
//!
//! - **In-memory only**: Data is lost on restart (acceptable per spec)
//! - **Thread-safe**: Uses DashMap for concurrent access from multiple handlers
//! - **Automatic expiry**: Entries expire after 30 minutes by default
//! - **Separate stores**: State events and PR events use different indexing strategies
mod helpers;
pub mod sync;
mod types;
pub use helpers::{can_apply_state, can_satisfy_state, extract_refs_from_state, get_unpushed_refs};
pub use types::{PrPurgatoryEntry, RefPair, RefUpdate, StatePurgatoryEntry};
use dashmap::DashMap;
use nostr_sdk::prelude::*;
use std::collections::HashSet;
use std::path::PathBuf;
use std::sync::Arc;
use std::time::{Duration, Instant};
pub use sync::SyncQueueEntry;
/// Default expiry duration for purgatory entries (30 minutes)
const DEFAULT_EXPIRY: Duration = Duration::from_secs(1800);
/// Default delay before syncing user-submitted events (3 minutes).
/// This gives time for the git push to arrive after the nostr event.
const DEFAULT_SYNC_DELAY: Duration = Duration::from_secs(180);
/// Delay for sync-triggered events (500ms).
/// Used for batching burst arrivals during negentropy sync.
const IMMEDIATE_SYNC_DELAY: Duration = Duration::from_millis(500);
/// Main purgatory structure holding events awaiting git data.
///
/// Provides thread-safe concurrent access to two separate stores:
/// - State events indexed by repository identifier
/// - PR events indexed by event ID
///
/// Also manages a sync queue for background git data fetching:
/// - Tracks identifiers that need syncing with backoff/debouncing
/// - Supports both user-submitted events (3min delay) and sync-triggered (500ms delay)
///
/// ## Expired Event Tracking
///
/// Events that expire from purgatory without finding git data are tracked in
/// `expired_events` to prevent infinite re-sync loops. When proactive sync
/// fetches events from relays, we filter out expired events using:
/// - `event_ids()` - Returns both active purgatory events AND expired events
/// - `is_expired()` - Check if an event has expired before
/// - `mark_expired()` - Called during cleanup to track newly expired events
///
/// This prevents the sync system from repeatedly fetching and re-adding events
/// that we've already determined have no git data available.
#[derive(Clone)]
pub struct Purgatory {
/// State events (kind 30618) indexed by repository identifier.
/// Multiple state events can wait for the same identifier (different maintainers).
state_events: Arc<DashMap<String, Vec<StatePurgatoryEntry>>>,
/// PR events (kind 1617/1618) or placeholders indexed by event ID (hex string).
/// Event ID is from the 'e' tag in the PR event itself.
pr_events: Arc<DashMap<String, PrPurgatoryEntry>>,
/// Sync queue for background git data fetching.
/// Maps repository identifier to sync queue entry with timing/backoff state.
sync_queue: Arc<DashMap<String, SyncQueueEntry>>,
/// Events that expired from purgatory without finding git data.
/// Prevents infinite re-sync loops by filtering these out during negentropy/REQ sync.
/// Stored as EventId (hex string) for efficient lookup.
expired_events: Arc<DashMap<EventId, Instant>>,
_git_data_path: PathBuf,
}
impl Purgatory {
/// Create a new empty purgatory.
pub fn new(git_data_path: impl Into<PathBuf>) -> Self {
Self {
state_events: Arc::new(DashMap::new()),
pr_events: Arc::new(DashMap::new()),
sync_queue: Arc::new(DashMap::new()),
expired_events: Arc::new(DashMap::new()),
_git_data_path: git_data_path.into(),
}
}
/// Enqueue an identifier for background git data sync.
///
/// This method is called when a state or PR event is added to purgatory.
/// It uses debouncing to handle burst arrivals efficiently:
/// - If the identifier is already queued, resets attempt_count and updates
/// next_attempt if the new delay would be sooner
/// - If not queued, creates a new entry with the given delay
///
/// # Arguments
/// * `identifier` - The repository identifier to sync
/// * `delay` - How long to wait before the first sync attempt
pub fn enqueue_sync(&self, identifier: &str, delay: Duration) {
self.sync_queue
.entry(identifier.to_string())
.and_modify(|entry| {
// Reset attempt count and potentially update next_attempt
entry.on_new_event(delay);
tracing::debug!(
identifier = %identifier,
"Updated existing sync queue entry"
);
})
.or_insert_with(|| {
tracing::debug!(
identifier = %identifier,
delay_secs = delay.as_secs(),
"Added new sync queue entry"
);
SyncQueueEntry::new(delay)
});
}
/// Enqueue an identifier for sync with the default delay (3 minutes).
///
/// Used for user-submitted events where we expect a git push to follow.
pub fn enqueue_sync_default(&self, identifier: &str) {
self.enqueue_sync(identifier, DEFAULT_SYNC_DELAY);
}
/// Enqueue an identifier for immediate sync (500ms delay).
///
/// Used for sync-triggered events (e.g., from negentropy) where we want
/// to batch burst arrivals but start syncing quickly.
pub fn enqueue_sync_immediate(&self, identifier: &str) {
self.enqueue_sync(identifier, IMMEDIATE_SYNC_DELAY);
}
/// Check if there are pending events for an identifier.
///
/// Returns true if purgatory has state events or PR events for this identifier.
/// This is used by the sync loop to determine if an identifier should remain
/// in the sync queue.
///
/// # Arguments
/// * `identifier` - The repository identifier to check
pub fn has_pending_events(&self, identifier: &str) -> bool {
// Check state events
if self
.state_events
.get(identifier)
.is_some_and(|entries| !entries.is_empty())
{
return true;
}
// Check PR events - need to scan all entries since they're indexed by event_id
// PR events reference repositories via `a` tags with format `30617:<owner_pubkey>:<identifier>`
for entry in self.pr_events.iter() {
if let Some(ref event) = entry.value().event {
if Self::event_references_identifier(event, identifier) {
return true;
}
}
}
false
}
/// Check if an event references a specific repository identifier.
///
/// Looks for `a` tags with format `30617:<owner_pubkey>:<identifier>`.
fn event_references_identifier(event: &Event, identifier: &str) -> bool {
for tag in event.tags.iter() {
let tag_vec = tag.clone().to_vec();
if tag_vec.len() >= 2 && tag_vec[0] == "a" && tag_vec[1].starts_with("30617:") {
// Format: 30617:<owner_pubkey>:<identifier>
let parts: Vec<&str> = tag_vec[1].split(':').collect();
if parts.len() >= 3 && parts[2] == identifier {
return true;
}
}
}
false
}
/// Get a reference to the sync queue (for the sync loop).
pub fn sync_queue(&self) -> &Arc<DashMap<String, SyncQueueEntry>> {
&self.sync_queue
}
/// Remove an identifier from the sync queue.
///
/// Called when sync completes or the identifier no longer has pending events.
pub fn remove_from_sync_queue(&self, identifier: &str) {
self.sync_queue.remove(identifier);
}
/// Add a state event to purgatory.
///
/// The event will expire after the default duration unless matched with git data.
/// Multiple state events for the same identifier are allowed (from different authors).
///
/// Automatically enqueues the identifier for background sync with the default delay
/// (3 minutes), giving time for a git push to arrive after the nostr event.
/// For sync-triggered events, the SyncManager calls `enqueue_sync_immediate` separately
/// to override this delay.
///
/// # Arguments
/// * `event` - The state event (kind 30618) to hold
/// * `identifier` - The repository identifier from the 'd' tag
/// * `author` - The event author's public key
pub fn add_state(&self, event: Event, identifier: String, author: PublicKey) {
let now = Instant::now();
let entry = StatePurgatoryEntry {
event,
identifier: identifier.clone(),
author,
created_at: now,
expires_at: now + DEFAULT_EXPIRY,
};
self.state_events
.entry(identifier.clone())
.or_default()
.push(entry);
// Enqueue for background sync with default delay
// (SyncManager will call enqueue_sync_immediate for sync-triggered events)
self.enqueue_sync_default(&identifier);
}
/// Add a PR event to purgatory.
///
/// The event will expire after the default duration unless matched with git data.
///
/// Automatically enqueues the referenced repository identifier for background sync
/// with the default delay (3 minutes), giving time for a git push to arrive.
///
/// # Arguments
/// * `event` - The PR event (kind 1617/1618) to hold
/// * `event_id` - The event ID (hex string) from the 'e' tag
/// * `commit` - The commit SHA from the 'c' tag
pub fn add_pr(&self, event: Event, event_id: String, commit: String) {
// Extract identifier from the event's `a` tag for sync enqueueing
let identifier = crate::git::sync::extract_identifier_from_pr_event(&event);
let now = Instant::now();
let entry = PrPurgatoryEntry {
event: Some(event),
commit,
created_at: now,
expires_at: now + DEFAULT_EXPIRY,
};
self.pr_events.insert(event_id, entry);
// Enqueue the identifier for background sync if we could extract it
if let Some(id) = identifier {
self.enqueue_sync_default(&id);
}
}
/// Add a PR placeholder (git data arrived before PR event).
///
/// Creates a placeholder entry waiting for the corresponding PR event.
///
/// # Arguments
/// * `event_id` - The expected event ID (from git ref name)
/// * `commit` - The commit SHA that was pushed
pub fn add_pr_placeholder(&self, event_id: String, commit: String) {
let now = Instant::now();
let entry = PrPurgatoryEntry {
event: None, // Placeholder - no event yet
commit,
created_at: now,
expires_at: now + DEFAULT_EXPIRY,
};
self.pr_events.insert(event_id, entry);
}
/// Find state events waiting for a specific repository identifier.
///
/// Returns all state events (from all maintainers) waiting for git data
/// matching this identifier.
///
/// # Arguments
/// * `identifier` - The repository identifier to search for
///
/// # Returns
/// Vector of state events waiting for this identifier, or empty vec if none found
pub fn find_state(&self, identifier: &str) -> Vec<StatePurgatoryEntry> {
self.state_events
.get(identifier)
.map(|entries| entries.clone())
.unwrap_or_default()
}
/// Find a PR event or placeholder by event ID.
///
/// # Arguments
/// * `event_id` - The event ID to search for
///
/// # Returns
/// The PR entry if found, None otherwise
pub fn find_pr(&self, event_id: &str) -> Option<PrPurgatoryEntry> {
self.pr_events.get(event_id).map(|entry| entry.clone())
}
/// Find a PR placeholder specifically (git-data-first scenario).
///
/// Returns the commit SHA only if a placeholder exists (entry with no event).
/// Used to distinguish placeholders from actual PR events.
///
/// # Arguments
/// * `event_id` - The event ID to search for
///
/// # Returns
/// Some(commit_sha) if a placeholder exists, None if no entry or entry has an event
pub fn find_pr_placeholder(&self, event_id: &str) -> Option<String> {
self.pr_events.get(event_id).and_then(|entry| {
if entry.event.is_none() {
Some(entry.commit.clone())
} else {
None
}
})
}
/// Find all PR events for a specific repository identifier.
///
/// PR events reference repositories via `a` tags with format `30617:<owner_pubkey>:<identifier>`.
/// This function scans all PR entries and returns those that reference the given identifier.
///
/// Note: This is a linear scan since PR events are indexed by event_id, not by identifier.
/// For repositories with many PR events, this could be optimized with a secondary index.
///
/// # Arguments
/// * `identifier` - The repository identifier to search for
///
/// # Returns
/// Vector of PR purgatory entries that reference this identifier
pub fn find_prs_for_identifier(&self, identifier: &str) -> Vec<PrPurgatoryEntry> {
self.pr_events
.iter()
.filter(|entry| {
if let Some(ref event) = entry.value().event {
Self::event_references_identifier(event, identifier)
} else {
false
}
})
.map(|entry| entry.value().clone())
.collect()
}
/// Remove a state event from purgatory.
///
/// Removes all entries for the given identifier.
///
/// # Arguments
/// * `identifier` - The repository identifier to remove
pub fn remove_state(&self, identifier: &str) {
self.state_events.remove(identifier);
}
/// Remove a specific state event by comparing the full event.
///
/// This allows removing a single state event while leaving others
/// for the same identifier intact.
///
/// # Arguments
/// * `identifier` - The repository identifier
/// * `event_id` - The specific event ID to remove
pub fn remove_state_event(&self, identifier: &str, event_id: &EventId) {
if let Some(mut entries) = self.state_events.get_mut(identifier) {
entries.retain(|entry| entry.event.id != *event_id);
if entries.is_empty() {
drop(entries); // Release lock before removal
self.state_events.remove(identifier);
}
}
}
/// Find state events that could be satisfied by ref updates.
///
/// Returns state events waiting for this identifier where applying the
/// ref updates to local state results in exactly the declared state.
/// Uses late-binding ref extraction at git push time.
///
/// # Arguments
/// * `identifier` - The repository identifier to search for
/// * `pushed_updates` - Ref updates in the current push operation
/// * `local_refs` - Refs already existing locally (ref_name -> SHA)
///
/// # Returns
/// Vector of events that can be satisfied by the push
pub fn find_matching_states(
&self,
identifier: &str,
pushed_updates: &[RefUpdate],
local_refs: &std::collections::HashMap<String, String>,
) -> Vec<Event> {
self.state_events
.get(identifier)
.map(|entries| {
entries
.iter()
.filter(|entry| {
helpers::can_satisfy_state(&entry.event, pushed_updates, local_refs)
})
.map(|entry| entry.event.clone())
.collect()
})
.unwrap_or_default()
}
/// Extend expiry for state events about to be processed.
///
/// Ensures entries have at least `duration` remaining on their timer.
/// Sets expiry to max(current_expiry, now + duration).
///
/// # Arguments
/// * `identifier` - The repository identifier
/// * `event_ids` - Event IDs to extend expiry for
/// * `duration` - Minimum duration to guarantee from now
pub fn extend_expiry(&self, identifier: &str, event_ids: &[EventId], duration: Duration) {
if let Some(mut entries) = self.state_events.get_mut(identifier) {
let now = Instant::now();
let new_expiry = now + duration;
for entry in entries.iter_mut() {
if event_ids.contains(&entry.event.id) {
// Set to max of current expiry and new expiry
if entry.expires_at < new_expiry {
entry.expires_at = new_expiry;
}
}
}
}
}
/// Remove a PR event or placeholder from purgatory.
///
/// # Arguments
/// * `event_id` - The event ID to remove
pub fn remove_pr(&self, event_id: &str) {
self.pr_events.remove(event_id);
}
/// Get all event IDs currently stored in purgatory AND previously expired events.
///
/// Returns a HashSet of all event IDs for:
/// - State events currently held in purgatory
/// - PR events currently held in purgatory
/// - Events that previously expired from purgatory without finding git data
///
/// This is used by negentropy sync and REQ+EOSE to avoid fetching events
/// that are either:
/// 1. Already in purgatory awaiting git data
/// 2. Previously expired without finding git data (prevents infinite re-sync)
///
/// # Returns
/// HashSet of event IDs (as EventId) for all events in purgatory + expired events
pub fn event_ids(&self) -> HashSet<EventId> {
let mut ids = HashSet::new();
// Collect state event IDs
for entry in self.state_events.iter() {
for state_entry in entry.value().iter() {
ids.insert(state_entry.event.id);
}
}
// Collect PR event IDs (only actual events, not placeholders)
for entry in self.pr_events.iter() {
if let Some(ref event) = entry.value().event {
ids.insert(event.id);
}
}
// Collect expired event IDs
for entry in self.expired_events.iter() {
ids.insert(*entry.key());
}
ids
}
/// Check if an event has previously expired from purgatory.
///
/// Returns true if this event was previously held in purgatory and expired
/// without finding git data. This prevents re-adding the event during sync.
///
/// # Arguments
/// * `event_id` - The event ID to check
///
/// # Returns
/// true if the event has expired before, false otherwise
pub fn is_expired(&self, event_id: &EventId) -> bool {
self.expired_events.contains_key(event_id)
}
/// Mark an event as expired (called during cleanup).
///
/// Tracks events that expired from purgatory without finding git data.
/// This prevents infinite re-sync loops by filtering these events during
/// negentropy and REQ+EOSE sync.
///
/// # Arguments
/// * `event_id` - The event ID to mark as expired
fn mark_expired(&self, event_id: EventId) {
self.expired_events.insert(event_id, Instant::now());
}
/// Get all PR placeholder event IDs (git-data-first entries without events).
///
/// Returns event IDs for entries where git data arrived before the PR event.
/// These correspond to `refs/nostr/<event-id>` refs that should be cleaned up
/// on shutdown since they don't have corresponding events.
///
/// # Returns
/// Vector of event IDs (hex strings) for placeholder entries
pub fn get_placeholder_event_ids(&self) -> Vec<String> {
self.pr_events
.iter()
.filter_map(|entry| {
if entry.value().event.is_none() {
Some(entry.key().clone())
} else {
None
}
})
.collect()
}
/// Remove expired entries from purgatory.
///
/// Should be called periodically (every 60 seconds) by background task to clean up
/// entries that have exceeded their expiry deadline.
///
/// **Important**: This method also marks expired events in `expired_events` to
/// prevent infinite re-sync loops. Events that expire without finding git data
/// will be filtered out during future negentropy/REQ sync operations.
///
/// # Returns
/// Tuple of (num_state_removed, num_pr_removed)
pub fn cleanup(&self) -> (usize, usize) {
let now = Instant::now();
let mut state_removed = 0;
// Remove expired state events and mark them as expired
self.state_events.retain(|_, entries| {
let original_len = entries.len();
// Collect event IDs before removing
let expired_ids: Vec<EventId> = entries
.iter()
.filter(|entry| entry.expires_at <= now)
.map(|entry| entry.event.id)
.collect();
// Mark as expired to prevent re-sync
for event_id in expired_ids {
self.mark_expired(event_id);
}
// Remove expired entries
entries.retain(|entry| entry.expires_at > now);
state_removed += original_len - entries.len();
!entries.is_empty()
});
// Remove expired PR events and mark them as expired
let expired_prs: Vec<(String, Option<EventId>)> = self
.pr_events
.iter()
.filter(|entry| entry.value().expires_at <= now)
.map(|entry| {
let event_id = entry.value().event.as_ref().map(|e| e.id);
(entry.key().clone(), event_id)
})
.collect();
let pr_removed = expired_prs.len();
for (event_id_str, event_id_opt) in expired_prs {
// Mark actual PR events as expired (not placeholders)
if let Some(event_id) = event_id_opt {
self.mark_expired(event_id);
}
self.pr_events.remove(&event_id_str);
}
(state_removed, pr_removed)
}
/// Remove expired entries from purgatory (legacy method).
///
/// # Returns
/// Total number of entries removed (state + PR events)
#[deprecated(since = "0.1.0", note = "Use cleanup() instead for separate counts")]
pub fn remove_expired(&self) -> usize {
let (state, pr) = self.cleanup();
state + pr
}
/// Remove old expired event records.
///
/// Expired events are tracked to prevent infinite re-sync loops, but they
/// shouldn't be kept forever. This method removes expired event records
/// older than the specified duration.
///
/// Should be called periodically (e.g., daily) to prevent unbounded growth.
///
/// # Arguments
/// * `older_than` - Remove expired events older than this duration (default: 7 days)
///
/// # Returns
/// Number of expired event records removed
pub fn cleanup_expired_events(&self, older_than: Duration) -> usize {
let cutoff = Instant::now() - older_than;
let mut removed = 0;
self.expired_events.retain(|_, &mut expired_at| {
let keep = expired_at > cutoff;
if !keep {
removed += 1;
}
keep
});
removed
}
/// Get current count of entries in purgatory.
///
/// # Returns
/// Tuple of (state_event_count, pr_event_count)
pub fn count(&self) -> (usize, usize) {
let state_count: usize = self.state_events.iter().map(|e| e.value().len()).sum();
let pr_count = self.pr_events.len();
(state_count, pr_count)
}
/// Get count of expired events being tracked.
///
/// # Returns
/// Number of expired events in the tracking set
pub fn expired_count(&self) -> usize {
self.expired_events.len()
}
/// Clear all entries from purgatory (for testing).
#[cfg(test)]
pub fn clear(&self) {
self.state_events.clear();
self.pr_events.clear();
self.sync_queue.clear();
self.expired_events.clear();
}
/// Get the current size of the sync queue (for testing/metrics).
pub fn sync_queue_size(&self) -> usize {
self.sync_queue.len()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_purgatory_creation() {
let purgatory = Purgatory::new(PathBuf::new());
let (state_count, pr_count) = purgatory.count();
assert_eq!(state_count, 0);
assert_eq!(pr_count, 0);
}
#[test]
fn test_purgatory_count() {
let purgatory = Purgatory::new(PathBuf::new());
// Add some test data
let keys = Keys::generate();
let event = EventBuilder::text_note("test")
.sign_with_keys(&keys)
.unwrap();
purgatory.add_state(event.clone(), "test-repo".to_string(), keys.public_key());
purgatory.add_pr(event, "test-event-id".to_string(), "abc123".to_string());
let (state_count, pr_count) = purgatory.count();
assert_eq!(state_count, 1);
assert_eq!(pr_count, 1);
}
#[test]
fn test_enqueue_sync_debounces_rapid_calls() {
let purgatory = Purgatory::new(PathBuf::new());
// First call - creates entry
purgatory.enqueue_sync("test-repo", Duration::from_secs(60));
assert_eq!(purgatory.sync_queue_size(), 1);
// Simulate some sync attempts
if let Some(mut entry) = purgatory.sync_queue.get_mut("test-repo") {
entry.attempt_count = 3;
entry.next_attempt = Instant::now() + Duration::from_secs(120);
}
// Second call with shorter delay - should reset attempt_count and update next_attempt
purgatory.enqueue_sync("test-repo", Duration::from_secs(10));
// Should still be only one entry (debounced)
assert_eq!(purgatory.sync_queue_size(), 1);
// Attempt count should be reset
let entry = purgatory.sync_queue.get("test-repo").unwrap();
assert_eq!(entry.attempt_count, 0, "attempt_count should be reset to 0");
// next_attempt should be updated to the sooner time (within tolerance)
let expected_max = Instant::now() + Duration::from_secs(10) + Duration::from_millis(100);
assert!(
entry.next_attempt <= expected_max,
"next_attempt should be updated to sooner time"
);
}
#[test]
fn test_has_pending_events_with_state_events() {
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
// No events initially
assert!(!purgatory.has_pending_events("test-repo"));
// Add a state event
let event = EventBuilder::text_note("state")
.sign_with_keys(&keys)
.unwrap();
purgatory.add_state(event, "test-repo".to_string(), keys.public_key());
// Now should have pending events
assert!(purgatory.has_pending_events("test-repo"));
// Different identifier should not have pending events
assert!(!purgatory.has_pending_events("other-repo"));
}
#[test]
fn test_has_pending_events_with_pr_events() {
use nostr_sdk::{Kind, Tag, TagKind};
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
// No events initially
assert!(!purgatory.has_pending_events("test-repo"));
// Add a PR event with `a` tag referencing the repository
let tags = vec![Tag::custom(
TagKind::Custom("a".into()),
vec!["30617:abc123def456:test-repo".to_string()],
)];
let event = EventBuilder::new(Kind::from(1618), "PR content")
.tags(tags)
.sign_with_keys(&keys)
.unwrap();
purgatory.add_pr(event, "pr-event-id".to_string(), "commit123".to_string());
// Now should have pending events for test-repo
assert!(purgatory.has_pending_events("test-repo"));
// Different identifier should not have pending events
assert!(!purgatory.has_pending_events("other-repo"));
}
#[test]
fn test_remove_from_sync_queue() {
let purgatory = Purgatory::new(PathBuf::new());
purgatory.enqueue_sync("repo-1", Duration::from_secs(60));
purgatory.enqueue_sync("repo-2", Duration::from_secs(60));
assert_eq!(purgatory.sync_queue_size(), 2);
purgatory.remove_from_sync_queue("repo-1");
assert_eq!(purgatory.sync_queue_size(), 1);
// repo-1 should be gone
assert!(purgatory.sync_queue.get("repo-1").is_none());
// repo-2 should still be there
assert!(purgatory.sync_queue.get("repo-2").is_some());
}
#[test]
fn test_enqueue_sync_default_and_immediate() {
let purgatory = Purgatory::new(PathBuf::new());
// Test default delay (3 minutes)
purgatory.enqueue_sync_default("repo-default");
let entry = purgatory.sync_queue.get("repo-default").unwrap();
let expected_min = Instant::now() + Duration::from_secs(170); // ~3min minus tolerance
let expected_max = Instant::now() + Duration::from_secs(190); // ~3min plus tolerance
assert!(
entry.next_attempt >= expected_min && entry.next_attempt <= expected_max,
"Default delay should be ~180 seconds"
);
drop(entry);
// Test immediate delay (500ms)
purgatory.enqueue_sync_immediate("repo-immediate");
let entry = purgatory.sync_queue.get("repo-immediate").unwrap();
let expected_max = Instant::now() + Duration::from_millis(600);
assert!(
entry.next_attempt <= expected_max,
"Immediate delay should be ~500ms"
);
}
}
#[test]
fn test_pr_event_vs_placeholder() {
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
let event = EventBuilder::text_note("test PR")
.sign_with_keys(&keys)
.unwrap();
// Add a PR event with actual event
purgatory.add_pr(
event.clone(),
"event-id-1".to_string(),
"commit-abc".to_string(),
);
// Add a placeholder (no event)
purgatory.add_pr_placeholder("event-id-2".to_string(), "commit-def".to_string());
// find_pr should find both
assert!(purgatory.find_pr("event-id-1").is_some());
assert!(purgatory.find_pr("event-id-2").is_some());
// find_pr_placeholder should only find the placeholder
assert!(purgatory.find_pr_placeholder("event-id-1").is_none());
assert_eq!(
purgatory.find_pr_placeholder("event-id-2"),
Some("commit-def".to_string())
);
}
#[test]
fn test_pr_placeholder_creation_and_retrieval() {
let purgatory = Purgatory::new(PathBuf::new());
// Add a placeholder
purgatory.add_pr_placeholder("placeholder-id".to_string(), "commit-123".to_string());
// Should be findable by find_pr
let entry = purgatory.find_pr("placeholder-id");
assert!(entry.is_some());
let entry = entry.unwrap();
assert!(entry.event.is_none()); // No event yet
assert_eq!(entry.commit, "commit-123");
// Should be findable by find_pr_placeholder
let commit = purgatory.find_pr_placeholder("placeholder-id");
assert_eq!(commit, Some("commit-123".to_string()));
}
#[test]
fn test_cleanup_removes_expired_entries() {
use std::time::Duration;
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
// Create events
let state_event = EventBuilder::text_note("state event")
.sign_with_keys(&keys)
.unwrap();
let pr_event = EventBuilder::text_note("pr event")
.sign_with_keys(&keys)
.unwrap();
// Add entries to purgatory
purgatory.add_state(
state_event.clone(),
"test-repo".to_string(),
keys.public_key(),
);
purgatory.add_pr(pr_event, "pr-123".to_string(), "commit-abc".to_string());
purgatory.add_pr_placeholder("pr-456".to_string(), "commit-def".to_string());
// Verify entries are there
let (state_count, pr_count) = purgatory.count();
assert_eq!(state_count, 1);
assert_eq!(pr_count, 2);
// Manually expire entries by modifying their expiry time
// (This is a bit hacky but needed for testing without waiting 30 minutes)
if let Some(mut entries) = purgatory.state_events.get_mut("test-repo") {
for entry in entries.iter_mut() {
entry.expires_at = Instant::now() - Duration::from_secs(1);
}
}
// Expire PR events
for mut entry in purgatory.pr_events.iter_mut() {
entry.value_mut().expires_at = Instant::now() - Duration::from_secs(1);
}
// Run cleanup
let (state_removed, pr_removed) = purgatory.cleanup();
// Verify counts
assert_eq!(state_removed, 1);
assert_eq!(pr_removed, 2);
// Verify entries are gone
let (state_count, pr_count) = purgatory.count();
assert_eq!(state_count, 0);
assert_eq!(pr_count, 0);
}
#[test]
fn test_cleanup_preserves_non_expired_entries() {
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
let state_event = EventBuilder::text_note("state event")
.sign_with_keys(&keys)
.unwrap();
let pr_event = EventBuilder::text_note("pr event")
.sign_with_keys(&keys)
.unwrap();
// Add fresh entries
purgatory.add_state(state_event, "test-repo".to_string(), keys.public_key());
purgatory.add_pr(pr_event, "pr-123".to_string(), "commit-abc".to_string());
// Run cleanup
let (state_removed, pr_removed) = purgatory.cleanup();
// Nothing should be removed
assert_eq!(state_removed, 0);
assert_eq!(pr_removed, 0);
// Verify entries are still there
let (state_count, pr_count) = purgatory.count();
assert_eq!(state_count, 1);
assert_eq!(pr_count, 1);
}
#[test]
fn test_cleanup_mixed_expired_and_fresh() {
use std::time::Duration;
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
// Add multiple state events for same repo
let event1 = EventBuilder::text_note("event1")
.sign_with_keys(&keys)
.unwrap();
let event2 = EventBuilder::text_note("event2")
.sign_with_keys(&keys)
.unwrap();
purgatory.add_state(event1, "test-repo".to_string(), keys.public_key());
purgatory.add_state(event2, "test-repo".to_string(), keys.public_key());
// Expire only the first one
if let Some(mut entries) = purgatory.state_events.get_mut("test-repo") {
if let Some(entry) = entries.get_mut(0) {
entry.expires_at = Instant::now() - Duration::from_secs(1);
}
}
// Add PR events
let pr1 = EventBuilder::text_note("pr1")
.sign_with_keys(&keys)
.unwrap();
let pr2 = EventBuilder::text_note("pr2")
.sign_with_keys(&keys)
.unwrap();
purgatory.add_pr(pr1, "pr-1".to_string(), "commit-1".to_string());
purgatory.add_pr(pr2, "pr-2".to_string(), "commit-2".to_string());
// Expire only first PR
if let Some(mut entry) = purgatory.pr_events.get_mut("pr-1") {
entry.expires_at = Instant::now() - Duration::from_secs(1);
}
// Run cleanup
let (state_removed, pr_removed) = purgatory.cleanup();
// One of each should be removed
assert_eq!(state_removed, 1);
assert_eq!(pr_removed, 1);
// Verify remaining counts
let (state_count, pr_count) = purgatory.count();
assert_eq!(state_count, 1); // One state event remains
assert_eq!(pr_count, 1); // One PR event remains
}
#[test]
fn test_remove_expired_legacy_method() {
use std::time::Duration;
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
let state_event = EventBuilder::text_note("state")
.sign_with_keys(&keys)
.unwrap();
let pr_event = EventBuilder::text_note("pr").sign_with_keys(&keys).unwrap();
purgatory.add_state(state_event, "repo".to_string(), keys.public_key());
purgatory.add_pr(pr_event, "pr-id".to_string(), "commit".to_string());
// Expire both
if let Some(mut entries) = purgatory.state_events.get_mut("repo") {
for entry in entries.iter_mut() {
entry.expires_at = Instant::now() - Duration::from_secs(1);
}
}
for mut entry in purgatory.pr_events.iter_mut() {
entry.value_mut().expires_at = Instant::now() - Duration::from_secs(1);
}
// Test legacy method returns total
#[allow(deprecated)]
let total = purgatory.remove_expired();
assert_eq!(total, 2); // 1 state + 1 PR
}
#[test]
fn test_expired_event_tracking() {
use std::time::Duration;
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
let state_event = EventBuilder::text_note("state")
.sign_with_keys(&keys)
.unwrap();
let pr_event = EventBuilder::text_note("pr").sign_with_keys(&keys).unwrap();
let state_event_id = state_event.id;
let pr_event_id = pr_event.id;
// Add events to purgatory
purgatory.add_state(state_event, "repo".to_string(), keys.public_key());
purgatory.add_pr(pr_event, "pr-id".to_string(), "commit".to_string());
// Events should not be marked as expired yet
assert!(!purgatory.is_expired(&state_event_id));
assert!(!purgatory.is_expired(&pr_event_id));
// Expire both events
if let Some(mut entries) = purgatory.state_events.get_mut("repo") {
for entry in entries.iter_mut() {
entry.expires_at = Instant::now() - Duration::from_secs(1);
}
}
for mut entry in purgatory.pr_events.iter_mut() {
entry.value_mut().expires_at = Instant::now() - Duration::from_secs(1);
}
// Run cleanup
let (state_removed, pr_removed) = purgatory.cleanup();
assert_eq!(state_removed, 1);
assert_eq!(pr_removed, 1);
// Events should now be marked as expired
assert!(purgatory.is_expired(&state_event_id));
assert!(purgatory.is_expired(&pr_event_id));
// event_ids() should include expired events
let ids = purgatory.event_ids();
assert!(ids.contains(&state_event_id));
assert!(ids.contains(&pr_event_id));
// Expired count should be 2
assert_eq!(purgatory.expired_count(), 2);
}
#[test]
fn test_cleanup_expired_events() {
use std::time::Duration;
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
let event1 = EventBuilder::text_note("event1")
.sign_with_keys(&keys)
.unwrap();
let event2 = EventBuilder::text_note("event2")
.sign_with_keys(&keys)
.unwrap();
let event1_id = event1.id;
let event2_id = event2.id;
// Add and immediately expire event1
purgatory.add_state(event1, "repo1".to_string(), keys.public_key());
if let Some(mut entries) = purgatory.state_events.get_mut("repo1") {
for entry in entries.iter_mut() {
entry.expires_at = Instant::now() - Duration::from_secs(1);
}
}
purgatory.cleanup();
// Add and expire event2 (will be more recent)
purgatory.add_state(event2, "repo2".to_string(), keys.public_key());
if let Some(mut entries) = purgatory.state_events.get_mut("repo2") {
for entry in entries.iter_mut() {
entry.expires_at = Instant::now() - Duration::from_secs(1);
}
}
purgatory.cleanup();
// Both should be in expired_events
assert_eq!(purgatory.expired_count(), 2);
// Manually set event1's expiry time to be old
if let Some(mut entry) = purgatory.expired_events.get_mut(&event1_id) {
*entry.value_mut() = Instant::now() - Duration::from_secs(8 * 24 * 3600);
// 8 days ago
}
// Clean up expired events older than 7 days
let removed = purgatory.cleanup_expired_events(Duration::from_secs(7 * 24 * 3600));
// Only event1 should be removed
assert_eq!(removed, 1);
assert_eq!(purgatory.expired_count(), 1);
// event1 should be gone, event2 should remain
assert!(!purgatory.is_expired(&event1_id));
assert!(purgatory.is_expired(&event2_id));
}
#[test]
fn test_expired_events_prevent_readdition() {
use std::time::Duration;
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
let event = EventBuilder::text_note("test")
.sign_with_keys(&keys)
.unwrap();
let event_id = event.id;
// Add event to purgatory
purgatory.add_state(event.clone(), "repo".to_string(), keys.public_key());
// Expire it
if let Some(mut entries) = purgatory.state_events.get_mut("repo") {
for entry in entries.iter_mut() {
entry.expires_at = Instant::now() - Duration::from_secs(1);
}
}
purgatory.cleanup();
// Event should be marked as expired
assert!(purgatory.is_expired(&event_id));
// event_ids() should return the expired event
let ids = purgatory.event_ids();
assert!(ids.contains(&event_id));
// This simulates what negentropy/REQ+EOSE should do:
// Check if event is in event_ids() before adding
if !ids.contains(&event_id) {
purgatory.add_state(event, "repo".to_string(), keys.public_key());
}
// Event should NOT be re-added
let (state_count, _) = purgatory.count();
assert_eq!(state_count, 0, "Event should not be re-added to purgatory");
}
#[test]
fn test_pr_placeholder_not_marked_expired() {
use std::time::Duration;
let purgatory = Purgatory::new(PathBuf::new());
// Add a PR placeholder (no event)
purgatory.add_pr_placeholder("placeholder-id".to_string(), "commit-123".to_string());
// Expire it
if let Some(mut entry) = purgatory.pr_events.get_mut("placeholder-id") {
entry.value_mut().expires_at = Instant::now() - Duration::from_secs(1);
}
// Run cleanup
let (_, pr_removed) = purgatory.cleanup();
assert_eq!(pr_removed, 1);
// Expired count should be 0 (placeholders don't have event IDs to track)
assert_eq!(purgatory.expired_count(), 0);
}
#[test]
fn test_user_can_resubmit_expired_event() {
use std::time::Duration;
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
let event = EventBuilder::text_note("test")
.sign_with_keys(&keys)
.unwrap();
let event_id = event.id;
// Add event to purgatory
purgatory.add_state(event.clone(), "repo".to_string(), keys.public_key());
// Expire it
if let Some(mut entries) = purgatory.state_events.get_mut("repo") {
for entry in entries.iter_mut() {
entry.expires_at = Instant::now() - Duration::from_secs(1);
}
}
purgatory.cleanup();
// Event should be marked as expired
assert!(purgatory.is_expired(&event_id));
// User re-submits the same event (simulating retry after pushing git data)
// This should be allowed - the policy layer will check is_synced flag
// For now, just verify the event is marked as expired
assert!(purgatory.is_expired(&event_id));
// The policy layer (in builder.rs and state.rs) will:
// - Check is_synced flag (false for user-submitted)
// - Skip the expired check for user-submitted events
// - Allow the event to be re-added to purgatory or accepted if git data now exists
}
|