Merge pull request #17 from id13/master

Add nested field search query support

Author: barseghyanartur

examples/simple/search_indexes/documents/city.py

@@ -53,7 +53,7 @@ class CityDocument(DocType):
     # ********************************************************************
 
     # City object
-    country = fields.ObjectField(
+    country = fields.NestedField(
         properties={
             'name': StringField(
                 analyzer=html_strip,

examples/simple/search_indexes/viewsets/city.py

@@ -46,8 +46,12 @@ class CityDocumentViewSet(BaseDocumentViewSet):
     search_fields = (
         'name',
         'info',
-        'country.name',
     )
+
+    search_nested_fields = {
+        'country': ['name'],
+    }
+
     # Define filtering fields
     filter_fields = {
         'id': None,

src/django_elasticsearch_dsl_drf/filter_backends/search.py

@@ -43,6 +43,10 @@ class SearchFilterBackend(BaseFilterBackend, FilterBackendMixin):
         >>>         'title',
         >>>         'content',
         >>>     )
+        >>>     search_nested_fields = {
+        >>>         'state': ['name'],
+        >>>         'documents.author': ['title', 'description'],
+        >>>     }
     """
 
     search_param = api_settings.SEARCH_PARAM
@@ -58,6 +62,41 @@ def get_search_query_params(self, request):
         query_params = request.query_params.copy()
         return query_params.getlist(self.search_param, [])
 
+    def construct_nested_search(self, request, view):
+        """Construct nested search.
+
+        :param request: Django REST framework request.
+        :param queryset: Base queryset.
+        :param view: View.
+        :type request: rest_framework.request.Request
+        :type queryset: elasticsearch_dsl.search.Search
+        :type view: rest_framework.viewsets.ReadOnlyModelViewSet
+        :return: Updated queryset.
+        :rtype: elasticsearch_dsl.search.Search
+        """
+        if not hasattr(view, 'search_nested_fields'):
+            return []
+
+        query_params = self.get_search_query_params(request)
+        __queries = []
+        for search_term in query_params:
+            for path, fields in view.search_nested_fields.items():
+                queries = []
+                for field in fields:
+                    field_key = "{}.{}".format(path, field)
+                    queries.append(
+                        Q("match", **{field_key: search_term})
+                    )
+
+                __queries.append(
+                    Q("nested",
+                      path=path,
+                      query=six.moves.reduce(operator.or_, queries)
+                      )
+                )
+
+        return __queries
+
     def construct_search(self, request, view):
         """Construct search.
 
@@ -99,10 +138,9 @@ def filter_queryset(self, request, queryset, view):
         :return: Updated queryset.
         :rtype: elasticsearch_dsl.search.Search
         """
-        __queries = self.construct_search(request, view)
+        __queries = self.construct_search(request, view) +\
+            self.construct_nested_search(request, view)
 
         if __queries:
-            queryset = queryset.query(
-                six.moves.reduce(operator.or_, __queries)
-            )
+            queryset = queryset.query('bool', should=__queries)
         return queryset

src/django_elasticsearch_dsl_drf/tests/test_search.py

@@ -56,6 +56,17 @@ def setUp(cls):
         )
 
         cls.all_count = cls.special_count + cls.lorem_count
+
+        cls.cities_count = 20
+        cls.cities = factories.CityFactory.create_batch(
+            cls.cities_count)
+        cls.switzerland = factories.CountryFactory.create(name='Switzerland')
+        cls.switz_cities_count = 10
+        cls.switz_cities = factories.CityFactory.create_batch(
+            cls.switz_cities_count,
+            country=cls.switzerland)
+        cls.all_cities_cound = cls.cities_count + cls.switz_cities_count
+
         call_command('search_index', '--rebuild', '-f')
 
     def _search_by_field(self, field_name, search_term):
@@ -81,13 +92,42 @@ def _search_by_field(self, field_name, search_term):
             self.special_count
         )
 
+    def _search_by_nested_field(self, search_term):
+        """Search by field."""
+        self.authenticate()
+
+        url = reverse('citydocument-list', kwargs={})
+        data = {}
+
+        # Should contain 20 results
+        response = self.client.get(url, data)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(len(response.data['results']), self.all_cities_cound)
+
+        # Should contain only 10 results
+        filtered_response = self.client.get(
+            url + '?search={}'.format(search_term),
+            data
+        )
+        self.assertEqual(filtered_response.status_code, status.HTTP_200_OK)
+        self.assertEqual(
+            len(filtered_response.data['results']),
+            self.switz_cities_count
+        )
+
     def test_search_by_field(self):
         """Search by field."""
         return self._search_by_field(
             'summary',
             'photography',
         )
 
+    def test_search_by_nested_field(self):
+        """Search by field."""
+        return self._search_by_nested_field(
+            'Switzerland',
+        )
+
 
 if __name__ == '__main__':
     unittest.main()