# Structured Logging System Implementation ## Summary Implements a comprehensive structured logging system to replace verbose console.* calls throughout the codebase, addressing all cleanup tasks from CLEANUP.md. ## What Changed ### Core Features - ✅ **Structured Logging System** - New `lib/logger.ts` with DEBUG, INFO, WARN, ERROR levels - ✅ **Environment-Based Control** - `LOG_LEVEL` env var controls verbosity (DEBUG/INFO/WARN/ERROR/NONE) - ✅ **JSON Logging Option** - `LOG_FORMAT=json` for structured JSON output - ✅ **Shared Constants** - Extracted session cookie name to `lib/constants.ts` ### Code Refactoring - ✅ Replaced all `console.*` calls in API routes with structured logger - ✅ Refactored `activity-log.ts` to use new logger system - ✅ Reduced verbose logging in auth, photos page, and upload routes - ✅ Updated proxy.ts to use structured logging - ✅ Removed unused legacy `/api/photos` route (replaced by `/api/photos/upload`) ### Security Improvements - ✅ Protected `/api/debug/session` endpoint with admin-only access - ✅ Added proper error logging with structured context ### Documentation - ✅ Documented multiple upload routes usage - ✅ Enhanced watch-activity.sh script documentation - ✅ Updated README.md with upload endpoint information - ✅ Added configuration documentation to next.config.ts ### Testing - ✅ Added 23 tests for logger system - ✅ Added 8 tests for refactored activity-log - ✅ All 43 tests passing ## Benefits 1. **Production-Ready Logging** - Environment-based control, defaults to INFO in production 2. **Reduced Verbosity** - DEBUG logs only show in development or when explicitly enabled 3. **Structured Output** - JSON format option for log aggregation tools 4. **Better Organization** - Shared constants, consistent logging patterns 5. **Improved Security** - Debug endpoint now requires admin access ## Testing ### Manual Testing - ✅ Server builds successfully - ✅ All tests pass (43/43) - ✅ Type checking passes - ✅ Linting passes - ✅ Production server runs with logs visible - ✅ Log levels work correctly (DEBUG shows all, INFO shows activity, etc.) ### Test Coverage - Logger system: 100% coverage - Activity log: 100% coverage - All existing tests still pass ## Configuration ### Environment Variables ```bash # Control log verbosity (DEBUG, INFO, WARN, ERROR, NONE) LOG_LEVEL=INFO # Use structured JSON logging LOG_FORMAT=json ``` ### Defaults - Development: `LOG_LEVEL=DEBUG` (shows all logs) - Production: `LOG_LEVEL=INFO` (shows activity and above) ## Migration Notes - No breaking changes (legacy route was unused) - All existing functionality preserved - Logs are now structured and filterable - Debug endpoint now requires admin authentication - Legacy `/api/photos` endpoint removed (use `/api/photos/upload` instead) ## Checklist - [x] All console.* calls replaced in API routes - [x] Logger system implemented with tests - [x] Activity logging refactored - [x] Debug endpoint protected - [x] Documentation updated - [x] All tests passing - [x] Type checking passes - [x] Linting passes - [x] Build succeeds - [x] Manual testing completed ## Related Issues Addresses cleanup tasks from CLEANUP.md: - Task 1: Verbose logging in production ✅ - Task 2: Activity logging optimization ✅ - Task 3: Upload verification logging ✅ - Task 4: Middleware debug logging ✅ - Task 5: Legacy upload route documentation ✅ - Task 6: Multiple upload routes documentation ✅ - Task 7: Cookie name constant extraction ✅ - Task 8: Next.js config documentation ✅ - Task 9: ARCHITECTURE.md (already correct) ✅ - Task 10: Watch activity script documentation ✅ Reviewed-on: #4
71 lines
1.8 KiB
TypeScript
71 lines
1.8 KiB
TypeScript
/**
|
|
* Activity logging utility for tracking user actions
|
|
* Uses structured logging with log levels for better production control
|
|
*/
|
|
|
|
import { logger } from './logger'
|
|
|
|
export interface ActivityLog {
|
|
timestamp: string
|
|
userId?: string
|
|
userEmail?: string
|
|
userRole?: string
|
|
action: string
|
|
path: string
|
|
method: string
|
|
ip?: string
|
|
details?: Record<string, unknown>
|
|
}
|
|
|
|
/**
|
|
* Log user activity with structured data
|
|
* Uses INFO level logging - can be filtered via LOG_LEVEL environment variable
|
|
*
|
|
* @param action - The action being performed (e.g., "PHOTO_UPLOAD", "GUESS_SUBMITTED")
|
|
* @param path - The request path
|
|
* @param method - The HTTP method
|
|
* @param user - Optional user object (id, email, role)
|
|
* @param details - Optional additional context data
|
|
* @param request - Optional Request object for extracting IP address
|
|
* @returns Structured activity log object
|
|
*/
|
|
export function logActivity(
|
|
action: string,
|
|
path: string,
|
|
method: string,
|
|
user?: { id: string; email: string; role: string } | null,
|
|
details?: Record<string, unknown>,
|
|
request?: Request
|
|
): ActivityLog {
|
|
const timestamp = new Date().toISOString()
|
|
const ip = request?.headers.get("x-forwarded-for") ||
|
|
request?.headers.get("x-real-ip") ||
|
|
"unknown"
|
|
|
|
const log: ActivityLog = {
|
|
timestamp,
|
|
userId: user?.id,
|
|
userEmail: user?.email,
|
|
userRole: user?.role,
|
|
action,
|
|
path,
|
|
method,
|
|
ip: ip.split(",")[0].trim(), // Get first IP if multiple
|
|
details
|
|
}
|
|
|
|
// Use structured logging with INFO level
|
|
// This allows filtering via LOG_LEVEL environment variable
|
|
logger.info(`Activity: ${action}`, {
|
|
method,
|
|
path,
|
|
userId: user?.id,
|
|
userEmail: user?.email,
|
|
userRole: user?.role,
|
|
ip: ip.split(",")[0].trim(),
|
|
...(details && { details }),
|
|
})
|
|
|
|
return log
|
|
}
|