LogoutSuccessHandlerToLogoutEventSubscriberRector.php

<?php

declare(strict_types=1);

namespace Rector\Symfony\Symfony51\Rector\Class_;

use PhpParser\Node;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PHPStan\Type\ObjectType;
use Rector\Rector\AbstractRector;
use Rector\Symfony\NodeAnalyzer\ClassAnalyzer;
use Rector\Symfony\NodeFactory\GetSubscribedEventsClassMethodFactory;
use Rector\Symfony\NodeFactory\OnSuccessLogoutClassMethodFactory;
use Rector\Symfony\ValueObject\EventReferenceToMethodNameWithPriority;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @changelog https://github.com/symfony/symfony/pull/36243
 *
 * @see \Rector\Symfony\Tests\Symfony51\Rector\Class_\LogoutSuccessHandlerToLogoutEventSubscriberRector\LogoutSuccessHandlerToLogoutEventSubscriberRectorTest
 */
final class LogoutSuccessHandlerToLogoutEventSubscriberRector extends AbstractRector
{
    private readonly ObjectType $successHandlerObjectType;

    public function __construct(
        private readonly OnSuccessLogoutClassMethodFactory $onSuccessLogoutClassMethodFactory,
        private readonly GetSubscribedEventsClassMethodFactory $getSubscribedEventsClassMethodFactory,
        private readonly ClassAnalyzer $classAnalyzer,
    ) {
        $this->successHandlerObjectType = new ObjectType(
            'Symfony\Component\Security\Http\Logout\LogoutSuccessHandlerInterface'
        );
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition('Change logout success handler to an event listener that listens to LogoutEvent', [
            new CodeSample(
                <<<'CODE_SAMPLE'
use Symfony\Component\Security\Http\Logout\LogoutSuccessHandlerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;

final class SomeLogoutHandler implements LogoutSuccessHandlerInterface
{
    /**
      * @var HttpUtils
      */
    private $httpUtils;

    public function __construct(HttpUtils $httpUtils)
    {
        $this->httpUtils = $httpUtils;
    }

    public function onLogoutSuccess(Request $request)
    {
        $response = $this->httpUtils->createRedirectResponse($request, 'some_url');
        return $response;
    }
}
CODE_SAMPLE

                ,
                <<<'CODE_SAMPLE'
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Security\Http\Event\LogoutEvent;

final class SomeLogoutHandler implements EventSubscriberInterface
{
    /**
      * @var HttpUtils
      */
    private $httpUtils;

    public function onLogout(LogoutEvent $logoutEvent): void
    {
        if ($logoutEvent->getResponse() !== null) {
            return;
        }

        $response = $this->httpUtils->createRedirectResponse($logoutEvent->getRequest(), 'some_url');
        $logoutEvent->setResponse($response);
    }

    /**
     * @return array<string, mixed>
     */
    public static function getSubscribedEvents(): array
    {
        return [
            LogoutEvent::class => [['onLogout', 64]],
        ];
    }
}
CODE_SAMPLE
            ),
        ]);
    }

    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes(): array
    {
        return [Class_::class];
    }

    /**
     * @param Class_ $node
     */
    public function refactor(Node $node): ?Node
    {
        if (! $this->isObjectType($node, $this->successHandlerObjectType)) {
            return null;
        }

        if (! $this->classAnalyzer->hasImplements(
            $node,
            'Symfony\Component\Security\Http\Logout\LogoutSuccessHandlerInterface'
        )) {
            return null;
        }

        $this->refactorImplements($node);

        $node->implements[] = new FullyQualified('Symfony\Component\EventDispatcher\EventSubscriberInterface');

        // 2. refactor logout() class method to onLogout()
        $onLogoutSuccessClassMethod = null;

        foreach ($node->stmts as $key => $stmt) {
            if (! $stmt instanceof ClassMethod) {
                continue;
            }

            if (! $this->isName($stmt, 'onLogoutSuccess')) {
                continue;
            }

            $onLogoutSuccessClassMethod = $stmt;
            unset($node->stmts[$key]);
        }

        if (! $onLogoutSuccessClassMethod instanceof ClassMethod) {
            return null;
        }

        $node->stmts[] = $this->onSuccessLogoutClassMethodFactory->createFromOnLogoutSuccessClassMethod(
            $onLogoutSuccessClassMethod
        );

        // 3. add getSubscribedEvents() class method
        $classConstFetch = $this->nodeFactory->createClassConstReference(
            'Symfony\Component\Security\Http\Event\LogoutEvent'
        );

        $eventReferencesToMethodNames = [
            new EventReferenceToMethodNameWithPriority($classConstFetch, 'onLogout', 64),
        ];

        $getSubscribedEventsClassMethod = $this->getSubscribedEventsClassMethodFactory->create(
            $eventReferencesToMethodNames
        );
        $node->stmts[] = $getSubscribedEventsClassMethod;

        return $node;
    }

    private function refactorImplements(Class_ $class): void
    {
        foreach ($class->implements as $key => $implement) {
            if (! $this->isName($implement, $this->successHandlerObjectType->getClassName())) {
                continue;
            }

            unset($class->implements[$key]);
        }
    }
}