[fix] Resolve conflicts and increased queries based on recent changes to geo_api:device_location

Author: dee077

openwisp_controller/config/api/serializers.py

@@ -380,25 +380,25 @@ def update(self, instance, validated_data):
 
 
 class VersionSerializer(BaseSerializer):
-    user_id = serializers.CharField(source='revision.user_id', read_only=True)
+    user_id = serializers.CharField(source="revision.user_id", read_only=True)
     date_created = serializers.DateTimeField(
-        source='revision.date_created', read_only=True
+        source="revision.date_created", read_only=True
     )
-    comment = serializers.CharField(source='revision.comment', read_only=True)
-    content_type = serializers.CharField(source='revision.content_type', read_only=True)
+    comment = serializers.CharField(source="revision.comment", read_only=True)
+    content_type = serializers.CharField(source="revision.content_type", read_only=True)
 
     class Meta:
         model = Version
         fields = [
-            'id',
-            'revision_id',
-            'object_id',
-            'content_type',
-            'db',
-            'format',
-            'serialized_data',
-            'object_repr',
-            'user_id',
-            'date_created',
-            'comment',
+            "id",
+            "revision_id",
+            "object_id",
+            "content_type",
+            "db",
+            "format",
+            "serialized_data",
+            "object_repr",
+            "user_id",
+            "date_created",
+            "comment",
         ]

openwisp_controller/config/api/views.py

@@ -305,43 +305,43 @@ def certificate_delete_invalidates_cache(cls, organization_id, common_name):
 
 class RevisionListView(ProtectedAPIMixin, ListAPIView):
     serializer_class = VersionSerializer
-    queryset = Version.objects.select_related('revision').order_by(
-        '-revision__date_created'
+    queryset = Version.objects.select_related("revision").order_by(
+        "-revision__date_created"
     )
 
     def get_queryset(self):
-        model = self.kwargs.get('model').lower()
+        model = self.kwargs.get("model").lower()
         queryset = self.queryset.filter(content_type__model=model)
-        revision_id = self.request.query_params.get('revision_id')
+        revision_id = self.request.query_params.get("revision_id")
         if revision_id:
             queryset = queryset.filter(revision_id=revision_id)
         return self.queryset.filter(content_type__model=model)
 
 
 class VersionDetailView(ProtectedAPIMixin, RetrieveAPIView):
     serializer_class = VersionSerializer
-    queryset = Version.objects.select_related('revision').order_by(
-        '-revision__date_created'
+    queryset = Version.objects.select_related("revision").order_by(
+        "-revision__date_created"
     )
 
     def get_queryset(self):
-        model = self.kwargs.get('model').lower()
+        model = self.kwargs.get("model").lower()
         return self.queryset.filter(content_type__model=model)
 
 
 class RevisionRestoreView(ProtectedAPIMixin, GenericAPIView):
     serializer_class = serializers.Serializer
-    queryset = Version.objects.select_related('revision').order_by(
-        '-revision__date_created'
+    queryset = Version.objects.select_related("revision").order_by(
+        "-revision__date_created"
     )
 
     def get_queryset(self):
-        model = self.kwargs.get('model').lower()
+        model = self.kwargs.get("model").lower()
         return self.queryset.filter(content_type__model=model)
 
     def post(self, request, *args, **kwargs):
         qs = self.get_queryset()
-        versions = get_list_or_404(qs, revision_id=kwargs['pk'])
+        versions = get_list_or_404(qs, revision_id=kwargs["pk"])
         with transaction.atomic():
             with reversion.create_revision():
                 for version in versions:

openwisp_controller/config/tests/test_api.py

@@ -1638,46 +1638,46 @@ def test_device_patch_with_templates_of_same_org(self):
 
     def test_revision_list_and_restore_api(self):
         org = self._get_org()
-        model_slug = 'device'
+        model_slug = "device"
         with reversion.create_revision():
             device = self._create_device(
                 organization=org,
                 name="test",
             )
-        path = reverse('config_api:device_detail', args=[device.pk])
-        data = dict(name='change-test-device')
-        response = self.client.patch(path, data, content_type='application/json')
+        path = reverse("config_api:device_detail", args=[device.pk])
+        data = dict(name="change-test-device")
+        response = self.client.patch(path, data, content_type="application/json")
         self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.data['name'], 'change-test-device')
+        self.assertEqual(response.data["name"], "change-test-device")
 
-        with self.subTest('Test revision list'):
-            path = reverse('config_api:revision_list', args=[model_slug])
+        with self.subTest("Test revision list"):
+            path = reverse("config_api:revision_list", args=[model_slug])
             response = self.client.get(path)
             response_json = response.json()
             version_id = response_json[1]["id"]
-            revision_id = response_json[1]['revision_id']
+            revision_id = response_json[1]["revision_id"]
             self.assertEqual(response.status_code, 200)
             self.assertEqual(len(response_json), 2)
 
-        with self.subTest('Test revision list filter by revision id'):
-            path = reverse('config_api:revision_list', args=[model_slug])
-            response = self.client.get(f'{path}?revision_id={revision_id}')
+        with self.subTest("Test revision list filter by revision id"):
+            path = reverse("config_api:revision_list", args=[model_slug])
+            response = self.client.get(f"{path}?revision_id={revision_id}")
             response_json = response.json()
             self.assertEqual(response.status_code, 200)
             self.assertEqual(len(response_json), 2)
 
-        with self.subTest('Test version detail'):
-            path = reverse('config_api:version_detail', args=[model_slug, version_id])
+        with self.subTest("Test version detail"):
+            path = reverse("config_api:version_detail", args=[model_slug, version_id])
             response = self.client.get(path)
             self.assertEqual(response.status_code, 200)
-            self.assertEqual(response.json()['id'], version_id)
-            self.assertEqual(response.json()['object_id'], str(device.pk))
+            self.assertEqual(response.json()["id"], version_id)
+            self.assertEqual(response.json()["object_id"], str(device.pk))
 
-        with self.subTest('Test revision restore view'):
-            revision_id = response_json[1]['revision_id']
+        with self.subTest("Test revision restore view"):
+            revision_id = response_json[1]["revision_id"]
             path = reverse(
-                'config_api:revision_restore', args=[model_slug, revision_id]
+                "config_api:revision_restore", args=[model_slug, revision_id]
             )
             response = self.client.post(path)
             self.assertEqual(response.status_code, 200)
-            self.assertEqual(Device.objects.get(name='test').pk, device.pk)
+            self.assertEqual(Device.objects.get(name="test").pk, device.pk)

openwisp_controller/geo/tests/test_api.py

@@ -724,7 +724,7 @@ def test_create_devicelocation_using_related_ids(self):
         floorplan = self._create_floorplan()
         location = floorplan.location
         url = reverse("geo_api:device_location", args=[device.id])
-        with self.assertNumQueries(26):
+        with self.assertNumQueries(29):
             response = self.client.put(
                 url,
                 data={
@@ -762,7 +762,7 @@ def test_create_devicelocation_location_floorplan(self):
             "floorplan.image": self._get_simpleuploadedfile(),
             "indoor": ["12.342,23.541"],
         }
-        with self.assertNumQueries(40):
+        with self.assertNumQueries(43):
             response = self.client.put(
                 url, encode_multipart(BOUNDARY, data), content_type=MULTIPART_CONTENT
             )
@@ -829,8 +829,8 @@ def test_create_devicelocation_only_location(self):
                 "type": "indoor",
             }
         }
-        with self.assertNumQueries(29):
-            response = self.client.put(url, data=data, content_type='application/json')
+        with self.assertNumQueries(32):
+            response = self.client.put(url, data=data, content_type="application/json")
         self.assertEqual(response.status_code, 201)
         self.assertEqual(self.location_model.objects.count(), 1)
         self.assertEqual(self.object_location_model.objects.count(), 1)
@@ -869,7 +869,7 @@ def test_create_devicelocation_existing_location_new_floorplan(self):
             "floorplan.image": self._get_simpleuploadedfile(),
             "indoor": ["12.342,23.541"],
         }
