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 exception handling #641

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:

  • Implement a custom exception handler for the Telegram bot to improve error logging and reporting.

Copy link
Contributor

sourcery-ai bot commented Oct 26, 2024

Reviewer's Guide by Sourcery

This PR implements a custom exception handling system for the Telegram bot. The implementation adds a new ExceptionHandler class that captures, logs, and reports exceptions to a designated Telegram channel with detailed formatting and timestamps.

Sequence diagram for exception handling and reporting

sequenceDiagram
    participant User
    participant Bot as TelegramBot
    participant Handler as ExceptionHandler
    participant Messenger as TelegramMessenger
    participant Logger
    participant Settings

    User->>Bot: Trigger an action
    Bot->>Handler: Exception occurs
    Handler->>Logger: Log exception with timestamp
    Handler->>Messenger: Send formatted exception message
    Messenger->>Settings: Retrieve TELEGRAM_BUG_REPORTER_CHANNEL_ID
    Messenger->>User: Notify about the error
Loading

File-Level Changes

Change Details Files
Implemented a custom exception handler for the Telegram bot
  • Created new ExceptionHandler class that inherits from telebot's ExceptionHandler
  • Added timestamp tracking for exception occurrences
  • Implemented detailed exception logging with traceback information
  • Added formatted message creation with exception details and timestamps
  • Set up exception reporting to a dedicated Telegram channel
  • Modified bot initialization to use the custom exception handler
telegram/bot.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 23537f7 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 they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟡 Security: 1 issue found
  • 🟢 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.


from telegram.models import TelegramConnection


logger = logging.getLogger(__name__)

telebot_instance = telebot.TeleBot(settings.TELEGRAM_BOT_API_KEY)

class ExceptionHandler(ExceptionHandler):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): The ExceptionHandler class name shadows the imported ExceptionHandler from telebot

Consider renaming this class to something more specific like TelegramExceptionHandler to avoid naming conflicts and potential confusion

timestamp = timezone.now().strftime("%d/%m/%Y, %H:%M:%S")

logger.error(f"Custom exception handler triggered for {exception}: {timestamp}")
traceback.print_exception(type(exception), exception, exception.__traceback__)
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): Indiscriminate exception handling could expose sensitive information

Consider implementing exception filtering or sanitization before logging and sending to Telegram. Not all exceptions should be treated equally, and some might contain sensitive data

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