sandrodach/MindSift

0 Fork 0

Files

T

sandrodachandClaude Opus 5.5 1ea0c78b41

MindSift CI & Docker Release / Build, Test in Container & Push (push) Successful in 50s

Details

feat(notes): operation log, block leases and sync API for collaborative editing

Phase 1 of the collaboration plan (server side):
- internal/collab: block tree with parent IDs and fractional order keys,
  operations with conflict rules (version check, block leases, conflict
  copies instead of lost text, restore on late edits, cycle checks),
  in-memory leases/sessions and long-poll notifier.
- Storage: per-note lock + transaction, append-only effect log (doc_ops),
  idempotent results per opId (doc_op_results), snapshot, log paging,
  central DocRole. Old flat block data is converted to the tree.
- The existing whole-document save (PUT/PATCH) runs as an adapter through
  the same engine, so the current editor keeps working and writes to the log.
- API: GET /docs/{id}/snapshot, POST /docs/{id}/sync, GET /docs/{id}/changes
  (long poll), POST /docs/{id}/leave; DOC_SEQ poke for WebSocket/SSE rooms.
- Backend accepts editor (write) shares for notes and folders; the forced
  read-only migration is gone. The share dialog still offers read only.
- Tests: conflict matrix, order keys, leases, storage adapter round trip,
  idempotency, API protocol incl. long poll, and a randomized simulation
  (4 clients, lost/duplicated requests and responses, offline phases,
  lease expiry) checking convergence, no lost text and exactly-once results.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

2026-10-28 11:47:56 +01:00

5.5 KiB

Raw Blame History

Architektur

Überblick

