1 Commits

Author SHA1 Message Date
f1e192c5d4 Merge pull request 'v1.2.0' (#10) from dev into main
Some checks failed
CI / test (push) Successful in 13s
Release / release (push) Failing after 5m14s
CI / build-dev (push) Has been skipped
Reviewed-on: #10
2026-03-28 13:24:34 -04:00
12 changed files with 107 additions and 592 deletions

View File

@@ -20,6 +20,7 @@ jobs:
- uses: actions/setup-node@v4 - uses: actions/setup-node@v4
with: with:
node-version: 'lts/*' node-version: 'lts/*'
cache: npm
- run: npm ci - run: npm ci
- run: npm test - run: npm test
@@ -47,10 +48,12 @@ jobs:
run: | run: |
LAST_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "") LAST_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
if [ -n "$LAST_TAG" ]; then if [ -n "$LAST_TAG" ]; then
git log "${LAST_TAG}..HEAD" --pretty=format:"- %s" --no-merges > /tmp/release_notes.txt NOTES=$(git log "${LAST_TAG}..HEAD" --pretty=format:"- %s" --no-merges)
else else
git log --pretty=format:"- %s" --no-merges > /tmp/release_notes.txt NOTES=$(git log --pretty=format:"- %s" --no-merges)
fi fi
NOTES_JSON=$(printf '%s' "$NOTES" | python3 -c "import sys,json; print(json.dumps(sys.stdin.read()))")
echo "NOTES=${NOTES_JSON}" >> $GITEA_ENV
- name: Docker metadata - name: Docker metadata
id: meta id: meta
@@ -79,9 +82,14 @@ jobs:
- name: Create Gitea release - name: Create Gitea release
run: | run: |
python3 -c "import json,os; v=os.environ['VERSION']; img=os.environ['IMAGE']; notes=open('/tmp/release_notes.txt').read(); open('/tmp/release_body.json','w').write(json.dumps({'tag_name':'v'+v,'name':'Catalyst v'+v,'body':'### Changes\n\n'+notes+'\n\n### Image\n\n'+img+':'+v,'draft':False,'prerelease':False}))"
curl -sf -X POST \ curl -sf -X POST \
-H "Authorization: token ${{ secrets.TOKEN }}" \ -H "Authorization: token ${{ secrets.TOKEN }}" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
"${{ gitea.server_url }}/api/v1/repos/${{ gitea.repository }}/releases" \ "${{ gitea.server_url }}/api/v1/repos/${{ gitea.repository }}/releases" \
--data @/tmp/release_body.json -d "{
\"tag_name\": \"v${{ env.VERSION }}\",
\"name\": \"Catalyst v${{ env.VERSION }}\",
\"body\": \"### Changes\n\n${{ env.NOTES }}\n\n### Image\n\n\`${{ env.IMAGE }}:${{ env.VERSION }}\`\",
\"draft\": false,
\"prerelease\": false
}"

187
README.md
View File

@@ -1,38 +1,39 @@
# Catalyst # Catalyst
A self-hosted infrastructure registry for homelab Proxmox environments. Track virtual machines across stacks, monitor service health, and maintain a full audit log of every configuration change. A self-hosted infrastructure registry. Track every VM, container, and service across your homelab — their state, stack, and which internal services are running on them.
--- ---
## Features ## Features
- **Dashboard** — filterable, searchable instance list with state and stack badges - **Dashboard** — filterable, searchable instance list with state and stack badges
- **Detail pages** — per-instance view with service flags, Tailscale IP, and a full change timeline - **Detail pages** — per-instance view with service flags, Tailscale IP, and timestamps
- **Audit log** — every field change is recorded with before/after values and a timestamp
- **Full CRUD** — add, edit, and delete instances via a clean modal interface - **Full CRUD** — add, edit, and delete instances via a clean modal interface
- **Production safeguard** — only development instances can be deleted; production instances must be demoted first - **Production safeguard** — only development instances can be deleted; production instances must be demoted first
- **Export / import** — JSON backup and restore via the settings modal - **REST API** — every operation is a plain HTTP call; no magic, no framework lock-in
- **REST API** — every operation is a plain HTTP call - **Persistent storage** — SQLite database on a Docker named volume; survives restarts and upgrades
- **Persistent storage** — SQLite on a Docker named volume; survives restarts and upgrades - **Zero native dependencies** — SQLite via Node's built-in `node:sqlite`. No compilation, no binaries.
- **Zero native dependencies** — SQLite via Node's built-in `node:sqlite`; no compilation, no binaries
--- ---
## Quick start ## Quick start
```bash
docker run -d \
--name catalyst \
-p 3000:3000 \
-v catalyst-data:/app/data \
gitea.thewrightserver.net/josh/catalyst:latest
```
Or with the included Compose file:
```bash ```bash
docker compose up -d docker compose up -d
``` ```
Open [http://localhost:3000](http://localhost:3000). Open [http://localhost:3000](http://localhost:3000).
### Environment variables
| Variable | Default | Description |
|---|---|---|
| `PORT` | `3000` | HTTP port the server binds to |
| `DB_PATH` | `data/catalyst.db` | Path to the SQLite database file |
--- ---
## REST API ## REST API
@@ -43,13 +44,13 @@ All endpoints are under `/api`. Request and response bodies are JSON.
#### `GET /api/instances` #### `GET /api/instances`
Returns all instances sorted by name. All query parameters are optional. Returns all instances, sorted by name. All query parameters are optional.
| Parameter | Type | Description | | Parameter | Type | Description |
|---|---|---| |-----------|--------|-----------------------------------------|
| `search` | string | Partial match on `name`, `vmid`, or `stack` | | `search` | string | Partial match on `name` or `vmid` |
| `state` | string | Exact match: `deployed`, `testing`, `degraded` | | `state` | string | Exact match: `deployed`, `testing`, `degraded` |
| `stack` | string | Exact match: `production`, `development` | | `stack` | string | Exact match: `production`, `development` |
``` ```
GET /api/instances?search=plex&state=deployed GET /api/instances?search=plex&state=deployed
@@ -63,11 +64,11 @@ GET /api/instances?search=plex&state=deployed
"state": "deployed", "state": "deployed",
"stack": "production", "stack": "production",
"tailscale_ip": "100.64.0.1", "tailscale_ip": "100.64.0.1",
"atlas": 1, "argus": 1, "semaphore": 0, "atlas": 1, "argus": 0, "semaphore": 0,
"patchmon": 1, "tailscale": 1, "andromeda": 0, "patchmon": 1, "tailscale": 1, "andromeda": 0,
"hardware_acceleration": 1, "hardware_acceleration": 1,
"created_at": "2024-01-15T10:30:00", "created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-03-10T14:22:00" "updated_at": "2024-03-10T14:22:00.000Z"
} }
] ]
``` ```
@@ -90,43 +91,10 @@ GET /api/instances/stacks
Returns a single instance by VMID. Returns a single instance by VMID.
| Status | Condition | | Status | Condition |
|---|---| |--------|-----------|
| `200` | Instance found | | `200` | Instance found |
| `400` | VMID is not a valid integer | | `404` | No instance with that VMID |
| `404` | No instance with that VMID | | `400` | VMID is not a valid integer |
---
#### `GET /api/instances/:vmid/history`
Returns the audit log for an instance — newest events first.
| Status | Condition |
|---|---|
| `200` | History returned (may be empty array) |
| `400` | VMID is not a valid integer |
| `404` | No instance with that VMID |
```json
[
{
"id": 3,
"vmid": 117,
"field": "state",
"old_value": "testing",
"new_value": "deployed",
"changed_at": "2024-03-10T14:22:00"
},
{
"id": 1,
"vmid": 117,
"field": "created",
"old_value": null,
"new_value": null,
"changed_at": "2024-01-15T10:30:00"
}
]
```
--- ---
@@ -135,21 +103,21 @@ Returns the audit log for an instance — newest events first.
Creates a new instance. Returns the created record. Creates a new instance. Returns the created record.
| Status | Condition | | Status | Condition |
|---|---| |--------|-----------|
| `201` | Created successfully | | `201` | Created successfully |
| `400` | Validation error see `errors` array in response | | `400` | Validation error (see `errors` array in response) |
| `409` | VMID already exists | | `409` | VMID already exists |
**Request body:** **Request body:**
| Field | Type | Required | Notes | | Field | Type | Required | Notes |
|---|---|---|---| |-------|------|----------|-------|
| `name` | string | yes | | | `name` | string | yes | |
| `vmid` | integer | yes | Must be > 0 and unique | | `vmid` | integer | yes | Must be > 0, unique |
| `state` | string | yes | `deployed`, `testing`, or `degraded` | | `state` | string | yes | `deployed`, `testing`, or `degraded` |
| `stack` | string | yes | `production` or `development` | | `stack` | string | yes | `production` or `development` |
| `tailscale_ip` | string | no | Valid IPv4 or empty string | | `tailscale_ip` | string | no | Defaults to `""` |
| `atlas` | 0\|1 | no | | | `atlas` | 0\|1 | no | Defaults to `0` |
| `argus` | 0\|1 | no | | | `argus` | 0\|1 | no | |
| `semaphore` | 0\|1 | no | | | `semaphore` | 0\|1 | no | |
| `patchmon` | 0\|1 | no | | | `patchmon` | 0\|1 | no | |
@@ -164,11 +132,11 @@ Creates a new instance. Returns the created record.
Replaces all fields on an existing instance. Accepts the same body shape as `POST`. The `vmid` in the body may differ from the URL — this is how you change a VMID. Replaces all fields on an existing instance. Accepts the same body shape as `POST`. The `vmid` in the body may differ from the URL — this is how you change a VMID.
| Status | Condition | | Status | Condition |
|---|---| |--------|-----------|
| `200` | Updated successfully | | `200` | Updated successfully |
| `400` | Validation error | | `400` | Validation error |
| `404` | No instance with that VMID | | `404` | No instance with that VMID |
| `409` | New VMID conflicts with an existing instance | | `409` | New VMID conflicts with an existing instance |
--- ---
@@ -177,36 +145,11 @@ Replaces all fields on an existing instance. Accepts the same body shape as `POS
Deletes an instance. Only instances on the `development` stack may be deleted. Deletes an instance. Only instances on the `development` stack may be deleted.
| Status | Condition | | Status | Condition |
|---|---| |--------|-----------|
| `204` | Deleted successfully | | `204` | Deleted successfully |
| `400` | VMID is not a valid integer | | `404` | No instance with that VMID |
| `404` | No instance with that VMID | | `422` | Instance is on the `production` stack |
| `422` | Instance is on the `production` stack | | `400` | VMID is not a valid integer |
---
### Backup
#### `GET /api/export`
Downloads a JSON backup of all instances as a file attachment.
```json
{
"version": 1,
"exported_at": "2024-03-10T14:22:00.000Z",
"instances": [ ... ]
}
```
#### `POST /api/import`
Replaces all instances from a JSON backup. Validates every row before committing — if any row is invalid the entire import is rejected.
| Status | Condition |
|---|---|
| `200` | Import successful — returns `{ "imported": N }` |
| `400` | Body missing `instances` array, or validation errors |
--- ---
@@ -214,30 +157,42 @@ Replaces all instances from a JSON backup. Validates every row before committing
```bash ```bash
npm install npm install
npm test # run all tests once npm test # run all tests once
npm run test:watch # watch mode npm run test:watch # watch mode
npm start # start the server on :3000 npm start # start the server on :3000
``` ```
Tests are split across three files: Tests are split across three files:
| File | What it covers | | File | What it covers |
|---|---| |------|----------------|
| `tests/db.test.js` | SQLite data layer — CRUD, constraints, filters, history logging | | `tests/db.test.js` | SQLite data layer — all CRUD operations, constraints, filters |
| `tests/api.test.js` | HTTP API — all endpoints, status codes, error cases | | `tests/api.test.js` | HTTP API — all endpoints, status codes, error cases |
| `tests/helpers.test.js` | UI helpers — `esc()` XSS contract, date formatting, history formatters | | `tests/helpers.test.js` | UI helper functions — `esc()` XSS contract, `fmtDate()` |
--- ---
## Versioning ## Versioning
Catalyst uses [semantic versioning](https://semver.org). `package.json` is the single source of truth. Catalyst uses [semantic versioning](https://semver.org). `package.json` is the single source of truth for the version number.
| Change | Bump | | Change | Bump | Example |
|---|---| |--------|------|---------|
| Bug fix | patch | | Bug fix | patch | `1.0.0``1.0.1` |
| New feature, backward compatible | minor | | New feature, backward compatible | minor | `1.0.0``1.1.0` |
| Breaking change | major | | Breaking change | major | `1.0.0``2.0.0` |
Pushing a tag triggers the CI pipeline: **test → build → release**. ### Cutting a release
Docker images are tagged `:x.y.z`, `:x.y`, and `:latest`.
```bash
# 1. Bump version in package.json, then:
git add package.json
git commit -m "chore: release v1.1.0"
git tag v1.1.0
git push && git push --tags
```
Pushing a tag triggers the full CI pipeline: **test → build → release**.
- Docker image tagged `:1.1.0`, `:1.1`, and `:latest` in the Gitea registry
- A Gitea release is created at `v1.1.0`

View File

@@ -70,19 +70,6 @@ nav {
.nav-sep { flex: 1; } .nav-sep { flex: 1; }
.nav-btn {
background: none;
border: 1px solid var(--border2);
color: var(--text2);
border-radius: 6px;
padding: 4px 8px;
font-size: 14px;
cursor: pointer;
margin-left: 10px;
line-height: 1;
}
.nav-btn:hover { border-color: var(--accent); color: var(--accent); }
.nav-divider { color: var(--border2); } .nav-divider { color: var(--border2); }
.nav-status { .nav-status {
@@ -628,56 +615,6 @@ select:focus { border-color: var(--accent); }
.confirm-actions { display: flex; justify-content: flex-end; gap: 10px; } .confirm-actions { display: flex; justify-content: flex-end; gap: 10px; }
/* ── HISTORY TIMELINE ── */
.tl-item {
display: grid;
grid-template-columns: 160px 140px 1fr;
gap: 0 12px;
padding: 7px 0;
border-bottom: 1px solid var(--border);
font-size: 12px;
align-items: baseline;
}
.tl-item:last-child { border-bottom: none; }
.tl-time { color: var(--text3); font-size: 11px; white-space: nowrap; }
.tl-field { color: var(--text2); }
.tl-change { display: flex; align-items: baseline; gap: 6px; }
.tl-old { color: var(--text3); text-decoration: line-through; }
.tl-arrow { color: var(--text3); }
.tl-new { color: var(--text); }
.tl-deployed { color: var(--accent); }
.tl-testing { color: var(--amber); }
.tl-degraded { color: var(--red); }
.tl-created .tl-field { color: var(--accent); }
.tl-created .tl-change { color: var(--text3); }
.tl-empty { color: var(--text3); font-size: 12px; padding: 8px 0; }
/* ── SETTINGS MODAL ── */
#settings-modal .modal-body { padding-top: 0; }
.settings-section { padding: 16px 0; border-bottom: 1px solid var(--border); }
.settings-section:last-child { border-bottom: none; padding-bottom: 0; }
.settings-section-title {
font-size: 10px;
font-weight: 600;
text-transform: uppercase;
letter-spacing: 0.1em;
color: var(--text3);
margin-bottom: 8px;
}
.settings-desc { font-size: 12px; color: var(--text2); margin: 0 0 14px; line-height: 1.6; }
.import-row { display: flex; gap: 10px; align-items: center; }
.import-file-input { flex: 1; }
.btn-secondary {
background: var(--bg3);
border-color: var(--border2);
color: var(--text);
}
.btn-secondary:hover { border-color: var(--accent); color: var(--accent); }
.btn-danger { background: var(--red2); border-color: var(--red); color: var(--text); }
.btn-danger:hover { background: var(--red); }
/* ── SCROLLBAR ── */ /* ── SCROLLBAR ── */
::-webkit-scrollbar { width: 6px; } ::-webkit-scrollbar { width: 6px; }
::-webkit-scrollbar-track { background: var(--bg); } ::-webkit-scrollbar-track { background: var(--bg); }

View File

@@ -22,7 +22,6 @@
<span class="nav-divider">·</span> <span class="nav-divider">·</span>
<span id="nav-version"></span> <span id="nav-version"></span>
</div> </div>
<button class="nav-btn" onclick="openSettingsModal()" title="Settings">&#9881;</button>
</nav> </nav>
<main> <main>
@@ -92,7 +91,7 @@
<div class="services-grid" id="detail-services"></div> <div class="services-grid" id="detail-services"></div>
</div> </div>
<div class="detail-section full"> <div class="detail-section full">
<div class="section-title">history</div> <div class="section-title">timestamps</div>
<div id="detail-timestamps"></div> <div id="detail-timestamps"></div>
</div> </div>
</div> </div>
@@ -172,31 +171,6 @@
</div> </div>
</div> </div>
<!-- SETTINGS MODAL -->
<div id="settings-modal" class="modal-overlay">
<div class="modal">
<div class="modal-header">
<span class="modal-title">Settings</span>
<button class="modal-close" onclick="closeSettingsModal()">&#x2715;</button>
</div>
<div class="modal-body">
<div class="settings-section">
<div class="settings-section-title">Export</div>
<p class="settings-desc">Download all instance data as a JSON backup file.</p>
<button class="btn btn-secondary" onclick="exportDB()">Export Database</button>
</div>
<div class="settings-section">
<div class="settings-section-title">Import</div>
<p class="settings-desc">Restore from a backup file. This replaces all current instances.</p>
<div class="import-row">
<input type="file" id="import-file" accept=".json" class="form-input import-file-input">
<button class="btn btn-danger" onclick="importDB()">Import</button>
</div>
</div>
</div>
</div>
</div>
<!-- TOAST --> <!-- TOAST -->
<div class="toast" id="toast"> <div class="toast" id="toast">
<div class="toast-dot"></div> <div class="toast-dot"></div>

View File

@@ -55,8 +55,3 @@ async function updateInstance(vmid, data) {
async function deleteInstance(vmid) { async function deleteInstance(vmid) {
await api(`/instances/${vmid}`, { method: 'DELETE' }); await api(`/instances/${vmid}`, { method: 'DELETE' });
} }
async function getInstanceHistory(vmid) {
const res = await fetch(`${BASE}/instances/${vmid}/history`);
return res.json();
}

View File

@@ -39,6 +39,7 @@ async function renderDashboard() {
<div class="stat-cell"><div class="stat-label">deployed</div><div class="stat-value">${states['deployed'] || 0}</div></div> <div class="stat-cell"><div class="stat-label">deployed</div><div class="stat-value">${states['deployed'] || 0}</div></div>
<div class="stat-cell"><div class="stat-label">testing</div><div class="stat-value amber">${states['testing'] || 0}</div></div> <div class="stat-cell"><div class="stat-label">testing</div><div class="stat-value amber">${states['testing'] || 0}</div></div>
<div class="stat-cell"><div class="stat-label">degraded</div><div class="stat-value red">${states['degraded'] || 0}</div></div> <div class="stat-cell"><div class="stat-label">degraded</div><div class="stat-value red">${states['degraded'] || 0}</div></div>
<div class="stat-cell"><div class="stat-label">stacks</div><div class="stat-value">${(await getDistinctStacks()).length}</div></div>
`; `;
await populateStackFilter(); await populateStackFilter();
@@ -99,21 +100,8 @@ async function filterInstances() {
// ── Detail Page ─────────────────────────────────────────────────────────────── // ── Detail Page ───────────────────────────────────────────────────────────────
const BOOL_FIELDS = ['atlas','argus','semaphore','patchmon','tailscale','andromeda','hardware_acceleration'];
function stateClass(field, val) {
if (field !== 'state') return '';
return { deployed: 'tl-deployed', testing: 'tl-testing', degraded: 'tl-degraded' }[val] ?? '';
}
function fmtHistVal(field, val) {
if (val == null || val === '') return '—';
if (BOOL_FIELDS.includes(field)) return val === '1' ? 'on' : 'off';
return esc(val);
}
async function renderDetailPage(vmid) { async function renderDetailPage(vmid) {
const [inst, history] = await Promise.all([getInstance(vmid), getInstanceHistory(vmid)]); const inst = await getInstance(vmid);
if (!inst) { navigate('dashboard'); return; } if (!inst) { navigate('dashboard'); return; }
currentVmid = vmid; currentVmid = vmid;
@@ -146,26 +134,10 @@ async function renderDetailPage(vmid) {
</div> </div>
`).join(''); `).join('');
document.getElementById('detail-timestamps').innerHTML = history.length document.getElementById('detail-timestamps').innerHTML = `
? history.map(e => { <div class="kv-row"><span class="kv-key">created</span><span class="kv-val">${fmtDateFull(inst.created_at)}</span></div>
if (e.field === 'created') return ` <div class="kv-row"><span class="kv-key">updated</span><span class="kv-val">${fmtDateFull(inst.updated_at)}</span></div>
<div class="tl-item tl-created"> `;
<span class="tl-time">${fmtDateFull(e.changed_at)}</span>
<span class="tl-field">created</span>
<span class="tl-change">—</span>
</div>`;
return `
<div class="tl-item">
<span class="tl-time">${fmtDateFull(e.changed_at)}</span>
<span class="tl-field">${esc(e.field)}</span>
<span class="tl-change">
<span class="tl-old">${fmtHistVal(e.field, e.old_value)}</span>
<span class="tl-arrow">→</span>
<span class="tl-new ${stateClass(e.field, e.new_value)}">${fmtHistVal(e.field, e.new_value)}</span>
</span>
</div>`;
}).join('')
: '<div class="tl-empty">no history yet</div>';
document.getElementById('detail-edit-btn').onclick = () => openEditModal(inst.vmid); document.getElementById('detail-edit-btn').onclick = () => openEditModal(inst.vmid);
document.getElementById('detail-delete-btn').onclick = () => confirmDeleteDialog(inst); document.getElementById('detail-delete-btn').onclick = () => confirmDeleteDialog(inst);
@@ -286,62 +258,12 @@ function showToast(msg, type = 'success') {
toastTimer = setTimeout(() => t.classList.remove('show'), 3000); toastTimer = setTimeout(() => t.classList.remove('show'), 3000);
} }
// ── Settings Modal ────────────────────────────────────────────────────────────
function openSettingsModal() {
document.getElementById('settings-modal').classList.add('open');
}
function closeSettingsModal() {
document.getElementById('settings-modal').classList.remove('open');
document.getElementById('import-file').value = '';
}
async function exportDB() {
const res = await fetch('/api/export');
const blob = await res.blob();
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = `catalyst-backup-${new Date().toISOString().slice(0, 10)}.json`;
a.click();
URL.revokeObjectURL(url);
}
async function importDB() {
const file = document.getElementById('import-file').files[0];
if (!file) { showToast('Select a backup file first', 'error'); return; }
document.getElementById('confirm-title').textContent = 'Replace all instances?';
document.getElementById('confirm-msg').textContent =
`This will delete all current instances and replace them with the contents of "${file.name}". This cannot be undone.`;
document.getElementById('confirm-overlay').classList.add('open');
document.getElementById('confirm-ok').onclick = async () => {
closeConfirm();
try {
const { instances } = JSON.parse(await file.text());
const res = await fetch('/api/import', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ instances }),
});
const data = await res.json();
if (!res.ok) { showToast(data.error ?? 'Import failed', 'error'); return; }
showToast(`Imported ${data.imported} instance${data.imported !== 1 ? 's' : ''}`, 'success');
closeSettingsModal();
renderDashboard();
} catch {
showToast('Invalid backup file', 'error');
}
};
}
// ── Keyboard / backdrop ─────────────────────────────────────────────────────── // ── Keyboard / backdrop ───────────────────────────────────────────────────────
document.addEventListener('keydown', e => { document.addEventListener('keydown', e => {
if (e.key !== 'Escape') return; if (e.key !== 'Escape') return;
if (document.getElementById('instance-modal').classList.contains('open')) { closeModal(); return; } if (document.getElementById('instance-modal').classList.contains('open')) { closeModal(); return; }
if (document.getElementById('confirm-overlay').classList.contains('open')) { closeConfirm(); return; } if (document.getElementById('confirm-overlay').classList.contains('open')) { closeConfirm(); return; }
if (document.getElementById('settings-modal').classList.contains('open')) { closeSettingsModal(); return; }
}); });
document.getElementById('instance-modal').addEventListener('click', e => { document.getElementById('instance-modal').addEventListener('click', e => {
@@ -350,6 +272,3 @@ document.getElementById('instance-modal').addEventListener('click', e => {
document.getElementById('confirm-overlay').addEventListener('click', e => { document.getElementById('confirm-overlay').addEventListener('click', e => {
if (e.target === document.getElementById('confirm-overlay')) closeConfirm(); if (e.target === document.getElementById('confirm-overlay')) closeConfirm();
}); });
document.getElementById('settings-modal').addEventListener('click', e => {
if (e.target === document.getElementById('settings-modal')) closeSettingsModal();
});

View File

@@ -1,6 +1,6 @@
{ {
"name": "catalyst", "name": "catalyst",
"version": "1.2.2", "version": "1.2.0",
"type": "module", "type": "module",
"scripts": { "scripts": {
"start": "node server/server.js", "start": "node server/server.js",

View File

@@ -43,16 +43,6 @@ function createSchema() {
); );
CREATE INDEX IF NOT EXISTS idx_instances_state ON instances(state); CREATE INDEX IF NOT EXISTS idx_instances_state ON instances(state);
CREATE INDEX IF NOT EXISTS idx_instances_stack ON instances(stack); CREATE INDEX IF NOT EXISTS idx_instances_stack ON instances(stack);
CREATE TABLE IF NOT EXISTS instance_history (
id INTEGER PRIMARY KEY AUTOINCREMENT,
vmid INTEGER NOT NULL,
field TEXT NOT NULL,
old_value TEXT,
new_value TEXT,
changed_at TEXT NOT NULL DEFAULT (datetime('now'))
);
CREATE INDEX IF NOT EXISTS idx_history_vmid ON instance_history(vmid);
`); `);
} }
@@ -109,14 +99,8 @@ export function getDistinctStacks() {
// ── Mutations ───────────────────────────────────────────────────────────────── // ── Mutations ─────────────────────────────────────────────────────────────────
const HISTORY_FIELDS = [
'name', 'state', 'stack', 'vmid', 'tailscale_ip',
'atlas', 'argus', 'semaphore', 'patchmon', 'tailscale', 'andromeda',
'hardware_acceleration',
];
export function createInstance(data) { export function createInstance(data) {
db.prepare(` return db.prepare(`
INSERT INTO instances INSERT INTO instances
(name, state, stack, vmid, atlas, argus, semaphore, patchmon, (name, state, stack, vmid, atlas, argus, semaphore, patchmon,
tailscale, andromeda, tailscale_ip, hardware_acceleration) tailscale, andromeda, tailscale_ip, hardware_acceleration)
@@ -124,14 +108,10 @@ export function createInstance(data) {
(@name, @state, @stack, @vmid, @atlas, @argus, @semaphore, @patchmon, (@name, @state, @stack, @vmid, @atlas, @argus, @semaphore, @patchmon,
@tailscale, @andromeda, @tailscale_ip, @hardware_acceleration) @tailscale, @andromeda, @tailscale_ip, @hardware_acceleration)
`).run(data); `).run(data);
db.prepare(
`INSERT INTO instance_history (vmid, field, old_value, new_value) VALUES (?, 'created', NULL, NULL)`
).run(data.vmid);
} }
export function updateInstance(vmid, data) { export function updateInstance(vmid, data) {
const old = getInstance(vmid); return db.prepare(`
db.prepare(`
UPDATE instances SET UPDATE instances SET
name=@name, state=@state, stack=@stack, vmid=@newVmid, name=@name, state=@state, stack=@stack, vmid=@newVmid,
atlas=@atlas, argus=@argus, semaphore=@semaphore, patchmon=@patchmon, atlas=@atlas, argus=@argus, semaphore=@semaphore, patchmon=@patchmon,
@@ -139,42 +119,12 @@ export function updateInstance(vmid, data) {
hardware_acceleration=@hardware_acceleration, updated_at=datetime('now') hardware_acceleration=@hardware_acceleration, updated_at=datetime('now')
WHERE vmid=@vmid WHERE vmid=@vmid
`).run({ ...data, newVmid: data.vmid, vmid }); `).run({ ...data, newVmid: data.vmid, vmid });
const newVmid = data.vmid;
const insertEvt = db.prepare(
`INSERT INTO instance_history (vmid, field, old_value, new_value) VALUES (?, ?, ?, ?)`
);
for (const field of HISTORY_FIELDS) {
const oldVal = String(old[field] ?? '');
const newVal = String(field === 'vmid' ? newVmid : (data[field] ?? ''));
if (oldVal !== newVal) insertEvt.run(newVmid, field, oldVal, newVal);
}
} }
export function deleteInstance(vmid) { export function deleteInstance(vmid) {
return db.prepare('DELETE FROM instances WHERE vmid = ?').run(vmid); return db.prepare('DELETE FROM instances WHERE vmid = ?').run(vmid);
} }
export function importInstances(rows) {
db.exec('BEGIN');
db.exec('DELETE FROM instances');
const insert = db.prepare(`
INSERT INTO instances
(name, state, stack, vmid, atlas, argus, semaphore, patchmon,
tailscale, andromeda, tailscale_ip, hardware_acceleration)
VALUES
(@name, @state, @stack, @vmid, @atlas, @argus, @semaphore, @patchmon,
@tailscale, @andromeda, @tailscale_ip, @hardware_acceleration)
`);
for (const row of rows) insert.run(row);
db.exec('COMMIT');
}
export function getInstanceHistory(vmid) {
return db.prepare(
'SELECT * FROM instance_history WHERE vmid = ? ORDER BY changed_at DESC'
).all(vmid);
}
// ── Test helpers ────────────────────────────────────────────────────────────── // ── Test helpers ──────────────────────────────────────────────────────────────
export function _resetForTest() { export function _resetForTest() {

View File

@@ -1,7 +1,7 @@
import { Router } from 'express'; import { Router } from 'express';
import { import {
getInstances, getInstance, getDistinctStacks, getInstances, getInstance, getDistinctStacks,
createInstance, updateInstance, deleteInstance, importInstances, getInstanceHistory, createInstance, updateInstance, deleteInstance,
} from './db.js'; } from './db.js';
export const router = Router(); export const router = Router();
@@ -28,16 +28,9 @@ function validate(body) {
return errors; return errors;
} }
function handleDbError(context, e, res) {
if (e.message.includes('UNIQUE')) return res.status(409).json({ error: 'vmid already exists' });
if (e.message.includes('CHECK')) return res.status(400).json({ error: 'invalid field value' });
console.error(context, e);
res.status(500).json({ error: 'internal server error' });
}
function normalise(body) { function normalise(body) {
const row = { const row = {
name: (body.name ?? '').trim(), name: body.name.trim(),
state: body.state, state: body.state,
stack: body.stack, stack: body.stack,
vmid: body.vmid, vmid: body.vmid,
@@ -61,14 +54,6 @@ router.get('/instances', (req, res) => {
res.json(getInstances({ search, state, stack })); res.json(getInstances({ search, state, stack }));
}); });
// GET /api/instances/:vmid/history
router.get('/instances/:vmid/history', (req, res) => {
const vmid = parseInt(req.params.vmid, 10);
if (!vmid) return res.status(400).json({ error: 'invalid vmid' });
if (!getInstance(vmid)) return res.status(404).json({ error: 'instance not found' });
res.json(getInstanceHistory(vmid));
});
// GET /api/instances/:vmid // GET /api/instances/:vmid
router.get('/instances/:vmid', (req, res) => { router.get('/instances/:vmid', (req, res) => {
const vmid = parseInt(req.params.vmid, 10); const vmid = parseInt(req.params.vmid, 10);
@@ -91,7 +76,10 @@ router.post('/instances', (req, res) => {
const created = getInstance(data.vmid); const created = getInstance(data.vmid);
res.status(201).json(created); res.status(201).json(created);
} catch (e) { } catch (e) {
handleDbError('POST /api/instances', e, res); if (e.message.includes('UNIQUE')) return res.status(409).json({ error: 'vmid already exists' });
if (e.message.includes('CHECK')) return res.status(400).json({ error: 'invalid field value' });
console.error('POST /api/instances', e);
res.status(500).json({ error: 'internal server error' });
} }
}); });
@@ -109,35 +97,9 @@ router.put('/instances/:vmid', (req, res) => {
updateInstance(vmid, data); updateInstance(vmid, data);
res.json(getInstance(data.vmid)); res.json(getInstance(data.vmid));
} catch (e) { } catch (e) {
handleDbError('PUT /api/instances/:vmid', e, res); if (e.message.includes('UNIQUE')) return res.status(409).json({ error: 'vmid already exists' });
} if (e.message.includes('CHECK')) return res.status(400).json({ error: 'invalid field value' });
}); console.error('PUT /api/instances/:vmid', e);
// GET /api/export
router.get('/export', (_req, res) => {
const instances = getInstances();
const date = new Date().toISOString().slice(0, 10);
res.setHeader('Content-Disposition', `attachment; filename="catalyst-backup-${date}.json"`);
res.json({ version: 1, exported_at: new Date().toISOString(), instances });
});
// POST /api/import
router.post('/import', (req, res) => {
const { instances } = req.body ?? {};
if (!Array.isArray(instances)) {
return res.status(400).json({ error: 'body must contain an instances array' });
}
const errors = [];
for (const [i, row] of instances.entries()) {
const errs = validate(normalise(row));
if (errs.length) errors.push({ index: i, errors: errs });
}
if (errors.length) return res.status(400).json({ errors });
try {
importInstances(instances.map(normalise));
res.json({ imported: instances.length });
} catch (e) {
console.error('POST /api/import', e);
res.status(500).json({ error: 'internal server error' }); res.status(500).json({ error: 'internal server error' });
} }
}); });
@@ -156,6 +118,7 @@ router.delete('/instances/:vmid', (req, res) => {
deleteInstance(vmid); deleteInstance(vmid);
res.status(204).end(); res.status(204).end();
} catch (e) { } catch (e) {
handleDbError('DELETE /api/instances/:vmid', e, res); console.error('DELETE /api/instances/:vmid', e);
res.status(500).json({ error: 'internal server error' });
} }
}); });

View File

@@ -239,78 +239,6 @@ describe('DELETE /api/instances/:vmid', () => {
}) })
}) })
// ── GET /api/instances/:vmid/history ─────────────────────────────────────────
describe('GET /api/instances/:vmid/history', () => {
it('returns history events for a known vmid', async () => {
await request(app).post('/api/instances').send(base)
const res = await request(app).get('/api/instances/100/history')
expect(res.status).toBe(200)
expect(res.body).toBeInstanceOf(Array)
expect(res.body[0].field).toBe('created')
})
it('returns 404 for unknown vmid', async () => {
expect((await request(app).get('/api/instances/999/history')).status).toBe(404)
})
it('returns 400 for non-numeric vmid', async () => {
expect((await request(app).get('/api/instances/abc/history')).status).toBe(400)
})
})
// ── GET /api/export ───────────────────────────────────────────────────────────
describe('GET /api/export', () => {
it('returns 200 with instances array and attachment header', async () => {
await request(app).post('/api/instances').send(base)
const res = await request(app).get('/api/export')
expect(res.status).toBe(200)
expect(res.headers['content-disposition']).toMatch(/attachment/)
expect(res.body.instances).toHaveLength(1)
expect(res.body.instances[0].name).toBe('traefik')
})
it('returns empty instances array when no data', async () => {
const res = await request(app).get('/api/export')
expect(res.body.instances).toEqual([])
})
})
// ── POST /api/import ──────────────────────────────────────────────────────────
describe('POST /api/import', () => {
it('replaces all instances and returns imported count', async () => {
await request(app).post('/api/instances').send(base)
const res = await request(app).post('/api/import')
.send({ instances: [{ ...base, vmid: 999, name: 'imported' }] })
expect(res.status).toBe(200)
expect(res.body.imported).toBe(1)
expect((await request(app).get('/api/instances')).body[0].name).toBe('imported')
})
it('returns 400 if instances is not an array', async () => {
expect((await request(app).post('/api/import').send({ instances: 'bad' })).status).toBe(400)
})
it('returns 400 with per-row errors for invalid rows', async () => {
const res = await request(app).post('/api/import')
.send({ instances: [{ ...base, name: '', vmid: 1 }] })
expect(res.status).toBe(400)
expect(res.body.errors[0].index).toBe(0)
})
it('returns 400 if body has no instances key', async () => {
expect((await request(app).post('/api/import').send({})).status).toBe(400)
})
it('returns 400 (not 500) when a row is missing name', async () => {
const res = await request(app).post('/api/import')
.send({ instances: [{ ...base, name: undefined, vmid: 1 }] })
expect(res.status).toBe(400)
})
})
// ── Static assets & SPA routing ─────────────────────────────────────────────── // ── Static assets & SPA routing ───────────────────────────────────────────────
describe('static assets and SPA routing', () => { describe('static assets and SPA routing', () => {

View File

@@ -2,7 +2,7 @@ import { describe, it, expect, beforeEach } from 'vitest'
import { import {
_resetForTest, _resetForTest,
getInstances, getInstance, getDistinctStacks, getInstances, getInstance, getDistinctStacks,
createInstance, updateInstance, deleteInstance, importInstances, getInstanceHistory, createInstance, updateInstance, deleteInstance,
} from '../server/db.js' } from '../server/db.js'
beforeEach(() => _resetForTest()); beforeEach(() => _resetForTest());
@@ -166,62 +166,6 @@ describe('deleteInstance', () => {
}); });
}); });
// ── importInstances ───────────────────────────────────────────────────────────
describe('importInstances', () => {
const base = { state: 'deployed', stack: 'production', atlas: 0, argus: 0, semaphore: 0, patchmon: 0, tailscale: 0, andromeda: 0, tailscale_ip: '', hardware_acceleration: 0 };
it('replaces all existing instances with the imported set', () => {
createInstance({ ...base, name: 'old', vmid: 1 });
importInstances([{ ...base, name: 'new', vmid: 2 }]);
expect(getInstance(1)).toBeNull();
expect(getInstance(2)).not.toBeNull();
});
it('clears all instances when passed an empty array', () => {
createInstance({ ...base, name: 'a', vmid: 1 });
importInstances([]);
expect(getInstances()).toEqual([]);
});
});
// ── instance history ─────────────────────────────────────────────────────────
describe('instance history', () => {
const base = { state: 'deployed', stack: 'production', atlas: 0, argus: 0, semaphore: 0, patchmon: 0, tailscale: 0, andromeda: 0, tailscale_ip: '', hardware_acceleration: 0 };
it('logs a created event when an instance is created', () => {
createInstance({ ...base, name: 'a', vmid: 1 });
const h = getInstanceHistory(1);
expect(h).toHaveLength(1);
expect(h[0].field).toBe('created');
});
it('logs changed fields when an instance is updated', () => {
createInstance({ ...base, name: 'a', vmid: 1 });
updateInstance(1, { ...base, name: 'a', vmid: 1, state: 'degraded' });
const h = getInstanceHistory(1);
const stateEvt = h.find(e => e.field === 'state');
expect(stateEvt).toBeDefined();
expect(stateEvt.old_value).toBe('deployed');
expect(stateEvt.new_value).toBe('degraded');
});
it('logs no events when nothing changes on update', () => {
createInstance({ ...base, name: 'a', vmid: 1 });
updateInstance(1, { ...base, name: 'a', vmid: 1 });
const h = getInstanceHistory(1).filter(e => e.field !== 'created');
expect(h).toHaveLength(0);
});
it('records history under the new vmid when vmid changes', () => {
createInstance({ ...base, name: 'a', vmid: 1 });
updateInstance(1, { ...base, name: 'a', vmid: 2 });
expect(getInstanceHistory(2).some(e => e.field === 'vmid')).toBe(true);
expect(getInstanceHistory(1).filter(e => e.field !== 'created')).toHaveLength(0);
});
});
// ── Test environment boot isolation ─────────────────────────────────────────── // ── Test environment boot isolation ───────────────────────────────────────────
describe('test environment boot isolation', () => { describe('test environment boot isolation', () => {

View File

@@ -133,64 +133,6 @@ describe('version label formatting', () => {
}) })
}) })
// ── fmtHistVal() ─────────────────────────────────────────────────────────────
// Mirrors the logic in ui.js — formats history field values for display.
const BOOL_FIELDS = ['atlas','argus','semaphore','patchmon','tailscale','andromeda','hardware_acceleration']
function fmtHistVal(field, val) {
if (val == null || val === '') return '—'
if (BOOL_FIELDS.includes(field)) return val === '1' ? 'on' : 'off'
return val
}
describe('fmtHistVal', () => {
it('returns — for null', () => {
expect(fmtHistVal('state', null)).toBe('—')
})
it('returns — for empty string', () => {
expect(fmtHistVal('state', '')).toBe('—')
})
it('returns on/off for boolean service fields', () => {
expect(fmtHistVal('atlas', '1')).toBe('on')
expect(fmtHistVal('atlas', '0')).toBe('off')
expect(fmtHistVal('hardware_acceleration', '1')).toBe('on')
})
it('returns the value as-is for non-boolean fields', () => {
expect(fmtHistVal('state', 'deployed')).toBe('deployed')
expect(fmtHistVal('name', 'plex')).toBe('plex')
expect(fmtHistVal('tailscale_ip', '100.64.0.1')).toBe('100.64.0.1')
})
})
// ── stateClass() ─────────────────────────────────────────────────────────────
// Mirrors the logic in ui.js — maps state values to timeline CSS classes.
function stateClass(field, val) {
if (field !== 'state') return ''
return { deployed: 'tl-deployed', testing: 'tl-testing', degraded: 'tl-degraded' }[val] ?? ''
}
describe('stateClass', () => {
it('returns empty string for non-state fields', () => {
expect(stateClass('name', 'plex')).toBe('')
expect(stateClass('stack', 'production')).toBe('')
})
it('returns the correct colour class for each state value', () => {
expect(stateClass('state', 'deployed')).toBe('tl-deployed')
expect(stateClass('state', 'testing')).toBe('tl-testing')
expect(stateClass('state', 'degraded')).toBe('tl-degraded')
})
it('returns empty string for unknown state values', () => {
expect(stateClass('state', 'unknown')).toBe('')
})
})
// ── CSS regressions ─────────────────────────────────────────────────────────── // ── CSS regressions ───────────────────────────────────────────────────────────
const css = readFileSync(join(__dirname, '../css/app.css'), 'utf8') const css = readFileSync(join(__dirname, '../css/app.css'), 'utf8')