Mapbox gl native pin update and offline fix - release-sangria patch 8.5.2 release (#99)

Author: Langston Smith

CHANGELOG.md

@@ -6,6 +6,13 @@ Mapbox welcomes participation and contributions from everyone.  If you'd like to
 ### Bugs
  - Synchronise LibaryLoader#loadLibrary to avoid race conditions resulting in UnsatisfiedLinkError [#58](https://github.com/mapbox/mapbox-gl-native-android/pull/58)
 
+## 8.5.2 - December 10, 2019
+[Changes](https://github.com/mapbox/mapbox-gl-native-android/compare/android-v8.5.1...android-v8.5.2) since [Mapbox Maps SDK for Android v8.5.1](https://github.com/mapbox/mapbox-gl-native-android/releases/tag/android-v8.5.1):
+
+### Features
+- Enabling decoupling vacuum operation from other operations run on the offline database file (delete offline region, clear ambient cache) [#99](https://github.com/mapbox/mapbox-gl-native-android/pull/99)
+
+
 ## 8.5.1 - November 20, 2019
 [Changes](https://github.com/mapbox/mapbox-gl-native-android/compare/android-v8.5.0...android-v8.5.1) since [Mapbox Maps SDK for Android v8.5.0](https://github.com/mapbox/mapbox-gl-native-android/releases/tag/android-v8.5.0):
 ### Bugs

MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineManager.java

@@ -306,6 +306,50 @@ public void run() {
     });
   }
 
+  /**
+   * Packs the existing database file into a minimal amount of disk space.
+   * <p>
+   * This operation has a performance impact as it will vacuum the database,
+   * forcing it to move pages on the filesystem.
+   * <p>
+   * When the operation is complete or encounters an error, the given callback will be
+   * executed on the database thread; it is the responsibility of the SDK bindings
+   * to re-execute a user-provided callback on the main thread.
+   * </p>
+   *
+   * @param callback the callback to be invoked when the database was reset or when the operation erred.
+   */
+  public void packDatabase(@Nullable final FileSourceCallback callback) {
+    fileSource.activate();
+    nativePackDatabase(new FileSourceCallback() {
+      @Override
+      public void onSuccess() {
+        handler.post(new Runnable() {
+          @Override
+          public void run() {
+            fileSource.deactivate();
+            if (callback != null) {
+              callback.onSuccess();
+            }
+          }
+        });
+      }
+
+      @Override
+      public void onError(@NonNull final String message) {
+        handler.post(new Runnable() {
+          @Override
+          public void run() {
+            fileSource.deactivate();
+            if (callback != null) {
+              callback.onError(message);
+            }
+          }
+        });
+      }
+    });
+  }
+
   /**
    * Forces re-validation of the ambient cache.
    * <p>
@@ -355,9 +399,10 @@ public void run() {
   /**
    * Erase resources from the ambient cache, freeing storage space.
    * <p>
-   * Erases the ambient cache, freeing resources. This operation can be
-   * potentially slow because it will trigger a VACUUM on SQLite,
-   * forcing the database to move pages on the filesystem.
+   * Erases the ambient cache, freeing resources.
+   * <p>
+   * Note that this operation can be potentially slow if packing the database
+   * occurs automatically ({@link OfflineManager#runPackDatabaseAutomatically(boolean)}).
    * </p>
    * <p>
    * Resources overlapping with offline regions will not be affected
@@ -620,14 +665,32 @@ private boolean isValidOfflineRegionDefinition(OfflineRegionDefinition definitio
    * <p>
    * Once this limit is reached, {@link OfflineRegion.OfflineRegionObserver#mapboxTileCountLimitExceeded(long)}
    * fires every additional attempt to download additional tiles until already downloaded tiles are removed
-   * by calling {@link OfflineRegion#deleteOfflineRegion(OfflineRegion.OfflineRegionDeleteCallback)}.
+   * by calling {@link OfflineRegion#delete(OfflineRegion.OfflineRegionDeleteCallback)}.
    * </p>
    *
    * @param limit the maximum number of tiles allowed to be downloaded
    */
   @Keep
   public native void setOfflineMapboxTileCountLimit(long limit);
 
+  /**
+   * Sets whether database file packing occurs automatically.
+   * By default, the automatic database file packing is enabled.
+   * <p>
+   * If packing is enabled, database file packing occurs automatically
+   * after an offline region is deleted by calling
+   * {@link OfflineRegion#delete(OfflineRegion.OfflineRegionDeleteCallback)}
+   * or the ambient cache is cleared by calling {@link OfflineManager#clearAmbientCache()}.
+   *
+   * If packing is disabled, disk space will not be freed after
+   * resources are removed unless {@link OfflineManager#packDatabase()} is explicitly called.
+   * </p>
+   *
+   * @param autopack flag setting the automatic database file packing.
+   */
+  @Keep
+  public native void runPackDatabaseAutomatically(boolean autopack);
+
   @Keep
   private native void initialize(FileSource fileSource);
 
@@ -648,6 +711,9 @@ private native void createOfflineRegion(FileSource fileSource, OfflineRegionDefi
   @Keep
   private native void nativeResetDatabase(@Nullable FileSourceCallback callback);
 
+  @Keep
+  private native void nativePackDatabase(@Nullable FileSourceCallback callback);
+
   @Keep
   private native void nativeInvalidateAmbientCache(@Nullable FileSourceCallback callback);
 

MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineRegion.java

@@ -388,6 +388,10 @@ public void run() {
    * by other regions, until the database shrinks below a certain size.
    * </p>
    * <p>
+   * Note that this operation can be potentially slow if packing the database
+   * occurs automatically ({@link OfflineManager#runPackDatabaseAutomatically(boolean)}).
+   * </p>
+   * <p>
    * When the operation is complete or encounters an error, the given callback will be
    * executed on the main thread.
    * </p>

MapboxGLAndroidSDKTestApp/src/androidTest/java/com/mapbox/mapboxsdk/testapp/offline/CacheTest.kt

@@ -85,4 +85,20 @@ class CacheTest {
     }
     countDownLatch.await()
   }
+
+  @Test
+  fun testSetPackDatabase() {
+    rule.activity.runOnUiThread {
+      OfflineManager.getInstance(context).packDatabase(object : OfflineManager.FileSourceCallback {
+        override fun onSuccess() {
+          countDownLatch.countDown()
+        }
+
+        override fun onError(message: String) {
+          Assert.assertNull("onError should not be called", message)
+        }
+      })
+    }
+    countDownLatch.await()
+  }
 }