Compare commits

..

3 Commits

Author SHA1 Message Date
1ff5badf1e Merge branch 'main' into fix/1539
Some checks failed
Review Approval Gate / verify-review (pull_request) Failing after 13s
CI / test (pull_request) Failing after 1m16s
CI / validate (pull_request) Failing after 1m21s
2026-04-22 01:16:42 +00:00
Alexander Whitestone
f8a0556c26 feat: add portal health checks for #1539
Some checks failed
CI / test (pull_request) Failing after 59s
Review Approval Gate / verify-review (pull_request) Failing after 8s
CI / validate (pull_request) Failing after 58s
2026-04-17 02:00:08 -04:00
Alexander Whitestone
9f6cdf4b92 test: define portal health checks for #1539 2026-04-17 01:38:46 -04:00
7 changed files with 397 additions and 246 deletions

234
GENOME.md
View File

@@ -1,234 +0,0 @@
# GENOME.md — The Nexus Codebase Architecture Map
**Generated**: 2026-04-20
**Repository**: Timmy_Foundation/the-nexus
**Purpose**: Comprehensive map of the Nexus codebase for developers and AI agents.
---
## Overview
The Nexus is Timmy's canonical 3D/world repository — a sovereign AI agent visualization surface and local-first training ground. It combines a Three.js 3D browser world with Python cognition components, WebSocket bridges, and fleet orchestration tools.
**Key Stats**:
- ~357 source files
- 201 Python files
- 23 JavaScript files
- 107 Markdown docs
- 24 Shell scripts
---
## Architecture
```
the-nexus/
├── app.js # Main Three.js 3D world (frontend entry)
├── index.html # HTML shell
├── style.css # Global styles
├── server.py # WebSocket gateway
├── gofai_worker.js # GOFAI web worker
├── portals.json # Portal registry
├── vision.json # Vision points config
├── provenance.json # File integrity hashes
├── nexus/ # Python cognition layer
│ ├── components/ # Frontend JS modules
│ ├── mnemosyne/ # Memory system
│ ├── mempalace/ # Long-term memory
│ └── symbolic-engine.js # GOFAI rules
├── scripts/ # Operational scripts
├── bin/ # CLI tools
├── tests/ # Test suite
├── docs/ # Documentation
└── config/ # Configuration files
```
---
## Frontend (Browser World)
### Entry Points
| File | Purpose |
|------|---------|
| `index.html` | HTML shell, HUD layout |
| `app.js` | Main Three.js app (~141K lines) |
| `style.css` | All styles (~61K) |
| `gofai_worker.js` | Off-thread GOFAI reasoning |
### Core Systems
| System | File | Description |
|--------|------|-------------|
| 3D World | `app.js` | Three.js scene, camera, rendering |
| GOFAI | `app.js` | Symbolic rules, blackboard, planner |
| Memory | `nexus/components/spatial-memory.js` | 3D memory crystals |
| Audio | `nexus/components/spatial-audio.js` | Spatial sound system |
| Portals | `portals.json` | External service links |
| Chat | `app.js` | Chat panel and messaging |
| HUD | `app.js` + `style.css` | Heads-up display |
### Components (`nexus/components/`)
| Component | Purpose |
|-----------|---------|
| `spatial-memory.js` | 3D memory crystal visualization |
| `spatial-audio.js` | Spatial sound for memories |
| `memory-birth.js` | Memory creation animation |
| `memory-pulse.js` | BFS pulse wave on click |
| `memory-inspect.js` | Memory detail panel |
| `memory-connections.js` | Connection graph |
| `memory-particles.js` | Particle effects |
| `memory-optimizer.js` | Memory cleanup |
| `session-rooms.js` | Evennia room snapshots |
| `timeline-scrubber.js` | Time navigation |
| `resonance-visualizer.js` | Pattern visualization |
| `portal-health-check.js` | Portal status monitoring |
| `spatial-chat.js` | 3D audio chat notifications |
---
## Backend (Python)
### Core Services
| File | Purpose |
|------|---------|
| `server.py` | WebSocket gateway for real-time comms |
| `multi_user_bridge.py` | Multi-user MUD bridge |
| `gitea_api/` | Gitea API helpers |
### Scripts (`scripts/`)
| Script | Purpose |
|--------|---------|
| `cleanup-duplicate-prs.sh` | Close duplicate PRs |
| `check-existing-prs.sh` | Pre-flight PR check |
| `pr_backlog_analyzer.py` | PR backlog analysis |
| `audit_mempalace_privacy.py` | Privacy audit |
| `provision-runner.sh` | Runner setup |
| `runner_health_probe.sh` | Health monitoring |
### Bin Tools (`bin/`)
| Tool | Purpose |
|------|---------|
| `enforce_branch_protection.py` | Branch protection enforcement |
| `check_duplicate_milestones.py` | Milestone cleanup |
| `generate_provenance.py` | Provenance hash generation |
---
## Data Files
| File | Format | Purpose |
|------|--------|---------|
| `portals.json` | JSON | Portal registry (8 portals) |
| `vision.json` | JSON | Vision points |
| `world_state.json` | JSON | World state snapshot |
| `provenance.json` | JSON | File integrity hashes |
| `manifest.json` | JSON | PWA manifest |
---
## Configuration
| File | Purpose |
|------|---------|
| `.gitea/branch-protection/` | Branch protection rules |
| `.github/workflows/` | CI/CD workflows |
| `config/` | Runtime configuration |
| `pytest.ini` | Test configuration |
---
## Testing
| Directory | Coverage |
|-----------|----------|
| `tests/` | Unit and integration tests |
| `tests/test_provenance.py` | File integrity tests |
| `tests/test_spatial_search.js` | Spatial search tests |
Run tests:
```bash
python3 -m pytest tests/ -v
node --test tests/*.js
```
---
## Key Patterns
### Component Pattern
```javascript
const ComponentName = (() => {
let _state = null;
function init(config) { ... }
function update(delta) { ... }
return { init, update };
})();
export { ComponentName };
```
### WebSocket Pattern
```python
async def handler(websocket):
async for message in websocket:
# Process and broadcast
pass
```
### Portal Schema
```json
{
"id": "portal-id",
"name": "Display Name",
"portal_type": "game-world",
"destination": { "url": "...", "type": "harness" }
}
```
---
## Security
- WebSocket gateway binds to `127.0.0.1` by default
- Optional token authentication via `NEXUS_WS_TOKEN`
- Rate limiting on connections and messages
- Branch protection on `main`
- Provenance hash verification
See `SECURITY.md` for full details.
---
## Related Repos
| Repo | Relationship |
|------|--------------|
| `timmy-config` | Configuration and fleet management |
| `hermes-agent` | Agent runtime |
| `timmy-home` | SOUL.md and core docs |
| `the-door` | Crisis detection system |
---
## Quick Start
```bash
# Clone
git clone https://forge.alexanderwhitestone.com/Timmy_Foundation/the-nexus.git
# Run WebSocket gateway
python3 server.py
# Open browser world
open index.html
# Run tests
python3 -m pytest tests/
```
---
*This GENOME.md is auto-maintained. Update when adding major new systems.*

