ENGCOM-2990: Added HTML renderer for description and short description #140

Author: Valeriy Naida

app/code/Magento/CatalogGraphQl/Model/Resolver/Product/ProductHtmlAttribute.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogGraphQl\Model\Resolver\Product;
+
+use Magento\Catalog\Model\Product;
+use Magento\Framework\GraphQl\Config\Element\Field;
+use Magento\Framework\GraphQl\Exception\GraphQlInputException;
+use Magento\Framework\GraphQl\Query\ResolverInterface;
+use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
+use Magento\Catalog\Helper\Output as OutputHelper;
+
+/**
+ * Resolve rendered content for attributes where HTML content is allowed
+ */
+class ProductHtmlAttribute implements ResolverInterface
+{
+    /**
+     * @var OutputHelper
+     */
+    private $outputHelper;
+
+    /**
+     * @param OutputHelper $outputHelper
+     */
+    public function __construct(
+        OutputHelper $outputHelper
+    ) {
+        $this->outputHelper = $outputHelper;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function resolve(
+        Field $field,
+        $context,
+        ResolveInfo $info,
+        array $value = null,
+        array $args = null
+    ) {
+        if (!isset($value['model'])) {
+            throw new GraphQlInputException(__('"model" value should be specified'));
+        }
+
+        /* @var $product Product */
+        $product = $value['model'];
+        $fieldName = $field->getName();
+        $renderedValue = $this->outputHelper->productAttribute($product, $product->getData($fieldName), $fieldName);
+        return $renderedValue;
+    }
+}

app/code/Magento/CatalogGraphQl/etc/schema.graphqls

@@ -248,8 +248,8 @@ interface ProductInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\
     id: Int @doc(description: "The ID number assigned to the product") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\EntityIdToId")
     name: String @doc(description: "The product name. Customers use this name to identify the product.")
     sku: String @doc(description: "A number or code assigned to a product to identify the product, options, price, and manufacturer")
-    description: String @doc(description: "Detailed information about the product. The value can include simple HTML tags.")
-    short_description: String @doc(description: "A short description of the product. Its use depends on the theme.")
+    description: String @doc(description: "Detailed information about the product. The value can include simple HTML tags.") @resolver(class: "\\Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\ProductHtmlAttribute")
+    short_description: String @doc(description: "A short description of the product. Its use depends on the theme.") @resolver(class: "\\Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\ProductHtmlAttribute")
     special_price: Float @doc(description: "The discounted price of the product")
     special_from_date: String @doc(description: "The beginning date that a product has a special price")
     special_to_date: String @doc(description: "The end date that a product has a special price")
@@ -548,6 +548,6 @@ type SortField {
 }
 
 type SortFields @doc(description: "SortFields contains a default value for sort fields and all available sort fields") {
-    default: String @doc(description: "Default value of sort fields") 
+    default: String @doc(description: "Default value of sort fields")
     options: [SortField] @doc(description: "Available sort fields")
 }

dev/tests/api-functional/testsuite/Magento/GraphQl/Catalog/ProductWithDescriptionDirectivesTest.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQl\Catalog;
+
+use Magento\Catalog\Api\Data\ProductInterface;
+use Magento\Catalog\Api\ProductRepositoryInterface;
+use Magento\TestFramework\ObjectManager;
+use Magento\TestFramework\TestCase\GraphQlAbstract;
+
+/**
+ * Test for checking that product fields with directives allowed are rendered correctly
+ */
+class ProductWithDescriptionDirectivesTest extends GraphQlAbstract
+{
+    /**
+     * @var \Magento\TestFramework\ObjectManager
+     */
+    private $objectManager;
+
+    protected function setUp()
+    {
+        $this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
+    }
+
+    /**
+     * @magentoApiDataFixture Magento/Catalog/_files/product_simple.php
+     * @magentoApiDataFixture Magento/Cms/_files/block.php
+     */
+    public function testHtmlDirectivesRendered()
+    {
+        $productSku = 'simple';
+        $cmsBlockId = 'fixture_block';
+        $assertionCmsBlockText = 'Fixture Block Title';
+
+        /** @var ProductRepositoryInterface $productRepository */
+        $productRepository = ObjectManager::getInstance()->get(ProductRepositoryInterface::class);
+        /** @var ProductInterface $product */
+        $product = $productRepository->get($productSku, false, null, true);
+        $product->setDescription('Test: {{block id="' . $cmsBlockId . '"}}');
+        $product->setShortDescription('Test: {{block id="' . $cmsBlockId . '"}}');
+        $productRepository->save($product);
+
+        $query = <<<QUERY
+{
+    products(filter: {sku: {eq: "{$productSku}"}}) {
+        items {
+            description
+            short_description        
+        }
+    }
+}
+QUERY;
+        $response = $this->graphQlQuery($query);
+
+        self::assertContains($assertionCmsBlockText, $response['products']['items'][0]['description']);
+        self::assertNotContains('{{block id', $response['products']['items'][0]['description']);
+        self::assertContains($assertionCmsBlockText, $response['products']['items'][0]['short_description']);
+        self::assertNotContains('{{block id', $response['products']['items'][0]['short_description']);
+    }
+}