Files
Primora/ROADMAP.md
T
Tomas DvorakandDevin 8cfddf9184 feat: phase 3 observability — IMS telemetry merge
Port IMS telemetry into Primora conventions:

- core.components/core.events (migration 00004 + sqlc) scoped to projects
- POST /api/v1/ingest — single or <=500-event batches via project prm_
  keys (X-Primora-Key alias), auto-registering components, permissive CORS
- Issues: fingerprint-grouped errors with count/severity/first+last seen
- Reads: events w/ filters + before-cursor, components, stats (1h/24h/7d/30d
  bucketed series + component health + totals + metric names), metric
  series (avg/p50/p95/max)
- GET .../telemetry/stream — project-scoped SSE through an in-process hub
  (buffered subs, drop-on-slow, 25s keepalives); ?api_key=/?token= auth
  for EventSource
- Telemetry page: health/issues/events/metrics/integrate tabs, live badge,
  390px-clean; demo stubs
- @primora/client SDK (createPrimoraClient: capture*/heartbeat/installAuto,
  queued keepalive flushes)
- MCP: primora_list_issues/list_events/telemetry_stats/metric_series
- IMS README deprecation note pointing here

Also fixes workspace pins to 0.3.0 — npm ci in the frontend image was
resolving the unpublished 0.2.0 spec from the registry.

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-09-16 16:21:03 +02:00

118 lines
6.0 KiB
Markdown

# Primora Roadmap
Primora is a self-hosted backend platform — the open, ownable alternative to
Supabase and Appwrite. One binary deployment gives you auth, Postgres-backed
APIs, object storage, document collections, API keys, an audit log, database
tooling, observability, and integrations — all behind one dashboard.
Design docs: [project_backend.md](project_backend.md) · [project_frontend.md](project_frontend.md)
---
## Phase 0 — Foundation (done)
- SolidJS dashboard, dark-first design system, demo mode
- Go + Gin API, sqlc, migrations, local object storage
- Better Auth service (email/password + OAuth), JWT via JWKS
- Docker Compose stack, nginx proxy, OpenAPI-generated client
- MIT license, CONTRIBUTING, SECURITY, rewritten README/QUICK_START
## Phase 1 — Surface area & release plumbing
Everything an operator touches that isn't in the box yet.
- **`primora` CLI** (TypeScript, `apps/cli`) — login, org/project context,
projects, buckets, objects up/download, keys, audit tail. `cac` for parsing,
`@clack/prompts` for interactive UX, `picocolors` for colour. Wraps the
generated `@primora/api-client` directly — one contract, zero duplication.
Ships as `@primora/cli` on npm (`npx primora …`) and as standalone binaries
via `bun build --compile` in the release pipeline (the opencode pattern).
- **`@primora/mcp` server** (`apps/mcp`) — MCP stdio server exposing
`primora_*` tools (list/create projects, keys, audit query, storage ops) so
agents can operate the platform directly. Ported from IMS's `apps/mcp`.
- **Auth users panel** — Supabase-style `Authentication → Users` view backed by
the auth service (list users, disable, reset). Requires a small admin
read endpoint on the auth service.
- **Release pipeline** — semver tags, CHANGELOG.md, GitHub Actions: build
matrix → GitHub Release + ghcr.io images (`primora/backend`,
`primora/auth`, `primora/frontend`, `primora/cli`).
- **Responsive pass** — sidebar already collapses; audit every page at
390px for table/card overflow.
## Phase 2 — Databases (DBX)
The "any database" story, via [DBX](https://github.com/t8y2/dbx) — 90+ drivers
in a 25 MB MCP server. Primora does not embed DBX; the Go backend keeps
`@dbx-app/mcp-server` as a persistent stdio subprocess and exposes its tools
as REST (pattern already proven in IMS's `internal/app/dbx.go`).
- **Connection registry** ✅ — per-project saved connections (Postgres, MySQL,
SQLite, Redis, MongoDB, …). Credentials stored server-side, never sent to
the browser. `core.db_connections` table + endpoints.
- **Databases page** ✅ — connection list → database/schema/table browser →
column/type/key inspector.
- **SQL editor** ✅ — query editor with ⌘/Ctrl+Enter, result grid, row detail.
- **Redis console** ✅ — command input + output history for redis-type
connections.
- **Visual overview** ✅ — schema graph: tables as nodes, foreign keys as edges.
- **First-party connections** ✅ — the platform's own Postgres and Dragonfly
auto-register as connections on every project, so "put Postgres in it and
it runs Postgres" works out of the box.
- **DB-to-DB links** — DBX data transfer between two saved connections
(e.g. Postgres → Dragonfly cache warm), plus documented patterns for
pairing them.
## Phase 3 — Observability (IMS merge) ✅
IMS (`~/Desktop/PROG+HTML/IMS`) is discontinued and folded in — same stack
(Gin + pgx + Postgres), ~2k lines to port.
- **Ingest API** — `POST /api/v1/ingest` authenticated by project `prm_` API keys
(`X-Primora-Key` or `X-API-Key`); event types: error, metric, log, heartbeat,
event; component auto-registration; single event or ≤500-event batch;
permissive CORS so browser SDKs can post directly.
- **Issues** — error groups by fingerprint (count, first/last seen, severity,
stack payload) — the Firebase Crashlytics-shaped view.
- **Telemetry views** — health overview (totals, activity histogram, component
health), issues, events, metric series (avg/p50/p95/max), Integrate tab;
live updates over SSE (`GET …/telemetry/stream`, `?api_key=`/`?token=` for
EventSource auth).
- **`@primora/client` SDK** — port of `@ims/client`: queued batching,
`keepalive` flush, `installAuto()` for browser error capture.
- **Agent tooling** — `primora_list_issues`, `primora_list_events`,
`primora_telemetry_stats`, `primora_metric_series` in `apps/mcp`.
- Migration note in IMS repo README → archive, point at Primora.
## Phase 4 — Integrations
- **Connector framework** — per-project external services: type, base URL,
credentials (encrypted at rest), health check. `core.integrations` table.
- **Rybbit connector** — user supplies their self-hosted Rybbit URL + API key;
Primora pulls site stats into a project **Analytics** page and dashboard
widgets. Read-only, no tracking proxy.
- **Webhooks** — outbound events (issue created, deploy marker) to arbitrary
URLs, so Primora can push into other self-hosted tools.
## Phase 5 — Distribution
- **Desktop app** — Tauri 2 shell (Linux/Windows/macOS). Thin client: asks for
the deployment URL on first run, renders the same SolidJS bundle, keeps a
system-tray presence. No embedded stack — self-hosted model preserved.
- **Phone** — PWA (manifest, service worker, install prompt) first; native
shells via Capacitor only if push notifications become a requirement.
- **Versioning** — `v0.x` minor-per-phase until API surface stabilizes,
`v1.0.0` when Phase 3 lands. Every release: GitHub Release notes +
tagged images + CLI binaries.
- **Docs site** — README stays canonical; a docs/ folder or site once the API
settles.
---
## What is deliberately out of scope
- Managed/hosted tier — the product is the self-hosted thing.
- Realtime subscriptions, edge functions, generated REST/GraphQL per-table
(Supabase PostgREST-style). Revisit after Phase 3 if wanted — Collections
already cover the common case.
- Embedding DBX's desktop UI — we use its MCP server as a library, not its app.