Improve increment exceptions

[abnegate]

Summary by CodeRabbit

• Bug Fixes
  • Improved error messages for attribute updates by providing more specific error types when invalid data types or value limits are encountered.

[coderabbitai]

Walkthrough

The changes refine error handling in database attribute operations by introducing a new TypeException class and updating two methods to throw more specific exceptions for type and limit violations. No public interfaces were altered; adjustments are internal to exception handling logic.

Changes

File(s)	Change Summary
src/Database/Database.php	Modified methods to throw TypeException for type errors, LimitException for limit errors; changed attribute removal key from $internalId to $sequence.
src/Database/Exception/Type.php	Added new TypeException class extending the base Exception.

Poem

In the warren of code, exceptions now bloom,
With types and limits, they banish the gloom.
No more generic errors, each has its place,
Rabbits rejoice at this logical grace.
Hopping through fields where bugs are few—
Precise exceptions, a dream come true!
🐇✨

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2349d88 and 09196fb.

📒 Files selected for processing (1)

• src/Database/Database.php (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/Database/Database.php

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: CodeQL

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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]

Actionable comments posted: 0

🧹 Nitpick comments (3)

src/Database/Exception/Type.php (3)

1-4: Consider enabling strict types for consistency.

If your codebase enforces strict typing, add:

declare(strict_types=1);

immediately after the <?php tag to catch type mismatches earlier.

---

5-6: Disambiguate the imported base Exception.

Importing Utopia\Database\Exception into the same-named namespace can be confusing. Consider aliasing the base class:

-use Utopia\Database\Exception;
+use Utopia\Database\Exception as BaseException;

Then update your class signature:

class Type extends BaseException

---

7-9: Add a brief doc-block to the exception.

A short description helps future maintainers understand the intent of this marker exception. For example:

/**
 * Thrown when a document attribute operation fails due to a type violation.
 */

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b2622d and 2349d88.

📒 Files selected for processing (2)

• src/Database/Database.php (3 hunks)
• src/Database/Exception/Type.php (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/Database/Database.php (3)

src/Database/Exception.php (1)

• Exception (7-21)

src/Database/Exception/Type.php (1)

• Type (7-9)

src/Database/Document.php (1)

• getAttribute (212-219)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Setup & Build Docker Image

🔇 Additional comments (5)

src/Database/Database.php (5)

21-21: LGTM: Proper import for TypeException usage.

The import follows the established naming convention and is necessary for the more specific exception handling below.

---

5147-5147: LGTM: Improved exception specificity for type validation.

Changing from DatabaseException to TypeException provides better error categorization for type validation failures, making it easier for consumers to handle different error scenarios appropriately.

---

5151-5151: LGTM: Improved exception specificity for limit validation.

Changing from DatabaseException to LimitException provides better error categorization for limit validation failures and maintains consistency with other limit checks in the codebase.

---

5238-5238: LGTM: Consistent exception specificity improvement.

This change mirrors the improvement made in increaseDocumentAttribute, providing consistent and more specific error handling for type validation across both increment/decrement operations.

---

5242-5242: LGTM: Consistent limit validation improvement.

This change maintains consistency with the increaseDocumentAttribute method by using LimitException for limit validation failures, improving error categorization for minimum limit violations.