docs: Update architecture and README for file uploads and activity logging
Some checks failed
CI / skip-ci-check (pull_request) Successful in 1m23s
CI / lint-and-type-check (pull_request) Failing after 1m43s
CI / test (pull_request) Successful in 1m51s
CI / build (pull_request) Successful in 1m52s
CI / secret-scanning (pull_request) Successful in 1m24s
CI / dependency-scan (pull_request) Successful in 1m28s
CI / sast-scan (pull_request) Successful in 2m28s
CI / workflow-summary (pull_request) Successful in 1m21s

- Revised architecture documentation to reflect changes in file upload handling, including new API routes and activity logging features.
- Updated README with deployment notes, file upload instructions, and monitoring activity logs.
- Clarified the use of `proxy.ts` for route protection in Next.js 16 and detailed the logging of user activities for both authenticated and unauthenticated requests.
This commit is contained in:
ilia 2026-01-04 16:27:35 -05:00
parent 91adbab487
commit 889acd0bbd
2 changed files with 99 additions and 13 deletions

View File

@ -26,16 +26,19 @@ mirrormatch/
│ ├── Navigation.tsx # Navigation bar (client component) │ ├── Navigation.tsx # Navigation bar (client component)
│ └── [others] # Form components, UI components │ └── [others] # Form components, UI components
├── lib/ # Utility libraries and helpers ├── lib/ # Utility libraries and helpers
│ ├── prisma.ts # Prisma client singleton │ ├── prisma.ts # Prisma client singleton (lazy initialization)
│ ├── auth.ts # NextAuth configuration │ ├── auth.ts # NextAuth configuration
│ ├── email.ts # Email sending utilities │ ├── email.ts # Email sending utilities
│ └── utils.ts # Helper functions (hashing, etc.) │ ├── utils.ts # Helper functions (hashing, etc.)
│ └── activity-log.ts # Activity logging utility
├── prisma/ # Database schema and migrations ├── prisma/ # Database schema and migrations
│ ├── schema.prisma # Prisma schema definition │ ├── schema.prisma # Prisma schema definition
│ └── seed.ts # Database seeding script │ └── seed.ts # Database seeding script
├── types/ # TypeScript type definitions ├── types/ # TypeScript type definitions
│ └── next-auth.d.ts # NextAuth type extensions │ └── next-auth.d.ts # NextAuth type extensions
└── middleware.ts # Next.js middleware for route protection ├── proxy.ts # Next.js proxy/middleware for route protection (Next.js 16)
└── lib/
└── activity-log.ts # Activity logging utility
``` ```
## Data Model ## Data Model
@ -153,21 +156,31 @@ model Guess {
### Route Protection ### Route Protection
**Location:** `middleware.ts` **Location:** `proxy.ts` (Next.js 16 uses `proxy.ts` instead of `middleware.ts`)
**Public Routes:** **Public Routes:**
- `/login` - `/login`
- `/api/auth/*` (NextAuth endpoints) - `/api/auth/*` (NextAuth endpoints)
- `/uploads/*` (uploaded files - legacy, now served via API)
- `/api/uploads/*` (uploaded files served via API route)
**Protected Routes:** **Protected Routes:**
- All other routes require authentication - All other routes require authentication
- `/admin/*` routes additionally require `role === "ADMIN"` - `/admin/*` routes additionally require `role === "ADMIN"`
**Implementation:** **Implementation:**
- Uses NextAuth `withAuth` middleware - Uses NextAuth `getToken` from `next-auth/jwt` in Edge runtime
- Checks JWT token on each request - Checks JWT token on each request via `proxy.ts`
- Redirects unauthenticated users to `/login` - Explicitly specifies cookie name: `__Secure-authjs.session-token`
- Redirects unauthenticated users to `/login` with `callbackUrl`
- Redirects non-admin users trying to access admin routes to home - Redirects non-admin users trying to access admin routes to home
- Logs all user activity (page visits, API calls)
**Activity Logging:**
- All authenticated requests are logged with user info, IP, path, method
- Unauthenticated access attempts are also logged
- Photo uploads and guess submissions have dedicated activity logs
- Logs format: `[ACTIVITY] timestamp | method path | User: email (role) | IP: ip`
## Application Flows ## Application Flows
@ -219,16 +232,37 @@ model Guess {
**Flow:** **Flow:**
1. User navigates to `/upload` 1. User navigates to `/upload`
2. Enters photo URL and answer name 2. Uploads photo file or enters photo URL and answer name
3. Form submits to `POST /api/photos` 3. Form submits to `POST /api/photos/upload` (file upload) or `POST /api/photos` (URL)
4. API route: 4. API route:
- Verifies session - Verifies session
- Creates Photo record with `uploaderId`, `url`, `answerName` - For file uploads:
- Validates file type and size (max 10MB)
- Calculates SHA256 hash for duplicate detection
- Generates unique filename: `timestamp-randomstring.extension`
- Saves file to `public/uploads/` directory
- Sets photo URL to `/api/uploads/[filename]`
- For URL uploads:
- Validates URL format
- Checks for duplicate URLs
- Uses provided URL directly
- Creates Photo record with `uploaderId`, `url`, `answerName`, `fileHash`
- Queries all other users (excluding uploader) - Queries all other users (excluding uploader)
- Sends email notifications to all other users (async, non-blocking) - Sends email notifications to all other users (async, non-blocking)
- Logs activity: `[PHOTO_UPLOAD]`
5. User redirected to photo detail page 5. User redirected to photo detail page
**API Route:** `app/api/photos/route.ts` **API Routes:**
- `app/api/photos/upload/route.ts` - File upload endpoint
- `app/api/photos/route.ts` - URL upload endpoint (legacy)
- `app/api/uploads/[filename]/route.ts` - Serves uploaded files
**File Storage:**
- Files stored in `public/uploads/` directory
- Served via `/api/uploads/[filename]` API route
- Files verified after write to ensure successful save
- Duplicate detection via SHA256 hash
**Email:** `lib/email.ts` - `sendNewPhotoEmail()` **Email:** `lib/email.ts` - `sendNewPhotoEmail()`
**Page:** `app/upload/page.tsx` (client component) **Page:** `app/upload/page.tsx` (client component)
@ -260,10 +294,13 @@ model Guess {
4. API route: 4. API route:
- Verifies session - Verifies session
- Checks if user already has correct guess (prevent duplicate points) - Checks if user already has correct guess (prevent duplicate points)
- Prevents users from guessing their own photos
- Normalizes guess text and answer (trim, lowercase) - Normalizes guess text and answer (trim, lowercase)
- Compares normalized strings - Compares normalized strings
- Creates Guess record with `correct` boolean - Creates Guess record with `correct` boolean
- If correct: increments user's points by 1 - If correct: increments user's points by photo's `points` value
- If wrong and penalty enabled: deducts penalty points
- Logs activity: `[GUESS_SUBMIT]` with result
5. Page refreshes to show feedback 5. Page refreshes to show feedback
**API Route:** `app/api/photos/[photoId]/guess/route.ts` **API Route:** `app/api/photos/[photoId]/guess/route.ts`
@ -274,6 +311,7 @@ model Guess {
- Case-insensitive comparison - Case-insensitive comparison
- Trims whitespace - Trims whitespace
- Exact match required (no fuzzy matching) - Exact match required (no fuzzy matching)
- Points awarded based on photo's `points` field (default: 1)
### 7. Leaderboard ### 7. Leaderboard

View File

@ -153,6 +153,26 @@ npm run build
npm start npm start
``` ```
### Deployment Notes
**Important Configuration:**
- Ensure `NODE_ENV=production` is set in production
- Set `NEXTAUTH_URL` to your production domain (e.g., `https://yourdomain.com`)
- Set `AUTH_TRUST_HOST=true` if using reverse proxy
- Ensure `DATABASE_URL` points to your production database
- Files are stored in `public/uploads/` directory - ensure this directory persists across deployments
**File Uploads:**
- Photos are uploaded to `public/uploads/` directory
- Files are served via `/api/uploads/[filename]` API route
- Ensure the uploads directory has proper write permissions
- Files are stored on the filesystem (not in database)
**Monitoring Activity:**
- User activity is logged to console/systemd logs
- Watch logs in real-time: `sudo journalctl -u app-backend -f | grep -E "\[ACTIVITY\]|\[PHOTO_UPLOAD\]|\[GUESS_SUBMIT\]"`
- Activity logs include: page visits, photo uploads, guess submissions
## Database Commands ## Database Commands
- `npm run db:generate` - Generate Prisma Client - `npm run db:generate` - Generate Prisma Client
@ -161,6 +181,18 @@ npm start
- `npm run db:studio` - Open Prisma Studio (database GUI) - `npm run db:studio` - Open Prisma Studio (database GUI)
- `npm run db:seed` - Seed database with initial admin user - `npm run db:seed` - Seed database with initial admin user
### Querying the Database
**Get all photo answers:**
```bash
psql "postgresql://user:password@host:5432/database" -c "SELECT \"answerName\" FROM \"Photo\" ORDER BY \"createdAt\" DESC;"
```
**Get answers with uploader info:**
```bash
psql "postgresql://user:password@host:5432/database" -c "SELECT p.\"answerName\", p.url, u.name as uploader, p.\"createdAt\" FROM \"Photo\" p JOIN \"User\" u ON p.\"uploaderId\" = u.id ORDER BY p.\"createdAt\" DESC;"
```
## Creating the First Admin User ## Creating the First Admin User
The seed script automatically creates an admin user. If you need to create one manually: The seed script automatically creates an admin user. If you need to create one manually:
@ -210,9 +242,12 @@ mirrormatch/
- View user points and roles - View user points and roles
### Photo Upload (`/upload`) ### Photo Upload (`/upload`)
- Upload photos via URL - Upload photos via file upload or URL
- Files are stored in `public/uploads/` directory
- Files are served via `/api/uploads/[filename]` API route
- Set answer name for guessing - Set answer name for guessing
- Automatically sends email notifications to all other users - Automatically sends email notifications to all other users
- Duplicate file detection (SHA256 hash)
### Photo Guessing (`/photos/[id]`) ### Photo Guessing (`/photos/[id]`)
- View photo and uploader info - View photo and uploader info
@ -269,7 +304,20 @@ Set up SMTP credentials in `.env`:
### Authentication Issues ### Authentication Issues
- Verify `NEXTAUTH_SECRET` is set - Verify `NEXTAUTH_SECRET` is set
- Check `NEXTAUTH_URL` matches your app URL - Check `NEXTAUTH_URL` matches your app URL
- Set `AUTH_TRUST_HOST=true` if using reverse proxy
- Clear browser cookies if needed - Clear browser cookies if needed
- Check middleware logs: `sudo journalctl -u app-backend | grep "Middleware"`
### Photo Upload Issues
- Verify `public/uploads/` directory exists and has write permissions
- Check file upload logs: `sudo journalctl -u app-backend | grep "UPLOAD"`
- Ensure files are being saved: check `public/uploads/` directory
- Files are served via `/api/uploads/[filename]` - verify API route is accessible
### Build Issues
- If build fails with `DATABASE_URL not set`, this is expected - Prisma initialization is lazy
- Ensure all environment variables are set in production
- Check for TypeScript errors: `npm run type-check`
## Documentation ## Documentation