Expose async variants of the style layer property setters (#6273)

Added new methods to `MapboxStyleManager` to expose async variants of
the style layer property setters.

GitOrigin-RevId: 29d0937248a6dd7e4a25a462fd33fc50b2429dd1

Author: jush

CHANGELOG.md

@@ -7,6 +7,7 @@ Mapbox welcomes participation and contributions from everyone.
 # main
 ## Features ✨ and improvements 🏁
 * Expose `LineLayer.lineCutoutOpacity` and `LineLayer.lineCutoutWidth` to make route lines visible through obstructing 3D buildings and other aboveground features.
+* Expose experimental `MapboxMap.setStyleLayerPropertiesAsync` and `MapboxMap.setStyleLayerPropertyAsync` (also available through `Style`) to allow setting properties from a any thread and asynchronously.
 
 ## Bug fixes 🐞
 * MapboxTracing was deprecated and moved to package com.mapbox.common.

maps-sdk/api/Release/metalava.txt

@@ -395,12 +395,12 @@ package com.mapbox.maps {
   public final class MapboxMapsOptionsKt {
   }
 
-  public final class MapboxTracing {
-    method public void disableAll();
-    method public void enableAll();
-    method public void enableCore();
-    method public void enablePlatform();
-    field public static final com.mapbox.maps.MapboxTracing INSTANCE;
+  @Deprecated public final class MapboxTracing {
+    method @Deprecated public void disableAll();
+    method @Deprecated public void enableAll();
+    method @Deprecated public void enableCore();
+    method @Deprecated public void enablePlatform();
+    field @Deprecated public static final com.mapbox.maps.MapboxTracing INSTANCE;
   }
 
   public abstract class SnapshotOverlay {

sdk-base/api/Release/metalava.txt

@@ -224,7 +224,9 @@ package com.mapbox.maps {
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleImportConfigProperties(String importId, java.util.HashMap<java.lang.String,com.mapbox.bindgen.Value> configs);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleImportConfigProperty(String importId, String config, com.mapbox.bindgen.Value value);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleLayerProperties(String layerId, com.mapbox.bindgen.Value properties);
+    method @AnyThread @CallSuper @com.mapbox.maps.MapboxExperimental public com.mapbox.common.Cancelable setStyleLayerPropertiesAsync(String layerId, com.mapbox.bindgen.Value properties, com.mapbox.maps.AsyncOperationResultCallback callback);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleLayerProperty(String layerId, String property, com.mapbox.bindgen.Value value);
+    method @AnyThread @CallSuper @com.mapbox.maps.MapboxExperimental public com.mapbox.common.Cancelable setStyleLayerPropertyAsync(String layerId, String property, com.mapbox.bindgen.Value value, com.mapbox.maps.AsyncOperationResultCallback callback);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleLightProperty(String id, String property, com.mapbox.bindgen.Value value);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleLights(com.mapbox.bindgen.Value lights);
     method @CallSuper @MainThread public com.mapbox.bindgen.Expected<java.lang.String,com.mapbox.bindgen.None> setStyleProjection(com.mapbox.bindgen.Value properties);

sdk-base/api/sdk-base.api

@@ -248,7 +248,9 @@ public class com/mapbox/maps/MapboxStyleManager {
 	public fun setStyleImportConfigProperties (Ljava/lang/String;Ljava/util/HashMap;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleImportConfigProperty (Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleLayerProperties (Ljava/lang/String;Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;
+	public fun setStyleLayerPropertiesAsync (Ljava/lang/String;Lcom/mapbox/bindgen/Value;Lcom/mapbox/maps/AsyncOperationResultCallback;)Lcom/mapbox/common/Cancelable;
 	public fun setStyleLayerProperty (Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;
+	public fun setStyleLayerPropertyAsync (Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/bindgen/Value;Lcom/mapbox/maps/AsyncOperationResultCallback;)Lcom/mapbox/common/Cancelable;
 	public fun setStyleLightProperty (Ljava/lang/String;Ljava/lang/String;Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleLights (Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;
 	public fun setStyleProjection (Lcom/mapbox/bindgen/Value;)Lcom/mapbox/bindgen/Expected;

sdk-base/src/main/java/com/mapbox/maps/MapboxStyleManager.kt

@@ -8,6 +8,7 @@ import androidx.annotation.RestrictTo
 import com.mapbox.bindgen.Expected
 import com.mapbox.bindgen.None
 import com.mapbox.bindgen.Value
+import com.mapbox.common.Cancelable
 import com.mapbox.geojson.Feature
 
 /**
@@ -580,6 +581,45 @@ open class MapboxStyleManager @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX)
     return styleManager.setStyleLayerProperty(layerId, property, value)
   }
 
+  /**
+   * Sets a value to a style layer property asynchronously.
+   *
+   * This method provides asynchronous argument parsing which is beneficial when working with
+   * large or complex style expressions that could block the main thread during parsing.
+   * The operation is performed on a background thread and the callback is invoked on the
+   * main thread once the operation completes.
+   *
+   * Values will be applied asynchronously at some moment in the future. If multiple calls
+   * to this method are made, the corresponding values will be applied in the same order
+   * as the calls were made.
+   *
+   * Note: This method should be used only if the given argument is a massive expression
+   * and its parsing would block the main thread otherwise. For simple property values,
+   * prefer the synchronous [setStyleLayerProperty] method.
+   *
+   * If the style is modified during this asynchronous method call, the scheduled layer
+   * property change will still be applied as long as a layer with the original name and
+   * type still exists.
+   *
+   * @param layerId A style layer identifier.
+   * @param property The style layer property name.
+   * @param value The style layer property value.
+   * @param callback Called once the request is complete or an error occurred.
+   *
+   * @return A [Cancelable] object that can be used to cancel the asynchronous operation.
+   */
+  @MapboxExperimental
+  @CallSuper
+  @AnyThread
+  open fun setStyleLayerPropertyAsync(
+    layerId: String,
+    property: String,
+    value: Value,
+    callback: AsyncOperationResultCallback
+  ): Cancelable {
+    return styleManager.setStyleLayerPropertyAsync(layerId, property, value, callback)
+  }
+
   /**
    * Gets style layer properties.
    *
@@ -610,6 +650,48 @@ open class MapboxStyleManager @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX)
     return styleManager.setStyleLayerProperties(layerId, properties)
   }
 
+  /**
+   * Experimental. Sets style layer properties asynchronously.
+   *
+   * This method can be used to perform batch update for a style layer properties with asynchronous
+   * argument parsing which is beneficial when working with large or complex style expressions that
+   * could block the main thread during parsing. The operation is performed on a background thread
+   * and the callback is invoked on the main thread once the operation completes.
+   *
+   * Properties will be applied asynchronously at some moment in the future. If multiple calls
+   * to this method are made, the corresponding properties will be applied in the same order
+   * as the calls were made.
+   *
+   * Note: This method should be used only if the given arguments contain massive expressions
+   * and their parsing would block the main thread otherwise. For simple property values,
+   * prefer the synchronous [setStyleLayerProperties] method.
+   *
+   * The structure of the provided [properties] value must conform to a format for a corresponding
+   * [layer type](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/).
+   * Modification of a layer [id](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#id) and/or
+   * a [layer type](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#type) is not allowed.
+   *
+   * If the style is modified during this asynchronous method call, the scheduled layer
+   * properties change will still be applied as long as a layer with the original name and
+   * type still exists.
+   *
+   * @param layerId A style layer identifier.
+   * @param properties A map of style layer properties.
+   * @param callback Called once the request is complete or an error occurred.
+   *
+   * @return A [Cancelable] object that can be used to cancel the asynchronous operation.
+   */
+  @CallSuper
+  @AnyThread
+  @MapboxExperimental
+  open fun setStyleLayerPropertiesAsync(
+    layerId: String,
+    properties: Value,
+    callback: AsyncOperationResultCallback
+  ): Cancelable {
+    return styleManager.setStyleLayerPropertiesAsync(layerId, properties, callback)
+  }
+
   /**
    * Adds a new [style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources).
    * Note: When adding a geojson source, this method does not synchronously parse the GeoJSON data.