[HttpClient] allow arbitrary JSON values in requests

pschultz · pschultz · commit 831cc3564784 · 2019-11-01T17:53:31.000+01:00
Allow arbitrary values in the "json" request option. Previously values were
limitated to arrays and objects of type JsonSerializable. This doesn't account
for scalar values and classes with public properties (which don't need to
implement JsonSerializable), all of which are perfectly acceptable arguments to
json_encode.
diff --git a/src/Symfony/Component/HttpClient/CHANGELOG.md b/src/Symfony/Component/HttpClient/CHANGELOG.md
@@ -15,6 +15,7 @@ CHANGELOG
  * added `TraceableHttpClient`, `HttpClientDataCollector` and `HttpClientPass` to integrate with the web profiler
  * allow enabling buffering conditionally with a Closure
  * allow option "buffer" to be a stream resource
+ * allow arbitrary values for the "json" option
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/HttpClient/HttpClientTrait.php b/src/Symfony/Component/HttpClient/HttpClientTrait.php
@@ -332,18 +332,14 @@ private static function normalizePeerFingerprint($fingerprint): array
     }
 
     /**
-     * @param array|\JsonSerializable $value
+     * @param mixed $value
      *
      * @throws InvalidArgumentException When the value cannot be json-encoded
      */
     private static function jsonEncode($value, int $flags = null, int $maxDepth = 512): string
     {
         $flags = $flags ?? (JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_PRESERVE_ZERO_FRACTION);
 
-        if (!\is_array($value) && !$value instanceof \JsonSerializable) {
-            throw new InvalidArgumentException(sprintf('Option "json" must be array or JsonSerializable, %s given.', \is_object($value) ? \get_class($value) : \gettype($value)));
-        }
-
         try {
             $value = json_encode($value, $flags | (\PHP_VERSION_ID >= 70300 ? \JSON_THROW_ON_ERROR : 0), $maxDepth);
         } catch (\JsonException $e) {
diff --git a/src/Symfony/Component/HttpClient/HttpOptions.php b/src/Symfony/Component/HttpClient/HttpOptions.php
@@ -86,7 +86,7 @@ public function setBody($body)
     }
 
     /**
-     * @param array|\JsonSerializable $json
+     * @param mixed $json
      *
      * @return $this
      */
diff --git a/src/Symfony/Contracts/HttpClient/HttpClientInterface.php b/src/Symfony/Contracts/HttpClient/HttpClientInterface.php
@@ -35,9 +35,9 @@ interface HttpClientInterface
         'body' => '',           // array|string|resource|\Traversable|\Closure - the callback SHOULD yield a string
                                 //   smaller than the amount requested as argument; the empty string signals EOF; when
                                 //   an array is passed, it is meant as a form payload of field names and values
-        'json' => null,         // array|\JsonSerializable - when set, implementations MUST set the "body" option to
-                                //   the JSON-encoded value and set the "content-type" headers to a JSON-compatible
-                                //   value if they are not defined - typically "application/json"
+        'json' => null,         // mixed - when set, implementations MUST set the "body" option to the JSON-encoded
+                                //   value and set the "content-type" header to a JSON-compatible value if they are not
+                                //   defined - typically "application/json"
         'user_data' => null,    // mixed - any extra data to attach to the request (scalar, callable, object...) that
                                 //   MUST be available via $response->getInfo('user_data') - not used internally
         'max_redirects' => 20,  // int - the maximum number of redirects to follow; a value lower than or equal to 0

Original file line number	Diff line number	Diff line change
`@@ -332,18 +332,14 @@ private static function normalizePeerFingerprint($fingerprint): array`
`332`	`332`	`}`
`333`	`333`
`334`	`334`	`/**`
`335`		`- * @param array\|\JsonSerializable $value`
	`335`	`+ * @param mixed $value`
`336`	`336`	`*`
`337`	`337`	`* @throws InvalidArgumentException When the value cannot be json-encoded`
`338`	`338`	`*/`
`339`	`339`	`private static function jsonEncode($value, int $flags = null, int $maxDepth = 512): string`
`340`	`340`	`{`
`341`	`341`	`$flags = $flags ?? (JSON_HEX_TAG \| JSON_HEX_APOS \| JSON_HEX_AMP \| JSON_HEX_QUOT \| JSON_PRESERVE_ZERO_FRACTION);`
`342`	`342`
`343`		`- if (!\is_array($value) && !$value instanceof \JsonSerializable) {`
`344`		`- throw new InvalidArgumentException(sprintf('Option "json" must be array or JsonSerializable, %s given.', \is_object($value) ? \get_class($value) : \gettype($value)));`
`345`		`- }`
`346`		`-`
`347`	`343`	`try {`
`348`	`344`	`$value = json_encode($value, $flags \| (\PHP_VERSION_ID >= 70300 ? \JSON_THROW_ON_ERROR : 0), $maxDepth);`
`349`	`345`	`} catch (\JsonException $e) {`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public function setBody($body)`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`/**`
`89`		`- * @param array\|\JsonSerializable $json`
	`89`	`+ * @param mixed $json`
`90`	`90`	`*`
`91`	`91`	`* @return $this`
`92`	`92`	`*/`