Merge branch 'main' into meili-bot/code-samples-v0-28

Author: alallema

.github/workflows/tests.yml

@@ -21,7 +21,7 @@ jobs:
     name: integration-tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
@@ -39,7 +39,7 @@ jobs:
     name: pylint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python 3.7
         uses: actions/setup-python@v2
         with:
@@ -55,7 +55,7 @@ jobs:
     name: mypy
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:

CONTRIBUTING.md

@@ -28,6 +28,15 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
 
 ### Setup <!-- omit in toc -->
 
+You can set up your local environment natively or using `docker`, check out the [`docker-compose.yml`](/docker-compose.yml).
+
+Example of running all the checks with docker:
+```bash
+docker-compose run --rm package bash -c "pipenv run mypy meilisearch && pipenv run pylint meilisearch && pipenv run pytest tests"
+```
+
+To install dependencies:
+
 ```bash
 pipenv install --dev
 ```
@@ -40,7 +49,7 @@ Each PR should pass the tests, mypy type checking, and the linter to be accepted
 # Tests
 curl -L https://install.meilisearch.com | sh # download Meilisearch
 ./meilisearch --master-key=masterKey --no-analytics # run Meilisearch
-pipenv run pytest meilisearch
+pipenv run pytest tests
 # MyPy
 pipenv run mypy meilisearch
 # Linter

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.8.4-buster
+
+COPY Pipfile .
+COPY Pipfile.lock .
+
+RUN apt-get update -y
+
+# Install pipenv and compilation dependencies
+RUN pip3 install pipenv
+RUN pipenv install --dev

Pipfile.lock

@@ -0,0 +1,24 @@
+version: "3.8"
+
+services:
+  package:
+    build: .
+    tty: true
+    stdin_open: true
+    working_dir: /home/package
+    environment:
+      - MEILISEARCH_HOST=http://meilisearch:7700
+    depends_on:
+      - meilisearch
+    links:
+      - meilisearch
+    volumes:
+      - ./:/home/package
+
+  meilisearch:
+    image: getmeili/meilisearch:latest
+    ports:
+      - "7700"
+    environment:
+      - MEILI_MASTER_KEY=masterKey
+      - MEILI_NO_ANALYTICS=true

docker-compose.yml

@@ -262,9 +262,14 @@ def get_key(self, key_or_uid: str) -> Dict[str, Any]:
         """
         return self.http.get(f'{self.config.paths.keys}/{key_or_uid}')
 
-    def get_keys(self) -> Dict[str, Any]:
+    def get_keys(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
         """Gets the Meilisearch API keys.
 
+        Parameters
+        ----------
+        parameters (optional):
+            parameters accepted by the get keys route: https://docs.meilisearch.com/reference/api/keys.html#get-all-keys
+
         Returns
         -------
         keys:
@@ -276,7 +281,11 @@ def get_keys(self) -> Dict[str, Any]:
         MeiliSearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
-        return self.http.get(self.config.paths.keys)
+        if parameters is None:
+            parameters = {}
+        return self.http.get(
+            f'{self.config.paths.keys}?{parse.urlencode(parameters)}'
+        )
 
     def create_key(
         self,

meilisearch/client.py

@@ -249,13 +249,15 @@ def search(self, query: str, opt_params: Optional[Dict[str, Any]] = None) -> Dic
             body=body
         )
 
-    def get_document(self, document_id: str) -> Dict[str, Any]:
+    def get_document(self, document_id: str, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
         """Get one document with given document identifier.
 
         Parameters
         ----------
         document_id:
             Unique identifier of the document.
+        parameters (optional):
+            parameters accepted by the get document route: https://docs.meilisearch.com/reference/api/documents.html#get-one-document
 
         Returns
         -------
@@ -267,8 +269,12 @@ def get_document(self, document_id: str) -> Dict[str, Any]:
         MeiliSearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
+        if parameters is None:
+            parameters = {}
+        elif 'fields' in parameters and isinstance(parameters['fields'], list):
+            parameters['fields'] = ",".join(parameters['fields'])
         return self.http.get(
-            f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}/{document_id}'
+            f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}/{document_id}?{parse.urlencode(parameters)}'
         )
 
     def get_documents(self, parameters: Optional[Dict[str, Any]] = None) -> List[Dict[str, Any]]:
@@ -291,6 +297,8 @@ def get_documents(self, parameters: Optional[Dict[str, Any]] = None) -> List[Dic
         """
         if parameters is None:
             parameters = {}
+        elif 'fields' in parameters and isinstance(parameters['fields'], list):
+            parameters['fields'] = ",".join(parameters['fields'])
         return self.http.get(
             f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}?{parse.urlencode(parameters)}'
         )

