Stickerify icon indicating copy to clipboard operation
Stickerify copied to clipboard

Divide custom exception into specific ones

Open rob93c opened this issue 1 year ago • 1 comments

Along with a major exception overhaul, this pull request also removes the use of the recently deprecated method disableWebPagePreview.

Summary by CodeRabbit

  • New Features

    • Enhanced error handling for Telegram API interactions and file operations.
    • Introduced new exception classes for better specificity in error reporting.
  • Bug Fixes

    • Improved error management across multiple components, ensuring more descriptive error messages.
  • Refactor

    • Updated methods to throw more specific exceptions related to media processing and command execution.
  • Style

    • Renamed fields and methods for improved clarity, such as updating disableWebPreview to disableLinkPreview.

rob93c avatar Aug 04 '24 13:08 rob93c

Walkthrough

Walkthrough

The recent changes enhance error handling and code coverage reporting in the Stickerifier application. New exception classes, including BaseException, FileOperationException, and MediaException, have been introduced for precise error management. Additionally, the build.gradle file now excludes specific classes from the JaCoCo coverage report, streamlining the analysis. Overall, these updates improve the robustness, maintainability, and functionality of the codebase.

Changes

Files Change Summary
build.gradle Added exclusion pattern for JaCoCo coverage report to omit files in the stickerify/exception directory.
src/main/java/com/github/stickerifier/stickerify/bot/Stickerify.java Enhanced error handling with new exception types and refined method signatures for clarity.
src/main/java/com/github/stickerifier/stickerify/exception/*.java Introduced new exception classes (BaseException, FileOperationException, MediaException, etc.) to improve error management.
src/main/java/com/github/stickerifier/stickerify/media/MediaHelper.java Updated methods to throw more specific exceptions, clarifying error reporting.
src/main/java/com/github/stickerifier/stickerify/process/*.java Changed exception handling to utilise ProcessException, refocusing error management strategies.
src/test/java/com/github/stickerifier/stickerify/media/MediaHelperTest.java Updated test cases to assert MediaException instead of TelegramApiException, reflecting new behaviour.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Bot
    participant MediaHelper
    participant ExceptionHandler
    
    User->>Bot: Send media file
    Bot->>MediaHelper: Process media
    MediaHelper->>MediaHelper: Validate media
    MediaHelper->>ExceptionHandler: Throw MediaException if invalid
    ExceptionHandler-->>Bot: Handle MediaException
    Bot-->>User: Notify failure

Poem

In the garden of code, a rabbit hops high,
With exceptions anew, watch the errors fly by!
JaCoCo now skips what it doesn’t need,
As we refine our paths, sowing seeds of good deed.
Hooray for the changes, let’s dance and rejoice,
In a world of clean code, we hear the right voice! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Aug 04 '24 13:08 coderabbitai[bot]