Files
ngit-grasp/src/purgatory/mod.rs
T
DanConwayDev b6c70f765d feat(purgatory): add persistence to survive relay restarts
Implement save/restore functionality for purgatory state to prevent
event loss during relay restarts. Events in purgatory (state events,
PR events, and expired events) are now saved to disk on graceful
shutdown and restored on startup.

Key features:
- Serialize purgatory state to JSON (purgatory-state.json)
- Time conversion helpers for Instant <-> Duration serialization
- Restore with downtime adjustment (preserves remaining TTL)
- Graceful degradation (missing/corrupted files don't crash)
- File cleanup after successful restore
- get_all_identifiers() for re-queueing after restore

Files:
- src/purgatory/persistence.rs: Time conversion helpers
- src/purgatory/types.rs: Serialization derives
- src/purgatory/mod.rs: save_to_disk/restore_from_disk methods

Tests: 15 unit tests covering serialization, downtime, edge cases
2026-01-14 10:18:47 +00:00

2173 lines
74 KiB
Rust

//! 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 persistence;
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 serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::collections::HashSet;
use std::path::{Path, PathBuf};
use std::sync::Arc;
use std::time::{Duration, Instant, SystemTime};
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);
/// Serializable wrapper for `StatePurgatoryEntry` with time offsets.
///
/// Stores `Instant` fields as `Duration` offsets from the `saved_at` timestamp
/// in `PurgatoryState`, allowing state to be persisted and restored across restarts.
#[derive(Debug, Clone, Serialize, Deserialize)]
struct SerializableStatePurgatoryEntry {
/// The nostr state event (kind 30618) awaiting git data
event: Event,
/// The repository identifier from the event's 'd' tag
identifier: String,
/// Event author pubkey
author: PublicKey,
/// Duration offset from saved_at for created_at
created_at_offset_secs: u64,
/// Duration offset from saved_at for expires_at
expires_at_offset_secs: u64,
}
/// Serializable wrapper for `PrPurgatoryEntry` with time offsets.
///
/// Stores `Instant` fields as `Duration` offsets from the `saved_at` timestamp
/// in `PurgatoryState`, allowing state to be persisted and restored across restarts.
#[derive(Debug, Clone, Serialize, Deserialize)]
struct SerializablePrPurgatoryEntry {
/// The nostr PR event, if received (None = git data arrived first)
event: Option<Event>,
/// The expected commit SHA from 'c' tag (if event exists)
/// or the actual commit pushed (if git arrived first)
commit: String,
/// Duration offset from saved_at for created_at
created_at_offset_secs: u64,
/// Duration offset from saved_at for expires_at
expires_at_offset_secs: u64,
}
/// Serializable purgatory state for disk persistence.
///
/// Contains all purgatory data needed to restore state across restarts:
/// - State events (indexed by identifier)
/// - PR events (indexed by event ID)
/// - Expired events (to prevent re-sync loops)
/// - Version number for future compatibility
/// - Saved timestamp for downtime calculation
#[derive(Debug, Clone, Serialize, Deserialize)]
struct PurgatoryState {
/// Version number for state format (currently 1)
version: u32,
/// When this state was saved to disk
saved_at: SystemTime,
/// State events indexed by repository identifier
state_events: HashMap<String, Vec<SerializableStatePurgatoryEntry>>,
/// PR events indexed by event ID (hex string)
pr_events: HashMap<String, SerializablePrPurgatoryEntry>,
/// Expired event IDs with their expiry timestamps
expired_events: HashMap<String, SystemTime>,
}
/// 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()
}
/// Get all repository identifiers currently in purgatory.
///
/// Returns a list of all unique repository identifiers that have state events
/// in purgatory. This is useful for re-queueing repositories after restore.
///
/// # Returns
/// Vector of repository identifiers (e.g., "owner/repo")
///
/// # Example
/// ```no_run
/// use ngit_grasp::purgatory::Purgatory;
/// use std::path::PathBuf;
///
/// let purgatory = Purgatory::new(PathBuf::from("/tmp/git"));
/// let identifiers = purgatory.get_all_identifiers();
/// for id in identifiers {
/// println!("Repository in purgatory: {}", id);
/// }
/// ```
pub fn get_all_identifiers(&self) -> Vec<String> {
self.state_events
.iter()
.map(|entry| entry.key().clone())
.collect()
}
/// Save purgatory state to disk.
///
/// Serializes the current purgatory state (state_events, pr_events, expired_events)
/// to JSON and saves it to the specified path. Time-based fields (`Instant`) are
/// converted to duration offsets from the current `SystemTime` for persistence.
///
/// Note: The sync_queue is NOT persisted - it will be rebuilt when events are
/// restored from disk.
///
/// # Arguments
/// * `path` - Path to save the state file
///
/// # Returns
/// Ok(()) on success, Err on failure
///
/// # Example
/// ```no_run
/// use ngit_grasp::purgatory::Purgatory;
/// use std::path::PathBuf;
///
/// let purgatory = Purgatory::new(PathBuf::from("/tmp/git"));
/// purgatory.save_to_disk(&PathBuf::from("/tmp/purgatory.json")).unwrap();
/// ```
pub fn save_to_disk(&self, path: &Path) -> Result<(), Box<dyn std::error::Error>> {
let saved_at = SystemTime::now();
let now_instant = Instant::now();
// Convert state_events to serializable format
let mut state_events = HashMap::new();
for entry in self.state_events.iter() {
let identifier = entry.key().clone();
let entries: Vec<SerializableStatePurgatoryEntry> = entry
.value()
.iter()
.map(|e| {
let created_offset =
persistence::instant_to_offset(e.created_at, saved_at, now_instant);
let expires_offset =
persistence::instant_to_offset(e.expires_at, saved_at, now_instant);
SerializableStatePurgatoryEntry {
event: e.event.clone(),
identifier: e.identifier.clone(),
author: e.author,
created_at_offset_secs: created_offset.as_secs(),
expires_at_offset_secs: expires_offset.as_secs(),
}
})
.collect();
state_events.insert(identifier, entries);
}
// Convert pr_events to serializable format
let mut pr_events = HashMap::new();
for entry in self.pr_events.iter() {
let event_id = entry.key().clone();
let e = entry.value();
let created_offset =
persistence::instant_to_offset(e.created_at, saved_at, now_instant);
let expires_offset =
persistence::instant_to_offset(e.expires_at, saved_at, now_instant);
let serializable = SerializablePrPurgatoryEntry {
event: e.event.clone(),
commit: e.commit.clone(),
created_at_offset_secs: created_offset.as_secs(),
expires_at_offset_secs: expires_offset.as_secs(),
};
pr_events.insert(event_id, serializable);
}
// Convert expired_events to serializable format
// We use SystemTime instead of Instant offsets for expired events since
// we don't need high precision for cleanup timing
let mut expired_events = HashMap::new();
for entry in self.expired_events.iter() {
let event_id = entry.key().to_hex();
// Convert Instant to SystemTime (approximate)
let expired_at_instant = *entry.value();
let elapsed_since_expire = now_instant.saturating_duration_since(expired_at_instant);
let expired_at_system = saved_at - elapsed_since_expire;
expired_events.insert(event_id, expired_at_system);
}
// Create state structure
let state = PurgatoryState {
version: 1,
saved_at,
state_events,
pr_events,
expired_events,
};
// Serialize to JSON and write to file
let json = serde_json::to_string_pretty(&state)?;
std::fs::write(path, json)?;
tracing::info!(
path = %path.display(),
state_events = state.state_events.len(),
pr_events = state.pr_events.len(),
expired_events = state.expired_events.len(),
"Saved purgatory state to disk"
);
Ok(())
}
/// Restore purgatory state from disk.
///
/// Loads a previously saved purgatory state from the specified path and populates
/// the current purgatory instance. Adjusts time-based fields to account for downtime
/// between save and restore.
///
/// After successful restore, the state file is deleted to prevent accidental
/// double-restore.
///
/// # Arguments
/// * `path` - Path to the saved state file
///
/// # Returns
/// Ok(()) on success, Err if file doesn't exist or is corrupted
///
/// # Example
/// ```no_run
/// use ngit_grasp::purgatory::Purgatory;
/// use std::path::PathBuf;
///
/// let purgatory = Purgatory::new(PathBuf::from("/tmp/git"));
/// match purgatory.restore_from_disk(&PathBuf::from("/tmp/purgatory.json")) {
/// Ok(()) => println!("State restored successfully"),
/// Err(e) => eprintln!("Failed to restore state: {}", e),
/// }
/// ```
pub fn restore_from_disk(&self, path: &Path) -> Result<(), Box<dyn std::error::Error>> {
// Read and parse state file
let json = std::fs::read_to_string(path)?;
let state: PurgatoryState = serde_json::from_str(&json)?;
// Verify version
if state.version != 1 {
return Err(format!("Unsupported state version: {}", state.version).into());
}
let now_instant = Instant::now();
// Restore state_events
for (identifier, entries) in state.state_events {
let restored_entries: Vec<StatePurgatoryEntry> = entries
.into_iter()
.map(|e| {
let created_at = persistence::offset_to_instant(
Duration::from_secs(e.created_at_offset_secs),
state.saved_at,
now_instant,
);
let expires_at = persistence::offset_to_instant(
Duration::from_secs(e.expires_at_offset_secs),
state.saved_at,
now_instant,
);
StatePurgatoryEntry {
event: e.event,
identifier: e.identifier,
author: e.author,
created_at,
expires_at,
}
})
.collect();
self.state_events.insert(identifier, restored_entries);
}
// Restore pr_events
for (event_id, e) in state.pr_events {
let created_at = persistence::offset_to_instant(
Duration::from_secs(e.created_at_offset_secs),
state.saved_at,
now_instant,
);
let expires_at = persistence::offset_to_instant(
Duration::from_secs(e.expires_at_offset_secs),
state.saved_at,
now_instant,
);
let entry = PrPurgatoryEntry {
event: e.event,
commit: e.commit,
created_at,
expires_at,
};
self.pr_events.insert(event_id, entry);
}
// Restore expired_events
for (event_id_hex, expired_at_system) in state.expired_events {
if let Ok(event_id) = EventId::from_hex(&event_id_hex) {
// Convert SystemTime back to Instant (approximate)
let elapsed_since_expire = SystemTime::now()
.duration_since(expired_at_system)
.unwrap_or(Duration::ZERO);
let expired_at_instant = now_instant - elapsed_since_expire;
self.expired_events.insert(event_id, expired_at_instant);
}
}
tracing::info!(
path = %path.display(),
state_events = self.state_events.len(),
pr_events = self.pr_events.len(),
expired_events = self.expired_events.len(),
saved_at = ?state.saved_at,
"Restored purgatory state from disk"
);
// Delete state file after successful restore
std::fs::remove_file(path)?;
tracing::debug!(path = %path.display(), "Deleted state file after restore");
Ok(())
}
}
#[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
}
// ============================================================================
// Persistence Serialization Tests
// ============================================================================
#[tokio::test]
async fn test_save_and_restore_state_events() {
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
// Add multiple state events for the same identifier
let event1 = EventBuilder::text_note("state event 1")
.sign_with_keys(&keys)
.unwrap();
let event2 = EventBuilder::text_note("state event 2")
.sign_with_keys(&keys)
.unwrap();
let event1_id = event1.id;
let event2_id = event2.id;
purgatory.add_state(event1.clone(), "test-repo".to_string(), keys.public_key());
purgatory.add_state(event2.clone(), "test-repo".to_string(), keys.public_key());
// Save to disk
purgatory.save_to_disk(&state_file).unwrap();
// Verify file exists
assert!(state_file.exists());
// Create new purgatory and restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// Verify file was deleted after restore
assert!(!state_file.exists());
// Verify state events were restored
let (state_count, _) = purgatory2.count();
assert_eq!(state_count, 2);
let restored_entries = purgatory2.find_state("test-repo");
assert_eq!(restored_entries.len(), 2);
// Verify event IDs match
let restored_ids: Vec<EventId> = restored_entries.iter().map(|e| e.event.id).collect();
assert!(restored_ids.contains(&event1_id));
assert!(restored_ids.contains(&event2_id));
// Verify identifiers and authors match
for entry in &restored_entries {
assert_eq!(entry.identifier, "test-repo");
assert_eq!(entry.author, keys.public_key());
}
}
#[tokio::test]
async fn test_save_and_restore_pr_events() {
use nostr_sdk::{Kind, Tag, TagKind};
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
// Add PR event with actual event
let tags = vec![Tag::custom(
TagKind::Custom("a".into()),
vec!["30617:abc123:test-repo".to_string()],
)];
let pr_event = EventBuilder::new(Kind::from(1618), "PR content")
.tags(tags)
.sign_with_keys(&keys)
.unwrap();
let pr_event_id = pr_event.id;
purgatory.add_pr(
pr_event.clone(),
"pr-event-id".to_string(),
"commit-abc".to_string(),
);
// Save to disk
purgatory.save_to_disk(&state_file).unwrap();
// Create new purgatory and restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// Verify PR event was restored
let (_, pr_count) = purgatory2.count();
assert_eq!(pr_count, 1);
let restored_entry = purgatory2.find_pr("pr-event-id").unwrap();
assert!(restored_entry.event.is_some());
assert_eq!(restored_entry.event.unwrap().id, pr_event_id);
assert_eq!(restored_entry.commit, "commit-abc");
}
#[tokio::test]
async fn test_save_and_restore_pr_placeholders() {
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
let purgatory = Purgatory::new(PathBuf::new());
// Add PR placeholder (git data arrived first)
purgatory.add_pr_placeholder("placeholder-id".to_string(), "commit-def".to_string());
// Save to disk
purgatory.save_to_disk(&state_file).unwrap();
// Create new purgatory and restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// Verify placeholder was restored
let (_, pr_count) = purgatory2.count();
assert_eq!(pr_count, 1);
let restored_entry = purgatory2.find_pr("placeholder-id").unwrap();
assert!(restored_entry.event.is_none()); // Still a placeholder
assert_eq!(restored_entry.commit, "commit-def");
// Verify it's findable as a placeholder
assert_eq!(
purgatory2.find_pr_placeholder("placeholder-id"),
Some("commit-def".to_string())
);
}
#[tokio::test]
async fn test_save_and_restore_expired_events() {
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
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 and expire event
purgatory.add_state(event, "repo".to_string(), keys.public_key());
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();
// Verify event is marked as expired
assert!(purgatory.is_expired(&event_id));
assert_eq!(purgatory.expired_count(), 1);
// Save to disk
purgatory.save_to_disk(&state_file).unwrap();
// Create new purgatory and restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// Verify expired event was restored
assert!(purgatory2.is_expired(&event_id));
assert_eq!(purgatory2.expired_count(), 1);
// Verify it's included in event_ids()
let ids = purgatory2.event_ids();
assert!(ids.contains(&event_id));
}
#[tokio::test]
async fn test_save_and_restore_empty_purgatory() {
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
let purgatory = Purgatory::new(PathBuf::new());
// Save empty purgatory
purgatory.save_to_disk(&state_file).unwrap();
// Verify file exists
assert!(state_file.exists());
// Create new purgatory and restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// Verify purgatory is still empty
let (state_count, pr_count) = purgatory2.count();
assert_eq!(state_count, 0);
assert_eq!(pr_count, 0);
assert_eq!(purgatory2.expired_count(), 0);
}
#[tokio::test]
async fn test_restore_missing_file() {
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("nonexistent.json");
let purgatory = Purgatory::new(PathBuf::new());
// Attempting to restore from missing file should error
let result = purgatory.restore_from_disk(&state_file);
assert!(result.is_err());
// Purgatory should remain empty
let (state_count, pr_count) = purgatory.count();
assert_eq!(state_count, 0);
assert_eq!(pr_count, 0);
}
#[tokio::test]
async fn test_restore_corrupted_json() {
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("corrupted.json");
// Write invalid JSON
std::fs::write(&state_file, "{ this is not valid json }").unwrap();
let purgatory = Purgatory::new(PathBuf::new());
// Attempting to restore corrupted file should error
let result = purgatory.restore_from_disk(&state_file);
assert!(result.is_err());
// Purgatory should remain empty
let (state_count, pr_count) = purgatory.count();
assert_eq!(state_count, 0);
assert_eq!(pr_count, 0);
}
#[tokio::test]
async fn test_restore_unsupported_version() {
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("wrong_version.json");
// Write state with unsupported version
let state = r#"{
"version": 999,
"saved_at": {"secs_since_epoch": 1000000000, "nanos_since_epoch": 0},
"state_events": {},
"pr_events": {},
"expired_events": {}
}"#;
std::fs::write(&state_file, state).unwrap();
let purgatory = Purgatory::new(PathBuf::new());
// Attempting to restore unsupported version should error
let result = purgatory.restore_from_disk(&state_file);
assert!(result.is_err());
assert!(result
.unwrap_err()
.to_string()
.contains("Unsupported state version"));
}
#[tokio::test]
async fn test_downtime_calculation() {
use tempfile::tempdir;
use tokio::time::sleep;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
// Add state event
let event = EventBuilder::text_note("test")
.sign_with_keys(&keys)
.unwrap();
purgatory.add_state(event.clone(), "repo".to_string(), keys.public_key());
// Get original expiry time
let original_entries = purgatory.find_state("repo");
let original_entry = &original_entries[0];
let original_expires_at = original_entry.expires_at;
let original_remaining = original_expires_at.saturating_duration_since(Instant::now());
// Save to disk
purgatory.save_to_disk(&state_file).unwrap();
// Simulate downtime (100ms)
sleep(Duration::from_millis(100)).await;
// Create new purgatory and restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// Get restored expiry time
let restored_entries = purgatory2.find_state("repo");
let restored_entry = &restored_entries[0];
let restored_expires_at = restored_entry.expires_at;
let restored_remaining = restored_expires_at.saturating_duration_since(Instant::now());
// Remaining time should be approximately the same (accounting for downtime)
// Allow 2000ms tolerance for test execution time and sleep duration
let diff = if restored_remaining > original_remaining {
restored_remaining.as_millis() - original_remaining.as_millis()
} else {
original_remaining.as_millis() - restored_remaining.as_millis()
};
assert!(
diff < 2000,
"Downtime calculation should preserve remaining TTL. Original: {}ms, Restored: {}ms, Diff: {}ms",
original_remaining.as_millis(),
restored_remaining.as_millis(),
diff
);
}
#[tokio::test]
async fn test_expiry_times_preserved() {
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
// Add state event
let event = EventBuilder::text_note("test")
.sign_with_keys(&keys)
.unwrap();
purgatory.add_state(event.clone(), "repo".to_string(), keys.public_key());
// Manually set expiry to a specific time in the future
let custom_expiry = Instant::now() + Duration::from_secs(600); // 10 minutes
if let Some(mut entries) = purgatory.state_events.get_mut("repo") {
for entry in entries.iter_mut() {
entry.expires_at = custom_expiry;
}
}
// Save to disk
purgatory.save_to_disk(&state_file).unwrap();
// Create new purgatory and restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// Get restored expiry time
let restored_entries = purgatory2.find_state("repo");
let restored_entry = &restored_entries[0];
let restored_remaining = restored_entry
.expires_at
.saturating_duration_since(Instant::now());
// Should be approximately 600 seconds (allow 3 second tolerance for test execution)
assert!(
restored_remaining.as_secs() >= 597 && restored_remaining.as_secs() <= 603,
"Expected ~600s remaining, got {}s",
restored_remaining.as_secs()
);
}
#[tokio::test]
async fn test_multiple_state_events_same_identifier() {
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
let purgatory = Purgatory::new(PathBuf::new());
let keys1 = Keys::generate();
let keys2 = Keys::generate();
let keys3 = Keys::generate();
// Add multiple state events for the same identifier from different authors
let event1 = EventBuilder::text_note("maintainer 1")
.sign_with_keys(&keys1)
.unwrap();
let event2 = EventBuilder::text_note("maintainer 2")
.sign_with_keys(&keys2)
.unwrap();
let event3 = EventBuilder::text_note("maintainer 3")
.sign_with_keys(&keys3)
.unwrap();
purgatory.add_state(
event1.clone(),
"shared-repo".to_string(),
keys1.public_key(),
);
purgatory.add_state(
event2.clone(),
"shared-repo".to_string(),
keys2.public_key(),
);
purgatory.add_state(
event3.clone(),
"shared-repo".to_string(),
keys3.public_key(),
);
// Save to disk
purgatory.save_to_disk(&state_file).unwrap();
// Create new purgatory and restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// Verify all three events were restored
let restored_entries = purgatory2.find_state("shared-repo");
assert_eq!(restored_entries.len(), 3);
// Verify all authors are present
let authors: Vec<PublicKey> = restored_entries.iter().map(|e| e.author).collect();
assert!(authors.contains(&keys1.public_key()));
assert!(authors.contains(&keys2.public_key()));
assert!(authors.contains(&keys3.public_key()));
}
#[tokio::test]
async fn test_mixed_pr_events_and_placeholders() {
use nostr_sdk::{Kind, Tag, TagKind};
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
// Add PR event with actual event
let tags = vec![Tag::custom(
TagKind::Custom("a".into()),
vec!["30617:abc123:test-repo".to_string()],
)];
let pr_event = EventBuilder::new(Kind::from(1618), "PR content")
.tags(tags)
.sign_with_keys(&keys)
.unwrap();
purgatory.add_pr(
pr_event.clone(),
"pr-with-event".to_string(),
"commit-abc".to_string(),
);
// Add PR placeholder
purgatory.add_pr_placeholder("pr-placeholder".to_string(), "commit-def".to_string());
// Save to disk
purgatory.save_to_disk(&state_file).unwrap();
// Create new purgatory and restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// Verify both were restored correctly
let (_, pr_count) = purgatory2.count();
assert_eq!(pr_count, 2);
// Verify PR event
let pr_entry = purgatory2.find_pr("pr-with-event").unwrap();
assert!(pr_entry.event.is_some());
assert_eq!(pr_entry.commit, "commit-abc");
// Verify placeholder
let placeholder_entry = purgatory2.find_pr("pr-placeholder").unwrap();
assert!(placeholder_entry.event.is_none());
assert_eq!(placeholder_entry.commit, "commit-def");
assert_eq!(
purgatory2.find_pr_placeholder("pr-placeholder"),
Some("commit-def".to_string())
);
}
#[tokio::test]
async fn test_file_cleanup_after_successful_restore() {
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
let purgatory = Purgatory::new(PathBuf::new());
let keys = Keys::generate();
// Add some data
let event = EventBuilder::text_note("test")
.sign_with_keys(&keys)
.unwrap();
purgatory.add_state(event, "repo".to_string(), keys.public_key());
// Save to disk
purgatory.save_to_disk(&state_file).unwrap();
assert!(state_file.exists());
// Restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// File should be deleted after successful restore
assert!(!state_file.exists());
}
#[tokio::test]
async fn test_comprehensive_roundtrip() {
use nostr_sdk::{Kind, Tag, TagKind};
use tempfile::tempdir;
let temp_dir = tempdir().unwrap();
let state_file = temp_dir.path().join("purgatory_state.json");
let purgatory = Purgatory::new(PathBuf::new());
let keys1 = Keys::generate();
let keys2 = Keys::generate();
// Add multiple state events
let state1 = EventBuilder::text_note("state 1")
.sign_with_keys(&keys1)
.unwrap();
let state2 = EventBuilder::text_note("state 2")
.sign_with_keys(&keys2)
.unwrap();
purgatory.add_state(state1.clone(), "repo1".to_string(), keys1.public_key());
purgatory.add_state(state2.clone(), "repo2".to_string(), keys2.public_key());
// Add PR event
let tags = vec![Tag::custom(
TagKind::Custom("a".into()),
vec!["30617:abc123:repo1".to_string()],
)];
let pr_event = EventBuilder::new(Kind::from(1618), "PR")
.tags(tags)
.sign_with_keys(&keys1)
.unwrap();
purgatory.add_pr(pr_event.clone(), "pr-1".to_string(), "commit-1".to_string());
// Add PR placeholder
purgatory.add_pr_placeholder("pr-2".to_string(), "commit-2".to_string());
// Add and expire an event
let expired_event = EventBuilder::text_note("expired")
.sign_with_keys(&keys1)
.unwrap();
let expired_id = expired_event.id;
purgatory.add_state(expired_event, "repo3".to_string(), keys1.public_key());
if let Some(mut entries) = purgatory.state_events.get_mut("repo3") {
for entry in entries.iter_mut() {
entry.expires_at = Instant::now() - Duration::from_secs(1);
}
}
purgatory.cleanup();
// Verify initial state
let (state_count, pr_count) = purgatory.count();
assert_eq!(state_count, 2); // state1, state2 (expired_event was cleaned up)
assert_eq!(pr_count, 2); // pr-1, pr-2
assert_eq!(purgatory.expired_count(), 1); // expired_event
// Save to disk
purgatory.save_to_disk(&state_file).unwrap();
// Create new purgatory and restore
let purgatory2 = Purgatory::new(PathBuf::new());
purgatory2.restore_from_disk(&state_file).unwrap();
// Verify all data was restored correctly
let (state_count2, pr_count2) = purgatory2.count();
assert_eq!(state_count2, 2);
assert_eq!(pr_count2, 2);
assert_eq!(purgatory2.expired_count(), 1);
// Verify state events
assert_eq!(purgatory2.find_state("repo1").len(), 1);
assert_eq!(purgatory2.find_state("repo2").len(), 1);
// Verify PR events
assert!(purgatory2.find_pr("pr-1").unwrap().event.is_some());
assert!(purgatory2.find_pr("pr-2").unwrap().event.is_none());
// Verify expired event
assert!(purgatory2.is_expired(&expired_id));
}