-        with self.assertNumQueries(34):
+        with self.assertNumQueries(37):
             response = self.client.put(
                 url, encode_multipart(BOUNDARY, data), content_type=MULTIPART_CONTENT
             )
@@ -892,7 +892,7 @@ def test_update_devicelocation_change_location_outdoor_to_indoor(self):
         }
         self.assertEqual(device_location.location.type, "outdoor")
         self.assertEqual(device_location.floorplan, None)
-        with self.assertNumQueries(31):
+        with self.assertNumQueries(33):
             response = self.client.put(
                 path, encode_multipart(BOUNDARY, data), content_type=MULTIPART_CONTENT
             )
@@ -911,7 +911,7 @@ def test_update_devicelocation_patch_indoor(self):
             "indoor": "0,0",
         }
         self.assertEqual(device_location.indoor, "-140.38620,40.369227")
-        with self.assertNumQueries(18):
+        with self.assertNumQueries(20):
             response = self.client.patch(path, data, content_type="application/json")
         self.assertEqual(response.status_code, 200)
         device_location.refresh_from_db()
@@ -928,8 +928,8 @@ def test_update_devicelocation_floorplan_related_id(self):
         data = {
             "floorplan": str(floor2.id),
         }
-        with self.assertNumQueries(20):
-            response = self.client.patch(path, data, content_type='application/json')
+        with self.assertNumQueries(22):
+            response = self.client.patch(path, data, content_type="application/json")
         self.assertEqual(response.status_code, 200)
         device_location.refresh_from_db()
         self.assertEqual(device_location.floorplan, floor2)
@@ -942,7 +942,7 @@ def test_update_devicelocation_location_related_id(self):
         data = {
             "location": str(location2.id),
         }
-        with self.assertNumQueries(19):
+        with self.assertNumQueries(21):
             response = self.client.patch(path, data, content_type="application/json")
         self.assertEqual(response.status_code, 200)
         device_location.refresh_from_db()

openwisp_controller/mixins.py

@@ -44,10 +44,10 @@ class AutoRevisionMixin(RevisionMixin):
     revision_atomic = False
 
     def dispatch(self, request, *args, **kwargs):
-        qs = getattr(self, 'queryset', None)
-        model = getattr(qs, 'model', None)
+        qs = getattr(self, "queryset", None)
+        model = getattr(qs, "model", None)
         if (
-            request.method in ('POST', 'PUT', 'PATCH')
+            request.method in ("POST", "PUT", "PATCH")
             and request.user.is_authenticated
             and model
             and reversion.is_registered(model)
@@ -56,7 +56,7 @@ def dispatch(self, request, *args, **kwargs):
                 response = super().dispatch(request, *args, **kwargs)
                 reversion.set_user(request.user)
                 reversion.set_comment(
-                    f'API request: {request.method} {request.get_full_path()}'
+                    f"API request: {request.method} {request.get_full_path()}"
                 )
             return response
         return super().dispatch(request, *args, **kwargs)