GitAuto: [FEATURE] Implement Queue wrapper

[gitauto-ai]

Resolves #82

What is the feature

Implement a Queue wrapper for AMQP to provide basic messaging functionalities including:

• Explicitly sending messages to a queue.
• Explicitly receiving messages from a queue.
• Implicitly declaring queues and Dead Letter Exchanges (DLX).
• Allowing consumption/sending without declaring the DLX queue by introducing a new private method and adding an optional parameter to the send/receive methods.
• Refactoring the code to support multiple servers:
  • The publish method uses a random server.
  • The consume method loops through all servers.
• Injecting an array of servers through the constructor.
• Modifying the consume method to accept optional parameters for QoS length (currently fixed at 10).

Why we need the feature

• Standardization: Provides a unified interface for queue operations, simplifying the codebase.
• Flexibility: Allows different configurations for declaring queues, with or without DLX, based on requirements.
• Scalability: Supporting multiple servers enhances load balancing and fault tolerance.
• Customization: Introducing optional QoS parameters in the consume method allows fine-tuning of message consumption.
• Maintainability: Refactoring and injecting configurations improve code readability and ease of testing.
• Performance: Random selection of servers for publishing can distribute the load evenly.

Implementing this feature enhances the messaging capabilities, promotes better design practices, and prepares the system for future scalability needs.

How to implement and why

1. Refactor the Queue Class:

   • Modify the constructor to accept an array of server configurations.

     public function __construct(array $servers)
     {
         $this->connectionStrings = $servers;
     }

   • This allows injecting multiple servers and improves testability.

2. Implement Methods for Queue Declaration:

   • Create declareQueueWithDLX and declareQueueWithoutDLX methods.

     private function declareQueueWithDLX($channel, $queueName)
     {
         // Existing implementation
     }
     
     private function declareQueueWithoutDLX($channel, $queueName)
     {
         // Implement declaration without DLX
     }

   • Add an optional parameter to choose between DLX and non-DLX queue declarations in publish and consume methods.

3. Modify the publish Method:

   • Add an optional parameter $useDLX = true.
   • Based on $useDLX, call the appropriate queue declaration method.

     public function publish($queueName, $message, $useDLX = true)
     {
         // ...
         if ($useDLX) {
             $this->declareQueueWithDLX($channel, $queueName);
         } else {
             $this->declareQueueWithoutDLX($channel, $queueName);
         }
         // ...
     }

   • Use a random server connection for publishing to distribute load.

4. Modify the consume Method:

   • Add optional parameters $prefetchCount = 10, $useDLX = true.
   • Use these parameters to set QoS and queue declaration.

     public function consume($timeout, $queueName, $callback, $resetTimeoutOnReceive = false, $prefetchCount = 10, $useDLX = true)
     {
         // ...
         if ($useDLX) {
             $this->declareQueueWithDLX($channel, $queueName);
         } else {
             $this->declareQueueWithoutDLX($channel, $queueName);
         }
         $channel->basic_qos(null, $prefetchCount, null);
         // ...
     }

   • Loop through all server connections to consume messages.

5. Handle Multiple Servers:

   • Update getConnection method to handle multiple servers.

     private function getConnection()
     {
         $servers = $this->getServers();
         $options = ['connection_timeout' => 10.0, 'read_write_timeout' => 10.0];
         return AMQPStreamConnection::create_connection($servers, $options);
     }

   • In publish, select a random server.
   • In consume, iterate over all servers to ensure messages are consumed from all queues.

6. Remove Hardcoded Configurations:

   • Eliminate hardcoded values and receive configurations as parameters.
   • Improves flexibility and allows different environments to use different settings.

7. Add Documentation and Tests:

   • Document all public methods and their parameters.
   • Provide examples on how to use the new features.
   • Write unit tests covering:
     • Message sending and receiving.
     • Queue declaration with and without DLX.
     • Multiple server connections.
     • Consumption with different QoS settings.

8. Rename Methods for Clarity:

   • Rename declareQueueAndDLX to declareQueueWithDLX for consistency.
   • Ensures code is self-explanatory and maintainable.

9. Ensure Code Quality:

   • Follow coding standards and best practices.
   • Handle exceptions gracefully to prevent crashes.
   • Validate inputs to prevent unexpected behaviors.

About backward compatibility

• Constructor Changes:

  • The constructor now expects an array of servers.
  • This breaks backward compatibility for any instantiation without parameters.
  • Resolution: Provide a default configuration or an alternative constructor to maintain compatibility.

• Method Signatures:

  • Added optional parameters with default values to publish and consume methods.
  • Existing code using these methods will continue to work without changes.

• Recommendation:

  • Update dependent code to pass server configurations explicitly.
  • This change is essential for supporting multiple servers and cannot be avoided.
  • The benefits of the new features outweigh the compatibility concerns.

By carefully managing the changes and providing defaults where possible, we minimize the impact on existing code while introducing valuable new features.

Test these changes locally

git checkout -b gitauto/issue-#82-51f588c0-a7e2-45bc-b113-f193f86e4d7f
git pull origin gitauto/issue-#82-51f588c0-a7e2-45bc-b113-f193f86e4d7f

[deepsource-io]

Here's the code health analysis summary for commits a48dfab..24dfd99. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Test coverage	⚠️ Artifact not reported	Timed out: Artifact was never reported	View Check ↗
SQL	✅ Success		View Check ↗
Secrets	✅ Success		View Check ↗
PHP	❌ Failure	❗ 6 occurences introduced	View Check ↗
Docker	✅ Success		View Check ↗

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[github-advanced-security]

Phpcs (reported by Codacy) found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 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.

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

2:46PM INF scanning for exposed secrets...
2:46PM INF 225 commits scanned.
2:46PM INF scan completed in 441ms
2:46PM INF no leaks found