Cleanup search display and logic.

Author: ericholscher

readthedocs/search/faceted_search.py

@@ -13,15 +13,25 @@
 
 log = logging.getLogger(__name__)
 
+ALL_FACETS = ['project', 'version', 'doc_type', 'language', 'index']
+
 
 class RTDFacetedSearch(FacetedSearch):
 
     def __init__(self, user, **kwargs):
         self.user = user
         self.filter_by_user = kwargs.pop('filter_by_user', None)
+
+        # Set filters properly
         for facet in self.facets:
             if facet in kwargs:
                 kwargs.setdefault('filters', {})[facet] = kwargs.pop(facet)
+
+        # Don't pass along unnecessary filters
+        for f in ALL_FACETS:
+            if f in kwargs:
+                del kwargs[f]
+
         super().__init__(**kwargs)
 
     def search(self):
@@ -98,6 +108,7 @@ class PageSearch(SettingsOverrideObject):
 
     """
     Allow this class to be overridden based on CLASS_OVERRIDES setting.
+
     This is primary used on the .com to adjust how we filter our search queries
     """
 
@@ -108,6 +119,7 @@ class ProjectSearch(SettingsOverrideObject):
 
     """
     Allow this class to be overridden based on CLASS_OVERRIDES setting.
+
     This is primary used on the .com to adjust how we filter our search queries
     """
 
@@ -118,6 +130,7 @@ class DomainSearch(SettingsOverrideObject):
 
     """
     Allow this class to be overridden based on CLASS_OVERRIDES setting.
+
     This is primary used on the .com to adjust how we filter our search queries
     """
 

readthedocs/search/views.py

@@ -12,8 +12,6 @@
 from readthedocs.search.faceted_search import (
     AllSearch, ProjectSearch, PageSearch, DomainSearch, ALL_FACETS
 )
-from readthedocs.search.utils import get_project_list_or_404
-
 
 log = logging.getLogger(__name__)
 LOG_TEMPLATE = '(Elastic Search) [{user}:{type}] [{project}:{version}:{language}] {msg}'
@@ -34,68 +32,62 @@
 
 
 def elastic_search(request, project_slug=None):
-    """Use Elasticsearch for global search."""
+    """
+    Global user search on the dashboard
+
+    This is for both the main search and project search.
+
+    :param project_slug: Sent when the view is a project search
+    """
+
+    if project_slug:
+        queryset = Project.objects.protected(request.user)
+        project_obj = get_object_or_404(queryset, slug=project_slug)
+
     user_input = UserInput(
         query=request.GET.get('q'),
-        type=request.GET.get('type', 'all'),
+        type=request.GET.get('type', 'project'),
         project=project_slug or request.GET.get('project'),
         version=request.GET.get('version', LATEST),
         taxonomy=request.GET.get('taxonomy'),
         language=request.GET.get('language'),
         doc_type=request.GET.get('doc_type'),
         index=request.GET.get('index'),
     )
+
     results = ''
     facets = {}
 
     if user_input.query:
         kwargs = {}
 
-        if user_input.project:
-            projects_list = get_project_list_or_404(
-                project_slug=user_input.project, user=request.user
-            )
-            project_slug_list = [project.slug for project in projects_list]
-            kwargs['project'] = project_slug_list
-            log.info('Filtering to project list: %s' % project_slug_list)
-
-        if user_input.version:
-            kwargs['version'] = [user_input.version]
-
-        if user_input.doc_type:
-            kwargs['doc_type'] = user_input.doc_type
-
-        if user_input.language:
-            kwargs['language'] = user_input.language
-
-        if user_input.index:
-            kwargs['index'] = user_input.index
+        for avail_facet in ALL_FACETS:
+            value = getattr(user_input, avail_facet, None)
+            if value:
+                kwargs[avail_facet] = value
 
         if user_input.type == 'project':
-            project_search = ProjectSearch(
+            search = ProjectSearch(
                 query=user_input.query, user=request.user, **kwargs
             )
-            results = project_search.execute()
-            facets = results.facets
+
         elif user_input.type == 'domain':
-            project_search = DomainSearch(
+            search = DomainSearch(
                 query=user_input.query, user=request.user, **kwargs
             )
-            results = project_search.execute()
-            facets = results.facets
-        elif user_input.type == 'file':
 
-            page_search = PageSearch(
+        elif user_input.type == 'file':
+            search = PageSearch(
                 query=user_input.query, user=request.user, **kwargs
             )
-            results = page_search.execute()
-            facets = results.facets
+
         elif user_input.type == 'all':
-            project_search = AllSearch(
+            search = AllSearch(
                 query=user_input.query, user=request.user, **kwargs
             )
-            results = project_search.execute()
-            facets = results.facets
+
+        results = search.execute()
+        facets = results.facets
 
         log.info(
             LOG_TEMPLATE.format(
@@ -135,9 +127,7 @@ def elastic_search(request, project_slug=None):
     })
 
     if project_slug:
-        queryset = Project.objects.protected(request.user)
-        project = get_object_or_404(queryset, slug=project_slug)
-        template_vars.update({'project_obj': project})
+        template_vars.update({'project_obj': project_obj})
 
     return render(
         request,

readthedocs/templates/search/elastic_search.html

@@ -30,15 +30,13 @@
 
 <div class="navigable">
   <ul>
-<!--
       <h5>{% trans 'Object Type' %}</h5>
-      <li class="{% if type == 'all' %}active{% endif %}"><a href="?{% url_replace request 'type' 'all' %}">{% trans 'All' %}</a></li>
+      {# <li class="{% if type == 'all' %}active{% endif %}"><a href="?{% url_replace request 'type' 'all' %}">{% trans 'All' %}</a></li> #}
       <li class="{% if type == 'project' %}active{% endif %}"><a href="?{% url_replace request 'type' 'project' %}">{% trans 'Projects' %}</a></li>
       <li class="{% if type == 'file' %}active{% endif %}"><a href="?{% url_replace request 'type' 'file' %}">{% trans 'Files' %}</a></li>
       <li class="{% if type == 'domain' %}active{% endif %}"><a href="?{% url_replace request 'type' 'domain' %}">{% trans 'Code API' %}</a></li>
 
       <hr>
--->
 
       {% if facets.index %}