Merge #816

816: Add Reverse ordering support for Task API r=brunoocasali a=ma1581

# Pull Request

## Related issue
Fixes #798 

## What does this PR do?
- Accepts 'reverse' field to provider ordering flexibility

## PR checklist
Please check if your PR fulfills the following requirements:
- [ Y ] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [ Y ] Have you read the contributing guidelines?
- [ Y ] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: MA <[email protected]>
Co-authored-by: Laurent Cazanove <[email protected]>
Co-authored-by: Mohammed Anas <[email protected]>

Author: 3 people

src/main/java/com/meilisearch/sdk/http/URLBuilder.java

@@ -67,7 +67,8 @@ public URLBuilder addParameter(String parameter, int[] value) {
 
     public URLBuilder addParameter(String parameter, Date value) {
         if (value != null) {
-            SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd");
+            // Changed to utilise RFC 3339 format
+            SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssXXX");
             addSeparator();
             params.append(parameter);
             params.append("=");
@@ -76,6 +77,23 @@ public URLBuilder addParameter(String parameter, Date value) {
         return this;
     }
 
+    /**
+     * To add a boolean parameter to url
+     *
+     * @param parameter - parameter name
+     * @param value - value of the parameter
+     * @return - updated url object
+     */
+    public URLBuilder addParameter(String parameter, Boolean value) {
+        if (value != null) {
+            addSeparator();
+            params.append(parameter);
+            params.append("=");
+            params.append(value);
+        }
+        return this;
+    }
+
     public URLBuilder addQuery(String query) {
         this.params.append(query);
         return this;

src/main/java/com/meilisearch/sdk/model/TasksQuery.java

@@ -23,6 +23,7 @@ public class TasksQuery {
     private String[] types;
     private String[] indexUids;
     private int[] canceledBy;
+    private Boolean reverse;
     private Date beforeEnqueuedAt;
     private Date afterEnqueuedAt;
     private Date beforeStartedAt;
@@ -47,7 +48,8 @@ public String toQuery() {
                         .addParameter("beforeStartedAt", this.getBeforeStartedAt())
                         .addParameter("afterStartedAt", this.getAfterStartedAt())
                         .addParameter("beforeFinishedAt", this.getBeforeFinishedAt())
-                        .addParameter("afterFinishedAt", this.getAfterFinishedAt());
+                        .addParameter("afterFinishedAt", this.getAfterFinishedAt())
+                        .addParameter("reverse", this.getReverse());
         return urlb.getURL();
     }
 }

src/test/java/com/meilisearch/integration/TasksTest.java

@@ -9,14 +9,16 @@
 import static org.hamcrest.Matchers.not;
 import static org.hamcrest.Matchers.notNullValue;
 import static org.hamcrest.Matchers.nullValue;
-import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.*;
 
 import com.meilisearch.integration.classes.AbstractIT;
 import com.meilisearch.integration.classes.TestData;
 import com.meilisearch.sdk.Index;
 import com.meilisearch.sdk.model.*;
 import com.meilisearch.sdk.utils.Movie;
-import java.util.Date;
+import java.time.Instant;
+import java.util.*;
+import java.util.stream.Collectors;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Tag;
@@ -32,6 +34,7 @@ public void initialize() {
         this.setUp();
         this.setUpJacksonClient();
         if (testData == null) testData = this.getTestData(MOVIES_INDEX, Movie.class);
+        TimeZone.setDefault(TimeZone.getTimeZone("UTC"));
     }
 
     @AfterAll
@@ -203,6 +206,35 @@ public void testClientGetTasksAllQueryParameters() throws Exception {
         assertThat(result.getResults().length, is(notNullValue()));
     }
 
+    @Test
+    public void testGetTasksInReverse() {
+        String indexUid = "tasksOnReverseOrder";
+        Date currentTime = Date.from(Instant.now());
+        TestData<Movie> testData = this.getTestData(MOVIES_INDEX, Movie.class);
+        TasksQuery query = new TasksQuery().setAfterEnqueuedAt(currentTime);
+        TasksQuery queryWithReverseFlag =
+                new TasksQuery().setAfterEnqueuedAt(currentTime).setReverse(true);
+
+        client.index(indexUid).addDocuments(testData.getRaw());
+        client.waitForTask(client.index(indexUid).addDocuments(testData.getRaw()).getTaskUid());
+        List<Integer> tasks =
+                Arrays.stream(client.getTasks(query).getResults())
+                        .map(Task::getUid)
+                        .collect(Collectors.toList());
+        List<Integer> reversedTasks =
+                Arrays.stream(client.getTasks(queryWithReverseFlag).getResults())
+                        .map(Task::getUid)
+                        .collect(Collectors.toList());
+
+        assertFalse(tasks.isEmpty());
+        assertIterableEquals(
+                tasks,
+                reversedTasks.stream()
+                        .sorted(Collections.reverseOrder())
+                        .collect(Collectors.toList()),
+                "The lists are not reversed versions of each other");
+    }
+
     /** Test Cancel Task */
     @Test
     public void testClientCancelTask() throws Exception {

src/test/java/com/meilisearch/sdk/http/URLBuilderTest.java

@@ -6,14 +6,20 @@
 import static org.junit.jupiter.api.Assertions.*;
 
 import java.text.SimpleDateFormat;
-import java.time.format.DateTimeFormatter;
 import java.util.Date;
+import java.util.TimeZone;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 public class URLBuilderTest {
 
     private final URLBuilder classToTest = new URLBuilder();
 
+    @BeforeEach
+    void beforeEach() {
+        TimeZone.setDefault(TimeZone.getTimeZone("UTC"));
+    }
+
     @Test
     void addSubroute() {
         classToTest.addSubroute("route");
@@ -92,28 +98,20 @@ void addParameterStringIntArray() {
 
     @Test
     void addParameterStringDate() throws Exception {
-        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");
-        Date date = format.parse("2042-01-30");
+        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssXXX");
+        Date date = format.parse("2042-01-30T10:30:00-05:00");
 
         classToTest.addParameter("parameter1", date);
-        String parameterDate1 =
-                classToTest
-                        .getParams()
-                        .toString()
-                        .substring(12, classToTest.getParams().toString().length());
-        assertDoesNotThrow(() -> DateTimeFormatter.ISO_DATE.parse(parameterDate1));
-        assertThat(classToTest.getParams().toString(), is(equalTo("?parameter1=2042-01-30")));
+        String parameterDate1 = classToTest.getParams().substring(12);
+        assertDoesNotThrow(() -> format.parse(parameterDate1));
+        assertEquals(classToTest.getParams().toString(), "?parameter1=2042-01-30T15:30:00Z");
 
         classToTest.addParameter("parameter2", date);
-        String parameterDate2 =
-                classToTest
-                        .getParams()
-                        .toString()
-                        .substring(34, classToTest.getParams().toString().length());
-        assertDoesNotThrow(() -> DateTimeFormatter.ISO_DATE.parse(parameterDate2));
-        assertThat(
+        String parameterDate2 = classToTest.getParams().substring(44);
+        assertDoesNotThrow(() -> format.parse(parameterDate2));
+        assertEquals(
                 classToTest.getParams().toString(),
-                is(equalTo("?parameter1=2042-01-30&parameter2=2042-01-30")));
+                "?parameter1=2042-01-30T15:30:00Z&parameter2=2042-01-30T15:30:00Z");
     }
 
     @Test