Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PHP 8.4 - Fixed implicitly nullable parameter issue in BaseMessage Model #207

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alexscott64
Copy link

@alexscott64 alexscott64 commented Dec 18, 2024

This fixes the deprecation notice for PHP8.4 regarding implicitly nullable parameters.

#206

Summary by CodeRabbit

  • New Features

    • Enhanced flexibility in message creation by allowing nullable cipher parameters in two static methods.
  • Bug Fixes

    • Updated method signatures to accept null values for cipher parameters, improving functionality.

Copy link

coderabbitai bot commented Dec 18, 2024

Walkthrough

The pull request modifies the BaseMessage class in the PHP project by updating method signatures for two static methods: fromEncoded and fromEncodedArray. The changes explicitly add nullable type hints to the $cipherParams parameter, allowing these methods to accept null values more clearly. This update addresses potential deprecation warnings in newer PHP versions by making the nullable nature of the parameter explicit.

Changes

File Change Summary
src/Models/BaseMessage.php Updated method signatures for fromEncoded and fromEncodedArray to use explicit nullable type hints for $cipherParams

Possibly related issues

  • ably/ably-php#206: Directly addresses the PHP 8.4 deprecation warning about implicitly marking parameters as nullable
    • The changes in this PR precisely match the issue description
    • Resolves the deprecation warning for parameter type hints

Poem

🐰 Nullable Whiskers, Code so Bright

In PHP's realm, types take flight
Explicit hints, no more implicit might
$cipherParams now clear and light
A rabbit's refactor, pure delight!

🔍✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 420f97d and 32a4c13.

📒 Files selected for processing (1)
  • src/Models/BaseMessage.php (2 hunks)
🔇 Additional comments (3)
src/Models/BaseMessage.php (3)

117-117: LGTM! Proper nullable type hint added.

The change correctly addresses PHP 8.4's deprecation notice by making the nullable parameter explicit with the ? operator. The implementation remains safe as it already includes proper null checks.


141-141: LGTM! Proper nullable type hint added.

The change correctly addresses PHP 8.4's deprecation notice by making the nullable parameter explicit with the ? operator. The implementation remains safe as it delegates to fromEncoded which properly handles null values.


Line range hint 117-141: Verify comprehensive coverage of PHP 8.4 nullable parameter deprecation.

Let's ensure we've caught all instances of implicit nullable parameters in the codebase.

✅ Verification successful

Based on the search results, I can now generate a final response:

All nullable parameter instances have been properly handled with explicit type hints.

The search results show that while there are many functions with null default values in the codebase, the specific instances in BaseMessage.php for the CipherParams parameter have been properly updated with explicit nullable type hints (?CipherParams). No other instances were found where implicit nullable parameters need to be updated for PHP 8.4 compatibility.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other potential instances of implicit nullable parameters
# Pattern: parameter with default null but without explicit nullable type hint

# Look for method parameters with = null but without ? prefix
rg "function.*\([^)]*\s+\$\w+\s*=\s*null[^)]*\)" --type php

# Look for constructor parameters with = null but without ? prefix
rg "__construct.*\([^)]*\s+\$\w+\s*=\s*null[^)]*\)" --type php

# Look for other potential parameter patterns that might need updating
ast-grep --pattern 'function $FNAME($PARAMS) { $$$
}' --lang php

Length of output: 191


Script:

#!/bin/bash
# Let's try a different approach to find nullable parameters

# Search for method parameters with null default value
rg "function.*\([^)]*=\s*null" --type php

# Search specifically for CipherParams with null default
rg "CipherParams.*=\s*null" --type php

# Look for function declarations with potential nullable parameters
rg "function.*\([^)]*\)" --type php -A 1

# Use ast-grep to find function declarations with parameters
ast-grep --pattern 'function $NAME($PARAMS = null) { $$$
}' --lang php

Length of output: 69764


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.

@alexscott64
Copy link
Author

Came back to this after the holidays. It looks like the issue is with PHP 7.x versions. Just wondering if there is a reason those are still being supported? Currently PHP 7.x and PHP 8.0 are EOL and are thus insecure to use.

https://www.php.net/supported-versions.php

@sacOO7
Copy link
Collaborator

sacOO7 commented Jan 9, 2025

Hi @alexscott64 thanks for creating the PR. We will check and get back to you 👍
I'm not sure why checks are failing for older versions of PHP though : (

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants