Refactor Auth::encodeCredentials to remove utf8_encode and update Cli…

[shimonewman]

…ent constructor to conditionally use coroutines

Summary by CodeRabbit

• New Features

  • Improved handling of coroutine usage for client connections, now defaulting to synchronous mode unless explicitly enabled and supported.

• Refactor

  • Updated credential encoding to simplify processing.
  • Changed the default behavior for client instantiation to enhance reliability in non-coroutine environments.

[coderabbitai]

Walkthrough

The changes update the authentication credential encoding in Auth.php by removing UTF-8 encoding before hashing. In Client.php, the default for coroutine usage is set to false, and additional runtime checks ensure coroutine clients are only used in valid coroutine contexts, otherwise defaulting to synchronous clients.

Changes

Cohort / File(s)	Change Summary
Auth Encoding Update src/Auth.php	Removed utf8_encode from the credential string before MD5 hashing in encodeCredentials.
Client Coroutine Handling src/Client.php	Changed default $useCoroutine to false; added checks to ensure coroutines are only used in valid contexts.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

A hop and a skip, credentials now hash
Without extra encoding, in a single flash.
The client’s more cautious, coroutines on hold—
Only when ready, their stories unfold.
With every small tweak, our warren runs right,
CodeRabbit’s delight, in the soft morning light!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 da22379 and cf12c21.

📒 Files selected for processing (1)

• src/Client.php (2 hunks)

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

• src/Client.php

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Tests (8.3)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat-use-coroutine

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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.

[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 b7a4901 and da22379.

📒 Files selected for processing (2)

• src/Auth.php (1 hunks)
• src/Client.php (2 hunks)

🧰 Additional context used

🪛 GitHub Actions: Linter

src/Client.php

[error] 1-1: Laravel Pint PSR-12 linting failed: single_line_after_imports style issue detected.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Tests (8.3)

🔇 Additional comments (3)

src/Auth.php (1)

284-287: LGTM! Good modernization by removing deprecated utf8_encode.

Removing utf8_encode is the correct approach since it was deprecated in PHP 8.2 and will be removed in PHP 9.0. The function was often problematic and for MongoDB's SCRAM-SHA-1 authentication, the credentials should be hashed directly without encoding transformations.

src/Client.php (2)

84-84: LGTM! More conservative default for coroutine usage.

Changing the default from true to false is a safer approach, ensuring coroutines are only used when explicitly requested and properly validated.

---

91-101: Excellent coroutine context validation.

The runtime validation ensures coroutines are only used in valid coroutine contexts by checking Swoole\Coroutine::getCid(). The try-catch block properly handles cases where Swoole might not be available or configured correctly.

This prevents runtime errors that could occur when attempting to use coroutine clients outside of a coroutine context.