[offline] Add manual build feature to OfflineIndex

Author: Clément Le Provost

algoliasearch/src/offline/java/com/algolia/search/saas/OfflineIndex.java

@@ -23,6 +23,7 @@
 
 package com.algolia.search.saas;
 
+import android.content.res.Resources;
 import android.os.Looper;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
@@ -829,6 +830,100 @@ public boolean hasOfflineData() {
         return localIndex.exists();
     }
 
+    // ----------------------------------------------------------------------
+    // Manual build
+    // ----------------------------------------------------------------------
+
+    /**
+     * Build the index from local data stored on the filesystem.
+     *
+     * @param settingsFile Absolute path to the file containing the index settings, in JSON format.
+     * @param objectFiles Absolute path(s) to the file(s) containing the objects. Each file must contain an array of
+     *                    objects, in JSON format.
+     * @param completionHandler Optional completion handler to be notified of the build's outcome.
+     * @return A cancellable request.
+     *
+     * **Note:** Cancelling the request does *not* cancel the build; it merely prevents the completion handler from
+     * being called.
+     */
+    public Request buildFromFiles(@NonNull final File settingsFile, @NonNull final File[] objectFiles, @Nullable CompletionHandler completionHandler) {
+        return getClient().new AsyncTaskRequest(completionHandler, getClient().localBuildExecutorService) {
+            @NonNull
+            @Override
+            protected JSONObject run() throws AlgoliaException {
+                return _build(settingsFile, objectFiles);
+            }
+        }.start();
+    }
+
+    public Request buildFromFiles(@NonNull final File settingsFile, @NonNull final File... objectFiles) {
+        return buildFromFiles(settingsFile, objectFiles, null);
+    }
+
+    /**
+     * Build the index from local data stored in raw resources.
+     *
+     * @param resources A {@link Resources} instance to read resources from.
+     * @param settingsResId Resource identifier of the index settings, in JSON format.
+     * @param objectsResIds Resource identifiers of the various objects files. Each file must contain an array of
+     *                    objects, in JSON format.
+     * @param completionHandler Optional completion handler to be notified of the build's outcome.
+     * @return A cancellable request.
+     *
+     * **Note:** Cancelling the request does *not* cancel the build; it merely prevents the completion handler from
+     * being called.
+     */
+    public Request buildFromRawResources(@NonNull final Resources resources, @NonNull final int settingsResId, @NonNull final int[] objectsResIds, @Nullable CompletionHandler completionHandler) {
+        return getClient().new AsyncTaskRequest(completionHandler, getClient().localBuildExecutorService) {
+            @NonNull
+            @Override
+            protected JSONObject run() throws AlgoliaException {
+                return _buildFromRawResources(resources, settingsResId, objectsResIds);
+            }
+        }.start();
+    }
+
+    public Request buildFromRawResources(@NonNull final Resources resources, @NonNull final int settingsResId, @NonNull final int... objectsResIds) {
+        return buildFromRawResources(resources, settingsResId, objectsResIds, null);
+    }
+
+    private JSONObject _buildFromRawResources(@NonNull final Resources resources, @NonNull final int settingsResId, @NonNull final int... objectsResIds) throws AlgoliaException {
+        // Save resources to independent files on disk.
+        File tmpDir = new File(getClient().getTempDir(), UUID.randomUUID().toString());
+        try {
+            tmpDir.mkdirs();
+            // Settings.
+            File settingsFile = new File(tmpDir, "settings.json");
+            FileUtils.writeFile(settingsFile, resources.openRawResource(settingsResId));
+            // Objects.
+            File[] objectFiles = new File[objectsResIds.length];
+            for (int i = 0; i < objectsResIds.length; ++i) {
+                objectFiles[i] = new File(tmpDir, "objects#" + Integer.toString(objectsResIds[i]) + ".json");
+                FileUtils.writeFile(objectFiles[i], resources.openRawResource(objectsResIds[i]));
+            }
+            // Build the index.
+            return _build(settingsFile, objectFiles);
+        } catch (IOException e) {
+            throw new AlgoliaException("Failed to write build resources to disk", e);
+        } finally {
+            // Delete temporary files.
+            FileUtils.deleteRecursive(tmpDir);
+        }
+    }
+
+    private JSONObject _build(@NonNull File settingsFile, @NonNull File... objectFiles) throws AlgoliaException {
+        AlgoliaException error = null;
+        String[] objectFilePaths = new String[objectFiles.length];
+        for (int i = 0; i < objectFiles.length; ++i) {
+            objectFilePaths[i] = objectFiles[i].getAbsolutePath();
+        }
+        final int status = localIndex.build(settingsFile.getAbsolutePath(), objectFilePaths, true /* clearIndex */, null /* deletedObjectIDs */);
+        if (status != 200) {
+            throw new AlgoliaException(String.format("Failed to build local index \"%s\"", OfflineIndex.this.getName()), status);
+        }
+        return new JSONObject();
+    }
+
     // ----------------------------------------------------------------------
     // Helpers
     // ----------------------------------------------------------------------

algoliasearch/src/testOffline/java/com/algolia/search/saas/OfflineIndexTest.java

@@ -27,7 +27,9 @@
 import org.json.JSONObject;
 import org.junit.Test;
 import org.mockito.internal.util.reflection.Whitebox;
+import org.robolectric.RuntimeEnvironment;
 
+import java.io.File;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -521,4 +523,44 @@ public void doRequestCompleted(JSONObject content, AlgoliaException error) {
             }
         });
     }
+
+    @Test
+    public void testBuild() {
+        final CountDownLatch signal = new CountDownLatch(2);
+
+        // Retrieve data files from resources.
+        File resourcesDir = new File(RuntimeEnvironment.application.getPackageResourcePath() + "/src/testOffline/res");
+        File rawDir = new File(resourcesDir, "raw");
+        File settingsFile = new File(rawDir, "settings.json");
+        File objectFile = new File(rawDir, "objects.json");
+
+        // Create the index.
+        final OfflineIndex index = client.getOfflineIndex(Helpers.safeIndexName(Helpers.getMethodName()));
+
+        // Check that no offline data exists.
+        assertFalse(index.hasOfflineData());
+
+        // Build the index.
+        index.buildFromFiles(settingsFile, new File[]{ objectFile }, new AssertCompletionHandler() {
+            @Override
+            public void doRequestCompleted(JSONObject content, AlgoliaException error) {
+                assertNull(error);
+
+                // Check that offline data exists now.
+                assertTrue(index.hasOfflineData());
+
+                // Search.
+                Query query = new Query().setQuery("peanuts").setFilters("kind:animal");
+                index.searchAsync(query, new AssertCompletionHandler() {
+                    @Override
+                    public void doRequestCompleted(JSONObject content, AlgoliaException error) {
+                        assertNull(error);
+                        assertEquals(2, content.optInt("nbHits"));
+                        signal.countDown();
+                    }
+                });
+                signal.countDown();
+            }
+        });
+    }
 }