[JsonPath] Make JsonCrawler stateless

alexandre-daubois · alexandre-daubois · commit faddb61a8c5e · 2025-03-29T18:21:52.000+01:00
diff --git a/src/Symfony/Component/JsonPath/JsonCrawler.php b/src/Symfony/Component/JsonPath/JsonCrawler.php
@@ -38,36 +38,29 @@ final class JsonCrawler implements JsonCrawlerInterface
         'value' => true,
     ];
 
-    /**
-     * @param resource|string $raw
-     */
-    public function __construct(
-        private readonly mixed $raw,
-    ) {
-        if (!\is_string($raw) && !\is_resource($raw)) {
-            throw new InvalidArgumentException(\sprintf('Expected string or resource, got "%s".', get_debug_type($raw)));
+    public function find(string|JsonPath $query, mixed $data): array
+    {
+        if (!\is_string($data) && !\is_resource($data)) {
+            throw new \TypeError(\sprintf('Expected string or resource, got "%s".', get_debug_type($data)));
         }
-    }
 
-    public function find(string|JsonPath $query): array
-    {
-        return $this->evaluate(\is_string($query) ? new JsonPath($query) : $query);
+        return $this->evaluate(\is_string($query) ? new JsonPath($query) : $query, $data);
     }
 
-    private function evaluate(JsonPath $query): array
+    private function evaluate(JsonPath $query, mixed $data): array
     {
         try {
             $tokens = JsonPathTokenizer::tokenize($query);
-            $json = $this->raw;
+            $json = $data;
 
-            if (\is_resource($this->raw)) {
+            if (\is_resource($data)) {
                 if (!class_exists(Splitter::class)) {
                     throw new \LogicException('The JsonStreamer package is required to evaluate a path against a resource. Try running "composer require symfony/json-streamer".');
                 }
 
                 $simplified = JsonPathUtils::findSmallestDeserializableStringAndPath(
                     $tokens,
-                    $this->raw,
+                    $data,
                 );
 
                 $tokens = $simplified['tokens'];
diff --git a/src/Symfony/Component/JsonPath/JsonCrawlerInterface.php b/src/Symfony/Component/JsonPath/JsonCrawlerInterface.php
@@ -22,10 +22,13 @@
 interface JsonCrawlerInterface
 {
     /**
+     * @param string|resource $data The JSON string or a stream resource containing the JSON string
+     *
      * @return list<array|string|float|int|bool|null>
      *
      * @throws InvalidArgumentException When the JSON string provided to the crawler cannot be decoded
      * @throws JsonCrawlerException When a syntax error occurs in the provided JSON path
+     * @throws \TypeError When the data provided is not a string or a resource
      */
-    public function find(string|JsonPath $query): array;
+    public function find(string|JsonPath $query, mixed $data): array;
 }
diff --git a/src/Symfony/Component/JsonPath/Tests/JsonCrawlerTest.php b/src/Symfony/Component/JsonPath/Tests/JsonCrawlerTest.php

Original file line number	Diff line number	Diff line change
`@@ -22,10 +22,13 @@`
`22`	`22`	`interface JsonCrawlerInterface`
`23`	`23`	`{`
`24`	`24`	`/**`
	`25`	`+ * @param string\|resource $data The JSON string or a stream resource containing the JSON string`
	`26`	`+ *`
`25`	`27`	`* @return list<array\|string\|float\|int\|bool\|null>`
`26`	`28`	`*`
`27`	`29`	`* @throws InvalidArgumentException When the JSON string provided to the crawler cannot be decoded`
`28`	`30`	`* @throws JsonCrawlerException When a syntax error occurs in the provided JSON path`
	`31`	`+ * @throws \TypeError When the data provided is not a string or a resource`
`29`	`32`	`*/`
`30`		`- public function find(string\|JsonPath $query): array;`
	`33`	`+ public function find(string\|JsonPath $query, mixed $data): array;`
`31`	`34`	`}`