fix(session): fix the reset password process

Author: Louis Courvoisier

CHANGELOG.md

@@ -8,6 +8,12 @@ A [BC BREAK] means the update will break the project for many reasons:
 * class refactoring
 
 
+### 2017-03-17
+
+* Prevents to close the user session too quickly in order to allow Drupal to write in.
+It fixes the reset password process.
+* Adds psr/log to fix the deprecation of LoggerInterface.
+
 ### 2014-05-19
 
 * [BC BREAK] Third argument of EntityRepository::findBy method is now $fieldConditions.

Event/Listener/UserRegistrationHookListener.php

@@ -12,7 +12,7 @@
 namespace Ekino\Bundle\DrupalBundle\Event\Listener;
 
 use Ekino\Bundle\DrupalBundle\Event\DrupalEvent;
-use Symfony\Component\HttpKernel\Log\LoggerInterface;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
 use Symfony\Component\Security\Core\User\UserInterface;
@@ -24,35 +24,40 @@
  */
 class UserRegistrationHookListener
 {
-    protected $userManager;
-
+    /**
+     * @var LoggerInterface
+     */
     protected $logger;
 
+    /**
+     * @var Request
+     */
     protected $request;
 
+    /**
+     * @var array
+     */
     protected $providerKeys;
 
     /**
-     * @param \Symfony\Component\HttpKernel\Log\LoggerInterface $logger
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     * @param array $providerKeys
+     * @param LoggerInterface $logger
+     * @param Request         $request
+     * @param array           $providerKeys
      */
     public function __construct(LoggerInterface $logger, Request $request, array $providerKeys)
     {
-        $this->logger      = $logger;
-        $this->request     = $request;
+        $this->logger       = $logger;
+        $this->request      = $request;
         $this->providerKeys = $providerKeys;
     }
 
     /**
      * http://api.drupal.org/api/drupal/modules--user--user.api.php/function/hook_user_login/7
      *
-     * @param \Ekino\Bundle\DrupalBundle\Event\DrupalEvent $event
-     * @return void
+     * @param DrupalEvent $event
      */
     public function onLogin(DrupalEvent $event)
     {
-        $edit = $event->getParameter(0);
         $user = $event->getParameter(1);
 
         if (!$user instanceof UserInterface) {
@@ -64,21 +69,17 @@ public function onLogin(DrupalEvent $event)
         // will be used
         foreach ($this->providerKeys as $providerKey) {
             $token = new UsernamePasswordToken($user, null, $providerKey, $user->getRoles());
-
             $this->request->getSession()->set('_security_'.$providerKey, serialize($token));
         }
-
-        $this->request->getSession()->save();
     }
 
     /**
-     * @param \Ekino\Bundle\DrupalBundle\Event\DrupalEvent $event
-     * @return void
+     * @param DrupalEvent $event
      */
     public function onLogout(DrupalEvent $event)
     {
         foreach ($this->providerKeys as $providerKey) {
             $this->request->getSession()->set('_security_'.$providerKey, null);
         }
     }
-}
+}

Tests/Event/Listener/UserRegistrationHookListenerTest.php

@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * This file is part of the Ekino Drupal package.
+ *
+ * (c) 2011 Ekino
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ekino\Bundle\DrupalBundle\Event\Listener;
+
+/**
+ * Tests UserRegistrationHookListener
+ *
+ * @author Louis Courvoisier <louis.courvoisier@ekino.com>
+ */
+class UserRegistrationHookListenerTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * Asserts the onLogin method throws an exception if user not instance of UserInterface
+     *
+     * @expectedException        \RuntimeException
+     * @expectedExceptionMessage An instance of UserInterface is expected
+     */
+    public function testOnLoginThrowsException()
+    {
+        $logger   = $this->getMock('Psr\Log\LoggerInterface');
+        $request  = $this->getMock('Symfony\Component\HttpFoundation\Request');
+        $listener = new UserRegistrationHookListener($logger, $request, array());
+
+        $event = $this->getMock('Ekino\Bundle\DrupalBundle\Event\DrupalEvent');
+        $event->expects($this->once())->method('getParameter')->with($this->equalTo(1))->willReturn(null);
+
+        $listener->onLogin($event);
+    }
+
+    /**
+     * Test onLogin method with provider keys
+     */
+    public function testOnLoginUserWithProviderKeys()
+    {
+        $logger  = $this->getMock('Psr\Log\LoggerInterface');
+        $session = $this->getMock('Symfony\Component\HttpFoundation\Session\SessionInterface');
+
+        $request = $this->getMock('Symfony\Component\HttpFoundation\Request');
+        $request->expects($this->exactly(3))->method('getSession')->willReturn($session);
+
+        $user = $this->getMock('Symfony\Component\Security\Core\User\UserInterface');
+        $user->expects($this->any())->method('getRoles')->willReturn(array('ROLE_USER'));
+
+        $event = $this->getMock('Ekino\Bundle\DrupalBundle\Event\DrupalEvent');
+        $event->expects($this->once())->method('getParameter')->with($this->equalTo(1))->willReturn($user);
+
+        $listener = new UserRegistrationHookListener($logger, $request, array('1', '2', '3'));
+        $listener->onLogin($event);
+    }
+
+    /**
+     * Test onLogin method with no provider keys
+     */
+    public function testOnLoginUserWithoutProviderKeys()
+    {
+        $logger = $this->getMock('Psr\Log\LoggerInterface');
+
+        $request = $this->getMock('Symfony\Component\HttpFoundation\Request');
+        $request->expects($this->never())->method('getSession');
+
+        $user = $this->getMock('Symfony\Component\Security\Core\User\UserInterface');
+
+        $event = $this->getMock('Ekino\Bundle\DrupalBundle\Event\DrupalEvent');
+        $event->expects($this->once())->method('getParameter')->with($this->equalTo(1))->willReturn($user);
+
+        $listener = new UserRegistrationHookListener($logger, $request, array());
+        $listener->onLogin($event);
+    }
+}

composer.json

@@ -16,7 +16,8 @@
         "friendsofsymfony/user-bundle": "*",
         "symfony/http-foundation": ">=2.1,<3.0-dev",
         "symfony/http-kernel": ">=2.1,<3.0-dev",
-        "twig/extensions": "1.0.*"
+        "twig/extensions": "1.0.*",
+        "psr/log": "1.0.*"
     },
     "autoload": {
         "psr-0": { "Ekino\\Bundle\\DrupalBundle": "" }