Browser (React SPA, PWA-Manifest)
   │  REST /api/v1/*           Authorization: Bearer <JWT | mindsift_sec_…>
   │  WebSocket /api/v1/ws     Fallback: SSE /api/v1/events
   ▼
Go-Server (chi)  ── internal/api   Handler, Middleware, Alarm-Ticker
   │                internal/ws    Hub (Räume, Benutzer-Kanäle, SSE)
   │                internal/auth  JWT, bcrypt, API-Key-Hash
   ▼                internal/config
SQLite (modernc.org/sqlite, WAL)  ── internal/storage

Das Frontend liegt per go:embed im Binary (cmd/server/main.go). Unbekannte Pfade liefern index.html (SPA-Routing); index.html, sw.js und manifest.json werden mit no-store ausgeliefert.

Stack

Schicht	Technik
Backend	Go 1.23, `go-chi/chi` v5, `go-chi/cors`, `gorilla/websocket`, `golang-jwt/jwt` v5, `x/crypto/bcrypt`
Datenbank	SQLite über `modernc.org/sqlite` (reines Go, kein CGO), WAL, `foreign_keys=ON`
Frontend	React 18, TypeScript, Vite 5, Tailwind 3, framer-motion (Triage-Karten), lucide-react, prismjs (Code-Blöcke)
Auslieferung	Mehrstufiges Dockerfile (Node 22 → Go 1.23 → Alpine 3.21), Image `git.dsit.me/sandrodach/mindsift`

Verzeichnisse

Pfad	Inhalt
`cmd/server/`	`main.go`, eingebettetes `dist/`
`internal/api/`	`server.go` (Routen, Handler, Alarm-Ticker, SMTP/Discord/Webhook-Versand)
`internal/storage/`	`sqlite.go` (Schema, Migrationen, gesamte Datenlogik)
`internal/domain/`	Strukturen (`models.go`), ID-Erzeugung, Tag-Extraktion
`internal/ws/`	`hub.go`
`internal/collab/`	Kern der Notiz-Synchronisation ohne Datenbank: Blockbaum, Operationen und Konfliktregeln, Sortierschlüssel, Leases, Long-Poll-Benachrichtigung
`internal/auth/`	Tokens und Passwörter
`internal/config/`	Umgebungsvariablen
`frontend/src/features/`	`triage`, `workspace`, `lists`, `teams`, `settings`, `capture`, `auth`, `help`
`frontend/src/lib/`	`api.ts` (REST-Client, Transport-Umschaltung WS/SSE), `types.ts`, `markdown.tsx`, `theme.ts`
`frontend/src/themes/`	CSS pro Theme

Start und Laufzeit

config.Load() liest die Umgebung (siehe unten).
storage.NewStore() öffnet SQLite (busy_timeout, WAL, max. 8 Verbindungen) und führt migrate() aus.
SMTP-Werte aus der Umgebung werden in system_settings übernommen, sofern dort noch nichts steht.
Mit Demo-Flag legt EnsureDemoAccounts die Konten admin/admin und user/user an.
api.NewServer startet den Alarm-Ticker (jede Minute) und baut den Router. Server-Timeouts: Lesen 15 s, Schreiben 30 s, Leerlauf 60 s. Beim Beenden wird sauber heruntergefahren.

Konfiguration

Variable	Standard	Bedeutung
`PORT`	`8080`	HTTP-Port
`DATA_DIR`	`./data` (Container: `/data`)	Verzeichnis der Datenbank
`DATABASE_URL`	leer	`sqlite:///pfad/datei.db` oder Pfad; ohne Angabe `DATA_DIR/mindsift.db`. Postgres-URLs werden nicht unterstützt (siehe Hinweis)
`JWT_SECRET`	festes Fallback (unsicher!)	Signaturschlüssel der Tokens; unbedingt setzen, siehe FLAW-04
`BASE_URL`	`http://localhost:<PORT>`	Basis-URL der Instanz
`ALLOW_REGISTRATION`	`false`	Startwert; die Einstellung im Admin-UI (`system_settings`) hat Vorrang
`LOG_LEVEL` / `DEBUG`	`info` / `false`	`debug`, `info`, `warn`, `error`; `DEBUG=true` erzwingt `debug`
`MINDA_DEMO` (auch `MINDSIFT_DEMO`, `DEMO_MODE`)	`false`	Demo-Konten anlegen
`SMTP_HOST`, `SMTP_PORT`, `SMTP_USER`, `SMTP_PASS`, `SMTP_FROM`, `SMTP_TLS`	leer / `587` / `true`	Mailversand, auch im Admin-UI einstellbar

Hinweis: DATABASE_URL mit postgres… führt dazu, dass der Standardpfad in DATA_DIR genutzt wird; Postgres ist nicht implementiert.

Authentifizierung

Login mit E-Mail, Benutzername (aus dem E-Mail-Präfix) oder login. Passwörter: bcrypt (DefaultCost).
JWT: HS256, Laufzeit 30 Tage, Claims userId, email, displayName, tokenVersion, jti. Gültig nur, wenn Token nicht in revoked_tokens steht, das Konto aktiv ist und tokenVersion mit users.token_version übereinstimmt. token_version wird bei Passwortänderung, Rollenwechsel, Deaktivierung und „Alle Sitzungen beenden“ erhöht.
Logout schreibt den Token-Hash in revoked_tokens.
API-Keys: mindsift_sec_<hex>, gespeichert als SHA-256, nur das Präfix bleibt sichtbar. Der Key gilt als Bearer-Token oder in X-API-Key und authentifiziert als Besitzer (FLAW-07).
Registrierung: nur mit Einladungscode oder wenn allow_registration aktiv ist. Das erste Konto entsteht über /auth/setup und wird Administrator.

Hintergrundjob: Alarme

startAlarmTicker prüft jede Minute alle offenen, noch nicht gemeldeten Aufgaben mit Fälligkeit. Ist due_date <= heute (Serverzeit), sendet er über die Kanäle des Benutzers (email, discord, webhook) und setzt alarm_sent, sobald mindestens ein Kanal erfolgreich war. Details und Einschränkungen: modules/tasks.md, FLAW-12.

Build

Stage 1  node:22-alpine   tsc, vitest, vite build            → frontend/dist
Stage 2  golang:1.23      go vet, go test, go build          → /app/mindsift (dist wird eingebettet)
Stage 3  alpine:3.21      nur Binary, ca-certificates, tzdata

Die Tests laufen beim Image-Build (Frontend: npm run test:run, Backend: go test -v ./...); ein Fehler bricht den Build ab. Frontend-Tests liegen unter frontend/src/**/__tests__/ (Vitest + jsdom + Testing Library, Setup in frontend/src/test/setup.ts).

5.5 KiB Raw Blame History