Merge remote-tracking branch 'origin/MC-30397' into 2.4-develop-pr9

StasKozar · StasKozar · commit b9c047375686 · 2020-02-04T16:01:41.000+02:00
diff --git a/dev/tests/integration/testsuite/Magento/Framework/Session/SaveHandlerTest.php b/dev/tests/integration/testsuite/Magento/Framework/Session/SaveHandlerTest.php
@@ -3,18 +3,25 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Framework\Session;
 
 use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\Exception\SessionException;
 use Magento\Framework\Phrase;
 use Magento\Framework\Session\Config\ConfigInterface;
-use Magento\Framework\App\ObjectManager;
+use Magento\TestFramework\Helper\Bootstrap;
+use Magento\TestFramework\ObjectManager;
 
+/**
+ * Tests \Magento\Framework\Session\SaveHandler functionality.
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class SaveHandlerTest extends \PHPUnit\Framework\TestCase
 {
     /**
-     * @var \Magento\TestFramework\ObjectManager
+     * @var ObjectManager
      */
     private $objectManager;
 
@@ -28,115 +35,96 @@ class SaveHandlerTest extends \PHPUnit\Framework\TestCase
      */
     private $saveHandlerFactoryMock;
 
+    /**
+     * @inheritdoc
+     */
     protected function setUp()
     {
-        $this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
+        $this->objectManager = Bootstrap::getObjectManager();
         $this->deploymentConfigMock = $this->createMock(DeploymentConfig::class);
         $this->objectManager->addSharedInstance($this->deploymentConfigMock, DeploymentConfig::class);
         $this->saveHandlerFactoryMock = $this->createMock(SaveHandlerFactory::class);
         $this->objectManager->addSharedInstance($this->saveHandlerFactoryMock, SaveHandlerFactory::class);
     }
 
+    /**
+     * @inheritdoc
+     */
     protected function tearDown()
     {
         $this->objectManager->removeSharedInstance(DeploymentConfig::class);
         $this->objectManager->removeSharedInstance(SaveHandlerFactory::class);
     }
 
     /**
-     * Tests that the session handler is correctly set when object is created.
-     *
-     * @dataProvider saveHandlerProvider
-     * @param string $deploymentConfigHandler
+     * @return void
      */
-    public function testConstructor($deploymentConfigHandler)
+    public function testRedisSaveHandler(): void
     {
-        $expected = $this->getExpectedSaveHandler($deploymentConfigHandler, ini_get('session.save_handler'));
-
         $this->deploymentConfigMock->method('get')
-            ->willReturnCallback(function ($configPath) use ($deploymentConfigHandler) {
-                switch ($configPath) {
-                    case Config::PARAM_SESSION_SAVE_METHOD:
-                        return $deploymentConfigHandler;
-                    case Config::PARAM_SESSION_CACHE_LIMITER:
-                        return 'private_no_expire';
-                    case Config::PARAM_SESSION_SAVE_PATH:
-                        return 'explicit_save_path';
-                    default:
-                        return null;
-                }
-            });
-
-        $this->saveHandlerFactoryMock->expects($this->once())
-            ->method('create')
-            ->with($expected);
-        $sessionConfig = $this->objectManager->create(ConfigInterface::class);
-        $this->objectManager->create(SaveHandler::class, ['sessionConfig' => $sessionConfig]);
+            ->willReturnMap(
+                [
+                    [Config::PARAM_SESSION_SAVE_METHOD, null, 'redis'],
+                    [Config::PARAM_SESSION_SAVE_PATH, null, 'explicit_save_path'],
+                ]
+            );
 
-        // Test expectation
-        $this->assertEquals(
-            $expected,
-            $sessionConfig->getOption('session.save_handler')
-        );
-    }
+        $redisHandlerMock = $this->getMockBuilder(SaveHandler\Redis::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $redisHandlerMock->method('open')
+            ->with('explicit_save_path', 'test_session_id')
+            ->willReturn(true);
 
-    public function saveHandlerProvider()
-    {
-        return [
-            ['db'],
-            ['redis'],
-            ['files'],
-            [false],
-        ];
+        $this->saveHandlerFactoryMock->expects($this->exactly(1))
+            ->method('create')
+            ->with('redis')
+            ->willReturn($redisHandlerMock);
+
+        $sessionConfig = $this->objectManager->create(ConfigInterface::class);
+        /** @var SaveHandler $saveHandler */
+        $saveHandler = $this->objectManager->create(SaveHandler::class, ['sessionConfig' => $sessionConfig]);
+        $result = $saveHandler->open('explicit_save_path', 'test_session_id');
+        $this->assertTrue($result);
     }
 
     /**
-     * Retrieve expected session.save_handler
-     *
-     * @param string $deploymentConfigHandler
-     * @param string $iniHandler
-     * @return string
+     * @return void
      */
-    private function getExpectedSaveHandler($deploymentConfigHandler, $iniHandler)
-    {
-        if ($deploymentConfigHandler) {
-            return $deploymentConfigHandler;
-        } elseif ($iniHandler) {
-            return $iniHandler;
-        } else {
-            return SaveHandlerInterface::DEFAULT_HANDLER;
-        }
-    }
-
-    public function testConstructorWithException()
+    public function testRedisSaveHandlerFallbackToDefaultOnSessionException(): void
     {
         $this->deploymentConfigMock->method('get')
-            ->willReturnCallback(function ($configPath) {
-                switch ($configPath) {
-                    case Config::PARAM_SESSION_SAVE_METHOD:
-                        return 'db';
-                    case Config::PARAM_SESSION_CACHE_LIMITER:
-                        return 'private_no_expire';
-                    case Config::PARAM_SESSION_SAVE_PATH:
-                        return 'explicit_save_path';
-                    default:
-                        return null;
-                }
-            });
+            ->willReturnMap(
+                [
+                    [Config::PARAM_SESSION_SAVE_METHOD, null, 'redis'],
+                    [Config::PARAM_SESSION_SAVE_PATH, null, 'explicit_save_path'],
+                ]
+            );
+
+        $redisHandlerMock = $this->getMockBuilder(SaveHandler\Redis::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $redisHandlerMock->method('open')
+            ->with('explicit_save_path', 'test_session_id')
+            ->willThrowException(new SessionException(new Phrase('Session Exception')));
+
+        $defaultHandlerMock = $this->getMockBuilder(SaveHandler\Native::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $defaultHandlerMock->expects($this->once())->method('open')->with('explicit_save_path', 'test_session_id');
 
         $this->saveHandlerFactoryMock->expects($this->at(0))
             ->method('create')
-            ->willThrowException(new SessionException(new Phrase('Session Exception')));
+            ->with('redis')
+            ->willReturn($redisHandlerMock);
         $this->saveHandlerFactoryMock->expects($this->at(1))
             ->method('create')
-            ->with(SaveHandlerInterface::DEFAULT_HANDLER);
-        $sessionConfig = $this->objectManager->create(ConfigInterface::class);
-        $this->objectManager->create(SaveHandler::class, ['sessionConfig' => $sessionConfig]);
+            ->with(SaveHandlerInterface::DEFAULT_HANDLER)
+            ->willReturn($defaultHandlerMock);
 
-        // Test expectation
-        $this->assertEquals(
-            'db',
-            $sessionConfig->getOption('session.save_handler')
-        );
+        $sessionConfig = $this->objectManager->create(ConfigInterface::class);
+        /** @var SaveHandler $saveHandler */
+        $saveHandler = $this->objectManager->create(SaveHandler::class, ['sessionConfig' => $sessionConfig]);
+        $saveHandler->open('explicit_save_path', 'test_session_id');
     }
 }
diff --git a/lib/internal/Magento/Framework/Session/SaveHandler.php b/lib/internal/Magento/Framework/Session/SaveHandler.php
@@ -3,13 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Framework\Session;
 
 use Magento\Framework\Session\Config\ConfigInterface;
-use \Magento\Framework\Exception\SessionException;
+use Magento\Framework\Exception\SessionException;
 
 /**
- * Magento session save handler
+ * Magento session save handler.
  */
 class SaveHandler implements SaveHandlerInterface
 {
@@ -21,8 +22,21 @@ class SaveHandler implements SaveHandlerInterface
     protected $saveHandlerAdapter;
 
     /**
-     * Constructor
-     *
+     * @var SaveHandlerFactory
+     */
+    private $saveHandlerFactory;
+
+    /**
+     * @var ConfigInterface
+     */
+    private $sessionConfig;
+
+    /**
+     * @var string
+     */
+    private $defaultHandler;
+
+    /**
      * @param SaveHandlerFactory $saveHandlerFactory
      * @param ConfigInterface $sessionConfig
      * @param string $default
@@ -32,87 +46,100 @@ public function __construct(
         ConfigInterface $sessionConfig,
         $default = self::DEFAULT_HANDLER
     ) {
-        /**
-         * Session handler
-         *
-         * Save handler may be set to custom value in deployment config, which will override everything else.
-         * Otherwise, try to read PHP settings for session.save_handler value. Otherwise, use 'files' as default.
-         */
-        $saveMethod = $sessionConfig->getOption('session.save_handler') ?: $default;
-
-        try {
-            $this->saveHandlerAdapter = $saveHandlerFactory->create($saveMethod);
-        } catch (SessionException $e) {
-            $this->saveHandlerAdapter = $saveHandlerFactory->create($default);
-        }
+        $this->saveHandlerFactory = $saveHandlerFactory;
+        $this->sessionConfig = $sessionConfig;
+        $this->defaultHandler = $default;
     }
 
     /**
-     * Open Session - retrieve resources
+     * Open Session - retrieve resources.
      *
      * @param string $savePath
      * @param string $name
      * @return bool
      */
     public function open($savePath, $name)
     {
-        return $this->saveHandlerAdapter->open($savePath, $name);
+        return $this->callSafely('open', $savePath, $name);
     }
 
     /**
-     * Close Session - free resources
+     * Close Session - free resources.
      *
      * @return bool
      */
     public function close()
     {
-        return $this->saveHandlerAdapter->close();
+        return $this->callSafely('close');
     }
 
     /**
-     * Read session data
+     * Read session data.
      *
      * @param string $sessionId
      * @return string
      */
     public function read($sessionId)
     {
-        return $this->saveHandlerAdapter->read($sessionId);
+        return $this->callSafely('read', $sessionId);
     }
 
     /**
-     * Write Session - commit data to resource
+     * Write Session - commit data to resource.
      *
      * @param string $sessionId
      * @param string $data
      * @return bool
      */
     public function write($sessionId, $data)
     {
-        return $this->saveHandlerAdapter->write($sessionId, $data);
+        return $this->callSafely('write', $sessionId, $data);
     }
 
     /**
-     * Destroy Session - remove data from resource for given session id
+     * Destroy Session - remove data from resource for given session id.
      *
      * @param string $sessionId
      * @return bool
      */
     public function destroy($sessionId)
     {
-        return $this->saveHandlerAdapter->destroy($sessionId);
+        return $this->callSafely('destroy', $sessionId);
     }
 
     /**
-     * Garbage Collection - remove old session data older
-     * than $maxLifetime (in seconds)
+     * Garbage Collection - remove old session data older than $maxLifetime (in seconds).
      *
      * @param int $maxLifetime
      * @return bool
      * @SuppressWarnings(PHPMD.ShortMethodName)
      */
     public function gc($maxLifetime)
     {
-        return $this->saveHandlerAdapter->gc($maxLifetime);
+        return $this->callSafely('gc', $maxLifetime);
+    }
+
+    /**
+     * Call save handler adapter method.
+     *
+     * In case custom handler failed, default files handler is used.
+     *
+     * @param string $method
+     * @param mixed $arguments
+     *
+     * @return mixed
+     */
+    private function callSafely(string $method, ...$arguments)
+    {
+        try {
+            if ($this->saveHandlerAdapter === null) {
+                $saveMethod = $this->sessionConfig->getOption('session.save_handler') ?: $this->defaultHandler;
+                $this->saveHandlerAdapter = $this->saveHandlerFactory->create($saveMethod);
+            }
+            return $this->saveHandlerAdapter->{$method}(...$arguments);
+        } catch (SessionException $exception) {
+            $this->saveHandlerAdapter = $this->saveHandlerFactory->create($this->defaultHandler);
+            return $this->saveHandlerAdapter->{$method}(...$arguments);
+        }
     }
 }
