Use a JSONField for BasePayment.extra_data

payments/core.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import re
+from importlib import import_module
 from typing import TYPE_CHECKING
 from urllib.parse import urlencode
 from urllib.parse import urljoin
@@ -167,7 +168,7 @@ def _default_provider_factory(variant: str, payment: BasePayment | None = None):
         raise ValueError(f"Payment variant does not exist: {variant}")
     if variant not in PROVIDER_CACHE:
         module_path, class_name = handler.rsplit(".", 1)
-        module = __import__(str(module_path), globals(), locals(), [str(class_name)])
+        module = import_module(module_path)
         class_ = getattr(module, class_name)
         PROVIDER_CACHE[variant] = class_(**config)
     return PROVIDER_CACHE[variant]

payments/cybersource/__init__.py

@@ -170,11 +170,11 @@ def charge(self, payment, data):
         else:
             params = self._prepare_preauth(payment, data)
         response = self._make_request(payment, params)
-        payment.attrs.capture = self._capture
+        payment.extra_data.capture = self._capture
         payment.transaction_id = response.requestID
         if response.reasonCode == AUTHENTICATE_REQUIRED:
             xid = response.payerAuthEnrollReply.xid
-            payment.attrs.xid = xid
+            payment.extra_data.xid = xid
             payment.change_status(
                 PaymentStatus.WAITING, message=_("3-D Secure verification in progress")
             )
@@ -276,8 +276,8 @@ def _get_params_for_new_payment(self, payment):
             "merchantReferenceCode": payment.id,
         }
         try:
-            fingerprint_id = payment.attrs.fingerprint_session_id
-        except AttributeError:
+            fingerprint_id = payment.extra_data["fingerprint_session_id"]
+        except KeyError:
             pass
         else:
             params["deviceFingerprintID"] = fingerprint_id
@@ -288,7 +288,7 @@ def _get_params_for_new_payment(self, payment):
 
     def _make_request(self, payment, params):
         response = self.client.service.runTransaction(**params)
-        payment.attrs.last_response = self._serialize_response(response)
+        payment.extra_data.last_response = self._serialize_response(response)
         return response
 
     def _prepare_payer_auth_validation_check(self, payment, card_data, pa_response):
@@ -297,7 +297,7 @@ def _prepare_payer_auth_validation_check(self, payment, card_data, pa_response):
         check_service.signedPARes = pa_response
         params = self._get_params_for_new_payment(payment)
         params["payerAuthValidateService"] = check_service
-        if payment.attrs.capture:
+        if payment.extra_data.capture:
             service = self.client.factory.create("data:CCCreditService")
             service._run = "true"
             params["ccCreditService"] = service
@@ -440,8 +440,8 @@ def _prepare_items(self, payment):
 
     def _prepare_merchant_defined_data(self, payment):
         try:
-            merchant_defined_data = payment.attrs.merchant_defined_data
-        except AttributeError:
+            merchant_defined_data = payment.extra_data["merchant_defined_data"]
+        except KeyError:
             return None
         else:
             data = self.client.factory.create("data:MerchantDefinedData")
@@ -471,7 +471,7 @@ def _serialize_response(self, response):
 
     def process_data(self, payment, request):
         xid = request.POST.get("MD")
-        if xid != payment.attrs.xid:
+        if xid != payment.extra_data.xid:
             return redirect(payment.get_failure_url())
         if payment.status in [PaymentStatus.CONFIRMED, PaymentStatus.PREAUTH]:
             return redirect(payment.get_success_url())

payments/cybersource/forms.py

@@ -41,7 +41,7 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         if self.provider.org_id:
             try:
-                fingerprint_id = self.payment.attrs.fingerprint_session_id
+                fingerprint_id = self.payment.extra_data.fingerprint_session_id
             except KeyError:
                 fingerprint_id = str(uuid4())
             self.fields["fingerprint"] = FingerprintInput(
@@ -57,7 +57,7 @@ def clean(self):
         if not self.errors:
             if self.provider.org_id:
                 fingerprint = cleaned_data["fingerprint"]
-                self.payment.attrs.fingerprint_session_id = fingerprint
+                self.payment.extra_data.fingerprint_session_id = fingerprint
             if not self.payment.transaction_id:
                 try:
                     self.provider.charge(self.payment, cleaned_data)

payments/cybersource/test_cybersource.py

@@ -153,7 +153,7 @@ def test_provider_redirects_on_success_captured_payment(
     ):
         transaction_id = 1234
         xid = "abc"
-        self.payment.attrs.xid = xid
+        self.payment.extra_data.xid = xid
 
         response = MagicMock()
         response.requestID = transaction_id
@@ -188,7 +188,7 @@ def test_provider_redirects_on_success_preauth_payment(
         )
         transaction_id = 1234
         xid = "abc"
-        self.payment.attrs.xid = xid
+        self.payment.extra_data.xid = xid
 
         response = MagicMock()
         response.requestID = transaction_id
@@ -218,7 +218,7 @@ def test_provider_redirects_on_success_preauth_payment(
     def test_provider_redirects_on_failure(self, mocked_request, mocked_redirect):
         transaction_id = 1234
         xid = "abc"
-        self.payment.attrs.xid = xid
+        self.payment.extra_data.xid = xid
 
         response = MagicMock()
         response.requestID = transaction_id

payments/mercadopago/__init__.py

@@ -74,7 +74,7 @@ def create_preference(self, payment: BasePayment):
         if payment.transaction_id:
             raise ValueError("This payment already has a preference.")
 
-        payment.attrs.external_reference = uuid4().hex
+        payment.extra_data.external_reference = uuid4().hex
 
         payload = {
             "auto_return": "all",
@@ -89,7 +89,7 @@ def create_preference(self, payment: BasePayment):
                 }
                 for item in payment.get_purchased_items()
             ],
-            "external_reference": payment.attrs.external_reference,
+            "external_reference": payment.extra_data.external_reference,
             "back_urls": {
                 "success": self.get_return_url(payment),
                 "pending": self.get_return_url(payment),
@@ -218,7 +218,7 @@ def poll_for_updates(self, payment: BasePayment):
         """
         data = self.client.payment().search(
             {
-                "external_reference": payment.attrs.external_reference,
+                "external_reference": payment.extra_data.external_reference,
             }
         )
 

payments/models.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import json
+import warnings
 from typing import Iterable
 from uuid import uuid4
 
@@ -80,7 +81,7 @@ class BasePayment(models.Model):
     billing_email = models.EmailField(blank=True)
     billing_phone = PhoneNumberField(blank=True)
     customer_ip_address = models.GenericIPAddressField(blank=True, null=True)
-    extra_data = models.TextField(blank=True, default="")
+    extra_data = models.JsonField(blank=True, default=dict)
     message = models.TextField(blank=True, default="")
     token = models.CharField(max_length=36, blank=True, default="")
     captured_amount = models.DecimalField(max_digits=9, decimal_places=2, default="0.0")
@@ -226,14 +227,18 @@ def refund(self, amount=None):
 
     @property
     def attrs(self):
-        """A JSON-serialised wrapper around `extra_data`.
-
-        This property exposes a a dict or list which is serialised into the `extra_data`
-        text field. Usage of this wrapper is preferred over accessing the underlying
-        field directly.
-
-        You may think of this as a `JSONField` which is saved to the `extra_data`
-        column.
-        """
-        # TODO: Deprecate in favour of JSONField when we drop support for django 2.2.
-        return PaymentAttributeProxy(self)
+        warnings.warn(
+            "Using BasePayment.attrs is deprecated. Use BasePayment.extra_data instead",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.extra_data
+
+    @attrs.setter
+    def attrs(self, value):
+        warnings.warn(
+            "Using BasePayment.attrs is deprecated. Use BasePayment.extra_data instead",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        self.extra_data = value

payments/paypal/__init__.py

@@ -249,7 +249,7 @@ def process_data(self, payment, request):
         except PaymentError:
             return redirect(failure_url)
         self.set_response_links(payment, executed_payment)
-        payment.attrs.payer_info = executed_payment["payer"]["payer_info"]
+        payment.extra_data.payer_info = executed_payment["payer"]["payer_info"]
         if self._capture:
             payment.captured_amount = payment.total
             payment.change_status(PaymentStatus.CONFIRMED)

payments/stripe/__init__.py

@@ -60,19 +60,19 @@ def capture(self, payment, amount=None):
         except stripe.InvalidRequestError as e:
             payment.change_status(PaymentStatus.REFUNDED)
             raise PaymentError("Payment already refunded") from e
-        payment.attrs.capture = json.dumps(charge)
+        payment.extra_data.capture = json.dumps(charge)
         return Decimal(amount) / 100
 
     def release(self, payment):
         charge = stripe.Charge.retrieve(payment.transaction_id)
         charge.refund()
-        payment.attrs.release = json.dumps(charge)
+        payment.extra_data.release = json.dumps(charge)
 
     def refund(self, payment, amount=None):
         amount = int((amount or payment.total) * 100)
         charge = stripe.Charge.retrieve(payment.transaction_id)
         charge.refund(amount=amount)
-        payment.attrs.refund = json.dumps(charge)
+        payment.extra_data.refund = json.dumps(charge)
         return Decimal(amount) / 100
 
 

payments/stripe/forms.py

@@ -87,7 +87,7 @@ def clean(self):
 
     def save(self):
         self.payment.transaction_id = self.charge.id
-        self.payment.attrs.charge = json.dumps(self.charge)
+        self.payment.extra_data.charge = json.dumps(self.charge)
         self.payment.change_status(PaymentStatus.PREAUTH)
         if self.provider._capture:
             self.payment.capture()

payments/test_core.py

@@ -44,10 +44,10 @@ class Payment(BasePayment):
 class TestBasePayment(TestCase):
     def test_payment_attributes(self):
         payment = Payment(extra_data='{"attr1": "test1", "attr2": "test2"}')
-        self.assertEqual(payment.attrs.attr1, "test1")
-        self.assertEqual(payment.attrs.attr2, "test2")
-        self.assertEqual(getattr(payment.attrs, "attr5", None), None)
-        self.assertEqual(hasattr(payment.attrs, "attr7"), False)
+        self.assertEqual(payment.extra_data.attr1, "test1")
+        self.assertEqual(payment.extra_data.attr2, "test2")
+        self.assertEqual(getattr(payment.extra_data, "attr5", None), None)
+        self.assertEqual(hasattr(payment.extra_data, "attr7"), False)
 
     def test_capture_with_wrong_status(self):
         payment = Payment(variant="default", status=PaymentStatus.WAITING)