feat: add workerStop handling

[basert]

Summary by CodeRabbit

• Bug Fixes
  • Improved shutdown reliability by ensuring stop callbacks are executed before pool shutdown and by explicitly stopping message consumption before closing connections.
• Refactor
  • Enhanced event handling by using standardized event constants and restructuring job processing and shutdown logic for better maintainability.
• New Features
  • Added support for executing custom callbacks when a worker stops.
• Chores
  • Removed an unused method for worker stop callbacks from the server, consolidating this functionality within the adapter.

[coderabbitai]

Walkthrough

The changes update event handling in the Swoole queue adapter to use constants and a private callback property for worker stop events. The AMQP broker's close method now explicitly stops consumption before closing. The server's job consumption logic is refactored for clarity, with shutdown and error hooks reorganized, and adapter-level worker stop callbacks are now used.

Changes

File(s)	Change Summary
src/Queue/Adapter/Swoole.php	Uses Swoole\Constant for event names, adds private $onStop callback, updates event registration and stop logic.
src/Queue/Broker/AMQP.php	close() now calls $this->channel?->stopConsume() before closing the connection.
src/Queue/Server.php	Refactors start() to reorganize hooks, removes workerStop() method, uses adapter's worker stop callback.

Poem

In the queue, the rabbits hop,
With Swoole events that never stop.
AMQP now closes neat,
Stopping jobs before retreat.
Hooks are tidier, errors caught—
A burrow well-kept, as code rabbits ought!
🐇✨

---

📜 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 06b5ced and 9e20d42.

📒 Files selected for processing (3)

• src/Queue/Adapter/Swoole.php (4 hunks)
• src/Queue/Broker/AMQP.php (1 hunks)
• src/Queue/Server.php (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/Queue/Adapter/Swoole.php (3)

src/Queue/Adapter.php (1)

• workerStart (35-35)

src/Queue/Adapter/Workerman.php (1)

• workerStart (34-41)

src/Queue/Broker/Pool.php (1)

• Pool (10-56)

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

• GitHub Check: Adapter Tests (Workerman)
• GitHub Check: Adapter Tests (SwooleRedisCluster)
• GitHub Check: Adapter Tests (AMQP)
• GitHub Check: Adapter Tests (Swoole)
• GitHub Check: Adapter Tests (Pool)

🔇 Additional comments (8)

src/Queue/Broker/AMQP.php (1)

134-134: LGTM! Proper resource cleanup sequence.

Excellent addition to stop consumption before closing the connection. This ensures graceful shutdown and prevents potential issues with partially processed messages.

src/Queue/Adapter/Swoole.php (3)

5-5: Good practice using constants for event names.

Using Swoole\Constant instead of string literals improves code maintainability and reduces the risk of typos.

---

14-15: Well-documented private property.

The $onStop callback property is properly typed and will store the worker stop callback for manual execution.

---

43-43: Consistent use of event constants.

Good improvement using Constant::EVENT_WORKER_START instead of string literals, maintaining consistency with the workerStop method.

src/Queue/Server.php (4)

220-285: Excellent refactoring to callback-based consumption.

The refactoring from an explicit while(true) loop to callback-based consumption improves separation of concerns and makes the code more maintainable. The three-callback structure (message processing, success, error) provides clear separation of responsibilities.

Key improvements:

• Hook usage is now correct: initHooks for initialization, shutdownHooks for cleanup
• Telemetry recording is properly maintained with wait time and process duration
• Resource management follows the established pattern
• Error handling is centralized in the error callback

---

232-232: Correct hook usage pattern.

Excellent fix! Both global and group initialization now correctly use $this->initHooks instead of the previous incorrect usage of $this->shutdownHooks for initialization.

Also applies to: 241-241

---

257-257: Proper shutdown hook implementation.

The shutdown callback correctly uses $this->shutdownHooks for both global and group-level cleanup operations, providing consistent lifecycle management.

Also applies to: 266-266

---

288-288: Appropriate delegation to adapter for worker stop handling.

The worker stop handling is correctly delegated to the adapter with a clean closure that closes the consumer. This aligns well with the adapter-level worker stop callback management implemented in the Swoole adapter.

However, consider the potential duplicate execution issue identified in the Swoole adapter review - the consumer close might be called twice if both the pool event and manual stop trigger.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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