Add nullable parameter to CipherParams in src/Models/BaseMessage.php …

[mclark-ably]

… and update tests/ChannelMessagesTest::testEncodingInteroperabilityAblyToRaw

Summary by CodeRabbit

• Improvements
  • Enhanced method signatures to support nullable cipher parameters, increasing flexibility in handling cases where parameters may not be provided.
  • Updated test cases to improve message encoding validation and error handling, ensuring robustness in encoding checks.

[coderabbitai]

Walkthrough

The pull request introduces modifications to the BaseMessage class in the src/Models/BaseMessage.php file, specifically updating the method signatures of two static methods: fromEncoded and fromEncodedArray. The changes involve explicitly marking the $cipherParams parameter as nullable using the ? type hint, addressing potential deprecation warnings in PHP 8.4 related to implicitly nullable parameters.

Changes

File	Change Summary
src/Models/BaseMessage.php	Updated method signatures for fromEncoded and fromEncodedArray to explicitly use ?CipherParams for nullable type hinting
tests/ChannelMessagesTest.php	Enhanced test assertions in testEncodingInteroperabilityRawToAbly and testEncodingInteroperabilityAblyToRaw methods

Possibly related issues

• ably/ably-php#206: Directly addresses the PHP 8.4 deprecation warning about implicitly marking parameters as nullable, specifically in the BaseMessage class methods.

Poem

🐰 Nullable Whiskers, Code so Bright
Parameters dance with type delight
PHP 8.4 warns with grace
We fix the type with a rabbit's embrace
Explicit nulls, no more implicit might! 🔧

---

📜 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 0850e77 and c2bcab9.

📒 Files selected for processing (1)

• tests/ChannelMessagesTest.php (2 hunks)

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

• tests/ChannelMessagesTest.php

⏰ Context from checks skipped due to timeout of 90000ms (14)

• GitHub Check: check (8.3, msgpack)
• GitHub Check: check (8.3, json)
• GitHub Check: check (8.2, msgpack)
• GitHub Check: check (8.2, json)
• GitHub Check: check (8.1, msgpack)
• GitHub Check: check (8.1, json)
• GitHub Check: check (8, msgpack)
• GitHub Check: check (8, json)
• GitHub Check: check (7.4, msgpack)
• GitHub Check: check (7.4, json)
• GitHub Check: check (7.3, msgpack)
• GitHub Check: check (7.3, json)
• GitHub Check: check (7.2, msgpack)
• GitHub Check: check (7.2, json)

---

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 1

📜 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 0850e77.

📒 Files selected for processing (2)

• src/Models/BaseMessage.php (2 hunks)
• tests/ChannelMessagesTest.php (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (14)

• GitHub Check: check (8.3, msgpack)
• GitHub Check: check (8.3, json)
• GitHub Check: check (8.2, msgpack)
• GitHub Check: check (8.2, json)
• GitHub Check: check (8.1, msgpack)
• GitHub Check: check (8.1, json)
• GitHub Check: check (8, msgpack)
• GitHub Check: check (8, json)
• GitHub Check: check (7.4, msgpack)
• GitHub Check: check (7.4, json)
• GitHub Check: check (7.3, msgpack)
• GitHub Check: check (7.3, json)
• GitHub Check: check (7.2, msgpack)
• GitHub Check: check (7.2, json)

🔇 Additional comments (4)

src/Models/BaseMessage.php (2)

117-117: LGTM! Explicit nullable type hint improves code clarity.

The change to make the $cipherParams parameter explicitly nullable using ?CipherParams aligns with PHP 8.4's deprecation of implicit nullable parameters.

---

141-141: LGTM! Consistent nullable type hint usage.

The change maintains consistency with fromEncoded method by using the same nullable type hint pattern.

tests/ChannelMessagesTest.php (2)

494-494: Formatting change.

---

547-547: LGTM! Improved null handling in assertion.

The updated assertion properly handles cases where the encoding property might not be set.