♻️(backend) refactor batch order serializers for contract field

Since we have changed we build the relation between batch order
and a contract, we needed to update the serializers for the client
and admin API that it returns the same information as before.

Author: jonathanreveille

src/backend/joanie/core/serializers/admin.py

@@ -1774,7 +1774,7 @@ class AdminBatchOrderSerializer(serializers.ModelSerializer):
         slug_field="id",
         write_only=False,
     )
-    contract = AdminContractSerializer(read_only=True)
+    contract = serializers.SerializerMethodField(read_only=True)
     organization = AdminOrganizationLightSerializer(read_only=True)
     main_invoice_reference = serializers.SlugRelatedField(
         read_only=True, slug_field="reference", source="main_invoice"
@@ -1855,7 +1855,7 @@ class Meta:
             "total",
             "currency",
             "main_invoice_reference",
-            "contract_id",
+            "contract",
             "offering_rules",
             "vouchers",
             "quote",
@@ -1872,6 +1872,12 @@ def get_vouchers(self, instance) -> list:
         """Return the voucher codes generated"""
         return instance.vouchers
 
+    def get_contract(self, instance):
+        """Return serialized information of the contract related to the batch order"""
+        if contract := getattr(instance, "contract", None):
+            return AdminContractSerializer(contract).data
+        return None
+
     def to_internal_value(self, data):
         """
         Override to ensure that the 'offering' field is renamed to 'relation'

src/backend/joanie/core/serializers/client.py

@@ -1550,6 +1550,7 @@ class BatchOrderSerializer(serializers.ModelSerializer):
         required=False,
         read_only=True,
     )
+    contract_id = serializers.SerializerMethodField(read_only=True)
     quote = QuoteLightSerializer(read_only=True)
     payment_method = serializers.ChoiceField(
         choices=enums.BATCH_ORDER_PAYMENT_METHOD_CHOICES,
@@ -1633,6 +1634,12 @@ def get_currency(self, *args, **kwargs) -> str:
         """
         return settings.DEFAULT_CURRENCY
 
+    def get_contract_id(self, instance):
+        """Return serialized contract id related to batch order"""
+        if contract := getattr(instance, "contract", None):
+            return str(contract.id)
+        return None
+
     def to_internal_value(self, data):
         """
         Override to ensure that the 'offering' field is renamed to 'relation'

src/backend/joanie/tests/core/api/admin/batch_order/test_read_detail.py

@@ -126,7 +126,7 @@ def test_api_admin_read_detail_batch_order_with_quote(self):
             payment_method=enums.BATCH_ORDER_WITH_BANK_TRANSFER,
         )
         batch_order.freeze_total(Decimal("100.00"))
-
+        batch_order.refresh_from_db()
         response = self.client.get(f"/api/v1.0/admin/batch-orders/{batch_order.id}/")
 
         self.assertStatusCodeEqual(response, HTTPStatus.OK)

src/backend/joanie/tests/core/api/batch_order/test_read_detail.perf.yml

@@ -1,5 +1,5 @@
 BatchOrderReadDetailAPITest.test_api_batch_order_read_detail_authenticated:
-- db: 'SELECT ... FROM "joanie_batch_order" INNER JOIN "joanie_user" ON ("joanie_batch_order"."owner_id" = "joanie_user"."id") INNER JOIN "joanie_course_product_relation" ON ("joanie_batch_order"."relation_id" = "joanie_course_product_relation"."id") LEFT OUTER JOIN "joanie_organization" ON ("joanie_batch_order"."organization_id" = "joanie_organization"."id") LEFT OUTER JOIN "joanie_contract" ON ("joanie_batch_order"."contract_id" = "joanie_contract"."id") WHERE ("joanie_user"."username" = # AND "joanie_batch_order"."id" = #::uuid) LIMIT #'
+- db: 'SELECT ... FROM "joanie_batch_order" INNER JOIN "joanie_user" ON ("joanie_batch_order"."owner_id" = "joanie_user"."id") INNER JOIN "joanie_course_product_relation" ON ("joanie_batch_order"."relation_id" = "joanie_course_product_relation"."id") LEFT OUTER JOIN "joanie_organization" ON ("joanie_batch_order"."organization_id" = "joanie_organization"."id") LEFT OUTER JOIN "joanie_contract" ON ("joanie_batch_order"."id" = "joanie_contract"."batch_order_id") WHERE ("joanie_user"."username" = # AND "joanie_batch_order"."id" = #::uuid) LIMIT #'
 - db: 'SELECT ... FROM "joanie_user" WHERE "joanie_user"."id" = #::uuid LIMIT #'
 - db: 'SELECT ... FROM "joanie_course" WHERE "joanie_course"."id" = #::uuid LIMIT #'
 - cache|get: parler.core.CourseTranslation.#.en-us

src/backend/joanie/tests/core/api/batch_order/test_read_list.perf.yml

@@ -1,6 +1,6 @@
 BatchOrderReadListAPITest.test_api_batch_order_read_authenticated_get_list:
 - db: 'SELECT COUNT(*) AS "__count" FROM "joanie_batch_order" INNER JOIN "joanie_user" ON ("joanie_batch_order"."owner_id" = "joanie_user"."id") WHERE "joanie_user"."username" = #'
-- db: 'SELECT ... FROM "joanie_batch_order" INNER JOIN "joanie_user" ON ("joanie_batch_order"."owner_id" = "joanie_user"."id") INNER JOIN "joanie_course_product_relation" ON ("joanie_batch_order"."relation_id" = "joanie_course_product_relation"."id") LEFT OUTER JOIN "joanie_organization" ON ("joanie_batch_order"."organization_id" = "joanie_organization"."id") LEFT OUTER JOIN "joanie_contract" ON ("joanie_batch_order"."contract_id" = "joanie_contract"."id") WHERE "joanie_user"."username" = # ORDER BY "joanie_batch_order"."created_on" ASC LIMIT #'
+- db: 'SELECT ... FROM "joanie_batch_order" INNER JOIN "joanie_user" ON ("joanie_batch_order"."owner_id" = "joanie_user"."id") INNER JOIN "joanie_course_product_relation" ON ("joanie_batch_order"."relation_id" = "joanie_course_product_relation"."id") LEFT OUTER JOIN "joanie_organization" ON ("joanie_batch_order"."organization_id" = "joanie_organization"."id") LEFT OUTER JOIN "joanie_contract" ON ("joanie_batch_order"."id" = "joanie_contract"."batch_order_id") WHERE "joanie_user"."username" = # ORDER BY "joanie_batch_order"."created_on" ASC LIMIT #'
 - db: 'SELECT ... FROM "joanie_user" WHERE "joanie_user"."id" = #::uuid LIMIT #'
 - db: 'SELECT ... FROM "joanie_course" WHERE "joanie_course"."id" = #::uuid LIMIT #'
 - cache|get: parler.core.CourseTranslation.#.en-us

src/backend/joanie/tests/swagger/admin-swagger.json

@@ -6405,11 +6405,7 @@
                         "readOnly": true
                     },
                     "contract": {
-                        "allOf": [
-                            {
-                                "$ref": "#/components/schemas/AdminContract"
-                            }
-                        ],
+                        "type": "string",
                         "readOnly": true
                     },
                     "company_name": {

src/backend/joanie/tests/swagger/swagger.json

@@ -5670,9 +5670,6 @@
                     },
                     "contract_id": {
                         "type": "string",
-                        "format": "uuid",
-                        "description": "contract of type convention",
-                        "nullable": true,
                         "readOnly": true
                     },
                     "company_name": {