1️⃣ Bug Investigation Summary Problem Overview The application throws a KeyError when attempting to record an employee's first check-in. The program assumes that an attendance record already exists, but the dictionary is empty. Error Classification Runtime Error Dictionary Access Error Data Initialization Bug State Management Issue Severity Assessment High Reason: Core attendance workflow fails. First-time users cannot use the system. API terminates unexpectedly. Prevents normal business operations. Initial Observations No record initialization. No defensive programming. Missing input validation. Missing exception handling. No automated tests covering first-time users. --- 2️⃣ Root Cause Analysis Primary Cause The dictionary entry for the employee does not exist before attempting to access it. Problematic code: attendance[employee_id]["check_in"] = datetime.now() At this point: attendance = {} Therefore: attendance["EMP101"] does not exist. --- Contributing Factors Missing dictionary initialization. No existence check. Lack of validation. Refactoring removed setup logic. No fallback mechanism. --- Why the Bug Occurred The developer assumed every employee would already have an attendance object before check-in. That assumption is incorrect for: New employees First login Cleared cache Fresh application startup --- Related Code Paths Affected flow: User Request ↓ check_in() ↓ attendance dictionary lookup ↓ Missing key ↓ KeyError ↓ Application Crash --- 3️⃣ Bug Fix Recommendations Step-by-Step Solution Step 1 Verify employee exists inside dictionary. Step 2 Create attendance record if missing. Step 3 Store check-in timestamp. Step 4 Validate check-out before calculating hours. Step 5 Return meaningful error messages. --- Corrected Code Suggestions from datetime import datetime attendance = {} def check_in(employee_id): if employee_id not in attendance: attendance[employee_id] = {} attendance[employee_id]["check_in"] = datetime.now() def check_out(employee_id): if employee_id not in attendance: raise ValueError("Employee has not checked in.") if "check_in" not in attendance[employee_id]: raise ValueError("Missing check-in record.") duration = datetime.now() - attendance[employee_id]["check_in"] attendance[employee_id]["hours"] = duration.total_seconds() / 3600 return attendance[employee_id] --- Alternative Implementation Options Use dict.setdefault() Store attendance in a database. Use a dataclass for attendance records. Implement an AttendanceManager class. Add middleware validation for API requests. --- Best-Practice Approach Validate input before processing. Never assume object existence. Raise descriptive exceptions. Separate business logic from storage. Add structured logging. --- 4️⃣ Code Quality Assessment Readability Improvements Use descriptive variable names. Add function docstrings. Improve code comments. Follow PEP 8 formatting. Group related logic together. --- Maintainability Recommendations Introduce an Attendance service layer. Avoid global variables. Use dependency injection. Centralize validation logic. Implement reusable helper functions. --- Performance Considerations Dictionary lookups are efficient (O(1)). For large deployments, replace in-memory storage with a database. Cache active attendance sessions if required. Reduce duplicate dictionary lookups. Profile API under concurrent load. --- Refactoring Opportunities Create an EmployeeAttendance class. Use type hints. Split validation into separate functions. Introduce repository pattern. Improve error handling architecture. --- 5️⃣ Testing & Verification Plan Unit Test Recommendations Test first-time employee check-in. Test repeated check-ins. Test valid check-out. Test check-out without check-in. Test invalid employee IDs. Test empty employee ID. Test multiple employees simultaneously. --- Edge Cases to Verify Duplicate check-in. Midnight shift crossing dates. Long-duration shifts. Missing employee record. Empty attendance dictionary. Corrupted attendance data. Concurrent API requests. --- Regression Testing Checklist Existing employees still work. API responses remain unchanged. Worked hours remain accurate. No new runtime exceptions. Database integration unaffected. Authentication flow unaffected. Logging continues working. --- Validation Steps 1. Start the FastAPI application. 2. Perform first-time employee check-in. 3. Verify attendance record creation. 4. Execute check-out. 5. Confirm calculated hours are correct. 6. Repeat with multiple employees. 7. Execute automated test suite. 8. Review logs for unexpected errors. --- 6️⃣ Prevention & Long-Term Improvements Coding Best Practices Validate all external inputs. Initialize objects before use. Avoid mutable global state. Use clear exception handling. Write defensive code. Follow SOLID principles. Adopt consistent code review practices. --- Static Analysis and Linting Recommendations Use Ruff for linting. Use Black for formatting. Use mypy for static type checking. Use Bandit for security scanning. Enable pre-commit hooks. Integrate automated code quality checks into CI/CD. --- Logging and Monitoring Improvements Log every check-in and check-out event. Record failed validation attempts. Include employee IDs in structured logs. Capture stack traces for unexpected exceptions. Monitor API error rates and response times. Configure alerts for repeated runtime failures. --- Future Debugging Prevention Strategy Increase unit and integration test coverage. Perform code reviews for all attendance-related changes. Add automated regression testing to the deployment pipeline. Introduce centralized exception handling. Document expected data structures and API contracts. Schedule periodic code quality audits and dependency updates. Maintain detailed operational dashboards to detect failures early.