Merge pull request #476 from meilisearch/task_changes

Apply tasks changes

Author: alallema

meilisearch/client.py

@@ -383,20 +383,26 @@ def create_dump(self) -> Dict[str, str]:
         """
         return self.http.post(self.config.paths.dumps)
 
-    def get_tasks(self) -> Dict[str, List[Dict[str, Any]]]:
+    def get_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, List[Dict[str, Any]]]:
         """Get all tasks.
 
+        Parameters
+        ----------
+        parameters (optional):
+            parameters accepted by the get tasks route: https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks.
+            `indexUid` should be set as a List.
+
         Returns
         -------
         task:
-            Dictionary containing a list of all enqueued, processing, succeeded or failed tasks.
+            Dictionary with limit, from, next and results containing a list of all enqueued, processing, succeeded or failed tasks.
 
         Raises
         ------
         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 get_tasks(self.config)
+        return get_tasks(self.config, parameters=parameters)
 
     def get_task(self, uid: int) -> Dict[str, Any]:
         """Get one task.

meilisearch/index.py

@@ -124,20 +124,30 @@ def create(config: Config, uid: str, options: Optional[Dict[str, Any]] = None) -
         payload = {**options, 'uid': uid}
         return HttpRequests(config).post(config.paths.index, payload)
 
-    def get_tasks(self) -> Dict[str, List[Dict[str, Any]]]:
+    def get_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, List[Dict[str, Any]]]:
         """Get all tasks of a specific index from the last one.
 
+        Parameters
+        ----------
+        parameters (optional):
+            parameters accepted by the get tasks route: https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks.
+            `indexUid` should be set as a List.
+
         Returns
         -------
         task:
-            Dictionary containing a list of all enqueued, processing, succeeded or failed tasks of the index.
+            Dictionary with limit, from, next and results containing a list of all enqueued, processing, succeeded or failed tasks of the index.
 
         Raises
         ------
         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 get_tasks(self.config, self.uid)
+        if parameters is not None:
+            parameters.setdefault('indexUid', []).append(self.uid)
+        else:
+            parameters = {'indexUid': self.uid}
+        return get_tasks(self.config, parameters=parameters)
 
     def get_task(self, uid: int) -> Dict[str, Any]:
         """Get one task through the route of a specific index.
@@ -157,7 +167,7 @@ def get_task(self, uid: int) -> 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 get_task(self.config, uid, self.uid)
+        return get_task(self.config, uid)
 
     def wait_for_task(
         self, uid: int,

meilisearch/task.py

@@ -1,3 +1,4 @@
+from urllib import parse
 from time import sleep
 from datetime import datetime
 from typing import Any, Dict, List, Optional
@@ -6,36 +7,37 @@
 from meilisearch.config import Config
 from meilisearch.errors import MeiliSearchTimeoutError
 
-def get_tasks(config: Config, index_id: Optional[str] = None) -> Dict[str, List[Dict[str, Any]]]:
+def get_tasks(config: Config, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, List[Dict[str, Any]]]:
     """Get all tasks.
 
     Parameters
     ----------
     config:
         Config object containing permission and location of Meilisearch.
-    index_id:
-        The id of the `Index`.
+    parameters (optional):
+        parameters accepted by the get tasks route: https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks.
+        `indexUid` should be set as a List.
 
     Returns
     -------
     task:
-        Dictionary containing a list of all enqueued, processing, succeeded or failed tasks.
+        Dictionary with limit, from, next and results containing a list of all enqueued, processing, succeeded or failed tasks.
 
     Raises
     ------
     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
     """
     http = HttpRequests(config)
-    if index_id is None:
-        return http.get(
-            f'{config.paths.task}'
-        )
+    if parameters is None or parameters == {}:
+        parameters = {}
+    elif 'indexUid' in parameters:
+        parameters['indexUid'] = ",".join(parameters['indexUid'])
     return http.get(
-        f'{config.paths.index}/{index_id}/{config.paths.task}'
+        f"{config.paths.task}?{parse.urlencode(parameters)}"
     )
 
-def get_task(config: Config, uid: int, index_id: Optional[str] = None) -> Dict[str, Any]:
+def get_task(config: Config, uid: int) -> Dict[str, Any]:
     """Get one task.
 
     Parameters
