From bec7d57fafc30f61104c7a2ecb884ea7c45edbb0 Mon Sep 17 00:00:00 2001 From: Eshaan Date: Sat, 25 Oct 2025 12:13:03 +1100 Subject: [PATCH 1/8] Add last sync timestamp display feature - Add getTimeSinceLastSync utility function to format relative time - Store last sync timestamp in localStorage per user - Display "Last updated X ago" below Sync button - Auto-refresh display every 10 seconds - Add comprehensive tests for time formatting Fixes #124 --- .../components/HomeComponents/Tasks/Tasks.tsx | 72 +++++++++++++----- .../Tasks/__tests__/tasks-utils.test.ts | 73 +++++++++++++++++++ .../HomeComponents/Tasks/tasks-utils.ts | 23 ++++++ 3 files changed, 150 insertions(+), 18 deletions(-) diff --git a/frontend/src/components/HomeComponents/Tasks/Tasks.tsx b/frontend/src/components/HomeComponents/Tasks/Tasks.tsx index 5bbbbb49..c04061d9 100644 --- a/frontend/src/components/HomeComponents/Tasks/Tasks.tsx +++ b/frontend/src/components/HomeComponents/Tasks/Tasks.tsx @@ -45,6 +45,7 @@ import { Props, sortTasks, sortTasksById, + getTimeSinceLastSync, } from './tasks-utils'; import Pagination from './Pagination'; import { url } from '@/components/utils/URLs'; @@ -105,6 +106,7 @@ export const Tasks = ( ); const [isEditingTags, setIsEditingTags] = useState(false); const [searchTerm, setSearchTerm] = useState(''); + const [lastSyncTime, setLastSyncTime] = useState(null); // Debounced search handler const debouncedSearch = debounce((value: string) => { @@ -148,6 +150,24 @@ export const Tasks = ( } }, [_selectedTask]); + // Load last sync time from localStorage on mount + useEffect(() => { + const storedLastSyncTime = localStorage.getItem(`lastSyncTime_${props.email}`); + if (storedLastSyncTime) { + setLastSyncTime(parseInt(storedLastSyncTime, 10)); + } + }, [props.email]); + + // Update the displayed time every 10 seconds + useEffect(() => { + const interval = setInterval(() => { + // Force re-render by updating the state + setLastSyncTime((prevTime) => prevTime); + }, 10000); // Update every 10 seconds + + return () => clearInterval(interval); + }, []); + useEffect(() => { const fetchTasksForEmail = async () => { try { @@ -205,6 +225,12 @@ export const Tasks = ( setTasks(sortTasksById(updatedTasks, 'desc')); setTempTasks(sortTasksById(updatedTasks, 'desc')); }); + + // Store last sync timestamp + const currentTime = Date.now(); + localStorage.setItem(`lastSyncTime_${user_email}`, currentTime.toString()); + setLastSyncTime(currentTime); + toast.success(`Tasks synced successfully!`); } catch (error) { console.error('Error syncing tasks:', error); @@ -667,9 +693,14 @@ export const Tasks = ( - +
+ + + {getTimeSinceLastSync(lastSyncTime)} + +
@@ -1218,21 +1249,26 @@ export const Tasks = ( - +
+ + + {getTimeSinceLastSync(lastSyncTime)} + +
diff --git a/frontend/src/components/HomeComponents/Tasks/__tests__/tasks-utils.test.ts b/frontend/src/components/HomeComponents/Tasks/__tests__/tasks-utils.test.ts index eff910c0..feeb01fa 100644 --- a/frontend/src/components/HomeComponents/Tasks/__tests__/tasks-utils.test.ts +++ b/frontend/src/components/HomeComponents/Tasks/__tests__/tasks-utils.test.ts @@ -8,6 +8,7 @@ import { sortTasksById, markTaskAsCompleted, markTaskAsDeleted, + getTimeSinceLastSync, } from '../tasks-utils'; import { Task } from '@/components/utils/types'; @@ -278,3 +279,75 @@ describe('markTaskAsDeleted', () => { }); }); }); + +describe('getTimeSinceLastSync', () => { + let originalDateNow: () => number; + + beforeAll(() => { + originalDateNow = Date.now; + }); + + afterAll(() => { + Date.now = originalDateNow; + }); + + it('returns "Never synced" when lastSyncTimestamp is null', () => { + expect(getTimeSinceLastSync(null)).toBe('Never synced'); + }); + + it('returns correct message for seconds ago', () => { + const now = 1000000000000; + Date.now = jest.fn(() => now); + const lastSync = now - 30000; // 30 seconds ago + expect(getTimeSinceLastSync(lastSync)).toBe('Last updated 30 seconds ago'); + }); + + it('returns correct message for 1 second ago', () => { + const now = 1000000000000; + Date.now = jest.fn(() => now); + const lastSync = now - 1000; // 1 second ago + expect(getTimeSinceLastSync(lastSync)).toBe('Last updated 1 second ago'); + }); + + it('returns correct message for minutes ago', () => { + const now = 1000000000000; + Date.now = jest.fn(() => now); + const lastSync = now - 5 * 60 * 1000; // 5 minutes ago + expect(getTimeSinceLastSync(lastSync)).toBe('Last updated 5 minutes ago'); + }); + + it('returns correct message for 1 minute ago', () => { + const now = 1000000000000; + Date.now = jest.fn(() => now); + const lastSync = now - 60 * 1000; // 1 minute ago + expect(getTimeSinceLastSync(lastSync)).toBe('Last updated 1 minute ago'); + }); + + it('returns correct message for hours ago', () => { + const now = 1000000000000; + Date.now = jest.fn(() => now); + const lastSync = now - 3 * 60 * 60 * 1000; // 3 hours ago + expect(getTimeSinceLastSync(lastSync)).toBe('Last updated 3 hours ago'); + }); + + it('returns correct message for 1 hour ago', () => { + const now = 1000000000000; + Date.now = jest.fn(() => now); + const lastSync = now - 60 * 60 * 1000; // 1 hour ago + expect(getTimeSinceLastSync(lastSync)).toBe('Last updated 1 hour ago'); + }); + + it('returns correct message for days ago', () => { + const now = 1000000000000; + Date.now = jest.fn(() => now); + const lastSync = now - 2 * 24 * 60 * 60 * 1000; // 2 days ago + expect(getTimeSinceLastSync(lastSync)).toBe('Last updated 2 days ago'); + }); + + it('returns correct message for 1 day ago', () => { + const now = 1000000000000; + Date.now = jest.fn(() => now); + const lastSync = now - 24 * 60 * 60 * 1000; // 1 day ago + expect(getTimeSinceLastSync(lastSync)).toBe('Last updated 1 day ago'); + }); +}); diff --git a/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts b/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts index ace7fc9e..eedcecfb 100644 --- a/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts +++ b/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts @@ -143,3 +143,26 @@ export const handleDate = (v: string) => { } return true; }; + +export const getTimeSinceLastSync = (lastSyncTimestamp: number | null): string => { + if (!lastSyncTimestamp) { + return 'Never synced'; + } + + const now = Date.now(); + const diffMs = now - lastSyncTimestamp; + const diffSeconds = Math.floor(diffMs / 1000); + const diffMinutes = Math.floor(diffSeconds / 60); + const diffHours = Math.floor(diffMinutes / 60); + const diffDays = Math.floor(diffHours / 24); + + if (diffSeconds < 60) { + return `Last updated ${diffSeconds} second${diffSeconds !== 1 ? 's' : ''} ago`; + } else if (diffMinutes < 60) { + return `Last updated ${diffMinutes} minute${diffMinutes !== 1 ? 's' : ''} ago`; + } else if (diffHours < 24) { + return `Last updated ${diffHours} hour${diffHours !== 1 ? 's' : ''} ago`; + } else { + return `Last updated ${diffDays} day${diffDays !== 1 ? 's' : ''} ago`; + } +}; From 0adc1ee377080e4bbd42d0aa1c4934a21300b63e Mon Sep 17 00:00:00 2001 From: Eshaan Date: Sat, 25 Oct 2025 12:21:47 +1100 Subject: [PATCH 2/8] Fix prettier formatting issues --- frontend/src/components/HomeComponents/Tasks/Tasks.tsx | 9 +++++++-- .../src/components/HomeComponents/Tasks/tasks-utils.ts | 4 +++- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/frontend/src/components/HomeComponents/Tasks/Tasks.tsx b/frontend/src/components/HomeComponents/Tasks/Tasks.tsx index c04061d9..872290e5 100644 --- a/frontend/src/components/HomeComponents/Tasks/Tasks.tsx +++ b/frontend/src/components/HomeComponents/Tasks/Tasks.tsx @@ -152,7 +152,9 @@ export const Tasks = ( // Load last sync time from localStorage on mount useEffect(() => { - const storedLastSyncTime = localStorage.getItem(`lastSyncTime_${props.email}`); + const storedLastSyncTime = localStorage.getItem( + `lastSyncTime_${props.email}` + ); if (storedLastSyncTime) { setLastSyncTime(parseInt(storedLastSyncTime, 10)); } @@ -228,7 +230,10 @@ export const Tasks = ( // Store last sync timestamp const currentTime = Date.now(); - localStorage.setItem(`lastSyncTime_${user_email}`, currentTime.toString()); + localStorage.setItem( + `lastSyncTime_${user_email}`, + currentTime.toString() + ); setLastSyncTime(currentTime); toast.success(`Tasks synced successfully!`); diff --git a/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts b/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts index eedcecfb..5aef4ef9 100644 --- a/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts +++ b/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts @@ -144,7 +144,9 @@ export const handleDate = (v: string) => { return true; }; -export const getTimeSinceLastSync = (lastSyncTimestamp: number | null): string => { +export const getTimeSinceLastSync = ( + lastSyncTimestamp: number | null +): string => { if (!lastSyncTimestamp) { return 'Never synced'; } From c948a328bc7599396ddbf0c6bd85e032d7e0cb1a Mon Sep 17 00:00:00 2001 From: Eshaan Date: Sat, 25 Oct 2025 12:24:53 +1100 Subject: [PATCH 3/8] Fix Tasks component test by adding missing mock functions --- .../src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx | 1 + 1 file changed, 1 insertion(+) diff --git a/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx b/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx index d1eb0a44..bcc23fbd 100644 --- a/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx +++ b/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx @@ -24,6 +24,7 @@ jest.mock('../tasks-utils', () => { ...originalModule, // Includes all real functions like sortTasksById markTaskAsCompleted: jest.fn(), // Overwrite this one with a mock markTaskAsDeleted: jest.fn(), // And this one + getTimeSinceLastSync: jest.fn().mockReturnValue('Last updated 5 minutes ago'), // Mock this new function }; }); From 0d1c2c23468a2888830c2ac66e1d34ca265a4eee Mon Sep 17 00:00:00 2001 From: Eshaan Date: Sun, 26 Oct 2025 02:44:57 +1100 Subject: [PATCH 4/8] Fix Prettier formatting in Tasks.test.tsx --- .../components/HomeComponents/Tasks/__tests__/Tasks.test.tsx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx b/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx index bcc23fbd..1de37be9 100644 --- a/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx +++ b/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx @@ -24,7 +24,9 @@ jest.mock('../tasks-utils', () => { ...originalModule, // Includes all real functions like sortTasksById markTaskAsCompleted: jest.fn(), // Overwrite this one with a mock markTaskAsDeleted: jest.fn(), // And this one - getTimeSinceLastSync: jest.fn().mockReturnValue('Last updated 5 minutes ago'), // Mock this new function + getTimeSinceLastSync: jest + .fn() + .mockReturnValue('Last updated 5 minutes ago'), // Mock this new function }; }); From 8126a191dc633d3dfa2a3122874b217f4abd6e15 Mon Sep 17 00:00:00 2001 From: Eshaan Date: Sun, 26 Oct 2025 17:50:25 +1100 Subject: [PATCH 5/8] Hash email in localStorage key for privacy - Add hashKey() function to create hash of key+email - Update localStorage to use hashed keys instead of plain email - Prevents storing email addresses directly in localStorage - Add comprehensive tests for hashKey function (5 new tests) - All 29 tests passing Addresses review feedback from @its-me-abhishek --- .../components/HomeComponents/Tasks/Tasks.tsx | 14 +++---- .../Tasks/__tests__/Tasks.test.tsx | 1 + .../Tasks/__tests__/tasks-utils.test.ts | 42 +++++++++++++++++++ .../HomeComponents/Tasks/tasks-utils.ts | 15 +++++++ 4 files changed, 64 insertions(+), 8 deletions(-) diff --git a/frontend/src/components/HomeComponents/Tasks/Tasks.tsx b/frontend/src/components/HomeComponents/Tasks/Tasks.tsx index 872290e5..1a6c1515 100644 --- a/frontend/src/components/HomeComponents/Tasks/Tasks.tsx +++ b/frontend/src/components/HomeComponents/Tasks/Tasks.tsx @@ -46,6 +46,7 @@ import { sortTasks, sortTasksById, getTimeSinceLastSync, + hashKey, } from './tasks-utils'; import Pagination from './Pagination'; import { url } from '@/components/utils/URLs'; @@ -152,9 +153,8 @@ export const Tasks = ( // Load last sync time from localStorage on mount useEffect(() => { - const storedLastSyncTime = localStorage.getItem( - `lastSyncTime_${props.email}` - ); + const hashedKey = hashKey('lastSyncTime', props.email); + const storedLastSyncTime = localStorage.getItem(hashedKey); if (storedLastSyncTime) { setLastSyncTime(parseInt(storedLastSyncTime, 10)); } @@ -228,12 +228,10 @@ export const Tasks = ( setTempTasks(sortTasksById(updatedTasks, 'desc')); }); - // Store last sync timestamp + // Store last sync timestamp using hashed key const currentTime = Date.now(); - localStorage.setItem( - `lastSyncTime_${user_email}`, - currentTime.toString() - ); + const hashedKey = hashKey('lastSyncTime', user_email); + localStorage.setItem(hashedKey, currentTime.toString()); setLastSyncTime(currentTime); toast.success(`Tasks synced successfully!`); diff --git a/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx b/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx index 1de37be9..1229cc84 100644 --- a/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx +++ b/frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx @@ -27,6 +27,7 @@ jest.mock('../tasks-utils', () => { getTimeSinceLastSync: jest .fn() .mockReturnValue('Last updated 5 minutes ago'), // Mock this new function + hashKey: jest.fn().mockReturnValue('mockHashedKey'), // Mock the hash function }; }); diff --git a/frontend/src/components/HomeComponents/Tasks/__tests__/tasks-utils.test.ts b/frontend/src/components/HomeComponents/Tasks/__tests__/tasks-utils.test.ts index feeb01fa..7ac2d540 100644 --- a/frontend/src/components/HomeComponents/Tasks/__tests__/tasks-utils.test.ts +++ b/frontend/src/components/HomeComponents/Tasks/__tests__/tasks-utils.test.ts @@ -9,6 +9,7 @@ import { markTaskAsCompleted, markTaskAsDeleted, getTimeSinceLastSync, + hashKey, } from '../tasks-utils'; import { Task } from '@/components/utils/types'; @@ -351,3 +352,44 @@ describe('getTimeSinceLastSync', () => { expect(getTimeSinceLastSync(lastSync)).toBe('Last updated 1 day ago'); }); }); + +describe('hashKey', () => { + it('generates a consistent hash for the same key and email', () => { + const key = 'lastSyncTime'; + const email = 'test@example.com'; + const hash1 = hashKey(key, email); + const hash2 = hashKey(key, email); + expect(hash1).toBe(hash2); + }); + + it('generates different hashes for different emails', () => { + const key = 'lastSyncTime'; + const email1 = 'test1@example.com'; + const email2 = 'test2@example.com'; + const hash1 = hashKey(key, email1); + const hash2 = hashKey(key, email2); + expect(hash1).not.toBe(hash2); + }); + + it('generates different hashes for different keys', () => { + const key1 = 'lastSyncTime'; + const key2 = 'otherKey'; + const email = 'test@example.com'; + const hash1 = hashKey(key1, email); + const hash2 = hashKey(key2, email); + expect(hash1).not.toBe(hash2); + }); + + it('returns a string', () => { + const hash = hashKey('lastSyncTime', 'test@example.com'); + expect(typeof hash).toBe('string'); + }); + + it('does not contain the original email', () => { + const email = 'test@example.com'; + const hash = hashKey('lastSyncTime', email); + expect(hash).not.toContain(email); + expect(hash).not.toContain('test'); + expect(hash).not.toContain('@'); + }); +}); diff --git a/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts b/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts index 5aef4ef9..dcfde5fe 100644 --- a/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts +++ b/frontend/src/components/HomeComponents/Tasks/tasks-utils.ts @@ -168,3 +168,18 @@ export const getTimeSinceLastSync = ( return `Last updated ${diffDays} day${diffDays !== 1 ? 's' : ''} ago`; } }; + +/** + * Simple hash function for creating a hash of email + key + * This prevents storing plain email addresses in localStorage + */ +export const hashKey = (key: string, email: string): string => { + const str = key + email; + let hash = 0; + for (let i = 0; i < str.length; i++) { + const char = str.charCodeAt(i); + hash = (hash << 5) - hash + char; + hash = hash & hash; // Convert to 32-bit integer + } + return Math.abs(hash).toString(36); +}; From c210fc6efca893557b4682d28de72e3a5950ee8c Mon Sep 17 00:00:00 2001 From: Eshaan Date: Sun, 16 Nov 2025 03:42:53 +1100 Subject: [PATCH 6/8] Add colored logging with charmbracelet/log Implements #144 - Colored Logging & Improved Backend Logs Features: - Integrated charmbracelet/log for structured, colored logging - Color-coded log levels (Info=Green, Warn=Yellow, Error=Red, Debug=Gray) - Configurable log levels via LOG_LEVEL environment variable - Structured logging with key-value pairs for better traceability - Timestamps on all log entries - Auto-initialization in tests for seamless testing Changes: - Added new logger utility package (backend/utils/logger/) - Updated all log statements across main.go, controllers, and utils - Replaced plain log.Println/Printf with structured logger calls - Added LOG_LEVEL to .env configuration - Updated go.mod with charmbracelet/log dependency Log Levels: - debug: Detailed diagnostic information - info: General informational messages (default) - warn: Warning messages for potential issues - error: Error events that need attention - fatal: Critical errors causing shutdown Usage examples: - Simple: logger.Info("Server started") - Structured: logger.Info("User authenticated", "email", user.Email, "uuid", uuid) - Formatted: logger.Errorf("Failed to connect: %v", err) Benefits: - Easier debugging with visual color coding - Better production monitoring with structured fields - Improved developer experience with clean, readable output - Quick issue identification with timestamps and context --- backend/controllers/app_handlers.go | 10 +-- backend/controllers/job_queue.go | 9 +- backend/controllers/websocket.go | 14 +-- backend/go.mod | 23 ++++- backend/go.sum | 46 ++++++++-- backend/main.go | 17 ++-- backend/utils/logger/logger.go | 129 ++++++++++++++++++++++++++++ backend/utils/tw/edit_task.go | 3 +- backend/utils/tw/modify_task.go | 22 +++-- 9 files changed, 228 insertions(+), 45 deletions(-) create mode 100644 backend/utils/logger/logger.go diff --git a/backend/controllers/app_handlers.go b/backend/controllers/app_handlers.go index 4b9014c0..f14f5400 100644 --- a/backend/controllers/app_handlers.go +++ b/backend/controllers/app_handlers.go @@ -2,9 +2,9 @@ package controllers import ( "ccsync_backend/utils" + "ccsync_backend/utils/logger" "context" "encoding/json" - "log" "net/http" "os" @@ -45,7 +45,7 @@ func (a *App) OAuthHandler(w http.ResponseWriter, r *http.Request) { // @Failure 500 {string} string "Internal server error" // @Router /auth/callback [get] func (a *App) OAuthCallbackHandler(w http.ResponseWriter, r *http.Request) { - log.Println("Fetching user info...") + logger.Info("Fetching user info...") code := r.URL.Query().Get("code") @@ -87,7 +87,7 @@ func (a *App) OAuthCallbackHandler(w http.ResponseWriter, r *http.Request) { return } - log.Printf("User Info: %v", userInfo) + logger.Info("User authenticated successfully", "email", email, "uuid", uuidStr) frontendOriginDev := os.Getenv("FRONTEND_ORIGIN_DEV") http.Redirect(w, r, frontendOriginDev+"/home", http.StatusSeeOther) @@ -110,7 +110,7 @@ func (a *App) UserInfoHandler(w http.ResponseWriter, r *http.Request) { return } - log.Printf("Sending User Info: %v", userInfo) + logger.Debug("Sending user info to client", "email", userInfo["email"]) w.Header().Set("Content-Type", "application/json") json.NewEncoder(w).Encode(userInfo) } @@ -148,5 +148,5 @@ func (a *App) LogoutHandler(w http.ResponseWriter, r *http.Request) { } w.WriteHeader(http.StatusOK) - log.Print("User has logged out") + logger.Info("User has logged out") } diff --git a/backend/controllers/job_queue.go b/backend/controllers/job_queue.go index b2bdae55..da7d5c8b 100644 --- a/backend/controllers/job_queue.go +++ b/backend/controllers/job_queue.go @@ -1,8 +1,7 @@ package controllers import ( - "fmt" - "log" + "ccsync_backend/utils/logger" "sync" ) @@ -37,7 +36,7 @@ func (q *JobQueue) AddJob(job Job) { func (q *JobQueue) processJobs() { for job := range q.jobChannel { - fmt.Printf("Executing job: %s\n", job.Name) + logger.Info("Executing job", "job", job.Name) go BroadcastJobStatus(JobStatus{ Job: job.Name, @@ -45,14 +44,14 @@ func (q *JobQueue) processJobs() { }) if err := job.Execute(); err != nil { - log.Printf("Error executing job %s: %v\n", job.Name, err) + logger.Error("Job execution failed", "job", job.Name, "error", err) go BroadcastJobStatus(JobStatus{ Job: job.Name, Status: "failure", }) } else { - log.Printf("Success in executing job %s\n", job.Name) + logger.Info("Job completed successfully", "job", job.Name) go BroadcastJobStatus(JobStatus{ Job: job.Name, diff --git a/backend/controllers/websocket.go b/backend/controllers/websocket.go index f5c8430f..e7c14ae4 100644 --- a/backend/controllers/websocket.go +++ b/backend/controllers/websocket.go @@ -1,7 +1,7 @@ package controllers import ( - "log" + "ccsync_backend/utils/logger" "net/http" "github.com/gorilla/websocket" @@ -24,37 +24,37 @@ var broadcast = make(chan JobStatus) func WebSocketHandler(w http.ResponseWriter, r *http.Request) { ws, err := upgrader.Upgrade(w, r, nil) if err != nil { - log.Println("WebSocket Upgrade Error:", err) + logger.Errorf("WebSocket upgrade error: %v", err) return } defer ws.Close() clients[ws] = true - log.Println("New WebSocket connection established!") + logger.Info("New WebSocket connection established") for { _, _, err := ws.ReadMessage() if err != nil { delete(clients, ws) - log.Println("WebSocket connection closed:", err) + logger.Debugf("WebSocket connection closed: %v", err) break } } } func BroadcastJobStatus(jobStatus JobStatus) { - log.Printf("Broadcasting: %+v\n", jobStatus) + logger.Debug("Broadcasting job status", "job", jobStatus.Job, "status", jobStatus.Status) broadcast <- jobStatus } func JobStatusManager() { for { jobStatus := <-broadcast - log.Printf("Sending to clients: %+v\n", jobStatus) + logger.Debug("Sending job status to clients", "job", jobStatus.Job, "status", jobStatus.Status) for client := range clients { err := client.WriteJSON(jobStatus) if err != nil { - log.Printf("WebSocket Write Error: %v\n", err) + logger.Warnf("WebSocket write error: %v", err) client.Close() delete(clients, client) } diff --git a/backend/go.mod b/backend/go.mod index fa156137..b7c46d67 100644 --- a/backend/go.mod +++ b/backend/go.mod @@ -3,27 +3,42 @@ module ccsync_backend go 1.19 require ( + github.com/charmbracelet/log v0.4.2 github.com/gorilla/sessions v1.2.2 github.com/swaggo/http-swagger v1.3.4 + github.com/swaggo/swag v1.16.3 golang.org/x/oauth2 v0.20.0 ) require ( github.com/KyleBanks/depth v1.2.1 // indirect + github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect + github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect + github.com/charmbracelet/lipgloss v1.1.0 // indirect + github.com/charmbracelet/x/ansi v0.8.0 // indirect + github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect + github.com/charmbracelet/x/term v0.2.1 // indirect github.com/davecgh/go-spew v1.1.1 // indirect + github.com/go-logfmt/logfmt v0.6.0 // indirect github.com/go-openapi/jsonpointer v0.19.5 // indirect github.com/go-openapi/jsonreference v0.20.0 // indirect github.com/go-openapi/spec v0.20.6 // indirect github.com/go-openapi/swag v0.19.15 // indirect github.com/gorilla/securecookie v1.1.2 // indirect github.com/josharian/intern v1.0.0 // indirect + github.com/lucasb-eyer/go-colorful v1.2.0 // indirect github.com/mailru/easyjson v0.7.6 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/mattn/go-runewidth v0.0.16 // indirect + github.com/muesli/termenv v0.16.0 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/rivo/uniseg v0.4.7 // indirect github.com/swaggo/files v0.0.0-20220610200504-28940afbdbfe // indirect - github.com/swaggo/swag v1.16.3 // indirect + github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect + golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect golang.org/x/net v0.17.0 // indirect - golang.org/x/sys v0.13.0 // indirect - golang.org/x/tools v0.7.0 // indirect + golang.org/x/sys v0.30.0 // indirect + golang.org/x/tools v0.14.0 // indirect gopkg.in/yaml.v2 v2.4.0 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) @@ -33,5 +48,5 @@ require ( github.com/google/uuid v1.6.0 github.com/gorilla/websocket v1.5.3 github.com/joho/godotenv v1.5.1 - github.com/stretchr/testify v1.9.0 + github.com/stretchr/testify v1.10.0 ) diff --git a/backend/go.sum b/backend/go.sum index 26c3a8f3..4c5bb360 100644 --- a/backend/go.sum +++ b/backend/go.sum @@ -2,10 +2,26 @@ cloud.google.com/go/compute/metadata v0.3.0 h1:Tz+eQXMEqDIKRsmY3cHTL6FVaynIjX2Qx cloud.google.com/go/compute/metadata v0.3.0/go.mod h1:zFmK7XCadkQkj6TtorcaGlCW1hT1fIilQDwofLpJ20k= github.com/KyleBanks/depth v1.2.1 h1:5h8fQADFrWtarTdtDudMmGsC7GPbOAu6RVB3ffsVFHc= github.com/KyleBanks/depth v1.2.1/go.mod h1:jzSb9d0L43HxTQfT+oSA1EEp2q+ne2uh6XgeJcm8brE= +github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k= +github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8= +github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc h1:4pZI35227imm7yK2bGPcfpFEmuY1gc2YSTShr4iJBfs= +github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk= +github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY= +github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30= +github.com/charmbracelet/log v0.4.2 h1:hYt8Qj6a8yLnvR+h7MwsJv/XvmBJXiueUcI3cIxsyig= +github.com/charmbracelet/log v0.4.2/go.mod h1:qifHGX/tc7eluv2R6pWIpyHDDrrb/AG71Pf2ysQu5nw= +github.com/charmbracelet/x/ansi v0.8.0 h1:9GTq3xq9caJW8ZrBTe0LIe2fvfLR/bYXKTx2llXn7xE= +github.com/charmbracelet/x/ansi v0.8.0/go.mod h1:wdYl/ONOLHLIVmQaxbIYEC/cRKOQyjTkowiI4blgS9Q= +github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd h1:vy0GVL4jeHEwG5YOXDmi86oYw2yuYUGqz6a8sLwg0X8= +github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs= +github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ= +github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-logfmt/logfmt v0.6.0 h1:wGYYu3uicYdqXVgoYbvnkrPVXkuLM1p1ifugDMEdRi4= +github.com/go-logfmt/logfmt v0.6.0/go.mod h1:WYhtIu8zTZfxdn5+rREduYbwxfcBr/Vr6KEVveWlfTs= github.com/go-openapi/jsonpointer v0.19.3/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg= github.com/go-openapi/jsonpointer v0.19.5 h1:gZr+CIYByUqjcgeLXnQu2gHYQC9o73G2XUeOFYEICuY= github.com/go-openapi/jsonpointer v0.19.5/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg= @@ -35,26 +51,41 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= +github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= github.com/mailru/easyjson v0.7.6 h1:8yTIVnZgCoiM1TgqoeTl+LfU5Jg6/xL3QhGQnimLYnA= github.com/mailru/easyjson v0.7.6/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc= +github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= +github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc= +github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk= github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs= github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= -github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/swaggo/files v0.0.0-20220610200504-28940afbdbfe h1:K8pHPVoTgxFJt1lXuIzzOX7zZhZFldJQK/CgKx9BFIc= github.com/swaggo/files v0.0.0-20220610200504-28940afbdbfe/go.mod h1:lKJPbtWzJ9JhsTN1k1gZgleJWY/cqq0psdoMmaThG3w= github.com/swaggo/http-swagger v1.3.4 h1:q7t/XLx0n15H1Q9/tk3Y9L4n210XzJF5WtnDX64a5ww= github.com/swaggo/http-swagger v1.3.4/go.mod h1:9dAh0unqMBAlbp1uE2Uc2mQTxNMU/ha4UbucIg1MFkQ= github.com/swaggo/swag v1.16.3 h1:PnCYjPCah8FK4I26l2F/KQ4yz3sILcVUN3cTlBFA9Pg= github.com/swaggo/swag v1.16.3/go.mod h1:DImHIuOFXKpMFAQjcC7FG4m3Dg4+QuUgUzJmKjI/gRk= -golang.org/x/mod v0.9.0 h1:KENHtAZL2y3NLMYZeHY9DW8HW8V+kQyJsY/V9JlKvCs= +github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no= +github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM= +golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI= +golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo= +golang.org/x/mod v0.13.0 h1:I/DsJXRlw/8l/0c24sM9yb0T4z9liZTduXvdAWYiysY= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM= golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= @@ -62,13 +93,14 @@ golang.org/x/oauth2 v0.20.0 h1:4mQdhULixXKP1rwYBW0vAijoXnkTG0BLCDRzfe1idMo= golang.org/x/oauth2 v0.20.0/go.mod h1:XYTD2NtWslqkgxebSiOHnXEap4TF09sJSc7H1sXbhtI= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE= -golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= +golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.7.0 h1:W4OVu8VVOaIO0yzWMNdepAulS7YfoS3Zabrm8DOXXU4= -golang.org/x/tools v0.7.0/go.mod h1:4pg6aUX35JBAogB10C9AtvVL+qowtN4pT3CGSQex14s= +golang.org/x/tools v0.14.0 h1:jvNa2pY0M4r62jkRQ6RwEZZyPcymeL9XZMLBbV7U2nc= +golang.org/x/tools v0.14.0/go.mod h1:uYBEerGOWcJyEORxN+Ek8+TT266gXkNlHdJBwexUsBg= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU= diff --git a/backend/main.go b/backend/main.go index 576fa4d7..b80e6751 100644 --- a/backend/main.go +++ b/backend/main.go @@ -2,7 +2,6 @@ package main import ( "encoding/gob" - "log" "net/http" "os" "time" @@ -14,6 +13,7 @@ import ( "ccsync_backend/controllers" "ccsync_backend/middleware" + "ccsync_backend/utils/logger" _ "ccsync_backend/docs" // Swagger docs httpSwagger "github.com/swaggo/http-swagger" @@ -44,11 +44,14 @@ import ( // @tag.description Authentication and authorization endpoints func main() { + // Initialize the colored logger + logger.Initialize() + if os.Getenv("ENV") != "production" { _ = godotenv.Load() - log.Println("Loaded") + logger.Info("Environment variables loaded from .env file") } else { - log.Println("Continue") + logger.Info("Running in production mode") } controllers.GlobalJobQueue = controllers.NewJobQueue() @@ -69,7 +72,7 @@ func main() { // Create a session store sessionKey := []byte(os.Getenv("SESSION_KEY")) if len(sessionKey) == 0 { - log.Fatal("SESSION_KEY environment variable is not set or empty") + logger.Fatal("SESSION_KEY environment variable is not set or empty") } store := sessions.NewCookieStore(sessionKey) gob.Register(map[string]interface{}{}) @@ -98,9 +101,9 @@ func main() { mux.HandleFunc("/api/docs/", httpSwagger.WrapHandler) go controllers.JobStatusManager() - log.Println("Server started at :8000") - log.Println("API documentation available at http://localhost:8000/api/docs/index.html") + logger.Info("Server started at :8000") + logger.Info("API documentation available at http://localhost:8000/api/docs/index.html") if err := http.ListenAndServe(":8000", app.EnableCORS(mux)); err != nil { - log.Fatal(err) + logger.Fatalf("Failed to start server: %v", err) } } diff --git a/backend/utils/logger/logger.go b/backend/utils/logger/logger.go new file mode 100644 index 00000000..2b554c31 --- /dev/null +++ b/backend/utils/logger/logger.go @@ -0,0 +1,129 @@ +package logger + +import ( + "os" + "strings" + + "github.com/charmbracelet/log" +) + +var Logger *log.Logger + +// Initialize sets up the colored logger with configurable log level +func Initialize() { + Logger = log.NewWithOptions(os.Stderr, log.Options{ + ReportCaller: false, + ReportTimestamp: true, + TimeFormat: "2006-01-02 15:04:05", + }) + + // Get log level from environment variable, default to Info + logLevelStr := strings.ToLower(os.Getenv("LOG_LEVEL")) + var logLevel log.Level + + switch logLevelStr { + case "debug": + logLevel = log.DebugLevel + case "info": + logLevel = log.InfoLevel + case "warn", "warning": + logLevel = log.WarnLevel + case "error": + logLevel = log.ErrorLevel + case "fatal": + logLevel = log.FatalLevel + default: + logLevel = log.InfoLevel + } + + Logger.SetLevel(logLevel) +} + +// Helper functions for common logging patterns + +// Info logs an informational message with optional key-value pairs (green) +func Info(msg string, keyvals ...interface{}) { + if Logger == nil { + Initialize() + } + Logger.Info(msg, keyvals...) +} + +// Warn logs a warning message with optional key-value pairs (yellow) +func Warn(msg string, keyvals ...interface{}) { + if Logger == nil { + Initialize() + } + Logger.Warn(msg, keyvals...) +} + +// Error logs an error message with optional key-value pairs (red) +func Error(msg string, keyvals ...interface{}) { + if Logger == nil { + Initialize() + } + Logger.Error(msg, keyvals...) +} + +// Debug logs a debug message with optional key-value pairs +func Debug(msg string, keyvals ...interface{}) { + if Logger == nil { + Initialize() + } + Logger.Debug(msg, keyvals...) +} + +// Fatal logs a fatal error and exits with optional key-value pairs +func Fatal(msg string, keyvals ...interface{}) { + if Logger == nil { + Initialize() + } + Logger.Fatal(msg, keyvals...) +} + +// With returns a logger with structured fields +func With(keyvals ...interface{}) *log.Logger { + return Logger.With(keyvals...) +} + +// Formatted logging functions for printf-style messages + +// Infof logs a formatted informational message +func Infof(format string, args ...interface{}) { + if Logger == nil { + Initialize() + } + Logger.Infof(format, args...) +} + +// Warnf logs a formatted warning message +func Warnf(format string, args ...interface{}) { + if Logger == nil { + Initialize() + } + Logger.Warnf(format, args...) +} + +// Errorf logs a formatted error message +func Errorf(format string, args ...interface{}) { + if Logger == nil { + Initialize() + } + Logger.Errorf(format, args...) +} + +// Debugf logs a formatted debug message +func Debugf(format string, args ...interface{}) { + if Logger == nil { + Initialize() + } + Logger.Debugf(format, args...) +} + +// Fatalf logs a formatted fatal error and exits +func Fatalf(format string, args ...interface{}) { + if Logger == nil { + Initialize() + } + Logger.Fatalf(format, args...) +} diff --git a/backend/utils/tw/edit_task.go b/backend/utils/tw/edit_task.go index 9b37f594..816ef5f4 100644 --- a/backend/utils/tw/edit_task.go +++ b/backend/utils/tw/edit_task.go @@ -2,6 +2,7 @@ package tw import ( "ccsync_backend/utils" + "ccsync_backend/utils/logger" "fmt" "os" "strings" @@ -28,7 +29,7 @@ func EditTaskInTaskwarrior(uuid, description, email, encryptionSecret, taskID st // Escape the double quotes in the description and format it if err := utils.ExecCommand("task", taskID, "modify", description); err != nil { - fmt.Println("task " + taskID + " modify " + description) + logger.Error("Failed to edit task", "taskID", taskID, "description", description, "error", err) return fmt.Errorf("failed to edit task: %v", err) } diff --git a/backend/utils/tw/modify_task.go b/backend/utils/tw/modify_task.go index 286a435e..08c07cb2 100644 --- a/backend/utils/tw/modify_task.go +++ b/backend/utils/tw/modify_task.go @@ -2,56 +2,59 @@ package tw import ( "ccsync_backend/utils" + "ccsync_backend/utils/logger" "fmt" "os" "strings" ) func ModifyTaskInTaskwarrior(uuid, description, project, priority, status, due, email, encryptionSecret, taskID string, tags []string) error { + logger.Debug("Starting task modification", "taskID", taskID, "email", email) + if err := utils.ExecCommand("rm", "-rf", "/root/.task"); err != nil { - fmt.Println("1") + logger.Error("Error deleting Taskwarrior data", "error", err) return fmt.Errorf("error deleting Taskwarrior data: %v", err) } tempDir, err := os.MkdirTemp("", "taskwarrior-"+email) if err != nil { - fmt.Println("2") + logger.Error("Failed to create temporary directory", "error", err) return fmt.Errorf("failed to create temporary directory: %v", err) } defer os.RemoveAll(tempDir) origin := os.Getenv("CONTAINER_ORIGIN") if err := SetTaskwarriorConfig(tempDir, encryptionSecret, origin, uuid); err != nil { - fmt.Println("4") + logger.Error("Failed to set Taskwarrior config", "error", err) return err } if err := SyncTaskwarrior(tempDir); err != nil { - fmt.Println("5") + logger.Error("Failed to sync Taskwarrior", "error", err) return err } escapedDescription := fmt.Sprintf(`description:"%s"`, strings.ReplaceAll(description, `"`, `\"`)) if err := utils.ExecCommand("task", taskID, "modify", escapedDescription); err != nil { - fmt.Println("6") + logger.Error("Failed to modify task description", "taskID", taskID, "error", err) return fmt.Errorf("failed to edit task: %v", err) } escapedProject := fmt.Sprintf(`project:%s`, strings.ReplaceAll(project, `"`, `\"`)) if err := utils.ExecCommand("task", taskID, "modify", escapedProject); err != nil { - fmt.Println("7") + logger.Error("Failed to modify task project", "taskID", taskID, "error", err) return fmt.Errorf("failed to edit task project: %v", err) } escapedPriority := fmt.Sprintf(`priority:%s`, strings.ReplaceAll(priority, `"`, `\"`)) if err := utils.ExecCommand("task", taskID, "modify", escapedPriority); err != nil { - fmt.Println("8") + logger.Error("Failed to modify task priority", "taskID", taskID, "error", err) return fmt.Errorf("failed to edit task priority: %v", err) } escapedDue := fmt.Sprintf(`due:%s`, strings.ReplaceAll(due, `"`, `\"`)) if err := utils.ExecCommand("task", taskID, "modify", escapedDue); err != nil { - fmt.Println("8") + logger.Error("Failed to modify task due date", "taskID", taskID, "error", err) return fmt.Errorf("failed to edit task due: %v", err) } @@ -87,9 +90,10 @@ func ModifyTaskInTaskwarrior(uuid, description, project, priority, status, due, } if err := SyncTaskwarrior(tempDir); err != nil { - fmt.Println("11") + logger.Error("Failed to sync Taskwarrior after modification", "error", err) return err } + logger.Info("Task modified successfully", "taskID", taskID) return nil } From 1ab3e17c19f6748ecfdcee6f87dfa4b40babef60 Mon Sep 17 00:00:00 2001 From: Eshaan Date: Sun, 16 Nov 2025 16:01:24 +1100 Subject: [PATCH 7/8] Refactor logging to use charmbracelet/log directly - Removed utils/logger wrapper package as suggested in review - Added global Logger variable in main package with InitLogger() - Created logger.go in controllers and utils/tw packages for local Logger instances - Logger instances auto-initialize in init() for test compatibility - Maintained all existing log functionality with structured logging - All tests pass successfully --- backend/controllers/app_handlers.go | 10 +-- backend/controllers/job_queue.go | 8 +- backend/controllers/logger.go | 22 +++++ backend/controllers/websocket.go | 14 +-- backend/logger.go | 41 +++++++++ backend/main.go | 18 ++-- backend/utils/logger/logger.go | 129 ---------------------------- backend/utils/tw/edit_task.go | 4 +- backend/utils/tw/logger.go | 22 +++++ backend/utils/tw/modify_task.go | 24 +++--- 10 files changed, 125 insertions(+), 167 deletions(-) create mode 100644 backend/controllers/logger.go create mode 100644 backend/logger.go delete mode 100644 backend/utils/logger/logger.go create mode 100644 backend/utils/tw/logger.go diff --git a/backend/controllers/app_handlers.go b/backend/controllers/app_handlers.go index f14f5400..7c02774f 100644 --- a/backend/controllers/app_handlers.go +++ b/backend/controllers/app_handlers.go @@ -2,7 +2,7 @@ package controllers import ( "ccsync_backend/utils" - "ccsync_backend/utils/logger" + "context" "encoding/json" "net/http" @@ -45,7 +45,7 @@ func (a *App) OAuthHandler(w http.ResponseWriter, r *http.Request) { // @Failure 500 {string} string "Internal server error" // @Router /auth/callback [get] func (a *App) OAuthCallbackHandler(w http.ResponseWriter, r *http.Request) { - logger.Info("Fetching user info...") + Logger.Info("Fetching user info...") code := r.URL.Query().Get("code") @@ -87,7 +87,7 @@ func (a *App) OAuthCallbackHandler(w http.ResponseWriter, r *http.Request) { return } - logger.Info("User authenticated successfully", "email", email, "uuid", uuidStr) + Logger.Info("User authenticated successfully", "email", email, "uuid", uuidStr) frontendOriginDev := os.Getenv("FRONTEND_ORIGIN_DEV") http.Redirect(w, r, frontendOriginDev+"/home", http.StatusSeeOther) @@ -110,7 +110,7 @@ func (a *App) UserInfoHandler(w http.ResponseWriter, r *http.Request) { return } - logger.Debug("Sending user info to client", "email", userInfo["email"]) + Logger.Debug("Sending user info to client", "email", userInfo["email"]) w.Header().Set("Content-Type", "application/json") json.NewEncoder(w).Encode(userInfo) } @@ -148,5 +148,5 @@ func (a *App) LogoutHandler(w http.ResponseWriter, r *http.Request) { } w.WriteHeader(http.StatusOK) - logger.Info("User has logged out") + Logger.Info("User has logged out") } diff --git a/backend/controllers/job_queue.go b/backend/controllers/job_queue.go index da7d5c8b..94d98b0e 100644 --- a/backend/controllers/job_queue.go +++ b/backend/controllers/job_queue.go @@ -1,7 +1,7 @@ package controllers import ( - "ccsync_backend/utils/logger" + "sync" ) @@ -36,7 +36,7 @@ func (q *JobQueue) AddJob(job Job) { func (q *JobQueue) processJobs() { for job := range q.jobChannel { - logger.Info("Executing job", "job", job.Name) + Logger.Info("Executing job", "job", job.Name) go BroadcastJobStatus(JobStatus{ Job: job.Name, @@ -44,14 +44,14 @@ func (q *JobQueue) processJobs() { }) if err := job.Execute(); err != nil { - logger.Error("Job execution failed", "job", job.Name, "error", err) + Logger.Error("Job execution failed", "job", job.Name, "error", err) go BroadcastJobStatus(JobStatus{ Job: job.Name, Status: "failure", }) } else { - logger.Info("Job completed successfully", "job", job.Name) + Logger.Info("Job completed successfully", "job", job.Name) go BroadcastJobStatus(JobStatus{ Job: job.Name, diff --git a/backend/controllers/logger.go b/backend/controllers/logger.go new file mode 100644 index 00000000..99111812 --- /dev/null +++ b/backend/controllers/logger.go @@ -0,0 +1,22 @@ +package controllers + +import ( + "os" + + "github.com/charmbracelet/log" +) + +// Logger is the global logger instance used across all controllers +var Logger *log.Logger + +func init() { + // Initialize logger with defaults if not set by main + if Logger == nil { + Logger = log.NewWithOptions(os.Stderr, log.Options{ + ReportCaller: false, + ReportTimestamp: true, + TimeFormat: "2006-01-02 15:04:05", + }) + Logger.SetLevel(log.InfoLevel) + } +} diff --git a/backend/controllers/websocket.go b/backend/controllers/websocket.go index e7c14ae4..3355aaf9 100644 --- a/backend/controllers/websocket.go +++ b/backend/controllers/websocket.go @@ -1,7 +1,7 @@ package controllers import ( - "ccsync_backend/utils/logger" + "net/http" "github.com/gorilla/websocket" @@ -24,37 +24,37 @@ var broadcast = make(chan JobStatus) func WebSocketHandler(w http.ResponseWriter, r *http.Request) { ws, err := upgrader.Upgrade(w, r, nil) if err != nil { - logger.Errorf("WebSocket upgrade error: %v", err) + Logger.Errorf("WebSocket upgrade error: %v", err) return } defer ws.Close() clients[ws] = true - logger.Info("New WebSocket connection established") + Logger.Info("New WebSocket connection established") for { _, _, err := ws.ReadMessage() if err != nil { delete(clients, ws) - logger.Debugf("WebSocket connection closed: %v", err) + Logger.Debugf("WebSocket connection closed: %v", err) break } } } func BroadcastJobStatus(jobStatus JobStatus) { - logger.Debug("Broadcasting job status", "job", jobStatus.Job, "status", jobStatus.Status) + Logger.Debug("Broadcasting job status", "job", jobStatus.Job, "status", jobStatus.Status) broadcast <- jobStatus } func JobStatusManager() { for { jobStatus := <-broadcast - logger.Debug("Sending job status to clients", "job", jobStatus.Job, "status", jobStatus.Status) + Logger.Debug("Sending job status to clients", "job", jobStatus.Job, "status", jobStatus.Status) for client := range clients { err := client.WriteJSON(jobStatus) if err != nil { - logger.Warnf("WebSocket write error: %v", err) + Logger.Warnf("WebSocket write error: %v", err) client.Close() delete(clients, client) } diff --git a/backend/logger.go b/backend/logger.go new file mode 100644 index 00000000..36aead99 --- /dev/null +++ b/backend/logger.go @@ -0,0 +1,41 @@ +package main + +import ( + "os" + "strings" + + "github.com/charmbracelet/log" +) + +// Logger is the global logger instance +var Logger *log.Logger + +// InitLogger sets up the colored logger with configurable log level +func InitLogger() { + Logger = log.NewWithOptions(os.Stderr, log.Options{ + ReportCaller: false, + ReportTimestamp: true, + TimeFormat: "2006-01-02 15:04:05", + }) + + // Get log level from environment variable, default to Info + logLevelStr := strings.ToLower(os.Getenv("LOG_LEVEL")) + var logLevel log.Level + + switch logLevelStr { + case "debug": + logLevel = log.DebugLevel + case "info": + logLevel = log.InfoLevel + case "warn", "warning": + logLevel = log.WarnLevel + case "error": + logLevel = log.ErrorLevel + case "fatal": + logLevel = log.FatalLevel + default: + logLevel = log.InfoLevel + } + + Logger.SetLevel(logLevel) +} diff --git a/backend/main.go b/backend/main.go index 162fc39d..b1357e66 100644 --- a/backend/main.go +++ b/backend/main.go @@ -13,7 +13,7 @@ import ( "ccsync_backend/controllers" "ccsync_backend/middleware" - "ccsync_backend/utils/logger" + "ccsync_backend/utils/tw" _ "ccsync_backend/docs" // Swagger docs httpSwagger "github.com/swaggo/http-swagger" @@ -45,13 +45,15 @@ import ( func main() { // Initialize the colored logger - logger.Initialize() + InitLogger() + controllers.Logger = Logger // Set the logger for controllers package + tw.Logger = Logger // Set the logger for tw package if os.Getenv("ENV") != "production" { _ = godotenv.Load() - logger.Info("Environment variables loaded from .env file") + Logger.Info("Environment variables loaded from .env file") } else { - logger.Info("Running in production mode") + Logger.Info("Running in production mode") } controllers.GlobalJobQueue = controllers.NewJobQueue() @@ -72,7 +74,7 @@ func main() { // Create a session store sessionKey := []byte(os.Getenv("SESSION_KEY")) if len(sessionKey) == 0 { - logger.Fatal("SESSION_KEY environment variable is not set or empty") + Logger.Fatal("SESSION_KEY environment variable is not set or empty") } store := sessions.NewCookieStore(sessionKey) gob.Register(map[string]interface{}{}) @@ -102,9 +104,9 @@ func main() { mux.HandleFunc("/api/docs/", httpSwagger.WrapHandler) go controllers.JobStatusManager() - logger.Info("Server started at :8000") - logger.Info("API documentation available at http://localhost:8000/api/docs/index.html") + Logger.Info("Server started at :8000") + Logger.Info("API documentation available at http://localhost:8000/api/docs/index.html") if err := http.ListenAndServe(":8000", app.EnableCORS(mux)); err != nil { - logger.Fatalf("Failed to start server: %v", err) + Logger.Fatalf("Failed to start server: %v", err) } } diff --git a/backend/utils/logger/logger.go b/backend/utils/logger/logger.go deleted file mode 100644 index 2b554c31..00000000 --- a/backend/utils/logger/logger.go +++ /dev/null @@ -1,129 +0,0 @@ -package logger - -import ( - "os" - "strings" - - "github.com/charmbracelet/log" -) - -var Logger *log.Logger - -// Initialize sets up the colored logger with configurable log level -func Initialize() { - Logger = log.NewWithOptions(os.Stderr, log.Options{ - ReportCaller: false, - ReportTimestamp: true, - TimeFormat: "2006-01-02 15:04:05", - }) - - // Get log level from environment variable, default to Info - logLevelStr := strings.ToLower(os.Getenv("LOG_LEVEL")) - var logLevel log.Level - - switch logLevelStr { - case "debug": - logLevel = log.DebugLevel - case "info": - logLevel = log.InfoLevel - case "warn", "warning": - logLevel = log.WarnLevel - case "error": - logLevel = log.ErrorLevel - case "fatal": - logLevel = log.FatalLevel - default: - logLevel = log.InfoLevel - } - - Logger.SetLevel(logLevel) -} - -// Helper functions for common logging patterns - -// Info logs an informational message with optional key-value pairs (green) -func Info(msg string, keyvals ...interface{}) { - if Logger == nil { - Initialize() - } - Logger.Info(msg, keyvals...) -} - -// Warn logs a warning message with optional key-value pairs (yellow) -func Warn(msg string, keyvals ...interface{}) { - if Logger == nil { - Initialize() - } - Logger.Warn(msg, keyvals...) -} - -// Error logs an error message with optional key-value pairs (red) -func Error(msg string, keyvals ...interface{}) { - if Logger == nil { - Initialize() - } - Logger.Error(msg, keyvals...) -} - -// Debug logs a debug message with optional key-value pairs -func Debug(msg string, keyvals ...interface{}) { - if Logger == nil { - Initialize() - } - Logger.Debug(msg, keyvals...) -} - -// Fatal logs a fatal error and exits with optional key-value pairs -func Fatal(msg string, keyvals ...interface{}) { - if Logger == nil { - Initialize() - } - Logger.Fatal(msg, keyvals...) -} - -// With returns a logger with structured fields -func With(keyvals ...interface{}) *log.Logger { - return Logger.With(keyvals...) -} - -// Formatted logging functions for printf-style messages - -// Infof logs a formatted informational message -func Infof(format string, args ...interface{}) { - if Logger == nil { - Initialize() - } - Logger.Infof(format, args...) -} - -// Warnf logs a formatted warning message -func Warnf(format string, args ...interface{}) { - if Logger == nil { - Initialize() - } - Logger.Warnf(format, args...) -} - -// Errorf logs a formatted error message -func Errorf(format string, args ...interface{}) { - if Logger == nil { - Initialize() - } - Logger.Errorf(format, args...) -} - -// Debugf logs a formatted debug message -func Debugf(format string, args ...interface{}) { - if Logger == nil { - Initialize() - } - Logger.Debugf(format, args...) -} - -// Fatalf logs a formatted fatal error and exits -func Fatalf(format string, args ...interface{}) { - if Logger == nil { - Initialize() - } - Logger.Fatalf(format, args...) -} diff --git a/backend/utils/tw/edit_task.go b/backend/utils/tw/edit_task.go index b3be3e77..443851fb 100644 --- a/backend/utils/tw/edit_task.go +++ b/backend/utils/tw/edit_task.go @@ -2,7 +2,7 @@ package tw import ( "ccsync_backend/utils" - "ccsync_backend/utils/logger" + "fmt" "os" "strings" @@ -29,7 +29,7 @@ func EditTaskInTaskwarrior(uuid, description, email, encryptionSecret, taskID st // Escape the double quotes in the description and format it if err := utils.ExecCommand("task", taskID, "modify", description); err != nil { - logger.Error("Failed to edit task", "taskID", taskID, "description", description, "error", err) + Logger.Error("Failed to edit task", "taskID", taskID, "description", description, "error", err) return fmt.Errorf("failed to edit task: %v", err) } diff --git a/backend/utils/tw/logger.go b/backend/utils/tw/logger.go new file mode 100644 index 00000000..10a55228 --- /dev/null +++ b/backend/utils/tw/logger.go @@ -0,0 +1,22 @@ +package tw + +import ( + "os" + + "github.com/charmbracelet/log" +) + +// Logger is the global logger instance used in tw package +var Logger *log.Logger + +func init() { + // Initialize logger with defaults if not set by main + if Logger == nil { + Logger = log.NewWithOptions(os.Stderr, log.Options{ + ReportCaller: false, + ReportTimestamp: true, + TimeFormat: "2006-01-02 15:04:05", + }) + Logger.SetLevel(log.InfoLevel) + } +} diff --git a/backend/utils/tw/modify_task.go b/backend/utils/tw/modify_task.go index 08c07cb2..3283975d 100644 --- a/backend/utils/tw/modify_task.go +++ b/backend/utils/tw/modify_task.go @@ -2,59 +2,59 @@ package tw import ( "ccsync_backend/utils" - "ccsync_backend/utils/logger" + "fmt" "os" "strings" ) func ModifyTaskInTaskwarrior(uuid, description, project, priority, status, due, email, encryptionSecret, taskID string, tags []string) error { - logger.Debug("Starting task modification", "taskID", taskID, "email", email) + Logger.Debug("Starting task modification", "taskID", taskID, "email", email) if err := utils.ExecCommand("rm", "-rf", "/root/.task"); err != nil { - logger.Error("Error deleting Taskwarrior data", "error", err) + Logger.Error("Error deleting Taskwarrior data", "error", err) return fmt.Errorf("error deleting Taskwarrior data: %v", err) } tempDir, err := os.MkdirTemp("", "taskwarrior-"+email) if err != nil { - logger.Error("Failed to create temporary directory", "error", err) + Logger.Error("Failed to create temporary directory", "error", err) return fmt.Errorf("failed to create temporary directory: %v", err) } defer os.RemoveAll(tempDir) origin := os.Getenv("CONTAINER_ORIGIN") if err := SetTaskwarriorConfig(tempDir, encryptionSecret, origin, uuid); err != nil { - logger.Error("Failed to set Taskwarrior config", "error", err) + Logger.Error("Failed to set Taskwarrior config", "error", err) return err } if err := SyncTaskwarrior(tempDir); err != nil { - logger.Error("Failed to sync Taskwarrior", "error", err) + Logger.Error("Failed to sync Taskwarrior", "error", err) return err } escapedDescription := fmt.Sprintf(`description:"%s"`, strings.ReplaceAll(description, `"`, `\"`)) if err := utils.ExecCommand("task", taskID, "modify", escapedDescription); err != nil { - logger.Error("Failed to modify task description", "taskID", taskID, "error", err) + Logger.Error("Failed to modify task description", "taskID", taskID, "error", err) return fmt.Errorf("failed to edit task: %v", err) } escapedProject := fmt.Sprintf(`project:%s`, strings.ReplaceAll(project, `"`, `\"`)) if err := utils.ExecCommand("task", taskID, "modify", escapedProject); err != nil { - logger.Error("Failed to modify task project", "taskID", taskID, "error", err) + Logger.Error("Failed to modify task project", "taskID", taskID, "error", err) return fmt.Errorf("failed to edit task project: %v", err) } escapedPriority := fmt.Sprintf(`priority:%s`, strings.ReplaceAll(priority, `"`, `\"`)) if err := utils.ExecCommand("task", taskID, "modify", escapedPriority); err != nil { - logger.Error("Failed to modify task priority", "taskID", taskID, "error", err) + Logger.Error("Failed to modify task priority", "taskID", taskID, "error", err) return fmt.Errorf("failed to edit task priority: %v", err) } escapedDue := fmt.Sprintf(`due:%s`, strings.ReplaceAll(due, `"`, `\"`)) if err := utils.ExecCommand("task", taskID, "modify", escapedDue); err != nil { - logger.Error("Failed to modify task due date", "taskID", taskID, "error", err) + Logger.Error("Failed to modify task due date", "taskID", taskID, "error", err) return fmt.Errorf("failed to edit task due: %v", err) } @@ -90,10 +90,10 @@ func ModifyTaskInTaskwarrior(uuid, description, project, priority, status, due, } if err := SyncTaskwarrior(tempDir); err != nil { - logger.Error("Failed to sync Taskwarrior after modification", "error", err) + Logger.Error("Failed to sync Taskwarrior after modification", "error", err) return err } - logger.Info("Task modified successfully", "taskID", taskID) + Logger.Info("Task modified successfully", "taskID", taskID) return nil } From 2c44469b93a6016b80f0b464c7fd52943bcf433d Mon Sep 17 00:00:00 2001 From: Eshaan Date: Sun, 16 Nov 2025 16:03:13 +1100 Subject: [PATCH 8/8] Fix gofmt formatting issues --- backend/controllers/app_handlers.go | 2 +- backend/controllers/job_queue.go | 1 - backend/controllers/websocket.go | 1 - backend/utils/tw/edit_task.go | 2 +- backend/utils/tw/modify_task.go | 2 +- 5 files changed, 3 insertions(+), 5 deletions(-) diff --git a/backend/controllers/app_handlers.go b/backend/controllers/app_handlers.go index 7c02774f..8d838077 100644 --- a/backend/controllers/app_handlers.go +++ b/backend/controllers/app_handlers.go @@ -2,7 +2,7 @@ package controllers import ( "ccsync_backend/utils" - + "context" "encoding/json" "net/http" diff --git a/backend/controllers/job_queue.go b/backend/controllers/job_queue.go index 94d98b0e..eca6238f 100644 --- a/backend/controllers/job_queue.go +++ b/backend/controllers/job_queue.go @@ -1,7 +1,6 @@ package controllers import ( - "sync" ) diff --git a/backend/controllers/websocket.go b/backend/controllers/websocket.go index 3355aaf9..1b5869f5 100644 --- a/backend/controllers/websocket.go +++ b/backend/controllers/websocket.go @@ -1,7 +1,6 @@ package controllers import ( - "net/http" "github.com/gorilla/websocket" diff --git a/backend/utils/tw/edit_task.go b/backend/utils/tw/edit_task.go index 443851fb..865ff491 100644 --- a/backend/utils/tw/edit_task.go +++ b/backend/utils/tw/edit_task.go @@ -2,7 +2,7 @@ package tw import ( "ccsync_backend/utils" - + "fmt" "os" "strings" diff --git a/backend/utils/tw/modify_task.go b/backend/utils/tw/modify_task.go index 3283975d..97b40dea 100644 --- a/backend/utils/tw/modify_task.go +++ b/backend/utils/tw/modify_task.go @@ -2,7 +2,7 @@ package tw import ( "ccsync_backend/utils" - + "fmt" "os" "strings"