[framework] [frontend-api] universal product list (#2901)

Author: vitek-rostislav

composer.json

@@ -22,9 +22,11 @@
     },
     "require": {
         "php": "^8.1",
+        "elasticsearch/elasticsearch": "^7.6.1",
         "lcobucci/jwt": "^4.1.5",
         "overblog/graphql-bundle": "^1.0",
         "overblog/graphiql-bundle": "^0.3",
+        "overblog/dataloader-bundle": "^0.6.0",
         "shopsys/form-types-bundle": "14.0.x-dev",
         "shopsys/framework": "14.0.x-dev",
         "shopsys/migrations": "14.0.x-dev",

src/Component/Elasticsearch/MultipleSearchQuery.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Component\Elasticsearch;
+
+/**
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
+ */
+class MultipleSearchQuery
+{
+    /**
+     * @var array<int, mixed>
+     */
+    protected array $body;
+
+    /**
+     * @param string $indexName
+     * @param \Shopsys\FrameworkBundle\Model\Product\Search\FilterQuery[] $filterQueries
+     */
+    public function __construct(protected readonly string $indexName, array $filterQueries)
+    {
+        $this->body = $this->getBody($filterQueries);
+    }
+
+    /**
+     * @return array
+     */
+    public function getQuery(): array
+    {
+        return [
+            'index' => $this->indexName,
+            'body' => $this->body,
+        ];
+    }
+
+    /**
+     * @param \Shopsys\FrameworkBundle\Model\Product\Search\FilterQuery[] $filterQueries
+     * @return array
+     */
+    protected function getBody(array $filterQueries): array
+    {
+        $body = [];
+
+        foreach ($filterQueries as $filterQuery) {
+            $body[] = [];
+            $body[] = $filterQuery->getQuery()['body'];
+        }
+
+        return $body;
+    }
+}

src/Component/Elasticsearch/MultipleSearchQueryFactory.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Component\Elasticsearch;
+
+use Shopsys\FrameworkBundle\Component\Domain\Domain;
+use Shopsys\FrameworkBundle\Component\Elasticsearch\IndexDefinitionLoader;
+
+class MultipleSearchQueryFactory
+{
+    /**
+     * @param \Shopsys\FrameworkBundle\Component\Elasticsearch\IndexDefinitionLoader $indexDefinitionLoader
+     * @param \Shopsys\FrameworkBundle\Component\Domain\Domain $domain
+     */
+    public function __construct(
+        protected readonly IndexDefinitionLoader $indexDefinitionLoader,
+        protected readonly Domain $domain,
+    ) {
+    }
+
+    /**
+     * @param string $indexName
+     * @param \Shopsys\FrameworkBundle\Model\Product\Search\FilterQuery[] $filterQueries
+     * @return \Shopsys\FrontendApiBundle\Component\Elasticsearch\MultipleSearchQuery
+     */
+    public function create(string $indexName, array $filterQueries): MultipleSearchQuery
+    {
+        return new MultipleSearchQuery($this->getIndexAlias($indexName), $filterQueries);
+    }
+
+    /**
+     * @param string $indexName
+     * @return string
+     */
+    protected function getIndexAlias(string $indexName): string
+    {
+        return $this->indexDefinitionLoader->getIndexDefinition(
+            $indexName,
+            $this->domain->getId(),
+        )->getIndexAlias();
+    }
+}

src/Model/Mutation/Customer/User/CustomerUserMutation.php

@@ -11,6 +11,7 @@
 use Shopsys\FrameworkBundle\Model\Customer\User\CustomerUserFacade;
 use Shopsys\FrameworkBundle\Model\Customer\User\CustomerUserPasswordFacade;
 use Shopsys\FrameworkBundle\Model\Customer\User\FrontendCustomerUserProvider;
+use Shopsys\FrameworkBundle\Model\Product\List\ProductListFacade;
 use Shopsys\FrontendApiBundle\Model\Customer\User\CustomerUserDataFactory;
 use Shopsys\FrontendApiBundle\Model\Customer\User\CustomerUserUpdateDataFactory;
 use Shopsys\FrontendApiBundle\Model\Mutation\BaseTokenMutation;
@@ -31,6 +32,7 @@ class CustomerUserMutation extends BaseTokenMutation
      * @param \Shopsys\FrameworkBundle\Model\Customer\User\CustomerUserFacade $customerUserFacade
      * @param \Shopsys\FrontendApiBundle\Model\Customer\User\CustomerUserDataFactory $customerUserDataFactory
      * @param \Shopsys\FrontendApiBundle\Model\Token\TokenFacade $tokenFacade
+     * @param \Shopsys\FrameworkBundle\Model\Product\List\ProductListFacade $productListFacade
      */
     public function __construct(
         TokenStorageInterface $tokenStorage,
@@ -41,6 +43,7 @@ public function __construct(
         protected readonly CustomerUserFacade $customerUserFacade,
         protected readonly CustomerUserDataFactory $customerUserDataFactory,
         protected readonly TokenFacade $tokenFacade,
+        protected readonly ProductListFacade $productListFacade,
     ) {
         parent::__construct($tokenStorage);
     }
@@ -107,6 +110,8 @@ public function registerMutation(Argument $argument, InputValidator $validator):
 
         $deviceId = Uuid::uuid4()->toString();
 
+        $this->productListFacade->mergeProductListsToCustomerUser($argument['input']['productListsUuids'], $customerUser);
+
         return [
             'accessToken' => $this->tokenFacade->createAccessTokenAsString($customerUser, $deviceId),
             'refreshToken' => $this->tokenFacade->createRefreshTokenAsString($customerUser, $deviceId),

src/Model/Mutation/Login/LoginMutation.php

@@ -7,6 +7,7 @@
 use Overblog\GraphQLBundle\Definition\Argument;
 use Ramsey\Uuid\Uuid;
 use Shopsys\FrameworkBundle\Model\Customer\User\FrontendCustomerUserProvider;
+use Shopsys\FrameworkBundle\Model\Product\List\ProductListFacade;
 use Shopsys\FrontendApiBundle\Model\Mutation\AbstractMutation;
 use Shopsys\FrontendApiBundle\Model\Mutation\Customer\User\Exception\InvalidAccountOrPasswordUserError;
 use Shopsys\FrontendApiBundle\Model\Mutation\Customer\User\Exception\TooManyLoginAttemptsUserError;
@@ -24,13 +25,15 @@ class LoginMutation extends AbstractMutation
      * @param \Shopsys\FrontendApiBundle\Model\Token\TokenFacade $tokenFacade
      * @param \Symfony\Component\Security\Http\RateLimiter\DefaultLoginRateLimiter $loginRateLimiter
      * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
+     * @param \Shopsys\FrameworkBundle\Model\Product\List\ProductListFacade $productListFacade
      */
     public function __construct(
         protected readonly FrontendCustomerUserProvider $frontendCustomerUserProvider,
         protected readonly UserPasswordHasherInterface $userPasswordHasher,
         protected readonly TokenFacade $tokenFacade,
         protected readonly DefaultLoginRateLimiter $loginRateLimiter,
         protected readonly RequestStack $requestStack,
+        protected readonly ProductListFacade $productListFacade,
     ) {
     }
 
@@ -64,6 +67,8 @@ public function loginMutation(Argument $argument): array
 
         $this->loginRateLimiter->reset($this->requestStack->getCurrentRequest());
 
+        $this->productListFacade->mergeProductListsToCustomerUser($input['productListsUuids'], $user);
+
         return [
             'accessToken' => $this->tokenFacade->createAccessTokenAsString($user, $deviceId),
             'refreshToken' => $this->tokenFacade->createRefreshTokenAsString($user, $deviceId),

src/Model/Mutation/ProductList/Exception/ProductAlreadyInListUserError.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Model\Mutation\ProductList\Exception;
+
+use Overblog\GraphQLBundle\Error\UserError;
+use Shopsys\FrameworkBundle\Model\Product\List\ProductListTypeEnumInterface;
+use Shopsys\FrontendApiBundle\Model\Error\UserErrorWithCodeInterface;
+
+class ProductAlreadyInListUserError extends UserError implements UserErrorWithCodeInterface
+{
+    public const CODE = 'product-already-in-list';
+
+    /**
+     * @param string $message
+     * @param \Shopsys\FrameworkBundle\Model\Product\List\ProductListTypeEnum $productListType
+     */
+    public function __construct(
+        string $message,
+        protected readonly ProductListTypeEnumInterface $productListType,
+    ) {
+        parent::__construct($message);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getUserErrorCode(): string
+    {
+        return ProductListUserErrorCodeHelper::getUserErrorCode($this->productListType, static::CODE);
+    }
+}

src/Model/Mutation/ProductList/Exception/ProductListNotFoundUserError.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Model\Mutation\ProductList\Exception;
+
+use Overblog\GraphQLBundle\Error\UserError;
+use Shopsys\FrameworkBundle\Model\Product\List\ProductListTypeEnumInterface;
+use Shopsys\FrontendApiBundle\Model\Error\UserErrorWithCodeInterface;
+
+class ProductListNotFoundUserError extends UserError implements UserErrorWithCodeInterface
+{
+    public const CODE = 'product-list-not-found';
+
+    /**
+     * @param string $message
+     * @param \Shopsys\FrameworkBundle\Model\Product\List\ProductListTypeEnum $productListType
+     */
+    public function __construct(
+        string $message,
+        protected readonly ProductListTypeEnumInterface $productListType,
+    ) {
+        parent::__construct($message);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getUserErrorCode(): string
+    {
+        return ProductListUserErrorCodeHelper::getUserErrorCode($this->productListType, static::CODE);
+    }
+}

src/Model/Mutation/ProductList/Exception/ProductListUserErrorCodeHelper.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Model\Mutation\ProductList\Exception;
+
+use Shopsys\FrameworkBundle\Model\Product\List\ProductListTypeEnumInterface;
+
+class ProductListUserErrorCodeHelper
+{
+    /**
+     * @param \Shopsys\FrameworkBundle\Model\Product\List\ProductListTypeEnum $productListType
+     * @param string $code
+     * @return string
+     */
+    public static function getUserErrorCode(ProductListTypeEnumInterface $productListType, string $code): string
+    {
+        return $productListType->value . '-' . $code;
+    }
+}

src/Model/Mutation/ProductList/Exception/ProductNotInListUserError.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Model\Mutation\ProductList\Exception;
+
+use Overblog\GraphQLBundle\Error\UserError;
+use Shopsys\FrameworkBundle\Model\Product\List\ProductListTypeEnumInterface;
+use Shopsys\FrontendApiBundle\Model\Error\UserErrorWithCodeInterface;
+
+class ProductNotInListUserError extends UserError implements UserErrorWithCodeInterface
+{
+    public const CODE = 'product-not-in-list';
+
+    /**
+     * @param string $message
+     * @param \Shopsys\FrameworkBundle\Model\Product\List\ProductListTypeEnum $productListType
+     */
+    public function __construct(
+        string $message,
+        protected readonly ProductListTypeEnumInterface $productListType,
+    ) {
+        parent::__construct($message);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getUserErrorCode(): string
+    {
+        return ProductListUserErrorCodeHelper::getUserErrorCode($this->productListType, static::CODE);
+    }
+}