Remove custom JSON exceptions

[Strift]

Pull Request

Related issue

Fixes #526

What does this PR do?

• Remove custom JsonEncodingException and JsonDecodingException
• Let json_encode and json_decode throw JsonException
• Change the error messages (uses the default error message syntax)

PR checklist

Please check if your PR fulfills the following requirements:

• Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

• Refactor

  • Replaced custom JSON exception handling with standard PHP JSON exceptions throughout the application.
  • Removed custom exception classes related to JSON encoding and decoding.

• Tests

  • Updated tests to expect standard PHP JSON exceptions and simplified error messages.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

All usages and references to the custom exceptions JsonEncodingException and JsonDecodingException have been removed from the codebase. The code now directly uses PHP's built-in \JsonException for JSON encoding and decoding errors, updating both implementation and related documentation and tests accordingly.

Changes

File(s)	Change Summary
src/Contracts/Http.php, src/Http/Serialize/SerializerInterface.php	Updated PHPDoc @throws annotations to use \JsonException instead of custom exceptions; removed imports.
src/Exceptions/JsonEncodingException.php, src/Exceptions/JsonDecodingException.php	Deleted custom exception classes.
src/Http/Client.php	Updated PHPDoc @throws annotations to reference \JsonException; removed imports of custom exceptions.
src/Http/Serialize/Json.php	Removed try-catch blocks and rethrowing of custom exceptions; now directly allows \JsonException to propagate.
tests/Endpoints/DocumentsTest.php, tests/Http/ClientTest.php, tests/Http/Serialize/JsonTest.php	Updated tests to expect \JsonException and revised expected messages; removed imports of custom exceptions.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant JsonSerializer

    Caller->>JsonSerializer: serialize($data) / unserialize($string)
    JsonSerializer->>JsonSerializer: json_encode/json_decode(..., JSON_THROW_ON_ERROR)
    alt On JSON error
        JsonSerializer-->>Caller: throws \JsonException
    else Success
        JsonSerializer-->>Caller: returns result
    end

Loading

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Remove JsonEncodingException & JsonDecodingException (#526)	✅

Poem

A hop and a skip, exceptions take flight,
No more custom wrappers—PHP’s own feels right!
The code is now lighter, the tests are all keen,
JSON errors caught, crisp and clean.
🐇✨ Hooray for simplicity, as neat as can be!

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

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.

[Strift]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.