Skip to content
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

Merged
merged 1 commit into from
Oct 26, 2024
Merged

Conversation

alimaktabi
Copy link
Collaborator

@alimaktabi alimaktabi commented Oct 26, 2024

Summary by Sourcery

Enhancements:

  • Add logging to capture request headers for debugging purposes.

Copy link
Contributor

sourcery-ai bot commented Oct 26, 2024

Reviewer's Guide by Sourcery

This 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

Change Details Files
Added logging setup and request header logging in the Telegram bot view
  • Imported the logging module
  • Initialized a logger instance for the module
  • Added a log statement to capture request headers before token validation
telegram/views.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@alimaktabi alimaktabi merged commit 47014e8 into develop Oct 26, 2024
1 check passed
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines 46 to 47
# if client_ip not in telegram_ips:
# raise PermissionDenied("Invalid IP address")
Copy link
Contributor

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)
Copy link
Contributor

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant