Merge pull request #277 from openedx/pwnage101/ENT-9133-2

fix: null metadata should just be tolerated
openedx · Jul 22, 2024 · b088dfb · b088dfb
2 parents 95e5903 + 18f674e
commit b088dfb
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/enterprise_subsidy/apps/api/v2/serializers/deposits.py b/enterprise_subsidy/apps/api/v2/serializers/deposits.py
@@ -128,7 +128,7 @@ def create(self, validated_data):
                 sales_contract_reference_id=validated_data['sales_contract_reference_id'],
                 sales_contract_reference_provider=validated_data['sales_contract_reference_provider'],
                 idempotency_key=validated_data.get('idempotency_key'),
-                **validated_data.get('metadata', {}),
+                **(validated_data.get('metadata') or {}),
             )
         except openedx_ledger.api.DepositCreationError as exc:
             logger.error(

diff --git a/enterprise_subsidy/apps/api/v2/tests/test_deposit_views.py b/enterprise_subsidy/apps/api/v2/tests/test_deposit_views.py
@@ -48,6 +48,17 @@ class DepositCreateViewTests(APITestMixin):
             },
             "expected_response_status": status.HTTP_201_CREATED,
         },
+        {
+            "subsidy_active": True,
+            "creation_request_data": {
+                "desired_deposit_quantity": 100,
+                "sales_contract_reference_id": str(uuid.uuid4()),
+                "sales_contract_reference_provider": DEFAULT_SALES_CONTRACT_REFERENCE_PROVIDER_SLUG,
+                # Test getting a null metadata value.
+                "metadata": None,
+            },
+            "expected_response_status": status.HTTP_201_CREATED,
+        },
 
         ###
         # Sad paths:
@@ -119,7 +130,7 @@ def test_deposit_creation(
                 creation_request_data["sales_contract_reference_provider"]
             assert Deposit.objects.count() == 2
             created_deposit = Deposit.objects.get(uuid=response.data["uuid"])
-            assert created_deposit.transaction.metadata == creation_request_data.get("metadata", {})
+            assert created_deposit.transaction.metadata == (creation_request_data.get("metadata") or {})
         else:
             assert Deposit.objects.count() == 1