feat(clickAnalytics): Add clickAnalytics feature. Used to return the queryID for analytics (#548)

Author: robertmogos

algoliasearch/src/main/java/com/algolia/search/saas/Query.java

@@ -312,6 +312,20 @@ public Boolean getAllowTyposOnNumericTokens() {
         return parseBoolean(get(KEY_ALLOW_TYPOS_ON_NUMERIC_TOKENS));
     }
 
+    private static final String KEY_CLICK_ANALYTICS = "clickAnalytics";
+
+    /**
+     * @param enabled If set to true, the results will return queryID which is needed for sending click | conversion events. Defaults to false.
+     */
+    public @NonNull
+    Query setClickAnalytics(Boolean enabled) {
+        return set(KEY_CLICK_ANALYTICS, enabled);
+    }
+
+    public Boolean getClickAnalytics() {
+        return parseBoolean(get(KEY_CLICK_ANALYTICS));
+    }
+
     private static final String KEY_ANALYTICS = "analytics";
 
     /**

algoliasearch/src/test/java/com/algolia/search/saas/IndexTest.java

@@ -1299,6 +1299,30 @@ public void doRequestCompleted(JSONObject content, AlgoliaException error) {
         });
     }
 
+    @Test
+    public void searchWithClickTrackingAsync() {
+        final long begin = System.nanoTime();
+        Query query = new Query("Francisco");
+        query.setClickAnalytics(true);
+
+        index.searchAsync(query, new AssertCompletionHandler() {
+            @Override
+            public void doRequestCompleted(JSONObject content, AlgoliaException error) {
+                if (error == null) {
+                    assertNotNull(content.optInt("queryID"));
+                } else {
+                    fail(error.getMessage());
+                }
+            }
+        });
+
+        final long elapsedMillis = (System.nanoTime() - begin) / 1000000;
+        final int waitTimeoutMillis = Helpers.wait * 1000;
+        assertTrue("The test took longer than given timeout (" + elapsedMillis + " > " + waitTimeoutMillis + ").", elapsedMillis <= waitTimeoutMillis);
+    }
+
+
+
     private String getRandomString() {
         return UUID.randomUUID().toString();
     }

algoliasearch/src/test/java/com/algolia/search/saas/QueryTest.java

@@ -286,6 +286,16 @@ public void analytics() {
         assertEquals(query.getAnalytics(), Query.parse(query.build()).getAnalytics());
     }
 
+    @Test
+    public void clickAnalytics() {
+        Query query = new Query();
+        assertNull(query.getClickAnalytics());
+        query.setClickAnalytics(true);
+        assertEquals(Boolean.TRUE, query.getClickAnalytics());
+        assertEquals("true", query.get("clickAnalytics"));
+        assertEquals(query.getClickAnalytics(), Query.parse(query.build()).getClickAnalytics());
+    }
+
 
     @Test
     public void sortFacetValuesBy() {