[Serializer] Fixed throwing exception with option JSON_PARTIAL_OUTPUT_ON_ERROR #25490

diversantvlz · 2017-12-13T21:26:02Z

Q	A
Branch?	2.7
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	no
License	MIT
Doc PR	no

Php function json_encode/decode with option JSON_PARTIAL_OUTPUT_ON_ERROR return result on error, but if have is error json_last_error() always return error code even if there is a result and it is not false. Because of this is impossible set JSON_PARTIAL_OUTPUT_ON_ERROR option across variable $context.

Current fix solves this problem.

Verification on the false is completely correct, since json_encode / decode returns false only on error if not set JSON_PARTIAL_OUTPUT_ON_ERROR option.

Such have a problem e.g when encoding data is not utf-8 (emoji from facebook).

dunglas · 2017-12-13T22:24:30Z

Could you add some unit tests please?

nicolas-grekas · 2017-12-18T19:31:56Z

src/Symfony/Component/Serializer/Encoder/JsonDecode.php

-            throw new UnexpectedValueException(JsonEncoder::getLastErrorMessage());
+        if (false === $decodedData) {
+            $this->lastError = json_last_error();
+            throw new UnexpectedValueException(


should be on one line according to our CS policy

jvasseur · 2017-12-18T19:39:11Z

src/Symfony/Component/Serializer/Encoder/JsonDecode.php

@@ -95,8 +95,11 @@ public function decode($data, $format, array $context = array())
            $decodedData = json_decode($data, $associative, $recursionDepth);
        }

-        if (JSON_ERROR_NONE !== $this->lastError = json_last_error()) {
-            throw new UnexpectedValueException(JsonEncoder::getLastErrorMessage());
+        if (false === $decodedData) {


$decodedData can be false without it being an error if you decode the "false" string.

No, json_decode('false') return string 'false', not boolean false. false !== 'false'

@diversantvlz you should try running it :)

Ok, like this?

Simperfit · 2017-12-20T06:10:16Z

@diversantvlz Could you please add some unit test ?

dunglas · 2017-12-20T07:45:37Z

src/Symfony/Component/Serializer/Encoder/JsonDecode.php

@@ -95,8 +95,8 @@ public function decode($data, $format, array $context = array())
            $decodedData = json_decode($data, $associative, $recursionDepth);
        }

-        if (JSON_ERROR_NONE !== $this->lastError = json_last_error()) {
-            throw new UnexpectedValueException(JsonEncoder::getLastErrorMessage());
+        if (JSON_ERROR_NONE !== $this->lastError = json_last_error() and false === $decodedData) {


Please use && instead of and (it doesn't have the same priority).

In fact using && will break precedence, but it should still be used, so that both operands should be swapped

nicolas-grekas · 2017-12-20T10:30:30Z

Shouldn't we also check if the JSON_PARTIAL_OUTPUT_ON_ERROR flag is set?
This needs a test case for sure :)
Also, why removing the call to JsonEncoder::getLastErrorMessage()?

diversantvlz · 2017-12-20T11:36:00Z

Options argument in json_encode is a bit mask. To understand if a flag is installed, additional calculations must be made.

Simperfit · 2017-12-21T16:24:22Z

@diversantvlz Do you want me to help you adding a test ?

diversantvlz · 2017-12-21T21:19:45Z

@Simperfit Yes, why not. I would be thankful. I do not have enough time for this task, i can do it the next week.
It would be nice to test for something like:

//for decode
json_decode('false') === false && json_last_error() === JSON_ERROR_NONE;

//for encode
$arr = array(
   'utf8' => 'Hello World!', 
   'notUtf8' => "\xb0\xd0\xb5\xd0"
);

json_encode($arr) === false && json_last_error() === JSON_ERROR_UTF8;
json_encode($arr , JSON_PARTIAL_OUTPUT_ON_ERROR)  === '{"utf8":  "Hello World!", "notUtf8": null}' &&  json_last_error() === JSON_ERROR_UTF8;

nicolas-grekas

@diversantvlz FYI I pushed on your fork, with a test case, and reverting the change on JsonDecode since it cannot happen there (please provide a test case if you don't agree.)

diversantvlz · 2018-01-09T20:47:17Z

@nicolas-grekas @dunglas Review test case please.

nicolas-grekas · 2018-01-10T08:44:47Z

Thanks @diversantvlz FYI, I reverted the change on JsonDecode because it just shouldn't change, partial jsons is only a feature of JsonEncode.
I also fixed the code-style in the tests, and reverted a few other unrelated changes (like the not calling JsonEncoder::getLastErrorMessage() but constructing the message inline? - I guess these must be some bad merge/rebase.)

…_ON_ERROR

nicolas-grekas · 2018-01-10T09:05:09Z

Logic now fixed to work as expected on PHP 5.4 & 5.3.
PR ready.

Status: reviewed

nicolas-grekas · 2018-01-10T09:10:43Z

Thank you @diversantvlz.

…TIAL_OUTPUT_ON_ERROR (diversantvlz) This PR was merged into the 2.7 branch. Discussion ---------- [Serializer] Fixed throwing exception with option JSON_PARTIAL_OUTPUT_ON_ERROR | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | yes | New feature? | no  | BC breaks? | no | Deprecations? | no  | Tests pass? | yes | Fixed tickets | no | License | MIT | Doc PR | no  Php function json_encode/decode with option JSON_PARTIAL_OUTPUT_ON_ERROR return result on error, but if have is error json_last_error() always return error code even if there is a result and it is not false. Because of this is impossible set JSON_PARTIAL_OUTPUT_ON_ERROR option across variable $context. Current fix solves this problem. Verification on the false is completely correct, since json_encode / decode returns false only on error if not set JSON_PARTIAL_OUTPUT_ON_ERROR option. Such have a problem e.g when encoding data is not utf-8 (emoji from facebook). Commits ------- e7e410b [Serializer] Fixed throwing exception with option JSON_PARTIAL_OUTPUT_ON_ERROR

carsonbot added Status: Needs Review Serializer Bug labels Dec 13, 2017

diversantvlz force-pushed the 2.7 branch 4 times, most recently from 83d2f6d to d968567 Compare December 13, 2017 22:15

nicolas-grekas changed the title ~~[Serializer] Fixed throwing exception with option JSON_PARTIAL_OUTPUT…~~ [Serializer] Fixed throwing exception with option JSON_PARTIAL_OUTPUT_ON_ERROR Dec 18, 2017

nicolas-grekas added this to the 2.7 milestone Dec 18, 2017

nicolas-grekas reviewed Dec 18, 2017

View reviewed changes

jvasseur reviewed Dec 18, 2017

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Dec 20, 2017

dunglas requested changes Dec 20, 2017

View reviewed changes

diversantvlz force-pushed the 2.7 branch from 3b6f28a to 1382811 Compare December 20, 2017 12:02

nicolas-grekas force-pushed the 2.7 branch from 3127cea to 15f098b Compare January 7, 2018 10:08

nicolas-grekas approved these changes Jan 7, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Jan 7, 2018

nicolas-grekas force-pushed the 2.7 branch from 15f098b to 1c1547d Compare January 7, 2018 10:10

nicolas-grekas force-pushed the 2.7 branch 3 times, most recently from 3e75b6e to 3fb8c58 Compare January 10, 2018 08:40

nicolas-grekas force-pushed the 2.7 branch from 3fb8c58 to ae7b33e Compare January 10, 2018 08:57

[Serializer] Fixed throwing exception with option JSON_PARTIAL_OUTPUT…

e7e410b

…_ON_ERROR

nicolas-grekas force-pushed the 2.7 branch from ae7b33e to e7e410b Compare January 10, 2018 09:02

nicolas-grekas merged commit e7e410b into symfony:2.7 Jan 10, 2018

This was referenced Jan 29, 2018

Release v2.7.41 #25953

Merged

Release v2.8.34 #25954

Merged

Release v3.3.16 #25955

Merged

Release v3.4.4 #25956

Merged

Release v4.0.4 #25957

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Fixed throwing exception with option JSON_PARTIAL_OUTPUT_ON_ERROR #25490

[Serializer] Fixed throwing exception with option JSON_PARTIAL_OUTPUT_ON_ERROR #25490

diversantvlz commented Dec 13, 2017 •

edited by nicolas-grekas

Loading

dunglas commented Dec 13, 2017

nicolas-grekas Dec 18, 2017

diversantvlz Dec 20, 2017

jvasseur Dec 18, 2017

diversantvlz Dec 19, 2017

nicolas-grekas Dec 19, 2017

diversantvlz Dec 20, 2017

Simperfit commented Dec 20, 2017

dunglas Dec 20, 2017 •

edited

Loading

nicolas-grekas Dec 20, 2017

diversantvlz Dec 21, 2017

nicolas-grekas commented Dec 20, 2017

diversantvlz commented Dec 20, 2017

Simperfit commented Dec 21, 2017

diversantvlz commented Dec 21, 2017

nicolas-grekas left a comment

diversantvlz commented Jan 9, 2018

nicolas-grekas commented Jan 10, 2018

nicolas-grekas commented Jan 10, 2018

nicolas-grekas commented Jan 10, 2018

[Serializer] Fixed throwing exception with option JSON_PARTIAL_OUTPUT_ON_ERROR #25490

[Serializer] Fixed throwing exception with option JSON_PARTIAL_OUTPUT_ON_ERROR #25490

Conversation

diversantvlz commented Dec 13, 2017 • edited by nicolas-grekas Loading

dunglas commented Dec 13, 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

Simperfit commented Dec 20, 2017

dunglas Dec 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Dec 20, 2017

diversantvlz commented Dec 20, 2017

Simperfit commented Dec 21, 2017

diversantvlz commented Dec 21, 2017

nicolas-grekas left a comment

Choose a reason for hiding this comment

diversantvlz commented Jan 9, 2018

nicolas-grekas commented Jan 10, 2018

nicolas-grekas commented Jan 10, 2018

nicolas-grekas commented Jan 10, 2018

diversantvlz commented Dec 13, 2017 •

edited by nicolas-grekas

Loading

dunglas Dec 20, 2017 •

edited

Loading