All checks were successful
Verify and publish V2 container / build-and-push (push) Successful in 30s
Generation - Every quiz is NCLEX style; "Practice exam" writes 50 questions. - Calculation questions only when the material involves calculations (max 5 per exam). - Broad topics: the class's topics are listed in the prompt, a quick grouping call maps narrow labels onto broad ones, and leftover variants are merged. - Exact select-all count per batch; option order shuffled. - Python check: at most 3 runs, fixed problems count as passed, cosmetic remarks ignored. Assistant - Text, tool steps and cards appear in the order they happen, with paragraph breaks between steps. - Optional thinking box: fixed height, follows the newest text, can be scrolled back. - "+" opens a material picker listing recent items; items can be dragged in from class pages; shorter placeholder. MCP servers - Streamable HTTP client; encrypted headers. - Per-server instructions and switches for chat, Explain, generation and the quiz check. - Settings UI. Share links - Optional "Explain this" and "Ask about this material" per link, off by default. - Items are loaded on the server and checked against the share; no tools; rate-limited. - Migration 4 stores the switches. Study and documents - Standard flashcard mode (optionally repeat missed cards until known) next to spaced repetition. - Streak visuals restyled in the app palette. - Side by side / Original document views, with sandboxed previews of Word and PowerPoint files. Other - Built-in embedding model baked into the image; sharp stubbed if it cannot load; real load error shown in Settings. - Python runner blocks network and process modules in JavaScript too. - "View questions and answers" removed from the quiz start screen. - Docs updated. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
184 lines
13 KiB
Markdown
184 lines
13 KiB
Markdown
# Study Desk V2 — progress and resume notes
|
||
|
||
Updated 2026-11-12. Branch: **v2**. Original V1: **main**, preserved at `7bd0a9a`.
|
||
The owner authorized publishing progress and `v2` now tracks Forgejo `origin/v2`.
|
||
No production deployment has been performed.
|
||
|
||
## Product and architecture
|
||
|
||
This is a rebuilt app using React + Vite + TypeScript, Hono/Node HTTP server, built-in
|
||
`node:sqlite`, SQLite FTS5, local document storage and a persistent document queue. One process,
|
||
one data volume, one administrator. Anonymous visitors get public read-only shares and
|
||
browser-local study progress. Administrator progress stays server-side.
|
||
|
||
The previous agent implemented the core product and committed it through `c549c34`:
|
||
classes/folders, CRUD/duplicate/move/search, quiz sessions/results/history, FSRS flashcards,
|
||
imports/exports/templates, documents/extraction/retrieval/OCR, provider adapters, editable
|
||
AI drafts, tool-based assistant actions, sharing, analytics and the responsive themed UI.
|
||
User feedback fixes are already included: larger clickable flashcards, arrow keys, streak
|
||
effects, persistent review sidebar, live quiz score, shared quiz timers, SATA credit details,
|
||
type-grouped materials, copyable import instructions and assistant library links.
|
||
|
||
## Current continuation
|
||
|
||
- Confirmed original 162 tests pass; sandbox networking initially blocked the mock provider.
|
||
- Added encryption-key corruption/missing-key refusal, static-path boundary validation,
|
||
private embedded-media authorization and share-revocation checks.
|
||
- Full backups include the generated encryption key and fail on unreadable files.
|
||
- Added backup restore, media authorization, key durability, static-path traversal, V1 import and failed-migration
|
||
rollback tests. The new V1 test checks source bytes are unchanged and state is preserved.
|
||
- Added Dockerfile, Compose, .dockerignore, README and deployment/migration/AI documentation.
|
||
- Updated obsolete ChatGPT subscription wording after checking official documentation:
|
||
account integration exists for eligible clients, but hosted app approval for this private
|
||
Unraid web deployment has not been established. API integration remains the working path.
|
||
- Terra completed isolated UI/workflow and visual QA; see results below.
|
||
- Guarded quiz exit/submission when the latest save failed, and prevented repeated automatic
|
||
timer submissions after a failed request.
|
||
- Preserved the V1 card elapsed-days scheduling field during import.
|
||
|
||
## 2026-11-12 additions
|
||
|
||
- `.forgejo/workflows/build-v2.yml`: pushes to `v2` run typecheck + tests inside the Node 24
|
||
image (new Dockerfile `test` stage), build and smoke-test the production image, then publish
|
||
`study:v2` and `study:v2-<sha>`. Never `:latest`. Verified locally with Docker Desktop; the
|
||
workflow itself has not run on the Forgejo runner yet (nothing pushed).
|
||
- Drag-to-reorder (`web/src/ui/Sortable.tsx`, pointer events so touch works, keyboard with
|
||
arrows/Home/End and live announcements) for class materials, folders, questions and cards.
|
||
New endpoint `POST /api/classes/:id/items/reorder`.
|
||
- Timed exams use a wall-clock `deadlineAt` stored in attempt settings. The server refuses late
|
||
answers (409 `time_up`), submits overdue exams lazily and before every authenticated GET,
|
||
and caps time used at the limit. Shared exams use a local wall-clock deadline too.
|
||
- Shared quiz sessions freeze their questions (with option order) in browser storage, with a
|
||
fingerprint to tell the visitor when the owner has since edited the quiz.
|
||
- Scanned PDFs are read in 8-page batches split with pdf-lib, cached per batch, with real page
|
||
numbers. OpenAI-compatible adapter now sends PDFs as Chat Completions `file` parts when the
|
||
model is marked as PDF-capable.
|
||
- Semantic search: migration `2_embeddings` (`chunk_vectors`), embedding support in the
|
||
OpenAI/Gemini/Ollama/compatible adapters, `server/services/semantic.ts` (background indexing,
|
||
in-memory cosine search, reciprocal-rank fusion with FTS), Settings → AI section.
|
||
- Browser QA on an isolated `.test-data/qa` instance (port 3742, `study-qa` launch config):
|
||
drag and keyboard reorder persisted; 375px class page has no overflow; semantic search
|
||
enabled from Settings and indexed; a 1-minute exam counted down on the wall clock and
|
||
auto-submitted at 60 s; a shared session kept original questions after the owner edited them.
|
||
|
||
## 2026-11-15: first revision (owner's 21-item list)
|
||
|
||
Implemented and verified on an isolated instance (`.test-data/rev1`, port 3743):
|
||
DeepSeek provider (`server/ai/providers/deepseek.ts`); 7 reasoning-effort levels mapped per
|
||
adapter; the "does not support tool calling" errors were DeepSeek rejecting forced tool choice
|
||
in thinking mode: compatible servers now get the call requested in the prompt, and only a
|
||
genuine "no tools" 400 reports unsupported. Cached-input prices (migration 3) and cache-write
|
||
/off-peak aware costs. Built-in embeddings (`server/ai/localEmbed.ts`, bge-small, default when
|
||
nothing is chosen). Assistant turns run server-side independent of the browser (re-attach via
|
||
`GET /api/ai/chat/:id/stream`, stop via `POST /api/ai/chat/:id/stop`); drafts tray in the
|
||
sidebar/Today. Quiz start screen, navigator ring/legend fix, timer only for timed exams,
|
||
7-point letter grades, numeric questions (migration 3 rebuilds `questions` for the new type;
|
||
answers are compared numerically, units ignored, optional ± tolerance). Dialog footer padding
|
||
(`safe-pb-3`), keyboard hints removed, small assistant button, full-width assistant page, model
|
||
switcher and @-tagging. Editable generator instructions and built-in presets (builtin = 2 marks
|
||
an edited built-in), separate chatbot import instructions. Copy buttons work over plain HTTP
|
||
inside dialogs. Class/folder shares include processed documents.
|
||
|
||
Live DeepSeek (`deepseek-flash` only) checks passed: discovery, quiz generation at default and
|
||
Max effort (numeric items produced, answer keys correct with thinking on), multi-step tool
|
||
turns, follow-up turns, tagged quiz to flashcards, an answer finishing after disconnect; zero
|
||
errors in Usage. Docker image builds; ONNX Runtime and the embedding model run in the container.
|
||
The image grew to about 1.3 GB because of ONNX Runtime.
|
||
|
||
## 2026-11-15: second revision (owner's 19-item list)
|
||
|
||
Quiz generation: all quizzes NCLEX; "Practice exam" = 50 questions; calculation questions only
|
||
when the source mentions calculations (max 5 in an exam); broad topics (prompted, plus
|
||
`consolidateTopics` merging narrower labels); option order shuffled. The Python check uses at
|
||
most 3 runs and ignores cosmetic remarks. Assistant: text, tool steps and cards stream in the
|
||
order they happen (`MessagePart`), paragraphs are separated between steps, optional "Show
|
||
thinking" box (persisted, fixed height, follows the newest text), "+" opens a material picker
|
||
(no more flashing "@"), library items can be dragged into the panel, shorter placeholder.
|
||
"View questions and answers" removed from the quiz start screen. Built-in embedding model baked
|
||
into the image (`scripts/fetch-embedding-model.mjs`, `LOCAL_MODELS_DIR`), sharp stubbed when its
|
||
native binary will not load, and the real load error shown in Settings. Python runner also blocks
|
||
network and process modules in JavaScript (Node 24's permission model does not block network).
|
||
|
||
New: MCP servers with per-server instructions and per-area switches (`server/ai/mcp.ts`,
|
||
`runChatWithMcp` in `service.ts`); per-share AI switches (migration 4, `shares.ai`;
|
||
`POST /api/public/:token/explain|chat`, rate-limited, no tools); flashcard Standard mode with
|
||
"repeat missed cards until known" next to Spaced repetition on the deck page; streak visuals
|
||
restyled in the app palette (marker highlighter, accent bar, mono numerals); document Side by
|
||
side / Original view with generated previews for Word and PowerPoint. Item 13 (pictures in
|
||
PowerPoint files) was verified only: they are not read; see docs/AI.md.
|
||
|
||
Tests: `tests/revision2.test.ts` (mock MCP server over Streamable HTTP and SSE, area switches,
|
||
instructions in prompts, exam length, calculation allowance, topic merging, message part order,
|
||
previews, share-link AI scope and rate limits).
|
||
|
||
## Verification status
|
||
|
||
Baseline: 162 tests passed, TypeScript passed and production web/server builds passed.
|
||
Added six regression tests. Full `npm run check` passes: **208 tests** (2026-11-15; 181 on 2026-11-12), TypeScript
|
||
and both production builds. The Docker `test` stage runs the same 181 tests on Node 24. Tests were run with loopback access for the mock provider.
|
||
|
||
The earlier agent manually exercised quiz completion/results, flashcards, streak effects,
|
||
mock AI generation through the assistant, editable drafts, and a 375px home page without
|
||
horizontal overflow. Treat these as historical evidence; record Terra's fresh results below.
|
||
|
||
Docker Desktop is now installed. Image build and a disposable non-root container passed
|
||
login, document/card persistence across restart, full-backup ZIP, anonymous sharing and
|
||
private API denial. Still unverified: Unraid filesystem permissions/proxy, paid-provider
|
||
inference and real ChatGPT OAuth/eligibility. The installable app caches its shell, not private study data;
|
||
full offline administrator study is not implemented.
|
||
|
||
## Remaining work
|
||
|
||
1. On Unraid later: execute the deployment/restore checklist in docs/DEPLOYMENT.md.
|
||
2. With owner-supplied provider connections: verify live discovery, streamed chat, generation,
|
||
OCR and task routing. No real-provider calls should be inferred from mock test results.
|
||
3. Future optional work: approved ChatGPT account OAuth, more robust offline studying and
|
||
(semantic embeddings were added on 2026-11-12, the built-in model on 2026-11-15).
|
||
|
||
## Resume safely
|
||
|
||
1. `git status --short`, read this file and recent commits. Do not overwrite user changes.
|
||
2. The ignored `.env` currently selects `.data/`, containing dev/demo content that the user
|
||
has tried. Never print its secrets or reset/seed it casually. Use a new `.test-data/...`
|
||
directory and a separate port for destructive QA.
|
||
3. `npm.cmd run check` (tests require localhost networking for their mock AI server).
|
||
4. `npm.cmd run dev` for Vite + API, or `npm.cmd run build` then `npm.cmd start` for the built
|
||
app. See README and .env.example. All automated test databases are disposable copies.
|
||
5. Keep focused commits on `v2`. The owner has now authorized pushing progress to this branch;
|
||
Git Credential Manager works. Never force push or publish/deploy to production implicitly.
|
||
|
||
## V1 comparison and follow-up usability work
|
||
|
||
See `docs/V2-COMPARISON.md` for the requirement matrix, V1 differences and remaining priorities.
|
||
Fixed the flashcard entrance/exit CSS conflict; restored touch grading and shuffle-remaining;
|
||
reset review queues on scope changes; serialized note autosaves, protected navigation with
|
||
unsaved edits and added an explicit retry action. Verified a note survives immediate
|
||
navigation and reload, and shuffling keeps browse progress at 2/4 rather than restarting.
|
||
|
||
The owner's rationale check passed using a synthetic three-question quiz with per-option
|
||
explanations: correct, incorrect and partial SATA feedback all show explanations inline under
|
||
their options. Results group explanations with each question. Screenshot is ignored at
|
||
`.test-data/rationale-check/correct-inline.png`. The temporary test server is stopped after QA.
|
||
|
||
## Fresh UI QA findings
|
||
|
||
Terra tested through Edge in an isolated volume on port 3731. Observed successful login,
|
||
class creation, quiz/question editing, practice start, save/exit, resume, answer check and
|
||
100% results; deck/card creation, browse flip, FSRS review, pasted question import; desktop
|
||
and emulated 400×933 mobile layouts in both themes. No obvious clipping or overlap observed
|
||
on those screens. The test server was stopped and the temporary password removed.
|
||
|
||
Visual finding: secondary labels appeared faint, particularly in dark mode. Adjusted the
|
||
shared `ink-3` colors. Computed WCAG contrast against paper/surface/sunken backgrounds:
|
||
light now **5.15 / 5.38 / 4.76** (previously 3.48 / 3.63 / 3.21); dark now
|
||
**7.42 / 6.86 / 7.71**. These ratios cover these token pairs, not a full accessibility audit.
|
||
|
||
Screenshots remain ignored under `.test-data/ui-terra/`: desktop-dark-quiz.png,
|
||
desktop-light-quiz.png, mobile-dark-quiz.png, mobile-light-quiz.png and mobile-light-session.png.
|
||
Post-fix Terra recheck: desktop light/dark screenshots show improved secondary-text legibility
|
||
(`postfix-dark-desktop.png`, `postfix-light-desktop.png`). An Edge InPrivate visitor opened
|
||
the isolated shared quiz without login, completed practice, saw its rationale and reached
|
||
100% results. Shared-deck UI, long-label layout stress tests and post-fix mobile contrast were
|
||
not revisited in this follow-up. Public deck data isolation/revocation is covered by API tests.
|
||
No known functional failures were found in the UI paths exercised. This is sampled QA, not
|
||
an exhaustive audit of every layout and browser. Terra's isolated server is stopped.
|