Merge branch 'master' into sdk

Author: Clément Le Provost

.travis.yml

@@ -1,3 +1,6 @@
+branches:
+  only:
+    - master
 sudo: false # Explicitely choose container-based infrastructure, see https://docs.travis-ci.com/user/ci-environment/
 language: android
 jdk:

ChangeLog.md

@@ -1,6 +1,14 @@
 Change Log
 ==========
 
+## 3.1 (2016-05-09)
+
+- Add typed accessors for missing query parameters `filters` and `numericFilters`
+- Shuffle host array at init time, for better load balancing
+- Perform stricter check on GZip `Content-Encoding` HTTP header
+- Update documentation
+
+
 ## 3.0 (2016-04-14)
 
 This major version brings new features as well as bug fixes. In addition, a lot of refactoring has been performed

README.md

@@ -5,6 +5,10 @@
 <!--/NO_HTML-->
 
 
+*Note: If you were using **version 2.x** of our Android client, read the [migration guide to version 3.x](https://github.com/algolia/algoliasearch-client-android/wiki/Migration-guide-to-version-3.x).*
+
+
+
 
 
 <!--NO_HTML-->
@@ -22,6 +26,7 @@ Our Android client lets you easily use the [Algolia Search API](https://www.algo
 
 
 
+
 <!--NO_HTML-->
 
 Table of Contents
@@ -1054,6 +1059,8 @@ You can also use a string array encoding (for example `numericFilters: ["price>1
 <code>available=1 AND (category:Book OR NOT category:Ebook) AND public</code>
 <code>date: 1441745506 TO 1441755506 AND inStock &gt; 0 AND author:&quot;John Doe&quot;</code></p>
 
+<p>If no attribute name is specified, the filter applies to <code>_tags</code>. For example: <code>public OR user_42</code> will translate to <code>_tags:public OR _tags:user_42</code>.</p>
+
 <p>The list of keywords is:</p>
 
 <ul>
@@ -1141,7 +1148,7 @@ You can send multiple queries with a single API call using a batch of queries:
 List<IndexQuery> queries = new ArrayList<>();
 
 queries.add(new IndexQuery("categories", new Query(myQueryString).setHitsPerPage(3)));
-queries.add(new IndexQuery("products", new Query(myQueryString).setHitsPerPage(3).setTagFilters("promotion"));
+queries.add(new IndexQuery("products", new Query(myQueryString).setHitsPerPage(3).set("filters", "promotion"));
 queries.add(new IndexQuery("products", new Query(myQueryString).setHitsPerPage(10)));
 
 client.multipleQueriesAsync(queries, new CompletionHandler() {

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

@@ -50,6 +50,13 @@ public AlgoliaException(String message, int statusCode)
 
     private static final long serialVersionUID = 1L;
 
+    /**
+     * Get the error's HTTP status code (if any).
+     * Only valid when the exception is an application-level error. Values are documented in the
+     * <a href="https://www.algolia.com/doc/rest">REST API</a>.
+     *
+     * @return The HTTP status code, or 0 if not available.
+     */
     public int getStatusCode()
     {
         return statusCode;

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

@@ -47,6 +47,7 @@
 import java.net.URLEncoder;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -64,7 +65,7 @@
  * </p>
  */
 public class Client {
-    private final static String version = "3.0";
+    private final static String version = "3.1";
 
     protected String userAgent = "Algolia for Android " + version;
 
@@ -125,18 +126,26 @@ public Client(@NonNull String applicationID, @NonNull String apiKey, String[] ho
             setReadHosts(hosts);
             setWriteHosts(hosts);
         } else {
-            setReadHosts(
-                    applicationID + "-dsn.algolia.net",
-                    applicationID + "-1.algolianet.com",
-                    applicationID + "-2.algolianet.com",
-                    applicationID + "-3.algolianet.com"
-            );
-            setWriteHosts(
-                    applicationID + ".algolia.net",
+            // Initialize hosts to their default values.
+            //
+            // NOTE: The host list comes in two parts:
+            //
+            // 1. The fault-tolerant, load-balanced DNS host.
+            // 2. The non-fault-tolerant hosts. Those hosts must be randomized to ensure proper load balancing in case
+            //    of the first host's failure.
+            //
+            List<String> fallbackHosts = Arrays.asList(
                     applicationID + "-1.algolianet.com",
                     applicationID + "-2.algolianet.com",
                     applicationID + "-3.algolianet.com"
             );
+            Collections.shuffle(fallbackHosts);
+            readHosts = new ArrayList<>(fallbackHosts.size() + 1);
+            readHosts.add(applicationID + "-dsn.algolia.net");
+            readHosts.addAll(fallbackHosts);
+            writeHosts = new ArrayList<>(fallbackHosts.size() + 1);
+            writeHosts.add(applicationID + ".algolia.net");
+            writeHosts.addAll(fallbackHosts);
         }
     }
 
@@ -700,7 +709,7 @@ private byte[] _requestRaw(Method m, String url, String json, List<String> hosts
 
                 final byte[] rawResponse;
                 String encoding = hostConnection.getContentEncoding();
-                if (encoding != null && encoding.contains("gzip")) {
+                if (encoding != null && encoding.equals("gzip")) {
                     rawResponse = _toByteArray(new GZIPInputStream(stream));
                 } else {
                     rawResponse = _toByteArray(stream);

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

@@ -419,7 +419,15 @@ public JSONArray getFacetFilters() {
         return null;
     }
 
-    // NOTE: `filters` left out because type too complex.
+    private static final String KEY_FILTERS = "filters";
+
+    public @NonNull Query setFilters(String filters) {
+        return set(KEY_FILTERS, filters);
+    }
+
+    public String getFilters() {
+        return get(KEY_FILTERS);
+    }
 
     private static final String KEY_GET_RANKING_INFO = "getRankingInfo";
 
@@ -688,7 +696,24 @@ public Integer getMinWordSizefor2Typos() {
         return parseInt(get(KEY_MIN_WORD_SIZE_FOR_2_TYPOS));
     }
 
-    // NOTE: `numericFilters` left out because type too complex.
+    private static final String KEY_NUMERIC_FILTERS = "numericFilters";
+
+    public @NonNull Query setNumericFilters(JSONArray filters) {
+        return set(KEY_NUMERIC_FILTERS, filters);
+    }
+
+    public JSONArray getNumericFilters() {
+        try {
+            String value = get(KEY_NUMERIC_FILTERS);
+            if (value != null) {
+                return new JSONArray(value);
+            }
+        }
+        catch (JSONException e) {
+            // Will return null
+        }
+        return null;
+    }
 
     private static final String KEY_OPTIONAL_WORDS = "optionalWords";
 

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

@@ -96,6 +96,10 @@ public void tearDown() throws Exception {
 
     @Test
     public void testSearchAsync() throws Exception {
+        testSearchAsync(Helpers.wait);
+    }
+
+    public void testSearchAsync(int waitTimeout) throws Exception {
         // Empty search.
         final CountDownLatch signal = new CountDownLatch(1);
         index.searchAsync(new Query(), new CompletionHandler() {
@@ -109,7 +113,7 @@ public void requestCompleted(JSONObject content, AlgoliaException error) {
                 signal.countDown();
             }
         });
-        assertTrue("No callback was called", signal.await(Helpers.wait, TimeUnit.SECONDS));
+        assertTrue("No callback was called", signal.await(waitTimeout, TimeUnit.SECONDS));
 
         // Search with query.
         final CountDownLatch signal2 = new CountDownLatch(1);
@@ -124,7 +128,7 @@ public void requestCompleted(JSONObject content, AlgoliaException error) {
                 signal2.countDown();
             }
         });
-        assertTrue("No callback was called", signal2.await(Helpers.wait, TimeUnit.SECONDS));
+        assertTrue("No callback was called", signal2.await(waitTimeout, TimeUnit.SECONDS));
     }
 
     @Test
@@ -438,6 +442,26 @@ public void testHostSwitch() throws Exception {
         testSearchAsync();
     }
 
+    @Test
+    public void testDNSTimeout() throws Exception {
+        // Given first host resulting in a DNS Timeout
+        String appId = (String) Whitebox.getInternalState(client, "applicationID");
+        List<String> hostsArray = (List<String>) Whitebox.getInternalState(client, "readHosts");
+        hostsArray.set(0, appId + "-dsn.algolia.biz");
+        Whitebox.setInternalState(client, "readHosts", hostsArray);
+
+        //And an index that does not cache search queries
+        index.disableSearchCache();
+
+
+        // Expect successful search within 5 seconds
+        long startTime = System.nanoTime();
+        testSearchAsync(5);
+        final long duration = (System.nanoTime() - startTime) / 1000000;
+
+        // Which should take at least 2 seconds, as per Client.connectTimeout
+        assertTrue("We should first timeout before successfully searching, but test took only " + duration + " ms.", duration > 2000);
+    }
 
     @Test
     public void testSNI() throws Exception {
@@ -544,7 +568,7 @@ public void testDeleteByQueryAsync() throws Exception {
         final CountDownLatch signal = new CountDownLatch(2);
         addDummyObjects(3000);
         final Query query = new Query();
-        query.set("numericFilters", "dummy < 1500");
+        query.setNumericFilters(new JSONArray().put("dummy < 1500"));
         index.deleteByQueryAsync(query, new CompletionHandler() {
             @Override
             public void requestCompleted(JSONObject content, AlgoliaException error) {

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

@@ -598,4 +598,28 @@ public void test_minimumAroundRadius() {
         Query query2 = Query.parse(query1.build());
         assertEquals(query2.getMinimumAroundRadius(), query1.getMinimumAroundRadius());
     }
+
+    @Test
+    public void test_numericFilters() throws JSONException {
+        final JSONArray VALUE = new JSONArray("[\"code=1\", [\"price:0 to 10\", \"price:1000 to 2000\"]]");
+        Query query1 = new Query();
+        assertNull(query1.getNumericFilters());
+        query1.setNumericFilters(VALUE);
+        assertEquals(query1.getNumericFilters(), VALUE);
+        assertEquals(query1.get("numericFilters"), "[\"code=1\",[\"price:0 to 10\",\"price:1000 to 2000\"]]");
+        Query query2 = Query.parse(query1.build());
+        assertEquals(query2.getNumericFilters(), query1.getNumericFilters());
+    }
+
+    @Test
+    public void test_filters() {
+        final String VALUE = "available=1 AND (category:Book OR NOT category:Ebook) AND publication_date: 1441745506 TO 1441755506 AND inStock > 0 AND author:\"John Doe\"";
+        Query query1 = new Query();
+        assertNull(query1.getFilters());
+        query1.setFilters(VALUE);
+        assertEquals(query1.getFilters(), VALUE);
+        assertEquals(query1.get("filters"), VALUE);
+        Query query2 = Query.parse(query1.build());
+        assertEquals(query2.getFilters(), query1.getFilters());
+    }
 }