MAGETWO-66686: Use Json serializer class instead of direct call

rganin · rganin · commit 5842fea256ee · 2017-03-24T10:44:11.000+02:00
diff --git a/lib/internal/Magento/Framework/App/Http/Context.php b/lib/internal/Magento/Framework/App/Http/Context.php
@@ -4,6 +4,8 @@
  * See COPYING.txt for license details.
  */
 namespace Magento\Framework\App\Http;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Serialize\Serializer\Json;
 
 /**
  * Context data for requests
@@ -27,14 +29,21 @@ class Context
      */
     protected $default = [];
 
+    /**
+     * @var Json
+     */
+    private $serializer;
+
     /**
      * @param array $data
      * @param array $default
+     * @param Json|null $serializer
      */
-    public function __construct(array $data = [], array $default = [])
+    public function __construct(array $data = [], array $default = [], Json $serializer = null)
     {
         $this->data = $data;
         $this->default = $default;
+        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
     }
 
     /**
@@ -105,7 +114,7 @@ public function getVaryString()
         $data = $this->getData();
         if (!empty($data)) {
             ksort($data);
-            return sha1(json_encode($data));
+            return sha1($this->serializer->serialize($data));
         }
         return null;
     }
diff --git a/lib/internal/Magento/Framework/App/PageCache/Identifier.php b/lib/internal/Magento/Framework/App/PageCache/Identifier.php
@@ -4,6 +4,8 @@
  * See COPYING.txt for license details.
  */
 namespace Magento\Framework\App\PageCache;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Serialize\Serializer\Json;
 
 /**
  * Page unique identifier
@@ -20,16 +22,24 @@ class Identifier
      */
     protected $context;
 
+    /**
+     * @var Json
+     */
+    private $serializer;
+
     /**
      * @param \Magento\Framework\App\Request\Http $request
      * @param \Magento\Framework\App\Http\Context $context
+     * @param Json|null $serializer
      */
     public function __construct(
         \Magento\Framework\App\Request\Http $request,
-        \Magento\Framework\App\Http\Context $context
+        \Magento\Framework\App\Http\Context $context,
+        Json $serializer = null
     ) {
         $this->request = $request;
         $this->context = $context;
+        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
     }
 
     /**
@@ -45,6 +55,6 @@ public function getValue()
             $this->request->get(\Magento\Framework\App\Response\Http::COOKIE_VARY_STRING)
                 ?: $this->context->getVaryString()
         ];
-        return sha1(json_encode($data));
+        return sha1($this->serializer->serialize($data));
     }
 }
diff --git a/lib/internal/Magento/Framework/App/Test/Unit/Http/ContextTest.php b/lib/internal/Magento/Framework/App/Test/Unit/Http/ContextTest.php
@@ -7,6 +7,7 @@
 namespace Magento\Framework\App\Test\Unit\Http;
 
 use \Magento\Framework\App\Http\Context;
+use Magento\Framework\Serialize\Serializer\Json;
 
 class ContextTest extends \PHPUnit_Framework_TestCase
 {
@@ -20,10 +21,33 @@ class ContextTest extends \PHPUnit_Framework_TestCase
      */
     protected $object;
 
+    /**
+     * @var Json|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $serializerMock;
+
     protected function setUp()
     {
         $this->objectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
-        $this->object = $this->objectManager->getObject(\Magento\Framework\App\Http\Context::class);
+        $this->serializerMock = $this->getMockBuilder(Json::class)
+            ->setMethods(['serialize'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->serializerMock->expects($this->any())
+            ->method('serialize')
+            ->will(
+                $this->returnCallback(
+                    function ($value) {
+                        return json_encode($value);
+                    }
+                )
+            );
+        $this->object = $this->objectManager->getObject(
+            \Magento\Framework\App\Http\Context::class,
+            [
+                'serializer' => $this->serializerMock
+            ]
+        );
     }
 
     public function testGetValue()
@@ -67,7 +91,7 @@ public function testGetVaryString()
 
     public function testToArray()
     {
-        $newObject = new \Magento\Framework\App\Http\Context(['key' => 'value']);
+        $newObject = new \Magento\Framework\App\Http\Context(['key' => 'value'], [], $this->serializerMock);
 
         $newObject->setValue('key1', 'value1', 'default1');
         $newObject->setValue('key2', 'value2', 'default2');
diff --git a/lib/internal/Magento/Framework/App/Test/Unit/PageCache/IdentifierTest.php b/lib/internal/Magento/Framework/App/Test/Unit/PageCache/IdentifierTest.php
@@ -9,6 +9,7 @@
 use Magento\Framework\App\PageCache\Identifier;
 use Magento\Framework\App\Response\Http;
 use Magento\Framework\App\Request\Http as HttpRequest;
+use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 
 class IdentifierTest extends \PHPUnit_Framework_TestCase
@@ -38,6 +39,11 @@ class IdentifierTest extends \PHPUnit_Framework_TestCase
      */
     private $model;
 
