Fix bug with get_tasks not returning all information

Author: sanders41

meilisearch_python_async/models/task.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
 import pydantic
 from camel_converter.pydantic_base import CamelBase
@@ -12,17 +12,17 @@ class TaskId(CamelBase):
     uid: int
 
 
-class TaskStatus(TaskId):
+class TaskResult(TaskId):
     index_uid: Optional[str] = None
     status: str
     task_type: Union[str, Dict[str, Any]] = Field(..., alias="type")
-    details: Optional[Dict[str, Any]]
-    error: Optional[Dict[str, Any]]
-    canceled_by: Optional[int]
-    duration: Optional[str]
+    details: Optional[Dict[str, Any]] = None
+    error: Optional[Dict[str, Any]] = None
+    canceled_by: Optional[int] = None
+    duration: Optional[str] = None
     enqueued_at: datetime
-    started_at: Optional[datetime]
-    finished_at: Optional[datetime]
+    started_at: Optional[datetime] = None
+    finished_at: Optional[datetime] = None
 
     if is_pydantic_2():
 
@@ -69,6 +69,13 @@ def validate_finished_at(cls, v: str) -> Union[datetime, None]:
             return iso_to_date_time(v)
 
 
+class TaskStatus(CamelBase):
+    results: List[TaskResult]
+    limit: int
+    from_: int = Field(..., alias="from")
+    next: Optional[int] = None
+
+
 class TaskInfo(CamelBase):
     task_uid: int
     index_uid: Optional[str] = None

meilisearch_python_async/task.py

@@ -9,7 +9,7 @@
 
 from meilisearch_python_async._http_requests import HttpRequests
 from meilisearch_python_async.errors import MeilisearchTaskFailedError, MeilisearchTimeoutError
-from meilisearch_python_async.models.task import TaskInfo, TaskStatus
+from meilisearch_python_async.models.task import TaskInfo, TaskResult, TaskStatus
 
 if TYPE_CHECKING:
     from meilisearch_python_async.client import Client  # pragma: no cover
@@ -156,7 +156,7 @@ async def get_tasks(
     *,
     index_ids: list[str] | None = None,
     types: str | list[str] | None = None,
-) -> list[TaskStatus]:
+) -> TaskStatus:
     """Get multiple tasks.
 
     Args:
@@ -168,7 +168,7 @@ async def get_tasks(
 
     Returns:
 
-        A list of all tasks.
+        Task statuses.
 
     Raises:
 
@@ -191,10 +191,10 @@ async def get_tasks(
     client_ = _get_client(client)
     response = await client_.get(url)
 
-    return [TaskStatus(**x) for x in response.json()["results"]]
+    return TaskStatus(**response.json())
 
 
-async def get_task(client: AsyncClient | Client, task_id: int) -> TaskStatus:
+async def get_task(client: AsyncClient | Client, task_id: int) -> TaskResult:
     """Get a single task from it's task id.
 
     Args:
@@ -204,7 +204,7 @@ async def get_task(client: AsyncClient | Client, task_id: int) -> TaskStatus:
 
     Returns:
 
-        A list of all tasks.
+        Results of a task.
 
     Raises:
 
@@ -223,7 +223,7 @@ async def get_task(client: AsyncClient | Client, task_id: int) -> TaskStatus:
     client_ = _get_client(client)
     response = await client_.get(f"tasks/{task_id}")
 
