Skip to content

Fix bug: Search optional params are not applied when they are a list of strings #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions meilisearch/index.py
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,9 @@ def search(self, query, opt_params=None):
if opt_params is None:
opt_params = {}
search_param = {'q': query}
for key in opt_params:
if isinstance(opt_params[key], list):
opt_params[key] = ','.join(opt_params[key])
params = {**search_param, **opt_params}
return self.http.get(
'{}/{}/{}?{}'.format(
Expand Down
18 changes: 9 additions & 9 deletions meilisearch/tests/index/test_index_document_meilisearch.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class TestDocument:

def setup_class(self):
self.index = self.client.create_index(uid='indexUID')
self.dataset_file = open("./datasets/small_movies.json", "r")
self.dataset_file = open('./datasets/small_movies.json', 'r')
self.dataset_json = json.loads(self.dataset_file.read())
self.dataset_file.close()

Expand All @@ -38,15 +38,15 @@ def test_add_documents(self):

def test_get_document(self):
"""Tests getting one document on a populated index"""
response = self.index.get_document("500682")
response = self.index.get_document('500682')
assert isinstance(response, object)
assert 'title' in response
assert response['title'] == 'The Highwaymen'

def test_get_document_inexistent(self):
"""Tests getting one INEXISTENT document on a populated index"""
with pytest.raises(Exception):
self.index.get_document("123")
self.index.get_document('123')

def test_get_documents_populated(self):
"""Tests getting documents on a populated index"""
Expand All @@ -70,30 +70,30 @@ def test_get_documents_offset_optional_params(self):
def test_update_documents(self):
"""Tests updating a single document and a set of documents """
response = self.index.get_documents()
response[0]['title'] = "Some title"
response[0]['title'] = 'Some title'
update = self.index.update_documents([response[0]])
assert isinstance(update, object)
assert 'updateId' in update
self.index.wait_for_pending_update(update['updateId'])
response = self.index.get_documents()
assert response[0]['title'] == "Some title"
assert response[0]['title'] == 'Some title'
update = self.index.update_documents(self.dataset_json)
self.index.wait_for_pending_update(update['updateId'])
response = self.index.get_documents()
assert response[0]['title'] != "Some title"
assert response[0]['title'] != 'Some title'

def test_delete_document(self):
"""Tests deleting a single document"""
response = self.index.delete_document("500682")
response = self.index.delete_document('500682')
assert isinstance(response, object)
assert 'updateId' in response
self.index.wait_for_pending_update(response['updateId'])
with pytest.raises(Exception):
self.index.get_document("500682")
self.index.get_document('500682')

def test_delete_documents(self):
"""Tests deleting a set of documents """
to_delete = ["522681", "450465", "329996"]
to_delete = ['522681', '450465', '329996']
response = self.index.delete_documents(to_delete)
assert isinstance(response, object)
assert 'updateId' in response
Expand Down
25 changes: 20 additions & 5 deletions meilisearch/tests/index/test_index_search_meilisearch.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class TestSearch:

def setup_class(self):
self.index = self.client.create_index(uid='indexUID')
self.dataset_file = open("./datasets/small_movies.json", "r")
self.dataset_file = open('./datasets/small_movies.json', 'r')
self.dataset_json = json.loads(self.dataset_file.read())
self.dataset_file.close()
response = self.index.add_documents(self.dataset_json, primary_key='id')
Expand Down Expand Up @@ -83,8 +83,23 @@ def test_basic_search_params_with_simple_string(self):
assert isinstance(response, object)
assert len(response['hits']) == 5
assert '_formatted' in response['hits'][0]
assert "title" in response['hits'][0]['_formatted']
assert not "release_date" in response['hits'][0]['_formatted']
assert 'title' in response['hits'][0]['_formatted']
assert not 'release_date' in response['hits'][0]['_formatted']

# Add def test_basic_search_params_with_string_list(self):
# when bug (issue #85) is fixed
def test_basic_search_params_with_string_list(self):
"""Tests search with string list in query params"""
response = self.index.search(
'a',
{
'limit': 5,
'attributesToRetrieve': ['title', 'overview'],
'attributesToHighlight': ['title'],
}
)
assert isinstance(response, object)
assert len(response['hits']) == 5
assert 'title' in response['hits'][0]
assert 'overview' in response['hits'][0]
assert not 'release_date' in response['hits'][0]
assert 'title' in response['hits'][0]['_formatted']
assert not 'overview' in response['hits'][0]['_formatted']
2 changes: 1 addition & 1 deletion meilisearch/tests/index/test_index_update_meilisearch.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class TestUpdate:

def setup_class(self):
self.index = self.client.create_index(uid='indexUID')
self.dataset_file = open("./datasets/small_movies.json", "r")
self.dataset_file = open('./datasets/small_movies.json', 'r')
self.dataset_json = json.loads(self.dataset_file.read())
self.dataset_file.close()

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class TestUpdate:

def setup_class(self):
self.index = self.client.create_index(uid='indexUID')
self.dataset_file = open("./datasets/small_movies.json", "r")
self.dataset_file = open('./datasets/small_movies.json', 'r')
self.dataset_json = json.loads(self.dataset_file.read())
self.dataset_file.close()

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class TestDisplayedAttributes:

def setup_class(self):
self.index = self.client.create_index(uid='indexUID')
self.dataset_file = open("./datasets/small_movies.json", "r")
self.dataset_file = open('./datasets/small_movies.json', 'r')
self.dataset_json = json.loads(self.dataset_file.read())
self.dataset_file.close()

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class TestSearchableAttributes:

def setup_class(self):
self.index = self.client.create_index(uid='indexUID')
self.dataset_file = open("./datasets/small_movies.json", "r")
self.dataset_file = open('./datasets/small_movies.json', 'r')
self.dataset_json = json.loads(self.dataset_file.read())
self.dataset_file.close()

Expand Down