# 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
210 lines
4.7 KiB
TypeScript
210 lines
4.7 KiB
TypeScript
import { logActivity } from '@/lib/activity-log';
|
|
import { logger } from '@/lib/logger';
|
|
|
|
// Mock the logger
|
|
jest.mock('@/lib/logger', () => ({
|
|
logger: {
|
|
info: jest.fn(),
|
|
debug: jest.fn(),
|
|
warn: jest.fn(),
|
|
error: jest.fn(),
|
|
},
|
|
}));
|
|
|
|
// Helper to create a mock Request object
|
|
function createMockRequest(headers: Record<string, string> = {}): Request {
|
|
const mockHeaders = new Headers();
|
|
Object.entries(headers).forEach(([key, value]) => {
|
|
mockHeaders.set(key, value);
|
|
});
|
|
|
|
return {
|
|
headers: mockHeaders,
|
|
} as unknown as Request;
|
|
}
|
|
|
|
describe('activity-log', () => {
|
|
beforeEach(() => {
|
|
jest.clearAllMocks();
|
|
});
|
|
|
|
describe('logActivity', () => {
|
|
it('should create activity log with all fields', () => {
|
|
const mockRequest = createMockRequest({
|
|
'x-forwarded-for': '192.168.1.1',
|
|
});
|
|
|
|
const user = {
|
|
id: 'user-123',
|
|
email: 'test@example.com',
|
|
role: 'USER',
|
|
};
|
|
|
|
const details = { photoId: 'photo-456' };
|
|
|
|
const result = logActivity(
|
|
'PHOTO_UPLOAD',
|
|
'/api/photos/upload',
|
|
'POST',
|
|
user,
|
|
details,
|
|
mockRequest
|
|
);
|
|
|
|
expect(result).toMatchObject({
|
|
action: 'PHOTO_UPLOAD',
|
|
path: '/api/photos/upload',
|
|
method: 'POST',
|
|
userId: 'user-123',
|
|
userEmail: 'test@example.com',
|
|
userRole: 'USER',
|
|
ip: '192.168.1.1',
|
|
details: { photoId: 'photo-456' },
|
|
});
|
|
expect(result.timestamp).toBeDefined();
|
|
});
|
|
|
|
it('should handle unauthenticated users', () => {
|
|
const result = logActivity(
|
|
'PAGE_VIEW',
|
|
'/photos',
|
|
'GET',
|
|
null,
|
|
undefined,
|
|
undefined
|
|
);
|
|
|
|
expect(result).toMatchObject({
|
|
action: 'PAGE_VIEW',
|
|
path: '/photos',
|
|
method: 'GET',
|
|
userId: undefined,
|
|
userEmail: undefined,
|
|
userRole: undefined,
|
|
ip: 'unknown',
|
|
});
|
|
});
|
|
|
|
it('should extract IP from x-forwarded-for header', () => {
|
|
const mockRequest = createMockRequest({
|
|
'x-forwarded-for': '192.168.1.1, 10.0.0.1',
|
|
});
|
|
|
|
const result = logActivity(
|
|
'ACTION',
|
|
'/path',
|
|
'GET',
|
|
undefined,
|
|
undefined,
|
|
mockRequest
|
|
);
|
|
|
|
expect(result.ip).toBe('192.168.1.1');
|
|
});
|
|
|
|
it('should extract IP from x-real-ip header when x-forwarded-for is missing', () => {
|
|
const mockRequest = createMockRequest({
|
|
'x-real-ip': '10.0.0.1',
|
|
});
|
|
|
|
const result = logActivity(
|
|
'ACTION',
|
|
'/path',
|
|
'GET',
|
|
undefined,
|
|
undefined,
|
|
mockRequest
|
|
);
|
|
|
|
expect(result.ip).toBe('10.0.0.1');
|
|
});
|
|
|
|
it('should use "unknown" for IP when no headers are present', () => {
|
|
const mockRequest = createMockRequest();
|
|
|
|
const result = logActivity(
|
|
'ACTION',
|
|
'/path',
|
|
'GET',
|
|
undefined,
|
|
undefined,
|
|
mockRequest
|
|
);
|
|
|
|
expect(result.ip).toBe('unknown');
|
|
});
|
|
|
|
it('should call logger.info with structured data', () => {
|
|
const user = {
|
|
id: 'user-123',
|
|
email: 'test@example.com',
|
|
role: 'USER',
|
|
};
|
|
|
|
const details = { photoId: 'photo-456' };
|
|
|
|
logActivity(
|
|
'PHOTO_UPLOAD',
|
|
'/api/photos/upload',
|
|
'POST',
|
|
user,
|
|
details
|
|
);
|
|
|
|
expect(logger.info).toHaveBeenCalledWith(
|
|
'Activity: PHOTO_UPLOAD',
|
|
expect.objectContaining({
|
|
method: 'POST',
|
|
path: '/api/photos/upload',
|
|
userId: 'user-123',
|
|
userEmail: 'test@example.com',
|
|
userRole: 'USER',
|
|
details: { photoId: 'photo-456' },
|
|
})
|
|
);
|
|
});
|
|
|
|
it('should not include details in logger call when details are not provided', () => {
|
|
const user = {
|
|
id: 'user-123',
|
|
email: 'test@example.com',
|
|
role: 'USER',
|
|
};
|
|
|
|
logActivity(
|
|
'PAGE_VIEW',
|
|
'/photos',
|
|
'GET',
|
|
user
|
|
);
|
|
|
|
expect(logger.info).toHaveBeenCalledWith(
|
|
'Activity: PAGE_VIEW',
|
|
expect.objectContaining({
|
|
method: 'GET',
|
|
path: '/photos',
|
|
userId: 'user-123',
|
|
userEmail: 'test@example.com',
|
|
userRole: 'USER',
|
|
})
|
|
);
|
|
|
|
const callArgs = (logger.info as jest.Mock).mock.calls[0][1];
|
|
expect(callArgs).not.toHaveProperty('details');
|
|
});
|
|
|
|
it('should handle empty details object', () => {
|
|
const result = logActivity(
|
|
'ACTION',
|
|
'/path',
|
|
'GET',
|
|
undefined,
|
|
{}
|
|
);
|
|
|
|
expect(result.details).toEqual({});
|
|
expect(logger.info).toHaveBeenCalled();
|
|
});
|
|
});
|
|
});
|