OXDEV-8728 Implement json serialization Exception

OXID-eSales · Sep 24, 2024 · 7a7d9c4 · 7a7d9c4
1 parent 3699ee8
commit 7a7d9c4
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 1 deletion.
diff --git a/src/UserData/Exception/JsonSerializationException.php b/src/UserData/Exception/JsonSerializationException.php
@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\GdprOptinModule\UserData\Exception;
+
+class JsonSerializationException extends \Exception
+{
+}
diff --git a/src/UserData/Service/CollectionSerializerServiceInterface.php b/src/UserData/Service/CollectionSerializerServiceInterface.php
@@ -11,8 +11,12 @@
 
 use OxidEsales\GdprOptinModule\UserData\DataType\ResultFileInterface;
 use OxidEsales\GdprOptinModule\UserData\DataType\TableCollectionInterface;
+use OxidEsales\GdprOptinModule\UserData\Exception\JsonSerializationException;
 
 interface CollectionSerializerServiceInterface
 {
+    /**
+     * @throws JsonSerializationException
+     */
     public function serializeCollection(TableCollectionInterface $data): ResultFileInterface;
 }
diff --git a/src/UserData/Service/JsonCollectionSerializerService.php b/src/UserData/Service/JsonCollectionSerializerService.php
@@ -12,11 +12,18 @@
 use OxidEsales\GdprOptinModule\UserData\DataType\ResultFile;
 use OxidEsales\GdprOptinModule\UserData\DataType\ResultFileInterface;
 use OxidEsales\GdprOptinModule\UserData\DataType\TableCollectionInterface;
+use OxidEsales\GdprOptinModule\UserData\Exception\JsonSerializationException;
 
 class JsonCollectionSerializerService implements CollectionSerializerServiceInterface
 {
     public function serializeCollection(TableCollectionInterface $data): ResultFileInterface
     {
-        return new ResultFile($data->getCollectionName(), json_encode($data->getCollection()));
+        $jsonData = json_encode($data->getCollection());
+
+        if ($jsonData === false) {
+            throw new JsonSerializationException();
+        }
+
+        return new ResultFile($data->getCollectionName(), $jsonData);
     }
 }
diff --git a/tests/Unit/UserData/Service/JsonCollectionSerializerServiceTest.php b/tests/Unit/UserData/Service/JsonCollectionSerializerServiceTest.php
@@ -10,6 +10,7 @@
 namespace OxidEsales\GdprOptinModule\Tests\Unit\UserData\Service;
 
 use OxidEsales\GdprOptinModule\UserData\DataType\TableCollectionInterface;
+use OxidEsales\GdprOptinModule\UserData\Exception\JsonSerializationException;
 use OxidEsales\GdprOptinModule\UserData\Service\JsonCollectionSerializerService;
 use PHPUnit\Framework\TestCase;
 
@@ -35,4 +36,23 @@ public function testSerializeCollection(): void
         $this->assertSame($expectedCollectionName, $actualResult->getFileName());
         $this->assertSame(json_encode($expectedCollection), $actualResult->getContent());
     }
+
+    public function testSerializeCollectionThrowsExceptionOnJsonError()
+    {
+        $invalidString = "\xB1\x31\x32";
+        $invalidCollection = [
+            ['someColum1' => uniqid(), 'someColum2' => $invalidString]
+        ];
+
+        $tableCollectionMock = $this->createConfiguredMock(TableCollectionInterface::class, [
+            'getCollection' => $invalidCollection,
+            'getCollectionName' => uniqid(),
+        ]);
+
+        $sut = new JsonCollectionSerializerService();
+
+        $this->expectException(JsonSerializationException::class);
+
+        $sut->serializeCollection($tableCollectionMock);
+    }
 }