ACPT-1666: Fix race conditions in _resetState methods

andimov · andimov · commit 0b15090b5648 · 2023-12-14T12:53:46.000-06:00
-- fix test failures
diff --git a/app/code/Magento/BundleGraphQl/Model/Cart/BuyRequest/BundleDataProvider.php b/app/code/Magento/BundleGraphQl/Model/Cart/BuyRequest/BundleDataProvider.php
@@ -19,14 +19,15 @@ class BundleDataProvider implements BuyRequestDataProviderInterface
 {
     /**
      * @var ArrayManagerFactory
-     *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ArrayManagerFactory $arrayManagerFactory;
 
     /**
      * @param ArrayManager $arrayManager @deprecated @see $arrayManagerFactory
      * @param ArrayManagerFactory|null $arrayManagerFactory
+     *
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function __construct(
         ArrayManager $arrayManager,
diff --git a/app/code/Magento/Catalog/Model/Product/Type.php b/app/code/Magento/Catalog/Model/Product/Type.php
@@ -24,17 +24,17 @@
  */
 class Type implements OptionSourceInterface, ResetAfterRequestInterface
 {
-    const TYPE_SIMPLE = 'simple';
+    public const TYPE_SIMPLE = 'simple';
 
-    const TYPE_BUNDLE = 'bundle';
+    public const TYPE_BUNDLE = 'bundle';
 
-    const TYPE_VIRTUAL = 'virtual';
+    public const TYPE_VIRTUAL = 'virtual';
 
-    const DEFAULT_TYPE = 'simple';
+    public const DEFAULT_TYPE = 'simple';
 
-    const DEFAULT_TYPE_MODEL = Simple::class;
+    public const DEFAULT_TYPE_MODEL = Simple::class;
 
-    const DEFAULT_PRICE_MODEL = Price::class;
+    public const DEFAULT_PRICE_MODEL = Price::class;
 
     /**
      * @var ConfigInterface
@@ -56,8 +56,6 @@ class Type implements OptionSourceInterface, ResetAfterRequestInterface
     protected $_compositeTypes;
 
     /**
-     * Price models
-     *
      * @var array|null|Price
      */
     protected $_priceModels;
diff --git a/app/code/Magento/ConfigurableProductGraphQl/Model/Cart/BuyRequest/SuperAttributeDataProvider.php b/app/code/Magento/ConfigurableProductGraphQl/Model/Cart/BuyRequest/SuperAttributeDataProvider.php
@@ -31,7 +31,7 @@ class SuperAttributeDataProvider implements BuyRequestDataProviderInterface
     /**
      * @var ArrayManagerFactory
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ArrayManagerFactory $arrayManagerFactory;
 
diff --git a/app/code/Magento/Integration/Model/CustomUserContext.php b/app/code/Magento/Integration/Model/CustomUserContext.php
@@ -15,14 +15,14 @@ class CustomUserContext implements UserContextInterface
     /**
      * @var int|null
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ?int $userId;
 
     /**
      * @var int|null
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ?int $userType;
 
diff --git a/app/code/Magento/JwtUserToken/Model/Data/JwtUserContext.php b/app/code/Magento/JwtUserToken/Model/Data/JwtUserContext.php
@@ -15,14 +15,14 @@ class JwtUserContext implements UserContextInterface
     /**
      * @var int|null
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ?int $userId;
 
     /**
      * @var int|null
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ?int $userType;
 
diff --git a/app/code/Magento/PaypalGraphQl/Model/PayflowProAdditionalDataProvider.php b/app/code/Magento/PaypalGraphQl/Model/PayflowProAdditionalDataProvider.php
@@ -18,6 +18,8 @@ class PayflowProAdditionalDataProvider implements AdditionalDataProviderInterfac
 {
     /**
      * @param ArrayManager $arrayManager
+     *
+     * phpcs:disable Magento2.CodeAnalysis.EmptyBlock
      */
     public function __construct(ArrayManager $arrayManager)
     {
diff --git a/app/code/Magento/PaypalGraphQl/Model/PayflowProCcVaultAdditionalDataProvider.php b/app/code/Magento/PaypalGraphQl/Model/PayflowProCcVaultAdditionalDataProvider.php
@@ -19,6 +19,8 @@ class PayflowProCcVaultAdditionalDataProvider implements AdditionalDataProviderI
 
     /**
      * @param ArrayManager $arrayManager
+     *
+     * phpcs:disable Magento2.CodeAnalysis.EmptyBlock
      */
     public function __construct(ArrayManager $arrayManager)
     {
diff --git a/app/code/Magento/PaypalGraphQl/Model/Plugin/Resolver/SetPaymentMethodOnCart.php b/app/code/Magento/PaypalGraphQl/Model/Plugin/Resolver/SetPaymentMethodOnCart.php
@@ -41,6 +41,8 @@ class SetPaymentMethodOnCart
 
     /**
      * @var ArrayManagerFactory
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ArrayManagerFactory $arrayManagerFactory;
 
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/BuyRequest/CustomizableOptionsDataProvider.php b/app/code/Magento/QuoteGraphQl/Model/Cart/BuyRequest/CustomizableOptionsDataProvider.php
@@ -19,7 +19,7 @@ class CustomizableOptionsDataProvider implements BuyRequestDataProviderInterface
     /**
      * @var ArrayManagerFactory
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ArrayManagerFactory $arrayManagerFactory;
 
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/BuyRequest/QuantityDataProvider.php b/app/code/Magento/QuoteGraphQl/Model/Cart/BuyRequest/QuantityDataProvider.php
@@ -20,7 +20,7 @@ class QuantityDataProvider implements BuyRequestDataProviderInterface
     /**
      * @var ArrayManagerFactory
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ArrayManagerFactory $arrayManagerFactory;
 
diff --git a/app/code/Magento/SalesRule/Model/DeltaPriceRound.php b/app/code/Magento/SalesRule/Model/DeltaPriceRound.php
@@ -26,13 +26,18 @@ class DeltaPriceRound implements ResetAfterRequestInterface
     private $roundingDeltas;
 
     /**
+     * Constructor
+     *
      * @param PriceCurrencyInterface $priceCurrency
      */
     public function __construct(PriceCurrencyInterface $priceCurrency)
     {
         $this->priceCurrency = $priceCurrency;
     }
 
+    /**
+     * @inheritDoc
+     */
     public function _resetState(): void
     {
         $this->roundingDeltas = null;
diff --git a/app/code/Magento/Theme/Model/Theme/ThemeProvider.php b/app/code/Magento/Theme/Model/Theme/ThemeProvider.php
@@ -45,14 +45,14 @@ class ThemeProvider implements ThemeProviderInterface, ResetAfterRequestInterfac
     /**
      * @var DeploymentConfig
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly DeploymentConfig $deploymentConfig;
 
     /**
      * @var Json
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly Json $serializer;
 
diff --git a/app/code/Magento/Webapi/Model/Authorization/SoapUserContext.php b/app/code/Magento/Webapi/Model/Authorization/SoapUserContext.php
@@ -23,14 +23,14 @@ class SoapUserContext implements UserContextInterface, ResetAfterRequestInterfac
     /**
      * @var Request
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly Request $request;
 
     /**
-     * @var Token
+     * @var TokenFactory
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly TokenFactory $tokenFactory;
 
@@ -52,14 +52,14 @@ class SoapUserContext implements UserContextInterface, ResetAfterRequestInterfac
     /**
      * @var IntegrationServiceInterface
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly IntegrationServiceInterface $integrationService;
 
     /**
      * @var BearerTokenValidator
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly BearerTokenValidator $bearerTokenValidator;
 
diff --git a/app/code/Magento/Webapi/Model/Authorization/TokenUserContext.php b/app/code/Magento/Webapi/Model/Authorization/TokenUserContext.php
@@ -62,14 +62,14 @@ class TokenUserContext implements UserContextInterface, ResetAfterRequestInterfa
     /**
      * @var UserTokenReaderInterface
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly UserTokenReaderInterface $userTokenReader;
 
     /**
      * @var UserTokenValidatorInterface
      *
-     * @SuppressWarnings(PHPCS)
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly UserTokenValidatorInterface $userTokenValidator;
 
diff --git a/dev/tests/integration/testsuite/Magento/GraphQl/App/GraphQlCheckoutMutationsStateTest.php b/dev/tests/integration/testsuite/Magento/GraphQl/App/GraphQlCheckoutMutationsStateTest.php
@@ -13,6 +13,7 @@
 use Magento\TestFramework\Fixture\DataFixture;
 use Magento\TestFramework\Fixture\DataFixtureStorage;
 use Magento\TestFramework\Fixture\DataFixtureStorageManager;
+use Magento\TestFramework\Helper\Bootstrap;
 
 /**
  * Tests the dispatch method in the GraphQl Controller class using a simple product query
diff --git a/lib/internal/Magento/Framework/App/Route/Config.php b/lib/internal/Magento/Framework/App/Route/Config.php
@@ -1,7 +1,5 @@
 <?php
 /**
- * Routes configuration model
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
@@ -10,6 +8,9 @@
 use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Routes configuration model
+ */
 class Config implements ConfigInterface, ResetAfterRequestInterface
 {
     /**
diff --git a/lib/internal/Magento/Framework/DB/Logger/LoggerProxy.php b/lib/internal/Magento/Framework/DB/Logger/LoggerProxy.php
@@ -52,31 +52,43 @@ class LoggerProxy implements LoggerInterface, ResetAfterRequestInterface
 
     /**
      * @var FileFactory
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly FileFactory $fileFactory;
 
     /**
      * @var QuietFactory
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly QuietFactory $quietFactory;
 
     /**
      * @var string|null
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ?string $loggerAlias;
 
     /**
      * @var bool
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly bool $logAllQueries;
 
     /**
      * @var float
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly float $logQueryTime;
 
     /**
      * @var bool
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly bool $logCallStack;
 
diff --git a/lib/internal/Magento/Framework/HTTP/PhpEnvironment/RemoteAddress.php b/lib/internal/Magento/Framework/HTTP/PhpEnvironment/RemoteAddress.php
@@ -20,6 +20,8 @@ class RemoteAddress implements ResetAfterRequestInterface
      * Request object.
      *
      * @var RequestInterface
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     protected readonly RequestInterface $request;
 
@@ -32,15 +34,21 @@ class RemoteAddress implements ResetAfterRequestInterface
 
     /**
      * @var array
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     protected readonly array $alternativeHeaders;
 
     /**
      * @var string[]|null
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly ?array $trustedProxies;
 
     /**
+     * Constructor
+     *
      * @param RequestInterface $httpRequest
      * @param array $alternativeHeaders
      * @param string[]|null $trustedProxies
@@ -55,6 +63,9 @@ public function __construct(
         $this->trustedProxies = $trustedProxies;
     }
 
+    /**
+     * @inheritDoc
+     */
     public function _resetState(): void
     {
         $this->remoteAddress = null;
diff --git a/lib/internal/Magento/Framework/MessageQueue/Topology/Config/Xml/Converter.php b/lib/internal/Magento/Framework/MessageQueue/Topology/Config/Xml/Converter.php
@@ -27,16 +27,22 @@ class Converter implements \Magento\Framework\Config\ConverterInterface, ResetAf
      * Boolean value converter.
      *
      * @var BooleanUtils
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly BooleanUtils $booleanUtils;
 
     /**
      * @var InterpreterInterface
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly InterpreterInterface $argumentInterpreter;
 
     /**
      * @var DefaultValueProvider
+     *
+     * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
      */
     private readonly DefaultValueProvider $defaultValue;
 
diff --git a/lib/internal/Magento/Framework/Model/ResourceModel/AbstractResource.php b/lib/internal/Magento/Framework/Model/ResourceModel/AbstractResource.php
@@ -82,7 +82,7 @@ public function addCommitCallback($callback)
     /**
      * Commit resource transaction
      *
-     * @deprecated see \Magento\Framework\Model\ExecuteCommitCallbacks::afterCommit
+     * @deprecated @see \Magento\Framework\Model\ExecuteCommitCallbacks::afterCommit
      * @return $this
      */
     public function commit()
@@ -248,7 +248,7 @@ protected function _getColumnsForEntityLoad(\Magento\Framework\Model\AbstractMod
      * Get serializer
      *
      * @return Json
-     * @deprecated 101.0.0
+     * @deprecated 101.0.0 @see not recommended anymore
      * @since 101.0.0
      */
     protected function getSerializer()
@@ -263,7 +263,7 @@ protected function getSerializer()
      * Get logger
      *
      * @return \Psr\Log\LoggerInterface
-     * @deprecated 101.0.1
+     * @deprecated 101.0.1 @see not recommended anymore
      */
     private function getLogger()
     {
diff --git a/lib/internal/Magento/Framework/Module/ModuleList/Loader.php b/lib/internal/Magento/Framework/Module/ModuleList/Loader.php
diff --git a/lib/internal/Magento/Framework/Search/Request/Cleaner.php b/lib/internal/Magento/Framework/Search/Request/Cleaner.php
diff --git a/lib/internal/Magento/Framework/Validator/Factory.php b/lib/internal/Magento/Framework/Validator/Factory.php
diff --git a/lib/internal/Magento/Framework/View/Asset/Source.php b/lib/internal/Magento/Framework/View/Asset/Source.php
diff --git a/lib/internal/Magento/Framework/View/Design/Fallback/RulePool.php b/lib/internal/Magento/Framework/View/Design/Fallback/RulePool.php
diff --git a/lib/internal/Magento/Framework/Webapi/Rest/Request/Deserializer/Xml.php b/lib/internal/Magento/Framework/Webapi/Rest/Request/Deserializer/Xml.php

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class SuperAttributeDataProvider implements BuyRequestDataProviderInterface`
`31`	`31`	`/**`
`32`	`32`	`* @var ArrayManagerFactory`
`33`	`33`	`*`
`34`		`- * @SuppressWarnings(PHPCS)`
	`34`	`+ * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting`
`35`	`35`	`*/`
`36`	`36`	`private readonly ArrayManagerFactory $arrayManagerFactory;`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@ class PayflowProAdditionalDataProvider implements AdditionalDataProviderInterfac`
`18`	`18`	`{`
`19`	`19`	`/**`
`20`	`20`	`* @param ArrayManager $arrayManager`
	`21`	`+ *`
	`22`	`+ * phpcs:disable Magento2.CodeAnalysis.EmptyBlock`
`21`	`23`	`*/`
`22`	`24`	`public function __construct(ArrayManager $arrayManager)`
`23`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@ class PayflowProCcVaultAdditionalDataProvider implements AdditionalDataProviderI`
`19`	`19`
`20`	`20`	`/**`
`21`	`21`	`* @param ArrayManager $arrayManager`
	`22`	`+ *`
	`23`	`+ * phpcs:disable Magento2.CodeAnalysis.EmptyBlock`
`22`	`24`	`*/`
`23`	`25`	`public function __construct(ArrayManager $arrayManager)`
`24`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class CustomizableOptionsDataProvider implements BuyRequestDataProviderInterface`
`19`	`19`	`/**`
`20`	`20`	`* @var ArrayManagerFactory`
`21`	`21`	`*`
`22`		`- * @SuppressWarnings(PHPCS)`
	`22`	`+ * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting`
`23`	`23`	`*/`
`24`	`24`	`private readonly ArrayManagerFactory $arrayManagerFactory;`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class QuantityDataProvider implements BuyRequestDataProviderInterface`
`20`	`20`	`/**`
`21`	`21`	`* @var ArrayManagerFactory`
`22`	`22`	`*`
`23`		`- * @SuppressWarnings(PHPCS)`
	`23`	`+ * phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting`
`24`	`24`	`*/`
`25`	`25`	`private readonly ArrayManagerFactory $arrayManagerFactory;`
`26`	`26`