Apply tasks changes

Author: alallema

meilisearch/index.py

@@ -137,7 +137,7 @@ def get_tasks(self) -> Dict[str, List[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_tasks(self.config, self.uid)
+        return get_tasks(self.config)
 
     def get_task(self, uid: int) -> Dict[str, Any]:
         """Get one task through the route of a specific index.
@@ -157,7 +157,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

@@ -6,7 +6,7 @@
 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) -> Dict[str, List[Dict[str, Any]]]:
     """Get all tasks.
 
     Parameters
@@ -27,15 +27,11 @@ def get_tasks(config: Config, index_id: Optional[str] = None) -> Dict[str, List[
         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}'
-        )
     return http.get(
-        f'{config.paths.index}/{index_id}/{config.paths.task}'
+        f'{config.paths.task}'
     )
 
-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 +54,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/client/test_client_dumps.py

@@ -8,22 +8,5 @@ def test_dump_creation(client, index_with_documents):
     """Tests the creation of a Meilisearch dump."""
     index_with_documents("indexUID-dump-creation")
     dump = client.create_dump()
-    assert dump['uid'] is not None
-    assert dump['status'] == 'in_progress'
-    wait_for_dump_creation(client, dump['uid'])
-
-def test_dump_status_route(client, index_with_documents):
-    """Tests the route for getting a Meilisearch dump status."""
-    index_with_documents("indexUID-dump-status")
-    dump = client.create_dump()
-    assert dump['uid'] is not None
-    assert dump['status'] == 'in_progress'
-    dump_status = client.get_dump_status(dump['uid'])
-    assert dump_status['uid'] is not None
-    assert dump_status['status'] is not None
-    wait_for_dump_creation(client, dump['uid'])
-
-def test_dump_status_nonexistent_uid_raises_error(client):
-    """Tests the route for getting an inexistent dump status."""
-    with pytest.raises(MeiliSearchApiError):
-        client.get_dump_status('uid_not_exists')
+    assert dump['taskUid'] is not None
+    client.wait_for_task(dump['taskUid'])

tests/client/test_client_task_meilisearch.py

@@ -12,17 +12,17 @@ def test_get_tasks_default(client):
 def test_get_tasks(client, empty_index):
     """Tests getting the global tasks list after populated 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_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)

tests/index/test_index_document_meilisearch.py

@@ -16,8 +16,8 @@ def test_add_documents(empty_index, small_movies):
     index = empty_index()
     response = index.add_documents(small_movies)
     assert isinstance(response, dict)
-    assert 'uid' in response
-    update = index.wait_for_task(response['uid'])
+    assert 'taskUid' in response
+    update = index.wait_for_task(response['taskUid'])
     assert index.get_primary_key() == 'id'
     assert update['status'] == 'succeeded'
 
@@ -38,9 +38,9 @@ def test_add_documents_in_batches(
 
     print(response, '\n', '\n')
     for r in response:
-        assert 'uid' in r
-        update = index.wait_for_task(r['uid'])
-        print(index.get_task(r['uid']), '\n')
+        assert 'taskUid' in r
+        update = index.wait_for_task(r['taskUid'])
+        print(index.get_task(r['taskUid']), '\n')
         assert update['status'] == 'succeeded'
 
     assert index.get_primary_key() == expected_primary_key
@@ -84,12 +84,12 @@ def test_update_documents(index_with_documents, small_movies):
     response[0]['title'] = 'Some title'
     update = index.update_documents([response[0]])
     assert isinstance(update, dict)
-    assert 'uid' in update
-    index.wait_for_task(update['uid'])
+    assert 'taskUid' in update
+    index.wait_for_task(update['taskUid'])
     response = index.get_documents()
     assert response[0]['title'] == 'Some title'
     update = index.update_documents(small_movies)
-    index.wait_for_task(update['uid'])
+    index.wait_for_task(update['taskUid'])
     response = index.get_documents()
     assert response[0]['title'] != 'Some title'
 
@@ -109,8 +109,8 @@ def test_update_documents_in_batches(
     assert ceil(len(small_movies) / batch_size) == len(response)
 
     for r in response:
-        assert 'uid' in r
-        update = index.wait_for_task(r['uid'])
+        assert 'taskUid' in r
+        update = index.wait_for_task(r['taskUid'])
         assert update['status'] == 'succeeded'
 
     assert index.get_primary_key() == expected_primary_key
@@ -120,8 +120,8 @@ def test_delete_document(index_with_documents):
     index = index_with_documents()
     response = index.delete_document('500682')
     assert isinstance(response, dict)
-    assert 'uid' in response
-    index.wait_for_task(response['uid'])
+    assert 'taskUid' in response
+    index.wait_for_task(response['taskUid'])
     with pytest.raises(Exception):
         index.get_document('500682')
 
@@ -131,8 +131,8 @@ def test_delete_documents(index_with_documents):
     index = index_with_documents()
     response = index.delete_documents(to_delete)
     assert isinstance(response, dict)
-    assert 'uid' in response
-    index.wait_for_task(response['uid'])
+    assert 'taskUid' in response
+    index.wait_for_task(response['taskUid'])
     for document in to_delete:
         with pytest.raises(Exception):
             index.get_document(document)
@@ -142,8 +142,8 @@ def test_delete_all_documents(index_with_documents):
     index = index_with_documents()
     response = index.delete_all_documents()
     assert isinstance(response, dict)
-    assert 'uid' in response
-    index.wait_for_task(response['uid'])
+    assert 'taskUid' in response
+    index.wait_for_task(response['taskUid'])
     response = index.get_documents()
     assert isinstance(response, list)
     assert response == []
@@ -153,8 +153,8 @@ def test_add_documents_csv(empty_index, songs_csv):
     index = empty_index()
     response = index.add_documents_csv(songs_csv)
     assert isinstance(response, dict)
-    assert 'uid' in response
-    task = index.wait_for_task(response['uid'])
+    assert 'taskUid' in response
+    task = index.wait_for_task(response['taskUid'])
     assert task['status'] == 'succeeded'
     assert index.get_primary_key() == 'id'
 
@@ -163,8 +163,8 @@ def test_add_documents_json(empty_index, small_movies_json_file):
     index = empty_index()
     response = index.add_documents_json(small_movies_json_file)
     assert isinstance(response, dict)
-    assert 'uid' in response
-    task = index.wait_for_task(response['uid'])
+    assert 'taskUid' in response
+    task = index.wait_for_task(response['taskUid'])
     assert task['status'] == 'succeeded'
     assert index.get_primary_key() == 'id'
 
@@ -173,7 +173,7 @@ def test_add_documents_ndjson(empty_index, songs_ndjson):
     index = empty_index()
     response = index.add_documents_ndjson(songs_ndjson)
     assert isinstance(response, dict)
-    assert 'uid' in response
-    task = index.wait_for_task(response['uid'])
+    assert 'taskUid' in response
+    task = index.wait_for_task(response['taskUid'])
     assert task['status'] == 'succeeded'
     assert index.get_primary_key() == 'id'