magento/graphql-ce#741: Add extension point to set custom parameters …

…to Query Context object
magento · Jun 19, 2019 · 0d505fe · 0d505fe
1 parent 87296c1
commit 0d505fe
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 144 deletions.
diff --git a/app/code/Magento/CustomerGraphQl/Model/Context/AddUserInfoToContext.php b/app/code/Magento/CustomerGraphQl/Model/Context/AddUserInfoToContext.php
@@ -21,21 +21,13 @@ class AddUserInfoToContext implements ContextParametersProcessorInterface
      */
     private $userContext;
 
-    /**
-     * @var GetCustomer
-     */
-    private $getCustomer;
-
     /**
      * @param UserContextInterface $userContext
-     * @param GetCustomer $getCustomer
      */
     public function __construct(
-        UserContextInterface $userContext,
-        GetCustomer $getCustomer
+        UserContextInterface $userContext
     ) {
         $this->userContext = $userContext;
-        $this->getCustomer = $getCustomer;
     }
 
     /**
@@ -53,28 +45,8 @@ public function execute(ContextParametersInterface $contextParameters): ContextP
             $currentUserType = (int)$currentUserType;
         }
 
-        if (false === $this->isUserGuest($currentUserId, $currentUserType)) {
-            $customer = $this->getCustomer->execute($currentUserId);
-            $contextParameters->addExtensionAttribute('customer', $customer);
-        }
-
         $contextParameters->setUserId($currentUserId);
         $contextParameters->setUserType($currentUserType);
         return $contextParameters;
     }
-
-    /**
-     * Checking if current customer is guest
-     *
-     * @param int|null $customerId
-     * @param int|null $customerType
-     * @return bool
-     */
-    private function isUserGuest(?int $customerId, ?int $customerType): bool
-    {
-        if (null === $customerId || null === $customerType) {
-            return true;
-        }
-        return 0 === (int)$customerId || (int)$customerType === UserContextInterface::USER_TYPE_GUEST;
-    }
 }
diff --git a/app/code/Magento/CustomerGraphQl/Model/Context/GetCustomer.php b/app/code/Magento/CustomerGraphQl/Model/Context/GetCustomer.php
diff --git a/app/code/Magento/CustomerGraphQl/Model/Customer/SaveCustomer.php b/app/code/Magento/CustomerGraphQl/Model/Customer/SaveCustomer.php
@@ -11,7 +11,6 @@
 use Magento\Framework\Exception\AlreadyExistsException;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\GraphQl\Exception\GraphQlAlreadyExistsException;
-use Magento\Framework\GraphQl\Exception\GraphQlAuthenticationException;
 use Magento\Framework\GraphQl\Exception\GraphQlInputException;
 use Magento\Customer\Api\Data\CustomerInterface;
 
@@ -39,7 +38,6 @@ public function __construct(
      *
      * @param CustomerInterface $customer
      * @throws GraphQlAlreadyExistsException
-     * @throws GraphQlAuthenticationException
      * @throws GraphQlInputException
      */
     public function execute(CustomerInterface $customer): void

diff --git a/app/code/Magento/CustomerGraphQl/Model/Resolver/IsSubscribed.php b/app/code/Magento/CustomerGraphQl/Model/Resolver/IsSubscribed.php
@@ -7,7 +7,6 @@
 
 namespace Magento\CustomerGraphQl\Model\Resolver;
 
-use Magento\CustomerGraphQl\Model\Customer\GetCustomer;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\Framework\GraphQl\Config\Element\Field;
@@ -19,25 +18,17 @@
  */
 class IsSubscribed implements ResolverInterface
 {
-    /**
-     * @var GetCustomer
-     */
-    private $getCustomer;
-
     /**
      * @var SubscriberFactory
      */
     private $subscriberFactory;
 
     /**
-     * @param GetCustomer $getCustomer
      * @param SubscriberFactory $subscriberFactory
      */
     public function __construct(
-        GetCustomer $getCustomer,
         SubscriberFactory $subscriberFactory
     ) {
-        $this->getCustomer = $getCustomer;
         $this->subscriberFactory = $subscriberFactory;
     }
 

diff --git a/app/code/Magento/GraphQl/Controller/GraphQl.php b/app/code/Magento/GraphQl/Controller/GraphQl.php
@@ -13,6 +13,7 @@
 use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\GraphQl\Exception\ExceptionFormatter;
 use Magento\Framework\GraphQl\Query\QueryProcessor;
+use Magento\Framework\GraphQl\Query\Resolver\ContextInterface;
 use Magento\Framework\GraphQl\Schema\SchemaGeneratorInterface;
 use Magento\Framework\Serialize\SerializerInterface;
 use Magento\Framework\Webapi\Response;
@@ -57,9 +58,10 @@ class GraphQl implements FrontControllerInterface
     private $graphQlError;
 
     /**
-     * @var ContextFactoryInterface
+     * @var ContextInterface
+     * @deprecated $contextFactory is used for creating Context object
      */
-    private $contextFactory;
+    private $resolverContext;
 
     /**
      * @var HttpRequestProcessor
@@ -81,17 +83,23 @@ class GraphQl implements FrontControllerInterface
      */
     private $httpResponse;
 
+    /**
+     * @var ContextFactoryInterface
+     */
+    private $contextFactory;
+
     /**
      * @param Response $response
      * @param SchemaGeneratorInterface $schemaGenerator
      * @param SerializerInterface $jsonSerializer
      * @param QueryProcessor $queryProcessor
      * @param ExceptionFormatter $graphQlError
-     * @param ContextFactoryInterface $contextFactory
+     * @param ContextInterface $resolverContext Deprecated. $contextFactory is used for creating Context object.
      * @param HttpRequestProcessor $requestProcessor
      * @param QueryFields $queryFields
      * @param JsonFactory|null $jsonFactory
      * @param HttpResponse|null $httpResponse
+     * @param ContextFactoryInterface $contextFactory
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -100,22 +108,24 @@ public function __construct(
         SerializerInterface $jsonSerializer,
         QueryProcessor $queryProcessor,
         ExceptionFormatter $graphQlError,
-        ContextFactoryInterface $contextFactory,
+        ContextInterface $resolverContext,
         HttpRequestProcessor $requestProcessor,
         QueryFields $queryFields,
         JsonFactory $jsonFactory = null,
-        HttpResponse $httpResponse = null
+        HttpResponse $httpResponse = null,
+        ContextFactoryInterface $contextFactory = null
     ) {
         $this->response = $response;
         $this->schemaGenerator = $schemaGenerator;
         $this->jsonSerializer = $jsonSerializer;
         $this->queryProcessor = $queryProcessor;
         $this->graphQlError = $graphQlError;
-        $this->contextFactory = $contextFactory;
+        $this->resolverContext = $resolverContext;
         $this->requestProcessor = $requestProcessor;
         $this->queryFields = $queryFields;
         $this->jsonFactory = $jsonFactory ?: ObjectManager::getInstance()->get(JsonFactory::class);
         $this->httpResponse = $httpResponse ?: ObjectManager::getInstance()->get(HttpResponse::class);
+        $this->contextFactory = $contextFactory ?: ObjectManager::getInstance()->get(ContextFactoryInterface::class);
     }
 
     /**

diff --git a/app/code/Magento/GraphQl/Model/Query/ContextFactory.php b/app/code/Magento/GraphQl/Model/Query/ContextFactory.php
@@ -19,7 +19,7 @@ class ContextFactory implements ContextFactoryInterface
     /**
      * @var ExtensionAttributesFactory
      */
-    protected $extensionAttributesFactory;
+    private $extensionAttributesFactory;
 
     /**
      * @var ObjectManagerInterface
@@ -64,7 +64,9 @@ public function create(): ContextInterface
 
         $extensionAttributes = $this->extensionAttributesFactory->create(
             ContextInterface::class,
-            $contextParameters->getExtensionAttributesData()
+            [
+                'data' => $contextParameters->getExtensionAttributesData(),
+            ]
         );
 
         $context = $this->objectManager->create(

diff --git a/app/code/Magento/GraphQl/etc/di.xml b/app/code/Magento/GraphQl/etc/di.xml
@@ -7,6 +7,7 @@
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
     <preference for="Magento\Framework\GraphQl\Schema\SchemaGeneratorInterface" type="Magento\Framework\GraphQl\Schema\SchemaGenerator" />
+    <preference for="Magento\Framework\GraphQl\Query\Resolver\ContextInterface" type="Magento\GraphQl\Model\Query\Resolver\Context" />
     <preference for="Magento\GraphQl\Model\Query\ContextInterface" type="Magento\GraphQl\Model\Query\Context" />
     <preference for="Magento\Framework\GraphQl\Schema\Type\Entity\MapperInterface" type="Magento\Framework\GraphQl\Schema\Type\Entity\DefaultMapper"/>
     <preference for="Magento\Framework\GraphQl\Schema\Type\Enum\DataMapperInterface" type="Magento\Framework\GraphQl\Schema\Type\Enum\DefaultDataMapper"/>

diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/GetCartForUser.php b/app/code/Magento/QuoteGraphQl/Model/Cart/GetCartForUser.php
@@ -58,6 +58,7 @@ public function __construct(
      * @return Quote
      * @throws GraphQlAuthorizationException
      * @throws GraphQlNoSuchEntityException
+     * @throws NoSuchEntityException
      */
     public function execute(string $cartHash, ?int $customerId): Quote
     {

diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/QuoteAddressFactory.php b/app/code/Magento/QuoteGraphQl/Model/Cart/QuoteAddressFactory.php
@@ -80,8 +80,8 @@ public function createBasedOnInputData(array $addressInput): QuoteAddress
      * @param int $customerAddressId
      * @param int $customerId
      * @return QuoteAddress
-     * @throws GraphQlInputException
      * @throws GraphQlAuthorizationException
+     * @throws GraphQlInputException
      * @throws GraphQlNoSuchEntityException
      */
     public function createBasedOnCustomerAddress(int $customerAddressId, int $customerId): QuoteAddress

diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/SetShippingAddressesOnCartInterface.php b/app/code/Magento/QuoteGraphQl/Model/Cart/SetShippingAddressesOnCartInterface.php
@@ -31,7 +31,6 @@ interface SetShippingAddressesOnCartInterface
      * @return void
      * @throws GraphQlInputException
      * @throws GraphQlAuthorizationException
-     * @throws GraphQlAuthenticationException
      * @throws GraphQlNoSuchEntityException
      */
     public function execute(ContextInterface $context, CartInterface $cart, array $shippingAddressesInput): void;