-    return TaskStatus(**response.json())
+    return TaskResult(**response.json())
 
 
 async def wait_for_task(
@@ -233,7 +233,7 @@ async def wait_for_task(
     timeout_in_ms: int | None = 5000,
     interval_in_ms: int = 50,
     raise_for_status: bool = False,
-) -> TaskStatus:
+) -> TaskResult:
     """Wait until Meilisearch processes a task, and get its status.
 
     Args:
@@ -280,7 +280,7 @@ async def wait_for_task(
     if timeout_in_ms:
         while elapsed_time < timeout_in_ms:
             response = await http_requests.get(url)
-            status = TaskStatus(**response.json())
+            status = TaskResult(**response.json())
             if status.status in ("succeeded", "failed"):
                 if raise_for_status and status.status == "failed":
                     raise MeilisearchTaskFailedError(f"Task {task_id} failed")
@@ -294,7 +294,7 @@ async def wait_for_task(
     else:
         while True:
             response = await http_requests.get(url)
-            status = TaskStatus(**response.json())
+            status = TaskResult(**response.json())
             if status.status in ("succeeded", "failed"):
                 return status
             await sleep(interval_in_ms / 1000)

tests/test_task.py

@@ -35,8 +35,8 @@ async def test_cancel_statuses(test_client):
     assert completed_task.index_uid is None
     assert completed_task.status == "succeeded"
     assert completed_task.task_type == "taskCancelation"
-    assert tasks[0].details is not None
-    assert "statuses=enqueued%2Cprocessing" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert "statuses=enqueued%2Cprocessing" in tasks.results[0].details["originalFilter"]
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -48,8 +48,8 @@ async def test_cancel_tasks_uids(test_client):
 
     assert completed_task.status == "succeeded"
     assert completed_task.task_type == "taskCancelation"
-    assert tasks[0].details is not None
-    assert "uids=1%2C2" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert "uids=1%2C2" in tasks.results[0].details["originalFilter"]
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -62,8 +62,8 @@ async def test_cancel_tasks_index_uids(test_client):
 
     assert completed_task.status == "succeeded"
     assert completed_task.task_type == "taskCancelation"
-    assert tasks[0].details is not None
-    assert "indexUids=1" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert "indexUids=1" in tasks.results[0].details["originalFilter"]
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -75,8 +75,8 @@ async def test_cancel_tasks_types(test_client):
 
     assert completed_task.status == "succeeded"
     assert completed_task.task_type == "taskCancelation"
-    assert tasks[0].details is not None
-    assert "types=taskDeletion" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert "types=taskDeletion" in tasks.results[0].details["originalFilter"]
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -89,9 +89,10 @@ async def test_cancel_tasks_before_enqueued_at(test_client):
 
     assert completed_task.status == "succeeded"
     assert completed_task.task_type == "taskCancelation"
-    assert tasks[0].details is not None
+    assert tasks.results[0].details is not None
     assert (
-        f"beforeEnqueuedAt={quote_plus(before.isoformat())}Z" in tasks[0].details["originalFilter"]
+        f"beforeEnqueuedAt={quote_plus(before.isoformat())}Z"
+        in tasks.results[0].details["originalFilter"]
     )
 
 
@@ -105,8 +106,11 @@ async def test_cancel_tasks_after_enqueued_at(test_client):
 
     assert completed_task.status == "succeeded"
     assert completed_task.task_type == "taskCancelation"
-    assert tasks[0].details is not None
-    assert f"afterEnqueuedAt={quote_plus(after.isoformat())}Z" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert (
+        f"afterEnqueuedAt={quote_plus(after.isoformat())}Z"
+        in tasks.results[0].details["originalFilter"]
+    )
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -119,9 +123,10 @@ async def test_cancel_tasks_before_started_at(test_client):
 
     assert completed_task.status == "succeeded"
     assert completed_task.task_type == "taskCancelation"
-    assert tasks[0].details is not None
+    assert tasks.results[0].details is not None
     assert (
-        f"beforeStartedAt={quote_plus(before.isoformat())}Z" in tasks[0].details["originalFilter"]
+        f"beforeStartedAt={quote_plus(before.isoformat())}Z"
+        in tasks.results[0].details["originalFilter"]
     )
 
 
@@ -135,8 +140,11 @@ async def test_cancel_tasks_after_finished_at(test_client):
 
     assert completed_task.status == "succeeded"
     assert completed_task.task_type == "taskCancelation"
-    assert tasks[0].details is not None
-    assert f"afterFinishedAt={quote_plus(after.isoformat())}Z" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert (
+        f"afterFinishedAt={quote_plus(after.isoformat())}Z"
+        in tasks.results[0].details["originalFilter"]
+    )
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -148,8 +156,8 @@ async def test_cancel_task_no_params(test_client):
 
     assert completed_task.status == "succeeded"
     assert completed_task.task_type == "taskCancelation"
-    assert tasks[0].details is not None
-    assert "statuses=enqueued%2Cprocessing" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert "statuses=enqueued%2Cprocessing" in tasks.results[0].details["originalFilter"]
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -161,8 +169,8 @@ async def test_delete_statuses(test_client):
 
     assert deleted_tasks.status == "succeeded"
     assert deleted_tasks.task_type == "taskDeletion"
-    assert tasks[0].details is not None
-    assert "statuses=enqueued%2Cprocessing" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert "statuses=enqueued%2Cprocessing" in tasks.results[0].details["originalFilter"]
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -174,8 +182,8 @@ async def test_delete_tasks(test_client):
 
     assert completed_task.status == "succeeded"
     assert completed_task.task_type == "taskDeletion"
-    assert tasks[0].details is not None
-    assert "uids=1%2C2" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert "uids=1%2C2" in tasks.results[0].details["originalFilter"]
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -187,8 +195,8 @@ async def test_delete_tasks_index_uids(test_client):
 
     assert deleted_task.status == "succeeded"
     assert deleted_task.task_type == "taskDeletion"
-    assert tasks[0].details is not None
-    assert "indexUids=1" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert "indexUids=1" in tasks.results[0].details["originalFilter"]
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -200,8 +208,8 @@ async def test_delete_tasks_types(test_client):
 
     assert deleted_task.status == "succeeded"
     assert deleted_task.task_type == "taskDeletion"
-    assert tasks[0].details is not None
-    assert "types=taskDeletion" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert "types=taskDeletion" in tasks.results[0].details["originalFilter"]
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -214,9 +222,10 @@ async def test_delete_tasks_before_enqueued_at(test_client):
 
     assert deleted_task.status == "succeeded"
     assert deleted_task.task_type == "taskDeletion"
-    assert tasks[0].details is not None
+    assert tasks.results[0].details is not None
     assert (
-        f"beforeEnqueuedAt={quote_plus(before.isoformat())}Z" in tasks[0].details["originalFilter"]
+        f"beforeEnqueuedAt={quote_plus(before.isoformat())}Z"
+        in tasks.results[0].details["originalFilter"]
     )
 
 
@@ -230,8 +239,11 @@ async def test_delete_tasks_after_enqueued_at(test_client):
 
     assert deleted_task.status == "succeeded"
     assert deleted_task.task_type == "taskDeletion"
-    assert tasks[0].details is not None
-    assert f"afterEnqueuedAt={quote_plus(after.isoformat())}Z" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert (
+        f"afterEnqueuedAt={quote_plus(after.isoformat())}Z"
+        in tasks.results[0].details["originalFilter"]
+    )
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -244,9 +256,10 @@ async def test_delete_tasks_before_started_at(test_client):
 
     assert deleted_task.status == "succeeded"
     assert deleted_task.task_type == "taskDeletion"
-    assert tasks[0].details is not None
+    assert tasks.results[0].details is not None
     assert (
-        f"beforeStartedAt={quote_plus(before.isoformat())}Z" in tasks[0].details["originalFilter"]
+        f"beforeStartedAt={quote_plus(before.isoformat())}Z"
+        in tasks.results[0].details["originalFilter"]
     )
 
 
@@ -260,8 +273,11 @@ async def test_delete_tasks_after_finished_at(test_client):
 
     assert deleted_task.status == "succeeded"
     assert deleted_task.task_type == "taskDeletion"
-    assert tasks[0].details is not None
-    assert f"afterFinishedAt={quote_plus(after.isoformat())}Z" in tasks[0].details["originalFilter"]
+    assert tasks.results[0].details is not None
+    assert (
+        f"afterFinishedAt={quote_plus(after.isoformat())}Z"
+        in tasks.results[0].details["originalFilter"]
+    )
 
 
 @pytest.mark.usefixtures("create_tasks")
@@ -273,36 +289,36 @@ async def test_delete_no_params(test_client):
 
     assert deleted_tasks.status == "succeeded"
     assert deleted_tasks.task_type == "taskDeletion"
-    assert tasks[0].details is not None
+    assert tasks.results[0].details is not None
     assert (
         "statuses=canceled%2Cenqueued%2Cfailed%2Cprocessing%2Csucceeded"
-        in tasks[0].details["originalFilter"]
+        in tasks.results[0].details["originalFilter"]
     )
 
 
 async def test_get_tasks(empty_index, small_movies):
     index = await empty_index()
     tasks = await get_tasks(index.http_client)
-    current_tasks = len(tasks)
+    current_tasks = len(tasks.results)
     response = await index.add_documents(small_movies)
     await wait_for_task(index.http_client, response.task_uid)
     response = await index.add_documents(small_movies)
     await wait_for_task(index.http_client, response.task_uid)
     response = await get_tasks(index.http_client)
-    assert len(response) >= current_tasks
+    assert len(response.results) >= current_tasks
 
 
 async def test_get_tasks_for_index(empty_index, small_movies):
     index = await empty_index()
     tasks = await get_tasks(index.http_client, index_ids=[index.uid])
-    current_tasks = len(tasks)
+    current_tasks = len(tasks.results)
     response = await index.add_documents(small_movies)
     await wait_for_task(index.http_client, response.task_uid)
     response = await index.add_documents(small_movies)
     await wait_for_task(index.http_client, response.task_uid)
     response = await get_tasks(index.http_client, index_ids=[index.uid])
-    assert len(response) >= current_tasks
-    uid = set([x.index_uid for x in response])
+    assert len(response.results) >= current_tasks
+    uid = set([x.index_uid for x in response.results])
     assert len(uid) == 1
     assert next(iter(uid)) == index.uid