# 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
97 lines
3.5 KiB
TypeScript
97 lines
3.5 KiB
TypeScript
import { auth } from "@/lib/auth"
|
|
import { NextResponse } from "next/server"
|
|
import { cookies } from "next/headers"
|
|
import { SESSION_COOKIE_NAME } from "@/lib/constants"
|
|
import { logger } from "@/lib/logger"
|
|
|
|
/**
|
|
* Debug endpoint for session inspection
|
|
* ADMIN ONLY - Protected endpoint for debugging session issues
|
|
*
|
|
* This endpoint should only be accessible to administrators.
|
|
* Consider removing in production or restricting further.
|
|
*/
|
|
export async function GET(request: Request) {
|
|
try {
|
|
// Require admin authentication
|
|
const session = await auth()
|
|
|
|
if (!session || session.user.role !== "ADMIN") {
|
|
logger.warn("Unauthorized access attempt to debug endpoint", {
|
|
userId: session?.user?.id,
|
|
userRole: session?.user?.role,
|
|
path: "/api/debug/session",
|
|
})
|
|
return NextResponse.json({ error: "Unauthorized" }, { status: 401 })
|
|
}
|
|
const cookieHeader = request.headers.get("cookie") || ""
|
|
|
|
// Parse cookies from header first
|
|
const cookieMap: Record<string, string> = {}
|
|
cookieHeader.split(";").forEach(cookie => {
|
|
const [key, value] = cookie.trim().split("=")
|
|
if (key && value) {
|
|
cookieMap[key] = decodeURIComponent(value)
|
|
}
|
|
})
|
|
|
|
// Try to get session token from cookies
|
|
const sessionTokenFromHeader = cookieMap[SESSION_COOKIE_NAME] || "NOT FOUND"
|
|
|
|
// Try to call auth() again for debugging (we already have session above, but this is for testing)
|
|
let authError = null
|
|
try {
|
|
// Already called above, but keeping for backward compatibility in response
|
|
logger.debug("Debug endpoint: Session retrieved", {
|
|
hasSession: !!session,
|
|
userId: session?.user?.id,
|
|
userRole: session?.user?.role,
|
|
})
|
|
} catch (err) {
|
|
authError = err instanceof Error ? err.message : String(err)
|
|
logger.error("Debug endpoint: auth() error", {
|
|
error: err instanceof Error ? err : new Error(String(err)),
|
|
})
|
|
}
|
|
|
|
// Try to get cookie from Next.js cookie store
|
|
let sessionTokenFromStore = "NOT ACCESSIBLE"
|
|
try {
|
|
const cookieStore = await cookies()
|
|
sessionTokenFromStore = cookieStore.get(SESSION_COOKIE_NAME)?.value || "NOT FOUND"
|
|
} catch {
|
|
// Cookie store might not be accessible in all contexts
|
|
}
|
|
|
|
return NextResponse.json({
|
|
hasSession: !!session,
|
|
session: session ? {
|
|
user: session.user,
|
|
expires: session.expires,
|
|
} : null,
|
|
authError,
|
|
cookies: {
|
|
sessionTokenInHeader: sessionTokenFromHeader !== "NOT FOUND",
|
|
sessionTokenInStore: sessionTokenFromStore !== "NOT FOUND" && sessionTokenFromStore !== "NOT ACCESSIBLE",
|
|
sessionTokenPreview: sessionTokenFromHeader !== "NOT FOUND" ? `${sessionTokenFromHeader.substring(0, 30)}...` : "NOT FOUND",
|
|
allCookieKeys: Object.keys(cookieMap),
|
|
cookieHeaderLength: cookieHeader.length,
|
|
cookieHeaderPreview: cookieHeader.substring(0, 200),
|
|
},
|
|
env: {
|
|
hasSecret: !!process.env.NEXTAUTH_SECRET,
|
|
nextAuthUrl: process.env.NEXTAUTH_URL,
|
|
nodeEnv: process.env.NODE_ENV,
|
|
authTrustHost: process.env.AUTH_TRUST_HOST,
|
|
secretLength: process.env.NEXTAUTH_SECRET?.length || 0,
|
|
secretPreview: process.env.NEXTAUTH_SECRET ? `${process.env.NEXTAUTH_SECRET.substring(0, 10)}...` : "missing",
|
|
}
|
|
})
|
|
} catch (error) {
|
|
return NextResponse.json({
|
|
error: error instanceof Error ? error.message : "Unknown error",
|
|
stack: error instanceof Error ? error.stack : undefined
|
|
}, { status: 500 })
|
|
}
|
|
}
|