Merge pull request #575 from magento-performance/ACPT-1687

andimov · web-flow · commit ee8ac1ebf098 · 2023-11-15T10:04:16.000-06:00
ACPT-1687: Move State Comparator/Collector into proper place
diff --git a/dev/tests/integration/testsuite/Magento/Framework/ObjectManager/ResetAfterRequestTest.php b/dev/tests/integration/testsuite/Magento/Framework/ObjectManager/ResetAfterRequestTest.php
@@ -11,9 +11,9 @@
 use Magento\Framework\Exception\RuntimeException;
 use Magento\Framework\ObjectManager\FactoryInterface as ObjectManagerFactoryInterface;
 use Magento\Framework\ObjectManagerInterface;
-use Magento\GraphQl\App\State\Collector;
-use Magento\GraphQl\App\State\Comparator;
-use Magento\GraphQl\App\State\CompareType;
+use Magento\Framework\TestFramework\ApplicationStateComparator\Collector;
+use Magento\Framework\TestFramework\ApplicationStateComparator\Comparator;
+use Magento\Framework\TestFramework\ApplicationStateComparator\CompareType;
 
 /**
  * Test that verifies that resetState method for classes cause the state to be the same as it was initially constructed
diff --git a/dev/tests/integration/testsuite/Magento/GraphQl/App/State/GraphQlStateDiff.php b/dev/tests/integration/testsuite/Magento/GraphQl/App/State/GraphQlStateDiff.php
@@ -17,6 +17,8 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\ObjectManagerInterface;
+use Magento\Framework\TestFramework\ApplicationStateComparator\Comparator;
+use Magento\Framework\TestFramework\ApplicationStateComparator\ObjectManager;
 use Magento\GraphQl\Quote\GetMaskedQuoteIdByReservedOrderId;
 use Magento\Integration\Api\CustomerTokenServiceInterface;
 use Magento\Quote\Model\MaskedQuoteIdToQuoteIdInterface;
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/CollectedObject.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/CollectedObject.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQl\App\State;
+namespace Magento\Framework\TestFramework\ApplicationStateComparator;
 
 /**
  * Immutable recursive data structure that holds copy of properties from collected objects.  Created by Collector.
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/CollectedObjectConstructedAndCurrent.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/CollectedObjectConstructedAndCurrent.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQl\App\State;
+namespace Magento\Framework\TestFramework\ApplicationStateComparator;
 
 /**
  * Returned by Collector
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/Collector.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/Collector.php
@@ -5,11 +5,11 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQl\App\State;
+namespace Magento\Framework\TestFramework\ApplicationStateComparator;
 
 use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
 use Magento\Framework\ObjectManagerInterface;
-use Magento\GraphQl\App\State\ObjectManagerInterface as StateObjectManagerInterface;
+use Magento\Framework\TestFramework\ApplicationStateComparator\ObjectManagerInterface as StateObjectManagerInterface;
 
 /**
  * Collects shared objects from ObjectManager and copies properties for later comparison
@@ -160,7 +160,7 @@ public function getPropertiesConstructedAndCurrent(): array
     public function getPropertiesFromObject(
         object $object,
         CompareType $compareType,
-        int $recursionLevel = 1,
+        int $recursionLevel = 0,
     ): CollectedObject {
         $className = get_class($object);
         $skipList = $compareType == CompareType::CompareBetweenRequests ?
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/Comparator.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/Comparator.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQl\App\State;
+namespace Magento\Framework\TestFramework\ApplicationStateComparator;
 
 use Magento\Framework\ObjectManager\NoninterceptableInterface;
 
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/CompareType.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/CompareType.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQl\App\State;
+namespace Magento\Framework\TestFramework\ApplicationStateComparator;
 
 /**
  * What type of comparison
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/DynamicFactoryDecorator.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/DynamicFactoryDecorator.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQl\App\State;
+namespace Magento\Framework\TestFramework\ApplicationStateComparator;
 
 use Magento\Framework\ObjectManager\Factory\Dynamic\Developer;
 use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/ObjectManager.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/ObjectManager.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQl\App\State;
+namespace Magento\Framework\TestFramework\ApplicationStateComparator;
 
 use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
 use Magento\TestFramework\ObjectManager as TestFrameworkObjectManager;
@@ -83,8 +83,8 @@ class ObjectManager extends TestFrameworkObjectManager implements ObjectManagerI
         'Magento\Framework\Logger\LoggerProxy',
         'Magento\TestFramework\ErrorLog\Logger',
         'Magento\SalesSequence\Model\Builder',
-        'Magento\GraphQl\App\State\SkipListAndFilterList',
-        'Magento\GraphQl\App\State\Collector',
+        'Magento\Framework\TestFramework\ApplicationStateComparator\SkipListAndFilterList',
+        'Magento\Framework\TestFramework\ApplicationStateComparator\Collector',
         'Magento\Framework\App\Filesystem\DirectoryList',
         'Magento\Framework\Filesystem\DirectoryList',
         'Magento\Framework\App\DeploymentConfig',
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/ObjectManagerInterface.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/ObjectManagerInterface.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQl\App\State;
+namespace Magento\Framework\TestFramework\ApplicationStateComparator;
 
 use Magento\Framework\ObjectManagerInterface as FrameworkObjectManagerInterface;
 use Weakmap;
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/ShouldResetState.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/ShouldResetState.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQl\App\State;
+namespace Magento\Framework\TestFramework\ApplicationStateComparator;
 
 enum ShouldResetState
 {
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/SkipListAndFilterList.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/SkipListAndFilterList.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GraphQl\App\State;
+namespace Magento\Framework\TestFramework\ApplicationStateComparator;
 
 /**
  * Skip List and Filter List for collecting and comparing objects created by ObjectManager
@@ -50,7 +50,7 @@ public function getSkipList(string $operationName, CompareType $compareType): ar
     {
         if ($this->skipList === null) {
             $skipListList = [];
-            foreach (glob(__DIR__ . '/../../_files/state-skip-list*.php') as $skipListFile) {
+            foreach (glob(__DIR__ . '/_files/state-skip-list*.php') as $skipListFile) {
                 $skipListList[] = include($skipListFile);
             }
             $this->skipList = array_merge_recursive(...$skipListList);
@@ -82,7 +82,7 @@ public function getFilterList(): array
     {
         if ($this->filterList === null) {
             $filterListList = [];
-            foreach (glob(__DIR__ . '/../../_files/state-filter-list*.php') as $filterListFile) {
+            foreach (glob(__DIR__ . '/_files/state-filter-list*.php') as $filterListFile) {
                 $filterListList[] = include($filterListFile);
             }
             $this->filterList = array_merge_recursive(...$filterListList);
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/_files/state-filter-list.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/_files/state-filter-list.php
diff --git a/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/_files/state-skip-list.php b/lib/internal/Magento/Framework/TestFramework/ApplicationStateComparator/_files/state-skip-list.php
@@ -323,7 +323,7 @@
          * resetState for userContext makes sense, but we need to make sure that it cannot copy current userContext. */
         Magento\CustomerGraphQl\Model\Context\AddUserInfoToContext::class => null, // FIXME: see above comment
         Magento\TestFramework\App\State::class => null,
