bug #9908 [HttpFoundation] Throw proper exception when invalid data is passed to JsonResponse class (stloyd)

fabpot · fabpot · commit 323710a2913c · 2013-12-31T12:26:13.000+01:00
This PR was merged into the 2.3 branch. Discussion ---------- [HttpFoundation] Throw proper exception when invalid data is passed to JsonResponse class | Q | A | ------------- | --- | Bug fix? | yes | BC breaks? | no* | Tests pass? | yes | Fixed tickets | #9903 | License | MIT \* as described in mentioned issue, before this PR there was thrown exception `UnexpectedValueException`, which was not correct, but I guess some people trying to hide the bug could use `try {} catch` on it. Commits ------- 38287e7 [HttpFoundation] Throw proper exception when invalid data is passed to JsonResponse class
diff --git a/src/Symfony/Component/HttpFoundation/JsonResponse.php b/src/Symfony/Component/HttpFoundation/JsonResponse.php
@@ -85,12 +85,18 @@ public function setCallback($callback = null)
      * @param mixed $data
      *
      * @return JsonResponse
+     *
+     * @throws \InvalidArgumentException
      */
     public function setData($data = array())
     {
         // Encode <, >, ', &, and " for RFC4627-compliant JSON, which may also be embedded into HTML.
         $this->data = json_encode($data, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT);
 
+        if (JSON_ERROR_NONE !== json_last_error()) {
+            throw new \InvalidArgumentException($this->transformJsonError());
+        }
+
         return $this->update();
     }
 
@@ -116,4 +122,31 @@ protected function update()
 
         return $this->setContent($this->data);
     }
+
+    private function transformJsonError()
+    {
+        if (function_exists('json_last_error_msg')) {
+            return json_last_error_msg();
+        }
+
+        switch (json_last_error()) {
+            case JSON_ERROR_DEPTH:
+                return 'Maximum stack depth exceeded.';
+
+            case JSON_ERROR_STATE_MISMATCH:
+                return 'Underflow or the modes mismatch.';
+
+            case JSON_ERROR_CTRL_CHAR:
+                return 'Unexpected control character found.';
+
+            case JSON_ERROR_SYNTAX:
+                return 'Syntax error, malformed JSON.';
+
+            case JSON_ERROR_UTF8:
+                return 'Malformed UTF-8 characters, possibly incorrectly encoded.';
+
+            default:
+                return 'Unknown error.';
+        }
+    }
 }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/JsonResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/JsonResponseTest.php
@@ -159,18 +159,27 @@ public function testSetCallback()
         $this->assertEquals('text/javascript', $response->headers->get('Content-Type'));
     }
 
+    public function testJsonEncodeFlags()
+    {
+        $response = new JsonResponse('<>\'&"');
+
+        $this->assertEquals('"\u003C\u003E\u0027\u0026\u0022"', $response->getContent());
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     */
     public function testSetCallbackInvalidIdentifier()
     {
         $response = new JsonResponse('foo');
-
-        $this->setExpectedException('InvalidArgumentException');
         $response->setCallback('+invalid');
     }
 
-    public function testJsonEncodeFlags()
+    /**
+     * @expectedException \InvalidArgumentException
+     */
+    public function testSetContent()
     {
-        $response = new JsonResponse('<>\'&"');
-
-        $this->assertEquals('"\u003C\u003E\u0027\u0026\u0022"', $response->getContent());
+        JsonResponse::create("\xB1\x31");
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -159,18 +159,27 @@ public function testSetCallback()`
`159`	`159`	`$this->assertEquals('text/javascript', $response->headers->get('Content-Type'));`
`160`	`160`	`}`
`161`	`161`
	`162`	`+ public function testJsonEncodeFlags()`
	`163`	`+ {`
	`164`	`+ $response = new JsonResponse('<>\'&"');`
	`165`	`+`
	`166`	`+ $this->assertEquals('"\u003C\u003E\u0027\u0026\u0022"', $response->getContent());`
	`167`	`+ }`
	`168`	`+`
	`169`	`+ /**`
	`170`	`+ * @expectedException \InvalidArgumentException`
	`171`	`+ */`
`162`	`172`	`public function testSetCallbackInvalidIdentifier()`
`163`	`173`	`{`
`164`	`174`	`$response = new JsonResponse('foo');`
`165`		`-`
`166`		`- $this->setExpectedException('InvalidArgumentException');`
`167`	`175`	`$response->setCallback('+invalid');`
`168`	`176`	`}`
`169`	`177`
`170`		`- public function testJsonEncodeFlags()`
	`178`	`+ /**`
	`179`	`+ * @expectedException \InvalidArgumentException`
	`180`	`+ */`
	`181`	`+ public function testSetContent()`
`171`	`182`	`{`
`172`		`- $response = new JsonResponse('<>\'&"');`
`173`		`-`
`174`		`- $this->assertEquals('"\u003C\u003E\u0027\u0026\u0022"', $response->getContent());`
	`183`	`+ JsonResponse::create("\xB1\x31");`
`175`	`184`	`}`
`176`	`185`	`}`