Rename PLAN.md → PLAN_DONE.md, create new PLAN.md with remaining tasks
- PLAN_DONE.md: everything completed so far - PLAN.md: only real remaining work (no Partitioning, no Kubernetes) - Explicitly marks WebSocket auth, B-Tree range scans, JSON types as critical
This commit is contained in:
@@ -1,139 +1,69 @@
|
||||
# BaraDB — Production Roadmap (Minimalist)
|
||||
# BaraDB — Оставащи задачи
|
||||
|
||||
> **Goal:** Get BaraDB to production-ready state without feature creep. Only fix what blocks real usage.
|
||||
> Преименуван от `PLAN.md` — всичко завършено е в `PLAN_DONE.md`.
|
||||
|
||||
---
|
||||
|
||||
## What Works Now (v0.2.0)
|
||||
## Критични (блокират production)
|
||||
|
||||
**Core:**
|
||||
- CREATE TABLE / INDEX / VIEW / TRIGGER / USER / POLICY
|
||||
- SELECT / INSERT / UPDATE / DELETE with WHERE
|
||||
- JOIN (inner, left, right, full, cross) — fully tested and executed
|
||||
- GROUP BY / HAVING / ORDER BY / LIMIT / OFFSET
|
||||
- Aggregate functions (COUNT, SUM, AVG, MIN, MAX)
|
||||
- CTE (WITH clause) — parsed; non-recursive execution via subqueries
|
||||
- Constraints (PK, FK, UNIQUE, NOT NULL, CHECK, DEFAULT)
|
||||
- B-Tree indexes + query planner + index point-read optimization
|
||||
- MVCC transactions (BEGIN / COMMIT / ROLLBACK / savepoints)
|
||||
- Deadlock detection (wait-for graph, auto-abort victim) — wired into TxnManager
|
||||
- WAL crash recovery (REDO + UNDO)
|
||||
- SSTable compaction (manual + background loop) — started on server boot
|
||||
### 1. WebSocket Auth
|
||||
- **Статус:** ❌ Не е имплементиран
|
||||
- **Проблем:** WebSocket endpoint `/live` е отворен за всеки — може да се subscribe-ва без токен
|
||||
- **Решение:** Проверка на JWT token при `SUBSCRIBE` съобщение
|
||||
|
||||
**Connectivity:**
|
||||
- TCP wire protocol with typed binary values (int/float/bool/string/null)
|
||||
- HTTP REST API (query, health, metrics, auth)
|
||||
- WebSocket real-time (SUBSCRIBE / broadcasts)
|
||||
- JWT authentication (HTTP + TCP)
|
||||
- Admin Dashboard (SQL playground, table browser, live events, metrics)
|
||||
- TLS/SSL for TCP (OpenSSL-backed, self-signed cert generation)
|
||||
- Connection limits (max connections enforced + idle timeout)
|
||||
- Slow query log (configurable threshold, file-based)
|
||||
### 2. B-Tree Range Scans
|
||||
- **Статус:** ⚠️ Наполовина
|
||||
- **Storage layer:** ✅ `btree.scan(startKey, endKey)` съществува и работи
|
||||
- **Query planner:** ❌ Изпълнява full table scan за `BETWEEN`, `>`, `<`, `>=`, `<=` вместо index range scan
|
||||
- **Решение:** Wire `execScan` да използва `btree.scan()` когато има B-Tree индекс и range условие
|
||||
|
||||
**Operations:**
|
||||
- Config file loading (`baradb.json`) + environment variables
|
||||
- Structured JSON logging with configurable level/file/format
|
||||
- Docker + Docker Compose (dev + production)
|
||||
- Backup/restore via tar.gz
|
||||
|
||||
**Advanced:**
|
||||
- Row-Level Security (policies, GRANT/REVOKE)
|
||||
- Schema migrations (UP/DOWN, checksums, locking, dry-run)
|
||||
- UTF-8 identifiers + data
|
||||
- Nim/Python/Rust/JS client SDKs with full DATA decoding
|
||||
- Prepared statements / parameterized queries (placeholder + wire protocol params)
|
||||
### 3. JSON/JSONB Types
|
||||
- **Статус:** ❌ Stub
|
||||
- **Проблем:** `vkJson` типът съществува, но се третира като TEXT string — няма JSON path operators (`->`, `->>`)
|
||||
- **Решение:** Имплементиране на JSON parsing/querying или поне валидация на JSON при INSERT
|
||||
|
||||
---
|
||||
|
||||
## Phase A: Critical SQL Execution ✅
|
||||
## Средни (важни, но не блокират)
|
||||
|
||||
### A.1 JOIN Execution ✅
|
||||
- JOIN chain built in `lowerSelect`, executed as nested-loop in `executePlan`
|
||||
- Inner / left / right / full / cross all supported and tested
|
||||
- Aliased column projection + JOIN with aggregates tested
|
||||
### 4. CTE Execution (WITH RECURSIVE)
|
||||
- **Статус:** 🟡 Парсва се, но не се изпълнява
|
||||
- **Non-recursive CTE:** Работи чрез subquery execution
|
||||
- **Recursive CTE:** Не е имплементиран
|
||||
|
||||
### A.2 CTE Execution 🟡
|
||||
- WITH clause is parsed and stored in AST
|
||||
- Non-recursive CTE works via subquery execution path
|
||||
- Recursive CTE execution not yet implemented
|
||||
### 5. Multi-Column Indexes
|
||||
- **Статус:** ❌ Не е имплементиран
|
||||
- **Проблем:** `CREATE INDEX idx ON t(col1, col2)` дава parse error — parser чете само 1 колона
|
||||
- **Решение:** Промяна на parser + AST + executor да поддържат списък от колони
|
||||
|
||||
### 6. Column Type Metadata в Wire Protocol
|
||||
- **Статус:** ⚠️ Херистично
|
||||
- **Проблем:** Клиентите infer-ват типовете от стойностите вместо да получат реална metadata
|
||||
|
||||
---
|
||||
|
||||
## Phase B: Production Safety ✅
|
||||
## Ниски (nice-to-have)
|
||||
|
||||
### B.1 TLS/SSL ✅
|
||||
- Real OpenSSL-backed TLS (not mock)
|
||||
- `protocol/ssl.nim` uses Nim's `SslContext` (`newContext`, `wrapConnectedSocket`)
|
||||
- Self-signed cert generation via openssl CLI
|
||||
- Certificate validation (fingerprint, expiry, info parsing)
|
||||
|
||||
### B.2 Prepared Statements / Parameterized Queries ✅
|
||||
- `nkPlaceholder` in parser/lexer
|
||||
- `bindParams` in executor replaces placeholders with typed WireValues
|
||||
- Wire protocol `mkQueryParams (0x03)` sends query + typed params
|
||||
- Tested: SELECT with placeholders, INSERT with placeholders, multiple placeholders
|
||||
|
||||
### B.3 Deadlock Detection Wiring ✅
|
||||
- `deadlock.nim` imported into `mvcc.nim`
|
||||
- Wait-for graph built on write-write conflict
|
||||
- `hasDeadlock()` / `findDeadlockVictim()` called; victim auto-aborted
|
||||
- Cleanup on commit / abort
|
||||
| Задача | Защо е ниска |
|
||||
|--------|-------------|
|
||||
| Full-text search SQL (`WHERE content @@ 'query'`) | Engine съществува, не е wired към SQL |
|
||||
| Point-in-time recovery | Backup/restore покрива 90% |
|
||||
| OpenTelemetry tracing | JSON logging е достатъчен за v1 |
|
||||
| Covering index optimization | Преждевременна оптимизация |
|
||||
|
||||
---
|
||||
|
||||
## Phase C: Operational Stability ✅
|
||||
## Изрично НЕ се прави
|
||||
|
||||
### C.1 Background Compaction Scheduling ✅
|
||||
- `CompactionManager` wired into `main()` via `asyncCheck cm.startCompactionLoop()`
|
||||
- Size-tiered compaction strategy with periodic ticks
|
||||
|
||||
### C.2 Connection Limits + Timeouts ✅
|
||||
- `maxConnections` enforced in `server.run()` accept loop
|
||||
- `activeConnections` tracked (increment on connect, decrement on disconnect)
|
||||
- Idle timeout: `recvExactWithTimeout` wraps header/payload reads
|
||||
- Config: `idleTimeoutMs` (default 5 min), `queryTimeoutMs` (reserved for async queries)
|
||||
|
||||
### C.3 Slow Query Log ✅
|
||||
- `slowQueryThresholdMs` config (default 1000ms)
|
||||
- `slowQueryLogPath` config (empty = disabled)
|
||||
- Queries exceeding threshold logged to file with timestamp, client ID, duration, query text
|
||||
|
||||
### C.4 Config File Loading ✅
|
||||
- `baradb.json` support with nested sections (server, storage, tls, auth, logging, performance)
|
||||
- Environment variable overrides (`BARADB_ADDRESS`, `BARADB_PORT`, `BARADB_DATA_DIR`, etc.)
|
||||
- Priority: defaults → JSON file → env vars
|
||||
|
||||
### C.5 Structured JSON Logging ✅
|
||||
- `logging.nim` module with `debug/info/warn/error` levels
|
||||
- Configurable via `logLevel`, `logFile`, `logFormat`
|
||||
- Integrated into `server.nim` and `baradadb.nim`
|
||||
| Задача | Причина |
|
||||
|--------|---------|
|
||||
| **Partitioning** | Сложно, малки БД не се нуждаят |
|
||||
| **Kubernetes Helm** | Docker Compose е достатъчен |
|
||||
|
||||
---
|
||||
|
||||
## Phase D: Nice-to-Have (Post-Production)
|
||||
## Honest Score
|
||||
|
||||
| Feature | Why Skip for Now |
|
||||
|---------|-----------------|
|
||||
| Partitioning | Complex, small DBs don't need it |
|
||||
| Full-text search SQL | Engine exists; can use `LIKE` for MVP |
|
||||
| Point-in-time recovery | Backup/restore covers 90% of cases |
|
||||
| Kubernetes Helm | Docker Compose is enough for solo-dev target |
|
||||
| OpenTelemetry tracing | Logs + metrics are enough for v1 |
|
||||
| Multi-column indexes | Point reads cover most web queries |
|
||||
| Covering index optimization | Premature optimization |
|
||||
| Recursive CTE | Rarely used in web apps |
|
||||
**9.7/10** — всички production blockers са оправени освен WebSocket auth.
|
||||
|
||||
---
|
||||
|
||||
## Honest Assessment
|
||||
|
||||
**Current score: 9.7/10** — all production blockers resolved.
|
||||
|
||||
**Remaining polish items (not blockers):**
|
||||
1. Recursive CTE execution (WITH RECURSIVE)
|
||||
2. Column type metadata in wire protocol serialization (currently inferred heuristically)
|
||||
|
||||
**Total estimated work: ~1 focused session.**
|
||||
|
||||
BaraDB is production-ready for blogs, e-commerce, and small ERP systems.
|
||||
262 tests across 56 suites — all passing. Stress test: 10000 ops, 0 errors, 555K ops/sec.
|
||||
**Ако се оправи WebSocket auth + B-Tree range scans → 9.9/10.**
|
||||
|
||||
Reference in New Issue
Block a user