Fix handling of Stringable objects in JSON update requests

Author: thomascorthals

CHANGELOG.md

@@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Solarium\Core\Query\AbstractQuery::setCpuAllowed()
 
+### Fixed
+- JSON update requests correctly handle `Stringable` object set as field value
+
 
 ## [6.3.5]
 ### Added

src/QueryType/Update/Query/Document.php

@@ -498,6 +498,8 @@ public function jsonSerialize()
         foreach ($fields as $key => &$value) {
             if ($value instanceof \DateTimeInterface) {
                 $value = $this->getHelper()->formatDate($value);
+            } elseif ($value instanceof \Stringable && !($value instanceof \JsonSerializable)) {
+                $value = (string) $value;
             } elseif (\is_array($value) && is_numeric(array_key_first($value))) {
                 // ensure consecutive indices so it doesn't serialize to an object
                 $value = array_values($value);

tests/QueryType/Update/RequestBuilder/JsonTest.php

@@ -711,6 +711,104 @@ public function testBuildAddJsonWithMultivalueDateTimes()
         );
     }
 
+    public function testBuildAddJsonWithJsonSerializableObject()
+    {
+        $value = new class() implements \JsonSerializable {
+            public function jsonSerialize(): mixed
+            {
+                return 'My value';
+            }
+        };
+
+        $command = new AddCommand();
+        $command->addDocument(
+            new Document(['id' => 1, 'my_field' => $value])
+        );
+        $json = [];
+
+        $this->builder->buildAddJson($command, $json);
+
+        $this->assertCount(1, $json);
+        $this->assertJsonStringEqualsJsonString(
+            '{
+                "add": {
+                    "doc": {
+                        "id": 1,
+                        "my_field": "My value"
+                    }
+                }
+            }',
+            '{'.$json[0].'}'
+        );
+    }
+
+    public function testBuildAddJsonWithStringableObject()
+    {
+        $value = new class() implements \Stringable {
+            public function __toString(): string
+            {
+                return 'My value';
+            }
+        };
+
+        $command = new AddCommand();
+        $command->addDocument(
+            new Document(['id' => 1, 'my_field' => $value])
+        );
+        $json = [];
+
+        $this->builder->buildAddJson($command, $json);
+
+        $this->assertCount(1, $json);
+        $this->assertJsonStringEqualsJsonString(
+            '{
+                "add": {
+                    "doc": {
+                        "id": 1,
+                        "my_field": "My value"
+                    }
+                }
+            }',
+            '{'.$json[0].'}'
+        );
+    }
+
+    public function testBuildAddJsonWithJsonSerializableAndStringableObject()
+    {
+        $value = new class() implements \JsonSerializable, \Stringable {
+            public function jsonSerialize(): mixed
+            {
+                return 'My JSON value';
+            }
+
+            public function __toString(): string
+            {
+                return 'My string value';
+            }
+        };
+
+        $command = new AddCommand();
+        $command->addDocument(
+            new Document(['id' => 1, 'my_field' => $value])
+        );
+        $json = [];
+
+        $this->builder->buildAddJson($command, $json);
+
+        $this->assertCount(1, $json);
+        $this->assertJsonStringEqualsJsonString(
+            '{
+                "add": {
+                    "doc": {
+                        "id": 1,
+                        "my_field": "My JSON value"
+                    }
+                }
+            }',
+            '{'.$json[0].'}'
+        );
+    }
+
     public function testBuildAddJsonWithFieldModifierAndNullValue()
     {
         $doc = new Document();

tests/QueryType/Update/RequestBuilder/XmlTest.php

@@ -522,6 +522,26 @@ public function testBuildAddXmlWithMultivalueDateTimes()
         );
     }
 
+    public function testBuildAddXmlWithStringableObject()
+    {
+        $value = new class() implements \Stringable {
+            public function __toString(): string
+            {
+                return 'My value';
+            }
+        };
+
+        $command = new AddCommand();
+        $command->addDocument(
+            new Document(['id' => 1, 'my_field' => $value])
+        );
+
+        $this->assertSame(
+            '<add><doc><field name="id">1</field><field name="my_field">My value</field></doc></add>',
+            $this->builder->buildAddXml($command)
+        );
+    }
+
     public function testBuildAddXmlWithFieldModifierAndNullValue()
     {
         $doc = new Document();