Merge pull request #426 from algolia/fix/duplicate-synonym-during-copy-index-between-app

Author: nunomaduro

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # Release Notes
 
+## Unreleased
+
+### Fixed
+- On `getVersion` param used by `search_index.get_settings` ([#426](https://github.com/algolia/algoliasearch-client-python/pull/426))
+
 ## [v2.0.3](https://github.com/algolia/algoliasearch-client-python/compare/2.0.2...2.0.3)
 
 ### Fixed

algoliasearch/search_index.py

@@ -132,7 +132,8 @@ def get_objects(self, object_ids, request_options=None):
                 request_options
             )
         # store attributesToRetrieve for use in each request
-        attributes_to_retrieve = request_options.data.pop('attributesToRetrieve', None)
+        attributes_to_retrieve = request_options.data.pop(
+            'attributesToRetrieve', None)
 
         requests = []
         for object_id in object_ids:
@@ -234,12 +235,16 @@ def set_settings(self, settings, request_options=None):
     def get_settings(self, request_options=None):
         # type: (Optional[Union[dict, RequestOptions]]) -> dict # noqa: E501
 
-        params = {'getVersion': 2}
+        if request_options is None or isinstance(request_options, dict):
+            request_options = RequestOptions.create(self._config,
+                                                    request_options)
+
+        request_options.query_parameters['getVersion'] = 2
 
         raw_response = self._transporter.read(
             Verb.GET,
             endpoint('1/indexes/{}/settings', self._name),
-            params,
+            None,
             request_options
         )
 

algoliasearch/search_index_async.py

@@ -80,12 +80,16 @@ def browse_rules_async(self, request_options=None):
     def get_settings_async(self, request_options=None):  # type: ignore
         # type: (Optional[Union[dict, RequestOptions]]) -> dict
 
-        params = {'getVersion': 2}
+        if request_options is None or isinstance(request_options, dict):
+            request_options = RequestOptions.create(self._config,
+                                                    request_options)
+
+        request_options.query_parameters['getVersion'] = 2
 
         raw_response = yield from self._transporter_async.read(
             Verb.GET,
             endpoint('1/indexes/{}/settings', self._name),
-            params,
+            None,
             request_options
         )
 

tests/features/test_account_client.py

@@ -46,6 +46,12 @@ def test_cross_app_copy_index(self):
         self.assertEqual(self.index2.get_rule('one'), rule)
 
         # Assert synonyms got copied
+        list_synonyms1 = [synonym for synonym in self.index.browse_synonyms()]
+        list_synonyms2 = [synonym for synonym in self.index2.browse_synonyms()]
+
+        self.assertEqual(list_synonyms1, list_synonyms2)
+
+        # Assert synomys are the same
         self.assertEqual(self.index2.get_synonym('one'), synonym)
 
         # Assert that copying again fails because index already exists

tests/unit/test_search_index.py

@@ -172,22 +172,48 @@ def test_get_settings(self):
             'ignorePlurals': True,
         }
 
-        settings = self.index.get_settings({'foo': 'bar'})
+        request_options = RequestOptions.create(self.config, {'foo': 'bar'})
+        settings = self.index.get_settings(request_options)
 
         self.transporter.read.assert_called_once_with(
             'GET',
             '1/indexes/index-name/settings',
-            {'getVersion': 2},  # asserts version 2 it's used.
-            {'foo': 'bar'}
+            None,
+            request_options
         )
 
+        self.assertEqual(request_options.query_parameters['getVersion'], 2)
+
         self.assertEqual(settings, {
             'searchableAttributes': ['attr1', 'attr2'],
             'numericAttributesForFiltering': ['attr1', 'attr2'],
             'replicas': ['index1', 'index2'],
             'ignorePlurals': True,
         })
 
+    def test_get_settings_none_as_request_options(self):
+        self.index.get_settings()
+
+        args = self.transporter.read.call_args[0]
+
+        self.assertEqual(args[3].query_parameters['getVersion'], 2)
+
+    def test_get_settings_dict_as_request_options(self):
+        self.index.get_settings({'foo': 'bar'})
+
+        args = self.transporter.read.call_args[0]
+
+        self.assertEqual(args[3].query_parameters['getVersion'], 2)
+
+    def test_get_settings_with_request_options(self):
+        request_options = RequestOptions.create(self.config, {'foo': 'bar'})
+
+        self.index.get_settings(request_options)
+
+        args = self.transporter.read.call_args[0]
+
+        self.assertEqual(args[3].query_parameters['getVersion'], 2)
+
     def test_save_synonyms(self):
         # Test null response
         self.index.save_synonyms([]).wait()