+    /**
+     * @var Json|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $serializerMock;
+
     /**
      * @return \Magento\Framework\TestFramework\Unit\Helper\ObjectManager
      */
@@ -51,11 +57,27 @@ protected function setUp()
         $this->requestMock = $this->getMockBuilder(HttpRequest::class)
             ->disableOriginalConstructor()
             ->getMock();
+
+        $this->serializerMock = $this->getMockBuilder(Json::class)
+            ->setMethods(['serialize'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->serializerMock->expects($this->any())
+            ->method('serialize')
+            ->will(
+                $this->returnCallback(
+                    function ($value) {
+                        return json_encode($value);
+                    }
+                )
+            );
+
         $this->model = $this->objectManager->getObject(
             Identifier::class,
             [
-                'request' => $this->requestMock,
-                'context' => $this->contextMock,
+                'request'    => $this->requestMock,
+                'context'    => $this->contextMock,
+                'serializer' => $this->serializerMock,
             ]
         );
         return parent::setUp();
diff --git a/lib/internal/Magento/Framework/App/Test/Unit/Utility/FilesTest.php b/lib/internal/Magento/Framework/App/Test/Unit/Utility/FilesTest.php
@@ -7,6 +7,7 @@
 
 use Magento\Framework\App\Utility\Files;
 use Magento\Framework\Component\ComponentRegistrar;
+use Magento\Framework\Serialize\Serializer\Json;
 
 class FilesTest extends \PHPUnit_Framework_TestCase
 {
@@ -20,18 +21,45 @@ class FilesTest extends \PHPUnit_Framework_TestCase
      */
     private $componentRegistrar;
 
+    /**
+     * @var Json|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $serializerMock;
+
     protected function setUp()
     {
         $this->componentRegistrar = new ComponentRegistrar();
         $this->dirSearch = $this->getMock(\Magento\Framework\Component\DirSearch::class, [], [], '', false);
+
+        $this->serializerMock = $this->getMockBuilder(Json::class)
+            ->setMethods(['serialize'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->serializerMock->expects($this->any())
+            ->method('serialize')
+            ->will(
+                $this->returnCallback(
+                    function ($value) {
+                        return json_encode($value);
+                    }
+                )
+            );
+
         $themePackageList = $this->getMock(
             \Magento\Framework\View\Design\Theme\ThemePackageList::class,
             [],
             [],
             '',
             false
         );
-        Files::setInstance(new Files($this->componentRegistrar, $this->dirSearch, $themePackageList));
+        Files::setInstance(
+            new Files(
+                $this->componentRegistrar,
+                $this->dirSearch,
+                $themePackageList,
+                $this->serializerMock
+            )
+        );
     }
 
     protected function tearDown()
diff --git a/lib/internal/Magento/Framework/App/Utility/Files.php b/lib/internal/Magento/Framework/App/Utility/Files.php
@@ -6,8 +6,10 @@
 
 namespace Magento\Framework\App\Utility;
 
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Component\ComponentRegistrar;
 use Magento\Framework\Component\DirSearch;
+use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\View\Design\Theme\ThemePackageList;
 use Magento\Framework\Filesystem\Glob;
 
@@ -69,6 +71,11 @@ class Files
      */
     private $themePackageList;
 
+    /**
+     * @var Json
+     */
+    private $serializer;
+
     /**
      * Setter for an instance of self
      *
@@ -117,15 +124,18 @@ public static function composeDataSets(array $files)
      * @param ComponentRegistrar $componentRegistrar
      * @param DirSearch $dirSearch
      * @param ThemePackageList $themePackageList
+     * @param Json|null $serializer
      */
     public function __construct(
         ComponentRegistrar $componentRegistrar,
         DirSearch $dirSearch,
-        ThemePackageList $themePackageList
+        ThemePackageList $themePackageList,
+        Json $serializer = null
     ) {
         $this->componentRegistrar = $componentRegistrar;
         $this->dirSearch = $dirSearch;
         $this->themePackageList = $themePackageList;
+        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
     }
 
     /**
@@ -375,7 +385,7 @@ public function getConfigFiles(
         $excludedFileNames = ['wsdl.xml', 'wsdl2.xml', 'wsi.xml'],
         $asDataSet = true
     ) {
-        $cacheKey = __METHOD__ . '|' . json_encode([$fileNamePattern, $excludedFileNames, $asDataSet]);
+        $cacheKey = __METHOD__ . '|' . $this->serializer->serialize([$fileNamePattern, $excludedFileNames, $asDataSet]);
         if (!isset(self::$_cache[$cacheKey])) {
             $files = $this->dirSearch->collectFiles(ComponentRegistrar::MODULE, "/etc/{$fileNamePattern}");
             $files = array_filter(
@@ -407,7 +417,7 @@ public function getXmlCatalogFiles(
         $excludedFileNames = [],
         $asDataSet = true
     ) {
-        $cacheKey = __METHOD__ . '|' . json_encode([$fileNamePattern, $excludedFileNames, $asDataSet]);
+        $cacheKey = __METHOD__ . '|' . $this->serializer->serialize([$fileNamePattern, $excludedFileNames, $asDataSet]);
         if (!isset(self::$_cache[$cacheKey])) {
             $files = $this->getFilesSubset(
                 $this->componentRegistrar->getPaths(ComponentRegistrar::MODULE),
diff --git a/lib/internal/Magento/Framework/Test/Unit/UrlTest.php b/lib/internal/Magento/Framework/Test/Unit/UrlTest.php
@@ -290,6 +290,9 @@ public function testGetUrlIdempotentSetRoutePath()
             ->method('getScope')
             ->will($this->returnValue($this->scopeMock));
 
+        $this->urlModifier->expects($this->exactly(1))->method('execute');
+
+        $this->assertEquals('catalog/product/view', $model->getUrl('catalog/product/view'));
         $this->assertEquals('catalog/product/view', $model->getUrl('catalog/product/view'));
     }
 
diff --git a/lib/internal/Magento/Framework/Url.php b/lib/internal/Magento/Framework/Url.php
@@ -8,6 +8,8 @@
 
 namespace Magento\Framework;
 
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\Url\HostChecker;
 
 /**
@@ -185,6 +187,11 @@ class Url extends \Magento\Framework\DataObject implements \Magento\Framework\Ur
      */
     private $hostChecker;
 
+    /**
+     * @var Json
+     */
+    private $serializer;
+
     /**
      * @param \Magento\Framework\App\Route\ConfigInterface $routeConfig
      * @param \Magento\Framework\App\RequestInterface $request
@@ -199,6 +206,7 @@ class Url extends \Magento\Framework\DataObject implements \Magento\Framework\Ur
      * @param string $scopeType
      * @param array $data
      * @param HostChecker|null $hostChecker
+     * @param Json|null $serializer
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -214,7 +222,8 @@ public function __construct(
         \Magento\Framework\Url\RouteParamsPreprocessorInterface $routeParamsPreprocessor,
         $scopeType,
         array $data = [],
-        HostChecker $hostChecker = null
+        HostChecker $hostChecker = null,
+        Json $serializer = null
     ) {
         $this->_request = $request;
         $this->_routeConfig = $routeConfig;
@@ -229,6 +238,7 @@ public function __construct(
         $this->_scopeType = $scopeType;
         $this->hostChecker = $hostChecker ?: \Magento\Framework\App\ObjectManager::getInstance()
             ->get(HostChecker::class);
+        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
         parent::__construct($data);
     }
 
@@ -856,7 +866,7 @@ function ($item) use (&$isCached) {
             ksort($cachedParams);
         }
 
-        $cacheKey = sha1($routePath . json_encode($cachedParams));
+        $cacheKey = sha1($routePath . $this->serializer->serialize($cachedParams));
         if (!isset($this->cacheUrl[$cacheKey])) {
             $this->cacheUrl[$cacheKey] = $this->getUrlModifier()->execute(
                 $this->createUrl($routePath, $routeParams)
diff --git a/lib/internal/Magento/Framework/View/Element/Template/File/Resolver.php b/lib/internal/Magento/Framework/View/Element/Template/File/Resolver.php
diff --git a/lib/internal/Magento/Framework/View/Test/Unit/Element/Template/File/ResolverTest.php b/lib/internal/Magento/Framework/View/Test/Unit/Element/Template/File/ResolverTest.php

Original file line number	Diff line number	Diff line change
`@@ -290,6 +290,9 @@ public function testGetUrlIdempotentSetRoutePath()`
`290`	`290`	`->method('getScope')`
`291`	`291`	`->will($this->returnValue($this->scopeMock));`
`292`	`292`
	`293`	`+ $this->urlModifier->expects($this->exactly(1))->method('execute');`
	`294`	`+`
	`295`	`+ $this->assertEquals('catalog/product/view', $model->getUrl('catalog/product/view'));`
`293`	`296`	`$this->assertEquals('catalog/product/view', $model->getUrl('catalog/product/view'));`
`294`	`297`	`}`
`295`	`298`