Skip to content

[Messenger] Add --exclude-receivers to messenger:consume command #60979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
fabpot merged 1 commit into from
Aug 23, 2025
Merged

[Messenger] Add --exclude-receivers to messenger:consume command #60979

fabpot merged 1 commit into from
Aug 23, 2025

Conversation

@jbdelhommeau
Copy link
Contributor

@jbdelhommeau jbdelhommeau commented Jun 30, 2025 •
edited
Loading

Q A
Branch? 7.4
Bug fix? no
New feature? yes
Deprecations? no
Docs symfony/symfony-docs#21165
License MIT

This PR adds a new --exclude-receivers (shortcut -et) option to the messenger:consume command. This option allows users to exclude specific transports/receivers from being consumed when using the --all flag.

What it does and why it's needed:

  • When running messenger:consume --all, you may want to skip certain transports (example the failed transports) without having to list all the others manually. The new --exclude-receivers option makes this possible.
  • This improves flexibility and usability for complex Messenger setups.

How it works:

php bin/console messenger:consume --all --exclude-receivers=queues1 --exclude-receivers=queues2

This will consume messages from all transports except queues1 and queues2.

Behavior:

  • The --exclude-queues option can only be used with --all. If used without --all, an InvalidOptionException is thrown.
  • If all queues are excluded, a RuntimeException is thrown to prevent running the command with no receivers.

Before:

  • No way to exclude specific receivers when using --all.

After:

  • You can now exclude queues with --exclude-receivers when using --all.

Tests:

  • Unit tests have been added to cover the new option, its validation, and edge cases.

@carsonbot carsonbot added this to the 7.4 milestone Jun 30, 2025
@jbdelhommeau
Copy link
Contributor Author

jbdelhommeau commented Jun 30, 2025

@Kocal 🎁

Kocal
Kocal reviewed Jun 30, 2025
View reviewed changes
@jbdelhommeau jbdelhommeau force-pushed the messenger-exlude-receivers branch from 52da22d to 04d44be Compare June 30, 2025 12:34
@carsonbot carsonbot changed the title chore: add exclude-receivers consume parameters [Messenger] chore: add exclude-receivers consume parameters Jun 30, 2025
@nicolas-grekas nicolas-grekas changed the title [Messenger] chore: add exclude-receivers consume parameters [Messenger] Add --exclude-queues consume parameters Jun 30, 2025
@OskarStark OskarStark changed the title [Messenger] Add --exclude-queues consume parameters [Messenger] Add --exclude-queues consume parameters Jun 30, 2025
@jbdelhommeau jbdelhommeau force-pushed the messenger-exlude-receivers branch 3 times, most recently from 3ca4340 to 3379fda Compare June 30, 2025 13:09
@B-Galati
Copy link
Contributor

B-Galati commented Jul 1, 2025 •
edited
Loading

@Kocal @jbdelhommeau Not sure about the naming of the option guys.

By default the command consumes from receivers/transports.

There is the option --queues but it's only for some implementations like AMQP.

So I guess we could have 2 options:

  • --exclude-queues
  • --exclude-receivers or --exclude-tranports (I prefer the later on my end because the config key name is transports)

Starting with the second option sounds more appropriate to me as it's not bound to some protocol/technologies. Also the current implementation is about receivers/transports not queues.

@jbdelhommeau jbdelhommeau force-pushed the messenger-exlude-receivers branch from 3379fda to dcde172 Compare July 1, 2025 12:51
@jbdelhommeau
Copy link
Contributor Author

jbdelhommeau commented Jul 1, 2025

I just push an new version more aligned with @B-Galati feedbacks.

