Skip to content

Latest commit

 

History

History
57 lines (46 loc) · 2.56 KB

dashboard.md

File metadata and controls

57 lines (46 loc) · 2.56 KB

Feature: Dashboard

Purpose

Provide an at-a-glance overview of file storage usage and recent upload activity.

Used By

  • UI: / page (dashboard home)
  • API: GET /files/stats, GET /files, GET /files/stats/activity

Core Functions

  • apps/web/src/components/dashboard/stats-cards.tsx — 4 stat cards
  • apps/web/src/components/dashboard/recent-uploads-table.tsx — last 10 uploads
  • apps/web/src/components/dashboard/upload-chart.tsx — bar chart of uploads per day
  • apps/web/src/lib/api-client.ts — getFileStats(), getFiles(), getUploadActivity()
  • services/api/app/runtime/files.py — GET /files/stats handler
  • services/api/app/service/files.py — get_stats() business logic
  • services/api/app/repo/b2_client.py — get_upload_stats() data access

Canonical Files

  • Dashboard page layout: apps/web/src/components/dashboard/stats-cards.tsx
  • Stats service logic: services/api/app/service/files.py

Inputs

  • None (dashboard loads data automatically)

Outputs

  • GET /files/stats → UploadStats (total_files, total_size_bytes, total_size_human, uploads_today, total_downloads)
  • GET /files (limit 10) → FileMetadata[] for recent uploads table (sorted newest-first)
  • GET /files/stats/activity?days=7 → DailyUploadCount[] for chart (server-side aggregation)

Flow

  • Page loads → three parallel API calls (stats, recent files, upload activity)
  • Stats cards display total files, storage used, uploads today, total downloads
  • Upload chart displays server-aggregated daily counts for last 7 days as bar chart
  • Recent uploads table shows last 10 files with filename, size, type, date, status badge

Edge Cases

  • API unavailable → stats default to zeros, table shows empty state
  • No files uploaded → empty chart message, empty table message
  • Large file count → stats endpoint paginates through all objects using ContinuationToken

UX States

  • Loading: skeleton placeholders for cards and table
  • Empty: "No files uploaded yet" / "No upload data available yet"
  • Loaded: populated cards, chart, table

Verification

  • Test files: services/api/tests/test_upload_activity.py, services/api/tests/test_recent_files.py
  • Required cases: stats with files, stats with empty bucket, API error fallback
  • Quick verify command: pnpm test:api
  • Full verify command: pnpm lint && pnpm lint:api && pnpm test:api && pnpm check:structure
  • Pass criteria: all pytest tests green, no ruff violations

Related Docs