Add regression tests for Doctrine listener security/request context (#34, #90, #150, #151) (#41)

Author: TavoNiievez

composer.lock

@@ -92,4 +92,12 @@
     $routes->add('send_message', '/send-message')
         ->controller(App\Controller\SendMessageController::class)
         ->methods(['GET']);
+
+    $routes->add('app_create_user', '/create-user')
+        ->controller(App\Controller\CreateUserController::class)
+        ->methods(['GET']);
+
+    $routes->add('app_create_user_with_confirmation', '/create-user-with-confirmation')
+        ->controller(App\Controller\CreateUserWithConfirmationController::class)
+        ->methods(['GET']);
 };

config/routes.php

@@ -26,4 +26,37 @@
             'entity' => User::class,
             'lazy' => true,
         ]);
+
+    // Doctrine listeners used by App\Tests\Functional\IssuesCest to reproduce the
+    // security/request context regressions. Each is public so the tests can grab
+    // it and read the state it captured during the request.
+
+    // Issue #34 (entity-listener path).
+    $services->set(App\Doctrine\CurrentUserListener::class)
+        ->public()
+        ->tag('doctrine.orm.entity_listener', [
+            'event' => Events::prePersist,
+            'entity' => User::class,
+            'lazy' => true,
+        ]);
+
+    // Issue #34 (event-listener path).
+    $services->set(App\Doctrine\CurrentUserEventListener::class)
+        ->public();
+
+    // Issue #150 (request_stack inside a Doctrine listener).
+    $services->set(App\Doctrine\RequestStackListener::class)
+        ->public();
+
+    // Issue #151 (shared listener instance across reboots).
+    $services->set(App\Doctrine\FlushCounterListener::class)
+        ->public();
+
+    // Issue #90 (email sent from a Doctrine entity listener).
+    $services->set(App\Doctrine\SendConfirmationListener::class)
+        ->tag('doctrine.orm.entity_listener', [
+            'event' => Events::postPersist,
+            'entity' => User::class,
+            'lazy' => true,
+        ]);
 };

config/services.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use App\Entity\User;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * Persists a user (one prePersist + one flush) so the Doctrine listeners under
+ * test fire within a real request. Shared trigger for issues #34, #150 and #151.
+ */
+final class CreateUserController extends AbstractController
+{
+    public function __invoke(EntityManagerInterface $em): Response
+    {
+        $em->persist(User::create('jane_doe@gmail.com', '123456'));
+        $em->flush();
+
+        return new Response('Created');
+    }
+}

src/Controller/CreateUserController.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use App\Doctrine\SendConfirmationListener;
+use App\Entity\User;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * Persists the marker user that makes App\Doctrine\SendConfirmationListener send
+ * a confirmation email from inside a Doctrine entity listener. Trigger for #90.
+ */
+final class CreateUserWithConfirmationController extends AbstractController
+{
+    public function __invoke(EntityManagerInterface $em): Response
+    {
+        $em->persist(User::create(SendConfirmationListener::TRIGGER_EMAIL, '123456'));
+        $em->flush();
+
+        return new Response('Created');
+    }
+}

src/Controller/CreateUserWithConfirmationController.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Doctrine;
+
+use App\Entity\User;
+use Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineListener;
+use Doctrine\ORM\Event\PrePersistEventArgs;
+use Doctrine\ORM\Events;
+use Symfony\Component\Security\Core\Security;
+
+/**
+ * Issue #34, event-listener path: a Doctrine event listener registered on the
+ * connection's event manager (not the ORM entity-listener resolver) must also
+ * see the logged-in user. This is the case the issue thread describes as a
+ * Doctrine "subscriber". Triggered by the `/create-user` route.
+ *
+ * @see https://github.com/Codeception/module-symfony/issues/34
+ */
+#[AsDoctrineListener(event: Events::prePersist)]
+final class CurrentUserEventListener
+{
+    public ?string $currentUserIdentifier = null;
+
+    public function __construct(private readonly Security $security)
+    {
+    }
+
+    public function prePersist(PrePersistEventArgs $args): void
+    {
+        if (!$args->getObject() instanceof User) {
+            return;
+        }
+
+        $this->currentUserIdentifier = $this->security->getUser()?->getUserIdentifier();
+    }
+}

