Reorder conversion methods in ParamConverter and binary check for logging

[koriym]

Close #57

BC Berak

This PR breaks backwards compatibility ( even though it is minor) as it changes the order of processing in ParamConverter. The release is incremented by the minor version.

Summary by CodeRabbit

• New Features
  • Enhanced the logging mechanism to include encoding of values for better data integrity and security.
• Bug Fixes
  • Improved parameter conversion logic by optimizing the order of checks, enhancing the handling and conversion of data types.
• Chores
  • Updated system requirements to include the ext-mbstring PHP extension for better multilingual support.

[coderabbitai]

Walkthrough

The updates involve adding support for the ext-mbstring PHP extension, enhancing the logging functionality to handle binary data more robustly, and modifying the order of type checks in ParamConverter. These changes aim to improve data handling and extend functionality, ensuring better compatibility and error handling in specific scenarios.

Changes

File Path	Change Summary
composer.json	Added requirement for ext-mbstring PHP extension.
src/MediaQueryLogger.php	Introduced function imports and added logic for encoding values before logging.
src/ParamConverter.php	Swapped order of checks for __toString method and ToScalarInterface implementation.

Assessment against linked issues

Objective	Addressed	Explanation
Handle binary Uuid values in logging (Issue #57)	✅	The changes in MediaQueryLogger.php include enhancements to handle binary data, specifically targeting the issue with Uuid values.

🐇✨
A hop, a skip, a code deploy,
With new checks and imports, oh boy!
Strings and binaries, log with ease,
With every commit, we aim to please.
Let's munch on carrots, celebrate this feat,
For bugs are gone, our code now neat! 🥕🎉
🐇✨

---

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

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

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration 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.

[koriym]

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

[coderabbitai]

Actionable comments posted: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9f79cab and e7e8643.

Files selected for processing (3)

• composer.json (1 hunks)
• src/MediaQueryLogger.php (2 hunks)
• src/ParamConverter.php (1 hunks)

Additional comments not posted (4)

src/MediaQueryLogger.php (2)

9-13: Ensure the newly imported functions are used appropriately throughout the code.

---

33-41: The logic to handle non-UTF-8 strings by encoding them in base64 is a good solution to the binary data issue in logs.

src/ParamConverter.php (1)

38-44: Changing the order of type checks to prioritize scalar conversion over string conversion is a good practice for data integrity.

composer.json (1)

14-14: Adding ext-mbstring to handle multi-byte strings is necessary for the new functionality in logging binary data.

[koriym]

@toby-griffiths What do you think?

[toby-griffiths]

@koriym Looks good to me. I think the AI bot has a point about the readabilty of the comment. It's suggested reads better to me than the original.

[koriym]

@NaokiTsuchiya merged!

[koriym]

@toby-griffiths Do you think this interface change is still necessary?

public function log(string $queryId, array $values, array $originalValues = []): void;