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
|
//! WebSocket connection handling for sync
//!
//! Manages the connection to a source relay, subscribes to events using
//! the three-layer filter strategy, and passes them through validation.
//!
//! ## Phase 2 Features
//!
//! - Three-layer filter subscriptions:
//! 1. Layer 1: kinds 30617 + 30618 (announcements)
//! 2. Layer 2: A/a tags for repository events
//! 3. Layer 3: E/e tags for related events (PRs, Issues, etc.)
//!
//! ## Phase 3 Features
//!
//! - Health tracking with success/failure reporting
//! - Exponential backoff with health-aware delays
//! - Dead relay detection and minimal retry
//!
//! ## Phase 4 Features
//!
//! - Dynamic subscription updates when new announcements/PRs arrive
//! - Per-connection subscription tracking
//! - Filter consolidation when count exceeds threshold (>150)
//! - Duplicate subscription prevention
use std::sync::Arc;
use std::time::Duration;
use nostr_sdk::prelude::*;
use tokio::sync::mpsc;
use super::filter::FilterService;
use super::health::RelayHealthTracker;
use super::subscription::SubscriptionManager;
/// Event received from the sync connection
#[derive(Debug, Clone)]
pub struct SyncedEvent {
pub event: Event,
pub source_url: String,
}
/// Manages a WebSocket connection to a single relay for syncing
pub struct SyncConnection {
url: String,
client: Client,
filter_service: Arc<FilterService>,
remote_domain: String,
subscription_manager: SubscriptionManager,
}
impl SyncConnection {
/// Create a new sync connection to the given relay URL
pub async fn new(
url: &str,
filter_service: Arc<FilterService>,
remote_domain: &str,
) -> Result<Self, Box<dyn std::error::Error + Send + Sync>> {
let client = Client::default();
// Add the relay
client.add_relay(url).await?;
// Connect to the relay
client.connect().await;
tracing::info!("Sync connection established to {}", url);
// Create subscription manager for this connection
let subscription_manager = SubscriptionManager::new(
filter_service.clone(),
remote_domain.to_string(),
);
Ok(Self {
url: url.to_string(),
client,
filter_service,
remote_domain: remote_domain.to_string(),
subscription_manager,
})
}
/// Start receiving events and send them through the channel
///
/// This method runs indefinitely, handling events from all three filter layers.
/// Dynamic subscription updates are triggered when new announcements or PRs arrive.
pub async fn run(mut self, tx: mpsc::Sender<SyncedEvent>) {
// Subscribe to all three filter layers
// Layer 1: Announcement discovery (kinds 30617 + 30618)
let layer1_filters = self.filter_service.get_layer1_filters();
for filter in &layer1_filters {
match self.client.subscribe(filter.clone(), None).await {
Ok(output) => {
tracing::info!(
"Subscribed to Layer 1 (announcements) on {} (subscription: {})",
self.url,
output.id()
);
}
Err(e) => {
tracing::error!("Failed to subscribe Layer 1 on {}: {}", self.url, e);
}
}
}
// Layer 2: Repository events (A/a tags)
let layer2_filters = self
.filter_service
.get_layer2_filters(&self.remote_domain)
.await;
for filter in &layer2_filters {
match self.client.subscribe(filter.clone(), None).await {
Ok(output) => {
tracing::info!(
"Subscribed to Layer 2 (repo events) on {} (subscription: {})",
self.url,
output.id()
);
}
Err(e) => {
tracing::error!("Failed to subscribe Layer 2 on {}: {}", self.url, e);
}
}
}
// Layer 3: Related events (E/e tags)
let layer3_filters = self.filter_service.get_layer3_filters().await;
for filter in &layer3_filters {
match self.client.subscribe(filter.clone(), None).await {
Ok(output) => {
tracing::info!(
"Subscribed to Layer 3 (related events) on {} (subscription: {})",
self.url,
output.id()
);
}
Err(e) => {
tracing::error!("Failed to subscribe Layer 3 on {}: {}", self.url, e);
}
}
}
tracing::info!(
"Sync subscriptions active on {} (L1: {}, L2: {}, L3: {})",
self.url,
layer1_filters.len(),
layer2_filters.len(),
layer3_filters.len()
);
// Handle incoming notifications
let url = self.url.clone();
self.client
.handle_notifications(|notification| {
let tx = tx.clone();
let url = url.clone();
async move {
match notification {
RelayPoolNotification::Event { event, .. } => {
tracing::debug!(
"Received event {} from {} (kind {})",
event.id,
url,
event.kind.as_u16()
);
// Send the event to the manager for processing
let synced = SyncedEvent {
event: (*event).clone(),
source_url: url.clone(),
};
if let Err(e) = tx.send(synced).await {
tracing::warn!("Failed to send synced event: {}", e);
return Ok(true); // Stop if channel is closed
}
}
RelayPoolNotification::Shutdown => {
tracing::warn!("Relay connection shutdown for {}", url);
return Ok(true); // Stop on shutdown
}
RelayPoolNotification::Message { message, .. } => {
tracing::trace!("Received message from {}: {:?}", url, message);
}
}
Ok(false) // Continue processing
}
})
.await
.ok();
}
/// Handle dynamic subscription updates based on incoming event kind
///
/// - kind 30617/30618: New announcement → add Layer 2 subscription
/// - kind 1617/1618/1619/1621/1622: New PR/Issue → add Layer 3 subscription
async fn handle_dynamic_subscription(&mut self, event: &Event) {
let kind = event.kind.as_u16();
// Check if this is an announcement kind (triggers Layer 2 subscription)
if SubscriptionManager::is_announcement_kind(kind) {
if let Some(new_filters) = self.subscription_manager.add_announcement(event) {
tracing::info!(
"New announcement {} on {}, adding {} Layer 2 filter(s) (total filters: {})",
event.id.to_hex(),
self.url,
new_filters.len(),
self.subscription_manager.get_filter_count()
);
self.subscribe_to_filters(new_filters, "Layer 2").await;
}
}
// Check if this is a PR/Issue kind (triggers Layer 3 subscription)
if SubscriptionManager::is_pr_issue_kind(kind) {
if let Some(new_filters) = self.subscription_manager.add_event(event) {
tracing::info!(
"New PR/Issue {} on {}, adding {} Layer 3 filter(s) (total filters: {})",
event.id.to_hex(),
self.url,
new_filters.len(),
self.subscription_manager.get_filter_count()
);
self.subscribe_to_filters(new_filters, "Layer 3").await;
}
}
// Check if we need to consolidate
if self.subscription_manager.should_consolidate() {
self.consolidate_subscriptions().await;
}
}
/// Subscribe to new filters
async fn subscribe_to_filters(&self, filters: Vec<Filter>, layer_name: &str) {
for filter in filters {
match self.client.subscribe(filter, None).await {
Ok(output) => {
tracing::debug!(
"Dynamic {} subscription on {} (subscription: {})",
layer_name,
self.url,
output.id()
);
}
Err(e) => {
tracing::warn!(
"Failed to add dynamic {} subscription on {}: {}",
layer_name,
self.url,
e
);
}
}
}
}
/// Consolidate subscriptions back to Layer 1 only
///
/// This is triggered when the filter count exceeds 150.
/// All existing subscriptions are closed and only Layer 1 is re-subscribed.
async fn consolidate_subscriptions(&mut self) {
tracing::warn!(
"Filter count {} exceeds threshold, consolidating subscriptions on {}",
self.subscription_manager.get_filter_count(),
self.url
);
// Get consolidated filters (clears tracking and returns Layer 1 only)
let layer1_filters = self.subscription_manager.consolidate();
// Note: nostr-sdk doesn't provide a way to close all subscriptions easily
// The client will manage subscription count internally
// We just add the new Layer 1 subscription
for filter in layer1_filters {
match self.client.subscribe(filter, None).await {
Ok(output) => {
tracing::info!(
"Consolidated to Layer 1 subscription on {} (subscription: {})",
self.url,
output.id()
);
}
Err(e) => {
tracing::error!(
"Failed to subscribe Layer 1 after consolidation on {}: {}",
self.url,
e
);
}
}
}
}
/// Get the current filter count from the subscription manager
pub fn get_filter_count(&self) -> usize {
self.subscription_manager.get_filter_count()
}
/// Check if subscriptions have been consolidated
pub fn is_consolidated(&self) -> bool {
self.subscription_manager.is_consolidated()
}
}
/// Reconnect loop with health-aware exponential backoff
///
/// This function manages the connection lifecycle with health tracking:
/// - Checks health state before attempting connections
/// - Reports success/failure to the health tracker
/// - Respects backoff delays from the health tracker
/// - Handles dead relay detection (24h+ failures)
///
/// # Arguments
/// * `url` - The relay URL to connect to
/// * `tx` - Channel sender for synced events
/// * `filter_service` - FilterService for building subscriptions
/// * `our_domain` - Our relay's domain (used to extract remote domain)
/// * `health_tracker` - Health tracker for managing connection state
pub async fn connect_with_retry(
url: &str,
tx: mpsc::Sender<SyncedEvent>,
filter_service: Arc<FilterService>,
_our_domain: &str,
health_tracker: Arc<RelayHealthTracker>,
) {
// Extract remote domain from URL
let remote_domain = extract_domain_from_url(url).unwrap_or_else(|| url.to_string());
loop {
// Check if we should attempt connection based on health state
if !health_tracker.should_attempt_connection(url) {
// Wait for remaining backoff
if let Some(remaining) = health_tracker.get_remaining_backoff(url) {
tracing::debug!(
"Relay {} in backoff, waiting {:?} before retry",
url,
remaining
);
tokio::time::sleep(remaining).await;
continue;
}
}
// Log current health state for dead relays
if health_tracker.is_dead(url) {
tracing::info!(
"Attempting reconnection to dead relay {} (daily retry)",
url
);
}
match SyncConnection::new(url, filter_service.clone(), &remote_domain).await {
Ok(conn) => {
// Record successful connection
health_tracker.record_success(url);
tracing::info!("Sync connection established to {}", url);
// Run the connection (this blocks until disconnection)
conn.run(tx.clone()).await;
// Connection ended - record as failure for reconnection backoff
// (The connection ending is considered a failure even if it worked for a while)
health_tracker.record_failure(url);
tracing::warn!("Sync connection to {} ended, will reconnect", url);
}
Err(e) => {
// Record connection failure
health_tracker.record_failure(url);
let failure_count = health_tracker.get_failure_count(url);
let state = health_tracker.get_state(url);
tracing::error!(
"Failed to connect to sync relay {} (attempt #{}, state: {}): {}",
url,
failure_count,
state,
e
);
}
}
// Get the backoff duration from health tracker
// If the health tracker has no backoff set (shouldn't happen), use a small default
let wait_duration = health_tracker
.get_remaining_backoff(url)
.unwrap_or(Duration::from_secs(5));
tracing::debug!(
"Waiting {:?} before reconnecting to {}",
wait_duration,
url
);
tokio::time::sleep(wait_duration).await;
}
}
/// Extract domain from a URL
fn extract_domain_from_url(url: &str) -> Option<String> {
let url = url
.trim_start_matches("ws://")
.trim_start_matches("wss://")
.trim_start_matches("http://")
.trim_start_matches("https://");
// Remove path
let domain = url.split('/').next()?;
Some(domain.to_string())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_extract_domain() {
assert_eq!(
extract_domain_from_url("ws://127.0.0.1:8080"),
Some("127.0.0.1:8080".to_string())
);
assert_eq!(
extract_domain_from_url("wss://relay.example.com/path"),
Some("relay.example.com".to_string())
);
}
}
|