refactor: cart_validation을 검증 항목별로 분리

Author: MU-Software

app/shop/serializers/cart_validation.py

@@ -0,0 +1,34 @@
+"""cart_validation 패키지 — 도메인별 파일 분리. 기존 `from shop.serializers.cart_validation import X` 경로 유지."""
+
+from shop.serializers.cart_validation._base import CustomerInfoCheckSerializer, OrderableCheckSerializerMode
+from shop.serializers.cart_validation.cart import CartOrderableCheckSerializer
+from shop.serializers.cart_validation.option import (
+    OptionOrderableCheckSerializer,
+    OptionOrderableCheckTypedDict,
+)
+from shop.serializers.cart_validation.product import (
+    ProductOrderableCheckAfterValidationDataType,
+    ProductOrderableCheckBeforeValidationDataType,
+    ProductOrderableCheckSerializer,
+)
+from shop.serializers.cart_validation.single_product_cart import (
+    CustomerInfoType,
+    SingleProductCartOrderableCheckDataType,
+    SingleProductCartOrderableCheckSerializer,
+)
+from shop.serializers.cart_validation.tag import TagOrderableCheckSerializer
+
+__all__ = [
+    "CartOrderableCheckSerializer",
+    "CustomerInfoCheckSerializer",
+    "CustomerInfoType",
+    "OptionOrderableCheckSerializer",
+    "OptionOrderableCheckTypedDict",
+    "OrderableCheckSerializerMode",
+    "ProductOrderableCheckAfterValidationDataType",
+    "ProductOrderableCheckBeforeValidationDataType",
+    "ProductOrderableCheckSerializer",
+    "SingleProductCartOrderableCheckDataType",
+    "SingleProductCartOrderableCheckSerializer",
+    "TagOrderableCheckSerializer",
+]

app/shop/serializers/cart_validation/__init__.py

@@ -0,0 +1,24 @@
+import enum
+
+from core.const.regex import ALLOW_ALL_PATTERN, PHONE_PATTERN
+from rest_framework import serializers
+from shop.order.models import CustomerInfo
+
+
+class CustomerInfoCheckSerializer(serializers.ModelSerializer):
+    """고객 정보가 Regex에 맞는지 확인합니다."""
+
+    name = serializers.RegexField(ALLOW_ALL_PATTERN, required=True, allow_null=False, allow_blank=False)
+    phone = serializers.RegexField(PHONE_PATTERN, required=True, allow_null=False, allow_blank=False)
+    email = serializers.EmailField(required=True, allow_null=False, allow_blank=False)
+    organization = serializers.RegexField(ALLOW_ALL_PATTERN, required=True, allow_null=False, allow_blank=True)
+
+    class Meta:
+        model = CustomerInfo
+        fields = ("name", "phone", "email", "organization")
+
+
+class OrderableCheckSerializerMode(str, enum.Enum):
+    ADD_SINGLE_PRODUCT_TO_CART = enum.auto()
+    CHECKOUT_SINGLE_PRODUCT = enum.auto()
+    CHECKOUT_CART = enum.auto()

app/shop/serializers/cart_validation/_base.py

@@ -0,0 +1,52 @@
+import typing
+
+from core.const.shop_error_messages import CartNotOrderableErrorMessages
+from rest_framework import serializers
+from shop.order.models import Order, OrderProductRelation
+from shop.payment_history.models import PaymentHistoryStatus
+from user.models import UserExt
+
+
+class CartOrderableCheckSerializer(serializers.Serializer):
+    """
+    장바구니가 주문 가능한지 확인합니다.
+    아래 조건에 해당될 경우 주문 불가능합니다.
+    - 이미 결제한 장바구니인 경우 주문 불가능
+    - 장바구니 내에 이미 결제한 상품이 있는 경우 주문 불가능
+    - 장바구니 내의 상품들 주문 금액 합계가 0원 미만이거나 100만원 이상인 경우 주문 불가능
+    """
+
+    cart = serializers.PrimaryKeyRelatedField(queryset=Order.objects.filter_has_no_payment_histories(), required=True)
+
+    class Meta:
+        fields = ("cart",)
+
+    def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
+        super().__init__(*args, **kwargs)
+        # 타인의 미결제 cart 로 결제 흐름 트리거를 방어 — request.user 의 cart 로만 lookup 한정.
+        request = self.context.get("request")
+        user = request.user if request is not None else None
+        self.fields["cart"].queryset = (
+            Order.objects.filter_has_no_payment_histories().filter(user=user)
+            if isinstance(user, UserExt)
+            else Order.objects.none()
+        )
+
+    def validate(self, data: dict) -> dict:
+        cart: Order = data["cart"]
+
+        # 이미 결제한 장바구니인 경우 주문 불가능
+        if cart.current_status != PaymentHistoryStatus.pending or cart.payment_histories.exists():
+            raise serializers.ValidationError(CartNotOrderableErrorMessages.ALREADY_ORDERED)
+
+        # 장바구니 내에 이미 결제한 상품이 있는 경우 주문 불가능
+        if cart.products.exclude(status=OrderProductRelation.OrderProductStatus.pending).exists():
+            raise serializers.ValidationError(CartNotOrderableErrorMessages.CONTAINS_PAID_PRODUCT)
+
+        # 장바구니 내의 상품들 주문 금액 합계가 0원 이하거나 100만원 이상인 경우 주문 불가능
+        if cart.first_paid_price <= 0:
+            raise serializers.ValidationError(CartNotOrderableErrorMessages.CART_PRICE_TOO_LOW)
+        if cart.first_paid_price >= 1_000_000:
+            raise serializers.ValidationError(CartNotOrderableErrorMessages.CART_PRICE_TOO_HIGH)
+
+        return data

