Merge pull request #36 from cloudblue/fix/LITE-12790

LITE-12790 Namespaces support distinct assignment

Author: maxipavlovic

dj_rql/_dataclasses.py

@@ -1,5 +1,5 @@
 #
-#  Copyright © 2020 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 #
 
 
@@ -40,3 +40,4 @@ def __init__(self, filter_name, operator, str_value, list_operator=None,
 
         self.filter_lookup = kwargs.get('filter_lookup')
         self.django_lookup = kwargs.get('django_lookup')
+        self.distinct = kwargs.get('distinct')

dj_rql/filter_cls.py

@@ -1,5 +1,5 @@
 #
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 #
 
 import decimal
@@ -553,9 +553,15 @@ def _get_filter_ordering_name(self, filter_item, filter_name):
 
         return filter_item['orm_route']
 
-    def _build_filters(self, filters, filter_route='', orm_route='',
-                       orm_model=None, select_tree=None, parent_qs=None):
+    def _build_filters(self, filters, **kwargs):
         """ Converter of provided nested filter configuration to linear inner representation. """
+        filter_route = kwargs.get('filter_route', '')
+        orm_route = kwargs.get('orm_route', '')
+        orm_model = kwargs.get('orm_model')
+        select_tree = kwargs.get('select_tree')
+        parent_qs = kwargs.get('parent_qs')
+        distinct = kwargs.get('distinct', False)
+
         _model = orm_model or self.MODEL
 
         if not orm_route:
@@ -591,16 +597,23 @@ def _build_filters(self, filters, filter_route='', orm_route='',
 
                 qs = item.get('qs')
                 tree, p_qs = self._fill_select_tree(
-                    namespace, related_filter_route, select_tree,
+                    namespace,
+                    related_filter_route,
+                    select_tree,
                     namespace=True,
                     hidden=item.get('hidden', False),
                     qs=qs,
                     parent_qs=parent_qs,
                 )
 
                 self._build_filters(
-                    item.get('filters', []), related_filter_route + '.',
-                    related_orm_route, related_model, select_tree=tree, parent_qs=p_qs,
+                    item.get('filters', []),
+                    filter_route=related_filter_route + '.',
+                    orm_route=related_orm_route,
+                    orm_model=related_model,
+                    select_tree=tree,
+                    parent_qs=p_qs,
+                    distinct=item.get('distinct', distinct),
                 )
                 continue
 
@@ -624,15 +637,20 @@ def _build_filters(self, filters, filter_route='', orm_route='',
 
             self._check_use_repr(item, field_filter_route)
             self._check_dynamic(item, field_filter_route, filter_route)
-            self._build_filters_for_common_item(item, field_filter_route, orm_route, _model)
+            self._build_filters_for_common_item(
+                item, field_filter_route, orm_route, _model, distinct,
+            )
 
-    def _build_filters_for_common_item(self, item, field_filter_route, orm_route, orm_model):
+    def _build_filters_for_common_item(
+        self, item, field_filter_route, orm_route, orm_model, distinct,
+    ):
         filter_name = item['filter']
         field = item.get('field')
         kwargs = {
             prop: item.get(prop)
-            for prop in ('lookups', 'use_repr', 'null_values', 'distinct', 'openapi', 'hidden')
+            for prop in ('lookups', 'use_repr', 'null_values', 'openapi', 'hidden')
         }
+        kwargs['distinct'] = item.get('distinct', distinct)
 
         if 'sources' in item:
             items = []

tests/dj_rf/filters.py

@@ -1,5 +1,5 @@
 #
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 #
 from cachetools import LFUCache, LRUCache
 
@@ -20,6 +20,7 @@
 }, {
     'namespace': 'publisher',
     'filters': ['id'],
+    'distinct': False,
     'qs': NSR('publisher'),
 }]
 
@@ -63,6 +64,7 @@ class BooksFilterClass(RQLFilterClass):
     }, {
         'namespace': 'author',
         'filters': AUTHOR_FILTERS,
+        'distinct': True,
         'qs': SR('author', 'author__publisher'),
     }, {
         'namespace': 'page',

tests/test_filter_cls/test_apply_filters.py

@@ -1,5 +1,5 @@
 #
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 #
 
 from functools import partial
@@ -570,6 +570,18 @@ def test_distinct_on_field_no_field_in_filter():
     assert not qs.query.distinct
 
 
+@pytest.mark.django_db
+def test_default_distinct_from_namespace():
+    _, qs = BooksFilterClass(book_qs).apply_filters('[email protected]')
+    assert qs.query.distinct
+
+
+@pytest.mark.django_db
+def test_redefined_distinct_from_namespace():
+    _, qs = BooksFilterClass(book_qs).apply_filters('author.publisher.id=1')
+    assert not qs.query.distinct
+
+
 @pytest.mark.django_db
 def test_distinct_on_field_field_in_filter():
     _, qs = BooksFilterClass(book_qs).apply_filters('status=planning')