Skip to content

Allow queue-specific configuration to exceed the default max-messages value #40110

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

Open
wants to merge 4 commits into
base: 2.4-develop
Choose a base branch
from
Open

Allow queue-specific configuration to exceed the default max-messages value #40110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
59a09ff
Allow configuration in queue_consumer.xml to be higher than default
baudeval Jul 29, 2025
cea6c16
Merge branch '2.4-develop' into baudeval-patch-1
baudeval Aug 8, 2025
de44eee
Merge branch '2.4-develop' into baudeval-patch-1
baudeval Aug 8, 2025
f94d54e
Merge branch '2.4-develop' into baudeval-patch-1
baudeval Aug 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 34 additions & 3 deletions app/code/Magento/MessageQueue/Model/Cron/ConsumersRunner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,7 @@ public function run(): void
];

if ($maxMessages) {
$arguments[] =
'--max-messages=' . min($consumer->getMaxMessages() ?? $maxMessages, $maxMessages);
$arguments = $this->addMaxMessagesArgument($arguments, $consumer, $maxMessages);
}

$command = $php . ' ' . BP . '/bin/magento queue:consumers:start %s %s'
Expand All @@ -155,7 +154,7 @@ public function run(): void
];

if ($maxMessages) {
$arguments[] = '--max-messages=' . min($consumer->getMaxMessages() ?? $maxMessages, $maxMessages);
$arguments = $this->addMaxMessagesArgument($arguments, $consumer, $maxMessages);
}

$command = $php . ' ' . BP . '/bin/magento queue:consumers:start %s %s'
Expand All @@ -166,6 +165,38 @@ public function run(): void
}
}

/**
* Add max-messages argument and log warning if exceeds default
*
* @param array $arguments Arguments array to append to
* @param ConsumerConfigItemInterface $consumer
* @param int $defaultMaxMessages
* @return array
*/
private function addMaxMessagesArgument(
array $arguments,
ConsumerConfigItemInterface $consumer,
int $defaultMaxMessages
): array {
$consumerMaxMessages =$consumer->getMaxMessages() ?? $defaultMaxMessages;

if ($consumerMaxMessages > $defaultMaxMessages) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Warning only logs but doesn't prevent potentially dangerous configurations

$this->logger->warning(
__(
'Consumer "%1" has max-messages=%2 which exceeds the configured default (%3). '
. 'This may probably cause high memory usage or long processing times.',
$consumer->getName(),
$consumerMaxMessages,
$defaultMaxMessages
)
);
}

$arguments[] = '--max-messages=' . $consumerMaxMessages;

return $arguments;
}

/**
* Checks that the consumer can be run
*
Expand Down
15 changes: 13 additions & 2 deletions app/code/Magento/MessageQueue/Test/Unit/Model/Cron/ConsumersRunnerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ public function testRunDisabled()

/**
* @param int $maxMessages
* @param int $maxMessagesConsumer
* @param bool $isLocked
* @param string $php
* @param string $command
Expand All @@ -135,6 +136,7 @@ public function testRunDisabled()
*/
public function testRun(
$maxMessages,
$maxMessagesConsumer,
$isLocked,
$php,
$command,
Expand All @@ -161,6 +163,7 @@ public function testRun(
$consumer = $this->getMockBuilder(ConsumerConfigItemInterface::class)
->getMockForAbstractClass();
$consumer->method('getName')->willReturn($consumerName);
$consumer->method('getMaxMessages')->willReturn($maxMessagesConsumer);

$this->phpExecutableFinderMock->expects($this->once())
->method('find')
Expand Down Expand Up @@ -190,6 +193,7 @@ public static function runDataProvider()
return [
[
'maxMessages' => 20000,
'maxMessagesConsumer' => 20000,
'isLocked' => false,
'php' => '',
'command' => 'php ' . BP . '/bin/magento queue:consumers:start %s %s %s',
Expand All @@ -200,16 +204,18 @@ public static function runDataProvider()
],
[
'maxMessages' => 10000,
'maxMessagesConsumer' => 30000,
'isLocked' => false,
'php' => '',
'command' => 'php ' . BP . '/bin/magento queue:consumers:start %s %s %s',
'arguments' => ['consumerName', '--single-thread', '--max-messages=10000'],
'arguments' => ['consumerName', '--single-thread', '--max-messages=30000'],
'allowedConsumers' => [],
'shellBackgroundExpects' => 1,
'isRunExpects' => 1,
],
[
'maxMessages' => 10000,
'maxMessagesConsumer' => 10000,
'isLocked' => false,
'php' => '',
'command' => 'php ' . BP . '/bin/magento queue:consumers:start %s %s %s',
Expand All @@ -220,6 +226,7 @@ public static function runDataProvider()
],
[
'maxMessages' => 10000,
'maxMessagesConsumer' => 10000,
'isLocked' => true,
'php' => '',
'command' => 'php ' . BP . '/bin/magento queue:consumers:start %s %s %s',
Expand All @@ -230,6 +237,7 @@ public static function runDataProvider()
],
[
'maxMessages' => 10000,
'maxMessagesConsumer' => 10000,
'isLocked' => true,
'php' => '',
'command' => 'php ' . BP . '/bin/magento queue:consumers:start %s %s %s',
Expand All @@ -240,6 +248,7 @@ public static function runDataProvider()
],
[
'maxMessages' => 10000,
'maxMessagesConsumer' => 10000,
'isLocked' => true,
'php' => '',
'command' => 'php ' . BP . '/bin/magento queue:consumers:start %s %s %s',
Expand All @@ -250,16 +259,18 @@ public static function runDataProvider()
],
[
'maxMessages' => 10000,
'maxMessagesConsumer' => 500,
'isLocked' => false,
'php' => '',
'command' => 'php ' . BP . '/bin/magento queue:consumers:start %s %s %s',
'arguments' => ['consumerName', '--single-thread', '--max-messages=10000'],
'arguments' => ['consumerName', '--single-thread', '--max-messages=500'],
'allowedConsumers' => ['consumerName'],
'shellBackgroundExpects' => 1,
'isRunExpects' => 1,
],
[
'maxMessages' => 0,
'maxMessagesConsumer' => 0,
'isLocked' => false,
'php' => '/bin/php',
'command' => '/bin/php ' . BP . '/bin/magento queue:consumers:start %s %s',
Expand Down