Added the codec parameter to the worker's respond method

[msmakouz]

Q	A
Bugfix?	❌
Breaks BC?	❌
New feature?	✔️
Issues	roadrunner-php/issues#13

What's changed

This change allows sending the codec in the respond method. For RoadRunner 2024, this is required. In RoadRunner 2023, is optional.

[coderabbitai]

Walkthrough

The recent update introduces modifications to the handling of codecs in the Worker class of a PHP project, specifically targeting the respond and send methods. These methods now accept an additional $codec parameter, allowing for the specification of the codec used for encoding the payload header. This change is temporary, as the default codec will be set to Frame::CODEC_PROTO in the upcoming version 4.0. Additionally, a new test case ensures the correct behavior of these modifications across different codecs.

Changes

File	Change Summary
src/.../Worker.php	Added $codec parameter to respond and send methods; Frame::CODEC_PROTO will be the default codec in v4.0.
tests/.../WorkerTest.php	Introduced testRespond to validate respond method with different codecs.

🐇✨
In the land of code, where the bits do roam,
A rabbit hopped in, making changes its home.
"A tweak here and there," it said with glee,
To handle codecs more gracefully.
So hop and cheer for the updates so bright,
For cleaner code takes flight tonight.
🌟📦

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.72%. Comparing base (8efc721) to head (ee6f54b).

Additional details and impacted files

@@             Coverage Diff              @@
##                3.x      #36      +/-   ##
============================================
+ Coverage     52.96%   56.72%   +3.75%     
- Complexity      100      101       +1     
============================================
  Files            11       11              
  Lines           236      238       +2     
============================================
+ Hits            125      135      +10     
+ Misses          111      103       -8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8efc721 and 3690076.

Files ignored due to path filters (1)

• composer.json is excluded by: !**/*.json

Files selected for processing (2)

• src/Worker.php (3 hunks)
• tests/Unit/WorkerTest.php (1 hunks)

Additional comments: 4

tests/Unit/WorkerTest.php (2)

• 16-30: The test method testRespond is well-implemented, using a data provider to test different codec scenarios. It correctly sets up a mock RelayInterface, asserts the expected behavior, and aligns with the PR objectives.
• 32-37: The data provider respondDataProvider is correctly implemented, yielding different codec scenarios for testing. This thorough approach ensures the new feature is robust and functions as intended.

src/Worker.php (2)

• 98-106: The addition of the $codec parameter to the respond method is correctly implemented and documented. This change aligns with the PR objectives, enhancing the method's flexibility and preparing for future requirements.
• 215-224: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [206-220]

The addition of the $codec parameter to the send method is correctly implemented. The method appropriately sets the codec flag on the Frame object based on the codec used, aligning with the PR objectives.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 3690076 and ee6f54b.

Files selected for processing (1)

• src/Worker.php (3 hunks)

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

• src/Worker.php