Replace Laminas\Json usage in the JsonModel. Possible BC break now that a DomainException is thrown if there is an encoding error

Signed-off-by: George Steel <george@net-glue.co.uk>

Author: gsteel

src/Model/JsonModel.php

@@ -8,10 +8,16 @@
 
 namespace Laminas\View\Model;
 
-use Laminas\Json\Json;
+use JsonException;
 use Laminas\Stdlib\ArrayUtils;
+use Laminas\View\Exception\DomainException;
 use Traversable;
 
+use function json_encode;
+
+use const JSON_PRETTY_PRINT;
+use const JSON_THROW_ON_ERROR;
+
 class JsonModel extends ViewModel
 {
     /**
@@ -60,13 +66,21 @@ public function serialize()
             $variables = ArrayUtils::iteratorToArray($variables);
         }
 
-        $options = [
-            'prettyPrint' => $this->getOption('prettyPrint'),
-        ];
+        $options = (bool) $this->getOption('prettyPrint', false) ? JSON_PRETTY_PRINT : 0;
 
         if (null !== $this->jsonpCallback) {
-            return $this->jsonpCallback.'('.Json::encode($variables, false, $options).');';
+            return $this->jsonpCallback.'('.$this->jsonEncode($variables, $options).');';
+        }
+        return $this->jsonEncode($variables, $options);
+    }
+
+    /** @param mixed $data */
+    private function jsonEncode($data, int $options): string
+    {
+        try {
+            return json_encode($data, $options | JSON_THROW_ON_ERROR);
+        } catch (JsonException $e) {
+            throw new DomainException('Failed to encode Json', $e->getCode(), $e);
         }
-        return Json::encode($variables, false, $options);
     }
 }

test/Model/JsonModelTest.php

@@ -8,37 +8,46 @@
 
 namespace LaminasTest\View\Model;
 
-use Laminas\Json\Json;
+use Laminas\View\Exception\DomainException;
 use Laminas\View\Model\JsonModel;
 use Laminas\View\Variables;
 use PHPUnit\Framework\TestCase;
 
+use function json_encode;
+
+use const JSON_PRETTY_PRINT;
+use const JSON_THROW_ON_ERROR;
+
 class JsonModelTest extends TestCase
 {
-    public function testAllowsEmptyConstructor()
+    public function testAllowsEmptyConstructor(): void
     {
         $model = new JsonModel();
         $this->assertInstanceOf(Variables::class, $model->getVariables());
         $this->assertEquals([], $model->getOptions());
     }
 
-    public function testCanSerializeVariablesToJson()
+    public function testCanSerializeVariablesToJson(): void
     {
         $array = ['foo' => 'bar'];
         $model = new JsonModel($array);
         $this->assertEquals($array, $model->getVariables());
-        $this->assertEquals(Json::encode($array), $model->serialize());
+        $this->assertJsonStringEqualsJsonString(json_encode($array, JSON_THROW_ON_ERROR), $model->serialize());
     }
 
-    public function testCanSerializeWithJsonpCallback()
+    public function testCanSerializeWithJsonpCallback(): void
     {
         $array = ['foo' => 'bar'];
         $model = new JsonModel($array);
         $model->setJsonpCallback('callback');
-        $this->assertEquals('callback(' . Json::encode($array) . ');', $model->serialize());
+        $expect = sprintf(
+            'callback(%s);',
+            json_encode($array, JSON_THROW_ON_ERROR)
+        );
+        $this->assertEquals($expect, $model->serialize());
     }
 
-    public function testPrettyPrint()
+    public function testPrettyPrint(): void
     {
         $array = [
             'simple' => 'simple test string',
@@ -49,6 +58,17 @@ public function testPrettyPrint()
             ]
         ];
         $model = new JsonModel($array, ['prettyPrint' => true]);
-        $this->assertEquals(Json::encode($array, false, ['prettyPrint' => true]), $model->serialize());
+        $expect = json_encode($array, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT);
+        $this->assertEquals($expect, $model->serialize());
+    }
+
+    public function testThatAnExceptionIsThrownIfItIsNotPossibleToEncodeThePayload(): void
+    {
+        $malformedUtf8 = [
+            'string' => "\x92",
+        ];
+        $this->expectException(DomainException::class);
+        $this->expectExceptionMessage('Failed to encode Json');
+        (new JsonModel($malformedUtf8))->serialize();
     }
 }