All checks were successful
CI / skip-ci-check (pull_request) Successful in 1m23s
CI / lint-and-type-check (pull_request) Successful in 1m47s
CI / test (pull_request) Successful in 1m51s
CI / build (pull_request) Successful in 1m52s
CI / secret-scanning (pull_request) Successful in 1m25s
CI / dependency-scan (pull_request) Successful in 1m28s
CI / sast-scan (pull_request) Successful in 2m32s
CI / workflow-summary (pull_request) Successful in 1m22s
This document lists code and features that were added during development/debugging that might be candidates for cleanup or removal in the future. ## Debug/Development Code ### 1. Verbose Logging in Production **Location:** Multiple files **Status:** Consider reducing in production - `lib/auth.ts` - Session callback logging (lines 78-103, 105-113) - Logs full session details on every session creation - Could be reduced to warnings only or removed in production - `app/photos/page.tsx` - Page render logging (lines 12-33) - Logs auth() calls and session details - Useful for debugging but verbose for production - `app/api/debug/session/route.ts` - Entire debug endpoint - Created for debugging session issues - Consider removing or protecting with admin-only access - Or move to development-only route ### 2. Activity Logging **Location:** `lib/activity-log.ts`, `proxy.ts`, API routes **Status:** Keep but consider optimization - Activity logging is useful for monitoring - Consider: - Moving to structured logging (JSON format) - Adding log rotation/retention policies - Option to disable in production if not needed - Rate limiting logs to prevent spam ### 3. Upload Verification Logging **Location:** `app/api/photos/upload/route.ts` **Status:** Keep but reduce verbosity - Lines 89-91: Directory creation/existence logging - Lines 101: File save verification logging - Useful for debugging but could be reduced to errors only ### 4. Middleware Debug Logging **Location:** `proxy.ts` **Status:** Keep but consider reducing - Lines 22-37: Activity logging for all requests - Useful for monitoring but generates many logs - Consider: log only important events or add log level filtering ## Unused/Redundant Code ### 5. Legacy Upload Route **Location:** `app/api/photos/route.ts` **Status:** Consider deprecating - Legacy URL-based upload endpoint - New uploads use `/api/photos/upload` - Consider: - Marking as deprecated - Removing if not used - Or consolidating with upload route ### 6. Multiple Upload Routes **Location:** `app/api/photos/upload/route.ts` and `app/api/photos/upload-multiple/route.ts` **Status:** Keep but document usage - Two separate upload endpoints - Consider if both are needed or can be consolidated ### 7. Proxy.ts Cookie Name Variable **Location:** `proxy.ts` line 15 **Status:** Minor cleanup - `cookieName` variable defined but could use constant - Consider moving to shared constant or env var ## Configuration Cleanup ### 8. Next.js Config **Location:** `next.config.ts` **Status:** Review - Image optimization settings (line 19: `unoptimized: false`) - Consider if all remote patterns are needed - Review Turbopack configuration if not using ## Documentation Cleanup ### 10. ARCHITECTURE.md References **Location:** `ARCHITECTURE.md` line 156 **Status:** Update - Still references `middleware.ts` in some places - Should reference `proxy.ts` instead - Update all middleware references ## Testing/Debugging Utilities ### 11. Watch Activity Script **Location:** `watch-activity.sh` (if created) **Status:** Keep or document - Useful utility for monitoring - Consider adding to README or removing if not needed ## Recommendations ### High Priority (Consider Removing) 1. `app/api/debug/session/route.ts` - Debug endpoint (protect or remove) 2. Verbose logging in `app/photos/page.tsx` - Reduce to errors only 3. Update ARCHITECTURE.md middleware references ### Medium Priority (Optimize) 1. Activity logging - Add log levels or filtering 2. Upload logging - Reduce verbosity 3. Session callback logging - Reduce in production ### Low Priority (Keep) 1. Activity logging utility - Useful for monitoring 2. Multiple upload routes - Document usage 3. Watch activity script - Useful utility ## Notes - **Consider** adding environment-based log levels (DEBUG, INFO, WARN, ERROR) - **Consider** moving debug endpoints behind admin authentication - **Consider** adding log rotation/retention for production --- Do all these in stages. create new tests and test and docuemtn as u go. add DEBUG, INFO, WARN, ERROR flags and only show when asked for. create new branch.
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();
|
|
});
|
|
});
|
|
});
|