Merge pull request #163 from novafloss/157_deduplicate_queries_retrieve_builder_view

Deduplicate queries retrieve builder view

Author: brunobord

CHANGELOG.rst

@@ -8,6 +8,7 @@ master (unreleased)
 * Added a make target to install the demo site.
 * Added django-perf-rec module for tests and improved SQL queries in `ContextFormDetailView` (#54, #154, #160).
 * Added test to count queries on dynamic form queryset + improve performances (#155, #156, #162).
+* Added test to count queries on retrieve builder view + improve performances by removing duplicate queries (#157, #158, #163).
 
 
 Release 0.5.0 (2017-01-10)

demo/tests/perfs/test_end_point.perf.yml

@@ -4,3 +4,10 @@ RenderContextSerializer.test_queryset:
 - db: SELECT ... FROM "formidable_item" WHERE "formidable_item"."field_id" IN (...) ORDER BY "formidable_item"."order" ASC
 - db: SELECT ... FROM "formidable_validation" WHERE "formidable_validation"."field_id" IN (...)
 - db: SELECT ... FROM "formidable_default" WHERE "formidable_default"."field_id" IN (...)
+RenderSerializerTestCase.test_queryset:
+- db: 'SELECT ... FROM "formidable_field" WHERE "formidable_field"."form_id" = # ORDER BY "formidable_field"."order" ASC'
+- db: SELECT ... FROM "formidable_item" WHERE "formidable_item"."field_id" IN (...) ORDER BY "formidable_item"."order" ASC
+- db: SELECT ... FROM "formidable_default" WHERE "formidable_default"."field_id" IN (...)
+- db: SELECT ... FROM "formidable_validation" WHERE "formidable_validation"."field_id" IN (...)
+- db: SELECT ... FROM "formidable_access" WHERE "formidable_access"."field_id" IN (...)
+- db: 'SELECT ... FROM "formidable_preset" WHERE "formidable_preset"."form_id" = #'

demo/tests/perfs/tests_integration.perf.yml

@@ -6,3 +6,11 @@ TestContextFormEndPoint.test_queryset:
 - db: SELECT ... FROM "formidable_item" WHERE "formidable_item"."field_id" IN (...) ORDER BY "formidable_item"."order" ASC
 - db: SELECT ... FROM "formidable_validation" WHERE "formidable_validation"."field_id" IN (...)
 - db: SELECT ... FROM "formidable_default" WHERE "formidable_default"."field_id" IN (...)
+UpdateFormTestCase.test_queryset_on_get:
+- db: 'SELECT ... FROM "formidable_formidable" WHERE "formidable_formidable"."id" = #'
+- db: 'SELECT ... FROM "formidable_field" WHERE "formidable_field"."form_id" = # ORDER BY "formidable_field"."order" ASC'
+- db: SELECT ... FROM "formidable_item" WHERE "formidable_item"."field_id" IN (...) ORDER BY "formidable_item"."order" ASC
+- db: SELECT ... FROM "formidable_default" WHERE "formidable_default"."field_id" IN (...)
+- db: SELECT ... FROM "formidable_validation" WHERE "formidable_validation"."field_id" IN (...)
+- db: SELECT ... FROM "formidable_access" WHERE "formidable_access"."field_id" IN (...)
+- db: 'SELECT ... FROM "formidable_preset" WHERE "formidable_preset"."form_id" = #'

demo/tests/test_end_point.py

@@ -196,6 +196,20 @@ def test_separator_field(self):
         self.assertNotIn('label', data)
         self.assertNotIn('help_text', data)
 
+    def test_queryset(self):
+        class MyTestForm(FormidableForm):
+            first_name = fields.CharField(default='foo')
+            last_name = fields.CharField()
+            origin = fields.ChoiceField(choices=(
+                ('fr', 'France'),
+                ('us', 'United States'),
+            ))
+
+        formidable = MyTestForm.to_formidable(label='test')
+        serializer = FormidableSerializer(instance=formidable)
+        with django_perf_rec.record(path='perfs/'):
+            serializer.data
+
 
 class RenderContextSerializer(TestCase):
 

demo/tests/tests_integration.py

@@ -5,6 +5,7 @@
 from copy import deepcopy
 
 from django.core.urlresolvers import reverse
+import django_perf_rec
 
 from freezegun import freeze_time
 from rest_framework.test import APITestCase
@@ -17,6 +18,33 @@
 from . import form_data, form_data_items
 
 
+class MyTestForm(FormidableForm):
+
+    name = fields.CharField(label='Name', accesses={'jedi': 'REQUIRED'})
+    birth_date = fields.DateField(
+        label='Your Birth Date',
+        validators=[
+            validators.AgeAboveValidator(
+                21, message='You cannot be a jedi until your 21'
+            ),
+            validators.DateIsInFuture(False)
+        ],
+        accesses={'jedi': 'REQUIRED'},
+    )
+    out_date = fields.DateField(
+        validators=[validators.DateIsInFuture(True)]
+    )
+    weapons = fields.ChoiceField(choices=[
+        ('gun', 'blaster'), ('sword', 'light saber')
+    ])
+    salary = fields.IntegerField(
+        validators=[
+            validators.GTValidator(0), validators.LTEValidator(25)
+        ],
+        accesses={'jedi': 'HIDDEN', 'jedi-master': 'REQUIRED'}
+    )
+
+
 class CreateFormTestCase(APITestCase):
 
     def test_simple(self):
@@ -73,6 +101,11 @@ def test_with_unknown_accesses(self):
 
 class UpdateFormTestCase(APITestCase):
 
+    @classmethod
+    def setUpClass(cls):
+        super(UpdateFormTestCase, cls).setUpClass()
+        cls.formidable_form = MyTestForm.to_formidable(label='test')
+
     def setUp(self):
         super(UpdateFormTestCase, self).setUp()
         self.form = Formidable.objects.create(
@@ -164,6 +197,12 @@ def test_delete_field_on_update(self):
             access_id="jedi-master", level="READONLY"
         ).exists())
 
+    def test_queryset_on_get(self):
+        with django_perf_rec.record(path='perfs/'):
+            self.client.get(reverse(
+                'formidable:form_detail', args=[self.formidable_form.pk])
+            )
+
 
 class TestAccess(APITestCase):
 
@@ -184,34 +223,9 @@ def test_get(self):
 
 class TestChain(APITestCase):
 
-    class MyTestForm(FormidableForm):
-
-        name = fields.CharField(label='Name', accesses={'jedi': 'REQUIRED'})
-        birth_date = fields.DateField(
-            label='Your Birth Date', validators=[
-                validators.AgeAboveValidator(
-                    21, message='You cannot be a jedi until your 21'
-                ),
-                validators.DateIsInFuture(False)
-            ],
-            accesses={'jedi': 'REQUIRED'},
-        )
-        out_date = fields.DateField(
-            validators=[validators.DateIsInFuture(True)]
-        )
-        weapons = fields.ChoiceField(choices=[
-            ('gun', 'blaster'), ('sword', 'light saber')
-        ])
-        salary = fields.IntegerField(
-            validators=[
-                validators.GTValidator(0), validators.LTEValidator(25)
-            ],
-            accesses={'jedi': 'HIDDEN', 'jedi-master': 'REQUIRED'}
-        )
-
     def setUp(self):
         super(APITestCase, self).setUp()
-        self.form = self.MyTestForm.to_formidable(label='Jedi Form')
+        self.form = MyTestForm.to_formidable(label='Jedi Form')
         self.assertTrue(self.form.pk)
 
     @freeze_time('2021-01-01')

formidable/serializers/fields.py

@@ -47,6 +47,14 @@ def validate(self, validated_data):
 
         return validated_data
 
+    def get_attribute(self, instance):
+        qs = super(FieldListSerializer, self).get_attribute(instance)
+        qs = qs.prefetch_related(
+            Prefetch('items', queryset=Item.objects.order_by('order')),
+            'defaults', 'validations', 'accesses'
+        )
+        return qs.order_by('order')
+
 
 class FieldSerializer(WithNestedSerializer):
 

formidable/views.py

@@ -5,7 +5,6 @@
 
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
-from django.db.models import Prefetch
 
 import six
 from rest_framework import exceptions
@@ -21,7 +20,7 @@
     FileFieldBuilder, FormFieldFactory, SkipField
 )
 from formidable.forms.validations.presets import presets_register
-from formidable.models import Field, Formidable
+from formidable.models import Formidable
 from formidable.serializers import FormidableSerializer, SimpleAccessSerializer
 from formidable.serializers.forms import ContextFormSerializer
 from formidable.serializers.presets import PresetsSerializer
@@ -176,11 +175,6 @@ class FormidableDetail(six.with_metaclass(MetaClassView,
     success_callback_settings = 'FORMIDABLE_POST_UPDATE_CALLBACK_SUCCESS'
     failure_callback_settings = 'FORMIDABLE_POST_UPDATE_CALLBACK_FAIL'
 
-    def get_queryset(self):
-        qs = super(FormidableDetail, self).get_queryset()
-        field_qs = Field.objects.order_by('order')
-        return qs.prefetch_related(Prefetch('fields', queryset=field_qs))
-
 
 class FormidableCreate(six.with_metaclass(MetaClassView,
                        CallbackMixin, CreateAPIView)):