meilisearch/index.py

@@ -29,10 +29,11 @@ def get_tasks(config: Config, parameters: Optional[Dict[str, Any]] = None) -> Di
         An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
     """
     http = HttpRequests(config)
-    if parameters is None or parameters == {}:
+    if parameters is None:
         parameters = {}
-    elif 'indexUid' in parameters:
-        parameters['indexUid'] = ",".join(parameters['indexUid'])
+    for param in parameters:
+        if isinstance(parameters[param], list):
+            parameters[param] = ",".join(parameters[param])
     return http.get(
         f"{config.paths.task}?{parse.urlencode(parameters)}"
     )

meilisearch/task.py

@@ -13,6 +13,12 @@ def test_get_keys_default(client):
     assert keys['results'][0]['key'] is not None
     assert keys['results'][1]['key'] is not None
 
+def test_get_keys_with_parameters(client):
+    """Tests if search and admin keys have been generated and can be retrieved."""
+    keys = client.get_keys({'limit': 1})
+    assert isinstance(keys, dict)
+    assert len(keys['results']) == 1
+
 def test_get_key(client, test_key):
     """Tests if a key can be retrieved."""
     key = client.get_key(test_key['key'])
@@ -65,7 +71,7 @@ def test_update_keys(client, test_key_info):
     """Tests updating a key."""
     key = client.create_key(test_key_info)
     assert key['name'] == test_key_info['name']
-    update_key = client.update_key(key=key['key'], options={ 'name': 'keyTest' })
+    update_key = client.update_key(key_or_uid=key['key'], options={ 'name': 'keyTest' })
     assert update_key['key'] is not None
     assert update_key['expiresAt'] is None
     assert update_key['name'] == 'keyTest'

tests/client/test_client_key_meilisearch.py

@@ -1,5 +1,7 @@
+import os
+
 MASTER_KEY = 'masterKey'
-BASE_URL = 'http://127.0.0.1:7700'
+BASE_URL = os.getenv('MEILISEARCH_HOST') if os.getenv('MEILISEARCH_HOST') else 'http://127.0.0.1:7700'
 
 INDEX_UID = 'indexUID'
 INDEX_UID2 = 'indexUID2'

tests/common.py

@@ -50,6 +50,14 @@ def test_get_document(index_with_documents):
     assert 'title' in response
     assert response['title'] == 'The Highwaymen'
 
+def test_get_document_with_fields(index_with_documents):
+    """Tests getting one document from a populated index."""
+    response = index_with_documents().get_document('500682', {'fields' : ['id', 'title']})
+    assert isinstance(response, dict)
+    assert 'title' in response
+    assert 'poster' not in response
+    assert response['title'] == 'The Highwaymen'
+
 def test_get_document_inexistent(empty_index):
     """Tests getting one inexistent document from a populated index."""
     with pytest.raises(Exception):
@@ -73,6 +81,7 @@ def test_get_documents_offset_optional_params(index_with_documents):
         'fields': 'title'
     })
     assert len(response_offset_limit['results']) == 3
+    assert 'title' in response_offset_limit['results'][0]
     assert response_offset_limit['results'][0]['title'] == response['results'][1]['title']
 
 def test_update_documents(index_with_documents, small_movies):

tests/index/test_index_document_meilisearch.py

@@ -12,7 +12,7 @@ def test_get_tasks_default(index_with_documents):
 
 def test_get_tasks(empty_index, small_movies):
     """Tests getting the tasks list of a populated index."""
-    index = empty_index()
+    index = empty_index("test_task")
     current_tasks = index.get_tasks()
     pre_count = len(current_tasks['results'])
     response = index.add_documents(small_movies)