app/shop/serializers/cart_validation/cart.py

@@ -0,0 +1,169 @@
+import re
+import typing
+import uuid
+
+from core.const.shop_error_messages import (
+    OptionGroupNotOrderableErrorMessages,
+    OptionNotOrderableErrorMessages,
+    SignInErrorMessages,
+)
+from core.serializer.nested_model_serializer import InstanceListSerializer
+from django.contrib.auth.models import AnonymousUser
+from rest_framework import request, serializers
+from shop.product.models import Option, OptionGroup, Product
+from shop.serializers.cart_validation._base import OrderableCheckSerializerMode
+from user.models import UserExt
+
+
+class OptionOrderableCheckTypedDict(typing.TypedDict):
+    product_option_group: OptionGroup
+    product_option: Option | None
+    custom_response: str | None
+
+
+class OptionOrderableCheckSerializer(serializers.Serializer):
+    """
+    장바구니에 담긴 상품의 옵션이 주문 가능한지 확인합니다.
+    아래 조건에 해당될 경우 주문 불가능합니다.
+
+    ==================== 상품 옵션 그룹 (OptionGroup) ====================
+    - 상품 옵션 중 필수 옵션이 매진된 경우 주문 불가능
+    - 옵션 그룹이 custom_response를 받는 경우, custom_response가 올바른 형식으로 입력되지 않은 경우 주문 불가능
+    - 옵션 그룹이 custom_response를 받지 않는 경우, option이 선택되지 않았거나 옵션 그룹에 속하지 않은 경우 주문 불가능
+
+    ==================== 상품 옵션 (Option) ====================
+    - 옵션의 재고가 없는 경우 주문 불가능
+    - 옵션의 최대 구매 수량이 정해져있으면, 해당 사용자가 이미 구매한 수량이 최대 구매 수량을 초과하는 경우 주문 불가능
+    - 고객이 옵션의 재고를 초과하여 옵션을 장바구니에 담으면 주문 불가능
+    """
+
+    product_option_group = serializers.PrimaryKeyRelatedField(
+        queryset=OptionGroup.objects.filter(deleted_at__isnull=True),
+        required=True,
+        allow_null=False,
+    )
+    product_option = serializers.PrimaryKeyRelatedField(
+        queryset=Option.objects.filter(deleted_at__isnull=True),
+        required=True,
+        allow_null=True,
+    )
+    custom_response = serializers.CharField(required=True, allow_null=True, allow_blank=True)
+
+    class Meta:
+        list_serializer_class = InstanceListSerializer
+        fields = "__all__"
+
+    @property
+    def validation_mode(self) -> OrderableCheckSerializerMode:
+        if not (mode := self.context.get("mode")):
+            return OrderableCheckSerializerMode.ADD_SINGLE_PRODUCT_TO_CART
+        return mode
+
+    @property
+    def group(self) -> OptionGroup | None:
+        group: OptionGroup | str | uuid.UUID | None = self.initial_data.get("product_option_group")
+        if not group:
+            return None
+        if isinstance(group, (str, uuid.UUID)):
+            return OptionGroup.objects.filter(pk=group).first()
+        return group
+
+    def validate_product_option_group(self, group: OptionGroup) -> OptionGroup:
+        # 상품 옵션 중 필수 옵션이 매진된 경우 주문 불가능
+        if not group.is_group_stock_available():
+            raise serializers.ValidationError(
+                OptionGroupNotOrderableErrorMessages.SOLDOUT.format(group.product.name, group.name)
+            )
+
+        return group
+
+    def validate_product_option(self, option: Option | None) -> Option | None:
+        user: UserExt | AnonymousUser = typing.cast(request.Request, self.context["request"]).user
+        if not isinstance(user, UserExt):
+            raise serializers.ValidationError(SignInErrorMessages.USER_NOT_SIGNED_IN)
+
+        if not self.group or self.group.is_custom_response:
+            return None
+
+        # 옵션 그룹이 custom_response를 받지 않는 경우, option이 선택되지 않았거나 옵션 그룹에 속하지 않은 경우 주문 불가능
+        if not (option and option.group_id == self.group.id):
+            raise serializers.ValidationError(OptionGroupNotOrderableErrorMessages.OPTION_NOT_SELECTED)
+
+        product: Product = option.group.product
+        if option.leftover_stock is not None:
+            # 옵션의 재고가 없는 경우 주문 불가능
+            if option.leftover_stock <= 0:
+                raise serializers.ValidationError(
+                    OptionNotOrderableErrorMessages.SOLDOUT.format(product.name, option.name)
+                )
+
+            # 고객이 옵션의 재고를 초과하여 옵션을 장바구니에 담으면 주문 불가능
+            user_option_cart_included_count = option.get_user_taken_stock_count(
+                user=user,
+                include_cart=True,
+                include_purchased=False,
+            )
+            match self.validation_mode:
+                case OrderableCheckSerializerMode.ADD_SINGLE_PRODUCT_TO_CART:
+                    user_option_cart_included_count += 1
+                case OrderableCheckSerializerMode.CHECKOUT_SINGLE_PRODUCT:
+                    # 이미 재고 체크를 위에서 했으므로, 단일 주문의 경우 확인할 필요가 없습니다.
+                    user_option_cart_included_count = 0
+                case OrderableCheckSerializerMode.CHECKOUT_CART:
+                    pass
+                case _:
+                    raise ValueError("Invalid validation mode")
+
+            if user_option_cart_included_count > option.leftover_stock:
+                raise serializers.ValidationError(
+                    OptionNotOrderableErrorMessages.TOO_MUCH_CART_OPTION.format(product.name, option.name)
+                )
+
+        # 옵션의 최대 구매 수량이 정해져있으면, 해당 사용자가 이미 구매한 수량이 최대 구매 수량을 초과하는 경우 주문 불가능
+        if option.max_quantity_per_user > 0:  # 0 = 무제한 sentinel
+            match self.validation_mode:
+                case OrderableCheckSerializerMode.ADD_SINGLE_PRODUCT_TO_CART:
+                    user_option_taken_count = (
+                        option.get_user_taken_stock_count(
+                            user=user,
+                            include_cart=True,
+                            include_purchased=True,
+                        )
+                        + 1
+                    )
+                case OrderableCheckSerializerMode.CHECKOUT_SINGLE_PRODUCT:
+                    user_option_taken_count = (
+                        option.get_user_taken_stock_count(
+                            user=user,
+                            include_cart=False,
+                            include_purchased=True,
+                        )
+                        + 1
+                    )
+                case OrderableCheckSerializerMode.CHECKOUT_CART:
+                    user_option_taken_count = option.get_user_taken_stock_count(
+                        user=user,
+                        include_cart=True,
+                        include_purchased=True,
+                    )
+                case _:
+                    raise ValueError("Invalid validation mode")
+
+            if user_option_taken_count > option.max_quantity_per_user:
+                raise serializers.ValidationError(
+                    OptionNotOrderableErrorMessages.ALREADY_ORDERED_TOO_MUCH.format(product.name, option.name)
+                )
+
+        return option
+
+    def validate_custom_response(self, custom_response: str | None) -> str | None:
+        if not (self.group and self.group.is_custom_response):
+            return None
+
+        # 옵션 그룹이 custom_response를 받는 경우, custom_response가 올바른 형식으로 입력되지 않은 경우 주문 불가능
+        if self.group.custom_response_pattern and not re.match(
+            self.group.custom_response_pattern, custom_response or ""
+        ):
+            raise serializers.ValidationError(OptionGroupNotOrderableErrorMessages.CUSTOM_RESPONSE_PATTERN_MISMATCH)
+
+        return custom_response