Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion config/mago.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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<string>, 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<R>
{ 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
Expand Down
12 changes: 10 additions & 2 deletions src/Controller/BaseCrudDtoController.php
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down Expand Up @@ -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);
}
Expand Down
85 changes: 85 additions & 0 deletions tests/Controller/BaseCrudDtoControllerEditTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
<?php

declare(strict_types=1);

namespace Protung\EasyAdminPlusBundle\Tests\Controller;

use Doctrine\ORM\Tools\SchemaTool;
use EasyCorp\Bundle\EasyAdminBundle\Event\AfterEntityUpdatedEvent;
use Override;
use PHPUnit\Framework\Attributes\CoversClass;
use Protung\EasyAdminPlusBundle\Controller\BaseCrudDtoController;
use Protung\EasyAdminPlusBundle\Test\Controller\EditActionCrudDtoTestCase;
use Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Controller\NoteCrudController;
use Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Dto\NoteDto;
use Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Entity\Note;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\Response;

/**
* Saving a note through its DTO, with and without a listener that answers the after-update event itself.
*
* @template-extends EditActionCrudDtoTestCase<Note, NoteDto, NoteCrudController>
*/
#[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);
}
}
84 changes: 84 additions & 0 deletions tests/Controller/BaseCrudDtoControllerNewTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<?php

declare(strict_types=1);

namespace Protung\EasyAdminPlusBundle\Tests\Controller;

use Doctrine\ORM\Tools\SchemaTool;
use EasyCorp\Bundle\EasyAdminBundle\Event\AfterEntityPersistedEvent;
use Override;
use PHPUnit\Framework\Attributes\CoversClass;
use Protung\EasyAdminPlusBundle\Controller\BaseCrudDtoController;
use Protung\EasyAdminPlusBundle\Test\Controller\NewActionCrudDtoTestCase;
use Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Controller\NoteCrudController;
use Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Dto\NoteDto;
use Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Entity\Note;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\Response;

/**
* Creating a note through its DTO, with and without a listener that answers the after-persist event itself.
*
* @template-extends NewActionCrudDtoTestCase<Note, NoteDto, NoteCrudController>
*/
#[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);
}
}
63 changes: 63 additions & 0 deletions tests/Test/TestApplication/Controller/NoteCrudController.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<?php

declare(strict_types=1);

namespace Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Controller;

use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
use Override;
use Protung\EasyAdminPlusBundle\Controller\BaseCrudDtoController;
use Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Dto\NoteDto;
use Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Entity\Note;

/**
* Notes created and edited through a DTO.
*
* @template-extends BaseCrudDtoController<Note, NoteDto>
*/
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<TextField> */
#[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 ?? '';
}
}
15 changes: 15 additions & 0 deletions tests/Test/TestApplication/Dto/NoteDto.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

declare(strict_types=1);

namespace Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Dto;

final class NoteDto
{
/**
* EasyAdmin reads the primary key of the instance it shows, which is the DTO.
*/
public int|null $id = null;

public string|null $title = null;
}
19 changes: 19 additions & 0 deletions tests/Test/TestApplication/Entity/Note.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

declare(strict_types=1);

namespace Protung\EasyAdminPlusBundle\Tests\Test\TestApplication\Entity;

use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity]
class Note
{
#[ORM\Id]
#[ORM\GeneratedValue]
#[ORM\Column]
public int $id;

#[ORM\Column]
public string $title = '';
}
Loading