gun-rs 1.0.4

A realtime, decentralized, offline-first, graph data synchronization engine (Rust port)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

# Test Suite


This directory contains the test suite for Gun.rs.

## Test Files


- `basic_tests.rs` - Unit tests for core functionality (no network required)
- `integration_tests.rs` - Integration tests that connect to a real Gun.js relay server
- `lock_tests.rs` - Tests for lock contention and deadlock prevention
- `stress_tests.rs` - Stress tests for concurrent operations and network resilience
- `webrtc_tests.rs` - Comprehensive tests for WebRTC functionality (25+ tests)

## Running Tests


### Run All Tests

```bash
cargo test
```

### Run Only Unit Tests (Fast, No Network Required)

```bash
cargo test --lib
```

### Run Integration Tests (Requires Network Connectivity)

```bash
cargo test --test integration_tests
```

### Run WebRTC Tests

```bash
# Unit tests for WebRTC components

cargo test --test webrtc_tests

# Integration test: Two clients via WebRTC

cargo test --test webrtc_two_clients -- --nocapture
```

### Run Lock Contention Tests

```bash
cargo test --test lock_tests
```

### Run Stress Tests

```bash
cargo test --test stress_tests
```

### Run Tests with Output

```bash
cargo test --test integration_tests -- --nocapture
cargo test --test webrtc_tests -- --nocapture
```

### Run Specific Test

```bash
cargo test --test integration_tests test_relay_put_get
cargo test --test webrtc_tests test_webrtc_peer_creation
```

## Integration Tests


The integration tests (`integration_tests.rs`) connect to a real Gun.js relay server to verify:
- Basic put/get operations
- Real-time updates
- Data persistence
- Concurrent connections
- Chain operations
- Map operations
- Error handling

**Note**: Integration tests require:
1. Network connectivity
2. Access to the relay server: `http://dig-relay-prod.eba-2cmanxbe.us-east-1.elasticbeanstalk.com/gun`
3. May take longer to run due to network delays

The tests use unique keys (with timestamps) to avoid conflicts with other tests or users.

## WebRTC Tests


The `webrtc_tests.rs` file contains **25+ comprehensive tests** covering:

### Configuration Tests

- Default WebRTC options
- Custom ICE servers (STUN/TURN)
- Data channel configuration
- Options cloning

### WebRTCPeer Tests

- Peer connection creation
- SDP offer/answer generation
- Message sending through data channels
- Connection state tracking
- Peer cleanup and closing
- Concurrent peer creation

### WebRTCManager Tests

- Manager initialization
- RTC signaling message handling (offer, answer, ICE candidate)
- Peer discovery and connection initiation
- Self-message filtering
- Invalid message handling
- Connection limit enforcement
- Message forwarding to mesh

### Integration Tests

- Gun instance with WebRTC enabled/disabled
- Invalid SDP handling
- Connection timeouts
- Error scenarios

**Note**: Some WebRTC tests may fail if STUN servers are unreachable (expected in restricted network environments). This is normal and doesn't indicate a code issue.

## Test Coverage


- ✅ Core database operations
- ✅ Chain API
- ✅ Event system
- ✅ Network synchronization
- ✅ Data persistence
- ✅ Error handling
- ✅ Real-time updates
- ✅ WebRTC peer-to-peer connections (25+ tests)
- ✅ NAT traversal (STUN/TURN)
- ✅ SDP offer/answer exchange
- ✅ ICE candidate handling
- ✅ Lock contention and deadlock prevention
- ✅ Stress testing for concurrent operations