@jbdelhommeau jbdelhommeau force-pushed the messenger-exlude-receivers branch from dcde172 to 4677777 Compare July 1, 2025 12:57
Kocal
Kocal reviewed Jul 1, 2025
View reviewed changes
@jbdelhommeau jbdelhommeau force-pushed the messenger-exlude-receivers branch from 4677777 to 0406863 Compare July 2, 2025 07:38
@nicolas-grekas nicolas-grekas changed the title [Messenger] Add --exclude-queues consume parameters [Messenger] Add --exclude-receivers consume parameters Jul 7, 2025
@nicolas-grekas nicolas-grekas changed the title [Messenger] Add --exclude-receivers consume parameters [Messenger] Add --exclude-queues to messenger:consume command Jul 7, 2025
@nicolas-grekas nicolas-grekas changed the title [Messenger] Add --exclude-queues to messenger:consume command [Messenger] Add --exclude-receivers to messenger:consume command Jul 7, 2025
nicolas-grekas
nicolas-grekas reviewed Jul 7, 2025
View reviewed changes
Copy link
Member

@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

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

Please add a line in the changelog file of the component (you can borrow from the PR title)

@OskarStark OskarStark mentioned this pull request Jul 9, 2025
Merged
@jbdelhommeau jbdelhommeau force-pushed the messenger-exlude-receivers branch 2 times, most recently from 1f706e6 to 167c1fe Compare July 10, 2025 14:13
@jbdelhommeau
Copy link
Contributor Author

jbdelhommeau commented Jul 10, 2025

Please add a line in the changelog file of the component (you can borrow from the PR title)

Done

fabpot
fabpot requested changes Aug 17, 2025
View reviewed changes
@jbdelhommeau jbdelhommeau force-pushed the messenger-exlude-receivers branch 2 times, most recently from 3fb0e8b to a2e2161 Compare August 20, 2025 14:55
@jbdelhommeau jbdelhommeau requested a review from fabpot August 20, 2025 15:00
@nicolas-grekas
Copy link
Member

nicolas-grekas commented Aug 21, 2025

(please rebase to get rid of the merge commit and trigger tests again)

@jbdelhommeau jbdelhommeau force-pushed the messenger-exlude-receivers branch 4 times, most recently from 309f256 to a7ee972 Compare August 21, 2025 07:15
fabpot
fabpot approved these changes Aug 23, 2025
View reviewed changes
src/Symfony/Component/Messenger/CHANGELOG.md Outdated
7.3
---

* Add `--exclude-receivers` option to the `messenger:consume command`
Copy link
Member

@fabpot fabpot Aug 23, 2025

Choose a reason for hiding this comment

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

Should be moved to a new 7.4 section.

@fabpot fabpot force-pushed the messenger-exlude-receivers branch from a7ee972 to 9d9a9d8 Compare August 23, 2025 06:22
@fabpot
Copy link
Member

fabpot commented Aug 23, 2025

Thank you @jbdelhommeau.

@fabpot fabpot merged commit ff682f8 into symfony:7.4 Aug 23, 2025
10 of 12 checks passed
javiereguiluz added a commit to javiereguiluz/symfony-docs that referenced this pull request Sep 2, 2025
@javiereguiluz
minor symfony#21165 [Messenger] Document the --exclude-receivers op…
ae5898d 
…tion for `messenger:consume` command (OskarStark)

This PR was squashed before being merged into the 7.4 branch.

Discussion
----------

[Messenger] Document the `--exclude-receivers` option for `messenger:consume` command

- Add documentation for the new `--exclude-receivers` option
- Show usage example with `--all` flag
- Include version annotation for Symfony 7.4
- Add note about requirement to use with `--all` option

### Code PR

* symfony/symfony#60979

Commits
-------

d252713 [Messenger] Document the `--exclude-receivers` option for `messenger:consume` command
This was referenced Oct 27, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nicolas-grekas nicolas-grekas nicolas-grekas left review comments

@OskarStark OskarStark OskarStark left review comments

@fabpot fabpot fabpot approved these changes

+1 more reviewer

@Kocal Kocal Kocal left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Feature Messenger Status: Reviewed

Projects

None yet

Milestone

7.4

Development

Successfully merging this pull request may close these issues.

7 participants

@jbdelhommeau @B-Galati @nicolas-grekas @fabpot @OskarStark @Kocal @carsonbot