Changes due to the review

Author: alallema

meilisearch/client.py

@@ -356,13 +356,13 @@ def get_dump_status(self, uid: str) -> Dict[str, str]:
             self.config.paths.dumps + '/' + str(uid) + '/status'
         )
 
-    def get_tasks(self) -> List[Dict[str, Any]]:
+    def get_tasks(self) -> Dict[str, List[Dict[str, Any]]]:
         """Get all tasks.
 
         Returns
         -------
         task:
-            List of all enqueued, processing, succeeded or failed actions of the index.
+            Dictionary containing a list of all enqueued, processing, succeeded or failed actions of the index.
 
         Raises
         ------

meilisearch/index.py

@@ -117,8 +117,8 @@ def get_primary_key(self) -> Optional[str]:
         """
         return self.fetch_info().primary_key
 
-    @classmethod
-    def create(cls, config: Config, uid: str, options: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+    @staticmethod
+    def create(config: Config, uid: str, options: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
         """Create the index.
 
         Parameters
@@ -144,13 +144,13 @@ def create(cls, config: Config, uid: str, options: Optional[Dict[str, Any]] = No
         payload = {**options, 'uid': uid}
         return HttpRequests(config).post(config.paths.index, payload)
 
-    def get_tasks(self) -> List[Dict[str, Any]]:
+    def get_tasks(self) -> Dict[str, List[Dict[str, Any]]]:
         """Get all tasks of a specific index from the last one.
 
         Returns
         -------
         task:
-            List of all enqueued, processing, succeeded or failed actions of the index.
+            Dictionary containing a list of all enqueued, processing, succeeded or failed actions of the index.
 
         Raises
         ------
@@ -216,7 +216,7 @@ def wait_for_task(
                 f'{self.config.paths.task}/{uid}'
             )
 
-            if get_task['status'] != 'enqueued' and get_task['status'] != 'processing':
+            if get_task['status'] not in ('enqueued', 'processing'):
                 return get_task
             sleep(interval_in_ms / 1000)
             time_delta = datetime.now() - start_time

tests/client/test_client_task_meilisearch.py

@@ -7,19 +7,16 @@ def test_get_tasks_default(client):
     """Tests getting the global tasks list."""
     tasks = client.get_tasks()
     assert isinstance(tasks, dict)
-    assert len(tasks) == 1
-    assert len(tasks['results']) != 0
+    assert 'results' in tasks
 
-def test_get_tasks(client, empty_index, small_movies):
+def test_get_tasks(client, empty_index):
     """Tests getting the global tasks list after populated an index."""
-    index = empty_index()
-    response = index.add_documents(small_movies)
-    assert 'uid' in response
-    response = index.add_documents(small_movies)
-    assert 'uid' in response
+    current_tasks = client.get_tasks()
+    pre_count = len(current_tasks["results"])
+    empty_index()
     tasks = client.get_tasks()
-    assert len(tasks) == 1
-    assert len(tasks['results']) != 0
+    assert isinstance(tasks, dict)
+    assert len(tasks['results']) == pre_count + 1
 
 def test_get_task(client):
     """Tests getting the tasks list of an empty index."""
@@ -29,13 +26,16 @@ def test_get_task(client):
     assert isinstance(task, dict)
     assert len(task) == 9
     assert 'uid' in task
+    assert 'indexUid' in task
     assert 'status' in task
     assert 'type' in task
     assert 'duration' in task
     assert 'enqueuedAt' in task
     assert 'finishedAt' in task
+    assert 'details' in task
+    assert 'startedAt' in task
 
 def test_get_task_inexistent(client):
     """Tests getting a task of an inexistent operation."""
     with pytest.raises(Exception):
-        client.get_task('999')
+        client.get_task('abc')

tests/conftest.py

@@ -20,14 +20,15 @@ def clear_indexes(client):
     # Deletes all the indexes in the MeiliSearch instance.
     indexes = client.get_indexes()
     for index in indexes:
-        client.index(index.uid).delete()
+        task = client.index(index.uid).delete()
+        client.wait_for_task(task['uid'])
 
 @fixture(scope='function')
 def indexes_sample(client):
     indexes = []
     for index_args in common.INDEX_FIXTURE:
-        response = client.create_index(**index_args)
-        client.wait_for_task(response['uid'])
+        task = client.create_index(**index_args)
+        client.wait_for_task(task['uid'])
         indexes.append(client.get_index(index_args['uid']))
     # Yields the indexes to the test to make them accessible.
     yield indexes
@@ -76,7 +77,7 @@ def index_maker(index_name=common.INDEX_UID):
 def index_with_documents(empty_index, small_movies):
     def index_maker(index_name=common.INDEX_UID, documents=small_movies):
         index = empty_index(index_name)
-        response = index.add_documents(documents)
-        index.wait_for_task(response['uid'])
+        task = index.add_documents(documents)
+        index.wait_for_task(task['uid'])
         return index
     return index_maker

tests/index/test_index.py

@@ -163,18 +163,19 @@ def test_get_primary_key(client):
     assert index.primary_key == 'book_id'
     assert index.get_primary_key() == 'book_id'
 
-@pytest.mark.usefixtures("indexes_sample")
-def test_update_index(client, empty_index):
+def test_update_index(empty_index):
     """Tests updating an index."""
     index = empty_index()
-    response = client.get_index(uid=common.INDEX_UID)
+    response = index.update(primary_key='objectID')
+    index.wait_for_task(response['uid'])
+    response = index.fetch_info()
     assert isinstance(response, Index)
     assert index.get_primary_key() == 'objectID'
     assert isinstance(index.created_at, datetime)
     assert isinstance(index.updated_at, datetime)
 
 @pytest.mark.usefixtures("indexes_sample")
-def test_delete_index(client):
+def test_delete_index_by_client(client):
     """Tests deleting an index."""
     response = client.index(uid=common.INDEX_UID).delete()
     assert response['status'] == 'enqueued'

tests/index/test_index_task_meilisearch.py

@@ -7,20 +7,18 @@ def test_get_tasks_default(empty_index):
     """Tests getting the tasks list of an empty index."""
     task = empty_index().get_tasks()
     assert isinstance(task, dict)
-    assert len(task) == 1
-    assert len(task['results']) == 1
+    assert 'results' in task
+    assert len(task['results']) != 0
 
 def test_get_tasks(empty_index, small_movies):
     """Tests getting the tasks list of a populated index."""
     index = empty_index()
+    current_tasks = index.get_tasks()
+    pre_count = len(current_tasks["results"])
     response = index.add_documents(small_movies)
     assert 'uid' in response
-    response = index.add_documents(small_movies)
-    assert 'uid' in response
-    assert 'status' in response
     task = index.get_tasks()
-    assert len(task) == 1
-    assert len(task['results']) > 2
+    assert len(task['results']) == pre_count + 1
 
 def test_get_task(client):
     """Tests getting a task of a operation."""
@@ -31,13 +29,16 @@ def test_get_task(client):
     assert isinstance(task, dict)
     assert len(task) == 9
     assert 'uid' in task
+    assert 'indexUid' in task
     assert 'status' in task
     assert 'type' in task
     assert 'duration' in task
     assert 'enqueuedAt' in task
     assert 'finishedAt' in task
+    assert 'details' in task
+    assert 'startedAt' in task
 
 def test_get_task_inexistent(empty_index):
     """Tests getting a task of an inexistent operation."""
     with pytest.raises(Exception):
-        empty_index().get_task('999')
+        empty_index().get_task('abc')

tests/index/test_index_wait_for_task.py

@@ -12,8 +12,7 @@ def test_wait_for_task_default(index_with_documents):
     update = index.wait_for_task(response['uid'])
     assert isinstance(update, dict)
     assert 'status' in update
-    assert update['status'] != 'enqueued'
-    assert update['status'] != 'processing'
+    assert update['status'] not in ('enqueued', 'processing')
 
 def test_wait_for_task_timeout(index_with_documents):
     """Tests timeout risen by waiting for an update."""