114
app.js
View File

@@ -83,6 +83,7 @@ let workshopPanelCanvas = null;
let workshopScanMat = null;
let workshopPanelRefreshTimer = 0;
let lastFocusedPortal = null;
let portalHealthTimer = null;
// ═══ VISITOR / OPERATOR MODE ═══
let uiMode = 'visitor'; // 'visitor' | 'operator'
@@ -1536,6 +1537,7 @@ function createPortals(data) {
const portal = createPortal(config);
portals.push(portal);
});
startPortalHealthChecks();
}
function createPortal(config) {
@@ -1674,6 +1676,19 @@ function createPortal(config) {
swirl,
pSystem,
light,
labelCanvas,
labelContext: lctx,
labelTexture: labelTex,
labelMesh,
baseState: window.PortalHealth
? window.PortalHealth.captureBaseState(config)
: {
status: config.status || 'online',
blocked_reason: config.blocked_reason ?? null,
interaction_ready: config.interaction_ready !== false,
action_label: config.destination?.action_label || 'ENTER',
},
health: null,
customElements: {}
};
@@ -1754,6 +1769,86 @@ function createPortal(config) {
return portalObj;
}
function updatePortalLabelTexture(portal, runtimeState) {
if (!portal?.labelContext || !portal?.labelCanvas || !portal?.labelTexture) return;
const ctx = portal.labelContext;
const canvas = portal.labelCanvas;
const portalColor = new THREE.Color(portal.config.color);
ctx.clearRect(0, 0, canvas.width, canvas.height);
ctx.font = 'bold 32px "Orbitron", sans-serif';
ctx.fillStyle = '#' + portalColor.getHexString();
ctx.textAlign = 'center';
ctx.fillText(`${portal.config.name.toUpperCase()}`, 256, 36);
ctx.font = 'bold 18px "Orbitron", sans-serif';
if (runtimeState && runtimeState.online === false) {
ctx.fillStyle = '#ff4466';
ctx.fillText('OFFLINE', 256, 68);
} else if (portal.config.role) {
const roleColors = { timmy: '#4af0c0', reflex: '#ff4466', pilot: '#ffd700', creative: '#ff00ff' };
ctx.fillStyle = roleColors[portal.config.role] || '#888888';
ctx.fillText(portal.config.role.toUpperCase(), 256, 68);
}
portal.labelTexture.needsUpdate = true;
}
function setPortalVisualIntensity(portal, intensity) {
const factor = Math.max(0.12, Math.min(1, intensity));
portal.group.traverse(obj => {
if (obj.isPointLight) {
if (obj.userData.baseIntensity == null) obj.userData.baseIntensity = obj.intensity;
obj.intensity = obj.userData.baseIntensity * factor;
return;
}
const materials = obj.material ? (Array.isArray(obj.material) ? obj.material : [obj.material]) : [];
materials.forEach(mat => {
if (mat.opacity != null) {
if (mat.userData.baseOpacity == null) mat.userData.baseOpacity = mat.opacity;
mat.opacity = mat.userData.baseOpacity * factor;
}
if (mat.emissiveIntensity != null) {
if (mat.userData.baseEmissiveIntensity == null) mat.userData.baseEmissiveIntensity = mat.emissiveIntensity;
mat.emissiveIntensity = mat.userData.baseEmissiveIntensity * factor;
}
if (mat.transparent != null && factor < 1) mat.transparent = true;
});
});
}
function setPortalRuntimeState(portal, runtimeState) {
portal.health = runtimeState;
portal.config.status = runtimeState.status;
portal.config.blocked_reason = runtimeState.blocked_reason;
portal.config.interaction_ready = runtimeState.interaction_ready;
if (portal.config.destination) {
portal.config.destination.action_label = runtimeState.actionLabel;
}
setPortalVisualIntensity(portal, runtimeState.online === false ? 0.2 : 1);
updatePortalLabelTexture(portal, runtimeState);
}
async function runPortalHealthChecks() {
if (!window.PortalHealth || portals.length === 0) return;
await Promise.all(portals.map(async (portal) => {
const probe = await window.PortalHealth.probePortalHealth(portal.config);
const runtimeState = window.PortalHealth.computePortalRuntimeState(portal.config, portal.baseState, probe);
setPortalRuntimeState(portal, runtimeState);
}));
if (atlasOverlayActive) populateAtlas();
if (activePortal) checkPortalProximity();
}
function startPortalHealthChecks() {
if (!window.PortalHealth || portalHealthTimer) return;
runPortalHealthChecks();
portalHealthTimer = setInterval(runPortalHealthChecks, window.PortalHealth.DEFAULT_HEALTH_INTERVAL_MS);
}
// ═══ PARTICLES ═══
function createParticles() {
const count = particleCount(1500);
@@ -3048,8 +3143,14 @@ function checkPortalProximity() {
activePortal = closest;
const hint = document.getElementById('portal-hint');
const hintLabel = document.getElementById('portal-hint-label');
if (activePortal) {
const runtimeState = activePortal.health || {
online: activePortal.config.status !== 'offline',
tooltipText: `Enter ${activePortal.config.name}`,
};
document.getElementById('portal-hint-name').textContent = activePortal.config.name;
if (hintLabel) hintLabel.textContent = runtimeState.online ? 'Enter' : 'Offline';
hint.style.display = 'flex';
} else {
hint.style.display = 'none';
@@ -3063,8 +3164,13 @@ function activatePortal(portal) {
const descDisplay = document.getElementById('portal-desc-display');
const redirectBox = document.getElementById('portal-redirect-box');
const errorBox = document.getElementById('portal-error-box');
const errorMsg = document.querySelector('#portal-error-box .portal-error-msg');
const timerDisplay = document.getElementById('portal-timer');
const statusDot = document.getElementById('portal-status-dot');
const runtimeState = portal.health || {
online: portal.config.status !== 'offline',
blocked_reason: portal.config.blocked_reason,
};
nameDisplay.textContent = portal.config.name.toUpperCase();
descDisplay.textContent = portal.config.description;
@@ -3073,6 +3179,13 @@ function activatePortal(portal) {
overlay.style.display = 'flex';
if (!runtimeState.online) {
redirectBox.style.display = 'none';
errorBox.style.display = 'block';
if (errorMsg) errorMsg.textContent = runtimeState.blocked_reason || 'OFFLINE';
return;
}
if (portal.config.destination && portal.config.destination.url) {
redirectBox.style.display = 'block';
errorBox.style.display = 'none';
@@ -3091,6 +3204,7 @@ function activatePortal(portal) {
} else {
redirectBox.style.display = 'none';
errorBox.style.display = 'block';
if (errorMsg) errorMsg.textContent = 'DESTINATION NOT YET LINKED';
}
}

View File

@@ -236,7 +236,7 @@
<!-- Portal Hint -->
<div id="portal-hint" class="portal-hint" style="display:none;">
<div class="portal-hint-key">F</div>
<div class="portal-hint-text">Enter <span id="portal-hint-name"></span></div>
<div class="portal-hint-text"><span id="portal-hint-label">Enter</span> <span id="portal-hint-name"></span></div>
</div>
<!-- Vision Hint -->
@@ -394,6 +394,7 @@
<div id="memory-inspect-panel" class="memory-inspect-panel" style="display:none;" aria-label="Memory Inspect Panel"></div>
<div id="memory-connections-panel" class="memory-connections-panel" style="display:none;" aria-label="Memory Connections Panel"></div>
<script src="./portal-health.js"></script>
<script src="./boot.js"></script>
<script src="./avatar-customization.js"></script>
<script src="./lod-system.js"></script>

135
portal-health.js Normal file
View File

@@ -0,0 +1,135 @@
(function (global) {
const DEFAULT_HEALTH_INTERVAL_MS = 5 * 60 * 1000;
const DEFAULT_TIMEOUT_MS = 3000;
function derivePortalHealthTarget(config = {}) {
if (typeof config.health_check_url === 'string' && config.health_check_url.trim()) {
return config.health_check_url.trim();
}
const destinationUrl = config?.destination?.url;
if (typeof destinationUrl === 'string' && destinationUrl.trim()) {
return destinationUrl.trim();
}
return null;
}
function shouldProbePortalHealth(config = {}) {
const target = derivePortalHealthTarget(config);
return typeof target === 'string' && /^https?:\/\//i.test(target);
}
function captureBaseState(config = {}) {
return {
status: config.status || 'online',
blocked_reason: config.blocked_reason ?? null,
interaction_ready: config.interaction_ready !== false,
action_label: config?.destination?.action_label || 'ENTER',
};
}
function computePortalRuntimeState(config = {}, baseState = captureBaseState(config), probe = {}) {
const tracked = shouldProbePortalHealth(config);
const portalName = config.name || 'Portal';
if (!tracked) {
return {
tracked: false,
online: true,
status: baseState.status,
blocked_reason: baseState.blocked_reason,
interaction_ready: baseState.interaction_ready,
actionLabel: baseState.action_label,
tooltipText: `Enter ${portalName}`,
};
}
const online = probe.online !== false;
if (!online) {
const reason = probe.reason || 'Offline';
return {
tracked: true,
online: false,
status: 'offline',
blocked_reason: reason,
interaction_ready: false,
actionLabel: 'OFFLINE',
tooltipText: 'Offline',
};
}
return {
tracked: true,
online: true,
status: baseState.status,
blocked_reason: baseState.blocked_reason,
interaction_ready: baseState.interaction_ready,
actionLabel: baseState.action_label,
tooltipText: `Enter ${portalName}`,
};
}
function describeProbeFailure(error) {
if (!error) return 'Offline';
if (error.name === 'AbortError') return 'Offline';
return error.message || 'Offline';
}
async function probePortalHealth(config = {}, { fetchImpl = global.fetch, timeoutMs = DEFAULT_TIMEOUT_MS } = {}) {
const target = derivePortalHealthTarget(config);
if (!shouldProbePortalHealth(config)) {
return { online: true, skipped: true, target };
}
if (typeof fetchImpl !== 'function') {
return { online: false, reason: 'Offline', target };
}
const controller = typeof AbortController !== 'undefined' ? new AbortController() : null;
const timeout = controller
? setTimeout(() => controller.abort(), timeoutMs)
: null;
try {
const response = await fetchImpl(target, {
method: 'HEAD',
mode: 'no-cors',
cache: 'no-store',
signal: controller ? controller.signal : undefined,
});
if (timeout) clearTimeout(timeout);
const online = !response || response.type === 'opaque' || response.ok || response.status < 500;
return {
online,
reason: online ? null : `Offline (${response.status || 'unreachable'})`,
target,
};
} catch (error) {
if (timeout) clearTimeout(timeout);
return {
online: false,
reason: describeProbeFailure(error),
target,
};
}
}
const api = {
DEFAULT_HEALTH_INTERVAL_MS,
DEFAULT_TIMEOUT_MS,
derivePortalHealthTarget,
shouldProbePortalHealth,
captureBaseState,
computePortalRuntimeState,
probePortalHealth,
};
if (typeof module !== 'undefined' && module.exports) {
module.exports = api;
}
global.PortalHealth = api;
})(typeof window !== 'undefined' ? window : globalThis);

View File

@@ -129,13 +129,22 @@
"type": "harness",
"params": {
"mode": "creative"
}
},
"action_label": "Enter Workshop"
},
"agents_present": [
"timmy",
"kimi"
],
"interaction_ready": true
"interaction_ready": true,
"portal_type": "creative-harness",
"world_category": "creative",
"environment": "production",
"access_mode": "visitor",
"readiness_state": "online",
"blocked_reason": null,
"telemetry_source": "workshop",
"owner": "Timmy"
},
{
"id": "archive",
@@ -157,12 +166,21 @@
"type": "harness",
"params": {
"mode": "read"
}
},
"action_label": "Enter Archive"
},
"agents_present": [
"claude"
],
"interaction_ready": true
"interaction_ready": true,
"portal_type": "knowledge-harness",
"world_category": "archive",
"environment": "production",
"access_mode": "visitor",
"readiness_state": "online",
"blocked_reason": null,
"telemetry_source": "archive",
"owner": "Timmy"
},
{
"id": "chapel",
@@ -184,10 +202,19 @@
"type": "harness",
"params": {
"mode": "meditation"
}
},
"action_label": "Enter Chapel"
},
"agents_present": [],
"interaction_ready": true
"interaction_ready": true,
"portal_type": "sanctuary-harness",
"world_category": "sanctuary",
"environment": "production",
"access_mode": "visitor",
"readiness_state": "online",
"blocked_reason": null,
"telemetry_source": "chapel",
"owner": "Timmy"
},
{
"id": "courtyard",
@@ -209,13 +236,22 @@
"type": "harness",
"params": {
"mode": "social"
}
},
"action_label": "Enter Courtyard"
},
"agents_present": [
"timmy",
"perplexity"
],
"interaction_ready": true
"interaction_ready": true,
"portal_type": "social-harness",
"world_category": "social",
"environment": "production",
"access_mode": "visitor",
"readiness_state": "online",
"blocked_reason": null,
"telemetry_source": "courtyard",
"owner": "Reflex"
},
{
"id": "gate",
@@ -237,10 +273,19 @@
"type": "harness",
"params": {
"mode": "transit"
}
},
"action_label": "Enter Gate"
},
"agents_present": [],
"interaction_ready": false
"interaction_ready": false,
"portal_type": "transit-harness",
"world_category": "transit",
"environment": "production",
"access_mode": "operator",
"readiness_state": "standby",
"blocked_reason": null,
"telemetry_source": "gate",
"owner": "Reflex"
},
{
"id": "playground",
@@ -292,4 +337,4 @@
"agents_present": [],
"interaction_ready": true
}
]
]

