Skip to content

Documentation#250

Open
viktorprogger wants to merge 33 commits intomasterfrom
docs
Open

Documentation#250
viktorprogger wants to merge 33 commits intomasterfrom
docs

Conversation

@viktorprogger
Copy link
Copy Markdown
Contributor

Q A
Is bugfix? ✔️
New feature?
Breaks BC?

@viktorprogger viktorprogger changed the title Start docs refining Documentation Dec 13, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Dec 13, 2025

Codecov Report

❌ Patch coverage is 96.22642% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 98.48%. Comparing base (5999193) to head (6620bf9).

Files with missing lines Patch % Lines
src/Worker/Worker.php 87.50% 2 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##             master     #250      +/-   ##
============================================
- Coverage     98.59%   98.48%   -0.12%     
+ Complexity      372      369       -3     
============================================
  Files            48       48              
  Lines           998      987      -11     
============================================
- Hits            984      972      -12     
- Misses           14       15       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread docs/guide/en/configuration-with-config.md Outdated
Comment thread docs/guide/en/configuration-with-config.md Outdated
Comment thread docs/guide/en/message-handler.md Outdated
Comment thread docs/guide/en/message-handler.md Outdated
Comment thread docs/guide/en/message-handler.md Outdated
Comment thread docs/guide/en/message-handler.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@viktorprogger viktorprogger marked this pull request as ready for review January 7, 2026 15:19
@samdark samdark requested a review from Copilot January 7, 2026 19:50
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request is marked as a bugfix and includes significant documentation improvements, code refactoring, and a critical bug fix. The main changes involve integrating CallableFactory into the Worker class to simplify handler resolution, fixing a bug in the JSON message serializer, adding comprehensive documentation, and adding a command alias.

Key changes:

  • Integration of CallableFactory into Worker for unified callable resolution
  • Bug fix in JsonMessageSerializer where $payload['meta'] was incorrectly accessed instead of $meta
  • Extensive documentation added covering queue channels, message handlers, middleware pipelines, error handling, and more
  • Command alias queue:listen-all added to replace the typo queue:listen:all

Reviewed changes

Copilot reviewed 29 out of 29 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
tests/Unit/WorkerTest.php Added new test case for object method callable definitions and updated tests to use CallableFactory parameter
tests/Unit/Middleware/CallableFactoryTest.php Major refactoring with data providers for comprehensive testing of callable factory scenarios
tests/TestCase.php Added CallableFactory parameter to worker creation
tests/Integration/MiddlewareTest.php Added CallableFactory parameter to test setup
tests/Integration/MessageConsumingTest.php Added CallableFactory instantiation and parameter in worker setup
tests/Benchmark/QueueBench.php Added CallableFactory parameter to worker constructor
src/Worker/Worker.php Integrated CallableFactory for unified handler resolution, simplified handler caching logic
src/Middleware/CallableFactory.php Enhanced to support Closure detection, object method definitions, and improved validation
src/Message/JsonMessageSerializer.php Bug fix: corrected variable reference from $payload['meta'] to $meta
src/Command/ListenAllCommand.php Added command alias 'queue:listen:all' for backward compatibility
docs/guide/en/worker.md Rewritten to focus on starting workers and supervisor configuration
docs/guide/en/usage.md Expanded with queue channels, delayed execution, job status examples
docs/guide/en/producing-messages-from-external-systems.md New comprehensive guide for external message producers
docs/guide/en/prerequisites-and-installation.md New installation and requirements guide
docs/guide/en/middleware-pipelines.md New detailed middleware pipeline documentation
docs/guide/en/message-handler.md New guide explaining handler definition formats and configuration
docs/guide/en/loops.md New documentation on loop interface and signal handling
docs/guide/en/job-status.md New guide on job status tracking
docs/guide/en/error-handling.md Significantly expanded with step-by-step failure handling flow
docs/guide/en/envelopes.md New documentation on envelope pattern and metadata handling
docs/guide/en/debug-integration.md New guide for Yii Debug integration
docs/guide/en/console-commands.md New comprehensive console commands reference
docs/guide/en/configuration-with-config.md New configuration guide for yiisoft/config users
docs/guide/en/configuration-manual.md New manual configuration guide with examples
docs/guide/en/channels.md New detailed guide on queue channels concept and configuration
docs/guide/en/callable-definitions-extended.md New guide explaining extended callable definition formats
docs/guide/en/README.md Restructured guide index with better organization
config/params.php Added 'queue:listen-all' command alias
README.md Major rewrite with quick start guide and improved structure

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/guide/en/callable-definitions-extended.md Outdated
Comment thread README.md Outdated
Comment thread docs/guide/en/producing-messages-from-external-systems.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread docs/guide/en/callable-definitions-extended.md Outdated
Comment thread docs/guide/en/callable-definitions-extended.md Outdated
Comment thread docs/guide/en/callable-definitions-extended.md Outdated
Comment thread docs/guide/en/callable-definitions-extended.md Outdated
Comment thread docs/guide/en/callable-definitions-extended.md Outdated
Comment thread docs/guide/en/console-commands.md Outdated
Comment thread docs/guide/en/debug-integration.md Outdated
Comment thread docs/guide/en/error-handling.md Outdated
## Configuration
## When failure handling is triggered

Failure handling is triggered only when message processing throws a `Throwable`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about PHP notices or warnings or errors?

Copy link
Copy Markdown
Contributor Author

@viktorprogger viktorprogger Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most errors implement Throwable. So - yes, we do catch them.

Comment thread docs/guide/en/error-handling.md Outdated
Comment thread src/Worker/Worker.php Outdated
Comment thread config/params.php
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 38 out of 38 changed files in this pull request and generated 4 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/Worker/Worker.php
Comment thread src/Command/RunCommand.php Outdated
Comment thread src/Command/ListenAllCommand.php Outdated
Comment thread docs/guide/en/advanced-map.md Outdated
viktorprogger and others added 8 commits April 5, 2026 20:06
Kept docs-branch Quick Start README rewrite; merged master's PHP version
range (8.1-8.5) and PCNTL note. Resolved command option conflicts by
keeping `limit` parameter name with `queue` terminology from master, and
fixed `$channel` → `$queue` variable bug in RunCommand.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants