[shopsys] added hreflang feature (#2970)

shopsys · Jan 23, 2024 · d238091 · d238091
2 parents 5c352c8 + 525fbb1
commit d238091
Show file tree

Hide file tree

Showing 21 changed files with 246 additions and 2 deletions.
diff --git a/src/Model/Blog/Article/BlogArticleResolverMap.php b/src/Model/Blog/Article/BlogArticleResolverMap.php
@@ -40,6 +40,9 @@ protected function map(): array
                 'link' => static function (array $blogArticleData) {
                     return $blogArticleData['url'];
                 },
+                'hreflangLinks' => function (array $blogArticleData) {
+                    return $blogArticleData['hreflangLinks'];
+                },
             ],
         ];
     }

diff --git a/src/Model/Blog/Category/BlogCategoryResolverMap.php b/src/Model/Blog/Category/BlogCategoryResolverMap.php
@@ -10,6 +10,7 @@
 use Shopsys\FrameworkBundle\Model\Blog\Article\Elasticsearch\BlogArticleElasticsearchFacade;
 use Shopsys\FrameworkBundle\Model\Blog\Category\BlogCategory;
 use Shopsys\FrameworkBundle\Model\Blog\Category\BlogCategoryFacade;
+use Shopsys\FrameworkBundle\Model\Seo\HreflangLinksFacade;
 
 class BlogCategoryResolverMap extends ResolverMap
 {
@@ -18,12 +19,14 @@ class BlogCategoryResolverMap extends ResolverMap
      * @param \Shopsys\FrameworkBundle\Component\Router\FriendlyUrl\FriendlyUrlFacade $friendlyUrlFacade
      * @param \Shopsys\FrameworkBundle\Model\Blog\Category\BlogCategoryFacade $blogCategoryFacade
      * @param \Shopsys\FrameworkBundle\Model\Blog\Article\Elasticsearch\BlogArticleElasticsearchFacade $blogArticleElasticsearchFacade
+     * @param \Shopsys\FrameworkBundle\Model\Seo\HreflangLinksFacade $hreflangLinksFacade
      */
     public function __construct(
         protected readonly Domain $domain,
         protected readonly FriendlyUrlFacade $friendlyUrlFacade,
         protected readonly BlogCategoryFacade $blogCategoryFacade,
         protected readonly BlogArticleElasticsearchFacade $blogArticleElasticsearchFacade,
+        protected readonly HreflangLinksFacade $hreflangLinksFacade,
     ) {
     }
 
@@ -69,6 +72,9 @@ protected function map(): array
                 'articlesTotalCount' => function (BlogCategory $blogCategory) {
                     return $this->blogArticleElasticsearchFacade->getByBlogCategoryTotalCount($blogCategory);
                 },
+                'hreflangLinks' => function (BlogCategory $blogCategory) {
+                    return $this->hreflangLinksFacade->getForBlogCategory($blogCategory, $this->domain->getId());
+                },
             ],
         ];
     }

diff --git a/src/Model/Resolver/Brand/BrandResolverMap.php b/src/Model/Resolver/Brand/BrandResolverMap.php
@@ -7,17 +7,20 @@
 use Overblog\GraphQLBundle\Resolver\ResolverMap;
 use Shopsys\FrameworkBundle\Component\Domain\Domain;
 use Shopsys\FrameworkBundle\Model\Product\Brand\Brand;
+use Shopsys\FrameworkBundle\Model\Seo\HreflangLinksFacade;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
 class BrandResolverMap extends ResolverMap
 {
     /**
      * @param \Symfony\Component\Routing\Generator\UrlGeneratorInterface $urlGenerator
      * @param \Shopsys\FrameworkBundle\Component\Domain\Domain $domain
+     * @param \Shopsys\FrameworkBundle\Model\Seo\HreflangLinksFacade $hreflangLinksFacade
      */
     public function __construct(
         protected readonly UrlGeneratorInterface $urlGenerator,
         protected readonly Domain $domain,
+        protected readonly HreflangLinksFacade $hreflangLinksFacade,
     ) {
     }
 
@@ -44,6 +47,9 @@ protected function map(): array
                 'seoH1' => function (Brand $brand) {
                     return $brand->getSeoH1($this->domain->getId());
                 },
+                'hreflangLinks' => function (Brand $brand) {
+                    return $this->hreflangLinksFacade->getForBrand($brand, $this->domain->getId());
+                },
             ],
         ];
     }

diff --git a/src/Model/Resolver/Category/CategoryResolverMap.php b/src/Model/Resolver/Category/CategoryResolverMap.php
@@ -7,14 +7,18 @@
 use Overblog\GraphQLBundle\Resolver\ResolverMap;
 use Shopsys\FrameworkBundle\Component\Domain\Domain;
 use Shopsys\FrameworkBundle\Model\Category\Category;
+use Shopsys\FrameworkBundle\Model\Seo\HreflangLinksFacade;
 
 class CategoryResolverMap extends ResolverMap
 {
     /**
      * @param \Shopsys\FrameworkBundle\Component\Domain\Domain $domain
+     * @param \Shopsys\FrameworkBundle\Model\Seo\HreflangLinksFacade $hreflangLinksFacade
      */
-    public function __construct(protected readonly Domain $domain)
-    {
+    public function __construct(
+        protected readonly Domain $domain,
+        protected readonly HreflangLinksFacade $hreflangLinksFacade,
+    ) {
     }
 
     /**
@@ -33,6 +37,9 @@ protected function map(): array
                 'seoMetaDescription' => function (Category $category) {
                     return $category->getSeoMetaDescription($this->domain->getId());
                 },
+                'hreflangLinks' => function (Category $category) {
+                    return $this->hreflangLinksFacade->getForCategory($category, $this->domain->getId());
+                },
             ],
         ];
     }

diff --git a/src/Model/Resolver/Image/SeoPageImagesQuery.php b/src/Model/Resolver/Image/SeoPageImagesQuery.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Model\Resolver\Image;
+
+use GraphQL\Executor\Promise\Promise;
+use Shopsys\FrameworkBundle\Model\Seo\Page\SeoPage;
+use Shopsys\FrameworkBundle\Model\Seo\Page\SeoPageFacade;
+
+class SeoPageImagesQuery extends ImagesQuery
+{
+    /**
+     * @param \Shopsys\FrameworkBundle\Model\Seo\Page\SeoPage $seoPage
+     * @return \GraphQL\Executor\Promise\Promise
+     */
+    public function ogImageBySeoPageQuery(SeoPage $seoPage): Promise
+    {
+        return $this->mainImageByEntityPromiseQuery(
+            $seoPage,
+            SeoPageFacade::IMAGE_TYPE_OG,
+        );
+    }
+}
diff --git a/src/Model/Resolver/Products/DataMapper/ProductArrayFieldMapper.php b/src/Model/Resolver/Products/DataMapper/ProductArrayFieldMapper.php
@@ -206,4 +206,13 @@ public function getMainVariant(array $data): array
     {
         return $this->productElasticsearchProvider->getVisibleProductArrayById($data['main_variant_id']);
     }
+
+    /**
+     * @param array $data
+     * @return array
+     */
+    public function getHreflangLinks(array $data): array
+    {
+        return $data['hreflang_links'];
+    }
 }
diff --git a/src/Model/Resolver/Products/DataMapper/ProductEntityFieldMapper.php b/src/Model/Resolver/Products/DataMapper/ProductEntityFieldMapper.php
@@ -9,6 +9,7 @@
 use Shopsys\FrameworkBundle\Model\Product\Availability\ProductAvailabilityFacade;
 use Shopsys\FrameworkBundle\Model\Product\Collection\ProductCollectionFacade;
 use Shopsys\FrameworkBundle\Model\Product\Product;
+use Shopsys\FrameworkBundle\Model\Seo\HreflangLinksFacade;
 use Shopsys\FrontendApiBundle\Model\Parameter\ParameterWithValuesFactory;
 use Shopsys\FrontendApiBundle\Model\Product\ProductAccessoryFacade;
 
@@ -21,6 +22,7 @@ class ProductEntityFieldMapper
      * @param \Shopsys\FrameworkBundle\Model\Customer\User\CurrentCustomerUser $currentCustomerUser
      * @param \Shopsys\FrontendApiBundle\Model\Parameter\ParameterWithValuesFactory $parameterWithValuesFactory
      * @param \Shopsys\FrameworkBundle\Model\Product\Availability\ProductAvailabilityFacade $productAvailabilityFacade
+     * @param \Shopsys\FrameworkBundle\Model\Seo\HreflangLinksFacade $hreflangLinksFacade
      */
     public function __construct(
         protected readonly Domain $domain,
@@ -29,6 +31,7 @@ public function __construct(
         protected readonly CurrentCustomerUser $currentCustomerUser,
         protected readonly ParameterWithValuesFactory $parameterWithValuesFactory,
         protected readonly ProductAvailabilityFacade $productAvailabilityFacade,
+        protected readonly HreflangLinksFacade $hreflangLinksFacade,
     ) {
     }
 
@@ -157,4 +160,13 @@ public function getOrderingPriority(Product $product): int
     {
         return $product->getOrderingPriority($this->domain->getId());
     }
+
+    /**
+     * @param \Shopsys\FrameworkBundle\Model\Product\Product $product
+     * @return \Shopsys\FrameworkBundle\Model\Seo\HreflangLink[]
+     */
+    public function getHreflangLinks(Product $product): array
+    {
+        return $this->hreflangLinksFacade->getForProduct($product, $this->domain->getId());
+    }
 }
diff --git a/src/Model/Resolver/SeoPage/Exception/SeoPageNotFoundUserError.php b/src/Model/Resolver/SeoPage/Exception/SeoPageNotFoundUserError.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Model\Resolver\SeoPage\Exception;
+
+use Shopsys\FrontendApiBundle\Model\Error\EntityNotFoundUserError;
+use Shopsys\FrontendApiBundle\Model\Error\UserErrorWithCodeInterface;
+
+class SeoPageNotFoundUserError extends EntityNotFoundUserError implements UserErrorWithCodeInterface
+{
+    protected const CODE = 'seo-page-not-found';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getUserErrorCode(): string
+    {
+        return static::CODE;
+    }
+}
diff --git a/src/Model/Resolver/SeoPage/SeoPageQuery.php b/src/Model/Resolver/SeoPage/SeoPageQuery.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Model\Resolver\SeoPage;
+
+use Shopsys\FrameworkBundle\Component\Domain\Domain;
+use Shopsys\FrameworkBundle\Model\Seo\Page\Exception\SeoPageNotFoundException;
+use Shopsys\FrameworkBundle\Model\Seo\Page\SeoPage;
+use Shopsys\FrameworkBundle\Model\Seo\Page\SeoPageFacade;
+use Shopsys\FrameworkBundle\Model\Seo\Page\SeoPageSlugTransformer;
+use Shopsys\FrontendApiBundle\Model\Resolver\AbstractQuery;
+use Shopsys\FrontendApiBundle\Model\Resolver\SeoPage\Exception\SeoPageNotFoundUserError;
+
+class SeoPageQuery extends AbstractQuery
+{
+    /**
+     * @param \Shopsys\FrameworkBundle\Model\Seo\Page\SeoPageFacade $seoPageFacade
+     * @param \Shopsys\FrameworkBundle\Component\Domain\Domain $domain
+     */
+    public function __construct(
+        protected readonly SeoPageFacade $seoPageFacade,
+        protected readonly Domain $domain,
+    ) {
+    }
+
+    /**
+     * @param string $pageSlug
+     * @return \Shopsys\FrameworkBundle\Model\Seo\Page\SeoPage
+     */
+    public function seoPageByPageSlugQuery(string $pageSlug): SeoPage
+    {
+        $domainId = $this->domain->getId();
+
+        try {
+            $slug = SeoPageSlugTransformer::transformFriendlyUrlToSeoPageSlug($pageSlug);
+            $seoPage = $this->seoPageFacade->getByDomainIdAndPageSlug($domainId, $slug);
+        } catch (SeoPageNotFoundException $seoPageNotFoundException) {
+            throw new SeoPageNotFoundUserError($seoPageNotFoundException->getMessage());
+        }
+
+        return $seoPage;
+    }
+}
diff --git a/src/Model/Resolver/SeoPage/SeoPageResolverMap.php b/src/Model/Resolver/SeoPage/SeoPageResolverMap.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Model\Resolver\SeoPage;
+
+use Overblog\GraphQLBundle\Resolver\ResolverMap;
+use Shopsys\FrameworkBundle\Component\Domain\Domain;
+use Shopsys\FrameworkBundle\Model\Seo\HreflangLinksFacade;
+use Shopsys\FrameworkBundle\Model\Seo\Page\SeoPage;
+
+class SeoPageResolverMap extends ResolverMap
+{
+    /**
+     * @param \Shopsys\FrameworkBundle\Component\Domain\Domain $domain
+     * @param \Shopsys\FrameworkBundle\Model\Seo\HreflangLinksFacade $hreflangLinksFacade
+     */
+    public function __construct(
+        protected readonly Domain $domain,
+        protected readonly HreflangLinksFacade $hreflangLinksFacade,
+    ) {
+    }
+
+    /**
+     * @return array
+     */
+    protected function map(): array
+    {
+        return [
+            'SeoPage' => [
+                'title' => fn (SeoPage $seoPage) => $seoPage->getSeoTitle($this->domain->getId()),
+                'metaDescription' => fn (SeoPage $seoPage) => $seoPage->getSeoMetaDescription($this->domain->getId()),
+                'canonicalUrl' => fn (SeoPage $seoPage) => $seoPage->getCanonicalUrl($this->domain->getId()),
+                'ogTitle' => fn (SeoPage $seoPage) => $seoPage->getSeoOgTitle($this->domain->getId()),
+                'ogDescription' => fn (SeoPage $seoPage) => $seoPage->getSeoOgDescription($this->domain->getId()),
+                'hreflangLinks' => fn (SeoPage $seoPage) => $this->hreflangLinksFacade->getForSeoPage($seoPage, $this->domain->getId()),
+            ],
+        ];
+    }
+}
diff --git a/src/Resources/config/graphql-types/BlogArticleDecorator.types.yaml b/src/Resources/config/graphql-types/BlogArticleDecorator.types.yaml
@@ -6,6 +6,7 @@ BlogArticleDecorator:
             - 'Breadcrumb'
             - 'Slug'
             - 'ArticleInterface'
+            - 'Hreflang'
         fields:
             id:
                 type: "Int!"
@@ -68,3 +69,6 @@ BlogArticleDecorator:
                     type:
                         type: "String"
                         defaultValue: null
+            hreflangLinks:
+                type: "[HreflangLink!]!"
+                description: "Alternate links for hreflang meta tags"
diff --git a/src/Resources/config/graphql-types/BlogCategoryDecorator.types.yaml b/src/Resources/config/graphql-types/BlogCategoryDecorator.types.yaml
@@ -5,6 +5,7 @@ BlogCategoryDecorator:
         interfaces:
             - 'Breadcrumb'
             - 'Slug'
+            - 'Hreflang'
         fields:
             uuid:
                 type: "Uuid!"
@@ -51,3 +52,6 @@ BlogCategoryDecorator:
             articlesTotalCount:
                 type: "Int!"
                 description: "Total count of blog articles in this category"
+            hreflangLinks:
+                type: "[HreflangLink!]!"
+                description: "Alternate links for hreflang meta tags"
diff --git a/src/Resources/config/graphql-types/BrandDecorator.types.yaml b/src/Resources/config/graphql-types/BrandDecorator.types.yaml
@@ -2,6 +2,8 @@ BrandDecorator:
     type: object
     decorator: true
     config:
+        interfaces:
+            - 'Hreflang'
         description: "Represents a brand"
         fields:
             uuid:
@@ -41,3 +43,6 @@ BrandDecorator:
                     config:
                         orderingModeType: 'ProductOrderingModeEnum'
                 resolve: '@=query("productsByBrandQuery", args, value)'
+            hreflangLinks:
+                type: "[HreflangLink!]!"
+                description: "Alternate links for hreflang meta tags"
diff --git a/src/Resources/config/graphql-types/CategoryDecorator.types.yaml b/src/Resources/config/graphql-types/CategoryDecorator.types.yaml
@@ -44,3 +44,6 @@ CategoryDecorator:
             categoryHierarchy:
                 type: "[CategoryHierarchyItem!]!"
                 description: "All parent category names with their IDs and UUIDs"
+            hreflangLinks:
+                type: "[HreflangLink!]!"
+                description: "Alternate links for hreflang meta tags"
diff --git a/src/Resources/config/graphql-types/Hreflang/HreflangDecorator.types.yaml b/src/Resources/config/graphql-types/Hreflang/HreflangDecorator.types.yaml
@@ -0,0 +1,9 @@
+HreflangDecorator:
+    type: interface
+    decorator: true
+    config:
+        description: "Represents entity able to return alternate links for hreflang meta tags"
+        fields:
+            hreflangLinks:
+                type: "[HreflangLink!]!"
+                description: "Alternate links for hreflang meta tags"
diff --git a/src/Resources/config/graphql-types/Hreflang/HreflangLinkDecorator.types.yaml b/src/Resources/config/graphql-types/Hreflang/HreflangLinkDecorator.types.yaml
@@ -0,0 +1,11 @@
+HreflangLinkDecorator:
+    type: object
+    decorator: true
+    config:
+        fields:
+            hreflang:
+                type: "String!"
+                description: "Language code for hreflang meta tag"
+            href:
+                type: "String!"
+                description: "URL for hreflang meta tag"
diff --git a/src/Resources/config/graphql-types/MainVariantDecorator.types.yaml b/src/Resources/config/graphql-types/MainVariantDecorator.types.yaml
@@ -9,3 +9,4 @@ MainVariantDecorator:
                 type: '[Variant!]!'
         interfaces:
             - 'Product'
+            - 'Hreflang'
diff --git a/src/Resources/config/graphql-types/ProductDecorator.types.yaml b/src/Resources/config/graphql-types/ProductDecorator.types.yaml
@@ -68,3 +68,6 @@ ProductDecorator:
             seoMetaDescription:
                 type: "String"
                 description: "Seo meta description of product"
+            hreflangLinks:
+                type: "[HreflangLink!]!"
+                description: "Alternate links for hreflang meta tags"
diff --git a/src/Resources/config/graphql-types/RegularProductDecorator.types.yaml b/src/Resources/config/graphql-types/RegularProductDecorator.types.yaml
@@ -6,3 +6,4 @@ RegularProductDecorator:
     config:
         interfaces:
             - 'Product'
+            - 'Hreflang'