add-auditing-system

[hu55ain3laa]

Description

a complete auditing and logging system for FastCRUD that tracks database operations, user actions, and data changes. The new audit module provides tools to enhance accountability, compliance, and debugging capabilities without requiring significant changes to existing code.

Changes

• Operation Tracking: Records create, read, update, and delete operations
• Change Tracking: Captures before/after values for all field updates
• User Attribution: Tracks which user performed each operation
• Context Capture: Records IP address, user agent, and custom context data
• Integrated Logging: Works with both database storage and standard Python logging
• Non-intrusive Implementation: Drop-in replacement via AuditableFastCRUD class

Implementation Details

The auditing system consists of the following components:

1. Database Models: AuditLog and AuditLogEntry tables for storing audit data
2. Audit Logger: Core logging functionality with both async and sync support
3. Context Management: Session-based context tracking for user information
4. Auditable CRUD Class: Extension of FastCRUD with built-in auditing capabilities

Tests

• ✅ Added comprehensive tests in tests/sqlalchemy/audit/ directory
• ✅ Code passes mypy type checking
• ✅ Code follows style guidelines (verified with ruff)
• ✅ Documentation added for all components

Checklist

• ✅ I have read the CONTRIBUTING document.
• ✅ My code follows the code style of this project.
• ✅ I have added necessary documentation (if appropriate).
• ✅ I have added tests that cover my changes (if applicable).
• ✅ All new and existing tests passed.