src/Doctrine/CurrentUserEventListener.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Doctrine;
+
+use App\Entity\User;
+use Symfony\Component\Security\Core\Security;
+
+/**
+ * Issue #34, entity-listener path: the security token must be available inside a
+ * Doctrine entity listener, exactly as it is inside a controller. Registered as a
+ * lazy `doctrine.orm.entity_listener` in config/services.php and triggered by the
+ * `/create-user` route (App\Controller\CreateUserController).
+ *
+ * @see https://github.com/Codeception/module-symfony/issues/34
+ */
+final class CurrentUserListener
+{
+    public ?string $currentUserIdentifier = null;
+
+    public function __construct(private readonly Security $security)
+    {
+    }
+
+    public function prePersist(User $user): void
+    {
+        $this->currentUserIdentifier = $this->security->getUser()?->getUserIdentifier();
+    }
+}

src/Doctrine/CurrentUserListener.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Doctrine;
+
+use Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineListener;
+use Doctrine\ORM\Event\OnFlushEventArgs;
+use Doctrine\ORM\Events;
+
+/**
+ * Issue #151: when the EntityManager was persisted across kernel reboots, the
+ * listener instance held by Doctrine diverged from the one returned by
+ * grabService(), so state recorded during the request was invisible to the test.
+ * Both must be the same shared instance. Triggered by the `/create-user` route,
+ * which performs exactly one flush.
+ *
+ * @see https://github.com/Codeception/module-symfony/issues/151
+ */
+#[AsDoctrineListener(event: Events::onFlush)]
+final class FlushCounterListener
+{
+    public int $flushes = 0;
+
+    public function onFlush(OnFlushEventArgs $args): void
+    {
+        ++$this->flushes;
+    }
+}

src/Doctrine/FlushCounterListener.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Doctrine;
+
+use App\Entity\User;
+use Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineListener;
+use Doctrine\ORM\Event\PrePersistEventArgs;
+use Doctrine\ORM\Events;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+/**
+ * Issue #150: the request_stack injected into a Doctrine listener must expose the
+ * current request (and therefore its locale and session), instead of returning
+ * null as it did when the EntityManager was persisted across kernel reboots.
+ * Triggered by the `/create-user` route.
+ *
+ * @see https://github.com/Codeception/module-symfony/issues/150
+ */
+#[AsDoctrineListener(event: Events::prePersist)]
+final class RequestStackListener
+{
+    public bool $hasRequest = false;
+    public ?string $currentLocale = null;
+
+    public function __construct(private readonly RequestStack $requestStack)
+    {
+    }
+
+    public function prePersist(PrePersistEventArgs $args): void
+    {
+        if (!$args->getObject() instanceof User) {
+            return;
+        }
+
+        $request = $this->requestStack->getCurrentRequest();
+        $this->hasRequest = $request !== null;
+        $this->currentLocale = $request?->getLocale();
+    }
+}

src/Doctrine/RequestStackListener.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Doctrine;
+
+use App\Entity\User;
+use App\Utils\Mailer;
+
+/**
+ * Issue #90: an email sent from a Doctrine entity listener must be collected by
+ * the profiler so that seeEmailIsSent() works. Registered as a lazy
+ * `doctrine.orm.entity_listener` and triggered by the dedicated
+ * `/create-user-with-confirmation` route.
+ *
+ * @see https://github.com/Codeception/module-symfony/issues/90
+ */
+final class SendConfirmationListener
+{
+    /**
+     * Marker address: only this user triggers the mail, so the listener
+     * does not interfere with the email counts asserted in MailerCest.
+     */
+    public const TRIGGER_EMAIL = 'issue90-listener@example.com';
+
+    public function __construct(private readonly Mailer $mailer)
+    {
+    }
+
+    public function postPersist(User $user): void
+    {
+        if ($user->getEmail() === self::TRIGGER_EMAIL) {
+            $this->mailer->sendConfirmationEmail($user);
+        }
+    }
+}