fixup! ✨(backend) add agreement batch order viewset and serializer

Author: jonathanreveille

src/backend/joanie/core/api/client/__init__.py

@@ -1661,16 +1661,16 @@ class GenericAgreementViewSet(
     filterset_class = filters.AgreementFilter
     ordering = ["-student_signed_on", "-created_on"]
     queryset = (
-        models.Contract.objects.exclude(batch_orders__state=enums.ORDER_STATE_CANCELED)
+        models.Contract.objects.exclude(batch_order__state=enums.ORDER_STATE_CANCELED)
         .select_related(
             "definition",
             "organization_signatory",
         )
         .prefetch_related(
-            "batch_orders__organization",
-            "batch_orders__offering__course",
-            "batch_orders__owner",
-            "batch_orders__offering__product",
+            "batch_order__organization",
+            "batch_order__offering__course",
+            "batch_order__owner",
+            "batch_order__offering__product",
         )
     )
 
@@ -1693,7 +1693,7 @@ class NestedOrganizationAgreementViewSet(NestedGenericViewSet, GenericAgreementV
     offering id.
     """
 
-    lookup_fields = ["batch_orders__organization__pk", "pk"]
+    lookup_fields = ["batch_order__organization__pk", "pk"]
     lookup_url_kwargs = ["organization_id", "pk"]
 
     def _lookup_by_organization_code_or_pk(self):
@@ -1704,7 +1704,7 @@ def _lookup_by_organization_code_or_pk(self):
         try:
             uuid.UUID(self.kwargs["organization_id"])
         except ValueError:
-            self.lookup_fields[0] = "batch_orders__organization__code__iexact"
+            self.lookup_fields[0] = "batch_order__organization__code__iexact"
 
     def initial(self, request, *args, **kwargs):
         """
@@ -1726,7 +1726,7 @@ def get_queryset(self):
         )
 
         additional_filter = {
-            "batch_orders__organization__accesses__user__username": username,
+            "batch_order__organization__accesses__user__username": username,
         }
 
         return queryset.filter(**additional_filter)

src/backend/joanie/core/filters/client/__init__.py

@@ -184,7 +184,7 @@ class AgreementFilter(filters.FilterSet):
         method="filter_signature_state",
         choices=enums.CONTRACT_SIGNATURE_STATE_FILTER_CHOICES,
     )
-    organization_id = filters.UUIDFilter(field_name="batch_orders__organization__id")
+    organization_id = filters.UUIDFilter(field_name="batch_order__organization__id")
     offering_id = filters.UUIDFilter(method="filter_offering_id")
 
     class Meta:
@@ -219,11 +219,11 @@ def filter_offering_id(self, queryset, _name, value):
             return queryset.none()
 
         return queryset.filter(
-            batch_orders__relation__course_id=offering.course_id,
-            batch_orders__relation__product_id=offering.product_id,
-            batch_orders__organization__in=offering.organizations.only(
-                "pk"
-            ).values_list("pk", flat=True),
+            batch_order__relation__course_id=offering.course_id,
+            batch_order__relation__product_id=offering.product_id,
+            batch_order__organization__in=offering.organizations.only("pk").values_list(
+                "pk", flat=True
+            ),
         )
 
 

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

@@ -549,7 +549,7 @@ def get_total_currency(self, *args, **kwargs) -> str:
 class AgreementBatchOrderSerializer(AbilitiesModelSerializer):
     """Small serializer for Contracts models related to Batch Orders (agreements)"""
 
-    batch_order = serializers.SerializerMethodField(read_only=True)
+    batch_order = BatchOrderLightSerializer(read_only=True)
 
     class Meta:
         model = models.Contract
@@ -559,13 +559,6 @@ class Meta:
         ]
         read_only_fields = fields
 
