Remove zend json from json controller #10342

dmanners · 2017-07-26T20:01:50Z

Description

Removing the usage of Zend_Json in the Json Controller. Deprecating the method setData to encourage the use of the more type specific methods in this class after talking through options with @okorshenko

Fixed Issues (if relevant)

Upgrade ZF components. Zend_Json #9236: Upgrade ZF components. Zend_Json

Manual testing scenarios

...
...

Contribution checklist

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
All automated tests passed successfully (all builds on Travis CI are green)

- use the \Magento\Framework\Serialize\Serializer\Json instead of Zend_Json

- if we are dealing with something like new \Magento\Framework\DataObject() being used as a response object

- deprecate this method to encourage usage of other methods in this class, - be stricter on types passed into this method,

dmanners · 2017-07-26T20:02:40Z

This PR I expect to come up with plenty of talk/opinions. I am happy to hear what people think would be other options if there are some.

orlangur · 2017-07-26T20:23:06Z

lib/internal/Magento/Framework/Controller/Result/Json.php

+     */
+    public function __construct(
+        InlineInterface $translateInline,
+        \Magento\Framework\Serialize\Serializer\Json $serializer = null


Why do we rely on particular implementation and not interface by the way?
https://github.com/magento/magento2/blob/develop/app/etc/di.xml#L162

#8331 (comment) was the original comment from the team on the matter,

Thanks, I expected something like this. Not sure why such interface was introduced at all if we keep creating json-only code.

Needs to be mentioned somewhere to avoid confusion like #10335 (comment)

okorshenko · 2017-07-31T23:23:56Z

@dmanners This pull request has been reverted due to broken functionality. We need to review this change one more time. Thank you

dmanners · 2017-07-31T23:34:06Z

@okorshenko sure. Do you have a specific use/test case that this broke for so that I can have something to review when thinking about possible options here.

Thanks

orlangur · 2017-08-02T11:16:58Z

lib/internal/Magento/Framework/Controller/Result/Json.php

+     * @throws \InvalidArgumentException
+     * @throws \Magento\Framework\Exception\LocalizedException
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @deprecated


I disagree with deprecating this method. setData is for setting data which will be encoded and setJsonData is for setting raw data.

Two arguments which has no effect should be deprecated though.

Please change method description accordingly.

orlangur · 2017-08-02T11:17:29Z

lib/internal/Magento/Framework/Controller/Result/Json.php

     */
    public function setData($data, $cycleCheck = false, $options = [])
    {
-        $this->json = \Zend_Json::encode($data, $cycleCheck, $options);


This method is just setter, no need to call another setter, Magento is already slow enough.

orlangur · 2017-08-02T11:19:51Z

lib/internal/Magento/Framework/Controller/Result/Json.php

     */
    public function setData($data, $cycleCheck = false, $options = [])
    {
-        $this->json = \Zend_Json::encode($data, $cycleCheck, $options);
+        if ($data instanceof \Magento\Framework\DataObject) {


Why need this explicitly?

This is needed to maintain compatibility with the old implementation which took care of this inside.

I see...

public static function encode($valueToEncode, $cycleCheck = false, $options = array()) { if (is_object($valueToEncode)) { if (method_exists($valueToEncode, 'toJson')) { return $valueToEncode->toJson(); } elseif (method_exists($valueToEncode, 'toArray')) { return self::encode($valueToEncode->toArray(), $cycleCheck, $options); } }

Why it is not maintained for any object then?

orlangur · 2017-08-02T11:20:26Z

lib/internal/Magento/Framework/Controller/Result/Json.php

+            return $this->setArrayData($data->toArray());
+        }
+
+        if (is_array($data)) {


Please remove this if.

Please clarify

setData should be as old one, thus setData([]) just encodes array with no necessity for additional logic.

orlangur · 2017-08-02T11:20:51Z

lib/internal/Magento/Framework/Controller/Result/Json.php

+            return $this->setArrayData($data);
+        }
+
+        if (is_string($data)) {


Passing string parameter did encode $data before, please remove this if.

Please clarify

setData('someString') was setting json_encode('someString') and not just 'someString'.

orlangur · 2017-08-02T11:22:24Z

lib/internal/Magento/Framework/Controller/Result/Json.php

+     * @return $this
+     * @throws \InvalidArgumentException
+     */
+    public function setArrayData(array $data)


Please remove this method as it does not bring any value.

This method was introduced to deprecate and remove setData method, which has too much responsibilities.

This is what I strongly disagree with. Its responsibility is quite clear - encode value and set it. There is no need to think which value you're passing.

setData - pass value and it will be encoded
setJsonData - pass string and it will be set as is

I do agree that setData($object) could be discouraged and corresponding if could be marked as deprecated for further removal and setData method simplification. But introduction of setArrayData method looks like a mess to me.

orlangur · 2017-08-02T11:24:49Z

@dmanners I didn't do code review previous time but now did, please check my suggestions and prepare a new PR (merged PR cannot be reopened AFAIK).

dmanners · 2017-08-03T11:39:25Z

@orlangur thanks for the feedback, I appreciate the thoughts. I need to re-think these changes anyway so will take your ideas on board and see what I can put together.

dmanners added 6 commits July 26, 2017 19:51

Remove the usage of Zend_Json from the controller results json file.

baeb58c

- use the \Magento\Framework\Serialize\Serializer\Json instead of Zend_Json

Update the return type for the Adminhtml tax rate controllers

db6f353

Add ignore for unused parameters on the setData method

4f78388

Check to see if we are dealing with an object with a toJson method

7e46cea

- if we are dealing with something like new \Magento\Framework\DataObject() being used as a response object

Update Controller/Result/Json setData

ff0581b

- deprecate this method to encourage usage of other methods in this class, - be stricter on types passed into this method,

Remove comments in prepration for PR

41e118b

okorshenko self-assigned this Jul 26, 2017

okorshenko added this to the July 2017 milestone Jul 26, 2017

okorshenko added the develop label Jul 26, 2017

orlangur reviewed Jul 26, 2017

View reviewed changes

magento-team added Progress: accept develop labels Jul 26, 2017

okorshenko assigned orlangur Jul 27, 2017

magento-team merged commit 41e118b into magento:develop Jul 27, 2017

magento-team pushed a commit that referenced this pull request Jul 27, 2017

MAGETWO-71062: Remove zend json from json controller #10342

dc80f44

magento-team pushed a commit that referenced this pull request Jul 27, 2017

MAGETWO-71062: Remove zend json from json controller #10342

2742ee8

dmanners deleted the remove-zend-json-from-json-controller branch July 28, 2017 07:00

dmanners restored the remove-zend-json-from-json-controller branch July 31, 2017 23:28

dmanners deleted the remove-zend-json-from-json-controller branch July 31, 2017 23:28

orlangur reviewed Aug 2, 2017

View reviewed changes

ishakhsuvarov mentioned this pull request Aug 4, 2017

Update the AdminNotification AjaxMarkAsRead controller #10433

Merged

4 tasks

magento-team pushed a commit that referenced this pull request Oct 3, 2017

MAGETWO-80187: [2.2.x] - Remove zend json from json controller #10342

61341d1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove zend json from json controller #10342

Remove zend json from json controller #10342

dmanners commented Jul 26, 2017 •

edited by okorshenko

Loading

dmanners commented Jul 26, 2017

orlangur Jul 26, 2017

dmanners Jul 26, 2017

orlangur Jul 26, 2017

okorshenko commented Jul 31, 2017 •

edited

Loading

dmanners commented Jul 31, 2017

orlangur Aug 2, 2017

orlangur Aug 2, 2017

orlangur Aug 2, 2017

ishakhsuvarov Aug 2, 2017

orlangur Aug 2, 2017

orlangur Aug 2, 2017

ishakhsuvarov Aug 2, 2017

orlangur Aug 2, 2017

orlangur Aug 2, 2017

ishakhsuvarov Aug 2, 2017

orlangur Aug 2, 2017

orlangur Aug 2, 2017

ishakhsuvarov Aug 2, 2017

orlangur Aug 2, 2017 •

edited

Loading

orlangur commented Aug 2, 2017

dmanners commented Aug 3, 2017

Remove zend json from json controller #10342

Remove zend json from json controller #10342

Conversation

dmanners commented Jul 26, 2017 • edited by okorshenko Loading

Description

Fixed Issues (if relevant)

Manual testing scenarios

Contribution checklist

dmanners commented Jul 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

okorshenko commented Jul 31, 2017 • edited Loading

dmanners commented Jul 31, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orlangur Aug 2, 2017 • edited Loading

Choose a reason for hiding this comment

orlangur commented Aug 2, 2017

dmanners commented Aug 3, 2017

dmanners commented Jul 26, 2017 •

edited by okorshenko

Loading

okorshenko commented Jul 31, 2017 •

edited

Loading

orlangur Aug 2, 2017 •

edited

Loading