View File

@@ -0,0 +1,21 @@
const { test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const ROOT = path.resolve(__dirname, '..');
test('index bootstraps portal-health helper before app startup', () => {
const html = fs.readFileSync(path.join(ROOT, 'index.html'), 'utf8');
assert.match(html, /portal-health\.js/);
});
test('app wires recurring portal health checks and offline tooltip behavior', () => {
const source = fs.readFileSync(path.join(ROOT, 'app.js'), 'utf8');
assert.match(source, /startPortalHealthChecks\(/);
assert.match(source, /runPortalHealthChecks\(/);
assert.match(source, /PortalHealth\.DEFAULT_HEALTH_INTERVAL_MS/);
assert.match(source, /tooltipText/);
assert.match(source, /Offline/);
assert.match(source, /setPortalRuntimeState\(/);
});

View File

@@ -0,0 +1,69 @@
const { test } = require('node:test');
const assert = require('node:assert/strict');
const {
DEFAULT_HEALTH_INTERVAL_MS,
derivePortalHealthTarget,
shouldProbePortalHealth,
computePortalRuntimeState,
} = require('../portal-health.js');
test('portal health checks default to five minutes', () => {
assert.equal(DEFAULT_HEALTH_INTERVAL_MS, 5 * 60 * 1000);
});
test('portal health target prefers explicit health URL then destination URL', () => {
assert.equal(
derivePortalHealthTarget({
health_check_url: 'https://status.timmy.foundation/health',
destination: { url: 'https://portal.timmy.foundation' },
}),
'https://status.timmy.foundation/health'
);
assert.equal(
derivePortalHealthTarget({ destination: { url: 'https://portal.timmy.foundation' } }),
'https://portal.timmy.foundation'
);
assert.equal(
derivePortalHealthTarget({ destination: { url: null } }),
null
);
});
test('portal health probe eligibility only tracks portals with external URLs', () => {
assert.equal(shouldProbePortalHealth({ destination: { url: 'https://portal.timmy.foundation' } }), true);
assert.equal(shouldProbePortalHealth({ destination: { url: './local.html' } }), false);
assert.equal(shouldProbePortalHealth({ destination: { url: null } }), false);
});
test('runtime state marks offline portals unavailable and restores base state when healthy', () => {
const config = {
name: 'Workshop',
status: 'online',
blocked_reason: null,
interaction_ready: true,
destination: { url: 'https://workshop.timmy.foundation', action_label: 'Enter Workshop' },
};
const baseState = {
status: 'online',
blocked_reason: null,
interaction_ready: true,
action_label: 'Enter Workshop',
};
const offline = computePortalRuntimeState(config, baseState, { online: false, reason: 'Offline' });
assert.equal(offline.status, 'offline');
assert.equal(offline.interaction_ready, false);
assert.equal(offline.blocked_reason, 'Offline');
assert.equal(offline.tooltipText, 'Offline');
assert.equal(offline.actionLabel, 'OFFLINE');
const restored = computePortalRuntimeState(config, baseState, { online: true });
assert.equal(restored.status, 'online');
assert.equal(restored.interaction_ready, true);
assert.equal(restored.blocked_reason, null);
assert.equal(restored.tooltipText, 'Enter Workshop');
assert.equal(restored.actionLabel, 'Enter Workshop');
});