peerpigeon 1.0.4 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +60 -1
- package/dist/peerpigeon-browser.js +439 -6
- package/dist/peerpigeon-browser.js.map +3 -3
- package/docs/BINARY_IMPLEMENTATION_SUMMARY.md +304 -0
- package/docs/BINARY_MESSAGES.md +332 -0
- package/docs/STREAMING_API.md +542 -0
- package/docs/STREAMING_IMPLEMENTATION_SUMMARY.md +286 -0
- package/examples/binary-message-demo.html +496 -0
- package/examples/browser-2/EXPRESS_SOLUTION.md +183 -0
- package/examples/browser-2/ICE_DEBUG.md +171 -0
- package/examples/browser-2/IMPLEMENTATION.md +218 -0
- package/examples/browser-2/QUICK_START.md +149 -0
- package/examples/browser-2/README.md +303 -0
- package/examples/browser-2/dist/assets/index-Cck_6WJV.css +1 -0
- package/examples/browser-2/dist/assets/index-D8-cNlWQ.js +57 -0
- package/examples/browser-2/dist/index.html +32 -0
- package/examples/browser-2/dist/peerpigeon-browser.js +12483 -0
- package/examples/browser-2/index.html +2 -1
- package/examples/browser-2/package-lock.json +1276 -0
- package/examples/browser-2/package.json +5 -3
- package/examples/browser-2/public/peerpigeon-browser.js +12483 -0
- package/examples/browser-2/src/App.vue +7 -4
- package/examples/browser-2/src/components/CryptoView.vue +4 -4
- package/examples/browser-2/src/components/TestingView.vue +794 -0
- package/examples/browser-2/src/main.js +7 -1
- package/examples/browser-2/src/router.js +63 -0
- package/examples/browser-2/src/stores/peerpigeon.js +68 -7
- package/examples/browser-2/vite.config.js +15 -1
- package/examples/stream-file-transfer-demo.html +935 -0
- package/package.json +1 -1
- package/src/ConnectionManager.js +30 -0
- package/src/PeerConnection.js +409 -4
- package/src/PeerPigeonMesh.js +120 -1
- package/src/SignalingClient.js +12 -5
- package/src/browser-entry.js +5 -1
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
# WebRTC ICE Debugging Guide for Browser-2
|
|
2
|
+
|
|
3
|
+
## Current Issue
|
|
4
|
+
|
|
5
|
+
Peers are discovering each other through signaling but ICE negotiation is failing, preventing WebRTC connections from establishing.
|
|
6
|
+
|
|
7
|
+
## Symptoms
|
|
8
|
+
|
|
9
|
+
- ✅ Signaling works (peers discover each other)
|
|
10
|
+
- ✅ Offers/answers are exchanged
|
|
11
|
+
- ❌ ICE candidates fail
|
|
12
|
+
- ❌ No peer connections establish
|
|
13
|
+
|
|
14
|
+
## Key Differences: Vanilla vs Vue/Vite
|
|
15
|
+
|
|
16
|
+
### Vanilla Browser Example
|
|
17
|
+
- **Protocol**: Could be `file://` or `http://`
|
|
18
|
+
- **No HMR**: No WebSocket conflicts
|
|
19
|
+
- **No Proxy**: Direct WebRTC access
|
|
20
|
+
- **Works perfectly**
|
|
21
|
+
|
|
22
|
+
### Vue/Vite Example (browser-2)
|
|
23
|
+
- **Protocol**: `http://localhost:5173`
|
|
24
|
+
- **HMR Active**: Vite's WebSocket on port 5173
|
|
25
|
+
- **Dev Server**: Vite's middleware
|
|
26
|
+
- **ICE Failing**
|
|
27
|
+
|
|
28
|
+
## Possible Causes
|
|
29
|
+
|
|
30
|
+
### 1. Mixed Content Issues
|
|
31
|
+
If signaling server is `ws://` but page is `https://`, browsers block it.
|
|
32
|
+
- **Check**: Is your signaling server `ws://` or `wss://`?
|
|
33
|
+
- **Solution**: Match protocols (both HTTP + WS or both HTTPS + WSS)
|
|
34
|
+
|
|
35
|
+
### 2. Firefox Strict Networking
|
|
36
|
+
Firefox has stricter WebRTC policies than Chrome.
|
|
37
|
+
- **Check**: Does it work in Chrome?
|
|
38
|
+
- **Solution**: May need TURN server for Firefox
|
|
39
|
+
|
|
40
|
+
### 3. Vite HMR WebSocket Conflict
|
|
41
|
+
Vite's HMR uses WebSocket on same origin, might interfere.
|
|
42
|
+
- **Check**: Disable HMR temporarily
|
|
43
|
+
- **Solution**: Different ports or disable HMR
|
|
44
|
+
|
|
45
|
+
### 4. CORS/Headers
|
|
46
|
+
Vite might be setting headers that interfere with WebRTC.
|
|
47
|
+
- **Check**: Browser console for CORS errors
|
|
48
|
+
- **Solution**: Adjust Vite server headers
|
|
49
|
+
|
|
50
|
+
### 5. Network Topology
|
|
51
|
+
Your local network might require TURN for relay.
|
|
52
|
+
- **Check**: Are you behind a restrictive firewall/NAT?
|
|
53
|
+
- **Solution**: Add TURN server configuration
|
|
54
|
+
|
|
55
|
+
## Debug Steps
|
|
56
|
+
|
|
57
|
+
### Step 1: Check Signaling Server Protocol
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# Check what's running
|
|
61
|
+
lsof -i :3000
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Look for: Is it HTTP or HTTPS?
|
|
65
|
+
|
|
66
|
+
### Step 2: Try in Chrome
|
|
67
|
+
|
|
68
|
+
Open http://localhost:5173 in Chrome instead of Firefox.
|
|
69
|
+
- If it works: Firefox-specific issue
|
|
70
|
+
- If it fails: General Vite/Vue issue
|
|
71
|
+
|
|
72
|
+
### Step 3: Check about:webrtc in Firefox
|
|
73
|
+
|
|
74
|
+
1. Open new tab
|
|
75
|
+
2. Go to `about:webrtc`
|
|
76
|
+
3. Look at "Connection Log"
|
|
77
|
+
4. Find your peer connection attempts
|
|
78
|
+
5. Look for ICE candidate failures
|
|
79
|
+
|
|
80
|
+
Common issues shown:
|
|
81
|
+
- No host candidates (firewall blocking)
|
|
82
|
+
- No srflx candidates (STUN server issues)
|
|
83
|
+
- No relay candidates (need TURN server)
|
|
84
|
+
|
|
85
|
+
### Step 4: Test Without Vite
|
|
86
|
+
|
|
87
|
+
Build for production and serve with simple HTTP server:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
npm run build
|
|
91
|
+
cd dist
|
|
92
|
+
python3 -m http.server 8080
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Open http://localhost:8080
|
|
96
|
+
- If it works: Vite dev server issue
|
|
97
|
+
- If it fails: Build/configuration issue
|
|
98
|
+
|
|
99
|
+
### Step 5: Compare Working vs Failing
|
|
100
|
+
|
|
101
|
+
Open both at the same time:
|
|
102
|
+
1. **Vanilla browser example** (working)
|
|
103
|
+
2. **Vue browser-2** (failing)
|
|
104
|
+
|
|
105
|
+
Check in browser DevTools Network tab:
|
|
106
|
+
- Are WebSocket connections the same?
|
|
107
|
+
- Are there different security warnings?
|
|
108
|
+
- Are ICE candidates different?
|
|
109
|
+
|
|
110
|
+
## Quick Test Commands
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
# Build and test without Vite dev server
|
|
114
|
+
cd /path/to/PeerPigeon/examples/browser-2
|
|
115
|
+
npm run build
|
|
116
|
+
cd dist
|
|
117
|
+
python3 -m http.server 8080
|
|
118
|
+
# Open http://localhost:8080 in browser
|
|
119
|
+
|
|
120
|
+
# Check if signaling server is running
|
|
121
|
+
curl http://localhost:3000/health || echo "Signaling server not running"
|
|
122
|
+
|
|
123
|
+
# Test in different browsers
|
|
124
|
+
open -a "Google Chrome" http://localhost:5173
|
|
125
|
+
open -a "Firefox" http://localhost:5173
|
|
126
|
+
open -a "Safari" http://localhost:5173
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Temporary Workarounds
|
|
130
|
+
|
|
131
|
+
### Workaround 1: Use Production Build
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
npm run build
|
|
135
|
+
npm run preview
|
|
136
|
+
# Opens on different port without HMR
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Workaround 2: Disable HMR
|
|
140
|
+
|
|
141
|
+
Add to `vite.config.js`:
|
|
142
|
+
```javascript
|
|
143
|
+
export default defineConfig({
|
|
144
|
+
server: {
|
|
145
|
+
hmr: false // Disable HMR
|
|
146
|
+
}
|
|
147
|
+
});
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Workaround 3: Add TURN Server
|
|
151
|
+
|
|
152
|
+
If you have access to a TURN server, configure PeerPigeon to use it.
|
|
153
|
+
(Check PeerPigeon docs for ICE server configuration)
|
|
154
|
+
|
|
155
|
+
## Expected Behavior
|
|
156
|
+
|
|
157
|
+
When working correctly, you should see in console:
|
|
158
|
+
```
|
|
159
|
+
🔍 PEER DISCOVERED EVENT
|
|
160
|
+
🤝 PEER CONNECTED EVENT ← This is missing!
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
Currently seeing:
|
|
164
|
+
```
|
|
165
|
+
🔍 PEER DISCOVERED EVENT ✅
|
|
166
|
+
👋 PEER DISCONNECTED EVENT (ICE failed) ❌
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## Next Steps
|
|
170
|
+
|
|
171
|
+
Please run the **Step 4** test (build + simple HTTP server) and let me know if that works. This will tell us if it's specifically a Vite dev server issue.
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
# Browser-2 Testing Integration - Implementation Summary
|
|
2
|
+
|
|
3
|
+
## What Was Done
|
|
4
|
+
|
|
5
|
+
Successfully added comprehensive PeerPigeon testing support to the browser-2 (Vue 3) example, matching the capabilities of the browser example.
|
|
6
|
+
|
|
7
|
+
## Changes Made
|
|
8
|
+
|
|
9
|
+
### 1. New Testing View Component
|
|
10
|
+
**File:** `src/components/TestingView.vue`
|
|
11
|
+
|
|
12
|
+
Created a comprehensive testing interface with:
|
|
13
|
+
- Quick test buttons (Validate Peer ID, Performance Test, Stress Test, etc.)
|
|
14
|
+
- Test configuration options (message count, size, peer ID input)
|
|
15
|
+
- Real-time test results display with color-coded status
|
|
16
|
+
- Performance metrics tracking (messages sent/received, DHT operations, duration, success rate, avg response time)
|
|
17
|
+
- Export functionality (logs, test results, metrics)
|
|
18
|
+
|
|
19
|
+
### 2. Router Setup
|
|
20
|
+
**File:** `src/router.js` (NEW)
|
|
21
|
+
|
|
22
|
+
- Created Vue Router configuration
|
|
23
|
+
- Added routes for all feature tabs
|
|
24
|
+
- Added new `/testing` route for the testing view
|
|
25
|
+
- Set up navigation with clean URLs
|
|
26
|
+
|
|
27
|
+
### 3. Main.js Update
|
|
28
|
+
**File:** `src/main.js`
|
|
29
|
+
|
|
30
|
+
Changed from simple demo to full app:
|
|
31
|
+
- Import and configure Pinia for state management
|
|
32
|
+
- Import and configure Vue Router
|
|
33
|
+
- Use full `App.vue` instead of `App-simple.vue`
|
|
34
|
+
|
|
35
|
+
### 4. App.vue Update
|
|
36
|
+
**File:** `src/App.vue`
|
|
37
|
+
|
|
38
|
+
- Added Testing tab to navigation (🧪 icon)
|
|
39
|
+
- Fixed favicon loading (replaced with emoji icon)
|
|
40
|
+
- Navigation now includes all 8 feature tabs
|
|
41
|
+
|
|
42
|
+
### 5. Store Enhancements
|
|
43
|
+
**File:** `src/stores/peerpigeon.js`
|
|
44
|
+
|
|
45
|
+
Added test-specific methods:
|
|
46
|
+
- `sendBroadcastMessage()` - Send broadcast messages
|
|
47
|
+
- `sendDirectMessage()` - Send direct peer-to-peer messages
|
|
48
|
+
- `dhtPut()` / `dhtGet()` - DHT operations
|
|
49
|
+
- Performance tracking support
|
|
50
|
+
- Debug logging integration
|
|
51
|
+
|
|
52
|
+
### 6. PeerPigeon Loading Fix
|
|
53
|
+
**Critical fix for Vite/Vue integration issues**
|
|
54
|
+
|
|
55
|
+
#### Problem
|
|
56
|
+
- Vite's module system was interfering with PeerPigeon's global window object
|
|
57
|
+
- PeerPigeon wasn't loading correctly, resulting in mock implementations
|
|
58
|
+
- Peers couldn't connect despite signaling server being available
|
|
59
|
+
|
|
60
|
+
#### Solution
|
|
61
|
+
1. **Public Folder Approach:**
|
|
62
|
+
- Created `public/` directory
|
|
63
|
+
- Copy `peerpigeon-browser.js` to public folder
|
|
64
|
+
- Vite serves files from public folder as static assets
|
|
65
|
+
|
|
66
|
+
2. **Build Script Update (`package.json`):**
|
|
67
|
+
```json
|
|
68
|
+
"scripts": {
|
|
69
|
+
"dev": "npm run copy-peerpigeon && vite",
|
|
70
|
+
"build": "npm run copy-peerpigeon && vite build",
|
|
71
|
+
"copy-peerpigeon": "mkdir -p public && cp ../../dist/peerpigeon-browser.js public/ || true"
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
3. **HTML Loading Order (`index.html`):**
|
|
76
|
+
```html
|
|
77
|
+
<!-- Load PeerPigeon BEFORE Vue app -->
|
|
78
|
+
<script src="/peerpigeon-browser.js"></script>
|
|
79
|
+
<script type="module" src="/src/main.js"></script>
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
4. **Wait for PeerPigeon Helper (`stores/peerpigeon.js`):**
|
|
83
|
+
- Added `waitForPeerPigeon()` function
|
|
84
|
+
- Polls for `window.PeerPigeon` availability
|
|
85
|
+
- 5-second timeout with fallback to mock
|
|
86
|
+
- Ensures PeerPigeon is loaded before initializing mesh
|
|
87
|
+
|
|
88
|
+
5. **Vite Config Simplification (`vite.config.js`):**
|
|
89
|
+
- Removed complex path aliases
|
|
90
|
+
- Let Vite handle public folder automatically
|
|
91
|
+
- Simple, clean configuration
|
|
92
|
+
|
|
93
|
+
### 7. CryptoView Bug Fixes
|
|
94
|
+
**File:** `src/components/CryptoView.vue`
|
|
95
|
+
|
|
96
|
+
Fixed duplicate function declarations:
|
|
97
|
+
- Renamed `signData()` function to `performSign()`
|
|
98
|
+
- Renamed `verifySignature()` function to `performVerify()`
|
|
99
|
+
- Updated template to use new function names
|
|
100
|
+
|
|
101
|
+
### 8. Documentation
|
|
102
|
+
**File:** `README.md`
|
|
103
|
+
|
|
104
|
+
Comprehensive documentation including:
|
|
105
|
+
- Feature overview (all 8 tabs)
|
|
106
|
+
- Testing suite capabilities
|
|
107
|
+
- Getting started guide
|
|
108
|
+
- PeerPigeon loading requirements
|
|
109
|
+
- Troubleshooting section for common issues:
|
|
110
|
+
- Mock peer ID issues
|
|
111
|
+
- No peers connecting
|
|
112
|
+
- Build problems
|
|
113
|
+
- Step-by-step debugging instructions
|
|
114
|
+
|
|
115
|
+
## File Structure
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
browser-2/
|
|
119
|
+
├── public/
|
|
120
|
+
│ └── peerpigeon-browser.js # PeerPigeon library (copied)
|
|
121
|
+
├── src/
|
|
122
|
+
│ ├── components/
|
|
123
|
+
│ │ ├── TestingView.vue # NEW - Testing interface
|
|
124
|
+
│ │ ├── CryptoView.vue # Fixed duplicate declarations
|
|
125
|
+
│ │ └── ...other views
|
|
126
|
+
│ ├── stores/
|
|
127
|
+
│ │ └── peerpigeon.js # Enhanced with testing methods
|
|
128
|
+
│ ├── App.vue # Updated with Testing tab
|
|
129
|
+
│ ├── main.js # Updated to use router & Pinia
|
|
130
|
+
│ └── router.js # NEW - Router configuration
|
|
131
|
+
├── index.html # Updated PeerPigeon loading
|
|
132
|
+
├── package.json # Added copy-peerpigeon script
|
|
133
|
+
├── vite.config.js # Simplified configuration
|
|
134
|
+
└── README.md # Complete documentation
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## Testing Features
|
|
139
|
+
|
|
140
|
+
### Test Types
|
|
141
|
+
1. **Peer ID Validation** - Validates peer ID format
|
|
142
|
+
2. **Performance Test** - Measures message throughput and response times
|
|
143
|
+
3. **Stress Test** - Combined DHT + messaging load test
|
|
144
|
+
4. **Invalid Peer Test** - Tests error handling for invalid peers
|
|
145
|
+
5. **Malformed Message Test** - Tests handling of malformed data
|
|
146
|
+
6. **DHT Limits Test** - Tests DHT with large payloads
|
|
147
|
+
|
|
148
|
+
### Metrics Tracked
|
|
149
|
+
- Messages sent/received
|
|
150
|
+
- DHT operations count
|
|
151
|
+
- Test duration
|
|
152
|
+
- Success rate percentage
|
|
153
|
+
- Average response time
|
|
154
|
+
|
|
155
|
+
### Export Options
|
|
156
|
+
- Export all logs (JSON)
|
|
157
|
+
- Export test results (JSON)
|
|
158
|
+
- Export performance metrics (JSON)
|
|
159
|
+
|
|
160
|
+
## Comparison: Browser vs Browser-2
|
|
161
|
+
|
|
162
|
+
| Feature | Browser (Vanilla) | Browser-2 (Vue 3) |
|
|
163
|
+
|---------|-------------------|-------------------|
|
|
164
|
+
| Framework | Vanilla JS | Vue 3 + Vite |
|
|
165
|
+
| State | Class-based | Pinia Store |
|
|
166
|
+
| UI Updates | Manual DOM | Reactive |
|
|
167
|
+
| Components | Monolithic | Modular |
|
|
168
|
+
| Testing | ✅ Complete | ✅ Complete |
|
|
169
|
+
| Build | Script tag | Vite bundler |
|
|
170
|
+
| Dev Server | Simple HTTP | Vite HMR |
|
|
171
|
+
|
|
172
|
+
## Key Learnings
|
|
173
|
+
|
|
174
|
+
### Vite + PeerPigeon Integration
|
|
175
|
+
1. **Script loading order matters** - PeerPigeon must load before Vue
|
|
176
|
+
2. **Public folder is essential** - Vite serves static assets from public/
|
|
177
|
+
3. **Async loading required** - Wait for global objects to be available
|
|
178
|
+
4. **Module system conflicts** - ES modules don't mix well with globals
|
|
179
|
+
5. **Build process integration** - Copy library before starting dev server
|
|
180
|
+
|
|
181
|
+
### Vue 3 Patterns
|
|
182
|
+
1. **Composition API** - Clean, testable component logic
|
|
183
|
+
2. **Pinia stores** - Centralized state management
|
|
184
|
+
3. **Router integration** - Tab navigation with clean URLs
|
|
185
|
+
4. **Reactive data** - Automatic UI updates from store changes
|
|
186
|
+
|
|
187
|
+
## Usage
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
# Install dependencies
|
|
191
|
+
npm install
|
|
192
|
+
|
|
193
|
+
# Start development server (auto-copies PeerPigeon)
|
|
194
|
+
npm run dev
|
|
195
|
+
|
|
196
|
+
# Build for production
|
|
197
|
+
npm run build
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
## Success Criteria ✅
|
|
201
|
+
|
|
202
|
+
- [x] Testing tab added to navigation
|
|
203
|
+
- [x] All test types implemented
|
|
204
|
+
- [x] Performance metrics tracking
|
|
205
|
+
- [x] Export functionality working
|
|
206
|
+
- [x] Real PeerPigeon library loads (not mock)
|
|
207
|
+
- [x] Peers can connect to each other
|
|
208
|
+
- [x] Tests run successfully when connected
|
|
209
|
+
- [x] Build succeeds without errors
|
|
210
|
+
- [x] Documentation complete with troubleshooting
|
|
211
|
+
|
|
212
|
+
## Next Steps (Optional)
|
|
213
|
+
|
|
214
|
+
1. Add more test scenarios (reconnection, network switching, etc.)
|
|
215
|
+
2. Implement test result history/persistence
|
|
216
|
+
3. Add visual charts for performance metrics
|
|
217
|
+
4. Create automated test suites
|
|
218
|
+
5. Add CI/CD integration for automated testing
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
# Quick Start Checklist
|
|
2
|
+
|
|
3
|
+
## ✅ Setup Complete!
|
|
4
|
+
|
|
5
|
+
Your browser-2 example now has comprehensive testing support just like the browser example.
|
|
6
|
+
|
|
7
|
+
## Before Running
|
|
8
|
+
|
|
9
|
+
### 1. Start the Signaling Server
|
|
10
|
+
```bash
|
|
11
|
+
# From the root PeerPigeon directory
|
|
12
|
+
npm run dev-server
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
The server should be running on `ws://localhost:3000`
|
|
16
|
+
|
|
17
|
+
### 2. Start the Browser-2 Dev Server
|
|
18
|
+
```bash
|
|
19
|
+
# From examples/browser-2
|
|
20
|
+
npm run dev
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
This will:
|
|
24
|
+
- Copy PeerPigeon library to public folder
|
|
25
|
+
- Start Vite dev server on http://localhost:5173
|
|
26
|
+
|
|
27
|
+
## Testing the Setup
|
|
28
|
+
|
|
29
|
+
### Check PeerPigeon is Loading
|
|
30
|
+
|
|
31
|
+
1. Open http://localhost:5173 in your browser
|
|
32
|
+
2. Look at the header - you should see:
|
|
33
|
+
- **Peer ID**: Should be a real hex ID (40 characters), NOT `mock-peer-xxxxx`
|
|
34
|
+
- **Status**: Should show "Disconnected" initially
|
|
35
|
+
|
|
36
|
+
3. Open browser console (F12) and check for:
|
|
37
|
+
```
|
|
38
|
+
✅ PeerPigeon loaded successfully
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Connect to Network
|
|
42
|
+
|
|
43
|
+
1. Click the **"Connect"** button in the header
|
|
44
|
+
2. Status should change to "Connected"
|
|
45
|
+
3. Peer count should show "0/4" (or similar)
|
|
46
|
+
|
|
47
|
+
### Add Another Peer
|
|
48
|
+
|
|
49
|
+
Open one of these in another browser tab/window:
|
|
50
|
+
- Another tab of http://localhost:5173
|
|
51
|
+
- The original browser example: `examples/browser/index.html`
|
|
52
|
+
|
|
53
|
+
You should see:
|
|
54
|
+
- Peer count increase to "1/4", "2/4", etc.
|
|
55
|
+
- Connected peers listed in the Network tab
|
|
56
|
+
|
|
57
|
+
### Run Tests
|
|
58
|
+
|
|
59
|
+
1. Click the **🧪 Testing** tab
|
|
60
|
+
2. Try a quick test:
|
|
61
|
+
- Click **"Performance Test"** button
|
|
62
|
+
- Watch test results appear in real-time
|
|
63
|
+
- Check the metrics at the bottom
|
|
64
|
+
|
|
65
|
+
## Troubleshooting
|
|
66
|
+
|
|
67
|
+
### Problem: Mock Peer ID (`mock-peer-xxxxx`)
|
|
68
|
+
|
|
69
|
+
**Cause:** PeerPigeon library didn't load
|
|
70
|
+
|
|
71
|
+
**Solutions:**
|
|
72
|
+
```bash
|
|
73
|
+
# 1. Verify the file exists
|
|
74
|
+
ls public/peerpigeon-browser.js
|
|
75
|
+
|
|
76
|
+
# 2. If missing, rebuild PeerPigeon
|
|
77
|
+
cd ../..
|
|
78
|
+
npm run build
|
|
79
|
+
|
|
80
|
+
# 3. Copy to public folder
|
|
81
|
+
cd examples/browser-2
|
|
82
|
+
npm run copy-peerpigeon
|
|
83
|
+
|
|
84
|
+
# 4. Hard refresh browser (Ctrl+Shift+R)
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Problem: No Peers Connecting
|
|
88
|
+
|
|
89
|
+
**Causes:**
|
|
90
|
+
1. Signaling server not running
|
|
91
|
+
2. Wrong WebSocket URL
|
|
92
|
+
3. Only one browser tab open
|
|
93
|
+
|
|
94
|
+
**Solutions:**
|
|
95
|
+
```bash
|
|
96
|
+
# 1. Check signaling server
|
|
97
|
+
npm run dev-server # from root directory
|
|
98
|
+
|
|
99
|
+
# 2. Verify URL in header
|
|
100
|
+
# Should be: ws://localhost:3000
|
|
101
|
+
|
|
102
|
+
# 3. Open multiple tabs
|
|
103
|
+
# - Open another tab of localhost:5173
|
|
104
|
+
# - OR open examples/browser/index.html
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Problem: Tests Failing
|
|
108
|
+
|
|
109
|
+
**Cause:** Not connected to network
|
|
110
|
+
|
|
111
|
+
**Solution:**
|
|
112
|
+
1. Click "Connect" button first
|
|
113
|
+
2. Wait for at least 1 peer to connect
|
|
114
|
+
3. Then run tests
|
|
115
|
+
|
|
116
|
+
## What Should Work Now
|
|
117
|
+
|
|
118
|
+
✅ Real PeerPigeon library loads (not mock)
|
|
119
|
+
✅ Peers can connect to signaling server
|
|
120
|
+
✅ Peers discover and connect to each other
|
|
121
|
+
✅ All 8 feature tabs work (Network, Messaging, Media, DHT, Storage, Crypto, Debug, Testing)
|
|
122
|
+
✅ Testing tab shows comprehensive test suite
|
|
123
|
+
✅ Tests execute and show results
|
|
124
|
+
✅ Performance metrics track correctly
|
|
125
|
+
✅ Export functions work
|
|
126
|
+
|
|
127
|
+
## Quick Demo Flow
|
|
128
|
+
|
|
129
|
+
1. **Start servers** (signaling + dev)
|
|
130
|
+
2. **Open browser** → http://localhost:5173
|
|
131
|
+
3. **Connect** → Click "Connect" button
|
|
132
|
+
4. **Open second tab** → Same URL
|
|
133
|
+
5. **Watch peers connect** → Peer count increases
|
|
134
|
+
6. **Try messaging** → Go to Messaging tab, send message
|
|
135
|
+
7. **Run tests** → Go to Testing tab, click "Performance Test"
|
|
136
|
+
8. **Check results** → See real-time test results and metrics
|
|
137
|
+
|
|
138
|
+
## Need Help?
|
|
139
|
+
|
|
140
|
+
Check these files:
|
|
141
|
+
- `README.md` - Full documentation
|
|
142
|
+
- `IMPLEMENTATION.md` - Technical details
|
|
143
|
+
- Browser console (F12) - Error messages and logs
|
|
144
|
+
|
|
145
|
+
Common console messages:
|
|
146
|
+
- `✅ PeerPigeon loaded successfully` - Good!
|
|
147
|
+
- `🔍 PeerPigeon availability: {available: true}` - Good!
|
|
148
|
+
- `❌ PeerPigeon not found` - Need to fix loading
|
|
149
|
+
- `🤝 Peer connected: abc12345...` - Peer connection working!
|