Merge branch 'ACPT-1634' into ACPT-1660-and-ACPT-1634

Author: JacobBrownAustin

app/code/Magento/ApplicationPerformanceMonitor/Profiler/Profiler.php

@@ -73,7 +73,7 @@ public function doProfile(callable $functionBeingProfiled, Application $applicat
      *
      * @param Metrics $beforeMetrics
      * @param Metrics $afterMetrics
-     * @param Metrics|null $previousAfterMetrics,
+     * @param Metrics|null $previousAfterMetrics
      * @param array $information extra information that we send to output
      * @return void
      */

app/code/Magento/ApplicationPerformanceMonitorNewRelic/Profiler/Output/NewRelicOutput.php

@@ -21,8 +21,9 @@ class NewRelicOutput implements OutputInterface
     public const CONFIG_VERBOSE_KEY = 'application/performance_monitor/newrelic_output_verbose';
 
     public function __construct(
-        private readonly DeploymentConfig $deploymentConfig, private readonly NewRelicWrapper $newRelicWrapper)
-    {
+        private readonly DeploymentConfig $deploymentConfig,
+        private readonly NewRelicWrapper $newRelicWrapper
+    ) {
     }
 
     /**
@@ -59,6 +60,11 @@ public function doOutput(array $metrics, array $information) : void
         }
     }
 
+    /**
+     * Is configured to output verbose
+     *
+     * @return bool
+     */
     private function isVerbose(): bool
     {
         return match ($this->deploymentConfig->get(static::CONFIG_VERBOSE_KEY)) {

dev/tests/api-functional/testsuite/Magento/GraphQl/ConfigurableProduct/AddConfigurableProductToCartTest.php

@@ -753,7 +753,7 @@ private function getAvailableProductCustomOption(string $productSku): array
     {
         $query = <<<QUERY
 {
-  products(filter: {sku: {eq: "${productSku}"}}) {
+  products(filter: {sku: {eq: "{$productSku}"}}) {
     items {
       name
       ... on CustomizableProductInterface {

dev/tests/integration/testsuite/Magento/GraphQl/App/State/Collector.php

@@ -9,9 +9,12 @@
 
 use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
 use Magento\Framework\ObjectManagerInterface;
+use Magento\GraphQl\App\State\ObjectManagerInterface as StateObjectManagerInterface;
 
 /**
  * Collects shared objects from ObjectManager and copies properties for later comparison
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Collector
 {
@@ -45,7 +48,7 @@ public function __construct(
      */
     private function copyArray(
         array $array,
-        string $compareType,
+        CompareType $compareType,
         int $recursionLevel,
         int $arrayRecursionLevel = 100
     ) : array {
@@ -86,9 +89,9 @@ function ($element) use (
      * @param ShouldResetState $shouldResetState
      * @return CollectedObject[]
      */
-    public function getSharedObjects(string $shouldResetState): array
+    public function getSharedObjects(ShouldResetState $shouldResetState): array
     {
-        if ($this->objectManager instanceof ObjectManager) {
+        if ($this->objectManager instanceof ObjectManagerInterface) {
             $sharedInstances = $this->objectManager->getSharedInstances();
         } else {
             $obj = new \ReflectionObject($this->objectManager);
@@ -128,7 +131,7 @@ public function getPropertiesConstructedAndCurrent(): array
     {
         /** @var ObjectManager $objectManager */
         $objectManager = $this->objectManager;
-        if (!($objectManager instanceof ObjectManager)) {
+        if (!($objectManager instanceof StateObjectManagerInterface)) {
             throw new \Exception("Not the correct type of ObjectManager");
         }
         // Calling _resetState helps us avoid adding skip/filter for these classes.
@@ -156,7 +159,7 @@ public function getPropertiesConstructedAndCurrent(): array
      */
     public function getPropertiesFromObject(
         object $object,
-        string $compareType,
+        CompareType $compareType,
         int $recursionLevel = 1,
     ): CollectedObject {
         $className = get_class($object);
@@ -165,7 +168,7 @@ public function getPropertiesFromObject(
         if (array_key_exists($className, $skipList)) {
             return CollectedObject::getSkippedObject();
         }
-        if ($this->objectManager instanceof ObjectManager) {
+        if ($this->objectManager instanceof StateObjectManagerInterface) {
             $serviceName = array_search($object, $this->objectManager->getSharedInstances(), true);
             if ($serviceName && array_key_exists($serviceName, $skipList)) {
                 return CollectedObject::getSkippedObject();

dev/tests/integration/testsuite/Magento/GraphQl/App/State/Comparator.php

@@ -179,16 +179,21 @@ private function compare(
                 }
             }
         }
-        if ($objectState) {
-            return [
-                'objectClassBefore' => $before->getClassName(),
-                'objectClassAfter' => $after->getClassName(),
-                'properties' => $objectState,
-                'objectIdBefore' => $before->getObjectId(),
-                'objectIdAfter' => $after->getObjectId(),
-            ];
+        if (!$objectState) {
+            return [];
         }
-        return [];
+        $returnValue = [
+            'objectClassBefore' => $before->getClassName(),
+            'properties' => $objectState,
+        ];
+        if ($returnValue['objectClassBefore'] !== $after->getClassName()) {
+            $returnValue['objectClassAfter'] = $after->getClassName();
+        }
+        if ($before->getObjectId() != $after->getObjectId()) {
+            $returnValue['objectIdBefore'] = $before->getObjectId();
+            $returnValue['objectIdAfter'] = $after->getObjectId();
+        }
+        return $returnValue;
     }
 
     /**

dev/tests/integration/testsuite/Magento/GraphQl/App/State/CompareType.php

@@ -9,11 +9,9 @@
 
 /**
  * What type of comparison
- *
- * TODO: change this back into enum once magento-semvar is fixed
  */
-class CompareType
+enum CompareType
 {
-    public const CompareBetweenRequests = "CompareBetweenRequests";
-    public const CompareConstructedAgainstCurrent = "CompareConstructedAgainstCurrent";
+    case CompareBetweenRequests;
+    case CompareConstructedAgainstCurrent;
 }

dev/tests/integration/testsuite/Magento/GraphQl/App/State/DynamicFactoryDecorator.php

@@ -102,7 +102,7 @@ public function _resetState(): void
     /**
      * Returns the WeakMap that stores the CollectedObject
      *
-     * @return WeakMap
+     * @return WeakMap with CollectedObject as values
      */
     public function getWeakMap() : WeakMap
     {

dev/tests/integration/testsuite/Magento/GraphQl/App/State/ObjectManager.php

@@ -14,7 +14,7 @@
 /**
  * ObjectManager decorator used by GraphQlStateTest for resetting objects and getting initial properties from objects
  */
-class ObjectManager extends TestFrameworkObjectManager
+class ObjectManager extends TestFrameworkObjectManager implements ObjectManagerInterface
 {
     /**
      * Constructs this instance by copying test framework's ObjectManager
@@ -35,7 +35,7 @@ public function __construct(TestFrameworkObjectManager $testFrameworkObjectManag
     /**
      * Returns the WeakMap used by DynamicFactoryDecorator
      *
-     * @return WeakMap
+     * @return WeakMap with CollectedObject as values
      */
     public function getWeakMap() : WeakMap
     {

dev/tests/integration/testsuite/Magento/GraphQl/App/State/ObjectManagerInterface.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQl\App\State;
+
+use Magento\Framework\ObjectManagerInterface as FrameworkObjectManagerInterface;
+use Weakmap;
+
+/**
+ * Interface for ObjectManager that has additional methods used by Collector for comparing state
+ */
+interface ObjectManagerInterface extends FrameworkObjectManagerInterface
+{
+    /**
+     * Returns the WeakMap with CollectedObject as values
+     *
+     * @return WeakMap with CollectedObject as values
+     */
+    public function getWeakMap() : WeakMap;
+
+    /**
+     * Returns shared instances
+     *
+     * @return object[]
+     */
+    public function getSharedInstances() : array;
+
+    /**
+     * Resets all factory objects that implement ResetAfterRequestInterface
+     */
+    public function resetStateWeakMapObjects() : void;
+
+    /**
+     * Resets all objects sharing state & implementing ResetAfterRequestInterface
+     */
+    public function resetStateSharedInstances() : void;
+}

dev/tests/integration/testsuite/Magento/GraphQl/App/State/ShouldResetState.php

@@ -7,9 +7,8 @@
 
 namespace Magento\GraphQl\App\State;
 
-// TODO: change this back into enum once magento-semvar is fixed
-class ShouldResetState
+enum ShouldResetState
 {
-    public const DoResetState = "DoResetState";
-    public const DoNotResetState = "DoNotResetState";
+    case DoResetState;
+    case DoNotResetState;
 }