fix: Handle empty custom data

PaddleHQ · Oct 11, 2024 · 02ae267 · 02ae267
1 parent 807fd31
commit 02ae267
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@ Check our main [developer changelog](https://developer.paddle.com/?utm_source=dx
 - `TransactionsClient::preview()` `TransactionPreview` response now allows null price ID for non-catalog prices:
   - `TransactionPreview` `items[]->price` can now return `Price` (with `id`) or `TransactionPreviewPrice` (with nullable `id`)
   - `TransactionPreview` `details->lineItems[]->priceId` is now nullable
+- Empty custom data array will now serialize to empty JSON object `{}`
 
 ### Added
 - `TransactionsClient::create()` now supports operation items with optional properties:

diff --git a/src/Client.php b/src/Client.php
@@ -41,6 +41,7 @@
 use Psr\Http\Message\UriInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+use Symfony\Component\Serializer\Context\Normalizer\ObjectNormalizerContextBuilder;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
 use Symfony\Component\Serializer\Normalizer\BackedEnumNormalizer;
@@ -172,7 +173,16 @@ private function requestRaw(string $method, string|UriInterface $uri, array|\Jso
         $request = $this->requestFactory->createRequest($method, $uri);
 
         $serializer = new Serializer(
-            [new BackedEnumNormalizer(), new JsonSerializableNormalizer(), new ObjectNormalizer(nameConverter: new CamelCaseToSnakeCaseNameConverter())],
+            [
+                new BackedEnumNormalizer(),
+                new JsonSerializableNormalizer(),
+                new ObjectNormalizer(
+                    nameConverter: new CamelCaseToSnakeCaseNameConverter(),
+                    defaultContext: (new ObjectNormalizerContextBuilder())
+                        ->withPreserveEmptyObjects(true)
+                        ->toArray(),
+                ),
+            ],
             [new JsonEncoder()],
         );
 

diff --git a/src/Entities/Shared/CustomData.php b/src/Entities/Shared/CustomData.php
@@ -18,8 +18,10 @@ public function __construct(
     ) {
     }
 
-    public function jsonSerialize(): array|\JsonSerializable
+    public function jsonSerialize(): array|\JsonSerializable|\stdClass
     {
-        return $this->data;
+        return $this->data === []
+            ? (object) []
+            : $this->data;
     }
 }
diff --git a/src/Notifications/Entities/Shared/CustomData.php b/src/Notifications/Entities/Shared/CustomData.php
@@ -18,8 +18,10 @@ public function __construct(
     ) {
     }
 
-    public function jsonSerialize(): array|\JsonSerializable
+    public function jsonSerialize(): array|\JsonSerializable|\stdClass
     {
-        return $this->data;
+        return $this->data === []
+            ? (object) []
+            : $this->data;
     }
 }
diff --git a/...es/Transactions/_fixtures/request/create_with_multiple_non_catalog_price_and_product.json b/...es/Transactions/_fixtures/request/create_with_multiple_non_catalog_price_and_product.json
@@ -6,7 +6,7 @@
                 "description": "Annual (per seat)",
                 "name": "Annual (per seat)",
                 "product": {
-                    "custom_data": [],
+                    "custom_data": {},
                     "description": "Some description",
                     "image_url": "https://paddle-sandbox.s3.amazonaws.com/user/10889/2nmP8MQSret0aWeDemRw_icon1.png",
                     "name": "Annual (per seat)",

diff --git a/...l/Resources/Transactions/_fixtures/request/create_with_non_catalog_price_and_product.json b/...l/Resources/Transactions/_fixtures/request/create_with_non_catalog_price_and_product.json
@@ -6,7 +6,7 @@
                 "description": "Annual (per seat)",
                 "name": "Annual (per seat)",
                 "product": {
-                    "custom_data": [],
+                    "custom_data": {},
                     "description": "Some description",
                     "image_url": "https://paddle-sandbox.s3.amazonaws.com/user/10889/2nmP8MQSret0aWeDemRw_icon1.png",
                     "name": "Annual (per seat)",

diff --git a/...s/Transactions/_fixtures/request/preview_with_multiple_non_catalog_price_and_product.json b/...s/Transactions/_fixtures/request/preview_with_multiple_non_catalog_price_and_product.json
@@ -6,7 +6,7 @@
                 "description": "Annual (per seat)",
                 "name": "Annual (per seat)",
                 "product": {
-                    "custom_data": [],
+                    "custom_data": {},
                     "description": "Some description",
                     "image_url": "https://paddle-sandbox.s3.amazonaws.com/user/10889/2nmP8MQSret0aWeDemRw_icon1.png",
                     "name": "Annual (per seat)",

diff --git a/.../Resources/Transactions/_fixtures/request/preview_with_non_catalog_price_and_product.json b/.../Resources/Transactions/_fixtures/request/preview_with_non_catalog_price_and_product.json
@@ -6,7 +6,7 @@
                 "description": "Annual (per seat)",
                 "name": "Annual (per seat)",
                 "product": {
-                    "custom_data": [],
+                    "custom_data": {},
                     "description": "Some description",
                     "image_url": "https://paddle-sandbox.s3.amazonaws.com/user/10889/2nmP8MQSret0aWeDemRw_icon1.png",
                     "name": "Annual (per seat)",

diff --git a/...l/Resources/Transactions/_fixtures/request/update_with_non_catalog_price_and_product.json b/...l/Resources/Transactions/_fixtures/request/update_with_non_catalog_price_and_product.json
@@ -6,7 +6,7 @@
                 "description": "Annual (per seat)",
                 "name": "Annual (per seat)",
                 "product": {
-                    "custom_data": [],
+                    "custom_data": {},
                     "description": "Some description",
                     "image_url": "https://paddle-sandbox.s3.amazonaws.com/user/10889/2nmP8MQSret0aWeDemRw_icon1.png",
                     "name": "Annual (per seat)",