Merge pull request #423 from meilisearch/bump-meilisearch-v0.30.0-add…

…-delete-tasks

Add `deleteTasks` method

src/Contracts/DeleteTasksQuery.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MeiliSearch\Contracts;
+
+use MeiliSearch\Delegates\TasksQueryTrait;
+
+class DeleteTasksQuery
+{
+    use TasksQueryTrait;
+}

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);

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
      */

tests/Contracts/DeleteTasksQueryTest.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Contracts;
+
+use MeiliSearch\Contracts\TasksQuery;
+use PHPUnit\Framework\TestCase;
+
+class DeleteTasksQueryTest extends TestCase
+{
+    public function testSetTypes(): void
+    {
+        $data = (new TasksQuery())->setTypes(['abc', 'xyz']);
+
+        $this->assertEquals($data->toArray(), ['types' => 'abc,xyz']);
+    }
+
+    public function testSetNext(): void
+    {
+        $data = (new TasksQuery())->setNext(99);
+
+        $this->assertEquals($data->toArray(), ['next' => 99]);
+    }
+
+    public function testSetAnyDateFilter(): void
+    {
+        $date = new \DateTime();
+        $data = (new TasksQuery())->setBeforeEnqueuedAt($date);
+
+        $this->assertEquals($data->toArray(), ['beforeEnqueuedAt' => $date->format(\DateTime::RFC3339)]);
+    }
+
+    public function testToArrayWithSetNextWithZero(): void
+    {
+        $data = (new TasksQuery())->setNext(0);
+
+        $this->assertEquals($data->toArray(), ['next' => 0]);
+    }
+
+    public function testToArrayWithDifferentSets(): void
+    {
+        $data = (new TasksQuery())->setFrom(10)->setLimit(9)->setNext(99)->setStatuses(['enqueued']);
+
+        $this->assertEquals($data->toArray(), [
+            'limit' => 9, 'next' => 99, 'from' => 10, 'statuses' => 'enqueued',
+        ]);
+    }
+}

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';