MAGETWO-60910: Session initialized during reindex from CLI and result fatal error

- Don't start session if cli used.

Author: AlexeyManenok

dev/tests/integration/etc/di/preferences/ce.php

@@ -27,4 +27,5 @@
     \Magento\Framework\App\Config\ScopeConfigInterface::class => \Magento\TestFramework\App\Config::class,
     \Magento\Framework\App\ResourceConnection\ConfigInterface::class =>
         \Magento\Framework\App\ResourceConnection\Config::class,
+    \Magento\Framework\Session\SessionStartChecker::class => \Magento\TestFramework\Session\SessionStartChecker::class
 ];

dev/tests/integration/framework/Magento/TestFramework/Session/SessionStartChecker.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\TestFramework\Session;
+
+/**
+ * Class to check if session can be started or not. Dummy for integration tests.
+ */
+class SessionStartChecker extends \Magento\Framework\Session\SessionStartChecker
+{
+    /**
+     * Can session be started or not.
+     *
+     * @return bool
+     */
+    public function check() : bool
+    {
+        return true;
+    }
+}

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

@@ -36,7 +36,7 @@ class SessionManager implements SessionManagerInterface
     /**
      * Validator
      *
-     * @var \Magento\Framework\Session\ValidatorInterface
+     * @var ValidatorInterface
      */
     protected $validator;
 
@@ -50,28 +50,28 @@ class SessionManager implements SessionManagerInterface
     /**
      * SID resolver
      *
-     * @var \Magento\Framework\Session\SidResolverInterface
+     * @var SidResolverInterface
      */
     protected $sidResolver;
 
     /**
      * Session config
      *
-     * @var \Magento\Framework\Session\Config\ConfigInterface
+     * @var Config\ConfigInterface
      */
     protected $sessionConfig;
 
     /**
      * Save handler
      *
-     * @var \Magento\Framework\Session\SaveHandlerInterface
+     * @var SaveHandlerInterface
      */
     protected $saveHandler;
 
     /**
      * Storage
      *
-     * @var \Magento\Framework\Session\StorageInterface
+     * @var StorageInterface
      */
     protected $storage;
 
@@ -92,6 +92,11 @@ class SessionManager implements SessionManagerInterface
      */
     private $appState;
 
+    /**
+     * @var SessionStartChecker
+     */
+    private $sessionStartChecker;
+
     /**
      * @param \Magento\Framework\App\Request\Http $request
      * @param SidResolverInterface $sidResolver
@@ -102,7 +107,10 @@ class SessionManager implements SessionManagerInterface
      * @param \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager
      * @param \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $cookieMetadataFactory
      * @param \Magento\Framework\App\State $appState
+     * @param SessionStartChecker|null $sessionStartChecker
      * @throws \Magento\Framework\Exception\SessionException
+     *
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         \Magento\Framework\App\Request\Http $request,
@@ -113,7 +121,8 @@ public function __construct(
         StorageInterface $storage,
         \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager,
         \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $cookieMetadataFactory,
-        \Magento\Framework\App\State $appState
+        \Magento\Framework\App\State $appState,
+        SessionStartChecker $sessionStartChecker = null
     ) {
         $this->request = $request;
         $this->sidResolver = $sidResolver;
@@ -124,11 +133,15 @@ public function __construct(
         $this->cookieManager = $cookieManager;
         $this->cookieMetadataFactory = $cookieMetadataFactory;
         $this->appState = $appState;
+        $this->sessionStartChecker = $sessionStartChecker ?: \Magento\Framework\App\ObjectManager::getInstance()->get(
+            SessionStartChecker::class
+        );
         $this->start();
     }
 
     /**
-     * This method needs to support sessions with APC enabled
+     * This method needs to support sessions with APC enabled.
+     *
      * @return void
      */
     public function writeClose()
@@ -163,47 +176,49 @@ public function __call($method, $args)
      */
     public function start()
     {
-        if (!$this->isSessionExists()) {
-            \Magento\Framework\Profiler::start('session_start');
-
-            try {
-                $this->appState->getAreaCode();
-            } catch (\Magento\Framework\Exception\LocalizedException $e) {
-                throw new \Magento\Framework\Exception\SessionException(
-                    new \Magento\Framework\Phrase(
-                        'Area code not set: Area code must be set before starting a session.'
-                    ),
-                    $e
-                );
-            }
+        if ($this->sessionStartChecker->check()) {
+            if (!$this->isSessionExists()) {
+                \Magento\Framework\Profiler::start('session_start');
+
+                try {
+                    $this->appState->getAreaCode();
+                } catch (\Magento\Framework\Exception\LocalizedException $e) {
+                    throw new \Magento\Framework\Exception\SessionException(
+                        new \Magento\Framework\Phrase(
+                            'Area code not set: Area code must be set before starting a session.'
+                        ),
+                        $e
+                    );
+                }
 
-            // Need to apply the config options so they can be ready by session_start
-            $this->initIniOptions();
-            $this->registerSaveHandler();
-            if (isset($_SESSION['new_session_id'])) {
-                // Not fully expired yet. Could be lost cookie by unstable network.
-                session_commit();
-                session_id($_SESSION['new_session_id']);
-            }
-            $sid = $this->sidResolver->getSid($this);
-            // potential custom logic for session id (ex. switching between hosts)
-            $this->setSessionId($sid);
-            session_start();
-            if (isset($_SESSION['destroyed'])
-                && $_SESSION['destroyed'] < time() - $this->sessionConfig->getCookieLifetime()
-            ) {
-                $this->destroy(['clear_storage' => true]);
-            }
+                // Need to apply the config options so they can be ready by session_start
+                $this->initIniOptions();
+                $this->registerSaveHandler();
+                if (isset($_SESSION['new_session_id'])) {
+                    // Not fully expired yet. Could be lost cookie by unstable network.
+                    session_commit();
+                    session_id($_SESSION['new_session_id']);
+                }
+                $sid = $this->sidResolver->getSid($this);
+                // potential custom logic for session id (ex. switching between hosts)
+                $this->setSessionId($sid);
+                session_start();
+                if (isset($_SESSION['destroyed'])
+                    && $_SESSION['destroyed'] < time() - $this->sessionConfig->getCookieLifetime()
+                ) {
+                    $this->destroy(['clear_storage' => true]);
+                }
 
-            $this->validator->validate($this);
-            $this->renewCookie($sid);
+                $this->validator->validate($this);
+                $this->renewCookie($sid);
 
-            register_shutdown_function([$this, 'writeClose']);
+                register_shutdown_function([$this, 'writeClose']);
 
-            $this->_addHost();
-            \Magento\Framework\Profiler::stop('session_start');
+                $this->_addHost();
+                \Magento\Framework\Profiler::stop('session_start');
+            }
+            $this->storage->init(isset($_SESSION) ? $_SESSION : []);
         }
-        $this->storage->init(isset($_SESSION) ? $_SESSION : []);
         return $this;
     }
 

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

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\Framework\Session;
+
+/**
+ * Class to check if session can be started or not.
+ */
+class SessionStartChecker
+{
+    /**
+     * @var bool
+     */
+    private $checkSapi;
+
+    /**
+     * @param bool $checkSapi
+     */
+    public function __construct(bool $checkSapi = true)
+    {
+        $this->checkSapi = $checkSapi;
+    }
+
+    /**
+     * Can session be started or not.
+     *
+     * @return bool
+     */
+    public function check() : bool
+    {
+        return !($this->checkSapi && PHP_SAPI === 'cli');
+    }
+}