Refactor search code

docs/development/search.rst

@@ -37,13 +37,14 @@ By default, Auto Indexing is turned off in development mode. To turn it on, chan
 After that, whenever a documentation successfully builds, or project gets added,
 the search index will update automatically.
 
-
 Architecture
 ------------
 The search architecture is devided into 2 parts.
-One part is responsible for **indexing** the documents and projects and
-the other part is responsible for querying the Index to show the proper results to users.
-We use the `django-elasticsearch-dsl`_ package mostly to the keep the search working.
+
+* One part is responsible for **indexing** the documents and projects (`documents.py`)
+* The other part is responsible for **querying** the Index to show the proper results to users (`faceted_search.py`)
+
+We use the `django-elasticsearch-dsl`_ package for our Document abstraction.
 `django-elasticsearch-dsl`_ is a wrapper around `elasticsearch-dsl`_ for easy configuration
 with Django.
 
@@ -72,11 +73,11 @@ and index/delete the documentation content from the `HTMLFile` instances.
 
 How we index projects
 ~~~~~~~~~~~~~~~~~~~~~
+
 We also index project information in our search index so that the user can search for projects
-from the main site. `django-elasticsearch-dsl`_ listen `post_create` and `post_delete` signals of
+from the main site. We listen to the `post_create` and `post_delete` signals of
 `Project` model and index/delete into Elasticsearch accordingly.
 
-
 Elasticsearch Document
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -88,9 +89,7 @@ As per requirements of `django-elasticsearch-dsl`_, it is stored in the
     `django-elasticsearch-dsl`_ listens to the `post_save` signal of `Project` model and
     then index/delete into Elasticsearch.
 
-    **PageDocument**: It is used for indexing documentation of projects. By default, the auto
-    indexing is turned off by `ignore_signals = settings.ES_PAGE_IGNORE_SIGNALS`.
-    `settings.ES_PAGE_IGNORE_SIGNALS` is `False` both in development and production.
+    **PageDocument**: It is used for indexing documentation of projects. 
     As mentioned above, our `Search` app listens to the `bulk_post_create` and `bulk_post_delete`
     signals and indexes/deleted documentation into Elasticsearch. The signal listeners are in
     the `readthedocs/search/signals.py` file. Both of the signals are dispatched

readthedocs/core/static-src/core/js/doc-embed/search.js

@@ -32,7 +32,6 @@ function attach_elastic_search_query(data) {
                 var total_count = data.count || 0;
 
                 if (hit_list.length) {
-                    // console.debug('Read the Docs search got a result. Showing results.');
                     for (var i = 0; i < hit_list.length; i += 1) {
                         var doc = hit_list[i];
                         var highlight = doc.highlight;
@@ -105,7 +104,6 @@ function attach_elastic_search_query(data) {
             },
             complete: function (resp, status_code) {
                 if (status_code !== 'success' || resp.responseJSON.count === 0) {
-                    // console.debug('Read the Docs search failed, skipping loading search content.');
                     return search_def.reject();
                 }
                 return search_def.resolve(resp.responseJSON);

readthedocs/search/api.py

@@ -45,6 +45,7 @@ def get_highlight(self, obj):
 
 
 class PageSearchAPIView(generics.ListAPIView):
+
     """Main entry point to perform a search using Elasticsearch."""
 
     pagination_class = SearchPagination

readthedocs/search/faceted_search.py

@@ -70,7 +70,7 @@ def query(self, search, query):
 
         # need to search for both 'and' and 'or' operations
         # the score of and should be higher as it satisfies both or and and
-        for operator in ['and', 'or']:
+        for operator in ['AND', 'OR']:
             query_string = SimpleQueryString(
                 query=query, fields=self.fields, default_operator=operator
             )
@@ -84,18 +84,22 @@ def query(self, search, query):
 
 
 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
     """
+
     _default_class = PageSearchBase
 
 
 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
     """
+
     _default_class = ProjectSearchBase