Skip to content

Conversation

@okorneliuk
Copy link
Contributor

@okorneliuk okorneliuk commented Nov 22, 2024

Q A
Bugfix? ✔️
Breaks BC?
New feature?

Got rid of deprecations like following:

Deprecated: Spiral\RoadRunner\Worker::hasPayload(): Implicitly marking parameter $class as nullable is deprecated, the explicit nullable type must be used instead in app/vendor/spiral/roadrunner-worker/src/Worker.php on line 121

My gRPC service does not run because of these deprecations.

Summary by CodeRabbit

  • New Features

    • Enhanced flexibility in payload handling by allowing nullable string parameters in key methods of the Worker class and interface.
  • Bug Fixes

    • Improved type hinting for method parameters in the Worker class and interface, ensuring clearer expectations for input values.

@coderabbitai
Copy link

coderabbitai bot commented Nov 22, 2024

Walkthrough

The changes in this pull request involve updating the method signatures of several functions in the Worker class and the WorkerInterface. Specifically, the parameters for the methods hasPayload, getPayload, and findPayload have been modified to accept nullable string types. This allows these methods to accept null as a valid argument while maintaining the existing logic and functionality of payload handling.

Changes

File Change Summary
src/Worker.php Updated method signatures: hasPayload(string $class = null) to hasPayload(?string $class = null)
getPayload(string $class = null) to getPayload(?string $class = null)
findPayload(string $class = null) to findPayload(?string $class = null)
src/WorkerInterface.php Updated method signatures: hasPayload(string $class = null) to hasPayload(?string $class = null)
getPayload(string $class = null) to getPayload(?string $class = null)

Poem

In the meadow where bunnies play,
Changes come in a subtle way.
Nullable strings, oh what a treat,
Making methods more flexible and neat!
Hopping along with joy and cheer,
Our code is better, let’s give a cheer! 🐇✨


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>, please review it.
    • 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 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 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 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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
src/Worker.php (1)

Line range hint 138-143: Update PHPDoc to reflect nullable parameter.

The method signature correctly marks the parameter as nullable, but the PHPDoc should be updated to match.

- * @param class-string<Payload>|null $class
+ * @param ?class-string<Payload> $class
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 44c6f37 and 570c208.

📒 Files selected for processing (2)
  • src/Worker.php (2 hunks)
  • src/WorkerInterface.php (1 hunks)
🔇 Additional comments (6)
src/WorkerInterface.php (3)

54-54: LGTM! Correctly addresses PHP 8.4 deprecation.

The change from string $class = null to ?string $class = null properly addresses the PHP 8.4 deprecation by making the nullable parameter explicit while maintaining backward compatibility.


62-62: LGTM! Correctly addresses PHP 8.4 deprecation.

The change from string $class = null to ?string $class = null properly addresses the PHP 8.4 deprecation by making the nullable parameter explicit while maintaining backward compatibility.


54-62: Verify interface implementations are updated.

Since we're modifying an interface, let's ensure all implementing classes have been updated with the new method signatures.

✅ Verification successful

Interface implementations are correctly updated

The verification shows that Worker class in src/Worker.php is the only implementation of WorkerInterface, and it correctly implements both methods with matching signatures:

  • hasPayload(?string $class = null): bool
  • getPayload(?string $class = null): ?Payload
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find all PHP files that might implement WorkerInterface
echo "Searching for WorkerInterface implementations..."
rg -l "implements.*WorkerInterface" --type php

# Look for hasPayload and getPayload method signatures
echo "Checking method signatures in potential implementations..."
rg "(?:public|protected|private)\s+function\s+(?:hasPayload|getPayload)\s*\([^)]*\)" \
   --type php \
   --multiline \
   --ignore-case

Length of output: 749

src/Worker.php (3)

Line range hint 126-136: LGTM: Consistent nullable parameter handling.

The method signature change is correct and the implementation properly handles the nullable parameter. The return type was already correctly marked as nullable.


121-124: LGTM: Explicit nullable parameter declaration.

The change correctly addresses the PHP 8.4 deprecation by making the nullable parameter explicit in the method signature. This maintains backward compatibility while following PHP 8.4 best practices.

Let's verify the interface alignment:

✅ Verification successful

✓ Method signature correctly aligns with interface

The hasPayload method signature in Worker.php perfectly matches the declaration in WorkerInterface.php, both using ?string $class = null: bool. The change maintains the contract while addressing PHP 8.4 deprecations.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify that WorkerInterface has the same nullable parameter declaration
ast-grep --pattern 'interface WorkerInterface {
  $$$
  hasPayload(?string $class = null): bool
  $$$
}'

Length of output: 106


Script:

#!/bin/bash
# Let's first find the interface file
fd -e php WorkerInterface

# Then check the content of the interface file
rg -B2 -A2 "hasPayload" --type php

Length of output: 1412


Line range hint 121-143: Verify no other implicit nullable parameters.

The changes correctly address the PHP 8.4 deprecation warnings for the payload-related methods. Let's verify there are no other implicit nullable parameters in the codebase that might trigger similar warnings.

✅ Verification successful

All nullable parameters are properly typed, no action needed

The codebase scan shows all method parameters with default null values already have explicit nullable type declarations (?string, ?int). This includes:

  • hasPayload(?string $class = null)
  • getPayload(?string $class = null)
  • findPayload(?string $class = null)
  • respond(Payload $payload, ?int $codec = null)
  • send(string $body = '', string $header = '', bool $eos = true, ?int $codec = null)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other method parameters with default null that might need explicit nullable type
ast-grep --pattern 'function $NAME($PARAM = null)'

Length of output: 52


Script:

#!/bin/bash
# Search for method parameters with default null using ripgrep
rg "function.*\(.*=\s*null.*\)" --type php -A 1

Length of output: 840

@roxblnfk roxblnfk merged commit dd0571a into roadrunner-php:3.x Nov 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants