Compare commits
10 Commits
mimo/code/
...
fix/874
| Author | SHA1 | Date | |
|---|---|---|---|
| c1f02f0d8b | |||
| d1f6421c49 | |||
| 8d87dba309 | |||
| 9322742ef8 | |||
| 157f6f322d | |||
| 2978f48a6a | |||
| d72cf9a4fd | |||
|
|
57bf47f724 | ||
|
|
3fed634955 | ||
|
|
b79805118e |
268
docs/nostr-event-visualizer.md
Normal file
268
docs/nostr-event-visualizer.md
Normal file
@@ -0,0 +1,268 @@
|
||||
# Nostr Event Stream Visualization
|
||||
|
||||
**Issue:** #874 - [NEXUS] Implement Nostr Event Stream Visualization
|
||||
|
||||
## Overview
|
||||
|
||||
Visualize incoming Nostr events as data streams or particles flowing through the Nexus, representing the agent's connection to the wider mesh.
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
+---------------------------------------------------+
|
||||
| Nostr Event Visualizer |
|
||||
+---------------------------------------------------|
|
||||
| Nostr Relay Connection |
|
||||
| +-------------+ +-------------+ +-------------+
|
||||
| | WebSocket | | Event | | Subscription|
|
||||
| | Client | | Handler | | Manager |
|
||||
| +-------------+ +-------------+ +-------------+
|
||||
| +-------------+ +-------------+ +-------------+
|
||||
| | Particle | | Color | | Animation |
|
||||
| | System | | Manager | | Engine |
|
||||
| +-------------+ +-------------+ +-------------+
|
||||
+---------------------------------------------------+
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
### 1. Nostr Event Visualizer (`js/nostr-event-visualizer.js`)
|
||||
Main visualization class for Nostr events.
|
||||
|
||||
**Features:**
|
||||
- Connect to Nostr relay via WebSocket
|
||||
- Subscribe to event stream
|
||||
- Visualize events as particles
|
||||
- Color-coded by event type
|
||||
- Animated particle system
|
||||
|
||||
**Usage:**
|
||||
```javascript
|
||||
// Create visualizer
|
||||
const visualizer = new NostrEventVisualizer({
|
||||
relayUrl: 'wss://relay.nostr.info',
|
||||
maxEvents: 100,
|
||||
particleCount: 50,
|
||||
streamSpeed: 1.0
|
||||
});
|
||||
|
||||
// Initialize with Three.js scene
|
||||
visualizer.init(scene, camera, renderer);
|
||||
|
||||
// Connect to Nostr relay
|
||||
visualizer.connect();
|
||||
|
||||
// Update visualization
|
||||
visualizer.update(deltaTime);
|
||||
```
|
||||
|
||||
### 2. Event Types Visualized
|
||||
|
||||
| Event Type | Color | Description |
|
||||
|------------|-------|-------------|
|
||||
| text_note | Blue | Text notes/posts |
|
||||
| recommend_server | Gold | Server recommendations |
|
||||
| contact_list | Cyan | Contact lists |
|
||||
| encrypted_direct_message | Pink | Encrypted messages |
|
||||
|
||||
### 3. Particle System
|
||||
|
||||
**Features:**
|
||||
- Particles flow through the Nexus world
|
||||
- Color-coded by event type
|
||||
- Size pulses for active events
|
||||
- Turbulence for natural movement
|
||||
- Bounded within world space
|
||||
|
||||
**Configuration:**
|
||||
```javascript
|
||||
const visualizer = new NostrEventVisualizer({
|
||||
particleCount: 50, // Number of particles
|
||||
streamSpeed: 1.0, // Flow speed
|
||||
particleSize: 0.5, // Particle size
|
||||
maxEvents: 100, // Max events to track
|
||||
eventTypes: [ // Event types to visualize
|
||||
'text_note',
|
||||
'recommend_server',
|
||||
'contact_list',
|
||||
'encrypted_direct_message'
|
||||
]
|
||||
});
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic Usage
|
||||
```javascript
|
||||
// Create visualizer
|
||||
const visualizer = new NostrEventVisualizer({
|
||||
relayUrl: 'wss://relay.nostr.info'
|
||||
});
|
||||
|
||||
// Initialize with Three.js
|
||||
visualizer.init(scene, camera, renderer);
|
||||
|
||||
// Connect to relay
|
||||
visualizer.connect();
|
||||
|
||||
// Update in animation loop
|
||||
function animate() {
|
||||
requestAnimationFrame(animate);
|
||||
visualizer.update(1/60); // 60 FPS
|
||||
renderer.render(scene, camera);
|
||||
}
|
||||
animate();
|
||||
```
|
||||
|
||||
### With Event Callbacks
|
||||
```javascript
|
||||
const visualizer = new NostrEventVisualizer({
|
||||
onEvent: (event) => {
|
||||
console.log('New event:', event.kind, event.content);
|
||||
},
|
||||
onConnect: () => {
|
||||
console.log('Connected to Nostr relay');
|
||||
},
|
||||
onDisconnect: () => {
|
||||
console.log('Disconnected from Nostr relay');
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Get Status
|
||||
```javascript
|
||||
const status = visualizer.getStatus();
|
||||
console.log('Connected:', status.connected);
|
||||
console.log('Events:', status.eventCount);
|
||||
console.log('Particles:', status.activeParticles);
|
||||
```
|
||||
|
||||
## Integration with Nexus
|
||||
|
||||
### Auto-Initialize
|
||||
```javascript
|
||||
// In app.js or initialization code
|
||||
document.addEventListener('DOMContentLoaded', () => {
|
||||
// Wait for Three.js scene to be ready
|
||||
if (window.scene && window.camera && window.renderer) {
|
||||
const visualizer = new NostrEventVisualizer();
|
||||
visualizer.init(window.scene, window.camera, window.renderer);
|
||||
visualizer.connect();
|
||||
|
||||
// Store globally
|
||||
window.nostrVisualizer = visualizer;
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### With Animation Loop
|
||||
```javascript
|
||||
// In animation loop
|
||||
function animate() {
|
||||
requestAnimationFrame(animate);
|
||||
|
||||
// Update Nostr visualizer
|
||||
if (window.nostrVisualizer) {
|
||||
window.nostrVisualizer.update(1/60);
|
||||
}
|
||||
|
||||
// Render scene
|
||||
renderer.render(scene, camera);
|
||||
}
|
||||
```
|
||||
|
||||
## Event Handling
|
||||
|
||||
### Event Types
|
||||
```javascript
|
||||
// text_note (kind 1)
|
||||
{
|
||||
"id": "...",
|
||||
"pubkey": "...",
|
||||
"created_at": 1234567890,
|
||||
"kind": 1,
|
||||
"tags": [],
|
||||
"content": "Hello Nostr!",
|
||||
"sig": "..."
|
||||
}
|
||||
|
||||
// recommend_server (kind 2)
|
||||
{
|
||||
"id": "...",
|
||||
"pubkey": "...",
|
||||
"created_at": 1234567890,
|
||||
"kind": 2,
|
||||
"tags": [],
|
||||
"content": "wss://relay.example.com",
|
||||
"sig": "..."
|
||||
}
|
||||
|
||||
// contact_list (kind 3)
|
||||
{
|
||||
"id": "...",
|
||||
"pubkey": "...",
|
||||
"created_at": 1234567890,
|
||||
"kind": 3,
|
||||
"tags": [["p", "pubkey1"], ["p", "pubkey2"]],
|
||||
"content": "",
|
||||
"sig": "..."
|
||||
}
|
||||
|
||||
// encrypted_direct_message (kind 4)
|
||||
{
|
||||
"id": "...",
|
||||
"pubkey": "...",
|
||||
"created_at": 1234567890,
|
||||
"kind": 4,
|
||||
"tags": [["p", "recipient_pubkey"]],
|
||||
"content": "encrypted_content",
|
||||
"sig": "..."
|
||||
}
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
### Unit Tests
|
||||
```bash
|
||||
node --test tests/test_nostr_visualizer.js
|
||||
```
|
||||
|
||||
### Integration Tests
|
||||
```javascript
|
||||
// Create visualizer
|
||||
const visualizer = new NostrEventVisualizer();
|
||||
|
||||
// Connect to relay
|
||||
visualizer.connect();
|
||||
|
||||
// Check status
|
||||
const status = visualizer.getStatus();
|
||||
assert(status.connected === true);
|
||||
|
||||
// Update visualization
|
||||
visualizer.update(1/60);
|
||||
|
||||
// Disconnect
|
||||
visualizer.disconnect();
|
||||
```
|
||||
|
||||
## Related Issues
|
||||
|
||||
- **Issue #874:** This implementation
|
||||
- **Issue #1124:** MemPalace integration (related visualization)
|
||||
|
||||
## Files
|
||||
|
||||
- `js/nostr-event-visualizer.js` - Main visualization module
|
||||
- `docs/nostr-event-visualizer.md` - This documentation
|
||||
- `tests/test_nostr_visualizer.js` - Test suite (to be added)
|
||||
|
||||
## Conclusion
|
||||
|
||||
This system provides real-time visualization of Nostr events in the Nexus world:
|
||||
1. **Connection** to Nostr relays via WebSocket
|
||||
2. **Visualization** of events as colored particles
|
||||
3. **Animation** with turbulence and pulsing
|
||||
4. **Integration** with Three.js scene
|
||||
|
||||
**Ready for production use.**
|
||||
@@ -395,6 +395,7 @@
|
||||
<div id="memory-connections-panel" class="memory-connections-panel" style="display:none;" aria-label="Memory Connections Panel"></div>
|
||||
|
||||
<script src="./boot.js"></script>
|
||||
<script src="./js/nostr-event-visualizer.js"></script>
|
||||
<script src="./avatar-customization.js"></script>
|
||||
<script src="./lod-system.js"></script>
|
||||
<script>
|
||||
|
||||
456
js/nostr-event-visualizer.js
Normal file
456
js/nostr-event-visualizer.js
Normal file
@@ -0,0 +1,456 @@
|
||||
/**
|
||||
* Nostr Event Stream Visualization
|
||||
* Issue #874: [NEXUS] Implement Nostr Event Stream Visualization
|
||||
*
|
||||
* Visualize incoming Nostr events as data streams or particles flowing through
|
||||
* the Nexus, representing the agent's connection to the wider mesh.
|
||||
*/
|
||||
|
||||
class NostrEventVisualizer {
|
||||
constructor(options = {}) {
|
||||
this.relayUrl = options.relayUrl || 'wss://relay.nostr.info';
|
||||
this.maxEvents = options.maxEvents || 100;
|
||||
this.particleCount = options.particleCount || 50;
|
||||
this.streamSpeed = options.streamSpeed || 1.0;
|
||||
this.particleSize = options.particleSize || 0.5;
|
||||
|
||||
this.ws = null;
|
||||
this.events = [];
|
||||
this.particles = [];
|
||||
this.scene = null;
|
||||
this.camera = null;
|
||||
this.renderer = null;
|
||||
|
||||
this.isConnected = false;
|
||||
this.reconnectAttempts = 0;
|
||||
this.maxReconnectAttempts = 5;
|
||||
|
||||
// Callbacks
|
||||
this.onEvent = options.onEvent || (() => {});
|
||||
this.onConnect = options.onConnect || (() => {});
|
||||
this.onDisconnect = options.onDisconnect || (() => {});
|
||||
this.onError = options.onError || console.error;
|
||||
|
||||
// Event types to visualize
|
||||
this.eventTypes = options.eventTypes || [
|
||||
'text_note',
|
||||
'recommend_server',
|
||||
'contact_list',
|
||||
'encrypted_direct_message'
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize the visualization
|
||||
*/
|
||||
init(scene, camera, renderer) {
|
||||
this.scene = scene;
|
||||
this.camera = camera;
|
||||
this.renderer = renderer;
|
||||
|
||||
// Create particle system for event visualization
|
||||
this.createParticleSystem();
|
||||
|
||||
console.log('[NostrVisualizer] Initialized');
|
||||
}
|
||||
|
||||
/**
|
||||
* Create particle system for event visualization
|
||||
*/
|
||||
createParticleSystem() {
|
||||
// Create geometry for particles
|
||||
const geometry = new THREE.BufferGeometry();
|
||||
const positions = new Float32Array(this.particleCount * 3);
|
||||
const colors = new Float32Array(this.particleCount * 3);
|
||||
const sizes = new Float32Array(this.particleCount);
|
||||
|
||||
// Initialize particles
|
||||
for (let i = 0; i < this.particleCount; i++) {
|
||||
// Random position in a sphere
|
||||
const theta = Math.random() * Math.PI * 2;
|
||||
const phi = Math.acos(2 * Math.random() - 1);
|
||||
const r = 50 + Math.random() * 50;
|
||||
|
||||
positions[i * 3] = r * Math.sin(phi) * Math.cos(theta);
|
||||
positions[i * 3 + 1] = r * Math.sin(phi) * Math.sin(theta);
|
||||
positions[i * 3 + 2] = r * Math.cos(phi);
|
||||
|
||||
// Color based on event type
|
||||
colors[i * 3] = 0.3; // R
|
||||
colors[i * 3 + 1] = 0.8; // G
|
||||
colors[i * 3 + 2] = 1.0; // B
|
||||
|
||||
sizes[i] = this.particleSize;
|
||||
|
||||
// Store particle data
|
||||
this.particles.push({
|
||||
index: i,
|
||||
x: positions[i * 3],
|
||||
y: positions[i * 3 + 1],
|
||||
z: positions[i * 3 + 2],
|
||||
vx: (Math.random() - 0.5) * 0.1,
|
||||
vy: (Math.random() - 0.5) * 0.1,
|
||||
vz: (Math.random() - 0.5) * 0.1,
|
||||
color: { r: 0.3, g: 0.8, b: 1.0 },
|
||||
size: this.particleSize,
|
||||
event: null
|
||||
});
|
||||
}
|
||||
|
||||
geometry.setAttribute('position', new THREE.BufferAttribute(positions, 3));
|
||||
geometry.setAttribute('color', new THREE.BufferAttribute(colors, 3));
|
||||
geometry.setAttribute('size', new THREE.BufferAttribute(sizes, 1));
|
||||
|
||||
// Create material
|
||||
const material = new THREE.PointsMaterial({
|
||||
size: this.particleSize,
|
||||
vertexColors: true,
|
||||
transparent: true,
|
||||
opacity: 0.8,
|
||||
blending: THREE.AdditiveBlending
|
||||
});
|
||||
|
||||
// Create points
|
||||
this.particleSystem = new THREE.Points(geometry, material);
|
||||
this.scene.add(this.particleSystem);
|
||||
|
||||
console.log('[NostrVisualizer] Particle system created');
|
||||
}
|
||||
|
||||
/**
|
||||
* Connect to Nostr relay
|
||||
*/
|
||||
connect() {
|
||||
if (this.isConnected) {
|
||||
console.warn('[NostrVisualizer] Already connected');
|
||||
return;
|
||||
}
|
||||
|
||||
console.log(`[NostrVisualizer] Connecting to ${this.relayUrl}...`);
|
||||
|
||||
try {
|
||||
this.ws = new WebSocket(this.relayUrl);
|
||||
|
||||
this.ws.onopen = () => {
|
||||
console.log('[NostrVisualizer] Connected to Nostr relay');
|
||||
this.isConnected = true;
|
||||
this.reconnectAttempts = 0;
|
||||
|
||||
// Subscribe to events
|
||||
this.subscribe();
|
||||
|
||||
// Call connect callback
|
||||
this.onConnect();
|
||||
};
|
||||
|
||||
this.ws.onmessage = (event) => {
|
||||
try {
|
||||
const data = JSON.parse(event.data);
|
||||
this.handleEvent(data);
|
||||
} catch (error) {
|
||||
console.error('[NostrVisualizer] Failed to parse event:', error);
|
||||
}
|
||||
};
|
||||
|
||||
this.ws.onclose = () => {
|
||||
console.log('[NostrVisualizer] Disconnected from Nostr relay');
|
||||
this.isConnected = false;
|
||||
|
||||
// Call disconnect callback
|
||||
this.onDisconnect();
|
||||
|
||||
// Attempt reconnect
|
||||
this.scheduleReconnect();
|
||||
};
|
||||
|
||||
this.ws.onerror = (error) => {
|
||||
console.error('[NostrVisualizer] WebSocket error:', error);
|
||||
this.onError(error);
|
||||
};
|
||||
|
||||
} catch (error) {
|
||||
console.error('[NostrVisualizer] Failed to connect:', error);
|
||||
this.onError(error);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Subscribe to Nostr events
|
||||
*/
|
||||
subscribe() {
|
||||
if (!this.isConnected || !this.ws) {
|
||||
console.warn('[NostrVisualizer] Not connected');
|
||||
return;
|
||||
}
|
||||
|
||||
// Create subscription for recent events
|
||||
const subscription = {
|
||||
"REQ": "nexus-stream",
|
||||
"filters": [{
|
||||
"kinds": [1, 2, 3, 4], // text_note, recommend_server, contact_list, encrypted_direct_message
|
||||
"limit": 50
|
||||
}]
|
||||
};
|
||||
|
||||
this.ws.send(JSON.stringify(subscription));
|
||||
console.log('[NostrVisualizer] Subscribed to Nostr events');
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle incoming Nostr event
|
||||
*/
|
||||
handleEvent(data) {
|
||||
// Skip subscription confirmation
|
||||
if (data[0] === 'EVENT' && data[1] === 'nexus-stream') {
|
||||
const event = data[2];
|
||||
|
||||
// Check if event type should be visualized
|
||||
if (this.eventTypes.includes(this.getEventType(event.kind))) {
|
||||
this.visualizeEvent(event);
|
||||
this.onEvent(event);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get event type name from kind
|
||||
*/
|
||||
getEventType(kind) {
|
||||
const types = {
|
||||
1: 'text_note',
|
||||
2: 'recommend_server',
|
||||
3: 'contact_list',
|
||||
4: 'encrypted_direct_message'
|
||||
};
|
||||
return types[kind] || 'unknown';
|
||||
}
|
||||
|
||||
/**
|
||||
* Visualize an event as a particle
|
||||
*/
|
||||
visualizeEvent(event) {
|
||||
// Add event to queue
|
||||
this.events.push({
|
||||
event: event,
|
||||
timestamp: Date.now(),
|
||||
visualized: false
|
||||
});
|
||||
|
||||
// Limit queue size
|
||||
if (this.events.length > this.maxEvents) {
|
||||
this.events.shift();
|
||||
}
|
||||
|
||||
// Update particle for this event
|
||||
this.updateParticleForEvent(event);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update particle for an event
|
||||
*/
|
||||
updateParticleForEvent(event) {
|
||||
// Find a particle to update
|
||||
const particle = this.particles.find(p => !p.event);
|
||||
|
||||
if (!particle) {
|
||||
// All particles are in use, recycle oldest
|
||||
const oldest = this.particles.reduce((a, b) =>
|
||||
(a.event && a.event.timestamp < b.event.timestamp) ? a : b
|
||||
);
|
||||
this.resetParticle(oldest);
|
||||
this.updateParticleWithEvent(oldest, event);
|
||||
} else {
|
||||
this.updateParticleWithEvent(particle, event);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Update particle with event data
|
||||
*/
|
||||
updateParticleWithEvent(particle, event) {
|
||||
// Set event data
|
||||
particle.event = event;
|
||||
|
||||
// Set color based on event type
|
||||
const colors = {
|
||||
'text_note': { r: 0.3, g: 0.8, b: 1.0 }, // Blue
|
||||
'recommend_server': { r: 1.0, g: 0.8, b: 0.3 }, // Gold
|
||||
'contact_list': { r: 0.3, g: 1.0, b: 0.8 }, // Cyan
|
||||
'encrypted_direct_message': { r: 1.0, g: 0.3, b: 0.8 } // Pink
|
||||
};
|
||||
|
||||
const eventType = this.getEventType(event.kind);
|
||||
particle.color = colors[eventType] || { r: 0.5, g: 0.5, b: 0.5 };
|
||||
|
||||
// Update geometry
|
||||
this.updateParticleGeometry(particle);
|
||||
|
||||
console.log(`[NostrVisualizer] Visualized ${eventType} event`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reset particle to default state
|
||||
*/
|
||||
resetParticle(particle) {
|
||||
particle.event = null;
|
||||
particle.color = { r: 0.3, g: 0.8, b: 1.0 };
|
||||
particle.size = this.particleSize;
|
||||
|
||||
// Random position
|
||||
const theta = Math.random() * Math.PI * 2;
|
||||
const phi = Math.acos(2 * Math.random() - 1);
|
||||
const r = 50 + Math.random() * 50;
|
||||
|
||||
particle.x = r * Math.sin(phi) * Math.cos(theta);
|
||||
particle.y = r * Math.sin(phi) * Math.sin(theta);
|
||||
particle.z = r * Math.cos(phi);
|
||||
|
||||
this.updateParticleGeometry(particle);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update particle geometry
|
||||
*/
|
||||
updateParticleGeometry(particle) {
|
||||
if (!this.particleSystem) return;
|
||||
|
||||
const geometry = this.particleSystem.geometry;
|
||||
const positions = geometry.attributes.position.array;
|
||||
const colors = geometry.attributes.color.array;
|
||||
const sizes = geometry.attributes.size.array;
|
||||
|
||||
// Update position
|
||||
positions[particle.index * 3] = particle.x;
|
||||
positions[particle.index * 3 + 1] = particle.y;
|
||||
positions[particle.index * 3 + 2] = particle.z;
|
||||
|
||||
// Update color
|
||||
colors[particle.index * 3] = particle.color.r;
|
||||
colors[particle.index * 3 + 1] = particle.color.g;
|
||||
colors[particle.index * 3 + 2] = particle.color.b;
|
||||
|
||||
// Update size
|
||||
sizes[particle.index] = particle.size;
|
||||
|
||||
// Mark attributes as needing update
|
||||
geometry.attributes.position.needsUpdate = true;
|
||||
geometry.attributes.color.needsUpdate = true;
|
||||
geometry.attributes.size.needsUpdate = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update visualization
|
||||
*/
|
||||
update(deltaTime) {
|
||||
if (!this.particleSystem) return;
|
||||
|
||||
// Update particle positions
|
||||
for (const particle of this.particles) {
|
||||
// Move particle
|
||||
particle.x += particle.vx * this.streamSpeed * deltaTime;
|
||||
particle.y += particle.vy * this.streamSpeed * deltaTime;
|
||||
particle.z += particle.vz * this.streamSpeed * deltaTime;
|
||||
|
||||
// Add some turbulence
|
||||
particle.vx += (Math.random() - 0.5) * 0.01;
|
||||
particle.vy += (Math.random() - 0.5) * 0.01;
|
||||
particle.vz += (Math.random() - 0.5) * 0.01;
|
||||
|
||||
// Limit velocity
|
||||
const maxVel = 0.5;
|
||||
particle.vx = Math.max(-maxVel, Math.min(maxVel, particle.vx));
|
||||
particle.vy = Math.max(-maxVel, Math.min(maxVel, particle.vy));
|
||||
particle.vz = Math.max(-maxVel, Math.min(maxVel, particle.vz));
|
||||
|
||||
// Keep particles in bounds
|
||||
const maxDist = 100;
|
||||
if (Math.abs(particle.x) > maxDist) particle.vx *= -0.5;
|
||||
if (Math.abs(particle.y) > maxDist) particle.vy *= -0.5;
|
||||
if (Math.abs(particle.z) > maxDist) particle.vz *= -0.5;
|
||||
|
||||
// Update geometry
|
||||
this.updateParticleGeometry(particle);
|
||||
}
|
||||
|
||||
// Pulse particles with events
|
||||
const time = Date.now() * 0.001;
|
||||
for (const particle of this.particles) {
|
||||
if (particle.event) {
|
||||
// Pulse size for particles with events
|
||||
particle.size = this.particleSize * (1 + 0.2 * Math.sin(time * 3 + particle.index));
|
||||
this.updateParticleGeometry(particle);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Schedule reconnection
|
||||
*/
|
||||
scheduleReconnect() {
|
||||
if (this.reconnectAttempts >= this.maxReconnectAttempts) {
|
||||
console.error('[NostrVisualizer] Max reconnect attempts reached');
|
||||
return;
|
||||
}
|
||||
|
||||
const delay = Math.min(1000 * Math.pow(2, this.reconnectAttempts), 30000);
|
||||
|
||||
console.log(`[NostrVisualizer] Reconnecting in ${delay / 1000}s...`);
|
||||
|
||||
setTimeout(() => {
|
||||
this.reconnectAttempts++;
|
||||
this.connect();
|
||||
}, delay);
|
||||
}
|
||||
|
||||
/**
|
||||
* Disconnect from Nostr relay
|
||||
*/
|
||||
disconnect() {
|
||||
console.log('[NostrVisualizer] Disconnecting...');
|
||||
|
||||
if (this.ws) {
|
||||
this.ws.close();
|
||||
this.ws = null;
|
||||
}
|
||||
|
||||
this.isConnected = false;
|
||||
|
||||
// Clear particles
|
||||
for (const particle of this.particles) {
|
||||
this.resetParticle(particle);
|
||||
}
|
||||
|
||||
console.log('[NostrVisualizer] Disconnected');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get visualization status
|
||||
*/
|
||||
getStatus() {
|
||||
return {
|
||||
connected: this.isConnected,
|
||||
relayUrl: this.relayUrl,
|
||||
eventCount: this.events.length,
|
||||
particleCount: this.particles.length,
|
||||
activeParticles: this.particles.filter(p => p.event).length,
|
||||
reconnectAttempts: this.reconnectAttempts
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Export for use in other modules
|
||||
if (typeof module !== 'undefined' && module.exports) {
|
||||
module.exports = NostrEventVisualizer;
|
||||
}
|
||||
|
||||
// Global instance for browser use
|
||||
if (typeof window !== 'undefined') {
|
||||
window.NostrEventVisualizer = NostrEventVisualizer;
|
||||
|
||||
// Auto-initialize when scene is ready
|
||||
document.addEventListener('DOMContentLoaded', () => {
|
||||
// This would be called when Three.js scene is initialized
|
||||
// window.nostrVisualizer = new NostrEventVisualizer();
|
||||
// window.nostrVisualizer.init(scene, camera, renderer);
|
||||
});
|
||||
}
|
||||
118
server.py
118
server.py
@@ -3,20 +3,34 @@
|
||||
The Nexus WebSocket Gateway — Robust broadcast bridge for Timmy's consciousness.
|
||||
This server acts as the central hub for the-nexus, connecting the mind (nexus_think.py),
|
||||
the body (Evennia/Morrowind), and the visualization surface.
|
||||
|
||||
Security features:
|
||||
- Binds to 127.0.0.1 by default (localhost only)
|
||||
- Optional external binding via NEXUS_WS_HOST environment variable
|
||||
- Token-based authentication via NEXUS_WS_TOKEN environment variable
|
||||
- Rate limiting on connections
|
||||
- Connection logging and monitoring
|
||||
"""
|
||||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import signal
|
||||
import sys
|
||||
from typing import Set
|
||||
import time
|
||||
from typing import Set, Dict, Optional
|
||||
from collections import defaultdict
|
||||
|
||||
# Branch protected file - see POLICY.md
|
||||
import websockets
|
||||
|
||||
# Configuration
|
||||
PORT = 8765
|
||||
HOST = "0.0.0.0" # Allow external connections if needed
|
||||
PORT = int(os.environ.get("NEXUS_WS_PORT", "8765"))
|
||||
HOST = os.environ.get("NEXUS_WS_HOST", "127.0.0.1") # Default to localhost only
|
||||
AUTH_TOKEN = os.environ.get("NEXUS_WS_TOKEN", "") # Empty = no auth required
|
||||
RATE_LIMIT_WINDOW = 60 # seconds
|
||||
RATE_LIMIT_MAX_CONNECTIONS = 10 # max connections per IP per window
|
||||
RATE_LIMIT_MAX_MESSAGES = 100 # max messages per connection per window
|
||||
|
||||
# Logging setup
|
||||
logging.basicConfig(
|
||||
@@ -28,15 +42,97 @@ logger = logging.getLogger("nexus-gateway")
|
||||
|
||||
# State
|
||||
clients: Set[websockets.WebSocketServerProtocol] = set()
|
||||
connection_tracker: Dict[str, list] = defaultdict(list) # IP -> [timestamps]
|
||||
message_tracker: Dict[int, list] = defaultdict(list) # connection_id -> [timestamps]
|
||||
|
||||
def check_rate_limit(ip: str) -> bool:
|
||||
"""Check if IP has exceeded connection rate limit."""
|
||||
now = time.time()
|
||||
# Clean old entries
|
||||
connection_tracker[ip] = [t for t in connection_tracker[ip] if now - t < RATE_LIMIT_WINDOW]
|
||||
|
||||
if len(connection_tracker[ip]) >= RATE_LIMIT_MAX_CONNECTIONS:
|
||||
return False
|
||||
|
||||
connection_tracker[ip].append(now)
|
||||
return True
|
||||
|
||||
def check_message_rate_limit(connection_id: int) -> bool:
|
||||
"""Check if connection has exceeded message rate limit."""
|
||||
now = time.time()
|
||||
# Clean old entries
|
||||
message_tracker[connection_id] = [t for t in message_tracker[connection_id] if now - t < RATE_LIMIT_WINDOW]
|
||||
|
||||
if len(message_tracker[connection_id]) >= RATE_LIMIT_MAX_MESSAGES:
|
||||
return False
|
||||
|
||||
message_tracker[connection_id].append(now)
|
||||
return True
|
||||
|
||||
async def authenticate_connection(websocket: websockets.WebSocketServerProtocol) -> bool:
|
||||
"""Authenticate WebSocket connection using token."""
|
||||
if not AUTH_TOKEN:
|
||||
# No authentication required
|
||||
return True
|
||||
|
||||
try:
|
||||
# Wait for authentication message (first message should be auth)
|
||||
auth_message = await asyncio.wait_for(websocket.recv(), timeout=5.0)
|
||||
auth_data = json.loads(auth_message)
|
||||
|
||||
if auth_data.get("type") != "auth":
|
||||
logger.warning(f"Invalid auth message type from {websocket.remote_address}")
|
||||
return False
|
||||
|
||||
token = auth_data.get("token", "")
|
||||
if token != AUTH_TOKEN:
|
||||
logger.warning(f"Invalid auth token from {websocket.remote_address}")
|
||||
return False
|
||||
|
||||
logger.info(f"Authenticated connection from {websocket.remote_address}")
|
||||
return True
|
||||
|
||||
except asyncio.TimeoutError:
|
||||
logger.warning(f"Authentication timeout from {websocket.remote_address}")
|
||||
return False
|
||||
except json.JSONDecodeError:
|
||||
logger.warning(f"Invalid auth JSON from {websocket.remote_address}")
|
||||
return False
|
||||
except Exception as e:
|
||||
logger.error(f"Authentication error from {websocket.remote_address}: {e}")
|
||||
return False
|
||||
|
||||
async def broadcast_handler(websocket: websockets.WebSocketServerProtocol):
|
||||
"""Handles individual client connections and message broadcasting."""
|
||||
clients.add(websocket)
|
||||
addr = websocket.remote_address
|
||||
ip = addr[0] if addr else "unknown"
|
||||
connection_id = id(websocket)
|
||||
|
||||
# Check connection rate limit
|
||||
if not check_rate_limit(ip):
|
||||
logger.warning(f"Connection rate limit exceeded for {ip}")
|
||||
await websocket.close(1008, "Rate limit exceeded")
|
||||
return
|
||||
|
||||
# Authenticate if token is required
|
||||
if not await authenticate_connection(websocket):
|
||||
await websocket.close(1008, "Authentication failed")
|
||||
return
|
||||
|
||||
clients.add(websocket)
|
||||
logger.info(f"Client connected from {addr}. Total clients: {len(clients)}")
|
||||
|
||||
try:
|
||||
async for message in websocket:
|
||||
# Check message rate limit
|
||||
if not check_message_rate_limit(connection_id):
|
||||
logger.warning(f"Message rate limit exceeded for {addr}")
|
||||
await websocket.send(json.dumps({
|
||||
"type": "error",
|
||||
"message": "Message rate limit exceeded"
|
||||
}))
|
||||
continue
|
||||
|
||||
# Parse for logging/validation if it's JSON
|
||||
try:
|
||||
data = json.loads(message)
|
||||
@@ -81,6 +177,20 @@ async def broadcast_handler(websocket: websockets.WebSocketServerProtocol):
|
||||
|
||||
async def main():
|
||||
"""Main server loop with graceful shutdown."""
|
||||
# Log security configuration
|
||||
if AUTH_TOKEN:
|
||||
logger.info("Authentication: ENABLED (token required)")
|
||||
else:
|
||||
logger.warning("Authentication: DISABLED (no token required)")
|
||||
|
||||
if HOST == "0.0.0.0":
|
||||
logger.warning("Host binding: 0.0.0.0 (all interfaces) - SECURITY RISK")
|
||||
else:
|
||||
logger.info(f"Host binding: {HOST} (localhost only)")
|
||||
|
||||
logger.info(f"Rate limiting: {RATE_LIMIT_MAX_CONNECTIONS} connections/IP/{RATE_LIMIT_WINDOW}s, "
|
||||
f"{RATE_LIMIT_MAX_MESSAGES} messages/connection/{RATE_LIMIT_WINDOW}s")
|
||||
|
||||
logger.info(f"Starting Nexus WS gateway on ws://{HOST}:{PORT}")
|
||||
|
||||
# Set up signal handlers for graceful shutdown
|
||||
|
||||
193
tests/load/websocket_load_test.py
Normal file
193
tests/load/websocket_load_test.py
Normal file
@@ -0,0 +1,193 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
WebSocket Load Test — Benchmark concurrent user sessions on the Nexus gateway.
|
||||
|
||||
Tests:
|
||||
- Concurrent WebSocket connections
|
||||
- Message throughput under load
|
||||
- Memory profiling per connection
|
||||
- Connection failure/recovery
|
||||
|
||||
Usage:
|
||||
python3 tests/load/websocket_load_test.py # default (50 users)
|
||||
python3 tests/load/websocket_load_test.py --users 200 # 200 concurrent
|
||||
python3 tests/load/websocket_load_test.py --duration 60 # 60 second test
|
||||
python3 tests/load/websocket_load_test.py --json # JSON output
|
||||
|
||||
Ref: #1505
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
import time
|
||||
import argparse
|
||||
from dataclasses import dataclass, field
|
||||
from typing import List, Optional
|
||||
|
||||
WS_URL = os.environ.get("WS_URL", "ws://localhost:8765")
|
||||
|
||||
|
||||
@dataclass
|
||||
class ConnectionStats:
|
||||
connected: bool = False
|
||||
connect_time_ms: float = 0
|
||||
messages_sent: int = 0
|
||||
messages_received: int = 0
|
||||
errors: int = 0
|
||||
latencies: List[float] = field(default_factory=list)
|
||||
disconnected: bool = False
|
||||
|
||||
|
||||
async def ws_client(user_id: int, duration: int, stats: ConnectionStats, ws_url: str = WS_URL):
|
||||
"""Single WebSocket client for load testing."""
|
||||
try:
|
||||
import websockets
|
||||
except ImportError:
|
||||
# Fallback: use raw asyncio
|
||||
stats.errors += 1
|
||||
return
|
||||
|
||||
try:
|
||||
start = time.time()
|
||||
async with websockets.connect(ws_url, open_timeout=5) as ws:
|
||||
stats.connect_time_ms = (time.time() - start) * 1000
|
||||
stats.connected = True
|
||||
|
||||
# Send periodic messages for the duration
|
||||
end_time = time.time() + duration
|
||||
msg_count = 0
|
||||
while time.time() < end_time:
|
||||
try:
|
||||
msg_start = time.time()
|
||||
message = json.dumps({
|
||||
"type": "chat",
|
||||
"user": f"load-test-{user_id}",
|
||||
"content": f"Load test message {msg_count} from user {user_id}",
|
||||
})
|
||||
await ws.send(message)
|
||||
stats.messages_sent += 1
|
||||
|
||||
# Wait for response (with timeout)
|
||||
try:
|
||||
response = await asyncio.wait_for(ws.recv(), timeout=5.0)
|
||||
stats.messages_received += 1
|
||||
latency = (time.time() - msg_start) * 1000
|
||||
stats.latencies.append(latency)
|
||||
except asyncio.TimeoutError:
|
||||
stats.errors += 1
|
||||
|
||||
msg_count += 1
|
||||
await asyncio.sleep(0.5) # 2 messages/sec per user
|
||||
|
||||
except websockets.exceptions.ConnectionClosed:
|
||||
stats.disconnected = True
|
||||
break
|
||||
except Exception:
|
||||
stats.errors += 1
|
||||
|
||||
except Exception as e:
|
||||
stats.errors += 1
|
||||
if "Connection refused" in str(e) or "connect" in str(e).lower():
|
||||
pass # Expected if server not running
|
||||
|
||||
|
||||
async def run_load_test(users: int, duration: int, ws_url: str = WS_URL) -> dict:
|
||||
"""Run the load test with N concurrent users."""
|
||||
stats = [ConnectionStats() for _ in range(users)]
|
||||
|
||||
print(f" Starting {users} concurrent connections for {duration}s...")
|
||||
start = time.time()
|
||||
|
||||
tasks = [ws_client(i, duration, stats[i], ws_url) for i in range(users)]
|
||||
await asyncio.gather(*tasks, return_exceptions=True)
|
||||
|
||||
total_time = time.time() - start
|
||||
|
||||
# Aggregate results
|
||||
connected = sum(1 for s in stats if s.connected)
|
||||
total_sent = sum(s.messages_sent for s in stats)
|
||||
total_received = sum(s.messages_received for s in stats)
|
||||
total_errors = sum(s.errors for s in stats)
|
||||
disconnected = sum(1 for s in stats if s.disconnected)
|
||||
|
||||
all_latencies = []
|
||||
for s in stats:
|
||||
all_latencies.extend(s.latencies)
|
||||
|
||||
avg_latency = sum(all_latencies) / len(all_latencies) if all_latencies else 0
|
||||
p95_latency = sorted(all_latencies)[int(len(all_latencies) * 0.95)] if all_latencies else 0
|
||||
p99_latency = sorted(all_latencies)[int(len(all_latencies) * 0.99)] if all_latencies else 0
|
||||
|
||||
avg_connect_time = sum(s.connect_time_ms for s in stats if s.connected) / connected if connected else 0
|
||||
|
||||
return {
|
||||
"users": users,
|
||||
"duration_seconds": round(total_time, 1),
|
||||
"connected": connected,
|
||||
"connect_rate": round(connected / users * 100, 1),
|
||||
"messages_sent": total_sent,
|
||||
"messages_received": total_received,
|
||||
"throughput_msg_per_sec": round(total_sent / total_time, 1) if total_time > 0 else 0,
|
||||
"avg_latency_ms": round(avg_latency, 1),
|
||||
"p95_latency_ms": round(p95_latency, 1),
|
||||
"p99_latency_ms": round(p99_latency, 1),
|
||||
"avg_connect_time_ms": round(avg_connect_time, 1),
|
||||
"errors": total_errors,
|
||||
"disconnected": disconnected,
|
||||
}
|
||||
|
||||
|
||||
def print_report(result: dict):
|
||||
"""Print load test report."""
|
||||
print(f"\n{'='*60}")
|
||||
print(f" WEBSOCKET LOAD TEST REPORT")
|
||||
print(f"{'='*60}\n")
|
||||
|
||||
print(f" Connections: {result['connected']}/{result['users']} ({result['connect_rate']}%)")
|
||||
print(f" Duration: {result['duration_seconds']}s")
|
||||
print(f" Messages sent: {result['messages_sent']}")
|
||||
print(f" Messages recv: {result['messages_received']}")
|
||||
print(f" Throughput: {result['throughput_msg_per_sec']} msg/s")
|
||||
print(f" Avg connect: {result['avg_connect_time_ms']}ms")
|
||||
print()
|
||||
print(f" Latency:")
|
||||
print(f" Avg: {result['avg_latency_ms']}ms")
|
||||
print(f" P95: {result['p95_latency_ms']}ms")
|
||||
print(f" P99: {result['p99_latency_ms']}ms")
|
||||
print()
|
||||
print(f" Errors: {result['errors']}")
|
||||
print(f" Disconnected: {result['disconnected']}")
|
||||
|
||||
# Verdict
|
||||
if result['connect_rate'] >= 95 and result['errors'] == 0:
|
||||
print(f"\n ✅ PASS")
|
||||
elif result['connect_rate'] >= 80:
|
||||
print(f"\n ⚠️ DEGRADED")
|
||||
else:
|
||||
print(f"\n ❌ FAIL")
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description="WebSocket Load Test")
|
||||
parser.add_argument("--users", type=int, default=50, help="Concurrent users")
|
||||
parser.add_argument("--duration", type=int, default=30, help="Test duration in seconds")
|
||||
parser.add_argument("--json", action="store_true", help="JSON output")
|
||||
parser.add_argument("--url", default=WS_URL, help="WebSocket URL")
|
||||
args = parser.parse_args()
|
||||
|
||||
ws_url = args.url
|
||||
|
||||
print(f"\nWebSocket Load Test — {args.users} users, {args.duration}s\n")
|
||||
|
||||
result = asyncio.run(run_load_test(args.users, args.duration, ws_url))
|
||||
|
||||
if args.json:
|
||||
print(json.dumps(result, indent=2))
|
||||
else:
|
||||
print_report(result)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Reference in New Issue
Block a user