@@ -58,12 +60,8 @@ def get_task(config: Config, uid: int, index_id: Optional[str] = None) -> Dict[s
         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 index_id is None:
-        return http.get(
-            f'{config.paths.task}/{uid}'
-        )
     return http.get(
-        f'{config.paths.index}/{index_id}/{config.paths.task}/{uid}'
+        f'{config.paths.task}/{uid}'
     )
 
 

tests/__init__.py

@@ -1,2 +1 @@
 from .common import MASTER_KEY, BASE_URL
-from .helper import wait_for_dump_creation

tests/client/test_client_task_meilisearch.py

@@ -10,19 +10,38 @@ def test_get_tasks_default(client):
     assert 'results' in tasks
 
 def test_get_tasks(client, empty_index):
-    """Tests getting the global tasks list after populated an index."""
+    """Tests getting the global tasks list after populating an index."""
     current_tasks = client.get_tasks()
-    pre_count = len(current_tasks["results"])
+    pre_count = current_tasks["from"]
     empty_index()
     tasks = client.get_tasks()
     assert isinstance(tasks, dict)
-    assert len(tasks['results']) == pre_count + 1
+    assert tasks['from'] == pre_count + 1
+
+def test_get_tasks_empty_parameters(client, empty_index):
+    """Tests getting the global tasks list after populating an index."""
+    tasks = client.get_tasks({})
+    assert isinstance(tasks, dict)
+    assert isinstance(tasks['results'], list)
+
+def test_get_tasks_with_parameters(client):
+    """Tests getting the global tasks list after populating an index."""
+    tasks = client.get_tasks({'limit': 1, 'from': 1})
+    assert isinstance(tasks, dict)
+    assert len(tasks['results']) == 1
+    assert tasks['results'][0]['uid'] == 1
+
+def test_get_tasks_with_index_uid(client):
+    """Tests getting the global tasks list after populating an index."""
+    tasks = client.get_tasks({'limit': 1, 'indexUid': [common.INDEX_UID]})
+    assert isinstance(tasks, dict)
+    assert len(tasks['results']) == 1
 
 def test_get_task(client):
     """Tests getting the tasks list of an empty index."""
     response = client.create_index(uid=common.INDEX_UID)
-    client.wait_for_task(response['uid'])
-    task = client.get_task(response['uid'])
+    client.wait_for_task(response['taskUid'])
+    task = client.get_task(response['taskUid'])
     assert isinstance(task, dict)
     assert len(task) == 9
     assert 'uid' in task

tests/conftest.py

@@ -23,14 +23,14 @@ def clear_indexes(client):
     indexes = client.get_indexes()
     for index in indexes:
         task = client.index(index.uid).delete()
-        client.wait_for_task(task['uid'])
+        client.wait_for_task(task['taskUid'])
 
 @fixture(scope='function')
 def indexes_sample(client):
     indexes = []
     for index_args in common.INDEX_FIXTURE:
         task = client.create_index(**index_args)
-        client.wait_for_task(task['uid'])
+        client.wait_for_task(task['taskUid'])
         indexes.append(client.get_index(index_args['uid']))
     # Yields the indexes to the test to make them accessible.
     yield indexes
@@ -78,18 +78,18 @@ def nested_movies():
 @fixture(scope='function')
 def empty_index(client, index_uid: Optional[str] = None):
     index_uid = index_uid if index_uid else common.INDEX_UID
-    def index_maker(index_name=index_uid):
-        task = client.create_index(uid=index_name)
-        client.wait_for_task(task['uid'])
-        return client.get_index(uid=index_name)
+    def index_maker(index_uid=index_uid):
+        task = client.create_index(uid=index_uid)
+        client.wait_for_task(task['taskUid'])
+        return client.get_index(uid=index_uid)
     return index_maker
 
 @fixture(scope='function')
 def index_with_documents(empty_index, small_movies):
-    def index_maker(index_name=common.INDEX_UID, documents=small_movies):
-        index = empty_index(index_name)
+    def index_maker(index_uid=common.INDEX_UID, documents=small_movies):
+        index = empty_index(index_uid)
         task = index.add_documents(documents)
-        index.wait_for_task(task['uid'])
+        index.wait_for_task(task['taskUid'])
         return index
     return index_maker
 

tests/index/test_index.py

@@ -19,7 +19,7 @@ def test_create_index(client, empty_index):
 def test_create_index_with_primary_key(client):
     """Tests creating an index with a primary key."""
     response = client.create_index(uid=common.INDEX_UID2, options={'primaryKey': 'book_id'})
-    client.wait_for_task(response['uid'])
+    client.wait_for_task(response['taskUid'])
     index = client.get_index(uid=common.INDEX_UID2)
     assert isinstance(index, Index)
     assert index.uid == common.INDEX_UID2
@@ -29,7 +29,7 @@ def test_create_index_with_primary_key(client):
 def test_create_index_with_uid_in_options(client):
     """Tests creating an index with a primary key."""
     response = client.create_index(uid=common.INDEX_UID3, options={'uid': 'wrong', 'primaryKey': 'book_id'})
-    client.wait_for_task(response['uid'])
+    client.wait_for_task(response['taskUid'])
     index = client.get_index(uid=common.INDEX_UID3)
     assert isinstance(index, Index)
     assert index.uid == common.INDEX_UID3
@@ -140,7 +140,7 @@ def test_update_index(empty_index):
     """Tests updating an index."""
     index = empty_index()
     response = index.update(primary_key='objectID')
-    index.wait_for_task(response['uid'])
+    index.wait_for_task(response['taskUid'])
     response = index.fetch_info()
     assert isinstance(response, Index)
     assert index.get_primary_key() == 'objectID'
@@ -152,17 +152,17 @@ def test_delete_index_by_client(client):
     """Tests deleting an index."""
     response = client.index(uid=common.INDEX_UID).delete()
     assert response['status'] == 'enqueued'
-    client.wait_for_task(response['uid'])
+    client.wait_for_task(response['taskUid'])
     with pytest.raises(Exception):
         client.get_index(uid=common.INDEX_UID)
     response = client.index(uid=common.INDEX_UID2).delete()
     assert response['status'] == 'enqueued'
-    client.wait_for_task(response['uid'])
+    client.wait_for_task(response['taskUid'])
     with pytest.raises(Exception):
         client.get_index(uid=common.INDEX_UID2)
     response = client.index(uid=common.INDEX_UID3).delete()
     assert response['status'] == 'enqueued'
-    client.wait_for_task(response['uid'])
+    client.wait_for_task(response['taskUid'])
     with pytest.raises(Exception):
         client.get_index(uid=common.INDEX_UID3)
     assert len(client.get_indexes()) == 0
@@ -171,14 +171,14 @@ def test_delete_index_by_client(client):
 def test_delete(client):
     assert client.get_index(uid=common.INDEX_UID)
     deleted = Client(BASE_URL, MASTER_KEY).index(common.INDEX_UID).delete()
-    client.wait_for_task(deleted['uid'])
+    client.wait_for_task(deleted['taskUid'])
     with pytest.raises(MeiliSearchApiError):
         client.get_index(uid=common.INDEX_UID)
 
 @pytest.mark.usefixtures("indexes_sample")
 def test_delete_index(client):
     assert client.get_index(uid=common.INDEX_UID)
     deleted = Client(BASE_URL, MASTER_KEY).delete_index(uid=common.INDEX_UID)
-    client.wait_for_task(deleted['uid'])
+    client.wait_for_task(deleted['taskUid'])
     with pytest.raises(MeiliSearchApiError):
         client.get_index(uid=common.INDEX_UID)