Skip to content

[make:message] use AsMessage for routing if available #1690

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

Merged
merged 1 commit into from
Apr 25, 2025
Merged

[make:message] use AsMessage for routing if available #1690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 17 additions & 2 deletions src/Maker/MakeMessage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Messenger\Attribute\AsMessage;
use Symfony\Component\Messenger\Attribute\AsMessageHandler;
use Symfony\Component\Messenger\MessageBusInterface;

Expand Down Expand Up @@ -86,6 +87,8 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma

public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
{
$chosenTransport = $input->getArgument('chosen-transport');

$messageClassNameDetails = $generator->createClassNameDetails(
$input->getArgument('name'),
'Message\\'
Expand All @@ -97,9 +100,20 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
'Handler'
);

$useStatements = new UseStatementGenerator([]);

/* @legacy remove when AsMessage is always available */
if ($chosenTransport && class_exists(AsMessage::class)) {
$useStatements->addUseStatement(AsMessage::class);
}

$generator->generateClass(
$messageClassNameDetails->getFullName(),
'message/Message.tpl.php'
'message/Message.tpl.php',
[
'use_statements' => $useStatements,
'transport' => class_exists(AsMessage::class) ? $chosenTransport : null,
]
);

$useStatements = new UseStatementGenerator([
Expand All @@ -116,7 +130,8 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
]
);

if (null !== $chosenTransport = $input->getArgument('chosen-transport')) {
/* @legacy remove when AsMessage is always available */
if ($chosenTransport && !class_exists(AsMessage::class)) {
$this->updateMessengerConfig($generator, $chosenTransport, $messageClassNameDetails->getFullName());
}

Expand Down
3 changes: 3 additions & 0 deletions templates/message/Message.tpl.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

namespace <?= $namespace; ?>;

<?= $use_statements; ?>

<?php if ($transport): ?>#[AsMessage('<?= $transport ?>')]<?= "\n" ?><?php endif ?>
final class <?= $class_name."\n" ?>
{
/*
Expand Down
32 changes: 23 additions & 9 deletions tests/Maker/MakeMessageTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use Symfony\Bundle\MakerBundle\Test\MakerTestCase;
use Symfony\Bundle\MakerBundle\Test\MakerTestDetails;
use Symfony\Bundle\MakerBundle\Test\MakerTestRunner;
use Symfony\Component\Messenger\Attribute\AsMessage;
use Symfony\Component\Yaml\Yaml;

class MakeMessageTest extends MakerTestCase
Expand Down Expand Up @@ -63,15 +64,25 @@ public function getTestDetails(): \Generator

$this->assertStringContainsString('Success', $output);

$messengerConfig = $runner->readYaml('config/packages/messenger.yaml');
$this->assertArrayHasKey('routing', $messengerConfig['framework']['messenger']);
$this->assertArrayHasKey('App\Message\SendWelcomeEmail', $messengerConfig['framework']['messenger']['routing']);
$this->assertSame(
'async',
$messengerConfig['framework']['messenger']['routing']['App\Message\SendWelcomeEmail']
);

$this->runMessageTest($runner, 'it_generates_message_with_transport.php');

$messageContents = file_get_contents($runner->getPath('src/Message/SendWelcomeEmail.php'));

if (!str_contains($messageContents, AsMessage::class)) {
/* @legacy remove when AsMessage is always available */
$messengerConfig = $runner->readYaml('config/packages/messenger.yaml');
$this->assertArrayHasKey('routing', $messengerConfig['framework']['messenger']);
$this->assertArrayHasKey('App\Message\SendWelcomeEmail', $messengerConfig['framework']['messenger']['routing']);
$this->assertSame(
'async',
$messengerConfig['framework']['messenger']['routing']['App\Message\SendWelcomeEmail']
);

return;
}

$this->assertStringContainsString(AsMessage::class, $messageContents);
$this->assertStringContainsString("#[AsMessage('async')]", $messageContents);
}),
];

Expand All @@ -86,10 +97,13 @@ public function getTestDetails(): \Generator

$this->assertStringContainsString('Success', $output);

$this->runMessageTest($runner, 'it_generates_message_with_transport.php');

$messengerConfig = $runner->readYaml('config/packages/messenger.yaml');
$this->assertArrayNotHasKey('routing', $messengerConfig['framework']['messenger']);

$this->runMessageTest($runner, 'it_generates_message_with_transport.php');
$messageContents = file_get_contents($runner->getPath('src/Message/SendWelcomeEmail.php'));
$this->assertStringNotContainsString(AsMessage::class, $messageContents);
}),
];
}
Expand Down