Ensure method is allowed and defined

Author: tonisvain

drf_sideloading/mixins.py

@@ -7,6 +7,7 @@
 from django.utils.translation import gettext_lazy as _
 from rest_framework.exceptions import ValidationError
 from rest_framework.generics import get_object_or_404
+from rest_framework.mixins import RetrieveModelMixin, ListModelMixin
 from rest_framework.response import Response
 from rest_framework.serializers import ListSerializer
 
@@ -152,8 +153,17 @@ def get_sideloading_serializer_context(self):
     # modified DRF methods
 
     def retrieve(self, request, *args, **kwargs):
+        if not isinstance(self, RetrieveModelMixin):
+            # The viewset does not have RetrieveModelMixin and therefore the method is not allowed
+            return self.http_method_not_allowed(request, *args, **kwargs)
+
         if self.sideloading_query_param_name not in request.query_params:
-            return super().retrieve(request, *args, **kwargs)
+            try:
+                return super().retrieve(request=request, *args, **kwargs)
+            except AttributeError:
+                # self.retrieve() method was not declared before this mixin.
+                # Make sure the SideloadableRelationsMixin is defined higher than RetrieveModelMixin.
+                return self.http_method_not_allowed(request, *args, **kwargs)
 
         (
             sideloading_serializer_class,
@@ -166,7 +176,12 @@ def retrieve(self, request, *args, **kwargs):
         ) = self.get_sideloading_variables_from_serializer(request=request)
 
         if not relations_to_sideload:
-            return super().retrieve(request, *args, **kwargs)
+            try:
+                return super().retrieve(request=request, *args, **kwargs)
+            except AttributeError:
+                # self.retrieve() method was not declared before this mixin.
+                # Make sure the SideloadableRelationsMixin is defined higher than RetrieveModelMixin.
+                return self.http_method_not_allowed(request, *args, **kwargs)
 
         # return object with sideloading serializer
         queryset, relations_sources = self.get_sideloadable_object_as_queryset(
@@ -189,8 +204,17 @@ def retrieve(self, request, *args, **kwargs):
         return Response(serializer.data)
 
     def list(self, request, *args, **kwargs):
+        if not isinstance(self, ListModelMixin):
+            # The viewset does not have ListModelMixin and therefore the method is not allowed
+            return self.http_method_not_allowed(request, *args, **kwargs)
+
         if request.method != "GET" or self.sideloading_query_param_name not in request.query_params:
-            return super().list(request, *args, **kwargs)
+            try:
+                return super().list(request=request, *args, **kwargs)
+            except AttributeError:
+                # self.list() method was not declared before this mixin.
+                # Make sure the SideloadableRelationsMixin is defined higher than ListModelMixin.
+                return self.http_method_not_allowed(request, *args, **kwargs)
 
         (
             sideloading_serializer_class,
@@ -203,7 +227,12 @@ def list(self, request, *args, **kwargs):
         ) = self.get_sideloading_variables_from_serializer(request=request)
 
         if not relations_to_sideload:
-            return super().list(request, *args, **kwargs)
+            try:
+                return super().list(request=request, *args, **kwargs)
+            except AttributeError:
+                # self.list() method was not declared before this mixin.
+                # Make sure the SideloadableRelationsMixin is defined higher than ListModelMixin.
+                return self.http_method_not_allowed(request, *args, **kwargs)
 
         # After this `relations_to_sideload` is safe to use
         queryset = self.get_queryset()

tests/test_products_api.py

@@ -883,6 +883,66 @@ class Meta:
     #         )
 
 
+class TestDrfSideloadingWithoutListModelMixin(BaseTestCase):
+    def test_list(self):
+        response = self.client.get(
+            path=reverse("productretreiveonly-list"),
+            data={"sideload": "categories"},
+            **self.DEFAULT_HEADERS,
+        )
+        self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED)
+
+    def test_detail(self):
+        response = self.client.get(
+            path=reverse("productretreiveonly-detail", args=[self.product1.id]),
+            data={"sideload": "categories"},
+            **self.DEFAULT_HEADERS,
+        )
+        self.assertEqual(response.status_code, status.HTTP_200_OK, response.json())
+
+
+class TestDrfSideloadingWithoutRetreiveModelMixin(BaseTestCase):
+    def test_list(self):
+        response = self.client.get(
+            path=reverse("productlistonly-list"),
+            data={"sideload": "categories"},
+            **self.DEFAULT_HEADERS,
+        )
+        self.assertEqual(response.status_code, status.HTTP_200_OK, response.json())
+
+    def test_detail(self):
+        response = self.client.get(
+            path=reverse("productlistonly-detail", args=[self.product1.id]),
+            data={"sideload": "categories"},
+            **self.DEFAULT_HEADERS,
+        )
+        self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED)
+
+
+class TestDrfSideloadingListModelMixinAfterSideloading(BaseTestCase):
+    # in case the DRF views are added after sideloading,
+    # the list and retreive methods will be overwritten and no sideloading happens.
+
+    def test_list(self):
+        response = self.client.get(
+            path=reverse("productwrongmixinorder-list"),
+            data={"sideload": "categories,suppliers,filtered_suppliers,partners"},
+            **self.DEFAULT_HEADERS,
+        )
+        self.assertEqual(response.status_code, status.HTTP_200_OK, response.json())
+        self.assertIsInstance(response.json(), list)
+
+    def test_detail(self):
+        response = self.client.get(
+            path=reverse("productwrongmixinorder-detail", args=[self.product1.id]),
+            data={"sideload": "categories,suppliers,filtered_suppliers,partners"},
+            **self.DEFAULT_HEADERS,
+        )
+        self.assertEqual(response.status_code, status.HTTP_200_OK, response.json())
+        self.assertIsInstance(response.json(), dict)
+        self.assertListEqual(["name", "category", "supplier", "partners"], list(response.json().keys()))
+
+
 class TestDrfSideloadingBrowsableApiPermissions(BaseTestCase):
     """Run tests while including mixin but not defining sideloading"""
 

tests/urls.py

@@ -5,6 +5,11 @@
 
 router = routers.DefaultRouter()
 router.register(r"product", viewsets.ProductViewSet)
+router.register(r"productlistonly", viewsets.ListOnlyProductViewSet, basename="productlistonly")
+router.register(
+    r"productwrongmixinorder", viewsets.ProductViewSetSideloadingBeforeViews, basename="productwrongmixinorder"
+)
+router.register(r"productretreiveonly", viewsets.RetreiveOnlyProductViewSet, basename="productretreiveonly")
 router.register(r"category", viewsets.CategoryViewSet)
 router.register(r"supplier", viewsets.SupplierViewSet)
 router.register(r"partner", viewsets.PartnerViewSet)

tests/viewsets.py

@@ -1,4 +1,12 @@
 from rest_framework import viewsets, filters, versioning
+from rest_framework.mixins import (
+    CreateModelMixin,
+    RetrieveModelMixin,
+    UpdateModelMixin,
+    DestroyModelMixin,
+    ListModelMixin,
+)
+from rest_framework.viewsets import GenericViewSet
 
 from drf_sideloading.mixins import SideloadableRelationsMixin
 from tests.mixins import OtherMixin
@@ -28,6 +36,7 @@ class ProductViewSet(SideloadableRelationsMixin, OtherMixin, viewsets.ModelViewS
         # django_filters.rest_framework.DjangoFilterBackend,
     ]
     search_fields = ["name"]
+
     # filter_fields = ["confirmed"]
 
     def get_serializer_class(self):
@@ -41,6 +50,24 @@ def get_sideloading_serializer_class(self):
         return self.sideloading_serializer_class
 
 
+class ListOnlyProductViewSet(SideloadableRelationsMixin, OtherMixin, ListModelMixin, GenericViewSet):
+    queryset = Product.objects.all()
+    serializer_class = ProductSerializer
+    sideloading_serializer_class = ProductSideloadableSerializer
+
+
+class RetreiveOnlyProductViewSet(SideloadableRelationsMixin, OtherMixin, RetrieveModelMixin, GenericViewSet):
+    queryset = Product.objects.all()
+    serializer_class = ProductSerializer
+    sideloading_serializer_class = ProductSideloadableSerializer
+
+
+class ProductViewSetSideloadingBeforeViews(viewsets.ModelViewSet, SideloadableRelationsMixin, OtherMixin):
+    queryset = Product.objects.all()
+    serializer_class = ProductSerializer
+    sideloading_serializer_class = ProductSideloadableSerializer
+
+
 class CategoryViewSet(SideloadableRelationsMixin, viewsets.ModelViewSet):
     queryset = Category.objects.all()
     serializer_class = CategorySerializer