John O'Keefe
6457fbaf72
The design parked in the handoff (multi-tier stats off reading_history; bookorbit-style in data, not looks) is in. The real prerequisite work was data: reading_history existed but NOTHING wrote to it — the whole stats feature was sitting on an empty table. - CAPTURE (no client changes, no repo-boundary crossings): every successful progress write through SaveProgress (KOReader + app + web + Kobo + offline queue — the one chokepoint) now records one reading_history session row: span = the interval since the PREVIOUS write instant, pages = positive page delta when both sides know the page index, marker rows for first contact. Spans over 2h are kept as zero-second markers (overnight suspend→resume, offline flushes must not inflate totals) — the honest 'sync cadence, not a stopwatch' caveat stays. device_id only when a REAL device row matches (the web/app progress path historically stuffs the USER id into DeviceID — probe instead of trusting it; FK violation would silently drop every capture). Source preserved in device_metadata. - API: /api/stats/summary?range=7|30|90|year (totals, zero-filled daily arrays, streaks, most-active day/weekday, top books, library breakdown — one call), /api/stats/this-week (widget: rolling 7d vs previous + streak), /api/stats/books/:id (lifetime + recent sessions). All bucketed in the user's timezone; finished ≡ any push ≥0.995; visible-library lens enforced at source. Legacy /api/analytics/* kept untouched. Range windows anchor end-of-day to the START of today (blasting the clock time into tomorrow resolved 'today' a calendar day late — found by the streak test). - /stats page (sidebar Stats between Progress and Devices, previously /analytics was an orphan): range selector, five stat cards, two Chart.js v4 charts (daily minutes bar, pages/day line — chunked via dynamic import so main.js stays untouched), per-library breakdown, most-read list, empty-state explainer. /analytics now 301s to /stats. The orphaned analytics.templ + analytics.ts removed (their containers and the page JSON never matched; the page was astub). - Dashboard 'This Week' widget (server-rendered, suppressed on service failure) and the book detail 'Your Reading Stats' card (lifetime totals of the viewer's own sessions) complete the tiers: per-user default, per-library breakdown inline, per-book on the page, per-system/admin aggregate parked as before. Tests: statistics_test.go (capture semantics at the chokepoint, tz/day buckets, zero-fill, streak math, finished detection, range validation, auth gate, widget, per-book lifetime). Full suite PASS.
26 lines
962 B
Go
26 lines
962 B
Go
package router
|
|
|
|
func registerAnalyticsRoutes(cfg *Config) {
|
|
e := cfg.Echo
|
|
|
|
// JWT middleware for protected routes
|
|
jwtMiddleware := createJWTMiddleware(cfg)
|
|
|
|
protected := e.Group("/api", jwtMiddleware)
|
|
|
|
// Analytics routes (legacy shape; kept for existing API consumers —
|
|
// the web UI moved to /stats)
|
|
analytics := protected.Group("/analytics")
|
|
analytics.GET("/reading-stats", cfg.AnalyticsHandler.GetReadingStats)
|
|
analytics.GET("/device-usage", cfg.AnalyticsHandler.GetDeviceUsage)
|
|
analytics.GET("/popular-books", cfg.AnalyticsHandler.GetPopularBooks)
|
|
|
|
// Reading-statistics API (/stats page + dashboard widget + per-book
|
|
// card). Same session seed, service-backed aggregates, user-timezone
|
|
// bucketing. The legacy /analytics page redirects to /stats.
|
|
stats := protected.Group("/stats")
|
|
stats.GET("/summary", cfg.StatsHandler.Summary)
|
|
stats.GET("/this-week", cfg.StatsHandler.ThisWeek)
|
|
stats.GET("/books/:id", cfg.StatsHandler.BookStats)
|
|
}
|