Adding link to serialized data

Author: safwanrahman

readthedocs/search/api.py

@@ -2,6 +2,7 @@
 from rest_framework import exceptions
 from rest_framework.exceptions import ValidationError
 
+from readthedocs.projects.models import Project
 from readthedocs.search.documents import PageDocument
 from readthedocs.search.filters import SearchFilterBackend
 from readthedocs.search.pagination import SearchPagination
@@ -37,3 +38,30 @@ def validate_query_params(self):
                 errors[param] = ["This query param is required"]
 
             raise ValidationError(errors)
+
+    def get_serializer_context(self):
+        context = super(PageSearchAPIView, self).get_serializer_context()
+        context['projects_info'] = self.get_projects_info()
+        return context
+
+    def _get_all_projects(self):
+        """Return list of project and its subprojects."""
+        project_slug = self.request.query_params.get('project')
+        queryset = Project.objects.api(self.request.user).only('slug')
+
+        project = generics.get_object_or_404(queryset, slug=project_slug)
+        subprojects = queryset.filter(superprojects__parent_id=project.id)
+
+        project_list = list(subprojects) + [project]
+        return project_list
+
+    def get_projects_info(self):
+        version_slug = self.request.query_params.get('version')
+        all_projects = self._get_all_projects()
+        projects_info = {}
+
+        for project in all_projects:
+            data = {'docs_url': project.get_docs_url(version_slug=version_slug)}
+            projects_info[project.slug] = data
+
+        return projects_info

readthedocs/search/filters.py

@@ -1,7 +1,5 @@
 from rest_framework import filters
 
-from readthedocs.search.utils import get_project_slug_list_or_404
-
 
 class SearchFilterBackend(filters.BaseFilterBackend):
 
@@ -12,10 +10,9 @@ def filter_queryset(self, request, queryset, view):
         # ``queryset`` is actually a Elasticsearch DSL ``Search`` object.
         # So change the variable name
         es_search = queryset
-        project_slug = request.query_params.get('project')
         version_slug = request.query_params.get('version')
-        project_slug_list = get_project_slug_list_or_404(project_slug=project_slug,
-                                                         user=request.user)
+        projects_info = view.get_projects_info()
+        project_slug_list = projects_info.keys()
         # Elasticsearch ``terms`` query can take multiple values as list,
         # while ``term`` query takes single value.
         filtered_es_search = (es_search.filter('terms', project=project_slug_list)

readthedocs/search/serializers.py

@@ -1,13 +1,23 @@
 from rest_framework import serializers
 
+from readthedocs.projects.models import Project
+
 
 class PageSearchSerializer(serializers.Serializer):
     project = serializers.CharField()
     version = serializers.CharField()
     title = serializers.CharField()
     path = serializers.CharField()
+    link = serializers.SerializerMethodField()
     highlight = serializers.SerializerMethodField()
 
+    def get_link(self, obj):
+        projects_info = self.context.get('projects_info')
+        if projects_info:
+            project_data = projects_info[obj.project]
+            docs_url = project_data['docs_url']
+            return docs_url + obj.path
+
     def get_highlight(self, obj):
         highlight = getattr(obj.meta, 'highlight', None)
         if highlight:

readthedocs/search/tests/test_api.py

@@ -124,3 +124,6 @@ def test_doc_search_subprojects(self, api_client, all_projects):
         data = resp.data['results']
         assert len(data) == 1
         assert data[0]['project'] == subproject.slug
+        # Check the link is the subproject document link
+        document_link = subproject.get_docs_url(version_slug=version.slug)
+        assert document_link in data[0]['link']