Skip to content

Support queue add connections and refresh worker documentation - #521

Merged
dereuromark merged 12 commits into
masterfrom
maintenance/cake5-docs-cleanup
Oct 11, 2026
Merged

dereuromark merged 12 commits into
masterfrom
maintenance/cake5-docs-cleanup

Conversation

@dereuromark

@dereuromark dereuromark commented Oct 11, 2026 •

Copy link
Copy Markdown
Owner

Support queue add --connection, fix worker runtime defaults and document the installation, first job and worker lifecycle using the current command APIs.

queue add, queue run, queue job, queue info and queue worker share connection defaults and whitelist validation. Queue tables use the first configured connection in multi-connection mode; single-connection commands preserve a table override. Adding a job restores the table connection afterward.

Workers now use the configured default lifetime when no CLI override is supplied, and --max-runtime 0 also disables the PHP execution timeout. Incomplete jobs no longer trigger a PHP 8.5 null array-key deprecation. Statistics queries use query builders, and tests use PHPUnit attributes.

The documentation separates installation from the first working example, corrects configuration defaults and recovery commands, and explains retry and concurrency limits. Email examples use JSON-compatible data and match the actual Message and Mailer paths. Progress updates use private topics rather than session IDs.

Validation: 253 tests, 970 assertions, eight database-dependent skips; coding standards, PHPStan level 8 and the documentation build pass. All 76 PHP examples pass syntax checks; 639 rendered internal links resolve. Browser checks pass for navigation, search, SVG branding, light and dark themes and mobile layout. Local review findings are addressed and CI passes.

@coderabbitai

coderabbitai Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: db087f71-5de8-401c-a749-402bd9caa26d

📥 Commits

Reviewing files that changed from the base of the PR and between 458186a and c8f2db9.


📒 Files selected for processing (46)
  • README.md
  • config/app.example.php
  • docs/.vitepress/config.ts
  • docs/.vitepress/theme/custom.css
  • docs/admin/index.md
  • docs/guide/basic-setup.md
  • docs/guide/configuration.md
  • docs/guide/custom-tasks.md
  • docs/guide/getting-started.md
  • docs/guide/index.md
  • docs/guide/installation.md
  • docs/guide/mailing.md
  • docs/guide/multi-connection.md
  • docs/guide/operations.md
  • docs/guide/queueing-jobs.md
  • docs/guide/realtime-progress.md
  • docs/index.md
  • docs/reference/index.md
  • docs/reference/limitations.md
  • docs/reference/misc.md
  • docs/reference/tips.md
  • docs/reference/upgrading.md
  • docs/tasks/email.md
  • docs/tasks/index.md
  • docs/tasks/mailer.md
  • src/Command/AddCommand.php
  • src/Command/InfoCommand.php
  • src/Command/JobCommand.php
  • src/Command/WorkerCommand.php
  • src/Controller/Admin/QueueAppController.php
  • src/Model/Table/QueueProcessesTable.php
  • src/Model/Table/QueuedJobsTable.php
  • src/Queue/Config.php
  • src/Queue/Processor.php
  • tests/TestCase/Command/AddCommandTest.php
  • tests/TestCase/Command/BakeQueueTaskCommandTest.php
  • tests/TestCase/Command/InfoCommandTest.php
  • tests/TestCase/Command/JobCommandTest.php
  • tests/TestCase/Command/RunCommandTest.php
  • tests/TestCase/Command/WorkerCommandTest.php
  • tests/TestCase/Controller/Admin/QueueAppControllerTest.php
  • tests/TestCase/Controller/Admin/QueueControllerTest.php
  • tests/TestCase/Controller/Admin/QueueProcessesControllerTest.php
  • tests/TestCase/Controller/Admin/QueuedJobsControllerTest.php
  • tests/TestCase/Model/Table/QueuedJobsTableTest.php
  • tests/TestCase/Queue/ProcessorTest.php

 ______________________________
< Carpe Debug. Seize the bugs. >
 ------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR

🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Comment @coderabbitai help to get the list of available commands.

@dereuromark dereuromark changed the title Fix worker runtime defaults and refresh Queue documentation Support queue add connections and refresh worker documentation Oct 11, 2026
@dereuromark
dereuromark marked this pull request as ready for review October 11, 2026 13:40
@dereuromark
dereuromark merged commit 51d385a into master Oct 11, 2026
16 of 17 checks passed
@dereuromark
dereuromark deleted the maintenance/cake5-docs-cleanup branch October 11, 2026 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant