Fix #238: reindex deletes settings (again) (#241)

* chore(reindex_all): log settings if already there

* tests: Add test for reindex_all settings conservation

* fix(AlgoliaIndex): settings set for each instance, initialized if undefined

* fix(apply_some_settings): Reset to former value after setting

* refactor(test_reindex_with_settings): with various settings

* fix(reindex_all): Keep rules and synonyms over reindex, fixes #238

* refactor(test_index): Store index to delete in tearDown

* fix(test_index): Unique replicas for test_with_settings

Author: PLNech

algoliasearch_django/models.py

@@ -59,7 +59,7 @@ class AlgoliaIndex(object):
     index_name = None
 
     # Use to specify the settings of the index.
-    settings = {}
+    settings = None
 
     # Used to specify if the instance should be indexed.
     # The attribute should be either:
@@ -80,6 +80,9 @@ def __init__(self, model, client, settings):
         self.__named_fields = {}
         self.__translate_fields = {}
 
+        if self.settings is None:  # Only set settings if the actual index class does not define some
+            self.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
@@ -416,10 +419,14 @@ 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).
         """
+        should_keep_synonyms = False
+        should_keep_rules = False
         try:
             if not self.settings:
                 self.settings = self.get_settings()
                 logger.debug('Got settings for index %s: %s', self.index_name, self.settings)
+            else:
+                logger.debug("index %s already has settings: %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
@@ -442,6 +449,19 @@ def reindex_all(self, batch_size=1000):
 
                 self.__tmp_index.wait_task(self.__tmp_index.set_settings(self.settings)['taskID'])
                 logger.debug('APPLY SETTINGS ON %s_tmp', self.index_name)
+            rules = []
+            synonyms = []
+            for r in self.__index.iter_rules():
+                rules.append(r)
+            for s in self.__index.iter_synonyms():
+                synonyms.append(s)
+            if len(rules):
+                logger.debug('Got rules for index %s: %s', self.index_name, rules)
+                should_keep_rules = True
+            if len(synonyms):
+                logger.debug('Got synonyms for index %s: %s', self.index_name, rules)
+                should_keep_synonyms = True
+
             self.__tmp_index.clear_index()
             logger.debug('CLEAR INDEX %s_tmp', self.index_name)
 
@@ -483,6 +503,14 @@ def reindex_all(self, batch_size=1000):
                     logger.debug("RESTORE SLAVES")
                 if should_keep_replicas or should_keep_slaves:
                     self.__index.set_settings(self.settings)
+                if should_keep_rules:
+                    response = self.__index.batch_rules(rules, forward_to_replicas=True)
+                    self.__index.wait_task(response['taskID'])
+                    logger.info("Saved rules for index %s with response: {}".format(response), self.index_name)
+                if should_keep_synonyms:
+                    response = self.__index.batch_synonyms(synonyms, forward_to_replicas=True)
+                    self.__index.wait_task(response['taskID'])
+                    logger.info("Saved synonyms for index %s with response: {}".format(response), self.index_name)
             return counts
         except AlgoliaException as e:
             if DEBUG: