-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
added logs for debugging #643
Conversation
Reviewer's Guide by SourceryThis PR adds logging functionality to the Telegram bot views to aid in debugging. The implementation adds a logger instance and includes a new log statement to capture request headers. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @alimaktabi - I've reviewed your changes and found some issues that need to be addressed.
Blocking issues:
- Consider re-enabling the IP validation check for security (link)
- Avoid logging raw request headers as they may contain sensitive information (link)
Overall Comments:
- The IP address validation check should not be commented out as it's an important security feature. If you need to debug IP-related issues, consider logging the validation results instead.
- Logging entire request headers could expose sensitive information. Please be more selective about what gets logged.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🔴 Security: 2 blocking issues
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
# if client_ip not in telegram_ips: | ||
# raise PermissionDenied("Invalid IP address") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚨 issue (security): Consider re-enabling the IP validation check for security
Commented out IP validation could expose the endpoint to requests from unauthorized sources. If there's a specific reason for disabling this check, consider implementing alternative security controls.
@@ -42,6 +46,8 @@ def telebot_respond(request): | |||
# if client_ip not in telegram_ips: | |||
# raise PermissionDenied("Invalid IP address") | |||
|
|||
logger.info(request.headers) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚨 suggestion (security): Avoid logging raw request headers as they may contain sensitive information
Consider logging only specific headers needed for debugging or implement header filtering to redact sensitive data before logging.
safe_headers = {k: v for k, v in request.headers.items() if k.lower() in ['user-agent', 'content-type', 'content-length']}
logger.info(safe_headers)
Summary by Sourcery
Enhancements: