MAGETWO-52143: Make Redis session adapter changes backwards compatible in 2.1

Author: dsikkema-magento

lib/internal/Magento/Framework/Session/Config.php

@@ -76,9 +76,6 @@ class Config implements ConfigInterface
     /** @var string */
     protected $lifetimePath;
 
-    /** @var string */
-    private $saveHandlerName;
-
     /** @var \Magento\Framework\ValidatorFactory */
     protected $_validatorFactory;
 
@@ -110,20 +107,6 @@ public function __construct(
         $this->_scopeType = $scopeType;
         $this->lifetimePath = $lifetimePath;
 
-        /**
-         * 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.
-         */
-        $defaultSaveHandler = $this->getStorageOption('session.save_handler')
-            ?: SaveHandlerInterface::DEFAULT_HANDLER;
-        $saveMethod = $deploymentConfig->get(
-            self::PARAM_SESSION_SAVE_METHOD,
-            $defaultSaveHandler
-        );
-        $this->setSaveHandler($saveMethod);
-
         /**
          * Session path
          */
@@ -271,38 +254,6 @@ public function getName()
         return (string)$this->getOption('session.name');
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function setSaveHandler($saveHandler)
-    {
-        $this->setSaveHandlerName($saveHandler);
-        if ($saveHandler === 'db' || $saveHandler === 'redis') {
-            $saveHandler = 'user';
-        }
-        $this->setOption('session.save_handler', $saveHandler);
-        return $this;
-    }
-
-    /**
-     * Set save handler name
-     *
-     * @param string $saveHandlerName
-     * @return void
-     */
-    private function setSaveHandlerName($saveHandlerName)
-    {
-        $this->saveHandlerName = $saveHandlerName;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getSaveHandlerName()
-    {
-        return $this->saveHandlerName;
-    }
-
     /**
      * Set session.save_path
      *

lib/internal/Magento/Framework/Session/Config/ConfigInterface.php

@@ -170,19 +170,4 @@ public function setUseCookies($useCookies);
      * @SuppressWarnings(PHPMD.BooleanGetMethodName)
      */
     public function getUseCookies();
-
-    /**
-     * Get save handler name
-     *
-     * @return string
-     */
-    public function getSaveHandlerName();
-
-    /**
-     * Set session.save_handler
-     *
-     * @param string $saveHandler
-     * @return $this
-     */
-    public function setSaveHandler($saveHandler);
 }

lib/internal/Magento/Framework/Session/SaveHandler.php

@@ -5,6 +5,7 @@
  */
 namespace Magento\Framework\Session;
 
+use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\Exception\SessionException;
 use Magento\Framework\Session\Config\ConfigInterface;
 
@@ -20,24 +21,40 @@ class SaveHandler implements SaveHandlerInterface
      */
     protected $saveHandlerAdapter;
 
+    /**
+     * Config
+     *
+     * @var ConfigInterface
+     */
+    private $config;
+
     /**
      * Constructor
      *
      * @param SaveHandlerFactory $saveHandlerFactory
-     * @param ConfigInterface $config
+     * @param DeploymentConfig $deploymentConfig
      * @param string $default
      */
     public function __construct(
         SaveHandlerFactory $saveHandlerFactory,
-        ConfigInterface $config,
+        DeploymentConfig $deploymentConfig,
         $default = self::DEFAULT_HANDLER
     ) {
-        $saveMethod = $config->getSaveHandlerName();
+        /**
+         * 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.
+         */
+        $defaultSaveHandler = ini_get('session.save_handler') ?: SaveHandlerInterface::DEFAULT_HANDLER;
+        $saveMethod = $deploymentConfig->get(Config::PARAM_SESSION_SAVE_METHOD, $defaultSaveHandler);
+        $this->setSaveHandler($saveMethod);
+
         try {
             $connection = $saveHandlerFactory->create($saveMethod);
         } catch (SessionException $e) {
             $connection = $saveHandlerFactory->create($default);
-            $config->setSaveHandler($default);
+            $this->setSaveHandler($default);
         }
         $this->saveHandlerAdapter = $connection;
     }
@@ -110,4 +127,35 @@ public function gc($maxLifetime)
     {
         return $this->saveHandlerAdapter->gc($maxLifetime);
     }
+
+    /**
+     * Get config
+     *
+     * @return ConfigInterface
+     * @deprecated
+     */
+    private function getConfig()
+    {
+        if (!($this->config instanceof ConfigInterface)) {
+            return \Magento\Framework\App\ObjectManager::getInstance()->get(
+                ConfigInterface::class
+            );
+        }
+        return $this->config;
+    }
+
+    /**
+     * Set session.save_handler option in ini config
+     *
+     * @param string $saveHandler
+     * @return $this
+     */
+    private function setSaveHandler($saveHandler)
+    {
+        if ($saveHandler === 'db' || $saveHandler === 'redis') {
+            $saveHandler = 'user';
+        }
+        $this->getConfig()->setOption('session.save_handler', $saveHandler);
+        return $this;
+    }
 }