Add deleteTasks method to Client

meilisearch · Nov 26, 2022 · 029ac51 · 029ac51
1 parent 3e56de2
commit 029ac51
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/src/Endpoints/Delegates/HandlesTasks.php b/src/Endpoints/Delegates/HandlesTasks.php
@@ -5,6 +5,7 @@
 namespace MeiliSearch\Endpoints\Delegates;
 
 use MeiliSearch\Contracts\CancelTasksQuery;
+use MeiliSearch\Contracts\DeleteTasksQuery;
 use MeiliSearch\Contracts\TasksQuery;
 use MeiliSearch\Contracts\TasksResults;
 
@@ -24,6 +25,11 @@ public function getTasks(TasksQuery $options = null): TasksResults
         return new TasksResults($response);
     }
 
+    public function deleteTasks(DeleteTasksQuery $options = null): array
+    {
+        return $this->tasks->deleteTasks($options);
+    }
+
     public function cancelTasks(CancelTasksQuery $options = null): array
     {
         return $this->tasks->cancelTasks($options);

diff --git a/src/Endpoints/Tasks.php b/src/Endpoints/Tasks.php
@@ -5,6 +5,7 @@
 namespace MeiliSearch\Endpoints;
 
 use MeiliSearch\Contracts\CancelTasksQuery;
+use MeiliSearch\Contracts\DeleteTasksQuery;
 use MeiliSearch\Contracts\Endpoint;
 use MeiliSearch\Exceptions\TimeOutException;
 
@@ -30,6 +31,14 @@ public function cancelTasks(?CancelTasksQuery $options): array
         return $response;
     }
 
+    public function deleteTasks(?DeleteTasksQuery $options): array
+    {
+        $options = $options ?? new DeleteTasksQuery();
+        $response = $this->http->delete(self::PATH, $options->toArray());
+
+        return $response;
+    }
+
     /**
      * @throws TimeOutException
      */

diff --git a/tests/Endpoints/IndexTest.php b/tests/Endpoints/IndexTest.php
@@ -4,6 +4,7 @@
 
 namespace Tests\Endpoints;
 
+use MeiliSearch\Contracts\DeleteTasksQuery;
 use MeiliSearch\Contracts\TasksQuery;
 use MeiliSearch\Endpoints\Indexes;
 use MeiliSearch\Exceptions\TimeOutException;
@@ -276,6 +277,15 @@ public function testSwapIndexes(): void
         $this->assertSame($response['details']['swaps'], [['indexes' => ['indexA', 'indexB']], ['indexes' => ['indexC', 'indexD']]]);
     }
 
+    public function testDeleteTasks(): void
+    {
+        $promise = $this->client->deleteTasks((new DeleteTasksQuery())->setUids([1, 2]));
+        $response = $this->client->waitForTask($promise['taskUid']);
+
+        $this->assertSame($response['details']['originalFilter'], '?uids=1%2C2');
+        $this->assertIsNumeric($response['details']['matchedTasks']);
+    }
+
     public function testParseDate(): void
     {
         $date = '2021-01-01T01:23:45.123456Z';