Files
ColaFlow/docs/plans/sprint_3_story_1.md
Yaojia Wang b11c6447b5
Some checks failed
Code Coverage / Generate Coverage Report (push) Has been cancelled
Tests / Run Tests (9.0.x) (push) Has been cancelled
Tests / Docker Build Test (push) Has been cancelled
Tests / Test Summary (push) Has been cancelled
Sync
2025-11-08 18:13:48 +01:00

110 lines
3.4 KiB
Markdown

---
story_id: sprint_3_story_1
sprint: sprint_3
priority: P1
status: not_started
story_points: 3
estimated_days: 1-2
created_date: 2025-11-05
assignee: Frontend Team
---
# Story 1: Complete Logging Utility Migration
**Sprint**: Sprint 3
**Priority**: P1 (High)
**Estimated**: 1-2 days
**Owner**: Frontend Team
## Description
Replace all remaining console.log statements in the frontend codebase with the unified logger utility (`lib/utils/logger.ts`). This improves production code quality, reduces console spam, enables proper error tracking integration, and provides environment-aware logging.
## User Story
**As a** frontend developer,
**I want** all logging to go through a unified logger utility,
**So that** logs are properly managed in development and production environments.
## Acceptance Criteria
- [ ] No console.log statements remain in React Query hooks (`lib/hooks/`)
- [ ] No console.log statements remain in SignalR files (`lib/signalr/`)
- [ ] All logging uses `logger.debug()`, `logger.info()`, or `logger.error()`
- [ ] Development logs are verbose, production logs are minimal
- [ ] Error logs are properly structured for error tracking services
- [ ] No production console spam
## Technical Requirements
**Affected Files**:
- `lib/hooks/use-projects.ts` - React Query hook logging
- `lib/hooks/use-stories.ts` - React Query hook logging
- `lib/hooks/use-tasks.ts` - React Query hook logging
- `lib/hooks/use-epics.ts` - React Query hook logging (if console.log exists)
- `lib/signalr/ConnectionManager.ts` - SignalR connection logging
- Other hooks in `lib/hooks/` directory
**Logger Utility**: `lib/utils/logger.ts` (already exists)
## Tasks
- [ ] [Task 1](sprint_3_story_1_task_1.md) - Replace console.log in use-projects.ts
- [ ] [Task 2](sprint_3_story_1_task_2.md) - Replace console.log in use-stories.ts
- [ ] [Task 3](sprint_3_story_1_task_3.md) - Replace console.log in use-tasks.ts
- [ ] [Task 4](sprint_3_story_1_task_4.md) - Replace console.log in other React Query hooks
- [ ] [Task 5](sprint_3_story_1_task_5.md) - Replace console.log in SignalR files
- [ ] [Task 6](sprint_3_story_1_task_6.md) - Verify no console.log remains
**Progress**: 0/6 tasks completed
## Dependencies
**Prerequisites**:
- ✅ Logger utility already created (`lib/utils/logger.ts`)
- ✅ Code review completed with specific console.log locations identified
## Definition of Done
- All 6 tasks completed
- No console.log statements in production code (except dev tools)
- All React Query hooks use logger
- All SignalR files use logger
- Code reviewed and approved
- Git commit created
## Test Plan
**Manual Testing**:
1. Run application in development mode
2. Verify debug logs appear in console
3. Build for production: `npm run build`
4. Verify production build has minimal console output
5. Trigger errors and verify they're logged properly
**Verification Commands**:
```bash
# Search for remaining console.log
grep -r "console.log" lib/hooks/
grep -r "console.log" lib/signalr/
# Expected: No results (or only in test files)
```
## Notes
**Why This Matters**:
- Production console spam hurts performance
- Unstructured logs make debugging harder
- Missing error tracking integration
- Security: potential information leakage
**Quick Wins**:
- Simple find-and-replace in most cases
- Immediate production quality improvement
- Foundation for error tracking (Sentry/DataDog)
---
**Created**: 2025-11-05 by Frontend Agent