-    def get_batch_order(self, instance):
-        """
-        Returns batch order's information through the related name of the contract model
-        """
-        batch_order = instance.batch_orders.first()
-        return BatchOrderLightSerializer(batch_order, context=self.context).data
-
 
 class QuoteDefinitionSerializer(serializers.ModelSerializer):
     """Read only serializer for QuoteDefinition model."""

src/backend/joanie/tests/core/api/organizations/test_api_organizations_agreements.perf.yml

@@ -1,8 +1,8 @@
 OrganizationAgreementApiTest.test_api_organizations_agreement_list_by_signature_state:
 - db: SELECT DISTINCT "joanie_contract"."id" FROM "joanie_contract" ORDER BY "joanie_contract"."id" ASC
-- db: 'SELECT COUNT(*) AS "__count" FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."id" = "joanie_batch_order"."contract_id") INNER JOIN "joanie_batch_order" T4 ON ("joanie_contract"."id" = T4."contract_id") INNER JOIN "joanie_organization" T5 ON (T4."organization_id" = T5."id") INNER JOIN "joanie_organization_access" ON (T5."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") WHERE (NOT (EXISTS(SELECT # AS "a" FROM "joanie_batch_order" U1 WHERE (U1."state" = # AND U1."contract_id" = ("joanie_contract"."id")) LIMIT #)) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = # AND "joanie_contract"."organization_signed_on" IS # AND "joanie_contract"."student_signed_on" IS #)'
-- db: 'SELECT ... FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."id" = "joanie_batch_order"."contract_id") INNER JOIN "joanie_batch_order" T4 ON ("joanie_contract"."id" = T4."contract_id") INNER JOIN "joanie_organization" T5 ON (T4."organization_id" = T5."id") INNER JOIN "joanie_organization_access" ON (T5."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") INNER JOIN "joanie_contract_definition" ON ("joanie_contract"."definition_id" = "joanie_contract_definition"."id") LEFT OUTER JOIN "joanie_user" T9 ON ("joanie_contract"."organization_signatory_id" = T9."id") WHERE (NOT (EXISTS(SELECT # AS "a" FROM "joanie_batch_order" U1 WHERE (U1."state" = # AND U1."contract_id" = ("joanie_contract"."id")) LIMIT #)) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = # AND "joanie_contract"."organization_signed_on" IS # AND "joanie_contract"."student_signed_on" IS #) ORDER BY "joanie_contract"."created_on" DESC LIMIT #'
-- db: SELECT ... FROM "joanie_batch_order" WHERE "joanie_batch_order"."contract_id" IN (#::uuid) ORDER BY "joanie_batch_order"."created_on" ASC
+- db: 'SELECT COUNT(*) AS "__count" FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."batch_order_id" = "joanie_batch_order"."id") INNER JOIN "joanie_organization" ON ("joanie_batch_order"."organization_id" = "joanie_organization"."id") INNER JOIN "joanie_organization_access" ON ("joanie_organization"."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") WHERE (NOT ("joanie_batch_order"."state" = # AND "joanie_batch_order"."state" IS NOT NULL) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = # AND "joanie_contract"."organization_signed_on" IS # AND "joanie_contract"."student_signed_on" IS #)'
+- db: 'SELECT ... FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."batch_order_id" = "joanie_batch_order"."id") INNER JOIN "joanie_organization" ON ("joanie_batch_order"."organization_id" = "joanie_organization"."id") INNER JOIN "joanie_organization_access" ON ("joanie_organization"."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") INNER JOIN "joanie_contract_definition" ON ("joanie_contract"."definition_id" = "joanie_contract_definition"."id") LEFT OUTER JOIN "joanie_user" T7 ON ("joanie_contract"."organization_signatory_id" = T7."id") WHERE (NOT ("joanie_batch_order"."state" = # AND "joanie_batch_order"."state" IS NOT NULL) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = # AND "joanie_contract"."organization_signed_on" IS # AND "joanie_contract"."student_signed_on" IS #) ORDER BY "joanie_contract"."created_on" DESC LIMIT #'
+- db: SELECT ... FROM "joanie_batch_order" WHERE "joanie_batch_order"."id" IN (#::uuid) ORDER BY "joanie_batch_order"."created_on" ASC
 - db: SELECT ... FROM "joanie_organization" WHERE "joanie_organization"."id" IN (#::uuid) ORDER BY "joanie_organization"."created_on" DESC
 - db: 'SELECT ... FROM "joanie_course_product_relation" WHERE "joanie_course_product_relation"."id" = #::uuid LIMIT #'
 - db: SELECT ... FROM "joanie_course" WHERE "joanie_course"."id" IN (#::uuid) ORDER BY "joanie_course"."code" ASC
@@ -126,9 +126,9 @@ OrganizationAgreementApiTest.test_api_organizations_agreement_retrieve_with_acce
 OrganizationAgreementApiTest.test_api_organizations_agreements_list_by_offering:
 - db: SELECT DISTINCT "joanie_contract"."id" FROM "joanie_contract" ORDER BY "joanie_contract"."id" ASC
 - db: 'SELECT ... FROM "joanie_course_product_relation" INNER JOIN "joanie_course_product_relation_organizations" ON ("joanie_course_product_relation"."id" = "joanie_course_product_relation_organizations"."courseproductrelation_id") WHERE ("joanie_course_product_relation"."id" = #::uuid AND "joanie_course_product_relation_organizations"."organization_id" IN (#::uuid)) LIMIT #'
-- db: 'SELECT COUNT(*) AS "__count" FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."id" = "joanie_batch_order"."contract_id") INNER JOIN "joanie_batch_order" T4 ON ("joanie_contract"."id" = T4."contract_id") INNER JOIN "joanie_organization" T5 ON (T4."organization_id" = T5."id") INNER JOIN "joanie_organization_access" ON (T5."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") INNER JOIN "joanie_batch_order" T8 ON ("joanie_contract"."id" = T8."contract_id") INNER JOIN "joanie_course_product_relation" ON (T8."relation_id" = "joanie_course_product_relation"."id") WHERE (NOT (EXISTS(SELECT # AS "a" FROM "joanie_batch_order" U1 WHERE (U1."state" = # AND U1."contract_id" = ("joanie_contract"."id")) LIMIT #)) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = # AND T8."organization_id" IN (SELECT U0."id" FROM "joanie_organization" U0 INNER JOIN "joanie_course_product_relation_organizations" U1 ON (U0."id" = U1."organization_id") WHERE U1."courseproductrelation_id" = #::uuid) AND "joanie_course_product_relation"."course_id" = #::uuid AND "joanie_course_product_relation"."product_id" = #::uuid)'
-- db: 'SELECT ... FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."id" = "joanie_batch_order"."contract_id") INNER JOIN "joanie_batch_order" T4 ON ("joanie_contract"."id" = T4."contract_id") INNER JOIN "joanie_organization" T5 ON (T4."organization_id" = T5."id") INNER JOIN "joanie_organization_access" ON (T5."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") INNER JOIN "joanie_batch_order" T8 ON ("joanie_contract"."id" = T8."contract_id") INNER JOIN "joanie_course_product_relation" ON (T8."relation_id" = "joanie_course_product_relation"."id") INNER JOIN "joanie_contract_definition" ON ("joanie_contract"."definition_id" = "joanie_contract_definition"."id") LEFT OUTER JOIN "joanie_user" T14 ON ("joanie_contract"."organization_signatory_id" = T14."id") WHERE (NOT (EXISTS(SELECT # AS "a" FROM "joanie_batch_order" U1 WHERE (U1."state" = # AND U1."contract_id" = ("joanie_contract"."id")) LIMIT #)) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = # AND T8."organization_id" IN (SELECT U0."id" FROM "joanie_organization" U0 INNER JOIN "joanie_course_product_relation_organizations" U1 ON (U0."id" = U1."organization_id") WHERE U1."courseproductrelation_id" = #::uuid) AND "joanie_course_product_relation"."course_id" = #::uuid AND "joanie_course_product_relation"."product_id" = #::uuid) ORDER BY "joanie_contract"."created_on" DESC LIMIT #'
-- db: SELECT ... FROM "joanie_batch_order" WHERE "joanie_batch_order"."contract_id" IN (#::uuid) ORDER BY "joanie_batch_order"."created_on" ASC
+- db: 'SELECT COUNT(*) AS "__count" FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."batch_order_id" = "joanie_batch_order"."id") INNER JOIN "joanie_organization" ON ("joanie_batch_order"."organization_id" = "joanie_organization"."id") INNER JOIN "joanie_organization_access" ON ("joanie_organization"."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") INNER JOIN "joanie_course_product_relation" ON ("joanie_batch_order"."relation_id" = "joanie_course_product_relation"."id") WHERE (NOT ("joanie_batch_order"."state" = # AND "joanie_batch_order"."state" IS NOT NULL) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = # AND "joanie_batch_order"."organization_id" IN (SELECT U0."id" FROM "joanie_organization" U0 INNER JOIN "joanie_course_product_relation_organizations" U1 ON (U0."id" = U1."organization_id") WHERE U1."courseproductrelation_id" = #::uuid) AND "joanie_course_product_relation"."course_id" = #::uuid AND "joanie_course_product_relation"."product_id" = #::uuid)'
+- db: 'SELECT ... FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."batch_order_id" = "joanie_batch_order"."id") INNER JOIN "joanie_organization" ON ("joanie_batch_order"."organization_id" = "joanie_organization"."id") INNER JOIN "joanie_organization_access" ON ("joanie_organization"."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") INNER JOIN "joanie_course_product_relation" ON ("joanie_batch_order"."relation_id" = "joanie_course_product_relation"."id") INNER JOIN "joanie_contract_definition" ON ("joanie_contract"."definition_id" = "joanie_contract_definition"."id") LEFT OUTER JOIN "joanie_user" T10 ON ("joanie_contract"."organization_signatory_id" = T10."id") WHERE (NOT ("joanie_batch_order"."state" = # AND "joanie_batch_order"."state" IS NOT NULL) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = # AND "joanie_batch_order"."organization_id" IN (SELECT U0."id" FROM "joanie_organization" U0 INNER JOIN "joanie_course_product_relation_organizations" U1 ON (U0."id" = U1."organization_id") WHERE U1."courseproductrelation_id" = #::uuid) AND "joanie_course_product_relation"."course_id" = #::uuid AND "joanie_course_product_relation"."product_id" = #::uuid) ORDER BY "joanie_contract"."created_on" DESC LIMIT #'
+- db: SELECT ... FROM "joanie_batch_order" WHERE "joanie_batch_order"."id" IN (#::uuid) ORDER BY "joanie_batch_order"."created_on" ASC
 - db: SELECT ... FROM "joanie_organization" WHERE "joanie_organization"."id" IN (#::uuid) ORDER BY "joanie_organization"."created_on" DESC
 - db: 'SELECT ... FROM "joanie_course_product_relation" WHERE "joanie_course_product_relation"."id" = #::uuid LIMIT #'
 - db: SELECT ... FROM "joanie_course" WHERE "joanie_course"."id" IN (#::uuid) ORDER BY "joanie_course"."code" ASC
@@ -355,9 +355,9 @@ OrganizationAgreementApiTest.test_api_organizations_agreements_list_filter_by_wi
 - db: 'SELECT "joanie_organization_access"."role" FROM "joanie_organization_access" WHERE ("joanie_organization_access"."organization_id" = #::uuid AND "joanie_organization_access"."user_id" = #::uuid) ORDER BY "joanie_organization_access"."created_on" DESC LIMIT #'
 OrganizationAgreementApiTest.test_api_organizations_agreements_list_with_accesses:
 - db: SELECT DISTINCT "joanie_contract"."id" FROM "joanie_contract" ORDER BY "joanie_contract"."id" ASC
-- db: 'SELECT COUNT(*) AS "__count" FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."id" = "joanie_batch_order"."contract_id") INNER JOIN "joanie_batch_order" T4 ON ("joanie_contract"."id" = T4."contract_id") INNER JOIN "joanie_organization" T5 ON (T4."organization_id" = T5."id") INNER JOIN "joanie_organization_access" ON (T5."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") WHERE (NOT (EXISTS(SELECT # AS "a" FROM "joanie_batch_order" U1 WHERE (U1."state" = # AND U1."contract_id" = ("joanie_contract"."id")) LIMIT #)) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = #)'
-- db: 'SELECT ... FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."id" = "joanie_batch_order"."contract_id") INNER JOIN "joanie_batch_order" T4 ON ("joanie_contract"."id" = T4."contract_id") INNER JOIN "joanie_organization" T5 ON (T4."organization_id" = T5."id") INNER JOIN "joanie_organization_access" ON (T5."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") INNER JOIN "joanie_contract_definition" ON ("joanie_contract"."definition_id" = "joanie_contract_definition"."id") LEFT OUTER JOIN "joanie_user" T9 ON ("joanie_contract"."organization_signatory_id" = T9."id") WHERE (NOT (EXISTS(SELECT # AS "a" FROM "joanie_batch_order" U1 WHERE (U1."state" = # AND U1."contract_id" = ("joanie_contract"."id")) LIMIT #)) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = #) ORDER BY "joanie_contract"."created_on" DESC LIMIT #'
-- db: SELECT ... FROM "joanie_batch_order" WHERE "joanie_batch_order"."contract_id" IN (...) ORDER BY "joanie_batch_order"."created_on" ASC
+- db: 'SELECT COUNT(*) AS "__count" FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."batch_order_id" = "joanie_batch_order"."id") INNER JOIN "joanie_organization" ON ("joanie_batch_order"."organization_id" = "joanie_organization"."id") INNER JOIN "joanie_organization_access" ON ("joanie_organization"."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") WHERE (NOT ("joanie_batch_order"."state" = # AND "joanie_batch_order"."state" IS NOT NULL) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = #)'
+- db: 'SELECT ... FROM "joanie_contract" INNER JOIN "joanie_batch_order" ON ("joanie_contract"."batch_order_id" = "joanie_batch_order"."id") INNER JOIN "joanie_organization" ON ("joanie_batch_order"."organization_id" = "joanie_organization"."id") INNER JOIN "joanie_organization_access" ON ("joanie_organization"."id" = "joanie_organization_access"."organization_id") INNER JOIN "joanie_user" ON ("joanie_organization_access"."user_id" = "joanie_user"."id") INNER JOIN "joanie_contract_definition" ON ("joanie_contract"."definition_id" = "joanie_contract_definition"."id") LEFT OUTER JOIN "joanie_user" T7 ON ("joanie_contract"."organization_signatory_id" = T7."id") WHERE (NOT ("joanie_batch_order"."state" = # AND "joanie_batch_order"."state" IS NOT NULL) AND "joanie_batch_order"."organization_id" = #::uuid AND "joanie_user"."username" = #) ORDER BY "joanie_contract"."created_on" DESC LIMIT #'
+- db: SELECT ... FROM "joanie_batch_order" WHERE "joanie_batch_order"."id" IN (...) ORDER BY "joanie_batch_order"."created_on" ASC
 - db: SELECT ... FROM "joanie_organization" WHERE "joanie_organization"."id" IN (#::uuid) ORDER BY "joanie_organization"."created_on" DESC
 - db: 'SELECT ... FROM "joanie_course_product_relation" WHERE "joanie_course_product_relation"."id" = #::uuid LIMIT #'
 - db: 'SELECT ... FROM "joanie_course_product_relation" WHERE "joanie_course_product_relation"."id" = #::uuid LIMIT #'