fixup as per comments

Author: safwanrahman

readthedocs/search/management/commands/reindex_elasticsearch.py

@@ -7,8 +7,8 @@
 from django.core.management import BaseCommand
 from django_elasticsearch_dsl.registries import registry
 
-from ...tasks import (index_objects_to_es_task, switch_es_index_task, create_new_es_index_task,
-                      index_missing_objects_task)
+from ...tasks import (index_objects_to_es, switch_es_index, create_new_es_index,
+                      index_missing_objects)
 from ...utils import chunks
 
 log = logging.getLogger(__name__)
@@ -28,7 +28,7 @@ def _get_indexing_tasks(app_label, model_name, instance_ids, document_class, ind
                 'index_name': index_name,
                 'objects_id': chunk
             }
-            yield index_objects_to_es_task.si(**data)
+            yield index_objects_to_es.si(**data)
 
     def _run_reindex_tasks(self, models):
         for doc in registry.get_documents(models):
@@ -42,26 +42,26 @@ def _run_reindex_tasks(self, models):
             timestamp = datetime.datetime.now().strftime('%Y%m%d%H%M%S')
             new_index_name = "{}_{}".format(index_name, timestamp)
 
-            pre_index_task = create_new_es_index_task.si(app_label=app_label,
-                                                         model_name=model_name,
-                                                         index_name=index_name,
-                                                         new_index_name=new_index_name)
+            pre_index_task = create_new_es_index.si(app_label=app_label,
+                                                    model_name=model_name,
+                                                    index_name=index_name,
+                                                    new_index_name=new_index_name)
 
             indexing_tasks = self._get_indexing_tasks(app_label=app_label, model_name=model_name,
                                                       instance_ids=instance_ids,
                                                       document_class=str(doc),
                                                       index_name=new_index_name)
 
-            post_index_task = switch_es_index_task.si(app_label=app_label, model_name=model_name,
-                                                      index_name=index_name,
-                                                      new_index_name=new_index_name)
+            post_index_task = switch_es_index.si(app_label=app_label, model_name=model_name,
+                                                 index_name=index_name,
+                                                 new_index_name=new_index_name)
 
             # Task to run in order to add the objects
             # that has been inserted into database while indexing_tasks was running
-            missed_index_task = index_missing_objects_task.si(app_label=app_label,
-                                                              model_name=model_name,
-                                                              document_class=str(doc),
-                                                              indexed_instance_ids=instance_ids)
+            missed_index_task = index_missing_objects.si(app_label=app_label,
+                                                         model_name=model_name,
+                                                         document_class=str(doc),
+                                                         indexed_instance_ids=instance_ids)
 
             # http://celery.readthedocs.io/en/latest/userguide/canvas.html#chords
             chord_tasks = chord(header=indexing_tasks, body=post_index_task)

readthedocs/search/signals.py

@@ -8,7 +8,7 @@
 from readthedocs.projects.models import HTMLFile
 from readthedocs.projects.signals import bulk_post_create, bulk_post_delete
 from readthedocs.search.documents import PageDocument
-from readthedocs.search.tasks import index_objects_to_es_task
+from readthedocs.search.tasks import index_objects_to_es
 
 before_project_search = django.dispatch.Signal(providing_args=["body"])
 before_file_search = django.dispatch.Signal(providing_args=["body"])
@@ -27,7 +27,7 @@ def index_html_file(instance_list, **_):
 
     # Do not index if autosync is disabled globally
     if DEDConfig.autosync_enabled():
-        index_objects_to_es_task(**kwargs)
+        index_objects_to_es(**kwargs)
 
 
 @receiver(bulk_post_delete, sender=HTMLFile)

readthedocs/search/tasks.py

@@ -9,12 +9,24 @@
 
 
 def _get_index(indices, index_name):
+    """
+    Get Index from all the indices
+    :param indices: DED indices list
+    :param index_name: Name of the index
+    :return: DED Index
+    """
     for index in indices:
         if str(index) == index_name:
             return index
 
 
 def _get_document(model, document_class):
+    """
+    Get DED document class object from the model and name of document class
+    :param model: The model class to find the document
+    :param document_class: the name of the document class.
+    :return: DED DocType object
+    """
     documents = registry.get_documents(models=[model])
 
     for document in documents:
@@ -23,7 +35,7 @@ def _get_document(model, document_class):
 
 
 @app.task(queue='web')
-def create_new_es_index_task(app_label, model_name, index_name, new_index_name):
+def create_new_es_index(app_label, model_name, index_name, new_index_name):
     model = apps.get_model(app_label, model_name)
     indices = registry.get_indices(models=[model])
     old_index = _get_index(indices=indices, index_name=index_name)
@@ -32,7 +44,7 @@ def create_new_es_index_task(app_label, model_name, index_name, new_index_name):
 
 
 @app.task(queue='web')
-def switch_es_index_task(app_label, model_name, index_name, new_index_name):
+def switch_es_index(app_label, model_name, index_name, new_index_name):
     model = apps.get_model(app_label, model_name)
     indices = registry.get_indices(models=[model])
     old_index = _get_index(indices=indices, index_name=index_name)
@@ -54,7 +66,7 @@ def switch_es_index_task(app_label, model_name, index_name, new_index_name):
 
 
 @app.task(queue='web')
-def index_objects_to_es_task(app_label, model_name, document_class, index_name, objects_id):
+def index_objects_to_es(app_label, model_name, document_class, index_name, objects_id):
     model = apps.get_model(app_label, model_name)
     document = _get_document(model=model, document_class=document_class)
 
@@ -65,7 +77,7 @@ def index_objects_to_es_task(app_label, model_name, document_class, index_name,
 
 
 @app.task(queue='web')
-def index_missing_objects_task(app_label, model_name, document_class, indexed_instance_ids):
+def index_missing_objects(app_label, model_name, document_class, indexed_instance_ids):
     """
     Task to insure that none of the object is missed from indexing.