diff --git a/config/mago.toml b/config/mago.toml index 1d6c4b1..b3d12e3 100644 --- a/config/mago.toml +++ b/config/mago.toml @@ -46,7 +46,7 @@ ignore = [ # Symfony 6.4 names the parameters of AbstractBundle::loadExtension() $container and $builder, 7.4 and later $configurator and $container { code = "incompatible-parameter-name", in = ["src/ProtungEasyAdminPlusBundle.php"] }, # 2 errors on Symfony 6.4 # Symfony 6.4 types the return of getSubscribedServices() as array, so every class inheriting it from the FlashMessages trait is reported - { code = "incompatible-return-type", in = ["tests/Controller/BaseCrudControllerTest.php"] }, # 1 error on Symfony 6.4 + { code = "incompatible-return-type", in = ["tests/Controller/BaseCrudControllerTest.php", "tests/Test/TestApplication/Controller/NoteCrudController.php"] }, # 2 errors on Symfony 6.4 # Symfony 6.4 types the return of Crawler::each() as array, 7.4 and later as list { code = "invalid-return-statement", in = ["src/Test/Controller/DashboardControllerTestCase.php"] }, # 2 errors on Symfony 6.4 # askConfirmation() only takes a closure since EasyAdmin 5.10, so its closures are reported before diff --git a/src/Controller/BaseCrudDtoController.php b/src/Controller/BaseCrudDtoController.php index 4848ee0..041947b 100644 --- a/src/Controller/BaseCrudDtoController.php +++ b/src/Controller/BaseCrudDtoController.php @@ -173,8 +173,12 @@ public function edit(AdminContext $context): KeyValueStore|Response $this->updateEntity($this->container->get('doctrine')->getManagerForClass($context->getEntity()->getFqcn()), $entityInstance); - $this->container->get('event_dispatcher')->dispatch(new AfterEntityUpdatedEvent($entityInstance)); + $event = new AfterEntityUpdatedEvent($entityInstance); + $this->container->get('event_dispatcher')->dispatch($event); EntityDtoInstanceSetter::setInstance($entityDto, $entityInstance); + if ($event->isPropagationStopped()) { + return $event->getResponse(); + } return $this->getRedirectResponseAfterSave($context, Action::EDIT); } @@ -248,8 +252,12 @@ public function new(AdminContext $context): KeyValueStore|Response $this->persistEntity($this->container->get('doctrine')->getManagerForClass($context->getEntity()->getFqcn()), $entityInstance); - $this->container->get('event_dispatcher')->dispatch(new AfterEntityPersistedEvent($entityInstance)); + $event = new AfterEntityPersistedEvent($entityInstance); + $this->container->get('event_dispatcher')->dispatch($event); EntityDtoInstanceSetter::setInstance($context->getEntity(), $entityInstance); + if ($event->isPropagationStopped()) { + return $event->getResponse(); + } return $this->getRedirectResponseAfterSave($context, Action::NEW); } diff --git a/tests/Controller/BaseCrudDtoControllerEditTest.php b/tests/Controller/BaseCrudDtoControllerEditTest.php new file mode 100644 index 0000000..3eae4f1 --- /dev/null +++ b/tests/Controller/BaseCrudDtoControllerEditTest.php @@ -0,0 +1,85 @@ + + */ +#[CoversClass(BaseCrudDtoController::class)] +final class BaseCrudDtoControllerEditTest extends EditActionCrudDtoTestCase +{ + protected static string|int $expectedEntityIdUnderTest = 1; + + #[Override] + protected function setUp(): void + { + parent::setUp(); + + $entityManager = $this->getEntityManager(); + $metadata = $entityManager->getMetadataFactory()->getAllMetadata(); + $schemaTool = new SchemaTool($entityManager); + $schemaTool->dropSchema($metadata); + $schemaTool->createSchema($metadata); + + $note = new Note(); + $note->title = 'Original'; + $entityManager->persist($note); + $entityManager->flush(); + $entityManager->clear(); + } + + #[Override] + protected static function usePrettyUrls(): bool + { + return true; + } + + #[Override] + protected function controllerUnderTest(): string + { + return NoteCrudController::class; + } + + public function testSavingRedirectsToIndexWhenNoListenerStopsTheAfterEntityUpdatedEvent(): void + { + $this->assertSavingEntityAndRedirectingToIndexAction(['title' => 'Updated']); + + $this->clearObjectManager(); + self::assertSame('Updated', $this->getEntityUnderTest()->title); + } + + public function testSavingReturnsTheResponseOfTheListenerThatStoppedTheAfterEntityUpdatedEvent(): void + { + $this->getContainerService(EventDispatcherInterface::class, 'event_dispatcher')->addListener( + AfterEntityUpdatedEvent::class, + static function (AfterEntityUpdatedEvent $event): void { + $event->setResponse(new Response('Answered by the listener', Response::HTTP_ACCEPTED)); + }, + ); + + $this->submitFormRequest(['title' => 'Updated']); + + $response = $this->getClient()->getResponse(); + self::assertResponseStatusCode($response, Response::HTTP_ACCEPTED); + self::assertSame('Answered by the listener', $response->getContent()); + + $this->clearObjectManager(); + self::assertSame('Updated', $this->getEntityUnderTest()->title); + } +} diff --git a/tests/Controller/BaseCrudDtoControllerNewTest.php b/tests/Controller/BaseCrudDtoControllerNewTest.php new file mode 100644 index 0000000..cc4ee75 --- /dev/null +++ b/tests/Controller/BaseCrudDtoControllerNewTest.php @@ -0,0 +1,84 @@ + + */ +#[CoversClass(BaseCrudDtoController::class)] +final class BaseCrudDtoControllerNewTest extends NewActionCrudDtoTestCase +{ + #[Override] + protected function setUp(): void + { + parent::setUp(); + + $entityManager = $this->getEntityManager(); + $metadata = $entityManager->getMetadataFactory()->getAllMetadata(); + $schemaTool = new SchemaTool($entityManager); + $schemaTool->dropSchema($metadata); + $schemaTool->createSchema($metadata); + } + + #[Override] + protected static function usePrettyUrls(): bool + { + return true; + } + + #[Override] + protected function controllerUnderTest(): string + { + return NoteCrudController::class; + } + + public function testSavingRedirectsToIndexWhenNoListenerStopsTheAfterEntityPersistedEvent(): void + { + $this->assertSavingEntityAndRedirectingToIndexAction(['title' => 'Created']); + + $this->assertNoteWasCreated(); + } + + public function testSavingReturnsTheResponseOfTheListenerThatStoppedTheAfterEntityPersistedEvent(): void + { + $this->getContainerService(EventDispatcherInterface::class, 'event_dispatcher')->addListener( + AfterEntityPersistedEvent::class, + static function (AfterEntityPersistedEvent $event): void { + $event->setResponse(new Response('Answered by the listener', Response::HTTP_ACCEPTED)); + }, + ); + + $this->submitFormRequest(['title' => 'Created']); + + $response = $this->getClient()->getResponse(); + self::assertResponseStatusCode($response, Response::HTTP_ACCEPTED); + self::assertSame('Answered by the listener', $response->getContent()); + + $this->assertNoteWasCreated(); + } + + private function assertNoteWasCreated(): void + { + $this->clearObjectManager(); + + $notes = $this->getEntityManager()->getRepository(Note::class)->findAll(); + self::assertCount(1, $notes); + self::assertSame('Created', $notes[0]->title); + } +} diff --git a/tests/Test/TestApplication/Controller/NoteCrudController.php b/tests/Test/TestApplication/Controller/NoteCrudController.php new file mode 100644 index 0000000..917e875 --- /dev/null +++ b/tests/Test/TestApplication/Controller/NoteCrudController.php @@ -0,0 +1,63 @@ + + */ +final class NoteCrudController extends BaseCrudDtoController +{ + #[Override] + public static function getEntityFqcn(): string + { + return Note::class; + } + + #[Override] + public static function getDtoFqcn(): string + { + return NoteDto::class; + } + + /** @return iterable */ + #[Override] + public function configureFields(string $pageName): iterable + { + yield TextField::new('title'); + } + + #[Override] + public function createEntityFromDto(object $dto): Note + { + $note = new Note(); + $note->title = $dto->title ?? ''; + + return $note; + } + + #[Override] + public function createDtoFromEntity(object $entity): NoteDto + { + $dto = new NoteDto(); + $dto->id = $entity->id; + $dto->title = $entity->title; + + return $dto; + } + + #[Override] + public function updateEntityFromDto(object $entity, object $dto): void + { + $entity->title = $dto->title ?? ''; + } +} diff --git a/tests/Test/TestApplication/Dto/NoteDto.php b/tests/Test/TestApplication/Dto/NoteDto.php new file mode 100644 index 0000000..6026b06 --- /dev/null +++ b/tests/Test/TestApplication/Dto/NoteDto.php @@ -0,0 +1,15 @@ +