Merge pull request #34062 from karyna-tsymbal-atwix/php8-compatibility/fixes-for-launch-magento-in-php8

andrewbess · web-flow · commit 95f8d3626d62 · 2021-09-16T22:29:19.000+03:00
Added fixes to launch Magento on PHP 8
diff --git a/app/bootstrap.php b/app/bootstrap.php
@@ -30,6 +30,16 @@
     exit(1);
 }
 
+// PHP 8 compatibility. Define constants that are not present in PHP < 8.0
+if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 80000) {
+    if (!defined('T_NAME_QUALIFIED')) {
+        define('T_NAME_QUALIFIED', 24001);
+    }
+    if (!defined('T_NAME_FULLY_QUALIFIED')) {
+        define('T_NAME_FULLY_QUALIFIED', 24002);
+    }
+}
+
 require_once __DIR__ . '/autoload.php';
 // Sets default autoload mappings, may be overridden in Bootstrap::create
 \Magento\Framework\App\Bootstrap::populateAutoloader(BP, []);
diff --git a/dev/tests/api-functional/framework/bootstrap.php b/dev/tests/api-functional/framework/bootstrap.php
@@ -123,7 +123,8 @@ function setCustomErrorHandler()
 {
     set_error_handler(
         function ($errNo, $errStr, $errFile, $errLine) {
-            if (error_reporting()) {
+            $errLevel = error_reporting();
+            if (($errLevel & $errNo) !== 0) {
                 $errorNames = [
                     E_ERROR => 'Error',
                     E_WARNING => 'Warning',
diff --git a/dev/tests/error_handler.php b/dev/tests/error_handler.php
@@ -11,7 +11,8 @@ function setCustomErrorHandler()
 {
     set_error_handler(
         function ($errNo, $errStr, $errFile, $errLine) {
-            if (error_reporting()) {
+            $errLevel = error_reporting();
+            if (($errLevel & $errNo) !== 0) {
                 $errorNames = [
                     E_ERROR => 'Error',
                     E_WARNING => 'Warning',
diff --git a/dev/tests/integration/framework/bootstrap.php b/dev/tests/integration/framework/bootstrap.php
@@ -131,7 +131,8 @@ function setCustomErrorHandler()
 {
     set_error_handler(
         function ($errNo, $errStr, $errFile, $errLine) {
-            if (error_reporting()) {
+            $errLevel = error_reporting();
+            if (($errLevel & $errNo) !== 0) {
                 $errorNames = [
                     E_ERROR => 'Error',
                     E_WARNING => 'Warning',
diff --git a/dev/tests/integration/testsuite/Magento/Customer/Model/ResourceModel/Grid/CollectionReindexOnAccountLockTest.php b/dev/tests/integration/testsuite/Magento/Customer/Model/ResourceModel/Grid/CollectionReindexOnAccountLockTest.php
@@ -12,7 +12,6 @@
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\TestFramework\Indexer\TestCase;
-use Magento\Tests\NamingConvention\true\mixed;
 
 /**
  * Test if customer account lock on too many failed authentication attempts triggers customer grid reindex
@@ -39,7 +38,7 @@ private function lockCustomerAccountWithInvalidAuthentications()
     }
 
     /**
-     * @return mixed
+     * @return string|null
      * @throws NoSuchEntityException
      */
     private function getCustomerLockExpire(): ?string
@@ -53,7 +52,7 @@ private function getCustomerLockExpire(): ?string
     }
 
     /**
-     * @return mixed
+     * @return string|null
      */
     private function getCustomerGridLockExpire(): ?string
     {
diff --git a/dev/tests/static/framework/bootstrap.php b/dev/tests/static/framework/bootstrap.php
@@ -20,6 +20,16 @@
     define('TESTS_TEMP_DIR', dirname(__DIR__) . '/tmp');
 }
 
+// PHP 8 compatibility. Define constants that are not present in PHP < 8.0
+if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 80000) {
+    if (!defined('T_NAME_QUALIFIED')) {
+        define('T_NAME_QUALIFIED', 24001);
+    }
+    if (!defined('T_NAME_FULLY_QUALIFIED')) {
+        define('T_NAME_FULLY_QUALIFIED', 24002);
+    }
+}
+
 setCustomErrorHandler();
 
 $componentRegistrar = new ComponentRegistrar();
@@ -38,7 +48,8 @@ function setCustomErrorHandler()
 {
     set_error_handler(
         function ($errNo, $errStr, $errFile, $errLine) {
-            if (error_reporting()) {
+            $errLevel = error_reporting();
+            if (($errLevel & $errNo) !== 0) {
                 $errorNames = [
                     E_ERROR => 'Error',
                     E_WARNING => 'Warning',
diff --git a/dev/tests/unit/framework/bootstrap.php b/dev/tests/unit/framework/bootstrap.php
@@ -10,6 +10,16 @@
     define('TESTS_TEMP_DIR', dirname(__DIR__) . '/tmp');
 }
 
+// PHP 8 compatibility. Define constants that are not present in PHP < 8.0
+if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 80000) {
+    if (!defined('T_NAME_QUALIFIED')) {
+        define('T_NAME_QUALIFIED', 24001);
+    }
+    if (!defined('T_NAME_FULLY_QUALIFIED')) {
+        define('T_NAME_FULLY_QUALIFIED', 24002);
+    }
+}
+
 require_once __DIR__ . '/autoload.php';
 
 setCustomErrorHandler();
@@ -30,7 +40,8 @@ function setCustomErrorHandler()
 {
     set_error_handler(
         function ($errNo, $errStr, $errFile, $errLine) {
-            if (error_reporting()) {
+            $errLevel = error_reporting();
+            if (($errLevel & $errNo) !== 0) {
                 $errorNames = [
                     E_ERROR => 'Error',
                     E_WARNING => 'Warning',
diff --git a/lib/internal/Magento/Framework/Code/Reader/ClassReader.php b/lib/internal/Magento/Framework/Code/Reader/ClassReader.php
@@ -66,6 +66,10 @@ public function getConstructor($className)
     private function getParameterClass(ReflectionParameter $reflectionParameter): ?ReflectionClass
     {
         $parameterType = $reflectionParameter->getType();
+        // In PHP8, $parameterType could be an instance of ReflectionUnionType, which doesn't have isBuiltin method.
+        if ($parameterType !== null && method_exists($parameterType, 'isBuiltin') === false) {
+            return null;
+        }
 
         return $parameterType && !$parameterType->isBuiltin()
             ? new ReflectionClass($parameterType->getName())
diff --git a/lib/internal/Magento/Framework/Code/Reader/NamespaceResolver.php b/lib/internal/Magento/Framework/Code/Reader/NamespaceResolver.php
@@ -86,6 +86,7 @@ public function getImportedNamespaces(array $fileContent)
         $classStart = array_search('{', $fileContent);
         $fileContent = array_slice($fileContent, 0, $classStart);
         $output = [];
+
         foreach ($fileContent as $position => $token) {
             if (is_array($token) && $token[0] === T_USE) {
                 $import = array_slice($fileContent, $position);
@@ -104,8 +105,14 @@ public function getImportedNamespaces(array $fileContent)
                     $import = array_filter(
                         $import,
                         function ($token) {
-                            $whitelist = [T_NS_SEPARATOR, T_STRING, T_AS];
-                            if (isset($token[0]) && in_array($token[0], $whitelist)) {
+                            $whitelist = [
+                                T_NS_SEPARATOR => T_NS_SEPARATOR,
+                                T_STRING => T_STRING,
+                                T_AS => T_AS,
+                                T_NAME_QUALIFIED => T_NAME_QUALIFIED,
+                                T_NAME_FULLY_QUALIFIED => T_NAME_FULLY_QUALIFIED
+                            ];
+                            if (isset($token[0], $whitelist[$token[0]])) {
                                 return true;
                             }
                             return false;
diff --git a/lib/internal/Magento/Framework/DB/AbstractMapper.php b/lib/internal/Magento/Framework/DB/AbstractMapper.php
@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Framework\DB;
 
 use Magento\Framework\Api\CriteriaInterface;
@@ -125,7 +126,8 @@ public function map(CriteriaInterface $criteria)
                 if (!is_array($value)) {
                     throw new \InvalidArgumentException('Wrong type of argument, expecting array for '. $mapperMethod);
                 }
-                call_user_func_array([$this, $mapperMethod], $value);
+                // The `array_values` is a workaround to ensure the same behavior in PHP 7 and 8.
+                call_user_func_array([$this, $mapperMethod], array_values($value));
             }
         }
         return $this->select;
@@ -392,9 +394,10 @@ protected function getConditionFieldName($fieldName)
 
     /**
      * Hook for operations before rendering filters
+     *
      * @return void
      */
-    protected function renderFiltersBefore()
+    protected function renderFiltersBefore() //phpcs:ignore Magento2.CodeAnalysis.EmptyBlock
     {
     }
 
diff --git a/lib/internal/Magento/Framework/Escaper.php b/lib/internal/Magento/Framework/Escaper.php
@@ -303,6 +303,12 @@ public function encodeUrlParam($string)
      */
     public function escapeJs($string)
     {
+        if (!is_string($string)) {
+            // In PHP > 8, preg_replace_callback throws an error if the 3rd param type is incorrect.
+            // This check emulates an old behavior.
+            $string = (string) $string;
+        }
+
         if ($string === '' || ctype_digit($string)) {
             return $string;
         }
diff --git a/lib/internal/Magento/Framework/MessageQueue/Rpc/Publisher.php b/lib/internal/Magento/Framework/MessageQueue/Rpc/Publisher.php
@@ -3,14 +3,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Framework\MessageQueue\Rpc;
 
-use Magento\Framework\MessageQueue\PublisherInterface;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\MessageQueue\EnvelopeFactory;
 use Magento\Framework\MessageQueue\ExchangeRepository;
 use Magento\Framework\MessageQueue\MessageEncoder;
 use Magento\Framework\MessageQueue\MessageValidator;
 use Magento\Framework\MessageQueue\Publisher\ConfigInterface as PublisherConfig;
+use Magento\Framework\MessageQueue\PublisherInterface;
 
 /**
  * A MessageQueue Publisher to handle publishing a message.
@@ -49,16 +51,17 @@ class Publisher implements PublisherInterface
      */
     private $publisherConfig;
 
-    //@codingStandardsIgnoreStart
     /**
      * Initialize dependencies.
      *
      * @param ExchangeRepository $exchangeRepository
      * @param EnvelopeFactory $envelopeFactory
      * @param null $messageQueueConfig @deprecated obsolete dependency
      * @param null $amqpConfig @deprecated obsolete dependency
-     * @param MessageEncoder $messageEncoder
-     * @param MessageValidator $messageValidator
+     * @param MessageEncoder|null $messageEncoder
+     * @param MessageValidator|null $messageValidator
+     * @param ResponseQueueNameBuilder|null $responseQueueNameBuilder
+     * @param PublisherConfig|null $publisherConfig
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
@@ -67,24 +70,32 @@ public function __construct(
         EnvelopeFactory $envelopeFactory,
         $messageQueueConfig = null,
         $amqpConfig = null,
-        MessageEncoder $messageEncoder,
-        MessageValidator $messageValidator
+        MessageEncoder $messageEncoder = null,
+        MessageValidator $messageValidator = null,
+        ResponseQueueNameBuilder $responseQueueNameBuilder = null,
+        PublisherConfig $publisherConfig = null
     ) {
         $this->exchangeRepository = $exchangeRepository;
         $this->envelopeFactory = $envelopeFactory;
-        $this->messageEncoder = $messageEncoder;
-        $this->messageValidator = $messageValidator;
+        $objectManager = ObjectManager::getInstance();
+        $this->messageEncoder = $messageEncoder
+            ?? $objectManager->get(MessageEncoder::class);
+        $this->messageValidator = $messageValidator
+            ?? $objectManager->get(MessageValidator::class);
+        $this->responseQueueNameBuilder = $responseQueueNameBuilder
+            ?? $objectManager->get(ResponseQueueNameBuilder::class);
+        $this->publisherConfig = $publisherConfig
+            ?? $objectManager->get(PublisherConfig::class);
     }
-    //@codingStandardsIgnoreEnd
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function publish($topicName, $data)
     {
         $this->messageValidator->validate($topicName, $data);
         $data = $this->messageEncoder->encode($topicName, $data);
-        $replyTo = $this->getResponseQueueNameBuilder()->getQueueName($topicName);
+        $replyTo = $this->responseQueueNameBuilder->getQueueName($topicName);
         $envelope = $this->envelopeFactory->create(
             [
                 'body' => $data,
@@ -98,40 +109,9 @@ public function publish($topicName, $data)
                 ]
             ]
         );
-        $connectionName = $this->getPublisherConfig()->getPublisher($topicName)->getConnection()->getName();
+        $connectionName = $this->publisherConfig->getPublisher($topicName)->getConnection()->getName();
         $exchange = $this->exchangeRepository->getByConnectionName($connectionName);
         $responseMessage = $exchange->enqueue($topicName, $envelope);
         return $this->messageEncoder->decode($topicName, $responseMessage, false);
     }
-
-    /**
-     * Get response queue name builder.
-     *
-     * @return ResponseQueueNameBuilder
-     *
-     * @deprecated 103.0.0
-     */
-    private function getResponseQueueNameBuilder()
-    {
-        if ($this->responseQueueNameBuilder === null) {
-            $this->responseQueueNameBuilder = \Magento\Framework\App\ObjectManager::getInstance()
-                ->get(ResponseQueueNameBuilder::class);
-        }
-        return $this->responseQueueNameBuilder;
-    }
-
-    /**
-     * Get publisher config.
-     *
-     * @return PublisherConfig
-     *
-     * @deprecated 103.0.0
-     */
-    private function getPublisherConfig()
-    {
-        if ($this->publisherConfig === null) {
-            $this->publisherConfig = \Magento\Framework\App\ObjectManager::getInstance()->get(PublisherConfig::class);
-        }
-        return $this->publisherConfig;
-    }
 }
diff --git a/lib/internal/Magento/Framework/Model/AbstractModel.php b/lib/internal/Magento/Framework/Model/AbstractModel.php
@@ -5,6 +5,7 @@
  */
 namespace Magento\Framework\Model;
 
+use Magento\Framework\DataObject;
 use Magento\Framework\Phrase;
 
 /**
@@ -14,10 +15,12 @@
  * @api
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @SuppressWarnings(PHPMD.NumberOfChildren)
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
+ * @SuppressWarnings(PHPMD.ExcessiveClassLength)
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @since 100.0.2
  */
-abstract class AbstractModel extends \Magento\Framework\DataObject
+abstract class AbstractModel extends DataObject
 {
     /**
      * Prefix of model events names
@@ -186,8 +189,8 @@ public function __construct(
         $this->_logger = $context->getLogger();
         $this->_actionValidator = $context->getActionValidator();
 
-        if (method_exists($this->_resource, 'getIdFieldName')
-            || $this->_resource instanceof \Magento\Framework\DataObject
+        if ($this->_resource !== null
+            && (method_exists($this->_resource, 'getIdFieldName') || ($this->_resource instanceof DataObject))
         ) {
             $this->_idFieldName = $this->_getResource()->getIdFieldName();
         }
diff --git a/lib/internal/Magento/Framework/Test/Unit/EscaperTest.php b/lib/internal/Magento/Framework/Test/Unit/EscaperTest.php
@@ -137,6 +137,8 @@ public function escapeJsDataProvider()
     {
         return [
             'zero length string' => ['', ''],
+            'null as string' => [null, ''],
+            'Magento\Framework\Phrase as string' => [__('test'), 'test'],
             'only digits' => ['123', '123'],
             '<' => ['<', '\u003C'],
             '>' => ['>', '\\u003E'],
diff --git a/lib/internal/Magento/Framework/Translate.php b/lib/internal/Magento/Framework/Translate.php
@@ -332,6 +332,8 @@ protected function _addData($data)
                 continue;
             }
 
+            $key = is_array($key) ? $key : (string) $key;
+            $value = is_array($value) ? $value : (string) $value;
             $key = str_replace('""', '"', $key);
             $value = str_replace('""', '"', $value);
 
diff --git a/lib/internal/Magento/Framework/View/Layout/Generator/Block.php b/lib/internal/Magento/Framework/View/Layout/Generator/Block.php
@@ -12,7 +12,7 @@
 use Magento\Framework\View\Layout;
 
 /**
- * Class Block
+ * The block of the layout generator
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Block implements Layout\GeneratorInterface
@@ -299,7 +299,8 @@ protected function generateAction($block, $methodName, $actionArguments)
         $profilerKey = 'BLOCK_ACTION:' . $block->getNameInLayout() . '>' . $methodName;
         \Magento\Framework\Profiler::start($profilerKey);
         $args = $this->evaluateArguments($actionArguments);
-        call_user_func_array([$block, $methodName], $args);
+        // The `array_values` is a workaround to ensure the same behavior in PHP 7 and 8.
+        call_user_func_array([$block, $methodName], array_values($args));
         \Magento\Framework\Profiler::stop($profilerKey);
     }
 
diff --git a/setup/src/Magento/Setup/Console/CompilerPreparation.php b/setup/src/Magento/Setup/Console/CompilerPreparation.php
diff --git a/setup/src/Magento/Setup/Module/Di/Code/Reader/FileClassScanner.php b/setup/src/Magento/Setup/Module/Di/Code/Reader/FileClassScanner.php
diff --git a/setup/src/Magento/Setup/Module/Di/Code/Reader/FileScanner.php b/setup/src/Magento/Setup/Module/Di/Code/Reader/FileScanner.php
diff --git a/setup/src/Magento/Setup/Module/Di/Code/Scanner/PhpScanner.php b/setup/src/Magento/Setup/Module/Di/Code/Scanner/PhpScanner.php
diff --git a/setup/src/Magento/Setup/Module/I18n/Parser/Adapter/Php/Tokenizer.php b/setup/src/Magento/Setup/Module/I18n/Parser/Adapter/Php/Tokenizer.php
diff --git a/setup/src/Magento/Setup/Module/I18n/Parser/Adapter/Php/Tokenizer/Token.php b/setup/src/Magento/Setup/Module/I18n/Parser/Adapter/Php/Tokenizer/Token.php
diff --git a/setup/src/Magento/Setup/Test/Unit/Module/I18n/Parser/Adapter/Php/TokenizerTest.php b/setup/src/Magento/Setup/Test/Unit/Module/I18n/Parser/Adapter/Php/TokenizerTest.php

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`* Copyright © Magento, Inc. All rights reserved.`
`4`	`4`	`* See COPYING.txt for license details.`
`5`	`5`	`*/`
	`6`	`+`
`6`	`7`	`namespace Magento\Framework\DB;`
`7`	`8`
`8`	`9`	`use Magento\Framework\Api\CriteriaInterface;`
`@@ -125,7 +126,8 @@ public function map(CriteriaInterface $criteria)`
`125`	`126`	`if (!is_array($value)) {`
`126`	`127`	`throw new \InvalidArgumentException('Wrong type of argument, expecting array for '. $mapperMethod);`
`127`	`128`	`}`
`128`		`- call_user_func_array([$this, $mapperMethod], $value);`
	`129`	+ // The `array_values` is a workaround to ensure the same behavior in PHP 7 and 8.
	`130`	`+ call_user_func_array([$this, $mapperMethod], array_values($value));`
`129`	`131`	`}`
`130`	`132`	`}`
`131`	`133`	`return $this->select;`
`@@ -392,9 +394,10 @@ protected function getConditionFieldName($fieldName)`
`392`	`394`
`393`	`395`	`/**`
`394`	`396`	`* Hook for operations before rendering filters`
	`397`	`+ *`
`395`	`398`	`* @return void`
`396`	`399`	`*/`
`397`		`- protected function renderFiltersBefore()`
	`400`	`+ protected function renderFiltersBefore() //phpcs:ignore Magento2.CodeAnalysis.EmptyBlock`
`398`	`401`	`{`
`399`	`402`	`}`
`400`	`403`