MAGETWO-70775: Remove zend json from customer data #10259

 - moved component configuration to the template file

Author: Oleksii Korshenko

app/code/Magento/Customer/Block/CustomerScopeData.php

@@ -5,6 +5,9 @@
  */
 namespace Magento\Customer\Block;
 
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Serialize\Serializer\Json;
+
 /**
  * Class CustomerScopeData provide scope (website, store or store_group) information on front
  * Can be used, for example, on store front, in order to determine
@@ -20,28 +23,27 @@ class CustomerScopeData extends \Magento\Framework\View\Element\Template
     private $storeManager;
 
     /**
-     * @var \Magento\Framework\Serialize\Serializer\Json
+     * @var Json
      */
     private $serializer;
 
     /**
      * @param \Magento\Framework\View\Element\Template\Context $context
      * @param \Magento\Framework\Json\EncoderInterface $jsonEncoder
      * @param array $data
-     * @param \Magento\Framework\Serialize\Serializer\Json|null $serializer
+     * @param Json|null $serializer
      * @throws \RuntimeException
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function __construct(
         \Magento\Framework\View\Element\Template\Context $context,
         \Magento\Framework\Json\EncoderInterface $jsonEncoder,
         array $data = [],
-        \Magento\Framework\Serialize\Serializer\Json $serializer = null
+        Json $serializer = null
     ) {
         parent::__construct($context, $data);
         $this->storeManager = $context->getStoreManager();
-        $this->serializer = $serializer?: \Magento\Framework\App\ObjectManager::getInstance()
-            ->get(\Magento\Framework\Serialize\Serializer\Json::class);
+        $this->serializer = $serializer?: ObjectManager::getInstance()->get(Json::class);
     }
 
     /**
@@ -57,35 +59,14 @@ public function getWebsiteId()
     }
 
     /**
-     * @return array
-     */
-    public function getInvalidationRules()
-    {
-        return [
-            '*' => [
-                'Magento_Customer/js/invalidation-processor' => [
-                    'invalidationRules' => [
-                        'website-rule' => [
-                            'Magento_Customer/js/invalidation-rules/website-rule' => [
-                                'scopeConfig' => [
-                                    'websiteId' => $this->getWebsiteId(),
-                                ]
-                            ]
-                        ]
-                    ]
-                ]
-            ],
-        ];
-    }
-
-    /**
-     * Get the invalidation rules json encoded
+     * Encode invalidation rules.
      *
+     * @param array $configuration
      * @return bool|string
      * @throws \InvalidArgumentException
      */
-    public function getSerializedInvalidationRules()
+    public function encodeConfiguration(array $configuration)
     {
-        return $this->serializer->serialize($this->getInvalidationRules());
+        return $this->serializer->serialize($configuration);
     }
 }

app/code/Magento/Customer/Test/Unit/Block/CustomerScopeDataTest.php

@@ -85,46 +85,8 @@ public function testGetWebsiteId()
         $this->assertEquals($storeId, $this->model->getWebsiteId());
     }
 
-    public function testGetInvalidationRules()
+    public function testEncodeConfiguration()
     {
-        $storeId = 1;
-
-        $storeMock = $this->getMockBuilder(StoreInterface::class)
-            ->setMethods(['getWebsiteId'])
-            ->getMockForAbstractClass();
-
-        $storeMock->expects($this->any())
-            ->method('getWebsiteId')
-            ->willReturn($storeId);
-
-        $this->storeManagerMock->expects($this->any())
-            ->method('getStore')
-            ->with(null)
-            ->willReturn($storeMock);
-
-        $this->assertEquals(
-            [
-                '*' => [
-                    'Magento_Customer/js/invalidation-processor' => [
-                        'invalidationRules' => [
-                            'website-rule' => [
-                                'Magento_Customer/js/invalidation-rules/website-rule' => [
-                                    'scopeConfig' => [
-                                        'websiteId' => 1,
-                                    ]
-                                ]
-                            ]
-                        ]
-                    ]
-                ],
-            ],
-            $this->model->getInvalidationRules()
-        );
-    }
-
-    public function testGetSerializedInvalidationRules()
-    {
-        $storeId = 1;
         $rules = [
             '*' => [
                 'Magento_Customer/js/invalidation-processor' => [
@@ -141,27 +103,14 @@ public function testGetSerializedInvalidationRules()
             ],
         ];
 
-        $storeMock = $this->getMockBuilder(StoreInterface::class)
-            ->setMethods(['getWebsiteId'])
-            ->getMockForAbstractClass();
-
-        $storeMock->expects($this->any())
-            ->method('getWebsiteId')
-            ->willReturn($storeId);
-
-        $this->storeManagerMock->expects($this->any())
-            ->method('getStore')
-            ->with(null)
-            ->willReturn($storeMock);
-
         $this->serializerMock->expects($this->any())
             ->method('serialize')
             ->with($rules)
             ->willReturn(json_encode($rules));
 
         $this->assertEquals(
             json_encode($rules),
-            $this->model->getSerializedInvalidationRules()
+            $this->model->encodeConfiguration($rules)
         );
     }
 }

app/code/Magento/Customer/view/frontend/templates/js/customer-data/invalidation-rules.phtml

@@ -5,13 +5,21 @@
  */
 
 // @codingStandardsIgnoreFile
-?>
-<?php
 /* @var $block \Magento\Customer\Block\CustomerScopeData */
 ?>
 <script type="text/x-magento-init">
-<?php
-    /* @noEscape */
-    echo $block->getSerializedInvalidationRules();
+<?= /* @noEscape */ $block->encodeConfiguration([
+        '*' => ['Magento_Customer/js/invalidation-processor' => [
+            'invalidationRules' => [
+                'website-rule' => [
+                    'Magento_Customer/js/invalidation-rules/website-rule' => [
+                        'scopeConfig' => [
+                            'websiteId' => $block->getWebsiteId(),
+                        ]
+                    ]
+                ]
+            ]
+        ]],
+    ]);
 ?>
 </script>