fix(reindex_all): Keep settings over reindex (#239)

* fix(reindex_all): Keep settings over reindex, fixes #238

* chore: Formatting

* refactor(reindex_all): Use Exception.args

Author: PLNech

algoliasearch_django/models.py

@@ -82,7 +82,7 @@ def __init__(self, model, client, settings):
 
         try:
             all_model_fields = [f.name for f in model._meta.get_fields() if not f.is_relation]
-        except AttributeError: # get_fields requires Django >= 1.8
+        except AttributeError:  # get_fields requires Django >= 1.8
             all_model_fields = [f.name for f in model._meta.local_fields]
 
         if isinstance(self.fields, str):
@@ -358,7 +358,19 @@ def raw_search(self, query='', params=None):
             if DEBUG:
                 raise e
             else:
-                logger.warning('ERROR DURING SEARCH: %s', e)
+                logger.warning('ERROR DURING SEARCH ON %s: %s', self.index_name, e)
+
+    def get_settings(self):
+        """Returns the settings of the index."""
+        try:
+            logger.info('GET SETTINGS ON %s', self.index_name)
+            return self.__index.get_settings()
+        except AlgoliaException as e:
+            if DEBUG:
+                raise e
+            else:
+                logger.warning('ERROR DURING GET_SETTINGS ON %s: %s',
+                               self.model, e)
 
     def set_settings(self):
         """Applies the settings to the index."""
@@ -404,6 +416,15 @@ def reindex_all(self, batch_size=1000):
         a method `get_queryset` in your subclass. This can be used to optimize
         the performance (for example with select_related or prefetch_related).
         """
+        try:
+            if not self.settings:
+                self.settings = self.get_settings()
+                logger.debug('Got settings for index %s: %s', self.index_name, self.settings)
+        except AlgoliaException as e:
+            if any("Index does not exist" in arg for arg in e.args):
+                pass  # Expected, let's clear and recreate from scratch
+            else:
+                raise e  # Unexpected error while getting settings
         try:
             if self.settings:
                 replicas = self.settings.get('replicas', None)

tests/test_index.py

@@ -1,4 +1,5 @@
 # coding=utf-8
+import time
 from django.conf import settings
 from django.test import TestCase
 
@@ -79,6 +80,7 @@ def test_index_name_settings(self):
 
     def test_reindex_with_replicas(self):
         index = AlgoliaIndex(Website, self.client, settings.ALGOLIA)
+
         class WebsiteIndex(AlgoliaIndex):
             settings = {
                 'replicas': [
@@ -97,6 +99,7 @@ def test_reindex_with_should_index_boolean(self):
             is_online=True
         )
         index = AlgoliaIndex(Website, self.client, settings.ALGOLIA)
+
         class WebsiteIndex(AlgoliaIndex):
             settings = {
                 'replicas': [
@@ -109,6 +112,28 @@ class WebsiteIndex(AlgoliaIndex):
         index = WebsiteIndex(Website, self.client, settings.ALGOLIA)
         index.reindex_all()
 
+    def test_reindex_no_settings(self):
+        self.maxDiff = None
+
+        class WebsiteIndex(AlgoliaIndex):
+            foo = {}
+
+        # Given an existing index with settings
+        index = AlgoliaIndex(Website, self.client, settings.ALGOLIA)
+        index.settings = {'hitsPerPage': 42}
+        index.reindex_all()
+        time.sleep(10)  # FIXME: Refactor reindex_all to use waitTask
+        index_settings = index.get_settings()
+
+        # When reindexing with no current settings
+        index.settings = None
+        index = WebsiteIndex(Website, self.client, settings.ALGOLIA)
+        index.reindex_all()
+
+        # Expect the settings to be kept across reindex
+        self.assertEqual(index.get_settings(), index_settings,
+                         "An index whose model has no settings should keep its settings after reindex")
+
     def test_custom_objectID(self):
         class UserIndex(AlgoliaIndex):
             custom_objectID = 'username'
@@ -432,6 +457,7 @@ def test_save_record_should_index_boolean(self):
             is_online=True
         )
         index = AlgoliaIndex(Website, self.client, settings.ALGOLIA)
+
         class WebsiteIndex(AlgoliaIndex):
             settings = {
                 'replicas': [