ENGCOM-1283: #13296: Category name with special characters brakes … #13397

 - Merge Pull Request #13397 from vinayshah/magento2:2.2-develop_13296
 - Merged commits:
   1. 20396d5
   2. a22b6fd
   3. ff4f6cf
   4. 934a0a3
   5. 1bd6356
   6. 4bdba36
   7. e764e68
   8. ac21097
   9. b9821e9
   10. 6fec232
   11. c33d27f
   12. fc510c4
   13. f300c39
   14. b747343
   15. 851cc3a
   16. af0f2e9
   17. 05dfa6e

Author: magento-engcom-team

app/code/Magento/Catalog/view/adminhtml/web/js/category-tree.js

@@ -5,9 +5,10 @@
 
 define([
     'jquery',
+    'mageUtils',
     'jquery/ui',
     'jquery/jstree/jquery.jstree'
-], function ($) {
+], function ($, utils) {
     'use strict';
 
     $.widget('mage.categoryTree', {
@@ -88,9 +89,10 @@ define([
             if (!node) {
                 return result;
             }
+
             result = {
                 data: {
-                    title: node.name + ' (' + node['product_count'] + ')'
+                    title: utils.unescape(node.name) + ' (' + node['product_count'] + ')'
                 },
                 attr: {
                     'class': node.cls + (!!node.disabled ? ' disabled' : '') //eslint-disable-line no-extra-boolean-cast

app/code/Magento/UrlRewrite/Block/Catalog/Category/Tree.php

@@ -3,18 +3,26 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\UrlRewrite\Block\Catalog\Category;
 
+use Magento\Backend\Block\Widget\Context;
+use Magento\Backend\Helper\Data;
 use Magento\Catalog\Api\CategoryRepositoryInterface;
+use Magento\Catalog\Block\Adminhtml\Category\AbstractCategory;
 use Magento\Catalog\Model\Category;
+use Magento\Catalog\Model\CategoryFactory;
+use Magento\Catalog\Model\ProductFactory;
 use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\Json\EncoderInterface;
+use Magento\Framework\Registry;
 
 /**
  * Categories tree block for URL rewrites editing process
  *
  * @author     Magento Core Team <core@magentocommerce.com>
  */
-class Tree extends \Magento\Catalog\Block\Adminhtml\Category\AbstractCategory
+class Tree extends AbstractCategory
 {
     /**
      * List of allowed category ids
@@ -31,22 +39,22 @@ class Tree extends \Magento\Catalog\Block\Adminhtml\Category\AbstractCategory
     /**
      * Adminhtml data
      *
-     * @var \Magento\Backend\Helper\Data
+     * @var Data
      */
     protected $_adminhtmlData = null;
 
     /**
-     * @var \Magento\Catalog\Model\CategoryFactory
+     * @var CategoryFactory
      */
     protected $_categoryFactory;
 
     /**
-     * @var \Magento\Catalog\Model\ProductFactory
+     * @var ProductFactory
      */
     protected $_productFactory;
 
     /**
-     * @var \Magento\Framework\Json\EncoderInterface
+     * @var EncoderInterface
      */
     protected $_jsonEncoder;
 
@@ -56,24 +64,24 @@ class Tree extends \Magento\Catalog\Block\Adminhtml\Category\AbstractCategory
     protected $categoryRepository;
 
     /**
-     * @param \Magento\Backend\Block\Widget\Context $context
+     * @param Context $context
      * @param \Magento\Catalog\Model\ResourceModel\Category\Tree $categoryTree
-     * @param \Magento\Framework\Registry $registry
-     * @param \Magento\Framework\Json\EncoderInterface $jsonEncoder
-     * @param \Magento\Catalog\Model\ProductFactory $productFactory
-     * @param \Magento\Catalog\Model\CategoryFactory $categoryFactory
-     * @param \Magento\Backend\Helper\Data $adminhtmlData
+     * @param Registry $registry
+     * @param EncoderInterface $jsonEncoder
+     * @param ProductFactory $productFactory
+     * @param CategoryFactory $categoryFactory
+     * @param Data $adminhtmlData
      * @param CategoryRepositoryInterface $categoryRepository
      * @param array $data
      */
     public function __construct(
-        \Magento\Backend\Block\Widget\Context $context,
+        Context $context,
         \Magento\Catalog\Model\ResourceModel\Category\Tree $categoryTree,
-        \Magento\Framework\Registry $registry,
-        \Magento\Catalog\Model\CategoryFactory $categoryFactory,
-        \Magento\Framework\Json\EncoderInterface $jsonEncoder,
-        \Magento\Catalog\Model\ProductFactory $productFactory,
-        \Magento\Backend\Helper\Data $adminhtmlData,
+        Registry $registry,
+        CategoryFactory $categoryFactory,
+        EncoderInterface $jsonEncoder,
+        ProductFactory $productFactory,
+        Data $adminhtmlData,
         CategoryRepositoryInterface $categoryRepository,
         array $data = []
     ) {

app/code/Magento/UrlRewrite/view/adminhtml/templates/categories.phtml

@@ -8,19 +8,26 @@
 
 /** @var \Magento\UrlRewrite\Block\Catalog\Category\Tree $block */
 ?>
-<fieldset class="admin__fieldset" data-ui-id="category-selector">
-    <legend class="admin__legend"><span><?= $block->escapeHtml(__('Select Category')) ?></span></legend>
-    <div class="content content-category-tree">
-        <input type="hidden" name="categories" id="product_categories" value="" />
-        <?php if ($block->getRoot()): ?>
-        <div data-mage-init='<?php /* @noEscape */ echo $this->helper('Magento\Framework\Json\Helper\Data')->jsonEncode(
-            [
-                'categoryTree' => [
-                    'data' => $block->getTreeArray(),
-                    'url' => $block->escapeUrl($block->getLoadTreeUrl()),
-                ],
-            ]
-        ); ?>' class="jstree-default"></div>
-        <?php endif; ?>
-    </div>
-</fieldset>
+    <fieldset class="admin__fieldset" data-ui-id="category-selector">
+        <legend class="admin__legend"><span><?= $block->escapeHtml(__('Select Category')) ?></span></legend>
+        <div class="content content-category-tree">
+            <input type="hidden" name="categories" id="product_categories" value=""/>
+            <?php if ($block->getRoot()): ?>
+                <div class="jstree-default"></div>
+            <?php endif; ?>
+        </div>
+    </fieldset>
+<?php if ($block->getRoot()): ?>
+    <script type="text/x-magento-init">
+    {
+        ".jstree-default": {
+            "categoryTree": {
+                "data": <?php /* @noEscape */
+        echo $this->helper('Magento\Framework\Json\Helper\Data')->jsonEncode($block->getTreeArray()); ?>,
+                "url": "<?php /* @noEscape */
+        echo $block->escapeUrl($block->getLoadTreeUrl()); ?>"
+            }
+        }
+    }
+    </script>
+<?php endif; ?>

dev/tests/integration/testsuite/Magento/Catalog/_files/catalog_category_with_doublequotes.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+/** @var $category \Magento\Catalog\Model\Category */
+$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
+
+$categoryFirst = $objectManager->create(\Magento\Catalog\Model\Category::class);
+$categoryFirst->setName('Category 1')
+    ->setPath('1/2')
+    ->setLevel(2)
+    ->setAvailableSortBy('name')
+    ->setDefaultSortBy('name')
+    ->setIsActive(true)
+    ->setPosition(1)
+    ->save();
+
+// products from this fixture were moved to indexer_catalog_products.php
+$categorySecond = $objectManager->create(\Magento\Catalog\Model\Category::class);
+$categorySecond->setName('"Category 6"')
+    ->setPath($categoryFirst->getPath())
+    ->setLevel(3)
+    ->setAvailableSortBy('name')
+    ->setDefaultSortBy('name')
+    ->setIsActive(true)
+    ->setPosition(1)
+    ->save();

dev/tests/integration/testsuite/Magento/UrlRewrite/Block/Catalog/Category/TreeTest.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\UrlRewrite\Block\Catalog\Category;
 
 /**
@@ -56,7 +57,27 @@ public function testGetTreeArrayApostropheReplaced()
         $tree = $this->_treeBlock->getTreeArray();
 
         $this->assertNotContains('\'', $tree['children'][0]['children'][0]['children'][0]['name']);
-        $this->assertEquals(''Category 6'', $tree['children'][0]['children'][0]['children'][0]['name']);
+        $this->assertEquals(
+            ''Category 6'',
+            $tree['children'][0]['children'][0]['children'][0]['name']
+        );
+    }
+
+    /**
+     * Test that the getTreeArray() method scrubs single quotes and apostrophes from names
+     *
+     * @magentoAppIsolation enabled
+     * @magentoDataFixture Magento/Catalog/_files/catalog_category_with_doublequotes.php
+     */
+    public function testGetTreeArrayDoubleQuotesReplaced()
+    {
+        $tree = $this->_treeBlock->getTreeArray();
+
+        $this->assertNotContains('\"', $tree['children'][0]['children'][0]['children'][0]['name']);
+        $this->assertEquals(
+            '"Category 6"',
+            $tree['children'][0]['children'][0]['children'][0]['name']
+        );
     }
 
     /**

lib/web/mage/utils/misc.js

@@ -242,6 +242,26 @@ define([
             return data;
         },
 
+        /**
+         * Replaces symbol codes with their unescaped counterparts.
+         *
+         * @param {String} data
+         *
+         * @returns {String}
+         */
+        unescape: function (data) {
+            var unescaped = _.unescape(data),
+                mapCharacter = {
+                    ''': '\''
+                };
+
+            _.each(mapCharacter, function (value, key) {
+                unescaped = unescaped.replace(key, value);
+            });
+
+            return unescaped;
+        },
+
         /**
          * Converts PHP IntlFormatter format to moment format.
          *