-        Magento\GraphQl\App\State\SkipListAndFilterList::class => null, // Yes, our test uses mutable state itself :-)
+        Magento\Framework\TestFramework\ApplicationStateComparator\SkipListAndFilterList::class => null, // Yes, our test uses mutable state itself :-)
         Magento\Framework\DB\Adapter\Pdo\Mysql\Interceptor::class => null,
         Magento\Framework\App\ObjectManager\ConfigLoader\Compiled::class => null,
         Magento\Framework\Cache\Frontend\Adapter\Zend::class => null, // TODO: parentFrontends???
@@ -375,7 +375,7 @@
         Magento\PageBuilder\Plugin\Filter\TemplatePlugin::class => null,
         Magento\Customer\Api\Data\CustomerExtension::class => null,
         Magento\Framework\Css\PreProcessor\Adapter\CssInliner::class => null,
-        Magento\GraphQl\App\State\ObjectManager::class => null,
+        Magento\Framework\TestFramework\ApplicationStateComparator\ObjectManager::class => null,
         Magento\RemoteStorage\Filesystem::class => null,
         Magento\Framework\App\Cache\Frontend\Factory::class => null,
         Magento\Framework\Config\Scope::class => null,
@@ -387,7 +387,7 @@
         Magento\Framework\Xml\Parser::class => null, # TODO: why?!?! errorHandlerIsActive
         Magento\Framework\App\Area::class => null,
         Magento\Store\Model\Store\Interceptor::class => null,
-        Magento\GraphQl\App\State\Comparator::class => null, // Yes, our test uses mutable state itself :-)
+        Magento\Framework\TestFramework\ApplicationStateComparator\Comparator::class => null, // Yes, our test uses mutable state itself :-)
         Magento\Framework\GraphQl\Query\QueryParser::class =>
             null, // TODO: Do we need to add a reset for when config changes?
         Magento\Framework\App\Http\Context\Interceptor::class => null,
@@ -728,6 +728,7 @@
         Magento\Staging\Model\Update::class => null,
         Magento\Staging\Model\Update\Flag::class => null,
         Magento\Catalog\Model\Category\Attribute\Source\Sortby::class => null,
+        Magento\Config\App\Config\Source\EnvironmentConfigSource::class => null,
     ],
     '' => [
     ],
diff --git a/setup/src/Magento/Setup/Module/Di/Code/Reader/FileClassScanner.php b/setup/src/Magento/Setup/Module/Di/Code/Reader/FileClassScanner.php
@@ -137,6 +137,10 @@ private function extract(): string
             // `class` token is not used with a valid class name
             } elseif ($triggerClass && !$tokenIsArray) {
                 $triggerClass = false;
+            // `class` token was used as a string; not to define class
+            } elseif ($triggerClass && empty($class) && $token[0] === T_DOUBLE_ARROW) {
+                $triggerClass = false;
+                continue;
             // The class keyword was found in the last loop
             } elseif ($triggerClass && $token[0] === T_STRING) {
                 $triggerClass = false;
